org-capture.el 79 KB

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