1 ;;; ob-exp.el --- Exportation of org-babel source blocks
3 ;; Copyright (C) 2009-2012 Free Software Foundation, Inc.
5 ;; Author: 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/>.
27 (require 'org-exp-blocks
)
31 (defvar obe-marker nil
)
32 (defvar org-current-export-file
)
33 (defvar org-babel-lob-one-liner-regexp
)
34 (defvar org-babel-ref-split-regexp
)
35 (declare-function org-babel-lob-get-info
"ob-lob" ())
36 (declare-function org-babel-eval-wipe-error-buffer
"ob-eval" ())
37 (add-to-list 'org-export-interblocks
'(src org-babel-exp-non-block-elements
))
39 (org-export-blocks-add-block '(src org-babel-exp-src-block nil
))
41 (defcustom org-export-babel-evaluate t
42 "Switch controlling code evaluation during export.
43 When set to nil no code will be evaluated as part of the export
47 (put 'org-export-babel-evaluate
'safe-local-variable
(lambda (x) (eq x nil
)))
49 (defmacro org-babel-exp-in-export-file
(lang &rest body
)
51 `(let* ((lang-headers (intern (concat "org-babel-default-header-args:" ,lang
)))
52 (heading (nth 4 (ignore-errors (org-heading-components))))
53 (link (when org-current-export-file
56 (concat org-current-export-file
"::" heading
)
57 org-current-export-file
))))
58 (export-buffer (current-buffer)) results
)
60 ;; resolve parameters in the original file so that
61 ;; headline and file-wide parameters are included, attempt
62 ;; to go to the same heading in the original file
63 (set-buffer (get-file-buffer org-current-export-file
))
66 (let ((org-link-search-inhibit-query t
))
67 (org-open-link-from-string link
))
69 (goto-char (point-min))
70 (re-search-forward (regexp-quote heading
) nil t
))))
71 (setq results
,@body
))
72 (set-buffer export-buffer
)
74 (def-edebug-spec org-babel-exp-in-export-file
(form body
))
76 (defun org-babel-exp-src-block (body &rest headers
)
77 "Process source block for export.
78 Depending on the 'export' headers argument in replace the source
81 both ---- display the code and the results
83 code ---- the default, display the code inside the block but do
86 results - just like none only the block is run on export ensuring
87 that it's results are present in the org-mode buffer
89 none ----- do not display either code or results upon export"
91 (unless noninteractive
(message "org-babel-exp processing..."))
93 (goto-char (match-beginning 0))
94 (let* ((info (org-babel-get-src-block-info 'light
))
96 (raw-params (nth 2 info
)) hash
)
97 ;; bail if we couldn't get any info from the block
99 ;; if we're actually going to need the parameters
100 (when (member (cdr (assoc :exports
(nth 2 info
))) '("both" "results"))
101 (org-babel-exp-in-export-file lang
103 (org-babel-process-params
104 (org-babel-merge-params
105 org-babel-default-header-args
106 (org-babel-params-from-properties lang
)
107 (if (boundp lang-headers
) (eval lang-headers
) nil
)
109 (setf hash
(org-babel-sha1-hash info
)))
110 ;; expand noweb references in the original file
112 (if (org-babel-noweb-p (nth 2 info
) :export
)
113 (org-babel-expand-noweb-references
114 info
(get-file-buffer org-current-export-file
))
116 (org-babel-exp-do-export info
'block hash
)))))
118 (defcustom org-babel-exp-call-line-template
120 "Template used to export call lines.
121 This template may be customized to include the call line name
122 with any export markup. The template is filled out using
123 `org-fill-template', and the following %keys may be used.
127 An example value would be \"\\n: call: %line\" to export the call line
128 wrapped in a verbatim environment.
130 Note: the results are inserted separately after the contents of
135 (defvar org-babel-default-lob-header-args
)
136 (defun org-babel-exp-non-block-elements (start end
)
137 "Process inline source and call lines between START and END for export."
141 (unless (markerp end
)
142 (let ((m (make-marker)))
143 (set-marker m end
(current-buffer))
145 (let ((rx (concat "\\(" org-babel-inline-src-block-regexp
146 "\\|" org-babel-lob-one-liner-regexp
"\\)")))
147 (while (and (< (point) (marker-position end
))
148 (re-search-forward rx end t
))
150 (goto-char (match-beginning 0))
151 (looking-at org-babel-inline-src-block-regexp
))
154 (let* ((info (save-match-data
155 (org-babel-parse-inline-src-block-match)))
156 (params (nth 2 info
)))
158 (goto-char (match-beginning 2))
159 (unless (org-babel-in-example-or-verbatim)
160 ;; expand noweb references in the original file
162 (if (and (cdr (assoc :noweb params
))
163 (string= "yes" (cdr (assoc :noweb params
))))
164 (org-babel-expand-noweb-references
165 info
(get-file-buffer org-current-export-file
))
167 (let ((code-replacement (save-match-data
168 (org-babel-exp-do-export
171 (replace-match code-replacement nil nil nil
1)
172 (org-babel-examplize-region (match-beginning 1)
174 (forward-char 2)))))))
175 (unless (org-babel-in-example-or-verbatim)
176 (let* ((lob-info (org-babel-lob-get-info))
177 (inlinep (match-string 11))
178 (inline-start (match-end 11))
179 (inline-end (match-end 0))
180 (results (save-match-data
181 (org-babel-exp-do-export
182 (list "emacs-lisp" "results"
183 (org-babel-merge-params
184 org-babel-default-header-args
185 org-babel-default-lob-header-args
186 (org-babel-params-from-properties)
187 (org-babel-parse-header-arguments
188 (org-babel-clean-text-properties
189 (concat ":var results="
190 (mapconcat #'identity
193 "" nil
(car (last lob-info
)))
195 (rep (org-fill-template
196 org-babel-exp-call-line-template
197 `(("line" .
,(nth 0 lob-info
))))))
200 (goto-char inline-start
)
201 (delete-region inline-start inline-end
)
203 (replace-match rep t t
)))))))))
205 (defun org-babel-in-example-or-verbatim ()
206 "Return true if point is in example or verbatim code.
207 Example and verbatim code include escaped portions of
208 an org-mode buffer code that should be treated as normal
212 (goto-char (point-at-bol))
213 (looking-at "[ \t]*:[ \t]")))
214 (org-in-verbatim-emphasis)
215 (org-in-block-p org-list-forbidden-blocks
)
216 (org-between-regexps-p "^[ \t]*#\\+begin_src" "^[ \t]*#\\+end_src")))
218 (defun org-babel-exp-do-export (info type
&optional hash
)
219 "Return a string with the exported content of a code block.
220 The function respects the value of the :exports header argument."
221 (flet ((silently () (let ((session (cdr (assoc :session
(nth 2 info
)))))
222 (when (not (and session
(equal "none" session
)))
223 (org-babel-exp-results info type
'silent
))))
224 (clean () (unless (eq type
'inline
) (org-babel-remove-result info
))))
225 (case (intern (or (cdr (assoc :exports
(nth 2 info
))) "code"))
226 ('none
(silently) (clean) "")
227 ('code
(silently) (clean) (org-babel-exp-code info
))
228 ('results
(org-babel-exp-results info type nil hash
) "")
229 ('both
(org-babel-exp-results info type nil hash
)
230 (org-babel-exp-code info
)))))
232 (defcustom org-babel-exp-code-template
233 "#+BEGIN_SRC %lang%flags\n%body\n#+END_SRC"
234 "Template used to export the body of code blocks.
235 This template may be customized to include additional information
236 such as the code block name, or the values of particular header
237 arguments. The template is filled out using `org-fill-template',
238 and the following %keys may be used.
240 lang ------ the language of the code block
241 name ------ the name of the code block
242 body ------ the body of the code block
243 flags ----- the flags passed to the code block
245 In addition to the keys mentioned above, every header argument
246 defined for the code block may be used as a key and will be
247 replaced with its value."
251 (defun org-babel-exp-code (info)
252 "Return the original code block formatted for export."
254 org-babel-exp-code-template
255 `(("lang" .
,(nth 0 info
))
256 ("body" .
,(nth 1 info
))
257 ,@(mapcar (lambda (pair)
258 (cons (substring (symbol-name (car pair
)) 1)
259 (format "%S" (cdr pair
))))
261 ("flags" .
,((lambda (f) (when f
(concat " " f
))) (nth 3 info
)))
262 ("name" .
,(or (nth 4 info
) "")))))
264 (defun org-babel-exp-results (info type
&optional silent hash
)
265 "Evaluate and return the results of the current code block for export.
266 Results are prepared in a manner suitable for export by org-mode.
267 This function is called by `org-babel-exp-do-export'. The code
268 block will be evaluated. Optional argument SILENT can be used to
269 inhibit insertion of results into the buffer."
270 (when (and org-export-babel-evaluate
271 (not (and hash
(equal hash
(org-babel-current-result-hash)))))
272 (let ((lang (nth 0 info
))
274 (info (copy-sequence info
)))
275 ;; skip code blocks which we can't evaluate
276 (when (fboundp (intern (concat "org-babel-execute:" lang
)))
277 (org-babel-eval-wipe-error-buffer)
280 (org-babel-exp-in-export-file lang
281 (org-babel-process-params
282 (org-babel-merge-params
284 `((:results .
,(if silent
"silent" "replace")))))))
287 (org-babel-execute-src-block nil info
))
288 ((equal type
'inline
)
289 ;; position the point on the inline source block allowing
290 ;; `org-babel-insert-result' to check that the block is
292 (re-search-backward "[ \f\t\n\r\v]" nil t
)
293 (re-search-forward org-babel-inline-src-block-regexp nil t
)
294 (re-search-backward "src_" nil t
)
295 (org-babel-execute-src-block nil info
))
298 (re-search-backward org-babel-lob-one-liner-regexp nil t
)
299 (org-babel-execute-src-block nil info
)))))))))
305 ;;; ob-exp.el ends here