ob-exp.el 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399
  1. ;;; ob-exp.el --- Exportation of org-babel source blocks
  2. ;; Copyright (C) 2009-2013 Free Software Foundation, Inc.
  3. ;; Authors: Eric Schulte
  4. ;; Dan Davison
  5. ;; Keywords: literate programming, reproducible research
  6. ;; Homepage: http://orgmode.org
  7. ;; This file is part of GNU Emacs.
  8. ;; GNU Emacs is free software: you can redistribute it and/or modify
  9. ;; it under the terms of the GNU General Public License as published by
  10. ;; the Free Software Foundation, either version 3 of the License, or
  11. ;; (at your option) any later version.
  12. ;; GNU Emacs is distributed in the hope that it will be useful,
  13. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. ;; GNU General Public License for more details.
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  18. ;;; Code:
  19. (require 'ob-core)
  20. (eval-when-compile
  21. (require 'cl))
  22. (defvar org-current-export-file)
  23. (defvar org-babel-lob-one-liner-regexp)
  24. (defvar org-babel-ref-split-regexp)
  25. (defvar org-list-forbidden-blocks)
  26. (declare-function org-babel-lob-get-info "ob-lob" ())
  27. (declare-function org-babel-eval-wipe-error-buffer "ob-eval" ())
  28. (declare-function org-between-regexps-p "org"
  29. (start-re end-re &optional lim-up lim-down))
  30. (declare-function org-get-indentation "org" (&optional line))
  31. (declare-function org-heading-components "org" ())
  32. (declare-function org-in-block-p "org" (names))
  33. (declare-function org-in-verbatim-emphasis "org" ())
  34. (declare-function org-link-search "org" (s &optional type avoid-pos stealth))
  35. (declare-function org-fill-template "org" (template alist))
  36. (declare-function org-split-string "org" (string &optional separators))
  37. (declare-function org-element-at-point "org-element" (&optional keep-trail))
  38. (declare-function org-element-context "org-element" ())
  39. (declare-function org-element-property "org-element" (property element))
  40. (declare-function org-element-type "org-element" (element))
  41. (declare-function org-escape-code-in-string "org-src" (s))
  42. (defcustom org-export-babel-evaluate t
  43. "Switch controlling code evaluation during export.
  44. When set to nil no code will be evaluated as part of the export
  45. process. When set to 'inline-only, only inline code blocks will
  46. be executed."
  47. :group 'org-babel
  48. :version "24.1"
  49. :type '(choice (const :tag "Never" nil)
  50. (const :tag "Only inline code" inline-only)
  51. (const :tag "Always" t)))
  52. (put 'org-export-babel-evaluate 'safe-local-variable (lambda (x) (eq x nil)))
  53. (defun org-babel-exp-get-export-buffer ()
  54. "Return the current export buffer if possible."
  55. (cond
  56. ((bufferp org-current-export-file) org-current-export-file)
  57. (org-current-export-file (get-file-buffer org-current-export-file))
  58. ('otherwise
  59. (error "Requested export buffer when `org-current-export-file' is nil"))))
  60. (defvar org-link-search-inhibit-query)
  61. (defmacro org-babel-exp-in-export-file (lang &rest body)
  62. (declare (indent 1))
  63. `(let* ((lang-headers (intern (concat "org-babel-default-header-args:" ,lang)))
  64. (heading (nth 4 (ignore-errors (org-heading-components))))
  65. (export-buffer (current-buffer))
  66. (original-buffer (org-babel-exp-get-export-buffer)) results)
  67. (when original-buffer
  68. ;; resolve parameters in the original file so that
  69. ;; headline and file-wide parameters are included, attempt
  70. ;; to go to the same heading in the original file
  71. (set-buffer original-buffer)
  72. (save-restriction
  73. (when heading
  74. (condition-case nil
  75. (let ((org-link-search-inhibit-query t))
  76. (org-link-search heading))
  77. (error (when heading
  78. (goto-char (point-min))
  79. (re-search-forward (regexp-quote heading) nil t)))))
  80. (setq results ,@body))
  81. (set-buffer export-buffer)
  82. results)))
  83. (def-edebug-spec org-babel-exp-in-export-file (form body))
  84. (defun org-babel-exp-src-block (&rest headers)
  85. "Process source block for export.
  86. Depending on the 'export' headers argument, replace the source
  87. code block like this:
  88. both ---- display the code and the results
  89. code ---- the default, display the code inside the block but do
  90. not process
  91. results - just like none only the block is run on export ensuring
  92. that it's results are present in the org-mode buffer
  93. none ---- do not display either code or results upon export
  94. Assume point is at the beginning of block's starting line."
  95. (interactive)
  96. (unless noninteractive (message "org-babel-exp processing..."))
  97. (save-excursion
  98. (let* ((info (org-babel-get-src-block-info 'light))
  99. (lang (nth 0 info))
  100. (raw-params (nth 2 info)) hash)
  101. ;; bail if we couldn't get any info from the block
  102. (when info
  103. ;; if we're actually going to need the parameters
  104. (when (member (cdr (assoc :exports (nth 2 info))) '("both" "results"))
  105. (org-babel-exp-in-export-file lang
  106. (setf (nth 2 info)
  107. (org-babel-process-params
  108. (apply #'org-babel-merge-params
  109. org-babel-default-header-args
  110. (if (boundp lang-headers) (eval lang-headers) nil)
  111. (append (org-babel-params-from-properties lang)
  112. (list raw-params))))))
  113. (setf hash (org-babel-sha1-hash info)))
  114. (org-babel-exp-do-export info 'block hash)))))
  115. (defcustom org-babel-exp-call-line-template
  116. ""
  117. "Template used to export call lines.
  118. This template may be customized to include the call line name
  119. with any export markup. The template is filled out using
  120. `org-fill-template', and the following %keys may be used.
  121. line --- call line
  122. An example value would be \"\\n: call: %line\" to export the call line
  123. wrapped in a verbatim environment.
  124. Note: the results are inserted separately after the contents of
  125. this template."
  126. :group 'org-babel
  127. :type 'string)
  128. (defvar org-babel-default-lob-header-args)
  129. (defun org-babel-exp-process-buffer ()
  130. "Execute all Babel blocks in current buffer."
  131. (interactive)
  132. (save-window-excursion
  133. (save-excursion
  134. (let ((case-fold-search t)
  135. (regexp (concat org-babel-inline-src-block-regexp "\\|"
  136. org-babel-lob-one-liner-regexp "\\|"
  137. "^[ \t]*#\\+BEGIN_SRC")))
  138. (goto-char (point-min))
  139. (while (re-search-forward regexp nil t)
  140. (let* ((element (save-excursion
  141. ;; If match is inline, point is at its
  142. ;; end. Move backward so
  143. ;; `org-element-context' can get the
  144. ;; object, not the following one.
  145. (backward-char)
  146. (save-match-data (org-element-context))))
  147. (type (org-element-type element))
  148. (beg-el (org-element-property :begin element))
  149. (end-el (org-element-property :end element)))
  150. (case type
  151. (inline-src-block
  152. (let* ((info (org-babel-parse-inline-src-block-match))
  153. (params (nth 2 info)))
  154. (setf (nth 1 info)
  155. (if (and (cdr (assoc :noweb params))
  156. (string= "yes" (cdr (assoc :noweb params))))
  157. (org-babel-expand-noweb-references
  158. info (org-babel-exp-get-export-buffer))
  159. (nth 1 info)))
  160. (goto-char beg-el)
  161. (let ((replacement (org-babel-exp-do-export info 'inline)))
  162. (if (equal replacement "")
  163. ;; Replacement code is empty: remove inline src
  164. ;; block, including extra white space that
  165. ;; might have been created when inserting
  166. ;; results.
  167. (delete-region beg-el
  168. (progn (goto-char end-el)
  169. (skip-chars-forward " \t")
  170. (point)))
  171. ;; Otherwise: remove inline src block but
  172. ;; preserve following white spaces. Then insert
  173. ;; value.
  174. (delete-region beg-el
  175. (progn (goto-char end-el)
  176. (skip-chars-backward " \t")
  177. (point)))
  178. (insert replacement)))))
  179. ((babel-call inline-babel-call)
  180. (let* ((lob-info (org-babel-lob-get-info))
  181. (results
  182. (org-babel-exp-do-export
  183. (list "emacs-lisp" "results"
  184. (apply #'org-babel-merge-params
  185. org-babel-default-header-args
  186. org-babel-default-lob-header-args
  187. (append
  188. (org-babel-params-from-properties)
  189. (list
  190. (org-babel-parse-header-arguments
  191. (org-no-properties
  192. (concat
  193. ":var results="
  194. (mapconcat 'identity
  195. (butlast lob-info 2)
  196. " ")))))))
  197. "" (nth 3 lob-info) (nth 2 lob-info))
  198. 'lob))
  199. (rep (org-fill-template
  200. org-babel-exp-call-line-template
  201. `(("line" . ,(nth 0 lob-info))))))
  202. ;; If replacement is empty, completely remove the
  203. ;; object/element, including any extra white space
  204. ;; that might have been created when including
  205. ;; results.
  206. (if (equal rep "")
  207. (delete-region
  208. beg-el
  209. (progn (goto-char end-el)
  210. (if (not (eq type 'babel-call))
  211. (progn (skip-chars-forward " \t") (point))
  212. (skip-chars-forward " \r\t\n")
  213. (line-beginning-position))))
  214. ;; Otherwise, preserve following white
  215. ;; spaces/newlines and then, insert replacement
  216. ;; string.
  217. (goto-char beg-el)
  218. (delete-region beg-el
  219. (progn (goto-char end-el)
  220. (skip-chars-backward " \r\t\n")
  221. (point)))
  222. (insert rep))))
  223. (src-block
  224. (let* ((match-start (match-beginning 0))
  225. ;; Make sure we don't remove any blank lines
  226. ;; after the block when replacing it.
  227. (block-end (save-excursion
  228. (goto-char end-el)
  229. (skip-chars-backward " \r\t\n")
  230. (line-end-position)))
  231. (ind (org-get-indentation))
  232. (headers
  233. (cons
  234. (org-element-property :language element)
  235. (let ((params (org-element-property :parameters element)))
  236. (and params (org-split-string params "[ \t]+"))))))
  237. ;; Take care of matched block: compute replacement
  238. ;; string. In particular, a nil REPLACEMENT means
  239. ;; the block should be left as-is while an empty
  240. ;; string should remove the block.
  241. (let ((replacement (progn (goto-char match-start)
  242. (org-babel-exp-src-block headers))))
  243. (cond ((not replacement) (goto-char block-end))
  244. ((equal replacement "")
  245. (delete-region beg-el end-el))
  246. (t
  247. (goto-char match-start)
  248. (delete-region (point) block-end)
  249. (insert replacement)
  250. (if (org-element-property :preserve-indent element)
  251. ;; Indent only the code block markers.
  252. (save-excursion (skip-chars-backward " \r\t\n")
  253. (indent-line-to ind)
  254. (goto-char match-start)
  255. (indent-line-to ind))
  256. ;; Indent everything.
  257. (indent-rigidly match-start (point) ind))))))))))))))
  258. (defun org-babel-in-example-or-verbatim ()
  259. "Return true if point is in example or verbatim code.
  260. Example and verbatim code include escaped portions of
  261. an org-mode buffer code that should be treated as normal
  262. org-mode text."
  263. (or (save-match-data
  264. (save-excursion
  265. (goto-char (point-at-bol))
  266. (looking-at "[ \t]*:[ \t]")))
  267. (org-in-verbatim-emphasis)
  268. (org-in-block-p org-list-forbidden-blocks)
  269. (org-between-regexps-p "^[ \t]*#\\+begin_src" "^[ \t]*#\\+end_src")))
  270. (defun org-babel-exp-do-export (info type &optional hash)
  271. "Return a string with the exported content of a code block.
  272. The function respects the value of the :exports header argument."
  273. (let ((silently (lambda () (let ((session (cdr (assoc :session (nth 2 info)))))
  274. (when (not (and session (equal "none" session)))
  275. (org-babel-exp-results info type 'silent)))))
  276. (clean (lambda () (unless (eq type 'inline) (org-babel-remove-result info)))))
  277. (case (intern (or (cdr (assoc :exports (nth 2 info))) "code"))
  278. ('none (funcall silently) (funcall clean) "")
  279. ('code (funcall silently) (funcall clean) (org-babel-exp-code info))
  280. ('results (org-babel-exp-results info type nil hash) "")
  281. ('both (org-babel-exp-results info type nil hash)
  282. (org-babel-exp-code info)))))
  283. (defcustom org-babel-exp-code-template
  284. "#+BEGIN_SRC %lang%flags\n%body\n#+END_SRC"
  285. "Template used to export the body of code blocks.
  286. This template may be customized to include additional information
  287. such as the code block name, or the values of particular header
  288. arguments. The template is filled out using `org-fill-template',
  289. and the following %keys may be used.
  290. lang ------ the language of the code block
  291. name ------ the name of the code block
  292. body ------ the body of the code block
  293. flags ----- the flags passed to the code block
  294. In addition to the keys mentioned above, every header argument
  295. defined for the code block may be used as a key and will be
  296. replaced with its value."
  297. :group 'org-babel
  298. :type 'string)
  299. (defun org-babel-exp-code (info)
  300. "Return the original code block formatted for export."
  301. (setf (nth 1 info)
  302. (if (string= "strip-export" (cdr (assoc :noweb (nth 2 info))))
  303. (replace-regexp-in-string
  304. (org-babel-noweb-wrap) "" (nth 1 info))
  305. (if (org-babel-noweb-p (nth 2 info) :export)
  306. (org-babel-expand-noweb-references
  307. info (org-babel-exp-get-export-buffer))
  308. (nth 1 info))))
  309. (org-fill-template
  310. org-babel-exp-code-template
  311. `(("lang" . ,(nth 0 info))
  312. ("body" . ,(org-escape-code-in-string (nth 1 info)))
  313. ,@(mapcar (lambda (pair)
  314. (cons (substring (symbol-name (car pair)) 1)
  315. (format "%S" (cdr pair))))
  316. (nth 2 info))
  317. ("flags" . ,(let ((f (nth 3 info))) (when f (concat " " f))))
  318. ("name" . ,(or (nth 4 info) "")))))
  319. (defun org-babel-exp-results (info type &optional silent hash)
  320. "Evaluate and return the results of the current code block for export.
  321. Results are prepared in a manner suitable for export by org-mode.
  322. This function is called by `org-babel-exp-do-export'. The code
  323. block will be evaluated. Optional argument SILENT can be used to
  324. inhibit insertion of results into the buffer."
  325. (when (and (or (eq org-export-babel-evaluate t)
  326. (and (eq type 'inline)
  327. (eq org-export-babel-evaluate 'inline-only)))
  328. (not (and hash (equal hash (org-babel-current-result-hash)))))
  329. (let ((lang (nth 0 info))
  330. (body (if (org-babel-noweb-p (nth 2 info) :eval)
  331. (org-babel-expand-noweb-references
  332. info (org-babel-exp-get-export-buffer))
  333. (nth 1 info)))
  334. (info (copy-sequence info))
  335. (org-babel-current-src-block-location (point-marker)))
  336. ;; skip code blocks which we can't evaluate
  337. (when (fboundp (intern (concat "org-babel-execute:" lang)))
  338. (org-babel-eval-wipe-error-buffer)
  339. (prog1 nil
  340. (setf (nth 1 info) body)
  341. (setf (nth 2 info)
  342. (org-babel-exp-in-export-file lang
  343. (org-babel-process-params
  344. (org-babel-merge-params
  345. (nth 2 info)
  346. `((:results . ,(if silent "silent" "replace")))))))
  347. (cond
  348. ((equal type 'block)
  349. (org-babel-execute-src-block nil info))
  350. ((equal type 'inline)
  351. ;; position the point on the inline source block allowing
  352. ;; `org-babel-insert-result' to check that the block is
  353. ;; inline
  354. (re-search-backward "[ \f\t\n\r\v]" nil t)
  355. (re-search-forward org-babel-inline-src-block-regexp nil t)
  356. (re-search-backward "src_" nil t)
  357. (org-babel-execute-src-block nil info))
  358. ((equal type 'lob)
  359. (save-excursion
  360. (re-search-backward org-babel-lob-one-liner-regexp nil t)
  361. (let (org-confirm-babel-evaluate)
  362. (org-babel-execute-src-block nil info))))))))))
  363. (provide 'ob-exp)
  364. ;;; ob-exp.el ends here