1 ;;; org-babel-exp.el --- Exportation of org-babel source blocks
3 ;; Copyright (C) 2009 Eric Schulte, Dan Davison
5 ;; Author: Eric Schulte, Dan Davison
6 ;; Keywords: literate programming, reproducible research
7 ;; Homepage: http://orgmode.org
12 ;; This program 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, or (at your option)
17 ;; This program 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; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
29 ;; for more information see the comments in org-babel.el
33 (require 'org-exp-blocks
)
34 (org-export-blocks-add-block '(src org-babel-exp-src-blocks nil
))
35 (add-to-list 'org-export-interblocks
'(src org-babel-exp-inline-src-blocks
))
36 (add-to-list 'org-export-interblocks
'(lob org-babel-exp-lob-one-liners
))
37 (add-hook 'org-export-blocks-postblock-hook
'org-exp-res
/src-name-cleanup
)
39 (defvar org-babel-function-def-export-keyword
"function"
40 "When exporting a source block function, this keyword will
41 appear in the exported version in the place of source name
42 line. A source block is considered to be a source block function
43 if the source name is present and is followed by a parenthesized
44 argument list. The parentheses may be empty or contain
45 whitespace. An example is the following which generates n random
54 (defvar org-babel-function-def-export-indent
4
55 "When exporting a source block function, the block contents
56 will be indented by this many characters. See
57 `org-babel-function-def-export-name' for the definition of a
58 source block function.")
60 (defvar obe-marker nil
)
62 (defun org-babel-exp-src-blocks (body &rest headers
)
63 "Process src block for export. Depending on the 'export'
64 headers argument in replace the source code block with...
66 both ---- display the code and the results
68 code ---- the default, display the code inside the block but do
71 results - just like none only the block is run on export ensuring
72 that it's results are present in the org-mode buffer
74 none ----- do not display either code or results upon export"
76 (message "org-babel-exp processing...")
77 (when (member (first headers
) org-babel-interpreters
)
79 (goto-char (match-beginning 0))
80 (let* ((info (org-babel-get-src-block-info))
81 (params (third info
)))
82 ;; expand noweb references in the original file
84 (if (and (cdr (assoc :noweb params
))
85 (string= "yes" (cdr (assoc :noweb params
))))
86 (org-babel-expand-noweb-references
87 info
(get-file-buffer org-current-export-file
))
89 (org-babel-exp-do-export info
'block
)))))
91 (defun org-babel-exp-inline-src-blocks (start end
)
92 "Process inline src blocks between START and END for export.
93 See `org-babel-exp-src-blocks' for export options, currently the
94 options and are taken from `org-babel-defualt-inline-header-args'."
98 (while (and (< (point) end
)
99 (re-search-forward org-babel-inline-src-block-regexp end t
))
100 (let* ((info (save-match-data (org-babel-parse-inline-src-block-match)))
101 (params (third info
))
104 (if (org-babel-in-example-or-verbatim)
105 (buffer-substring (match-beginning 0) (match-end 0))
106 ;; expand noweb references in the original file
108 (if (and (cdr (assoc :noweb params
))
109 (string= "yes" (cdr (assoc :noweb params
))))
110 (org-babel-expand-noweb-references
111 info
(get-file-buffer org-current-export-file
))
113 (org-babel-exp-do-export info
'inline
)))))
114 (setq end
(+ end
(- (length replacement
) (length (match-string 1)))))
115 (replace-match replacement t t nil
1)))))
117 (defun org-exp-res/src-name-cleanup
()
118 "Cleanup leftover #+results and #+srcname lines as part of the
119 org export cycle. This should only be called after all block
120 processing has taken place."
123 (goto-char (point-min))
124 (while (re-search-forward
126 "\\("org-babel-source-name-regexp
"\\|"org-babel-result-regexp
"\\)")
129 (progn (beginning-of-line) (point))
130 (progn (end-of-line) (+ 1 (point)))))))
132 (defun org-babel-in-example-or-verbatim ()
133 "Return true if the point is currently in an escaped portion of
134 an org-mode buffer code which should be treated as normal
136 (or (org-in-indented-comment-line)
139 (goto-char (point-at-bol))
140 (looking-at "[ \t]*:[ \t]")))
141 (org-in-regexps-block-p "^[ \t]*#\\+begin_src" "^[ \t]*#\\+end_src")))
143 (defun org-babel-exp-lob-one-liners (start end
)
144 "Process #+lob (Library of Babel) calls between START and END for export.
145 See `org-babel-exp-src-blocks' for export options. Currently the
146 options are taken from `org-babel-default-header-args'."
151 (while (and (< (point) end
)
152 (re-search-forward org-babel-lob-one-liner-regexp nil t
))
154 (let ((lob-info (org-babel-lob-get-info)))
156 (org-babel-exp-do-export
157 (list "emacs-lisp" "results"
158 (org-babel-merge-params
159 org-babel-default-header-args
160 (org-babel-parse-header-arguments
161 (org-babel-clean-text-properties
162 (concat ":var results="
163 (mapconcat #'identity
164 (butlast lob-info
) " ")))))
165 (car (last lob-info
)))
167 (setq end
(+ end
(- (length replacement
) (length (match-string 0)))))
168 (replace-match replacement t t
)))))
170 (defun org-babel-exp-do-export (info type
)
171 "Return a string containing the exported content of the current
172 code block respecting the value of the :exports header argument."
173 (flet ((silently () (let ((session (cdr (assoc :session
(third info
)))))
175 (not (equal "none" session
))
176 (not (assoc :noeval
(third info
))))
177 (org-babel-exp-results info type
'silent
))))
178 (clean () (org-babel-remove-result info
)))
179 (case (intern (or (cdr (assoc :exports
(third info
))) "code"))
180 ('none
(silently) (clean) "")
181 ('code
(silently) (clean) (org-babel-exp-code info type
))
182 ('results
(org-babel-exp-results info type
))
183 ('both
(concat (org-babel-exp-code info type
)
185 (org-babel-exp-results info type
))))))
187 (defun org-babel-exp-code (info type
)
188 "Return the code the current code block in a manner suitable
189 for exportation by org-mode. This function is called by
190 `org-babel-exp-do-export'. The code block will not be
192 (let ((lang (first info
))
194 (switches (fourth info
))
198 (remove-if-not (lambda (el) (eq :var
(car el
))) (third info
)))))
200 ('inline
(format "=%s=" body
))
203 (format "#+BEGIN_SRC %s %s\n%s%s#+END_SRC\n" lang switches body
204 (if (and body
(string-match "\n$" body
))
212 (mapconcat #'identity args
", ")))
216 (let ((call-line (and (string-match "results=" (car args
))
217 (substring (car args
) (match-end 0)))))
220 (format "\n#+HTML: <label class=\"org-src-name\">%s</label>\n"
222 ((t (format ": %s\n" call-line
)))))))))
224 (defun org-babel-exp-results (info type
&optional silent
)
225 "Return the results of the current code block in a manner
226 suitable for exportation by org-mode. This function is called by
227 `org-babel-exp-do-export'. The code block will be evaluated.
228 Optional argument SILENT can be used to inhibit insertion of
229 results into the buffer."
230 (let ((lang (first info
))
233 ;; lets ensure that we lookup references in the original file
236 (if (and org-current-export-file
238 (string-match org-babel-ref-split-regexp
(cdr pair
))
239 (null (org-babel-ref-literal (match-string 2 (cdr pair
)))))
240 `(:var .
,(concat (match-string 1 (cdr pair
))
241 "=" org-current-export-file
242 ":" (match-string 2 (cdr pair
))))
247 (let ((raw (org-babel-execute-src-block
248 nil info
'((:results .
"silent"))))
249 (result-params (split-string (cdr (assoc :results params
)))))
251 (cond ;; respect the value of the :results header argument
252 ((member "file" result-params
)
253 (org-babel-result-to-file raw
))
254 ((or (member "raw" result-params
) (member "org" result-params
))
256 ((member "code" result-params
)
257 (format "src_%s{%s}" lang raw
))
260 (if (= 0 (length raw
)) "=(no results)="
262 (format "%S" raw
)))))))
264 (org-babel-execute-src-block
265 nil info
(org-babel-merge-params
266 params
`((:results .
,(if silent
"silent" "replace")))))
270 (re-search-backward org-babel-lob-one-liner-regexp nil t
)
271 (org-babel-execute-src-block
272 nil info
(org-babel-merge-params
273 params
`((:results .
,(if silent
"silent" "replace")))))
276 (provide 'org-babel-exp
)
277 ;;; org-babel-exp.el ends here