org-capture.el 70 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861
  1. ;;; org-capture.el --- Fast note taking in Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2010-2018 Free Software Foundation, Inc.
  3. ;; Author: Carsten Dominik <carsten at orgmode dot org>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; Homepage: https://orgmode.org
  6. ;;
  7. ;; This file is part of GNU Emacs.
  8. ;;
  9. ;; GNU Emacs is free software: you can redistribute it and/or modify
  10. ;; it under the terms of the GNU General Public License as published by
  11. ;; the Free Software Foundation, either version 3 of the License, or
  12. ;; (at your option) any later version.
  13. ;; GNU Emacs is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;; You should have received a copy of the GNU General Public License
  18. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  19. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  20. ;;
  21. ;;; Commentary:
  22. ;; This file contains an alternative implementation of the functionality
  23. ;; that used to be provided by org-remember.el. The implementation is more
  24. ;; streamlined, can produce more target types (e.g. plain list items or
  25. ;; table lines). Also, it does not use a temporary buffer for editing
  26. ;; the captured entry - instead it uses an indirect buffer that visits
  27. ;; the new entry already in the target buffer (this was an idea by Samuel
  28. ;; Wales). John Wiegley's excellent `remember.el' is not needed anymore
  29. ;; for this implementation, even though we borrow heavily from its ideas.
  30. ;; This implementation heavily draws on ideas by James TD Smith and
  31. ;; Samuel Wales, and, of cause, uses John Wiegley's remember.el as inspiration.
  32. ;;; TODO
  33. ;; - find a clever way to not always insert an annotation maybe a
  34. ;; predicate function that can check for conditions for %a to be
  35. ;; used. This could be one of the properties.
  36. ;; - Should there be plist members that arrange for properties to be
  37. ;; asked for, like James proposed in his RFC?
  38. ;;; Code:
  39. (require 'cl-lib)
  40. (require 'org)
  41. (declare-function org-at-encrypted-entry-p "org-crypt" ())
  42. (declare-function org-clock-update-mode-line "org-clock" (&optional refresh))
  43. (declare-function org-datetree-find-date-create "org-datetree" (date &optional keep-restriction))
  44. (declare-function org-decrypt-entry "org-crypt" ())
  45. (declare-function org-encrypt-entry "org-crypt" ())
  46. (declare-function org-table-analyze "org-table" ())
  47. (declare-function org-table-current-dline "org-table" ())
  48. (declare-function org-table-goto-line "org-table" (N))
  49. (defvar dired-buffers)
  50. (defvar org-end-time-was-given)
  51. (defvar org-remember-default-headline)
  52. (defvar org-remember-templates)
  53. (defvar org-table-border-regexp)
  54. (defvar org-table-current-begin-pos)
  55. (defvar org-table-hlines)
  56. (defvar org-capture-clock-was-started nil
  57. "Internal flag, noting if the clock was started.")
  58. (defvar org-capture-last-stored-marker (make-marker)
  59. "Marker pointing to the entry most recently stored with `org-capture'.")
  60. ;; The following variable is scoped dynamically by org-protocol
  61. ;; to indicate that the link properties have already been stored
  62. (defvar org-capture-link-is-already-stored nil)
  63. (defvar org-capture-is-refiling nil
  64. "Non-nil when capture process is refiling an entry.")
  65. (defvar org-capture--prompt-history-table (make-hash-table :test #'equal)
  66. "Hash table for all history lists per prompt.")
  67. (defvar org-capture--prompt-history nil
  68. "History list for prompt placeholders.")
  69. (defgroup org-capture nil
  70. "Options concerning capturing new entries."
  71. :tag "Org Capture"
  72. :group 'org)
  73. (defun org-capture-upgrade-templates (templates)
  74. "Update the template list to the new format.
  75. TEMPLATES is a template list, as in `org-capture-templates'. The
  76. new format unifies all the date/week tree targets into one that
  77. also allows for an optional outline path to specify a target."
  78. (let ((modified-templates
  79. (mapcar
  80. (lambda (entry)
  81. (pcase entry
  82. ;; Match templates with an obsolete "tree" target type. Replace
  83. ;; it with common `file+olp-datetree'. Add new properties
  84. ;; (i.e., `:time-prompt' and `:tree-type') if needed.
  85. (`(,key ,desc ,type (file+datetree . ,path) ,tpl . ,props)
  86. `(,key ,desc ,type (file+olp+datetree ,@path) ,tpl ,@props))
  87. (`(,key ,desc ,type (file+datetree+prompt . ,path) ,tpl . ,props)
  88. `(,key ,desc ,type (file+olp+datetree ,@path) ,tpl
  89. :time-prompt t ,@props))
  90. (`(,key ,desc ,type (file+weektree . ,path) ,tpl . ,props)
  91. `(,key ,desc ,type (file+olp+datetree ,@path) ,tpl
  92. :tree-type week ,@props))
  93. (`(,key ,desc ,type (file+weektree+prompt . ,path) ,tpl . ,props)
  94. `(,key ,desc ,type (file+olp+datetree ,@path) ,tpl
  95. :tree-type week :time-prompt t ,@props))
  96. ;; Other templates are left unchanged.
  97. (_ entry)))
  98. templates)))
  99. (unless (equal modified-templates templates)
  100. (message "Deprecated date/weektree capture templates changed to `file+olp+datetree'."))
  101. modified-templates))
  102. (defcustom org-capture-templates nil
  103. "Templates for the creation of new entries.
  104. Each entry is a list with the following items:
  105. keys The keys that will select the template, as a string, characters
  106. only, for example \"a\" for a template to be selected with a
  107. single key, or \"bt\" for selection with two keys. When using
  108. several keys, keys using the same prefix key must be together
  109. in the list and preceded by a 2-element entry explaining the
  110. prefix key, for example
  111. (\"b\" \"Templates for marking stuff to buy\")
  112. The \"C\" key is used by default for quick access to the
  113. customization of the template variable. But if you want to use
  114. that key for a template, you can.
  115. description A short string describing the template, will be shown during
  116. selection.
  117. type The type of entry. Valid types are:
  118. entry an Org node, with a headline. Will be filed
  119. as the child of the target entry or as a
  120. top-level entry.
  121. item a plain list item, will be placed in the
  122. first plain list at the target
  123. location.
  124. checkitem a checkbox item. This differs from the
  125. plain list item only is so far as it uses a
  126. different default template.
  127. table-line a new line in the first table at target location.
  128. plain text to be inserted as it is.
  129. target Specification of where the captured item should be placed.
  130. In Org files, targets usually define a node. Entries will
  131. become children of this node, other types will be added to the
  132. table or list in the body of this node.
  133. Most target specifications contain a file name. If that file
  134. name is the empty string, it defaults to `org-default-notes-file'.
  135. A file can also be given as a variable or as a function called
  136. with no argument. When an absolute path is not specified for a
  137. target, it is taken as relative to `org-directory'.
  138. Valid values are:
  139. (file \"path/to/file\")
  140. Text will be placed at the beginning or end of that file
  141. (id \"id of existing Org entry\")
  142. File as child of this entry, or in the body of the entry
  143. (file+headline \"path/to/file\" \"node headline\")
  144. Fast configuration if the target heading is unique in the file
  145. (file+olp \"path/to/file\" \"Level 1 heading\" \"Level 2\" ...)
  146. For non-unique headings, the full outline path is safer
  147. (file+regexp \"path/to/file\" \"regexp to find location\")
  148. File to the entry matching regexp
  149. (file+olp+datetree \"path/to/file\" \"Level 1 heading\" ...)
  150. Will create a heading in a date tree for today's date.
  151. If no heading is given, the tree will be on top level.
  152. To prompt for date instead of using TODAY, use the
  153. :time-prompt property. To create a week-tree, use the
  154. :tree-type property.
  155. (file+function \"path/to/file\" function-finding-location)
  156. A function to find the right location in the file
  157. (clock)
  158. File to the entry that is currently being clocked
  159. (function function-finding-location)
  160. Most general way: write your own function which both visits
  161. the file and moves point to the right location
  162. template The template for creating the capture item. If you leave this
  163. empty, an appropriate default template will be used. See below
  164. for more details. Instead of a string, this may also be one of
  165. (file \"/path/to/template-file\")
  166. (function function-returning-the-template)
  167. in order to get a template from a file, or dynamically
  168. from a function.
  169. The rest of the entry is a property list of additional options. Recognized
  170. properties are:
  171. :prepend Normally newly captured information will be appended at
  172. the target location (last child, last table line,
  173. last list item...). Setting this property will
  174. change that.
  175. :immediate-finish When set, do not offer to edit the information, just
  176. file it away immediately. This makes sense if the
  177. template only needs information that can be added
  178. automatically.
  179. :jump-to-captured When set, jump to the captured entry when finished.
  180. :empty-lines Set this to the number of lines the should be inserted
  181. before and after the new item. Default 0, only common
  182. other value is 1.
  183. :empty-lines-before Set this to the number of lines the should be inserted
  184. before the new item. Overrides :empty-lines for the
  185. number lines inserted before.
  186. :empty-lines-after Set this to the number of lines the should be inserted
  187. after the new item. Overrides :empty-lines for the
  188. number of lines inserted after.
  189. :clock-in Start the clock in this item.
  190. :clock-keep Keep the clock running when filing the captured entry.
  191. :clock-resume Start the interrupted clock when finishing the capture.
  192. Note that :clock-keep has precedence over :clock-resume.
  193. When setting both to t, the current clock will run and
  194. the previous one will not be resumed.
  195. :time-prompt Prompt for a date/time to be used for date/week trees
  196. and when filling the template.
  197. :tree-type When `week', make a week tree instead of the month tree.
  198. :unnarrowed Do not narrow the target buffer, simply show the
  199. full buffer. Default is to narrow it so that you
  200. only see the new stuff.
  201. :table-line-pos Specification of the location in the table where the
  202. new line should be inserted. It should be a string like
  203. \"II-3\", meaning that the new line should become the
  204. third line before the second horizontal separator line.
  205. :kill-buffer If the target file was not yet visited by a buffer when
  206. capture was invoked, kill the buffer again after capture
  207. is finalized.
  208. The template defines the text to be inserted. Often this is an
  209. Org mode entry (so the first line should start with a star) that
  210. will be filed as a child of the target headline. It can also be
  211. freely formatted text. Furthermore, the following %-escapes will
  212. be replaced with content and expanded:
  213. %[pathname] Insert the contents of the file given by
  214. `pathname'. These placeholders are expanded at the very
  215. beginning of the process so they can be used to extend the
  216. current template.
  217. %(sexp) Evaluate elisp `(sexp)' and replace it with the results.
  218. Only placeholders pre-existing within the template, or
  219. introduced with %[pathname] are expanded this way. Since this
  220. happens after expanding non-interactive %-escapes, those can
  221. be used to fill the expression.
  222. %<...> The result of format-time-string on the ... format specification.
  223. %t Time stamp, date only. The time stamp is the current time,
  224. except when called from agendas with `\\[org-agenda-capture]' or
  225. with `org-capture-use-agenda-date' set.
  226. %T Time stamp as above, with date and time.
  227. %u, %U Like the above, but inactive time stamps.
  228. %i Initial content, copied from the active region. If %i is
  229. indented, the entire inserted text will be indented as well.
  230. %a Annotation, normally the link created with `org-store-link'.
  231. %A Like %a, but prompt for the description part.
  232. %l Like %a, but only insert the literal link.
  233. %c Current kill ring head.
  234. %x Content of the X clipboard.
  235. %k Title of currently clocked task.
  236. %K Link to currently clocked task.
  237. %n User name (taken from the variable `user-full-name').
  238. %f File visited by current buffer when org-capture was called.
  239. %F Full path of the file or directory visited by current buffer.
  240. %:keyword Specific information for certain link types, see below.
  241. %^g Prompt for tags, with completion on tags in target file.
  242. %^G Prompt for tags, with completion on all tags in all agenda files.
  243. %^t Like %t, but prompt for date. Similarly %^T, %^u, %^U.
  244. You may define a prompt like: %^{Please specify birthday}t.
  245. The default date is that of %t, see above.
  246. %^C Interactive selection of which kill or clip to use.
  247. %^L Like %^C, but insert as link.
  248. %^{prop}p Prompt the user for a value for property `prop'.
  249. %^{prompt} Prompt the user for a string and replace this sequence with it.
  250. A default value and a completion table ca be specified like this:
  251. %^{prompt|default|completion2|completion3|...}.
  252. %? After completing the template, position cursor here.
  253. %\\1 ... %\\N Insert the text entered at the nth %^{prompt}, where N
  254. is a number, starting from 1.
  255. Apart from these general escapes, you can access information specific to
  256. the link type that is created. For example, calling `org-capture' in emails
  257. or in Gnus will record the author and the subject of the message, which you
  258. can access with \"%:from\" and \"%:subject\", respectively. Here is a
  259. complete list of what is recorded for each link type.
  260. Link type | Available information
  261. ------------------------+------------------------------------------------------
  262. bbdb | %:type %:name %:company
  263. vm, wl, mh, mew, rmail, | %:type %:subject %:message-id
  264. gnus | %:from %:fromname %:fromaddress
  265. | %:to %:toname %:toaddress
  266. | %:fromto (either \"to NAME\" or \"from NAME\")
  267. | %:date %:date-timestamp (as active timestamp)
  268. | %:date-timestamp-inactive (as inactive timestamp)
  269. gnus | %:group, for messages also all email fields
  270. eww, w3, w3m | %:type %:url
  271. info | %:type %:file %:node
  272. calendar | %:type %:date
  273. When you need to insert a literal percent sign in the template,
  274. you can escape ambiguous cases with a backward slash, e.g., \\%i."
  275. :group 'org-capture
  276. :version "24.1"
  277. :set (lambda (s v) (set s (org-capture-upgrade-templates v)))
  278. :type
  279. (let ((file-variants '(choice :tag "Filename "
  280. (file :tag "Literal")
  281. (function :tag "Function")
  282. (variable :tag "Variable")
  283. (sexp :tag "Form"))))
  284. `(repeat
  285. (choice :value ("" "" entry (file "~/org/notes.org") "")
  286. (list :tag "Multikey description"
  287. (string :tag "Keys ")
  288. (string :tag "Description"))
  289. (list :tag "Template entry"
  290. (string :tag "Keys ")
  291. (string :tag "Description ")
  292. (choice :tag "Capture Type " :value entry
  293. (const :tag "Org entry" entry)
  294. (const :tag "Plain list item" item)
  295. (const :tag "Checkbox item" checkitem)
  296. (const :tag "Plain text" plain)
  297. (const :tag "Table line" table-line))
  298. (choice :tag "Target location"
  299. (list :tag "File"
  300. (const :format "" file)
  301. ,file-variants)
  302. (list :tag "ID"
  303. (const :format "" id)
  304. (string :tag " ID"))
  305. (list :tag "File & Headline"
  306. (const :format "" file+headline)
  307. ,file-variants
  308. (string :tag " Headline"))
  309. (list :tag "File & Outline path"
  310. (const :format "" file+olp)
  311. ,file-variants
  312. (repeat :tag "Outline path" :inline t
  313. (string :tag "Headline")))
  314. (list :tag "File & Regexp"
  315. (const :format "" file+regexp)
  316. ,file-variants
  317. (regexp :tag " Regexp"))
  318. (list :tag "File [ & Outline path ] & Date tree"
  319. (const :format "" file+olp+datetree)
  320. ,file-variants
  321. (option (repeat :tag "Outline path" :inline t
  322. (string :tag "Headline"))))
  323. (list :tag "File & function"
  324. (const :format "" file+function)
  325. ,file-variants
  326. (sexp :tag " Function"))
  327. (list :tag "Current clocking task"
  328. (const :format "" clock))
  329. (list :tag "Function"
  330. (const :format "" function)
  331. (sexp :tag " Function")))
  332. (choice :tag "Template "
  333. (string)
  334. (list :tag "File"
  335. (const :format "" file)
  336. (file :tag "Template file"))
  337. (list :tag "Function"
  338. (const :format "" function)
  339. (function :tag "Template function")))
  340. (plist :inline t
  341. ;; Give the most common options as checkboxes
  342. :options (((const :format "%v " :prepend) (const t))
  343. ((const :format "%v " :immediate-finish) (const t))
  344. ((const :format "%v " :jump-to-captured) (const t))
  345. ((const :format "%v " :empty-lines) (const 1))
  346. ((const :format "%v " :empty-lines-before) (const 1))
  347. ((const :format "%v " :empty-lines-after) (const 1))
  348. ((const :format "%v " :clock-in) (const t))
  349. ((const :format "%v " :clock-keep) (const t))
  350. ((const :format "%v " :clock-resume) (const t))
  351. ((const :format "%v " :time-prompt) (const t))
  352. ((const :format "%v " :tree-type) (const week))
  353. ((const :format "%v " :unnarrowed) (const t))
  354. ((const :format "%v " :table-line-pos) (string))
  355. ((const :format "%v " :kill-buffer) (const t)))))))))
  356. (defcustom org-capture-before-finalize-hook nil
  357. "Hook that is run right before a capture process is finalized.
  358. The capture buffer is still current when this hook runs and it is
  359. widened to the entire buffer."
  360. :group 'org-capture
  361. :version "24.1"
  362. :type 'hook)
  363. (defcustom org-capture-after-finalize-hook nil
  364. "Hook that is run right after a capture process is finalized.
  365. Suitable for window cleanup."
  366. :group 'org-capture
  367. :version "24.1"
  368. :type 'hook)
  369. (defcustom org-capture-prepare-finalize-hook nil
  370. "Hook that is run before the finalization starts.
  371. The capture buffer is current and still narrowed."
  372. :group 'org-capture
  373. :version "24.1"
  374. :type 'hook)
  375. (defcustom org-capture-bookmark t
  376. "When non-nil, add a bookmark pointing at the last stored
  377. position when capturing."
  378. :group 'org-capture
  379. :version "24.3"
  380. :type 'boolean)
  381. ;;; The property list for keeping information about the capture process
  382. (defvar org-capture-plist nil
  383. "Plist for the current capture process, global, to avoid having to pass it.")
  384. (defvar org-capture-current-plist nil
  385. "Local variable holding the plist in a capture buffer.
  386. This is used to store the plist for use when finishing a capture process
  387. because another such process might have changed the global variable by then.
  388. Each time a new capture buffer has been set up, the global `org-capture-plist'
  389. is copied to this variable, which is local in the indirect buffer.")
  390. (defvar org-capture-clock-keep nil
  391. "Local variable to store the value of the :clock-keep parameter.
  392. This is needed in case org-capture-finalize is called interactively.")
  393. (defun org-capture-put (&rest stuff)
  394. "Add properties to the capture property list `org-capture-plist'."
  395. (while stuff
  396. (setq org-capture-plist (plist-put org-capture-plist
  397. (pop stuff) (pop stuff)))))
  398. (defun org-capture-get (prop &optional local)
  399. "Get properties from the capture property list `org-capture-plist'.
  400. When LOCAL is set, use the local variable `org-capture-current-plist',
  401. this is necessary after initialization of the capture process,
  402. to avoid conflicts with other active capture processes."
  403. (plist-get (if local org-capture-current-plist org-capture-plist) prop))
  404. ;;; The minor mode
  405. (defvar org-capture-mode-map
  406. (let ((map (make-sparse-keymap)))
  407. (define-key map "\C-c\C-c" #'org-capture-finalize)
  408. (define-key map "\C-c\C-k" #'org-capture-kill)
  409. (define-key map "\C-c\C-w" #'org-capture-refile)
  410. map)
  411. "Keymap for `org-capture-mode', a minor mode.
  412. Use this map to set additional keybindings for when Org mode is used
  413. for a capture buffer.")
  414. (defvar org-capture-mode-hook nil
  415. "Hook for the `org-capture-mode' minor mode.")
  416. (define-minor-mode org-capture-mode
  417. "Minor mode for special key bindings in a capture buffer.
  418. Turning on this mode runs the normal hook `org-capture-mode-hook'."
  419. nil " Cap" org-capture-mode-map
  420. (setq-local
  421. header-line-format
  422. (substitute-command-keys
  423. "\\<org-capture-mode-map>Capture buffer. Finish \
  424. `\\[org-capture-finalize]', refile `\\[org-capture-refile]', \
  425. abort `\\[org-capture-kill]'.")))
  426. ;;; The main commands
  427. (defvar org-capture-initial nil)
  428. (defvar org-capture-entry nil)
  429. ;;;###autoload
  430. (defun org-capture-string (string &optional keys)
  431. "Capture STRING with the template selected by KEYS."
  432. (interactive "sInitial text: \n")
  433. (let ((org-capture-initial string)
  434. (org-capture-entry (org-capture-select-template keys)))
  435. (org-capture)))
  436. (defcustom org-capture-templates-contexts nil
  437. "Alist of capture templates and valid contexts.
  438. For example, if you have a capture template \"c\" and you want
  439. this template to be accessible only from `message-mode' buffers,
  440. use this:
  441. \\='((\"c\" ((in-mode . \"message-mode\"))))
  442. Here are the available contexts definitions:
  443. in-file: command displayed only in matching files
  444. in-mode: command displayed only in matching modes
  445. not-in-file: command not displayed in matching files
  446. not-in-mode: command not displayed in matching modes
  447. in-buffer: command displayed only in matching buffers
  448. not-in-buffer: command not displayed in matching buffers
  449. [function]: a custom function taking no argument
  450. If you define several checks, the agenda command will be
  451. accessible if there is at least one valid check.
  452. You can also bind a key to another capture template depending on
  453. contextual rules.
  454. \\='((\"c\" \"d\" ((in-mode . \"message-mode\"))))
  455. Here it means: in `message-mode buffers', use \"c\" as the
  456. key for the capture template otherwise associated with \"d\".
  457. \(The template originally associated with \"d\" is not displayed
  458. to avoid duplicates.)"
  459. :version "24.3"
  460. :group 'org-capture
  461. :type '(repeat (list :tag "Rule"
  462. (string :tag " Capture key")
  463. (string :tag "Replace by template")
  464. (repeat :tag "Available when"
  465. (choice
  466. (cons :tag "Condition"
  467. (choice
  468. (const :tag "In file" in-file)
  469. (const :tag "Not in file" not-in-file)
  470. (const :tag "In buffer" in-buffer)
  471. (const :tag "Not in buffer" not-in-buffer)
  472. (const :tag "In mode" in-mode)
  473. (const :tag "Not in mode" not-in-mode))
  474. (regexp))
  475. (function :tag "Custom function"))))))
  476. (defcustom org-capture-use-agenda-date nil
  477. "Non-nil means use the date at point when capturing from agendas.
  478. When nil, you can still capture using the date at point with
  479. `\\[org-agenda-capture]'."
  480. :group 'org-capture
  481. :version "24.3"
  482. :type 'boolean)
  483. ;;;###autoload
  484. (defun org-capture (&optional goto keys)
  485. "Capture something.
  486. \\<org-capture-mode-map>
  487. This will let you select a template from `org-capture-templates', and
  488. then file the newly captured information. The text is immediately
  489. inserted at the target location, and an indirect buffer is shown where
  490. you can edit it. Pressing `\\[org-capture-finalize]' brings you back to the \
  491. previous
  492. state of Emacs, so that you can continue your work.
  493. When called interactively with a `\\[universal-argument]' prefix argument \
  494. GOTO, don't
  495. capture anything, just go to the file/headline where the selected
  496. template stores its notes.
  497. With a `\\[universal-argument] \\[universal-argument]' prefix argument, go to \
  498. the last note stored.
  499. When called with a `C-0' (zero) prefix, insert a template at point.
  500. When called with a `C-1' (one) prefix, force prompting for a date when
  501. a datetree entry is made.
  502. ELisp programs can set KEYS to a string associated with a template
  503. in `org-capture-templates'. In this case, interactive selection
  504. will be bypassed.
  505. If `org-capture-use-agenda-date' is non-nil, capturing from the
  506. agenda will use the date at point as the default date. Then, a
  507. `C-1' prefix will tell the capture process to use the HH:MM time
  508. of the day at point (if any) or the current HH:MM time."
  509. (interactive "P")
  510. (when (and org-capture-use-agenda-date
  511. (eq major-mode 'org-agenda-mode))
  512. (setq org-overriding-default-time
  513. (org-get-cursor-date (equal goto 1))))
  514. (cond
  515. ((equal goto '(4)) (org-capture-goto-target))
  516. ((equal goto '(16)) (org-capture-goto-last-stored))
  517. (t
  518. (let* ((orig-buf (current-buffer))
  519. (annotation (if (and (boundp 'org-capture-link-is-already-stored)
  520. org-capture-link-is-already-stored)
  521. (plist-get org-store-link-plist :annotation)
  522. (ignore-errors (org-store-link nil))))
  523. (entry (or org-capture-entry (org-capture-select-template keys)))
  524. initial)
  525. (setq initial (or org-capture-initial
  526. (and (org-region-active-p)
  527. (buffer-substring (point) (mark)))))
  528. (when (stringp initial)
  529. (remove-text-properties 0 (length initial) '(read-only t) initial))
  530. (when (stringp annotation)
  531. (remove-text-properties 0 (length annotation)
  532. '(read-only t) annotation))
  533. (cond
  534. ((equal entry "C")
  535. (customize-variable 'org-capture-templates))
  536. ((equal entry "q")
  537. (user-error "Abort"))
  538. (t
  539. (org-capture-set-plist entry)
  540. (org-capture-get-template)
  541. (org-capture-put :original-buffer orig-buf
  542. :original-file (or (buffer-file-name orig-buf)
  543. (and (featurep 'dired)
  544. (car (rassq orig-buf
  545. dired-buffers))))
  546. :original-file-nondirectory
  547. (and (buffer-file-name orig-buf)
  548. (file-name-nondirectory
  549. (buffer-file-name orig-buf)))
  550. :annotation annotation
  551. :initial initial
  552. :return-to-wconf (current-window-configuration)
  553. :default-time
  554. (or org-overriding-default-time
  555. (org-current-time)))
  556. (org-capture-set-target-location)
  557. (condition-case error
  558. (org-capture-put :template (org-capture-fill-template))
  559. ((error quit)
  560. (if (get-buffer "*Capture*") (kill-buffer "*Capture*"))
  561. (error "Capture abort: %s" error)))
  562. (setq org-capture-clock-keep (org-capture-get :clock-keep))
  563. (if (equal goto 0)
  564. ;;insert at point
  565. (org-capture-insert-template-here)
  566. (condition-case error
  567. (org-capture-place-template
  568. (eq (car (org-capture-get :target)) 'function))
  569. ((error quit)
  570. (if (and (buffer-base-buffer (current-buffer))
  571. (string-prefix-p "CAPTURE-" (buffer-name)))
  572. (kill-buffer (current-buffer)))
  573. (set-window-configuration (org-capture-get :return-to-wconf))
  574. (error "Capture template `%s': %s"
  575. (org-capture-get :key)
  576. (nth 1 error))))
  577. (if (and (derived-mode-p 'org-mode)
  578. (org-capture-get :clock-in))
  579. (condition-case nil
  580. (progn
  581. (if (org-clock-is-active)
  582. (org-capture-put :interrupted-clock
  583. (copy-marker org-clock-marker)))
  584. (org-clock-in)
  585. (setq-local org-capture-clock-was-started t))
  586. (error
  587. "Could not start the clock in this capture buffer")))
  588. (if (org-capture-get :immediate-finish)
  589. (org-capture-finalize)))))))))
  590. (defun org-capture-get-template ()
  591. "Get the template from a file or a function if necessary."
  592. (let ((txt (org-capture-get :template)) file)
  593. (cond
  594. ((and (listp txt) (eq (car txt) 'file))
  595. (if (file-exists-p
  596. (setq file (expand-file-name (nth 1 txt) org-directory)))
  597. (setq txt (org-file-contents file))
  598. (setq txt (format "* Template file %s not found" (nth 1 txt)))))
  599. ((and (listp txt) (eq (car txt) 'function))
  600. (if (fboundp (nth 1 txt))
  601. (setq txt (funcall (nth 1 txt)))
  602. (setq txt (format "* Template function %s not found" (nth 1 txt)))))
  603. ((not txt) (setq txt ""))
  604. ((stringp txt))
  605. (t (setq txt "* Invalid capture template")))
  606. (org-capture-put :template txt)))
  607. (defun org-capture-finalize (&optional stay-with-capture)
  608. "Finalize the capture process.
  609. With prefix argument STAY-WITH-CAPTURE, jump to the location of the
  610. captured item after finalizing."
  611. (interactive "P")
  612. (when (org-capture-get :jump-to-captured)
  613. (setq stay-with-capture t))
  614. (unless (and org-capture-mode
  615. (buffer-base-buffer (current-buffer)))
  616. (error "This does not seem to be a capture buffer for Org mode"))
  617. (run-hooks 'org-capture-prepare-finalize-hook)
  618. ;; Did we start the clock in this capture buffer?
  619. (when (and org-capture-clock-was-started
  620. org-clock-marker
  621. (eq (marker-buffer org-clock-marker) (buffer-base-buffer))
  622. (>= org-clock-marker (point-min))
  623. (< org-clock-marker (point-max)))
  624. ;; Looks like the clock we started is still running.
  625. (if org-capture-clock-keep
  626. ;; User may have completed clocked heading from the template.
  627. ;; Refresh clock mode line.
  628. (org-clock-update-mode-line t)
  629. ;; Clock out. Possibly resume interrupted clock.
  630. (let (org-log-note-clock-out) (org-clock-out))
  631. (when (and (org-capture-get :clock-resume 'local)
  632. (markerp (org-capture-get :interrupted-clock 'local))
  633. (buffer-live-p (marker-buffer
  634. (org-capture-get :interrupted-clock 'local))))
  635. (let ((clock-in-task (org-capture-get :interrupted-clock 'local)))
  636. (org-with-point-at clock-in-task (org-clock-in)))
  637. (message "Interrupted clock has been resumed"))))
  638. (let ((abort-note nil))
  639. ;; Store the size of the capture buffer
  640. (org-capture-put :captured-entry-size (- (point-max) (point-min)))
  641. (widen)
  642. ;; Store the insertion point in the target buffer
  643. (org-capture-put :insertion-point (point))
  644. (if org-note-abort
  645. (let ((beg (org-capture-get :begin-marker 'local))
  646. (end (org-capture-get :end-marker 'local)))
  647. (if (not (and beg end)) (setq abort-note 'dirty)
  648. (setq abort-note t)
  649. (org-with-wide-buffer (kill-region beg end))))
  650. ;; Postprocessing: Update Statistics cookies, do the sorting
  651. (when (derived-mode-p 'org-mode)
  652. (save-excursion
  653. (when (ignore-errors (org-back-to-heading))
  654. (org-update-parent-todo-statistics)
  655. (org-update-checkbox-count)))
  656. ;; FIXME Here we should do the sorting
  657. ;; If we have added a table line, maybe recompute?
  658. (when (and (eq (org-capture-get :type 'local) 'table-line)
  659. (org-at-table-p))
  660. (if (org-table-get-stored-formulas)
  661. (org-table-recalculate 'all) ;; FIXME: Should we iterate???
  662. (org-table-align))))
  663. ;; Store this place as the last one where we stored something
  664. ;; Do the marking in the base buffer, so that it makes sense after
  665. ;; the indirect buffer has been killed.
  666. (org-capture-store-last-position)
  667. ;; Run the hook
  668. (run-hooks 'org-capture-before-finalize-hook))
  669. (when (org-capture-get :decrypted)
  670. (save-excursion
  671. (goto-char (org-capture-get :decrypted))
  672. (org-encrypt-entry)))
  673. ;; Kill the indirect buffer
  674. (let ((return-wconf (org-capture-get :return-to-wconf 'local))
  675. (new-buffer (org-capture-get :new-buffer 'local))
  676. (kill-buffer (org-capture-get :kill-buffer 'local))
  677. (base-buffer (buffer-base-buffer (current-buffer))))
  678. ;; Kill the indirect buffer
  679. (kill-buffer (current-buffer))
  680. ;; Narrow back the target buffer to its previous state
  681. (with-current-buffer (org-capture-get :buffer)
  682. (let ((reg (org-capture-get :initial-target-region))
  683. (pos (org-capture-get :initial-target-position))
  684. (ipt (org-capture-get :insertion-point))
  685. (size (org-capture-get :captured-entry-size)))
  686. (if (not reg)
  687. (widen)
  688. (cond ((< ipt (car reg))
  689. ;; insertion point is before the narrowed region
  690. (narrow-to-region (+ size (car reg)) (+ size (cdr reg))))
  691. ((> ipt (cdr reg))
  692. ;; insertion point is after the narrowed region
  693. (narrow-to-region (car reg) (cdr reg)))
  694. (t
  695. ;; insertion point is within the narrowed region
  696. (narrow-to-region (car reg) (+ size (cdr reg)))))
  697. ;; now place back the point at its original position
  698. (if (< ipt (car reg))
  699. (goto-char (+ size pos))
  700. (goto-char (if (< ipt pos) (+ size pos) pos))))))
  701. ;; Kill the target buffer if that is desired
  702. (when (and base-buffer new-buffer kill-buffer)
  703. (with-current-buffer base-buffer (save-buffer))
  704. (kill-buffer base-buffer))
  705. ;; Restore the window configuration before capture
  706. (set-window-configuration return-wconf))
  707. (run-hooks 'org-capture-after-finalize-hook)
  708. ;; Special cases
  709. (cond
  710. (abort-note
  711. (cl-case abort-note
  712. (clean
  713. (message "Capture process aborted and target buffer cleaned up"))
  714. (dirty
  715. (error "Capture process aborted, but target buffer could not be \
  716. cleaned up correctly"))))
  717. (stay-with-capture
  718. (org-capture-goto-last-stored)))
  719. ;; Return if we did store something
  720. (not abort-note)))
  721. (defun org-capture-refile ()
  722. "Finalize the current capture and then refile the entry.
  723. Refiling is done from the base buffer, because the indirect buffer is then
  724. already gone. Any prefix argument will be passed to the refile command."
  725. (interactive)
  726. (unless (eq (org-capture-get :type 'local) 'entry)
  727. (user-error "Refiling from a capture buffer makes only sense \
  728. for `entry'-type templates"))
  729. (let* ((base (or (buffer-base-buffer) (current-buffer)))
  730. (pos (make-marker))
  731. (org-capture-is-refiling t)
  732. (kill-buffer (org-capture-get :kill-buffer 'local))
  733. (jump-to-captured (org-capture-get :jump-to-captured 'local)))
  734. ;; Since `org-capture-finalize' may alter buffer contents (e.g.,
  735. ;; empty lines) around entry, use a marker to refer to the
  736. ;; headline to be refiled. Place the marker in the base buffer,
  737. ;; as the current indirect one is going to be killed.
  738. (set-marker pos (save-excursion (org-back-to-heading t) (point)) base)
  739. ;; `org-capture-finalize' calls `org-capture-goto-last-stored' too
  740. ;; early. We want to wait for the refiling to be over, so we
  741. ;; control when the latter function is called.
  742. (org-capture-put :kill-buffer nil :jump-to-captured nil)
  743. (unwind-protect
  744. (progn
  745. (org-capture-finalize)
  746. (save-window-excursion
  747. (with-current-buffer base
  748. (org-with-wide-buffer
  749. (goto-char pos)
  750. (call-interactively 'org-refile))))
  751. (when kill-buffer (kill-buffer base))
  752. (when jump-to-captured (org-capture-goto-last-stored)))
  753. (set-marker pos nil))))
  754. (defun org-capture-kill ()
  755. "Abort the current capture process."
  756. (interactive)
  757. ;; FIXME: This does not do the right thing, we need to remove the
  758. ;; new stuff by hand it is easy: undo, then kill the buffer
  759. (let ((org-note-abort t)
  760. (org-capture-before-finalize-hook nil))
  761. (org-capture-finalize)))
  762. (defun org-capture-goto-last-stored ()
  763. "Go to the location where the last capture note was stored."
  764. (interactive)
  765. (org-goto-marker-or-bmk org-capture-last-stored-marker
  766. (plist-get org-bookmark-names-plist
  767. :last-capture))
  768. (message "This is the last note stored by a capture process"))
  769. ;;; Supporting functions for handling the process
  770. (defun org-capture-put-target-region-and-position ()
  771. "Store the initial region with `org-capture-put'."
  772. (org-capture-put
  773. :initial-target-region
  774. ;; Check if the buffer is currently narrowed
  775. (when (org-buffer-narrowed-p)
  776. (cons (point-min) (point-max))))
  777. ;; store the current point
  778. (org-capture-put :initial-target-position (point)))
  779. (defvar org-time-was-given) ; dynamically scoped parameter
  780. (defun org-capture-set-target-location (&optional target)
  781. "Find TARGET buffer and position.
  782. Store them in the capture property list."
  783. (let ((target-entry-p t))
  784. (save-excursion
  785. (pcase (or target (org-capture-get :target))
  786. (`(file ,path)
  787. (set-buffer (org-capture-target-buffer path))
  788. (org-capture-put-target-region-and-position)
  789. (widen)
  790. (setq target-entry-p nil))
  791. (`(id ,id)
  792. (pcase (org-id-find id)
  793. (`(,path . ,position)
  794. (set-buffer (org-capture-target-buffer path))
  795. (widen)
  796. (org-capture-put-target-region-and-position)
  797. (goto-char position))
  798. (_ (error "Cannot find target ID \"%s\"" id))))
  799. (`(file+headline ,path ,headline)
  800. (set-buffer (org-capture-target-buffer path))
  801. ;; Org expects the target file to be in Org mode, otherwise
  802. ;; it throws an error. However, the default notes files
  803. ;; should work out of the box. In this case, we switch it to
  804. ;; Org mode.
  805. (unless (derived-mode-p 'org-mode)
  806. (org-display-warning
  807. (format "Capture requirement: switching buffer %S to Org mode"
  808. (current-buffer)))
  809. (org-mode))
  810. (org-capture-put-target-region-and-position)
  811. (widen)
  812. (goto-char (point-min))
  813. (if (re-search-forward (format org-complex-heading-regexp-format
  814. (regexp-quote headline))
  815. nil t)
  816. (beginning-of-line)
  817. (goto-char (point-max))
  818. (unless (bolp) (insert "\n"))
  819. (insert "* " headline "\n")
  820. (beginning-of-line 0)))
  821. (`(file+olp ,path . ,outline-path)
  822. (let ((m (org-find-olp (cons (org-capture-expand-file path)
  823. outline-path))))
  824. (set-buffer (marker-buffer m))
  825. (org-capture-put-target-region-and-position)
  826. (widen)
  827. (goto-char m)
  828. (set-marker m nil)))
  829. (`(file+regexp ,path ,regexp)
  830. (set-buffer (org-capture-target-buffer path))
  831. (org-capture-put-target-region-and-position)
  832. (widen)
  833. (goto-char (point-min))
  834. (if (not (re-search-forward regexp nil t))
  835. (error "No match for target regexp in file %s" path)
  836. (goto-char (if (org-capture-get :prepend)
  837. (match-beginning 0)
  838. (match-end 0)))
  839. (org-capture-put :exact-position (point))
  840. (setq target-entry-p
  841. (and (derived-mode-p 'org-mode) (org-at-heading-p)))))
  842. (`(file+olp+datetree ,path . ,outline-path)
  843. (let ((m (if outline-path
  844. (org-find-olp (cons (org-capture-expand-file path)
  845. outline-path))
  846. (set-buffer (org-capture-target-buffer path))
  847. (point-marker))))
  848. (set-buffer (marker-buffer m))
  849. (org-capture-put-target-region-and-position)
  850. (widen)
  851. (goto-char m)
  852. (set-marker m nil)
  853. (require 'org-datetree)
  854. (org-capture-put-target-region-and-position)
  855. (widen)
  856. ;; Make a date/week tree entry, with the current date (or
  857. ;; yesterday, if we are extending dates for a couple of hours)
  858. (funcall
  859. (if (eq (org-capture-get :tree-type) 'week)
  860. #'org-datetree-find-iso-week-create
  861. #'org-datetree-find-date-create)
  862. (calendar-gregorian-from-absolute
  863. (cond
  864. (org-overriding-default-time
  865. ;; Use the overriding default time.
  866. (time-to-days org-overriding-default-time))
  867. ((or (org-capture-get :time-prompt)
  868. (equal current-prefix-arg 1))
  869. ;; Prompt for date.
  870. (let ((prompt-time (org-read-date
  871. nil t nil "Date for tree entry:"
  872. (current-time))))
  873. (org-capture-put
  874. :default-time
  875. (cond ((and (or (not (boundp 'org-time-was-given))
  876. (not org-time-was-given))
  877. (not (= (time-to-days prompt-time) (org-today))))
  878. ;; Use 00:00 when no time is given for another
  879. ;; date than today?
  880. (apply #'encode-time
  881. (append `(0 0 ,org-extend-today-until)
  882. (cl-cdddr (decode-time prompt-time)))))
  883. ((string-match "\\([^ ]+\\)--?[^ ]+[ ]+\\(.*\\)"
  884. org-read-date-final-answer)
  885. ;; Replace any time range by its start.
  886. (apply #'encode-time
  887. (org-read-date-analyze
  888. (replace-match "\\1 \\2" nil nil
  889. org-read-date-final-answer)
  890. prompt-time (decode-time prompt-time))))
  891. (t prompt-time)))
  892. (time-to-days prompt-time)))
  893. (t
  894. ;; Current date, possibly corrected for late night
  895. ;; workers.
  896. (org-today))))
  897. ;; the following is the keep-restriction argument for
  898. ;; org-datetree-find-date-create
  899. (when outline-path 'subtree-at-point))))
  900. (`(file+function ,path ,function)
  901. (set-buffer (org-capture-target-buffer path))
  902. (org-capture-put-target-region-and-position)
  903. (widen)
  904. (funcall function)
  905. (org-capture-put :exact-position (point))
  906. (setq target-entry-p
  907. (and (derived-mode-p 'org-mode) (org-at-heading-p))))
  908. (`(function ,fun)
  909. (funcall fun)
  910. (org-capture-put :exact-position (point))
  911. (setq target-entry-p
  912. (and (derived-mode-p 'org-mode) (org-at-heading-p))))
  913. (`(clock)
  914. (if (and (markerp org-clock-hd-marker)
  915. (marker-buffer org-clock-hd-marker))
  916. (progn (set-buffer (marker-buffer org-clock-hd-marker))
  917. (org-capture-put-target-region-and-position)
  918. (widen)
  919. (goto-char org-clock-hd-marker))
  920. (error "No running clock that could be used as capture target")))
  921. (target (error "Invalid capture target specification: %S" target)))
  922. (org-capture-put :buffer (current-buffer)
  923. :pos (point)
  924. :target-entry-p target-entry-p
  925. :decrypted
  926. (and (featurep 'org-crypt)
  927. (org-at-encrypted-entry-p)
  928. (save-excursion
  929. (org-decrypt-entry)
  930. (and (org-back-to-heading t) (point))))))))
  931. (defun org-capture-expand-file (file)
  932. "Expand functions, symbols and file names for FILE.
  933. When FILE is a function, call it. When it is a form, evaluate
  934. it. When it is a variable, return its value. When it is
  935. a string, treat it as a file name, possibly expanding it
  936. according to `org-directory', and return it. If it is the empty
  937. string, however, return `org-default-notes-file'. In any other
  938. case, raise an error."
  939. (let ((location (cond ((equal file "") org-default-notes-file)
  940. ((stringp file) (expand-file-name file org-directory))
  941. ((functionp file) (funcall file))
  942. ((and (symbolp file) (boundp file)) (symbol-value file))
  943. (t nil))))
  944. (or (org-string-nw-p location)
  945. (error "Invalid file location: %S" location))))
  946. (defun org-capture-target-buffer (file)
  947. "Get a buffer for FILE.
  948. FILE is a generalized file location, as handled by
  949. `org-capture-expand-file'."
  950. (let ((file (org-capture-expand-file file)))
  951. (or (org-find-base-buffer-visiting file)
  952. (progn (org-capture-put :new-buffer t)
  953. (find-file-noselect file)))))
  954. (defun org-capture-place-template (&optional inhibit-wconf-store)
  955. "Insert the template at the target location, and display the buffer.
  956. When `inhibit-wconf-store', don't store the window configuration, as it
  957. may have been stored before."
  958. (unless inhibit-wconf-store
  959. (org-capture-put :return-to-wconf (current-window-configuration)))
  960. (delete-other-windows)
  961. (org-switch-to-buffer-other-window
  962. (org-capture-get-indirect-buffer (org-capture-get :buffer) "CAPTURE"))
  963. (widen)
  964. (org-show-all)
  965. (goto-char (org-capture-get :pos))
  966. (setq-local outline-level 'org-outline-level)
  967. (pcase (org-capture-get :type)
  968. ((or `nil `entry) (org-capture-place-entry))
  969. (`table-line (org-capture-place-table-line))
  970. (`plain (org-capture-place-plain-text))
  971. (`item (org-capture-place-item))
  972. (`checkitem (org-capture-place-item)))
  973. (org-capture-mode 1)
  974. (setq-local org-capture-current-plist org-capture-plist))
  975. (defun org-capture-place-entry ()
  976. "Place the template as a new Org entry."
  977. (let ((reversed? (org-capture-get :prepend))
  978. (level 1))
  979. (when (org-capture-get :exact-position)
  980. (goto-char (org-capture-get :exact-position)))
  981. (cond
  982. ;; Insert as a child of the current entry.
  983. ((org-capture-get :target-entry-p)
  984. (setq level (org-get-valid-level
  985. (if (org-at-heading-p) (org-outline-level) 1)
  986. 1))
  987. (if reversed? (outline-next-heading) (org-end-of-subtree t t)))
  988. ;; Insert as a top-level entry at the beginning of the file.
  989. (reversed?
  990. (goto-char (point-min))
  991. (unless (org-at-heading-p) (outline-next-heading)))
  992. ;; Otherwise, insert as a top-level entry at the end of the file.
  993. (t (goto-char (point-max))))
  994. (unless (bolp) (insert "\n"))
  995. (org-capture-empty-lines-before)
  996. (let ((beg (point))
  997. (template (org-capture-get :template)))
  998. (org-capture-verify-tree template)
  999. (org-paste-subtree level template 'for-yank)
  1000. (org-capture-empty-lines-after)
  1001. (org-capture-position-for-last-stored beg)
  1002. (unless (org-at-heading-p) (outline-next-heading))
  1003. (let ((end (point)))
  1004. (org-capture-mark-kill-region beg end)
  1005. (org-capture-narrow beg end)
  1006. (when (or (re-search-backward "%\\?" beg t)
  1007. (re-search-forward "%\\?" end t))
  1008. (replace-match ""))))))
  1009. (defun org-capture-place-item ()
  1010. "Place the template as a new plain list item."
  1011. (let* ((txt (org-capture-get :template))
  1012. (target-entry-p (org-capture-get :target-entry-p))
  1013. (ind 0)
  1014. beg end)
  1015. (if (org-capture-get :exact-position)
  1016. (goto-char (org-capture-get :exact-position))
  1017. (cond
  1018. ((not target-entry-p)
  1019. ;; Insert as top-level entry, either at beginning or at end of file
  1020. (setq beg (point-min) end (point-max)))
  1021. (t
  1022. (setq beg (1+ (point-at-eol))
  1023. end (save-excursion (outline-next-heading) (point)))))
  1024. (setq ind nil)
  1025. (if (org-capture-get :prepend)
  1026. (progn
  1027. (goto-char beg)
  1028. (when (org-list-search-forward (org-item-beginning-re) end t)
  1029. (goto-char (match-beginning 0))
  1030. (setq ind (current-indentation))))
  1031. (goto-char end)
  1032. (when (org-list-search-backward (org-item-beginning-re) beg t)
  1033. (setq ind (current-indentation))
  1034. (org-end-of-item)))
  1035. (unless ind (goto-char end)))
  1036. ;; Remove common indentation
  1037. (setq txt (org-remove-indentation txt))
  1038. ;; Make sure this is indeed an item
  1039. (unless (string-match (concat "\\`" (org-item-re)) txt)
  1040. (setq txt (concat "- "
  1041. (mapconcat 'identity (split-string txt "\n")
  1042. "\n "))))
  1043. ;; Prepare surrounding empty lines.
  1044. (unless (bolp) (insert "\n"))
  1045. (org-capture-empty-lines-before)
  1046. (setq beg (point))
  1047. (unless (eolp) (save-excursion (insert "\n")))
  1048. (unless ind
  1049. (org-indent-line)
  1050. (setq ind (current-indentation))
  1051. (delete-region beg (point)))
  1052. ;; Set the correct indentation, depending on context
  1053. (setq ind (make-string ind ?\ ))
  1054. (setq txt (concat ind
  1055. (mapconcat 'identity (split-string txt "\n")
  1056. (concat "\n" ind))
  1057. "\n"))
  1058. ;; Insert item.
  1059. (insert txt)
  1060. (org-capture-empty-lines-after)
  1061. (org-capture-position-for-last-stored beg)
  1062. (setq end (point))
  1063. (org-capture-mark-kill-region beg end)
  1064. (org-capture-narrow beg end)
  1065. (when (or (re-search-backward "%\\?" beg t)
  1066. (re-search-forward "%\\?" end t))
  1067. (replace-match ""))))
  1068. (defun org-capture-place-table-line ()
  1069. "Place the template as a table line."
  1070. (require 'org-table)
  1071. (let ((text
  1072. (pcase (org-trim (org-capture-get :template))
  1073. ((pred (string-match-p org-table-border-regexp))
  1074. "| %?Bad template |")
  1075. (text (concat text "\n"))))
  1076. (table-line-pos (org-capture-get :table-line-pos))
  1077. beg end)
  1078. (cond
  1079. ((org-capture-get :exact-position)
  1080. (setq beg (org-capture-get :exact-position))
  1081. (setq end (save-excursion (outline-next-heading) (point))))
  1082. ((not (org-capture-get :target-entry-p))
  1083. ;; Table is not necessarily under a heading. Find first table
  1084. ;; in the buffer.
  1085. (setq beg (point-min) end (point-max)))
  1086. (t
  1087. ;; We are at a heading, limit search to the body.
  1088. (setq beg (line-beginning-position 2))
  1089. (setq end (save-excursion (outline-next-heading) (point)))))
  1090. (goto-char beg)
  1091. ;; Narrow to the table, possibly creating one if necessary.
  1092. (catch :found
  1093. (while (re-search-forward org-table-dataline-regexp end t)
  1094. (pcase (org-element-lineage (org-element-at-point) '(table) t)
  1095. (`nil nil)
  1096. (table
  1097. (goto-char (org-element-property :end table))
  1098. (skip-chars-backward " \r\t\n")
  1099. (forward-line)
  1100. (narrow-to-region (org-element-property :post-affiliated table)
  1101. (point))
  1102. (throw :found t))))
  1103. ;; No table found. Create it with an empty header.
  1104. (goto-char end)
  1105. (unless (bolp) (insert "\n"))
  1106. (let ((origin (point)))
  1107. (insert "| |\n|----|\n")
  1108. (narrow-to-region origin (point))))
  1109. ;; In the current table, find the appropriate location for TEXT.
  1110. (cond
  1111. ((and table-line-pos
  1112. (string-match "\\(I+\\)\\([-+][0-9]+\\)" table-line-pos))
  1113. (goto-char (point-min))
  1114. (let ((line
  1115. (condition-case _
  1116. (progn
  1117. (save-match-data (org-table-analyze))
  1118. (aref org-table-hlines
  1119. (- (match-end 1) (match-beginning 1))))
  1120. (error
  1121. (error "Invalid table line specification %S" table-line-pos))))
  1122. (delta (string-to-number (match-string 2 table-line-pos))))
  1123. (forward-line (+ line delta (if (< delta 0) 0 -1)))
  1124. (forward-line))) ;insert below
  1125. ((org-capture-get :prepend)
  1126. (goto-char (point-min))
  1127. (cond
  1128. ((not (re-search-forward org-table-hline-regexp nil t)))
  1129. ((re-search-forward org-table-dataline-regexp nil t) (beginning-of-line))
  1130. (t (goto-char (org-table-end)))))
  1131. (t
  1132. (goto-char (org-table-end))))
  1133. ;; Insert text and position point according to template.
  1134. (unless (bolp) (insert "\n"))
  1135. (let ((beg (point))
  1136. (end (save-excursion
  1137. (insert text)
  1138. (point))))
  1139. (org-capture-position-for-last-stored 'table-line)
  1140. (org-capture-mark-kill-region beg end)
  1141. (org-capture-narrow beg end)
  1142. (when (or (re-search-backward "%\\?" beg t)
  1143. (re-search-forward "%\\?" end t))
  1144. (replace-match "")))
  1145. (org-table-align)))
  1146. (defun org-capture-place-plain-text ()
  1147. "Place the template plainly.
  1148. If the target locator points at an Org node, place the template into
  1149. the text of the entry, before the first child. If not, place the
  1150. template at the beginning or end of the file.
  1151. Of course, if exact position has been required, just put it there."
  1152. (let* ((txt (org-capture-get :template))
  1153. beg end)
  1154. (cond
  1155. ((org-capture-get :exact-position)
  1156. (goto-char (org-capture-get :exact-position)))
  1157. ((and (org-capture-get :target-entry-p)
  1158. (bolp)
  1159. (looking-at org-outline-regexp))
  1160. ;; we should place the text into this entry
  1161. (if (org-capture-get :prepend)
  1162. ;; Skip meta data and drawers
  1163. (org-end-of-meta-data t)
  1164. ;; go to ent of the entry text, before the next headline
  1165. (outline-next-heading)))
  1166. (t
  1167. ;; beginning or end of file
  1168. (goto-char (if (org-capture-get :prepend) (point-min) (point-max)))))
  1169. (or (bolp) (newline))
  1170. (org-capture-empty-lines-before)
  1171. (setq beg (point))
  1172. (insert txt)
  1173. (org-capture-empty-lines-after)
  1174. (org-capture-position-for-last-stored beg)
  1175. (setq end (point))
  1176. (org-capture-mark-kill-region beg (1- end))
  1177. (org-capture-narrow beg (1- end))
  1178. (when (or (re-search-backward "%\\?" beg t)
  1179. (re-search-forward "%\\?" end t))
  1180. (replace-match ""))))
  1181. (defun org-capture-mark-kill-region (beg end)
  1182. "Mark the region that will have to be killed when aborting capture."
  1183. (let ((m1 (copy-marker beg))
  1184. (m2 (copy-marker end t)))
  1185. (org-capture-put :begin-marker m1)
  1186. (org-capture-put :end-marker m2)))
  1187. (defun org-capture-position-for-last-stored (where)
  1188. "Memorize the position that should later become the position of last capture."
  1189. (cond
  1190. ((integerp where)
  1191. (org-capture-put :position-for-last-stored
  1192. (move-marker (make-marker) where
  1193. (or (buffer-base-buffer (current-buffer))
  1194. (current-buffer)))))
  1195. ((eq where 'table-line)
  1196. (org-capture-put :position-for-last-stored
  1197. (list 'table-line
  1198. (org-table-current-dline))))
  1199. (t (error "This should not happen"))))
  1200. (defun org-capture-store-last-position ()
  1201. "Store the last-captured position."
  1202. (let* ((where (org-capture-get :position-for-last-stored 'local))
  1203. (pos (cond
  1204. ((markerp where)
  1205. (prog1 (marker-position where)
  1206. (move-marker where nil)))
  1207. ((and (listp where) (eq (car where) 'table-line))
  1208. (if (org-at-table-p)
  1209. (save-excursion
  1210. (org-table-goto-line (nth 1 where))
  1211. (point-at-bol))
  1212. (point))))))
  1213. (with-current-buffer (buffer-base-buffer (current-buffer))
  1214. (org-with-point-at pos
  1215. (when org-capture-bookmark
  1216. (let ((bookmark (plist-get org-bookmark-names-plist :last-capture)))
  1217. (when bookmark (with-demoted-errors (bookmark-set bookmark)))))
  1218. (move-marker org-capture-last-stored-marker (point))))))
  1219. (defun org-capture-narrow (beg end)
  1220. "Narrow, unless configuration says not to narrow."
  1221. (unless (org-capture-get :unnarrowed)
  1222. (narrow-to-region beg end)
  1223. (goto-char beg)))
  1224. (defun org-capture-empty-lines-before (&optional n)
  1225. "Set the correct number of empty lines before the insertion point.
  1226. Point will be after the empty lines, so insertion can directly be done."
  1227. (setq n (or n (org-capture-get :empty-lines-before)
  1228. (org-capture-get :empty-lines) 0))
  1229. (let ((pos (point)))
  1230. (org-back-over-empty-lines)
  1231. (delete-region (point) pos)
  1232. (when (> n 0) (newline n))))
  1233. (defun org-capture-empty-lines-after (&optional n)
  1234. "Set the correct number of empty lines after the inserted string.
  1235. Point will remain at the first line after the inserted text."
  1236. (setq n (or n (org-capture-get :empty-lines-after)
  1237. (org-capture-get :empty-lines) 0))
  1238. (org-back-over-empty-lines)
  1239. (while (looking-at "[ \t]*\n") (replace-match ""))
  1240. (let ((pos (point)))
  1241. (when (> n 0) (newline n))
  1242. (goto-char pos)))
  1243. (defvar org-clock-marker) ; Defined in org.el
  1244. (defun org-capture-insert-template-here ()
  1245. "Insert the capture template at point."
  1246. (let* ((template (org-capture-get :template))
  1247. (type (org-capture-get :type))
  1248. beg end pp)
  1249. (unless (bolp) (insert "\n"))
  1250. (setq beg (point))
  1251. (cond
  1252. ((and (eq type 'entry) (derived-mode-p 'org-mode))
  1253. (org-capture-verify-tree (org-capture-get :template))
  1254. (org-paste-subtree nil template t))
  1255. ((and (memq type '(item checkitem))
  1256. (derived-mode-p 'org-mode)
  1257. (save-excursion (skip-chars-backward " \t\n")
  1258. (setq pp (point))
  1259. (org-in-item-p)))
  1260. (goto-char pp)
  1261. (org-insert-item)
  1262. (skip-chars-backward " ")
  1263. (skip-chars-backward "-+*0123456789).")
  1264. (delete-region (point) (point-at-eol))
  1265. (setq beg (point))
  1266. (org-remove-indentation template)
  1267. (insert template)
  1268. (org-capture-empty-lines-after)
  1269. (goto-char beg)
  1270. (org-list-repair)
  1271. (org-end-of-item))
  1272. (t
  1273. (insert template)
  1274. (org-capture-empty-lines-after)
  1275. (skip-chars-forward " \t\n")
  1276. (unless (eobp) (beginning-of-line))))
  1277. (setq end (point))
  1278. (goto-char beg)
  1279. (when (re-search-forward "%\\?" end t)
  1280. (replace-match ""))))
  1281. (defun org-capture-set-plist (entry)
  1282. "Initialize the property list from the template definition."
  1283. (setq org-capture-plist (copy-sequence (nthcdr 5 entry)))
  1284. (org-capture-put :key (car entry) :description (nth 1 entry)
  1285. :target (nth 3 entry))
  1286. (let ((txt (nth 4 entry)) (type (or (nth 2 entry) 'entry)))
  1287. (when (or (not txt) (and (stringp txt) (not (string-match "\\S-" txt))))
  1288. ;; The template may be empty or omitted for special types.
  1289. ;; Here we insert the default templates for such cases.
  1290. (cond
  1291. ((eq type 'item) (setq txt "- %?"))
  1292. ((eq type 'checkitem) (setq txt "- [ ] %?"))
  1293. ((eq type 'table-line) (setq txt "| %? |"))
  1294. ((member type '(nil entry)) (setq txt "* %?\n %a"))))
  1295. (org-capture-put :template txt :type type)))
  1296. (defun org-capture-goto-target (&optional template-key)
  1297. "Go to the target location of a capture template.
  1298. The user is queried for the template."
  1299. (interactive)
  1300. (let ((entry (org-capture-select-template template-key)))
  1301. (unless entry (error "No capture template selected"))
  1302. (org-capture-set-plist entry)
  1303. (org-capture-set-target-location)
  1304. (pop-to-buffer-same-window (org-capture-get :buffer))
  1305. (goto-char (org-capture-get :pos))))
  1306. (defun org-capture-get-indirect-buffer (&optional buffer prefix)
  1307. "Make an indirect buffer for a capture process.
  1308. Use PREFIX as a prefix for the name of the indirect buffer."
  1309. (setq buffer (or buffer (current-buffer)))
  1310. (let ((n 1) (base (buffer-name buffer)) bname)
  1311. (setq bname (concat prefix "-" base))
  1312. (while (buffer-live-p (get-buffer bname))
  1313. (setq bname (concat prefix "-" (number-to-string (cl-incf n)) "-" base)))
  1314. (condition-case nil
  1315. (make-indirect-buffer buffer bname 'clone)
  1316. (error
  1317. (let ((buf (make-indirect-buffer buffer bname)))
  1318. (with-current-buffer buf (org-mode))
  1319. buf)))))
  1320. (defun org-capture-verify-tree (tree)
  1321. "Throw error if TREE is not a valid tree."
  1322. (unless (org-kill-is-subtree-p tree)
  1323. (error "Template is not a valid Org entry or tree")))
  1324. ;;; The template code
  1325. (defun org-capture-select-template (&optional keys)
  1326. "Select a capture template.
  1327. Lisp programs can force the template by setting KEYS to a string."
  1328. (let ((org-capture-templates
  1329. (or (org-contextualize-keys
  1330. (org-capture-upgrade-templates org-capture-templates)
  1331. org-capture-templates-contexts)
  1332. '(("t" "Task" entry (file+headline "" "Tasks")
  1333. "* TODO %?\n %u\n %a")))))
  1334. (if keys
  1335. (or (assoc keys org-capture-templates)
  1336. (error "No capture template referred to by \"%s\" keys" keys))
  1337. (org-mks org-capture-templates
  1338. "Select a capture template\n========================="
  1339. "Template key: "
  1340. '(("C" "Customize org-capture-templates")
  1341. ("q" "Abort"))))))
  1342. (defvar org-capture--clipboards nil
  1343. "List various clipboards values.")
  1344. (defun org-capture-fill-template (&optional template initial annotation)
  1345. "Fill a template and return the filled template as a string.
  1346. The template may still contain \"%?\" for cursor positioning."
  1347. (let* ((template (or template (org-capture-get :template)))
  1348. (buffer (org-capture-get :buffer))
  1349. (file (buffer-file-name (or (buffer-base-buffer buffer) buffer)))
  1350. (time (let* ((c (or (org-capture-get :default-time) (current-time)))
  1351. (d (decode-time c)))
  1352. (if (< (nth 2 d) org-extend-today-until)
  1353. (encode-time 0 59 23 (1- (nth 3 d)) (nth 4 d) (nth 5 d))
  1354. c)))
  1355. (v-t (format-time-string (org-time-stamp-format nil) time))
  1356. (v-T (format-time-string (org-time-stamp-format t) time))
  1357. (v-u (format-time-string (org-time-stamp-format nil t) time))
  1358. (v-U (format-time-string (org-time-stamp-format t t) time))
  1359. (v-c (and kill-ring (current-kill 0)))
  1360. (v-x (or (org-get-x-clipboard 'PRIMARY)
  1361. (org-get-x-clipboard 'CLIPBOARD)
  1362. (org-get-x-clipboard 'SECONDARY)
  1363. "")) ;ensure it is a string
  1364. ;; `initial' and `annotation' might have been passed. But if
  1365. ;; the property list has them, we prefer those values.
  1366. (v-i (or (plist-get org-store-link-plist :initial)
  1367. (and (stringp initial) (org-no-properties initial))
  1368. (org-capture-get :initial)
  1369. ""))
  1370. (v-a
  1371. (let ((a (or (plist-get org-store-link-plist :annotation)
  1372. annotation
  1373. (org-capture-get :annotation)
  1374. "")))
  1375. ;; Is the link empty? Then we do not want it...
  1376. (if (equal a "[[]]") "" a)))
  1377. (l-re "\\[\\[\\(.*?\\)\\]\\(\\[.*?\\]\\)?\\]")
  1378. (v-A (if (and v-a (string-match l-re v-a))
  1379. (replace-match "[[\\1][%^{Link description}]]" nil nil v-a)
  1380. v-a))
  1381. (v-l (if (and v-a (string-match l-re v-a))
  1382. (replace-match "\\1" nil nil v-a)
  1383. v-a))
  1384. (v-n user-full-name)
  1385. (v-k (if (marker-buffer org-clock-marker)
  1386. (org-no-properties org-clock-heading)
  1387. ""))
  1388. (v-K (if (marker-buffer org-clock-marker)
  1389. (org-make-link-string
  1390. (format "%s::*%s"
  1391. (buffer-file-name (marker-buffer org-clock-marker))
  1392. v-k)
  1393. v-k)
  1394. ""))
  1395. (v-f (or (org-capture-get :original-file-nondirectory) ""))
  1396. (v-F (or (org-capture-get :original-file) ""))
  1397. (org-capture--clipboards
  1398. (delq nil
  1399. (list v-i
  1400. (org-get-x-clipboard 'PRIMARY)
  1401. (org-get-x-clipboard 'CLIPBOARD)
  1402. (org-get-x-clipboard 'SECONDARY)
  1403. v-c))))
  1404. (setq org-store-link-plist (plist-put org-store-link-plist :annotation v-a))
  1405. (setq org-store-link-plist (plist-put org-store-link-plist :initial v-i))
  1406. (unless template
  1407. (setq template "")
  1408. (message "no template") (ding)
  1409. (sit-for 1))
  1410. (save-window-excursion
  1411. (org-switch-to-buffer-other-window (get-buffer-create "*Capture*"))
  1412. (erase-buffer)
  1413. (setq buffer-file-name nil)
  1414. (setq mark-active nil)
  1415. (insert template)
  1416. (goto-char (point-min))
  1417. ;; %[] insert contents of a file.
  1418. (save-excursion
  1419. (while (re-search-forward "%\\[\\(.+\\)\\]" nil t)
  1420. (let ((filename (expand-file-name (match-string 1)))
  1421. (beg (copy-marker (match-beginning 0)))
  1422. (end (copy-marker (match-end 0))))
  1423. (unless (org-capture-escaped-%)
  1424. (delete-region beg end)
  1425. (set-marker beg nil)
  1426. (set-marker end nil)
  1427. (condition-case error
  1428. (insert-file-contents filename)
  1429. (error
  1430. (insert (format "%%![couldn not insert %s: %s]"
  1431. filename
  1432. error))))))))
  1433. ;; Mark %() embedded elisp for later evaluation.
  1434. (org-capture-expand-embedded-elisp 'mark)
  1435. ;; Expand non-interactive templates.
  1436. (let ((regexp "%\\(:[-a-za-z]+\\|<\\([^>\n]+\\)>\\|[aAcfFikKlntTuUx]\\)"))
  1437. (save-excursion
  1438. (while (re-search-forward regexp nil t)
  1439. ;; `org-capture-escaped-%' may modify buffer and cripple
  1440. ;; match-data. Use markers instead. Ditto for other
  1441. ;; templates.
  1442. (let ((pos (copy-marker (match-beginning 0)))
  1443. (end (copy-marker (match-end 0)))
  1444. (value (match-string 1))
  1445. (time-string (match-string 2)))
  1446. (unless (org-capture-escaped-%)
  1447. (delete-region pos end)
  1448. (set-marker pos nil)
  1449. (set-marker end nil)
  1450. (let* ((inside-sexp? (org-capture-inside-embedded-elisp-p))
  1451. (replacement
  1452. (pcase (string-to-char value)
  1453. (?< (format-time-string time-string time))
  1454. (?:
  1455. (or (plist-get org-store-link-plist (intern value))
  1456. ""))
  1457. (?i
  1458. (if inside-sexp? v-i
  1459. ;; Outside embedded Lisp, repeat leading
  1460. ;; characters before initial place holder
  1461. ;; every line.
  1462. (let ((lead (buffer-substring-no-properties
  1463. (line-beginning-position) (point))))
  1464. (replace-regexp-in-string "\n\\(.\\)"
  1465. (concat lead "\\1")
  1466. v-i nil nil 1))))
  1467. (?a v-a)
  1468. (?A v-A)
  1469. (?c v-c)
  1470. (?f v-f)
  1471. (?F v-F)
  1472. (?k v-k)
  1473. (?K v-K)
  1474. (?l v-l)
  1475. (?n v-n)
  1476. (?t v-t)
  1477. (?T v-T)
  1478. (?u v-u)
  1479. (?U v-U)
  1480. (?x v-x))))
  1481. (insert
  1482. (if inside-sexp?
  1483. ;; Escape sensitive characters.
  1484. (replace-regexp-in-string "[\\\"]" "\\\\\\&" replacement)
  1485. replacement))))))))
  1486. ;; Expand %() embedded Elisp. Limit to Sexp originally marked.
  1487. (org-capture-expand-embedded-elisp)
  1488. ;; Expand interactive templates. This is the last step so that
  1489. ;; template is mostly expanded when prompting happens. Turn on
  1490. ;; Org mode and set local variables. This is to support
  1491. ;; completion in interactive prompts.
  1492. (let ((org-inhibit-startup t)) (org-mode))
  1493. (org-clone-local-variables buffer "\\`org-")
  1494. (let (strings) ; Stores interactive answers.
  1495. (save-excursion
  1496. (let ((regexp "%\\^\\(?:{\\([^}]*\\)}\\)?\\([CgGLptTuU]\\)?"))
  1497. (while (re-search-forward regexp nil t)
  1498. (let* ((items (and (match-end 1)
  1499. (save-match-data
  1500. (split-string (match-string-no-properties 1)
  1501. "|"))))
  1502. (key (match-string 2))
  1503. (beg (copy-marker (match-beginning 0)))
  1504. (end (copy-marker (match-end 0)))
  1505. (prompt (nth 0 items))
  1506. (default (nth 1 items))
  1507. (completions (nthcdr 2 items)))
  1508. (unless (org-capture-escaped-%)
  1509. (delete-region beg end)
  1510. (set-marker beg nil)
  1511. (set-marker end nil)
  1512. (pcase key
  1513. ((or "G" "g")
  1514. (let* ((org-last-tags-completion-table
  1515. (org-global-tags-completion-table
  1516. (cond ((equal key "G") (org-agenda-files))
  1517. (file (list file))
  1518. (t nil))))
  1519. (org-add-colon-after-tag-completion t)
  1520. (ins (mapconcat
  1521. #'identity
  1522. (org-split-string
  1523. (completing-read
  1524. (if prompt (concat prompt ": ") "Tags: ")
  1525. 'org-tags-completion-function nil nil nil
  1526. 'org-tags-history)
  1527. "[^[:alnum:]_@#%]+")
  1528. ":")))
  1529. (when (org-string-nw-p ins)
  1530. (unless (eq (char-before) ?:) (insert ":"))
  1531. (insert ins)
  1532. (unless (eq (char-after) ?:) (insert ":"))
  1533. (when (org-at-heading-p) (org-align-tags)))))
  1534. ((or "C" "L")
  1535. (let ((insert-fun (if (equal key "C") #'insert
  1536. (lambda (s) (org-insert-link 0 s)))))
  1537. (pcase org-capture--clipboards
  1538. (`nil nil)
  1539. (`(,value) (funcall insert-fun value))
  1540. (`(,first-value . ,_)
  1541. (funcall insert-fun
  1542. (read-string "Clipboard/kill value: "
  1543. first-value
  1544. 'org-capture--clipboards
  1545. first-value)))
  1546. (_ (error "Invalid `org-capture--clipboards' value: %S"
  1547. org-capture--clipboards)))))
  1548. ("p" (org-set-property prompt nil))
  1549. ((or "t" "T" "u" "U")
  1550. ;; These are the date/time related ones.
  1551. (let* ((upcase? (equal (upcase key) key))
  1552. (org-end-time-was-given nil)
  1553. (time (org-read-date upcase? t nil prompt)))
  1554. (org-insert-time-stamp
  1555. time (or org-time-was-given upcase?)
  1556. (member key '("u" "U"))
  1557. nil nil (list org-end-time-was-given))))
  1558. (`nil
  1559. ;; Load history list for current prompt.
  1560. (setq org-capture--prompt-history
  1561. (gethash prompt org-capture--prompt-history-table))
  1562. (push (org-completing-read
  1563. (concat (or prompt "Enter string")
  1564. (and default (format " [%s]" default))
  1565. ": ")
  1566. completions
  1567. nil nil nil 'org-capture--prompt-history default)
  1568. strings)
  1569. (insert (car strings))
  1570. ;; Save updated history list for current prompt.
  1571. (puthash prompt org-capture--prompt-history
  1572. org-capture--prompt-history-table))
  1573. (_
  1574. (error "Unknown template placeholder: \"%%^%s\""
  1575. key))))))))
  1576. ;; Replace %n escapes with nth %^{...} string.
  1577. (setq strings (nreverse strings))
  1578. (save-excursion
  1579. (while (re-search-forward "%\\\\\\([1-9][0-9]*\\)" nil t)
  1580. (unless (org-capture-escaped-%)
  1581. (replace-match
  1582. (nth (1- (string-to-number (match-string 1))) strings)
  1583. nil t)))))
  1584. ;; Make sure there are no empty lines before the text, and that
  1585. ;; it ends with a newline character.
  1586. (skip-chars-forward " \t\n")
  1587. (delete-region (point-min) (line-beginning-position))
  1588. (goto-char (point-max))
  1589. (skip-chars-backward " \t\n")
  1590. (delete-region (point) (point-max))
  1591. (insert "\n")
  1592. ;; Return the expanded template and kill the capture buffer.
  1593. (untabify (point-min) (point-max))
  1594. (set-buffer-modified-p nil)
  1595. (prog1 (buffer-substring-no-properties (point-min) (point-max))
  1596. (kill-buffer (current-buffer))))))
  1597. (defun org-capture-escaped-% ()
  1598. "Non-nil if % was escaped.
  1599. If yes, unescape it now. Assume match-data contains the
  1600. placeholder to check."
  1601. (save-excursion
  1602. (goto-char (match-beginning 0))
  1603. (let ((n (abs (skip-chars-backward "\\\\"))))
  1604. (delete-char (/ (1+ n) 2))
  1605. (= (% n 2) 1))))
  1606. (defun org-capture-expand-embedded-elisp (&optional mark)
  1607. "Evaluate embedded elisp %(sexp) and replace with the result.
  1608. When optional MARK argument is non-nil, mark Sexp with a text
  1609. property (`org-embedded-elisp') for later evaluation. Only
  1610. marked Sexp are evaluated when this argument is nil."
  1611. (save-excursion
  1612. (goto-char (point-min))
  1613. (while (re-search-forward "%(" nil t)
  1614. (cond
  1615. ((get-text-property (match-beginning 0) 'org-embedded-elisp)
  1616. (goto-char (match-beginning 0))
  1617. (let ((template-start (point)))
  1618. (forward-char 1)
  1619. (let* ((sexp (read (current-buffer)))
  1620. (result (org-eval
  1621. (org-capture--expand-keyword-in-embedded-elisp
  1622. sexp))))
  1623. (delete-region template-start (point))
  1624. (cond
  1625. ((not result) nil)
  1626. ((stringp result) (insert result))
  1627. (t (error
  1628. "Capture template sexp `%s' must evaluate to string or nil"
  1629. sexp))))))
  1630. ((not mark) nil)
  1631. ;; Only mark valid and non-escaped sexp.
  1632. ((org-capture-escaped-%) nil)
  1633. (t
  1634. (let ((end (with-syntax-table emacs-lisp-mode-syntax-table
  1635. (ignore-errors (scan-sexps (1- (point)) 1)))))
  1636. (when end
  1637. (put-text-property (- (point) 2) end 'org-embedded-elisp t))))))))
  1638. (defun org-capture--expand-keyword-in-embedded-elisp (attr)
  1639. "Recursively replace capture link keywords in ATTR sexp.
  1640. Such keywords are prefixed with \"%:\". See
  1641. `org-capture-template' for more information."
  1642. (cond ((consp attr)
  1643. (mapcar 'org-capture--expand-keyword-in-embedded-elisp attr))
  1644. ((symbolp attr)
  1645. (let* ((attr-symbol (symbol-name attr))
  1646. (key (and (string-match "%\\(:.*\\)" attr-symbol)
  1647. (intern (match-string 1 attr-symbol)))))
  1648. (or (plist-get org-store-link-plist key)
  1649. attr)))
  1650. (t attr)))
  1651. (defun org-capture-inside-embedded-elisp-p ()
  1652. "Non-nil if point is inside of embedded elisp %(sexp).
  1653. Assume sexps have been marked with
  1654. `org-capture-expand-embedded-elisp' beforehand."
  1655. (get-text-property (point) 'org-embedded-elisp))
  1656. ;;;###autoload
  1657. (defun org-capture-import-remember-templates ()
  1658. "Set `org-capture-templates' to be similar to `org-remember-templates'."
  1659. (interactive)
  1660. (when (and (yes-or-no-p
  1661. "Import old remember templates into org-capture-templates? ")
  1662. (yes-or-no-p
  1663. "Note that this will remove any templates currently defined in `org-capture-templates'. Do you still want to go ahead? "))
  1664. (require 'org-remember)
  1665. (setq org-capture-templates
  1666. (mapcar
  1667. (lambda (entry)
  1668. (let ((desc (car entry))
  1669. (key (char-to-string (nth 1 entry)))
  1670. (template (nth 2 entry))
  1671. (file (or (nth 3 entry) org-default-notes-file))
  1672. (position (or (nth 4 entry) org-remember-default-headline))
  1673. (type 'entry)
  1674. (prepend org-reverse-note-order)
  1675. immediate target jump-to-captured)
  1676. (cond
  1677. ((member position '(top bottom))
  1678. (setq target (list 'file file)
  1679. prepend (eq position 'top)))
  1680. ((eq position 'date-tree)
  1681. (setq target (list 'file+datetree file)
  1682. prepend nil))
  1683. (t (setq target (list 'file+headline file position))))
  1684. (when (string-match "%!" template)
  1685. (setq template (replace-match "" t t template)
  1686. immediate t))
  1687. (when (string-match "%&" template)
  1688. (setq jump-to-captured t))
  1689. (append (list key desc type target template)
  1690. (and prepend '(:prepend t))
  1691. (and immediate '(:immediate-finish t))
  1692. (and jump-to-captured '(:jump-to-captured t)))))
  1693. org-remember-templates))))
  1694. (provide 'org-capture)
  1695. ;;; org-capture.el ends here