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     ))
 137
 138 (defun ob-clojure-literate-cider-do-not-find-ns (body params)
 139   "Fix the issue that `cider-current-ns' try to invoke `clojure-find-ns' to extract ns from buffer."
 140   ;; TODO: Is it possible to find ns in `body'?
 141   (when (ob-clojure-literate-any-connection-p)
 142     (setq ob-clojure-literate-original-ns (cider-current-ns))
 143     (with-current-buffer ob-clojure-literate-session
 144       (setq ob-clojure-literate-session-ns cider-buffer-ns))
 145     (setq-local cider-buffer-ns ob-clojure-literate-session-ns))
 146   (message (format "ob-clojure-literate: current CIDER ns is [%s]." cider-buffer-ns)))
 147
 148 (defun ob-clojure-literate-set-local-session (toggle?)
 149   "Set buffer local `org-babel-default-header-args:clojure' for `ob-clojure-literate-mode' `TOGGLE?'."
 150   (if toggle?
 151       (progn
 152         ;; set local default session for ob-clojure.
 153         (setq ob-clojure-literate-session (ob-clojure-literate-set-session))
 154         (unless (local-variable-if-set-p 'org-babel-default-header-args:clojure)
 155           (make-local-variable 'org-babel-default-header-args:clojure))
 156         (add-to-list 'org-babel-default-header-args:clojure
 157                      `(:session . ,ob-clojure-literate-session))
 158         )
 159     ;; remove :session from buffer local default header arguments list.
 160     (unless (local-variable-if-set-p 'org-babel-default-header-args:clojure)
 161       (make-local-variable 'org-babel-default-header-args:clojure))
 162     (setq org-babel-default-header-args:clojure
 163           (delq t
 164                 (mapcar
 165                  (lambda (cons) (if (eq (car cons) :session) t cons))
 166                  org-babel-default-header-args:clojure)))
 167     ))
 168
 169 ;;; Support `org-babel-initiate-session' / [C-c C-v z] to initialize Clojure session.
 170
 171 (defun org-babel-clojure-initiate-session (&optional session _params)
 172   "Initiate a session named SESSION according to PARAMS."
 173   (when (and session (not (string= session "none")))
 174     (save-window-excursion
 175       (unless (org-babel-comint-buffer-livep session)
 176         ;; CIDER jack-in to the Clojure project directory.
 177         (cond
 178          ((eq org-babel-clojure-backend 'cider)
 179           (require 'cider)
 180           (let ((session-buffer (save-window-excursion
 181                                   (cider-jack-in t)
 182                                   (current-buffer))))
 183             (if (org-babel-comint-buffer-livep session-buffer)
 184                 (progn (sit-for .25) session-buffer))))
 185          ((eq org-babel-clojure-backend 'slime)
 186           (error "Session evaluation with SLIME is not supported"))
 187          (t
 188           (error "Session initiate failed")))
 189         )
 190       (get-buffer session)
 191       )))
 192
 193 (defun org-babel-prep-session:clojure (session params)
 194   "Prepare SESSION according to the header arguments specified in PARAMS."
 195   (let* ((session (org-babel-clojure-initiate-session session))
 196          (var-lines (org-babel-variable-assignments:clojure params)))
 197     (when session
 198       (org-babel-comint-in-buffer session
 199         (mapc (lambda (var)
 200                 (insert var) (comint-send-input nil t)
 201                             (org-babel-comint-wait-for-output session)
 202                             (sit-for .1) (goto-char (point-max))) var-lines)))
 203     session))
 204
 205 (defun org-babel-clojure-var-to-clojure (var)
 206   "Convert src block's `VAR' to Clojure variable."
 207   ;; TODO: reference `org-babel-python-var-to-python'
 208   )
 209
 210 (defun org-babel-variable-assignments:clojure (params)
 211   "Return a list of Clojure statements assigning the block's variables in `PARAMS'."
 212   (mapcar
 213    (lambda (pair)
 214      (format "(def %s %s)"
 215              (car pair)
 216              ;; (org-babel-clojure-var-to-clojure (cdr pair))
 217              (cdr pair)))
 218    (org-babel--get-vars params)))
 219
 220
 221 (defvar ob-clojure-literate-mode-map
 222   (let ((map (make-sparse-keymap)))
 223     map)
 224   "Keymap for `ob-clojure-literate-mode'.")
 225
 226 (define-key org-babel-map (kbd "M-s") 'ob-clojure-literate-specify-session-header-argument)
 227 (define-key org-babel-map (kbd "M-j") 'ob-clojure-literate-auto-jackin)
 228 ;; (define-key org-babel-map (kbd "M-e") 'cider-eval-last-sexp)
 229 ;; (define-key org-babel-map (kbd "M-d") 'cider-doc)
 230
 231 ;;;###autoload
 232 (defun ob-clojure-literate-enable ()
 233   "Enable Org-mode buffer locally for `ob-clojure-literate'."
 234   (when (and (not (null cider-connections)) ; only enable `ob-clojure-literate-mode' when has CIDER connections.
 235              (equal major-mode 'org-mode)) ; `ob-clojure-literate-mode' only works in `org-mode'.
 236     (ob-clojure-literate-set-local-cider-connections ob-clojure-literate-mode)
 237     (ob-clojure-literate-set-local-session ob-clojure-literate-mode)
 238     (advice-add 'org-babel-execute:clojure :before #'ob-clojure-literate-cider-do-not-find-ns)
 239     (message "ob-clojure-literate minor mode enabled.")))
 240
 241 ;;;###autoload
 242 (defun ob-clojure-literate-disable ()
 243   "Disable Org-mode buffer locally for `ob-clojure-literate'."
 244   (advice-remove 'org-babel-execute:clojure #'ob-clojure-literate-cider-do-not-find-ns)
 245   (setq-local cider-buffer-ns ob-clojure-literate-original-ns)
 246   (ob-clojure-literate-set-local-cider-connections ob-clojure-literate-mode)
 247   (ob-clojure-literate-set-local-session ob-clojure-literate-mode)
 248   (message "ob-clojure-literate minor mode disabled."))
 249
 250 ;;;###autoload
 251 (if ob-clojure-literate-auto-jackin-p (ob-clojure-literate-auto-jackin))
 252
 253 ;;;###autoload
 254 (define-minor-mode ob-clojure-literate-mode
 255   "A minor mode to toggle `ob-clojure-literate'."
 256   :require 'ob-clojure-literate
 257   :init-value t
 258   :lighter " clj-lp"
 259   :group 'ob-clojure-literate
 260   :keymap ob-clojure-literate-mode-map
 261   :global nil
 262   (if ob-clojure-literate-mode
 263       (ob-clojure-literate-enable)
 264     (ob-clojure-literate-disable))
 265   )
 266
 267 \f
 268
 269 (provide 'ob-clojure-literate)
 270
 271 ;;; ob-clojure-literate.el ends here