org-capture.el 75 KB

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