org-macro.el 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  1. ;;; org-macro.el --- Macro Replacement Code for Org -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2013-2019 Free Software Foundation, Inc.
  3. ;; Author: Nicolas Goaziou <n.goaziou@gmail.com>
  4. ;; Keywords: outlines, hypermedia, calendar, wp
  5. ;; This file is part of GNU Emacs.
  6. ;; GNU Emacs is free software: you can redistribute it and/or modify
  7. ;; it under the terms of the GNU General Public License as published by
  8. ;; the Free Software Foundation, either version 3 of the License, or
  9. ;; (at your option) any later version.
  10. ;; GNU Emacs is distributed in the hope that it will be useful,
  11. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. ;; GNU General Public License for more details.
  14. ;; You should have received a copy of the GNU General Public License
  15. ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
  16. ;;; Commentary:
  17. ;; Macros are expanded with `org-macro-replace-all', which relies
  18. ;; internally on `org-macro-expand'.
  19. ;; Default templates for expansion are stored in the buffer-local
  20. ;; variable `org-macro-templates'. This variable is updated by
  21. ;; `org-macro-initialize-templates', which recursively calls
  22. ;; `org-macro--collect-macros' in order to read setup files.
  23. ;; Argument in macros are separated with commas. Proper escaping rules
  24. ;; are implemented in `org-macro-escape-arguments' and arguments can
  25. ;; be extracted from a string with `org-macro-extract-arguments'.
  26. ;; Along with macros defined through #+MACRO: keyword, default
  27. ;; templates include the following hard-coded macros:
  28. ;; {{{time(format-string)}}},
  29. ;; {{{property(node-property)}}},
  30. ;; {{{input-file}}},
  31. ;; {{{modification-time(format-string)}}},
  32. ;; {{{n(counter,action}}}.
  33. ;; Upon exporting, "ox.el" will also provide {{{author}}}, {{{date}}},
  34. ;; {{{email}}} and {{{title}}} macros.
  35. ;;; Code:
  36. (require 'cl-lib)
  37. (require 'org-macs)
  38. (require 'org-compat)
  39. (declare-function org-element-at-point "org-element" ())
  40. (declare-function org-element-context "org-element" (&optional element))
  41. (declare-function org-element-copy "org-element" (datum))
  42. (declare-function org-element-macro-parser "org-element" ())
  43. (declare-function org-element-parse-secondary-string "org-element" (string restriction &optional parent))
  44. (declare-function org-element-property "org-element" (property element))
  45. (declare-function org-element-restriction "org-element" (element))
  46. (declare-function org-element-type "org-element" (element))
  47. (declare-function org-entry-get "org" (pom property &optional inherit literal-nil))
  48. (declare-function org-file-contents "org" (file &optional noerror nocache))
  49. (declare-function org-file-url-p "org" (file))
  50. (declare-function org-in-commented-heading-p "org" (&optional no-inheritance))
  51. (declare-function org-link-search "ol" (s &optional avoid-pos stealth))
  52. (declare-function org-mode "org" ())
  53. (declare-function vc-backend "vc-hooks" (f))
  54. (declare-function vc-call "vc-hooks" (fun file &rest args) t)
  55. (declare-function vc-exec-after "vc-dispatcher" (code))
  56. (defvar org-link-search-must-match-exact-headline)
  57. ;;; Variables
  58. (defvar-local org-macro-templates nil
  59. "Alist containing all macro templates in current buffer.
  60. Associations are in the shape of (NAME . TEMPLATE) where NAME
  61. stands for macro's name and template for its replacement value,
  62. both as strings. This is an internal variable. Do not set it
  63. directly, use instead:
  64. #+MACRO: name template")
  65. ;;; Functions
  66. (defun org-macro--collect-macros ()
  67. "Collect macro definitions in current buffer and setup files.
  68. Return an alist containing all macro templates found."
  69. (letrec ((collect-macros
  70. (lambda (files templates)
  71. ;; Return an alist of macro templates. FILES is a list
  72. ;; of setup files names read so far, used to avoid
  73. ;; circular dependencies. TEMPLATES is the alist
  74. ;; collected so far.
  75. (let ((case-fold-search t))
  76. (org-with-wide-buffer
  77. (goto-char (point-min))
  78. (while (re-search-forward
  79. "^[ \t]*#\\+\\(MACRO\\|SETUPFILE\\):" nil t)
  80. (let ((element (org-element-at-point)))
  81. (when (eq (org-element-type element) 'keyword)
  82. (let ((val (org-element-property :value element)))
  83. (if (equal (org-element-property :key element) "MACRO")
  84. ;; Install macro in TEMPLATES.
  85. (when (string-match
  86. "^\\(.*?\\)\\(?:\\s-+\\(.*\\)\\)?\\s-*$" val)
  87. (let* ((name (match-string 1 val))
  88. (template (or (match-string 2 val) ""))
  89. (old-cell (assoc name templates)))
  90. (if old-cell (setcdr old-cell template)
  91. (push (cons name template) templates))))
  92. ;; Enter setup file.
  93. (let* ((uri (org-strip-quotes (org-trim val)))
  94. (uri-is-url (org-file-url-p uri))
  95. (uri (if uri-is-url
  96. uri
  97. (expand-file-name uri))))
  98. ;; Avoid circular dependencies.
  99. (unless (member uri files)
  100. (with-temp-buffer
  101. (unless uri-is-url
  102. (setq default-directory
  103. (file-name-directory uri)))
  104. (org-mode)
  105. (insert (org-file-contents uri 'noerror))
  106. (setq templates
  107. (funcall collect-macros (cons uri files)
  108. templates)))))))))))
  109. templates))))
  110. (funcall collect-macros nil nil)))
  111. (defun org-macro-initialize-templates ()
  112. "Collect macro templates defined in current buffer.
  113. Templates are stored in buffer-local variable
  114. `org-macro-templates'.
  115. In addition to buffer-defined macros, the function installs the
  116. following ones: \"n\", \"author\", \"email\", \"keyword\",
  117. \"time\", \"property\", and, if the buffer is associated to
  118. a file, \"input-file\" and \"modification-time\"."
  119. (require 'org-element)
  120. (org-macro--counter-initialize) ;for "n" macro
  121. (setq org-macro-templates
  122. (nconc
  123. ;; Install user-defined macros.
  124. (org-macro--collect-macros)
  125. ;; Install file-specific macros.
  126. (let ((visited-file (buffer-file-name (buffer-base-buffer))))
  127. (and visited-file
  128. (file-exists-p visited-file)
  129. (list
  130. `("input-file" . ,(file-name-nondirectory visited-file))
  131. `("modification-time" .
  132. ,(format "(eval
  133. \(format-time-string $1
  134. (or (and (org-string-nw-p $2)
  135. (org-macro--vc-modified-time %s))
  136. '%s)))"
  137. (prin1-to-string visited-file)
  138. (prin1-to-string
  139. (file-attribute-modification-time
  140. (file-attributes visited-file))))))))
  141. ;; Install built-in macros.
  142. (list
  143. '("n" . "(eval (org-macro--counter-increment $1 $2))")
  144. `("author" . ,(org-macro--find-keyword-value "AUTHOR"))
  145. `("email" . ,(org-macro--find-keyword-value "EMAIL"))
  146. '("keyword" . "(eval (org-macro--find-keyword-value $1))")
  147. '("time" . "(eval (format-time-string $1))")
  148. `("title" . ,(org-macro--find-keyword-value "TITLE"))
  149. '("property" . "(eval (org-macro--get-property $1 $2))")
  150. `("date" .
  151. ,(let* ((value (org-macro--find-keyword-value "DATE"))
  152. (date (org-element-parse-secondary-string
  153. value (org-element-restriction 'keyword))))
  154. (if (and (consp date)
  155. (not (cdr date))
  156. (eq 'timestamp (org-element-type (car date))))
  157. (format "(eval (if (org-string-nw-p $1) %s %S))"
  158. (format "(org-timestamp-format '%S $1)"
  159. (org-element-copy (car date)))
  160. value)
  161. value)))))))
  162. (defun org-macro-expand (macro templates)
  163. "Return expanded MACRO, as a string.
  164. MACRO is an object, obtained, for example, with
  165. `org-element-context'. TEMPLATES is an alist of templates used
  166. for expansion. See `org-macro-templates' for a buffer-local
  167. default value. Return nil if no template was found."
  168. (let ((template
  169. ;; Macro names are case-insensitive.
  170. (cdr (assoc-string (org-element-property :key macro) templates t))))
  171. (when template
  172. (let* ((eval? (string-match-p "\\`(eval\\>" template))
  173. (value
  174. (replace-regexp-in-string
  175. "\\$[0-9]+"
  176. (lambda (m)
  177. (let ((arg (or (nth (1- (string-to-number (substring m 1)))
  178. (org-element-property :args macro))
  179. ;; No argument: remove place-holder.
  180. "")))
  181. ;; `eval' implies arguments are strings.
  182. (if eval? (format "%S" arg) arg)))
  183. template nil 'literal)))
  184. (when eval?
  185. (setq value (eval (condition-case nil (read value)
  186. (error (debug))))))
  187. ;; Force return value to be a string.
  188. (format "%s" (or value ""))))))
  189. (defun org-macro-replace-all (templates &optional keywords)
  190. "Replace all macros in current buffer by their expansion.
  191. TEMPLATES is an alist of templates used for expansion. See
  192. `org-macro-templates' for a buffer-local default value.
  193. Optional argument KEYWORDS, when non-nil is a list of keywords,
  194. as strings, where macro expansion is allowed.
  195. Return an error if a macro in the buffer cannot be associated to
  196. a definition in TEMPLATES."
  197. (org-with-wide-buffer
  198. (goto-char (point-min))
  199. (let ((properties-regexp (format "\\`EXPORT_%s\\+?\\'"
  200. (regexp-opt keywords)))
  201. record)
  202. (while (re-search-forward "{{{[-A-Za-z0-9_]" nil t)
  203. (unless (save-match-data (org-in-commented-heading-p))
  204. (let* ((datum (save-match-data (org-element-context)))
  205. (type (org-element-type datum))
  206. (macro
  207. (cond
  208. ((eq type 'macro) datum)
  209. ;; In parsed keywords and associated node
  210. ;; properties, force macro recognition.
  211. ((or (and (eq type 'keyword)
  212. (member (org-element-property :key datum) keywords))
  213. (and (eq type 'node-property)
  214. (string-match-p properties-regexp
  215. (org-element-property :key datum))))
  216. (save-excursion
  217. (goto-char (match-beginning 0))
  218. (org-element-macro-parser))))))
  219. (when macro
  220. (let* ((key (org-element-property :key macro))
  221. (value (org-macro-expand macro templates))
  222. (begin (org-element-property :begin macro))
  223. (signature (list begin
  224. macro
  225. (org-element-property :args macro))))
  226. ;; Avoid circular dependencies by checking if the same
  227. ;; macro with the same arguments is expanded at the
  228. ;; same position twice.
  229. (cond ((member signature record)
  230. (error "Circular macro expansion: %s" key))
  231. (value
  232. (push signature record)
  233. (delete-region
  234. begin
  235. ;; Preserve white spaces after the macro.
  236. (progn (goto-char (org-element-property :end macro))
  237. (skip-chars-backward " \t")
  238. (point)))
  239. ;; Leave point before replacement in case of
  240. ;; recursive expansions.
  241. (save-excursion (insert value)))
  242. ;; Special "results" macro: if it is not defined,
  243. ;; simply leave it as-is. It will be expanded in
  244. ;; a second phase.
  245. ((equal key "results"))
  246. (t
  247. (error "Undefined Org macro: %s; aborting"
  248. (org-element-property :key macro))))))))))))
  249. (defun org-macro-escape-arguments (&rest args)
  250. "Build macro's arguments string from ARGS.
  251. ARGS are strings. Return value is a string with arguments
  252. properly escaped and separated with commas. This is the opposite
  253. of `org-macro-extract-arguments'."
  254. (let ((s ""))
  255. (dolist (arg (reverse args) (substring s 1))
  256. (setq s
  257. (concat
  258. ","
  259. (replace-regexp-in-string
  260. "\\(\\\\*\\),"
  261. (lambda (m)
  262. (concat (make-string (1+ (* 2 (length (match-string 1 m)))) ?\\)
  263. ","))
  264. ;; If a non-terminal argument ends on backslashes, make
  265. ;; sure to also escape them as they will be followed by
  266. ;; a comma.
  267. (concat arg (and (not (equal s ""))
  268. (string-match "\\\\+\\'" arg)
  269. (match-string 0 arg)))
  270. nil t)
  271. s)))))
  272. (defun org-macro-extract-arguments (s)
  273. "Extract macro arguments from string S.
  274. S is a string containing comma separated values properly escaped.
  275. Return a list of arguments, as strings. This is the opposite of
  276. `org-macro-escape-arguments'."
  277. ;; Do not use `org-split-string' since empty strings are
  278. ;; meaningful here.
  279. (split-string
  280. (replace-regexp-in-string
  281. "\\(\\\\*\\),"
  282. (lambda (str)
  283. (let ((len (length (match-string 1 str))))
  284. (concat (make-string (/ len 2) ?\\)
  285. (if (zerop (mod len 2)) "\000" ","))))
  286. s nil t)
  287. "\000"))
  288. ;;; Helper functions and variables for internal macros
  289. (defun org-macro--get-property (property location)
  290. "Find PROPERTY's value at LOCATION.
  291. PROPERTY is a string. LOCATION is a search string, as expected
  292. by `org-link-search', or the empty string."
  293. (save-excursion
  294. (when (org-string-nw-p location)
  295. (condition-case _
  296. (let ((org-link-search-must-match-exact-headline t))
  297. (org-link-search location nil t))
  298. (error
  299. (error "Macro property failed: cannot find location %s" location))))
  300. (org-entry-get nil property 'selective)))
  301. (defun org-macro--find-keyword-value (name)
  302. "Find value for keyword NAME in current buffer.
  303. KEYWORD is a string. Return value associated to the keywords
  304. named after NAME, as a string, or nil."
  305. (org-with-point-at 1
  306. (let ((regexp (format "^[ \t]*#\\+%s:" (regexp-quote name)))
  307. (case-fold-search t)
  308. (result nil))
  309. (while (re-search-forward regexp nil t)
  310. (let ((element (org-element-at-point)))
  311. (when (eq 'keyword (org-element-type element))
  312. (setq result (concat result
  313. " "
  314. (org-element-property :value element))))))
  315. (and result (org-trim result)))))
  316. (defun org-macro--vc-modified-time (file)
  317. (save-window-excursion
  318. (when (vc-backend file)
  319. (let ((buf (get-buffer-create " *org-vc*"))
  320. (case-fold-search t)
  321. date)
  322. (unwind-protect
  323. (progn
  324. (vc-call print-log file buf nil nil 1)
  325. (with-current-buffer buf
  326. (vc-exec-after
  327. (lambda ()
  328. (goto-char (point-min))
  329. (when (re-search-forward "Date:?[ \t]*" nil t)
  330. (let ((time (parse-time-string
  331. (buffer-substring
  332. (point) (line-end-position)))))
  333. (when (cl-some #'identity time)
  334. (setq date (apply #'encode-time time))))))))
  335. (let ((proc (get-buffer-process buf)))
  336. (while (and proc (accept-process-output proc .5 nil t)))))
  337. (kill-buffer buf))
  338. date))))
  339. (defvar org-macro--counter-table nil
  340. "Hash table containing counter value per name.")
  341. (defun org-macro--counter-initialize ()
  342. "Initialize `org-macro--counter-table'."
  343. (setq org-macro--counter-table (make-hash-table :test #'equal)))
  344. (defun org-macro--counter-increment (name &optional action)
  345. "Increment counter NAME.
  346. NAME is a string identifying the counter.
  347. When non-nil, optional argument ACTION is a string.
  348. If the string is \"-\", keep the NAME counter at its current
  349. value, i.e. do not increment.
  350. If the string represents an integer, set the counter to this number.
  351. Any other non-empty string resets the counter to 1."
  352. (let ((name-trimmed (org-trim name))
  353. (action-trimmed (when (org-string-nw-p action)
  354. (org-trim action))))
  355. (puthash name-trimmed
  356. (cond ((not (org-string-nw-p action-trimmed))
  357. (1+ (gethash name-trimmed org-macro--counter-table 0)))
  358. ((string= "-" action-trimmed)
  359. (gethash name-trimmed org-macro--counter-table 1))
  360. ((string-match-p "\\`[0-9]+\\'" action-trimmed)
  361. (string-to-number action-trimmed))
  362. (t 1))
  363. org-macro--counter-table)))
  364. (provide 'org-macro)
  365. ;;; org-macro.el ends here