emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
blob f78dd6969dfcee93b1c89c6749d70c7e2fe0cae8 7179 bytes (raw)
name: lisp/ob-clojure.el 	 # note: path name is non-authoritative(*)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
;;; ob-clojure.el --- Babel Functions for Clojure    -*- lexical-binding: t; -*-

;; Copyright (C) 2009-2016 Free Software Foundation, Inc.

;; Author: Joel Boehland, Eric Schulte, Oleh Krehel, Frederick Giasson
;;
;; Keywords: literate programming, reproducible research
;; Homepage: http://orgmode.org

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; Support for evaluating clojure code

;; Requirements:

;; - clojure (at least 1.2.0)
;; - clojure-mode
;; - either cider or SLIME

;; For Cider, see https://github.com/clojure-emacs/cider

;; For SLIME, the best way to install these components is by following
;; the directions as set out by Phil Hagelberg (Technomancy) on the
;; web page: http://technomancy.us/126

;;; Code:
(require 'cl-lib)
(require 'ob)

(declare-function cider-current-connection "ext:cider-client" (&optional type))
(declare-function cider-current-session "ext:cider-client" ())
(declare-function nrepl-dict-get "ext:nrepl-client" (dict key))
(declare-function nrepl-sync-request:eval "ext:nrepl-client"
		  (input connection session &optional ns))
(declare-function org-trim "org" (s &optional keep-lead))
(declare-function slime-eval "ext:slime" (sexp &optional package))

(defvar org-babel-tangle-lang-exts)
(add-to-list 'org-babel-tangle-lang-exts '("clojure" . "clj"))

(defvar org-babel-default-header-args:clojure '())
(defvar org-babel-header-args:clojure '((package . :any)))

(defcustom org-babel-clojure-backend
  (cond ((featurep 'cider) 'cider)
	(t 'slime))
  "Backend used to evaluate Clojure code blocks."
  :group 'org-babel
  :type '(choice
	  (const :tag "cider" cider)
	  (const :tag "SLIME" slime)))

(defun org-babel-expand-body:clojure (body params)
  "Expand BODY according to PARAMS, return the expanded body."
  (let* ((vars (org-babel--get-vars params))
	 (result-params (cdr (assq :result-params params)))
	 (print-level nil) (print-length nil)
	 (body (org-trim
		(if (null vars) (org-trim body)
		  (concat "(let ["
			  (mapconcat
			   (lambda (var)
			     (format "%S (quote %S)" (car var) (cdr var)))
			   vars "\n      ")
			  "]\n" body ")")))))
    (if (or (member "code" result-params)
	    (member "pp" result-params))
	(format "(clojure.pprint/pprint (do %s))" body)
      body)))

(defun org-babel-execute:clojure (body params)
  "Execute a block of Clojure code with Babel. 
   The underlying process performed by the code block can be output 
   using the :show-process parameter."
  (let ((expanded (org-babel-expand-body:clojure body params))
        (sbuffer "*Clojure Show Process Sub Buffer*")
	(show (assq :show-process params))
	(response (list 'dict))
        status
        result)
    (cl-case org-babel-clojure-backend
      (cider
       (require 'cider)
       (let ((result-params (cdr (assq :result-params params))))
         ;; Check if the user want show the process in an output buffer/window.
         (when show
           ;; Create a new window with the show output buffer.
           (switch-to-buffer-other-window sbuffer)

           ;; Run the Clojure code in nREPL.
           (nrepl-request:eval
            expanded 
            (lambda (resp) 
              (when (member "out" resp)
                ;; Print the output of the nREPL in the output buffer.
                (princ (nrepl-dict-get resp "out") (get-buffer sbuffer)))
              (when (member "ex" resp)
                ;; In case there is an exception, then add it to the output buffer as well.
                (princ (nrepl-dict-get resp "ex") (get-buffer sbuffer))
                (princ (nrepl-dict-get resp "root-ex") (get-buffer sbuffer)))
              (when (member "err" resp)
                ;; In case there is an error, then add it to the output buffer as well.
                (princ (nrepl-dict-get resp "err") (get-buffer sbuffer)))
              (nrepl--merge response resp)
              ;; Update the status of the nREPL output session.
              (setq status (nrepl-dict-get response "status")))
            (cider-current-connection) 
            (cider-current-session))
           
           ;; Wait until the nREPL code finished to be processed.
           (while (not (member "done" status))
             (nrepl-dict-put response "status" (remove "need-input" status))
             (accept-process-output nil 0.01)
             (redisplay))

           ;; Delete the show buffer & window when the processing is finalized.
           (mapc #'delete-window (get-buffer-window-list sbuffer nil t))
	   (kill-buffer sbuffer)

           ;; Put the output or the value in the result section of the code block.
           (setq result (concat (nrepl-dict-get response 
                                                (if (or (member "output" result-params)
                                                        (member "pp" result-params))
                                                    "out"
                                                  "value"))
                                (nrepl-dict-get response "ex")
                                (nrepl-dict-get response "root-ex")
                                (nrepl-dict-get response "err"))))
         ;; Check if user want to run code without showing the process.
         (unless show
           (setq response (let ((nrepl-sync-request-timeout 
                                 org-babel-clojure-sync-nrepl-timeout))
                            (nrepl-sync-request:eval
                             expanded (cider-current-connection) (cider-current-session))))
           (setq result
                 (concat 
                  (nrepl-dict-get response (if (or (member "output" result-params)
                                                   (member "pp" result-params))
                                               "out"
                                             "value"))
                  (nrepl-dict-get response "ex")
                  (nrepl-dict-get response "root-ex")
                  (nrepl-dict-get response "err"))))))
       (slime
        (require 'slime)
        (with-temp-buffer
          (insert expanded)
          (setq result
                (slime-eval
                 `(swank:eval-and-grab-output
                   ,(buffer-substring-no-properties (point-min) (point-max)))
                 (cdr (assq :package params)))))))
      (org-babel-result-cond (cdr (assq :result-params params))
        result
        (condition-case nil (org-babel-script-escape result)
          (error result)))))

(provide 'ob-clojure)

;;; ob-clojure.el ends here

debug log:

solving f78dd69 ...
found f78dd69 in https://list.orgmode.org/orgmode/794c93aa-e2dc-2bfb-537e-0c89d8d34cea@fgiasson.com/
found 72ea77d in https://git.savannah.gnu.org/cgit/emacs/org-mode.git
preparing index
index prepared:
100644 72ea77ddf8a0718cea100674f8c42a41645fa4d4	lisp/ob-clojure.el

applying [1/1] https://list.orgmode.org/orgmode/794c93aa-e2dc-2bfb-537e-0c89d8d34cea@fgiasson.com/
diff --git a/lisp/ob-clojure.el b/lisp/ob-clojure.el
index 72ea77d..f78dd69 100644

1:19: trailing whitespace.
  "Execute a block of Clojure code with Babel. 
1:20: trailing whitespace.
   The underlying process performed by the code block can be output 
1:61: trailing whitespace.
            expanded 
1:62: trailing whitespace.
            (lambda (resp) 
1:76: trailing whitespace.
            (cider-current-connection) 
Checking patch lisp/ob-clojure.el...
Applied patch lisp/ob-clojure.el cleanly.
warning: squelched 4 whitespace errors
warning: 9 lines add whitespace errors.

index at:
100644 f78dd6969dfcee93b1c89c6749d70c7e2fe0cae8	lisp/ob-clojure.el

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).