1 ;;; ob-clojure.el --- org-babel functions for clojure evaluation
3 ;; Copyright (C) 2009, 2010 Free Software Foundation, Inc.
5 ;; Author: Joel Boehland
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 ;;; ob support for evaluating clojure code
31 ;;; A working clojure install. This also implies a working java executable
36 ;;; By far, the best way to install these components is by following
37 ;;; the directions as set out by Phil Hagelberg (Technomancy) on the
38 ;;; web page: http://technomancy.us/126
43 (eval-when-compile (require 'cl
))
45 (declare-function slime-eval-async
"ext:slime" (sexp &optional cont package
))
46 (declare-function slime-eval
"ext:slime" (sexp &optional package
))
47 (declare-function swank-clojure-concat-paths
"ext:slime" (paths))
48 (declare-function org-babel-ref-variables
"ext:slime" (params))
49 (declare-function slime
"ext:slime" (&optional command coding-system
))
50 (declare-function slime-output-buffer
"ext:slime" (&optional noprompt
))
51 (declare-function slime-filter-buffers
"ext:slime" (predicate))
53 (add-to-list 'org-babel-tangle-lang-exts
'("clojure" .
"clj"))
55 (defvar org-babel-default-header-args
:clojure
'())
57 (defvar org-babel-clojure-wrapper-method
61 (with-open [#^java.io.PrintWriter w
63 (java.io.BufferedWriter.
64 (java.io.OutputStreamWriter.
65 (java.io.FileOutputStream.
66 (java.io.File. f)))))]
73 (spit \"%s\" (str (main)))")
74 ;;";; <-- syntax highlighting is messed without this double quote
76 ;;taken mostly from clojure-test-mode.el
77 (defun org-babel-clojure-clojure-slime-eval (string &optional handler
)
78 "Evaluate a STRING of clojure code using `slime-eval-async'."
79 (slime-eval-async `(swank:eval-and-grab-output
,string
)
80 (or handler
#'identity
)))
82 (defun org-babel-clojure-slime-eval-sync (string)
83 "Evaluate a STRING of clojure code using `slime-eval'."
84 (slime-eval `(swank:eval-and-grab-output
,string
)))
86 ;;taken from swank-clojure.el
87 (defvar swank-clojure-binary
)
88 (defvar swank-clojure-classpath
)
89 (defvar swank-clojure-java-path
)
90 (defvar swank-clojure-extra-vm-args
)
91 (defvar swank-clojure-library-paths
)
92 (defvar swank-clojure-extra-classpaths
)
93 (defun org-babel-clojure-babel-clojure-cmd ()
94 "Create the command to start clojure according to current settings."
95 (if (and (not swank-clojure-binary
) (not swank-clojure-classpath
))
96 (error "%s" (concat "You must specifiy either a `swank-clojure-binary' "
97 "or a `swank-clojure-jar-path'"))
98 (if swank-clojure-binary
99 (if (listp swank-clojure-binary
)
101 (list swank-clojure-binary
))
105 (list swank-clojure-java-path
)
106 swank-clojure-extra-vm-args
108 (when swank-clojure-library-paths
109 (concat "-Djava.library.path="
110 (swank-clojure-concat-paths swank-clojure-library-paths
)))
112 (swank-clojure-concat-paths
114 swank-clojure-classpath
115 swank-clojure-extra-classpaths
))
118 (defun org-babel-clojure-table-or-string (results)
119 "Convert RESULTS to an elisp value.
120 If RESULTS looks like a table, then convert to an Emacs-lisp
121 table, otherwise return the results as a string."
123 (if (string-match "^\\[.+\\]$" results
)
126 (replace-regexp-in-string
127 "\\[" "(" (replace-regexp-in-string
128 "\\]" ")" (replace-regexp-in-string
129 ", " " " (replace-regexp-in-string
130 "'" "\"" results
))))))
133 (defun org-babel-clojure-var-to-clojure (var)
134 "Convert an elisp value into a clojure variable.
135 The elisp value VAR is converted into a string of clojure source
136 code specifying a variable of the same value."
141 (defun org-babel-clojure-build-full-form (body vars
)
142 "Construct a clojure let form with VARS as the let variables."
144 (mapconcat ;; define any variables
147 (car pair
) (org-babel-clojure-var-to-clojure (cdr pair
))))
149 (body (org-babel-trim body
)))
150 (if (> (length vars-forms
) 0)
151 (format "(let [%s]\n %s)" vars-forms body
)
154 (defun org-babel-prep-session:clojure
(session params
)
155 "Prepare SESSION according to the header arguments specified in PARAMS."
156 (require 'slime
) (require 'swank-clojure
)
157 (let* ((session-buf (org-babel-clojure-initiate-session session
))
158 (vars (org-babel-ref-variables params
))
159 (var-lines (mapcar ;; define any top level session variables
161 (format "(def %s %s)\n" (car pair
)
162 (org-babel-clojure-var-to-clojure (cdr pair
))))
166 (defun org-babel-load-session:clojure
(session body params
)
167 "Load BODY into SESSION."
168 (require 'slime
) (require 'swank-clojure
)
169 (save-window-excursion
170 (let ((buffer (org-babel-prep-session:clojure session params
)))
171 (with-current-buffer buffer
172 (goto-char (point-max))
173 (insert (org-babel-chomp body
)))
176 (defvar org-babel-clojure-buffers
'())
177 (defvar org-babel-clojure-pending-sessions
'())
179 (defun org-babel-clojure-session-buffer (session)
180 "Return the buffer associated with SESSION."
181 (cdr (assoc session org-babel-clojure-buffers
)))
183 (defun org-babel-clojure-initiate-session-by-key (&optional session
)
184 "Initiate a clojure session in an inferior-process-buffer.
185 If there is not a current inferior-process-buffer in SESSION
186 then create one. Return the initialized session."
187 (save-window-excursion
188 (let* ((session (if session
189 (if (stringp session
) (intern session
)
192 (clojure-buffer (org-babel-clojure-session-buffer session
)))
193 (unless (and clojure-buffer
(buffer-live-p clojure-buffer
))
194 (setq org-babel-clojure-buffers
195 (assq-delete-all session org-babel-clojure-buffers
))
196 (push session org-babel-clojure-pending-sessions
)
198 ;; we are waiting to finish setting up which will be done in
199 ;; org-babel-clojure-session-connected-hook below.
201 (while (and (not (org-babel-clojure-session-buffer session
))
203 (message "Waiting for clojure repl for session: %s ... %i"
207 (setq org-babel-clojure-pending-sessions
208 (remove session org-babel-clojure-pending-sessions
))
209 (unless (org-babel-clojure-session-buffer session
)
210 (error "Couldn't create slime clojure process"))
211 (setq clojure-buffer
(org-babel-clojure-session-buffer session
)))
214 (defun org-babel-clojure-initiate-session (&optional session params
)
215 "Return the slime-clojure repl buffer bound to SESSION.
216 Returns nil if \"none\" is specified."
217 (require 'slime
) (require 'swank-clojure
)
218 (unless (and (stringp session
) (string= session
"none"))
219 (org-babel-clojure-session-buffer
220 (org-babel-clojure-initiate-session-by-key session
))))
222 (defun org-babel-clojure-session-connected-hook ()
223 "Finish binding an org-babel session to a slime-clojure repl."
224 (let ((pending-session (pop org-babel-clojure-pending-sessions
)))
225 (when pending-session
227 (switch-to-buffer (slime-output-buffer))
229 (if (stringp pending-session
)
230 pending-session
(symbol-name pending-session
)))
231 (org-babel-clojure-bind-session-to-repl-buffer
232 pending-session
(slime-output-buffer))))))
234 (add-hook 'slime-connected-hook
'org-babel-clojure-session-connected-hook
)
236 (defun org-babel-clojure-bind-session-to-repl-buffer (session repl-buffer
)
237 "Associate SESSION with REPL-BUFFER."
238 (when (stringp session
) (setq session
(intern session
)))
239 (setq org-babel-clojure-buffers
240 (cons (cons session repl-buffer
)
241 (assq-delete-all session org-babel-clojure-buffers
))))
243 (defun org-babel-clojure-repl-buffer-pred ()
244 "Test whether the current buffer is an active slime-clojure
246 (and (buffer-live-p (current-buffer)) (eq major-mode
'slime-repl-mode
)))
248 (defun org-babel-clojure-bind-session-to-repl (session)
249 "Bind SESSION to a clojure repl."
250 (interactive "sEnter session name: ")
251 (let ((repl-bufs (slime-filter-buffers 'org-babel-clojure-repl-buffer-pred
)))
252 (unless repl-bufs
(error "No existing slime-clojure repl buffers exist"))
253 (let ((repl-buf (read-buffer "Choose slime-clojure repl: " repl-bufs t
)))
254 (org-babel-clojure-bind-session-to-repl-buffer session repl-buf
))))
256 (defun org-babel-clojure-evaluate-external-process
257 (buffer body
&optional result-type
)
258 "Evaluate the body in an external process."
259 (let ((cmd (format "%s -" (mapconcat #'identity
260 (org-babel-clojure-babel-clojure-cmd)
263 (output (org-babel-eval cmd body
))
264 (value (let* ((tmp-file (org-babel-temp-file "clojure-results-")))
265 (org-babel-eval cmd
(format org-babel-clojure-wrapper-method
266 body tmp-file tmp-file
))
267 (org-babel-clojure-table-or-string
268 (org-babel-eval-read-file tmp-file
)))))))
270 (defun org-babel-clojure-evaluate-session (buffer body
&optional result-type
)
271 "Evaluate the body in the context of a clojure session."
272 (require 'slime
) (require 'swank-clojure
)
275 (with-current-buffer buffer
276 (setq raw
(org-babel-clojure-slime-eval-sync body
))
277 (setq results
(reverse (mapcar #'org-babel-trim raw
)))
279 ((equal result-type
'output
)
280 (mapconcat #'identity
(reverse (cdr results
)) "\n"))
281 ((equal result-type
'value
)
282 (org-babel-clojure-table-or-string (car results
)))))))
284 (defun org-babel-clojure-evaluate (buffer body
&optional result-type
)
285 "Pass BODY to the Clojure process in BUFFER.
286 If RESULT-TYPE equals 'output then return a list of the outputs
287 of the statements in BODY, if RESULT-TYPE equals 'value then
288 return the value of the last statement in BODY as elisp."
290 (org-babel-clojure-evaluate-session buffer body result-type
)
291 (org-babel-clojure-evaluate-external-process buffer body result-type
)))
293 (defun org-babel-expand-body:clojure
(body params
&optional processed-params
)
294 "Expand BODY according to PARAMS, return the expanded body."
295 (org-babel-clojure-build-full-form
296 body
(nth 1 (or processed-params
(org-babel-process-params params
)))))
298 (defun org-babel-execute:clojure
(body params
)
299 "Execute a block of Clojure code."
300 (require 'slime
) (require 'swank-clojure
)
301 (let* ((processed-params (org-babel-process-params params
))
302 (body (org-babel-expand-body:clojure body params processed-params
))
303 (session (org-babel-clojure-initiate-session
304 (first processed-params
))))
305 (org-babel-reassemble-table
306 (org-babel-clojure-evaluate session body
(nth 3 processed-params
))
308 (nth 4 processed-params
) (cdr (assoc :colnames params
)))
310 (nth 5 processed-params
) (cdr (assoc :rownames params
))))))
312 (provide 'ob-clojure
)
314 ;; arch-tag: a43b33f2-653e-46b1-ac56-2805cf05b7d1
316 ;;; ob-clojure.el ends here