ob-exp.el 15 KB

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