contrib/lisp/ob-clojure-literate.el

   1 ;;; ob-clojure-literate.el --- Clojure's Org-mode Literate Programming.
   2
   3 ;; Authors: stardiviner <numbchild@gmail.com>
   4 ;; Package-Requires: ((emacs "24.4") (org "9") (cider "0.16.0") (dash "2.12.0"))
   5 ;; Package-Version: 1.1
   6 ;; Keywords: tools
   7 ;; homepage: https://github.com/stardiviner/ob-clojure-literate
   8
   9 ;; You should have received a copy of the GNU General Public License
  10 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  11
  12 ;;; Commentary:
  13 ;;
  14 ;; Auto setup ob-clojure-literate scaffold and jack-in Clojure project.
  15 ;;
  16 ;; Usage:
  17 ;;
  18 ;; [M-x ob-clojure-literate-mode] to toggle this minor mode.
  19
  20 ;;; Code:
  21 \f
  22 (require 'ob-clojure)
  23 (require 'cider)
  24 (require 'dash)
  25
  26 (defgroup ob-clojure-literate nil
  27   "Clojure's Org-mode Literate Programming."
  28   :prefix "ob-clojure-literate-"
  29   :group 'ob-babel)
  30
  31 ;;;###autoload
  32 (defcustom ob-clojure-literate-auto-jackin-p nil
  33   "Auto jack in ob-clojure project.
  34 Don't auto jack in by default for not rude."
  35   :type 'boolean
  36   :group 'ob-clojure-literate)
  37
  38 (defcustom ob-clojure-literate-project-location (concat user-emacs-directory "Org-mode/")
  39   "The location for `ob-clojure-literate' scaffold project."
  40   :type 'string
  41   :group 'ob-clojure-literate)
  42
  43 (defvar ob-clojure-literate-session nil)
  44 (defvar ob-clojure-literate-original-ns nil)
  45 (defvar ob-clojure-literate-session-ns nil)
  46 (defvar ob-clojure-literate-cider-connections nil)
  47
  48 (defcustom ob-clojure-literate-default-session "*cider-repl ob-clojure*"
  49   "The default session name for `ob-clojure-literate'."
  50   :type 'string
  51   :group 'ob-clojure-literate)
  52
  53 (defun ob-clojure-literate-any-connection-p ()
  54   "Return t if have any CIDER connection."
  55   (and
  56    ;; handle the case `cider-jack-in' is not finished creating connection, but `ob-clojure-literate-mode' is enabled.
  57    (not (null (cider-connections)))
  58    (not (null ob-clojure-literate-session)) ; before mode enabled, it is nil.
  59    (not (string-empty-p ob-clojure-literate-session)) ; after disable, it is "".
  60    ))
  61
  62 (defun ob-clojure-literate-get-session-list ()
  63   "Return a list of available started CIDER REPL sessions list."
  64   (-map 'buffer-name cider-connections))
  65
  66 (defun ob-clojure-literate-set-session ()
  67   "Set session name for buffer local."
  68   ;; if default session is the only one in connections list.
  69   (if (and (= (length (ob-clojure-literate-get-session-list)) 1)
  70            (-contains-p (ob-clojure-literate-get-session-list) ob-clojure-literate-default-session))
  71       (setq-local ob-clojure-literate-session ob-clojure-literate-default-session)
  72     ;; if have any connections, choose one from them.
  73     (if (ob-clojure-literate-any-connection-p)
  74         (setq-local ob-clojure-literate-session
  75                     (completing-read "Choose ob-clojure-literate :session : "
  76                                      (ob-clojure-literate-get-session-list)))
  77       ;; if none, set to default session name to fix `ob-clojure-literate-mode'
  78       ;; is enabled before `cider-jack-in' generated connections.
  79       (setq-local ob-clojure-literate-session ob-clojure-literate-default-session))
  80     ))
  81
  82 ;;;###autoload
  83 (defun ob-clojure-literate-specify-session-header-argument ()
  84   "Specify ob-clojure header argument :session with value selected from a list of available sessions."
  85   (interactive)
  86   (let ((lang (nth 0 (org-babel-get-src-block-info))))
  87     (if (and (string= lang "clojure") ; only in clojure src block.
  88              (car (seq-filter ; only when :session is not specified yet.
  89                    (lambda (header-argument)
  90                      (if (eq (car header-argument) :session)
  91                          (not (null (cdr header-argument)))))
  92                    (nth 2 (org-babel-get-src-block-info)))))
  93         (org-babel-insert-header-arg
  94          "session"
  95          (format "\"%s\""
  96                  (completing-read
  97                   "Choose :session for ob-clojure-literate: "
  98                   (ob-clojure-literate-get-session-list))))
  99       (message "This function only used in `clojure' src block.")))
 100   )
 101
 102 ;;; Auto start CIDER REPL session in a complete Leiningen project environment for Org-mode Babel to jack-in.
 103 ;;;###autoload
 104 (defun ob-clojure-literate-auto-jackin ()
 105   "Auto setup ob-clojure-literate scaffold and jack-in Clojure project."
 106   (interactive)
 107   (unless (file-directory-p (expand-file-name ob-clojure-literate-project-location))
 108     (make-directory ob-clojure-literate-project-location t)
 109     (let ((default-directory ob-clojure-literate-project-location))
 110       (shell-command "lein new ob-clojure")))
 111   (unless (or
 112            (and (cider-connected-p)
 113                 (if (not (null ob-clojure-literate-session))
 114                     (seq-contains cider-connections (get-buffer ob-clojure-literate-session))))
 115            cider-connections
 116            (not (null ob-clojure-literate-session)))
 117     ;; return back to original file.
 118     (if (not (and (= (length (ob-clojure-literate-get-session-list)) 1)
 119                   (-contains-p (ob-clojure-literate-get-session-list) ob-clojure-literate-default-session)))
 120         (save-window-excursion
 121           (find-file (expand-file-name (concat ob-clojure-literate-project-location "ob-clojure/src/ob_clojure/core.clj")))
 122           (with-current-buffer "core.clj"
 123             (cider-jack-in))))))
 124
 125 (defun ob-clojure-literate-set-local-cider-connections (toggle?)
 126   "Set buffer local `cider-connections' for `ob-clojure-literate-mode' `TOGGLE?'."
 127   (if toggle?
 128       (progn
 129         (setq ob-clojure-literate-cider-connections cider-connections)
 130         (unless (local-variable-if-set-p 'cider-connections)
 131           (make-local-variable 'cider-connections))
 132         (setq-local cider-connections ob-clojure-literate-cider-connections))
 133     ;; store/restore emptied CIDER connections by `ob-clojure-literate-enable'.
 134     (kill-local-variable 'cider-connections) ; kill local variable so that I can get the original global variable value.
 135     ;; Empty all CIDER connections to avoid `cider-current-connection' return any connection.
 136     ;; FIXME: when try to enable, `cider-connections' is local and nil.
 137     ;; (if (and (= (length (ob-clojure-literate-get-session-list)) 1)
 138     ;;          (-contains-p (ob-clojure-literate-get-session-list) ob-clojure-literate-default-session)))
 139     ;; (unless (local-variable-if-set-p 'cider-connections)
 140     ;;   (make-local-variable 'cider-connections))
 141     ;; (setq-local cider-connections '())
 142     ))
 143
 144 (defun ob-clojure-literate-cider-do-not-find-ns (body params)
 145   "Fix the issue that `cider-current-ns' try to invoke `clojure-find-ns' to extract ns from buffer."
 146   ;; TODO: Is it possible to find ns in `body'?
 147   (when (ob-clojure-literate-any-connection-p)
 148     (setq ob-clojure-literate-original-ns (cider-current-ns))
 149     (with-current-buffer ob-clojure-literate-session
 150       (setq ob-clojure-literate-session-ns cider-buffer-ns))
 151     (setq-local cider-buffer-ns ob-clojure-literate-session-ns))
 152   (message (format "ob-clojure-literate: current CIDER ns is [%s]." cider-buffer-ns)))
 153
 154 (defun ob-clojure-literate-set-local-session (toggle?)
 155   "Set buffer local `org-babel-default-header-args:clojure' for `ob-clojure-literate-mode' `TOGGLE?'."
 156   (if toggle?
 157       (progn
 158         ;; set local default session for ob-clojure.
 159         (setq ob-clojure-literate-session (ob-clojure-literate-set-session))
 160         (unless (local-variable-if-set-p 'org-babel-default-header-args:clojure)
 161           (make-local-variable 'org-babel-default-header-args:clojure))
 162         (add-to-list 'org-babel-default-header-args:clojure
 163                      `(:session . ,ob-clojure-literate-session))
 164         )
 165     ;; remove :session from buffer local default header arguments list.
 166     (unless (local-variable-if-set-p 'org-babel-default-header-args:clojure)
 167       (make-local-variable 'org-babel-default-header-args:clojure))
 168     (setq org-babel-default-header-args:clojure
 169           (delq t
 170                 (mapcar
 171                  (lambda (cons) (if (eq (car cons) :session) t cons))
 172                  org-babel-default-header-args:clojure)))
 173     ))
 174
 175 ;;; Support `org-babel-initiate-session' / [C-c C-v z] to initialize Clojure session.
 176
 177 (defun org-babel-clojure-initiate-session (&optional session _params)
 178   "Initiate a session named SESSION according to PARAMS."
 179   (when (and session (not (string= session "none")))
 180     (save-window-excursion
 181       (unless (org-babel-comint-buffer-livep session)
 182         ;; CIDER jack-in to the Clojure project directory.
 183         (cond
 184          ((eq org-babel-clojure-backend 'cider)
 185           (require 'cider)
 186           (let ((session-buffer (save-window-excursion
 187                                   (cider-jack-in t)
 188                                   (current-buffer))))
 189             (if (org-babel-comint-buffer-livep session-buffer)
 190                 (progn (sit-for .25) session-buffer))))
 191          ((eq org-babel-clojure-backend 'slime)
 192           (error "Session evaluation with SLIME is not supported"))
 193          (t
 194           (error "Session initiate failed")))
 195         )
 196       (get-buffer session)
 197       )))
 198
 199 (defun org-babel-prep-session:clojure (session params)
 200   "Prepare SESSION according to the header arguments specified in PARAMS."
 201   (let* ((session (org-babel-clojure-initiate-session session))
 202          (var-lines (org-babel-variable-assignments:clojure params)))
 203     (when session
 204       (org-babel-comint-in-buffer session
 205         (mapc (lambda (var)
 206                 (insert var) (comint-send-input nil t)
 207                 (org-babel-comint-wait-for-output session)
 208                 (sit-for .1) (goto-char (point-max))) var-lines)))
 209     session))
 210
 211 (defun org-babel-clojure-var-to-clojure (var)
 212   "Convert src block's `VAR' to Clojure variable."
 213   ;; TODO: reference `org-babel-python-var-to-python'
 214   )
 215
 216 (defun org-babel-variable-assignments:clojure (params)
 217   "Return a list of Clojure statements assigning the block's variables in `PARAMS'."
 218   (mapcar
 219    (lambda (pair)
 220      (format "(def %s %s)"
 221              (car pair)
 222              ;; (org-babel-clojure-var-to-clojure (cdr pair))
 223              (cdr pair)))
 224    (org-babel--get-vars params)))
 225
 226 ;;; Support header arguments  :results graphics :file "image.png" by inject Clojure code.
 227 (defun ob-clojure-literate-inject-code (args)
 228   "Inject Clojure code into `BODY' in `ARGS'.
 229 It is used to change Clojure currently working directory in a FAKE way.
 230 And generate inline graphics image file link result.
 231 Use header argument like this:
 232
 233 :results graphics :file \"incanter-plot.png\"
 234
 235 Then you need to assign image variable to this :file value like:
 236 (def incanter-plot (histogram (sample-normal 1000)))
 237
 238 *NOTE*: Currently only support Incanter's `save' function.
 239 "
 240   (let* ((body (nth 0 args))
 241          (params (nth 1 args))
 242          (dir (cdr (assq :dir params)))
 243          (default-directory (and (buffer-file-name) (file-name-directory (buffer-file-name))))
 244          (directory (and dir (file-name-as-directory (expand-file-name dir))))
 245          (result-type (cdr (assq :results params)))
 246          (file (cdr (assq :file params)))
 247          (file-name (file-name-base file))
 248          ;; TODO: future support `:graphics-file' to avoid collision.
 249          (graphics-result (member "graphics" (cdr (assq :result-params params))))
 250          ;; (graphics-file (cdr (assq :graphics-file params)))
 251          ;; (graphics-name (file-name-base graphics-file))
 252          (prepend-to-body (lambda (code)
 253                             (setq body (concat code "\n" body))))
 254          (append-to-body (lambda (code)
 255                            (setq body (concat body "\n" code "\n"))))
 256          )
 257     (when directory
 258       (unless (file-directory-p (expand-file-name directory))
 259         (warn (format "Target directory %s does not exist, please create it." dir))))
 260     (when file
 261       (funcall append-to-body
 262                (format "(save %s \"%s\")" file-name (concat directory file)))
 263       )
 264     (list body params) ; return modified argument list
 265     ))
 266
 267 ;;; support :results graphics :dir "data/image" :file "incanter-plot.png"
 268 (defun ob-clojure-literate-support-graphics-result (result)
 269   "Support :results graphics :dir \"data/images\" :file \"incanter-plot.png\"
 270 reset `RESULT' to `nil'."
 271   (let* ((params (nth 2 info))
 272          (graphics-result (member "graphics" (cdr (assq :result-params params)))))
 273     (if graphics-result
 274         (setq result nil))
 275     result))
 276
 277
 278 (defvar ob-clojure-literate-mode-map
 279   (let ((map (make-sparse-keymap)))
 280     map)
 281   "Keymap for `ob-clojure-literate-mode'.")
 282
 283 (define-key org-babel-map (kbd "M-s") 'ob-clojure-literate-specify-session-header-argument)
 284 (define-key org-babel-map (kbd "M-j") 'ob-clojure-literate-auto-jackin)
 285 ;; (define-key org-babel-map (kbd "M-e") 'cider-eval-last-sexp)
 286 ;; (define-key org-babel-map (kbd "M-d") 'cider-doc)
 287
 288 ;;;###autoload
 289 (defun ob-clojure-literate-enable ()
 290   "Enable Org-mode buffer locally for `ob-clojure-literate'."
 291   (when (and (not (null cider-connections)) ; only enable `ob-clojure-literate-mode' when has CIDER connections.
 292              (equal major-mode 'org-mode)) ; `ob-clojure-literate-mode' only works in `org-mode'.
 293     (ob-clojure-literate-set-local-cider-connections ob-clojure-literate-mode)
 294     (ob-clojure-literate-set-local-session ob-clojure-literate-mode)
 295     (advice-add 'org-babel-execute:clojure :before #'ob-clojure-literate-cider-do-not-find-ns)
 296     (advice-add 'org-babel-expand-body:clojure :filter-args #'ob-clojure-literate-inject-code)
 297     (advice-add 'org-babel-execute:clojure :filter-return #'ob-clojure-literate-support-graphics-result)
 298     (message "ob-clojure-literate minor mode enabled.")))
 299
 300 ;;;###autoload
 301 (defun ob-clojure-literate-disable ()
 302   "Disable Org-mode buffer locally for `ob-clojure-literate'."
 303   (advice-remove 'org-babel-execute:clojure #'ob-clojure-literate-cider-do-not-find-ns)
 304   (advice-remove 'org-babel-expand-body:clojure #'ob-clojure-literate-inject-code)
 305   (advice-remove 'org-babel-execute:clojure #'ob-clojure-literate-support-graphics-result)
 306   (setq-local cider-buffer-ns ob-clojure-literate-original-ns)
 307   (ob-clojure-literate-set-local-cider-connections ob-clojure-literate-mode)
 308   (ob-clojure-literate-set-local-session ob-clojure-literate-mode)
 309   (message "ob-clojure-literate minor mode disabled."))
 310
 311 ;;;###autoload
 312 (if ob-clojure-literate-auto-jackin-p (ob-clojure-literate-auto-jackin))
 313
 314 ;;;###autoload
 315 (define-minor-mode ob-clojure-literate-mode
 316   "A minor mode to toggle `ob-clojure-literate'."
 317   :require 'ob-clojure-literate
 318   :init-value t
 319   :lighter " clj-lp"
 320   :group 'ob-clojure-literate
 321   :keymap ob-clojure-literate-mode-map
 322   :global nil
 323   (if ob-clojure-literate-mode
 324       (ob-clojure-literate-enable)
 325     (ob-clojure-literate-disable))
 326   )
 327
 328 \f
 329
 330 (provide 'ob-clojure-literate)
 331
 332 ;;; ob-clojure-literate.el ends here