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