1 ;;; ob-exp.el --- Exportation of org-babel source blocks
3 ;; Copyright (C) 2009-2013 Free Software Foundation, Inc.
5 ;; Authors: Eric Schulte
7 ;; Keywords: literate programming, reproducible research
8 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 (defvar org-current-export-file
)
31 (defvar org-babel-lob-one-liner-regexp
)
32 (defvar org-babel-ref-split-regexp
)
33 (defvar org-list-forbidden-blocks
)
35 (declare-function org-babel-lob-get-info
"ob-lob" ())
36 (declare-function org-babel-eval-wipe-error-buffer
"ob-eval" ())
37 (declare-function org-between-regexps-p
"org"
38 (start-re end-re
&optional lim-up lim-down
))
39 (declare-function org-get-indentation
"org" (&optional line
))
40 (declare-function org-heading-components
"org" ())
41 (declare-function org-in-block-p
"org" (names))
42 (declare-function org-in-verbatim-emphasis
"org" ())
43 (declare-function org-link-search
"org" (s &optional type avoid-pos stealth
))
44 (declare-function org-fill-template
"org" (template alist
))
45 (declare-function org-split-string
"org" (string &optional separators
))
46 (declare-function org-element-at-point
"org-element" (&optional keep-trail
))
47 (declare-function org-element-context
"org-element" ())
48 (declare-function org-element-property
"org-element" (property element
))
49 (declare-function org-element-type
"org-element" (element))
50 (declare-function org-escape-code-in-string
"org-src" (s))
52 (defcustom org-export-babel-evaluate t
53 "Switch controlling code evaluation during export.
54 When set to nil no code will be evaluated as part of the export
55 process. When set to 'inline-only, only inline code blocks will
59 :type
'(choice (const :tag
"Never" nil
)
60 (const :tag
"Only inline code" inline-only
)
61 (const :tag
"Always" t
)))
62 (put 'org-export-babel-evaluate
'safe-local-variable
(lambda (x) (eq x nil
)))
64 (defun org-babel-exp-get-export-buffer ()
65 "Return the current export buffer if possible."
67 ((bufferp org-current-export-file
) org-current-export-file
)
68 (org-current-export-file (get-file-buffer org-current-export-file
))
70 (error "Requested export buffer when `org-current-export-file' is nil"))))
72 (defmacro org-babel-exp-in-export-file
(lang &rest body
)
74 `(let* ((lang-headers (intern (concat "org-babel-default-header-args:" ,lang
)))
75 (heading (nth 4 (ignore-errors (org-heading-components))))
76 (export-buffer (current-buffer))
77 (original-buffer (org-babel-exp-get-export-buffer)) results
)
79 ;; resolve parameters in the original file so that
80 ;; headline and file-wide parameters are included, attempt
81 ;; to go to the same heading in the original file
82 (set-buffer original-buffer
)
86 (let ((org-link-search-inhibit-query t
))
87 (org-link-search heading
))
89 (goto-char (point-min))
90 (re-search-forward (regexp-quote heading
) nil t
)))))
91 (setq results
,@body
))
92 (set-buffer export-buffer
)
94 (def-edebug-spec org-babel-exp-in-export-file
(form body
))
96 (defun org-babel-exp-src-block (&rest headers
)
97 "Process source block for export.
98 Depending on the 'export' headers argument, replace the source
101 both ---- display the code and the results
103 code ---- the default, display the code inside the block but do
106 results - just like none only the block is run on export ensuring
107 that it's results are present in the org-mode buffer
109 none ---- do not display either code or results upon export
111 Assume point is at the beginning of block's starting line."
113 (unless noninteractive
(message "org-babel-exp processing..."))
115 (let* ((info (org-babel-get-src-block-info 'light
))
117 (raw-params (nth 2 info
)) hash
)
118 ;; bail if we couldn't get any info from the block
120 ;; if we're actually going to need the parameters
121 (when (member (cdr (assoc :exports
(nth 2 info
))) '("both" "results"))
122 (org-babel-exp-in-export-file lang
124 (org-babel-process-params
125 (apply #'org-babel-merge-params
126 org-babel-default-header-args
127 (if (boundp lang-headers
) (eval lang-headers
) nil
)
128 (append (org-babel-params-from-properties lang
)
129 (list raw-params
))))))
130 (setf hash
(org-babel-sha1-hash info
)))
131 (org-babel-exp-do-export info
'block hash
)))))
133 (defcustom org-babel-exp-call-line-template
135 "Template used to export call lines.
136 This template may be customized to include the call line name
137 with any export markup. The template is filled out using
138 `org-fill-template', and the following %keys may be used.
142 An example value would be \"\\n: call: %line\" to export the call line
143 wrapped in a verbatim environment.
145 Note: the results are inserted separately after the contents of
150 (defvar org-babel-default-lob-header-args
)
151 (defun org-babel-exp-non-block-elements (start end
)
152 "Process inline source and call lines between START and END for export."
156 (unless (markerp end
)
157 (let ((m (make-marker)))
158 (set-marker m end
(current-buffer))
160 (let ((rx (concat "\\(?:" org-babel-inline-src-block-regexp
161 "\\|" org-babel-lob-one-liner-regexp
"\\)")))
162 (while (re-search-forward rx end t
)
164 (let* ((element (save-excursion
165 ;; If match is inline, point is at its
166 ;; end. Move backward so
167 ;; `org-element-context' can get the
168 ;; object, not the following one.
170 (save-match-data (org-element-context))))
171 (type (org-element-type element
)))
172 (when (memq type
'(babel-call inline-babel-call inline-src-block
))
173 (let ((beg-el (org-element-property :begin element
))
174 (end-el (org-element-property :end element
)))
177 (let* ((info (org-babel-parse-inline-src-block-match))
178 (params (nth 2 info
)))
180 (if (and (cdr (assoc :noweb params
))
181 (string= "yes" (cdr (assoc :noweb params
))))
182 (org-babel-expand-noweb-references
183 info
(org-babel-exp-get-export-buffer))
186 (unless (save-excursion (goto-char (point-at-bol))
187 (looking-at "^#\\+"))
188 (let ((replacement (org-babel-exp-do-export
190 (if (equal replacement
"")
191 ;; Replacement code is empty: completely
192 ;; remove inline src block, including extra
193 ;; white space that might have been created
194 ;; when inserting results.
195 (delete-region beg-el
196 (progn (goto-char end-el
)
197 (skip-chars-forward " \t")
199 ;; Otherwise: remove inline src block but
200 ;; preserve following white spaces. Then
202 (delete-region beg-el
203 (progn (goto-char end-el
)
204 (skip-chars-backward " \t")
206 (insert replacement
))))))
207 ((babel-call inline-babel-call
)
208 (let* ((lob-info (org-babel-lob-get-info))
210 (org-babel-exp-do-export
211 (list "emacs-lisp" "results"
212 (apply #'org-babel-merge-params
213 org-babel-default-header-args
214 org-babel-default-lob-header-args
216 (org-babel-params-from-properties)
218 (org-babel-parse-header-arguments
225 "" (nth 3 lob-info
) (nth 2 lob-info
))
227 (rep (org-fill-template
228 org-babel-exp-call-line-template
229 `(("line" .
,(nth 0 lob-info
))))))
230 ;; If replacement is empty, completely remove the
231 ;; object/element, including any extra white space
232 ;; that might have been created when including
237 (progn (goto-char end-el
)
238 (if (not (eq type
'babel-call
))
239 (progn (skip-chars-forward " \t") (point))
240 (skip-chars-forward " \r\t\n")
241 (line-beginning-position))))
242 ;; Otherwise, preserve following white
243 ;; spaces/newlines and then, insert replacement
246 (delete-region beg-el
247 (progn (goto-char end-el
)
248 (skip-chars-backward " \r\t\n")
250 (insert rep
)))))))))))))
252 (defvar org-src-preserve-indentation
) ; From org-src.el
253 (defun org-babel-exp-process-buffer ()
254 "Execute all blocks in visible part of buffer."
256 (save-window-excursion
257 (let ((case-fold-search t
)
260 (while (re-search-forward "^[ \t]*#\\+BEGIN_SRC" nil t
)
261 (let ((element (save-match-data (org-element-at-point))))
262 (when (eq (org-element-type element
) 'src-block
)
263 (let* ((match-start (copy-marker (match-beginning 0)))
264 (begin (copy-marker (org-element-property :begin element
)))
265 ;; Make sure we don't remove any blank lines after
266 ;; the block when replacing it.
267 (block-end (save-excursion
268 (goto-char (org-element-property :end element
))
269 (skip-chars-backward " \r\t\n")
270 (copy-marker (line-end-position))))
271 (ind (org-get-indentation))
274 (org-element-property :language element
)
275 (let ((params (org-element-property :parameters element
)))
276 (and params
(org-split-string params
"[ \t]+"))))))
277 ;; Execute all non-block elements between POS and
279 (org-babel-exp-non-block-elements pos begin
)
280 ;; Take care of matched block: compute replacement
281 ;; string. In particular, a nil REPLACEMENT means the
282 ;; block should be left as-is while an empty string
283 ;; should remove the block.
284 (let ((replacement (progn (goto-char match-start
)
285 (org-babel-exp-src-block headers
))))
286 (cond ((not replacement
) (goto-char block-end
))
287 ((equal replacement
"")
289 (progn (goto-char block-end
)
290 (skip-chars-forward " \r\t\n")
292 (line-beginning-position)))))
294 (goto-char match-start
)
295 (delete-region (point) block-end
)
297 (if (org-element-property :preserve-indent element
)
298 ;; Indent only the code block markers.
299 (save-excursion (skip-chars-backward " \r\t\n")
301 (goto-char match-start
)
302 (indent-line-to ind
))
303 ;; Indent everything.
304 (indent-rigidly match-start
(point) ind
)))))
305 (setq pos
(line-beginning-position))
307 (set-marker match-start nil
)
308 (set-marker begin nil
)
309 (set-marker block-end nil
)))))
310 ;; Eventually execute all non-block Babel elements between last
311 ;; src-block and end of buffer.
312 (org-babel-exp-non-block-elements pos
(point-max)))))
314 (defun org-babel-in-example-or-verbatim ()
315 "Return true if point is in example or verbatim code.
316 Example and verbatim code include escaped portions of
317 an org-mode buffer code that should be treated as normal
321 (goto-char (point-at-bol))
322 (looking-at "[ \t]*:[ \t]")))
323 (org-in-verbatim-emphasis)
324 (org-in-block-p org-list-forbidden-blocks
)
325 (org-between-regexps-p "^[ \t]*#\\+begin_src" "^[ \t]*#\\+end_src")))
327 (defun org-babel-exp-do-export (info type
&optional hash
)
328 "Return a string with the exported content of a code block.
329 The function respects the value of the :exports header argument."
330 (let ((silently (lambda () (let ((session (cdr (assoc :session
(nth 2 info
)))))
331 (when (not (and session
(equal "none" session
)))
332 (org-babel-exp-results info type
'silent
)))))
333 (clean (lambda () (unless (eq type
'inline
) (org-babel-remove-result info
)))))
334 (case (intern (or (cdr (assoc :exports
(nth 2 info
))) "code"))
335 ('none
(funcall silently
) (funcall clean
) "")
336 ('code
(funcall silently
) (funcall clean
) (org-babel-exp-code info
))
337 ('results
(org-babel-exp-results info type nil hash
) "")
338 ('both
(org-babel-exp-results info type nil hash
)
339 (org-babel-exp-code info
)))))
341 (defcustom org-babel-exp-code-template
342 "#+BEGIN_SRC %lang%flags\n%body\n#+END_SRC"
343 "Template used to export the body of code blocks.
344 This template may be customized to include additional information
345 such as the code block name, or the values of particular header
346 arguments. The template is filled out using `org-fill-template',
347 and the following %keys may be used.
349 lang ------ the language of the code block
350 name ------ the name of the code block
351 body ------ the body of the code block
352 flags ----- the flags passed to the code block
354 In addition to the keys mentioned above, every header argument
355 defined for the code block may be used as a key and will be
356 replaced with its value."
360 (defun org-babel-exp-code (info)
361 "Return the original code block formatted for export."
363 (if (string= "strip-export" (cdr (assoc :noweb
(nth 2 info
))))
364 (replace-regexp-in-string
365 (org-babel-noweb-wrap) "" (nth 1 info
))
366 (if (org-babel-noweb-p (nth 2 info
) :export
)
367 (org-babel-expand-noweb-references
368 info
(org-babel-exp-get-export-buffer))
371 org-babel-exp-code-template
372 `(("lang" .
,(nth 0 info
))
373 ("body" .
,(org-escape-code-in-string (nth 1 info
)))
374 ,@(mapcar (lambda (pair)
375 (cons (substring (symbol-name (car pair
)) 1)
376 (format "%S" (cdr pair
))))
378 ("flags" .
,((lambda (f) (when f
(concat " " f
))) (nth 3 info
)))
379 ("name" .
,(or (nth 4 info
) "")))))
381 (defun org-babel-exp-results (info type
&optional silent hash
)
382 "Evaluate and return the results of the current code block for export.
383 Results are prepared in a manner suitable for export by org-mode.
384 This function is called by `org-babel-exp-do-export'. The code
385 block will be evaluated. Optional argument SILENT can be used to
386 inhibit insertion of results into the buffer."
387 (when (and (or (eq org-export-babel-evaluate t
)
388 (and (eq type
'inline
)
389 (eq org-export-babel-evaluate
'inline-only
)))
390 (not (and hash
(equal hash
(org-babel-current-result-hash)))))
391 (let ((lang (nth 0 info
))
392 (body (if (org-babel-noweb-p (nth 2 info
) :eval
)
393 (org-babel-expand-noweb-references
394 info
(org-babel-exp-get-export-buffer))
396 (info (copy-sequence info
))
397 (org-babel-current-src-block-location (point-marker)))
398 ;; skip code blocks which we can't evaluate
399 (when (fboundp (intern (concat "org-babel-execute:" lang
)))
400 (org-babel-eval-wipe-error-buffer)
402 (setf (nth 1 info
) body
)
404 (org-babel-exp-in-export-file lang
405 (org-babel-process-params
406 (org-babel-merge-params
408 `((:results .
,(if silent
"silent" "replace")))))))
411 (org-babel-execute-src-block nil info
))
412 ((equal type
'inline
)
413 ;; position the point on the inline source block allowing
414 ;; `org-babel-insert-result' to check that the block is
416 (re-search-backward "[ \f\t\n\r\v]" nil t
)
417 (re-search-forward org-babel-inline-src-block-regexp nil t
)
418 (re-search-backward "src_" nil t
)
419 (org-babel-execute-src-block nil info
))
422 (re-search-backward org-babel-lob-one-liner-regexp nil t
)
423 (let (org-confirm-babel-evaluate)
424 (org-babel-execute-src-block nil info
))))))))))
429 ;;; ob-exp.el ends here