org-capture.el 71 KB

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