1 ;;; ob-exp.el --- Exportation of org-babel source blocks
3 ;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte, Dan Davison
6 ;; Keywords: literate programming, reproducible research
7 ;; 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 ;; See the online documentation for more information
29 ;; http://orgmode.org/worg/org-contrib/babel/
33 (require 'org-exp-blocks
)
37 (defvar obe-marker nil
)
38 (defvar org-current-export-file
)
39 (defvar org-babel-lob-one-liner-regexp
)
40 (defvar org-babel-ref-split-regexp
)
41 (declare-function org-babel-lob-get-info
"ob-lob" ())
42 (declare-function org-babel-eval-wipe-error-buffer
"ob-eval" ())
43 (add-to-list 'org-export-interblocks
'(src org-babel-exp-inline-src-blocks
))
44 (add-to-list 'org-export-interblocks
'(lob org-babel-exp-lob-one-liners
))
45 (add-hook 'org-export-blocks-postblock-hook
'org-exp-res
/src-name-cleanup
)
47 (org-export-blocks-add-block '(src org-babel-exp-src-block nil
))
49 (defcustom org-export-babel-evaluate t
50 "Switch controlling code evaluation during export.
51 When set to nil no code will be evaluated as part of the export
55 (put 'org-export-babel-evaluate
'safe-local-variable
(lambda (x) (eq x nil
)))
57 (defvar org-babel-function-def-export-keyword
"function"
58 "The keyword to substitute for the source name line on export.
59 When exporting a source block function, this keyword will
60 appear in the exported version in the place of source name
61 line. A source block is considered to be a source block function
62 if the source name is present and is followed by a parenthesized
63 argument list. The parentheses may be empty or contain
64 whitespace. An example is the following which generates n random
72 (defvar org-babel-function-def-export-indent
4
73 "Number of characters to indent a source block on export.
74 When exporting a source block function, the block contents will
75 be indented by this many characters. See
76 `org-babel-function-def-export-name' for the definition of a
77 source block function.")
79 (defmacro org-babel-exp-in-export-file
(&rest body
)
80 `(let* ((lang-headers (intern (concat "org-babel-default-header-args:" lang
)))
81 (heading (nth 4 (ignore-errors (org-heading-components))))
82 (link (when org-current-export-file
85 (concat org-current-export-file
"::" heading
)
86 org-current-export-file
))))
87 (export-buffer (current-buffer)) results
)
89 ;; resolve parameters in the original file so that
90 ;; headline and file-wide parameters are included, attempt
91 ;; to go to the same heading in the original file
92 (set-buffer (get-file-buffer org-current-export-file
))
95 (org-open-link-from-string link
)
97 (goto-char (point-min))
98 (re-search-forward (regexp-quote heading
) nil t
))))
99 (setq results
,@body
))
100 (set-buffer export-buffer
)
103 (defun org-babel-exp-src-block (body &rest headers
)
104 "Process source block for export.
105 Depending on the 'export' headers argument in replace the source
108 both ---- display the code and the results
110 code ---- the default, display the code inside the block but do
113 results - just like none only the block is run on export ensuring
114 that it's results are present in the org-mode buffer
116 none ----- do not display either code or results upon export"
118 (message "org-babel-exp processing...")
120 (goto-char (match-beginning 0))
121 (let* ((info (org-babel-get-src-block-info 'light
))
123 (raw-params (nth 2 info
)))
124 ;; bail if we couldn't get any info from the block
126 (org-babel-exp-in-export-file
128 (org-babel-merge-params
129 org-babel-default-header-args
130 (org-babel-params-from-buffer)
131 (org-babel-params-from-properties lang
)
132 (if (boundp lang-headers
) (eval lang-headers
) nil
)
134 ;; expand noweb references in the original file
136 (if (and (cdr (assoc :noweb
(nth 2 info
)))
137 (string= "yes" (cdr (assoc :noweb
(nth 2 info
)))))
138 (org-babel-expand-noweb-references
139 info
(get-file-buffer org-current-export-file
))
141 (org-babel-exp-do-export info
'block
)))))
143 (defun org-babel-exp-inline-src-blocks (start end
)
144 "Process inline source blocks between START and END for export.
145 See `org-babel-exp-src-block' for export options, currently the
146 options and are taken from `org-babel-default-inline-header-args'."
150 (while (and (< (point) end
)
151 (re-search-forward org-babel-inline-src-block-regexp end t
))
152 (let* ((info (save-match-data (org-babel-parse-inline-src-block-match)))
153 (params (nth 2 info
)) code-replacement
)
155 (goto-char (match-beginning 2))
156 (if (org-babel-in-example-or-verbatim)
157 (buffer-substring (match-beginning 0) (match-end 0))
158 ;; expand noweb references in the original file
160 (if (and (cdr (assoc :noweb params
))
161 (string= "yes" (cdr (assoc :noweb params
))))
162 (org-babel-expand-noweb-references
163 info
(get-file-buffer org-current-export-file
))
165 (setq code-replacement
(org-babel-exp-do-export info
'inline
))))
167 (replace-match code-replacement nil nil nil
1)
168 (org-babel-examplize-region (match-beginning 1) (match-end 1))
169 (forward-char 2))))))
171 (defun org-exp-res/src-name-cleanup
()
172 "Clean up #+results and #+srcname lines for export.
173 This function should only be called after all block processing
177 (goto-char (point-min))
178 (while (org-re-search-forward-unprotected
180 "\\("org-babel-src-name-regexp
"\\|"org-babel-result-regexp
"\\)")
183 (progn (beginning-of-line) (point))
184 (progn (end-of-line) (+ 1 (point)))))))
186 (defun org-babel-in-example-or-verbatim ()
187 "Return true if point is in example or verbatim code.
188 Example and verbatim code include escaped portions of
189 an org-mode buffer code that should be treated as normal
191 (or (org-in-indented-comment-line)
194 (goto-char (point-at-bol))
195 (looking-at "[ \t]*:[ \t]")))
196 (org-in-regexps-block-p "^[ \t]*#\\+begin_src" "^[ \t]*#\\+end_src")))
198 (defun org-babel-exp-lob-one-liners (start end
)
199 "Process Library of Babel calls between START and END for export.
200 See `org-babel-exp-src-block' for export options. Currently the
201 options are taken from `org-babel-default-header-args'."
206 (while (and (< (point) end
)
207 (re-search-forward org-babel-lob-one-liner-regexp nil t
))
209 (let ((lob-info (org-babel-lob-get-info)))
211 (org-babel-exp-do-export
212 (list "emacs-lisp" "results"
213 (org-babel-merge-params
214 org-babel-default-header-args
215 (org-babel-params-from-buffer)
216 (org-babel-params-from-properties)
217 (org-babel-parse-header-arguments
218 (org-babel-clean-text-properties
219 (concat ":var results="
220 (mapconcat #'identity
221 (butlast lob-info
) " ")))))
222 (car (last lob-info
)))
224 (setq end
(+ end
(- (length replacement
) (length (match-string 0)))))
225 (replace-match replacement t t
)))))
227 (defun org-babel-exp-do-export (info type
)
228 "Return a string with the exported content of a code block.
229 The function respects the value of the :exports header argument."
230 (flet ((silently () (let ((session (cdr (assoc :session
(nth 2 info
)))))
231 (when (and session
(not (equal "none" session
)))
232 (org-babel-exp-results info type
'silent
))))
233 (clean () (unless (eq type
'inline
) (org-babel-remove-result info
))))
234 (case (intern (or (cdr (assoc :exports
(nth 2 info
))) "code"))
235 ('none
(silently) (clean) "")
236 ('code
(silently) (clean) nil
)
237 ('results
(org-babel-exp-results info type
) "")
238 ('both
(org-babel-exp-results info type
) nil
))))
240 (defun org-babel-exp-results (info type
&optional silent
)
241 "Evaluate and return the results of the current code block for export.
242 Results are prepared in a manner suitable for export by org-mode.
243 This function is called by `org-babel-exp-do-export'. The code
244 block will be evaluated. Optional argument SILENT can be used to
245 inhibit insertion of results into the buffer."
246 (when org-export-babel-evaluate
247 (let ((lang (nth 0 info
))
249 (setf (nth 2 info
) (org-babel-exp-in-export-file
250 (org-babel-process-params (nth 2 info
))))
251 ;; skip code blocks which we can't evaluate
252 (when (fboundp (intern (concat "org-babel-execute:" lang
)))
253 (org-babel-eval-wipe-error-buffer)
256 (org-babel-merge-params
258 `((:results .
,(if silent
"silent" "replace")))))
260 ((or (equal type
'block
) (equal type
'inline
))
261 (org-babel-execute-src-block nil info
))
264 (re-search-backward org-babel-lob-one-liner-regexp nil t
)
265 (org-babel-execute-src-block nil info
)))))))))
269 ;; arch-tag: 523abf4c-76d1-44ed-9f27-e3bddf34bf0f
271 ;;; ob-exp.el ends here