Você não pode selecionar mais de 25 tópicos
Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
868 linhas
39 KiB
868 linhas
39 KiB
;;; cider-connection.el --- Connection and session life-cycle management for CIDER -*- lexical-binding: t -*-
|
|
;;
|
|
;; Copyright © 2019 Artur Malabarba, Bozhidar Batsov, Vitalie Spinu and CIDER contributors
|
|
;;
|
|
;; Author: Artur Malabarba <bruce.connor.am@gmail.com>
|
|
;; Bozhidar Batsov <bozhidar@batsov.com>
|
|
;; Vitalie Spinu <spinuvit@gmail.com>
|
|
;;
|
|
;; Keywords: languages, clojure, cider
|
|
;;
|
|
;; This program 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.
|
|
;;
|
|
;; This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
|
|
;;
|
|
;; This file is not part of GNU Emacs.
|
|
;;
|
|
;;
|
|
;;; Commentary:
|
|
;;
|
|
;;
|
|
;;; Code:
|
|
|
|
(require 'nrepl-client)
|
|
(require 'cl-lib)
|
|
(require 'format-spec)
|
|
(require 'sesman)
|
|
(require 'sesman-browser)
|
|
|
|
(defcustom cider-session-name-template "%J:%h:%p"
|
|
"Format string to use for session names.
|
|
See `cider-format-connection-params' for available format characters."
|
|
:type 'string
|
|
:group 'cider
|
|
:package-version '(cider . "0.18.0"))
|
|
|
|
(defcustom cider-connection-message-fn #'cider-random-words-of-inspiration
|
|
"The function to use to generate the message displayed on connect.
|
|
When set to nil no additional message will be displayed. A good
|
|
alternative to the default is `cider-random-tip'."
|
|
:type 'function
|
|
:group 'cider
|
|
:package-version '(cider . "0.11.0"))
|
|
|
|
(defcustom cider-redirect-server-output-to-repl t
|
|
"Controls whether nREPL server output would be redirected to the REPL.
|
|
When non-nil the output would end up in both the nrepl-server buffer (when
|
|
available) and the matching REPL buffer."
|
|
:type 'boolean
|
|
:group 'cider
|
|
:safe #'booleanp
|
|
:package-version '(cider . "0.17.0"))
|
|
|
|
(defcustom cider-auto-mode t
|
|
"When non-nil, automatically enable cider mode for all Clojure buffers."
|
|
:type 'boolean
|
|
:group 'cider
|
|
:safe #'booleanp
|
|
:package-version '(cider . "0.9.0"))
|
|
|
|
(defconst cider-required-nrepl-version "0.4.4"
|
|
"The minimum nREPL version that's known to work properly with CIDER.")
|
|
|
|
|
|
;;; Connect
|
|
|
|
(defun cider-nrepl-connect (params)
|
|
"Start nrepl client and create the REPL.
|
|
PARAMS is a plist containing :host, :port, :server and other parameters for
|
|
`cider-repl-create'."
|
|
(process-buffer
|
|
(nrepl-start-client-process
|
|
(plist-get params :host)
|
|
(plist-get params :port)
|
|
(plist-get params :server)
|
|
(lambda (_)
|
|
(cider-repl-create params)))))
|
|
|
|
(defun cider-connected-p ()
|
|
"Return t if CIDER is currently connected, nil otherwise."
|
|
(process-live-p (get-buffer-process (cider-current-repl))))
|
|
|
|
(defun cider-ensure-connected ()
|
|
"Ensure there is a linked CIDER session."
|
|
(sesman-ensure-session 'CIDER))
|
|
|
|
(defun cider--session-server (session)
|
|
"Return server buffer for SESSION or nil if there is no server."
|
|
(seq-some (lambda (r)
|
|
(buffer-local-value 'nrepl-server-buffer r))
|
|
(cdr session)))
|
|
|
|
(defun cider--gather-session-params (session)
|
|
"Gather all params for a SESSION."
|
|
(let (params)
|
|
(dolist (repl (cdr session))
|
|
(setq params (cider--gather-connect-params params repl)))
|
|
(when-let* ((server (cider--session-server session)))
|
|
(setq params (cider--gather-connect-params params server)))
|
|
params))
|
|
|
|
(defun cider--gather-connect-params (&optional params proc-buffer)
|
|
"Gather all relevant connection parameters into PARAMS plist.
|
|
PROC-BUFFER is either server or client buffer, defaults to current buffer."
|
|
(let ((proc-buffer (or proc-buffer (current-buffer))))
|
|
(with-current-buffer proc-buffer
|
|
(unless nrepl-endpoint
|
|
(error "This is not a REPL or SERVER buffer; is there an active REPL?"))
|
|
(let ((server-buf (if (nrepl-server-p proc-buffer)
|
|
proc-buffer
|
|
nrepl-server-buffer)))
|
|
(cl-loop for l on nrepl-endpoint by #'cddr
|
|
do (setq params (plist-put params (car l) (cadr l))))
|
|
(setq params (thread-first params
|
|
(plist-put :project-dir nrepl-project-dir)))
|
|
(when (buffer-live-p server-buf)
|
|
(setq params (thread-first params
|
|
(plist-put :server (get-buffer-process server-buf))
|
|
(plist-put :server-command nrepl-server-command))))
|
|
;; repl-specific parameters (do not pollute server params!)
|
|
(unless (nrepl-server-p proc-buffer)
|
|
(setq params (thread-first params
|
|
(plist-put :session-name cider-session-name)
|
|
(plist-put :repl-type cider-repl-type)
|
|
(plist-put :cljs-repl-type cider-cljs-repl-type)
|
|
(plist-put :repl-init-function cider-repl-init-function))))
|
|
params))))
|
|
|
|
(defun cider--close-buffer (buffer)
|
|
"Close the BUFFER and kill its associated process (if any)."
|
|
(when (buffer-live-p buffer)
|
|
(when-let* ((proc (get-buffer-process buffer)))
|
|
(when (process-live-p proc)
|
|
(delete-process proc)))
|
|
(kill-buffer buffer)))
|
|
|
|
(declare-function cider-repl-emit-interactive-stderr "cider-repl")
|
|
(defun cider--close-connection (repl &optional no-kill)
|
|
"Close connection associated with REPL.
|
|
When NO-KILL is non-nil stop the connection but don't kill the REPL
|
|
buffer."
|
|
(when (buffer-live-p repl)
|
|
(with-current-buffer repl
|
|
(when spinner-current (spinner-stop))
|
|
(when nrepl-tunnel-buffer
|
|
(cider--close-buffer nrepl-tunnel-buffer))
|
|
(when no-kill
|
|
;; inform sentinel not to kill the server, if any
|
|
(thread-first (get-buffer-process repl)
|
|
(process-plist)
|
|
(plist-put :keep-server t))))
|
|
(let ((proc (get-buffer-process repl)))
|
|
(when (and (process-live-p proc)
|
|
(or (not nrepl-server-buffer)
|
|
;; Sync request will hang if the server is dead.
|
|
(process-live-p (get-buffer-process nrepl-server-buffer))))
|
|
(nrepl-sync-request:close repl)
|
|
(delete-process proc)))
|
|
(when-let* ((messages-buffer (and nrepl-log-messages
|
|
(nrepl-messages-buffer repl))))
|
|
(kill-buffer messages-buffer))
|
|
(unless no-kill
|
|
(kill-buffer repl)))
|
|
(when repl
|
|
(sesman-remove-object 'CIDER nil repl (not no-kill) t)))
|
|
|
|
(defun cider-emit-manual-warning (section-id format &rest args)
|
|
"Emit a warning to the REPL and link to the online manual.
|
|
SECTION-ID is the section to link to. The link is added on the last line.
|
|
FORMAT is a format string to compile with ARGS and display on the REPL."
|
|
(let ((message (apply #'format format args)))
|
|
(cider-repl-emit-interactive-stderr
|
|
(concat "WARNING: " message "\n "
|
|
(cider--manual-button "More information" section-id)
|
|
"."))))
|
|
|
|
(defvar cider-version)
|
|
(defun cider--check-required-nrepl-version ()
|
|
"Check whether we're using a compatible nREPL version."
|
|
(if-let* ((nrepl-version (cider--nrepl-version)))
|
|
(when (version< nrepl-version cider-required-nrepl-version)
|
|
(cider-emit-manual-warning "troubleshooting/#warning-saying-you-have-to-use-nrepl-0212"
|
|
"CIDER requires nREPL %s (or newer) to work properly"
|
|
cider-required-nrepl-version))
|
|
(cider-emit-manual-warning "troubleshooting/#warning-saying-you-have-to-use-nrepl-0212"
|
|
"Can't determine nREPL's version.\nPlease, update nREPL to %s."
|
|
cider-required-nrepl-version)))
|
|
|
|
(defvar cider-minimum-clojure-version)
|
|
(defun cider--check-clojure-version-supported ()
|
|
"Ensure that we are meeting the minimum supported version of Clojure."
|
|
(if-let* ((clojure-version (cider--clojure-version)))
|
|
(when (version< clojure-version cider-minimum-clojure-version)
|
|
(cider-emit-manual-warning "installation/#prerequisites"
|
|
"Clojure version (%s) is not supported (minimum %s). CIDER will not work."
|
|
clojure-version cider-minimum-clojure-version))
|
|
(cider-emit-manual-warning "installation/#prerequisites"
|
|
"Can't determine Clojure's version. CIDER requires Clojure %s (or newer)."
|
|
cider-minimum-clojure-version)))
|
|
|
|
(defvar cider-required-middleware-version)
|
|
(defun cider--check-middleware-compatibility ()
|
|
"CIDER frontend/backend compatibility check.
|
|
Retrieve the underlying connection's CIDER-nREPL version and checks if the
|
|
middleware used is compatible with CIDER. If not, will display a warning
|
|
message in the REPL area."
|
|
(let* ((version-dict (nrepl-aux-info "cider-version" (cider-current-repl)))
|
|
(middleware-version (nrepl-dict-get version-dict "version-string")))
|
|
(cond
|
|
((null middleware-version)
|
|
(cider-emit-manual-warning "troubleshooting/#cider-complains-of-the-cider-nrepl-version"
|
|
"CIDER requires cider-nrepl to be fully functional. Some features will not be available without it!"))
|
|
((not (string= middleware-version cider-required-middleware-version))
|
|
(cider-emit-manual-warning "troubleshooting/#cider-complains-of-the-cider-nrepl-version"
|
|
"CIDER %s requires cider-nrepl %s, but you're currently using cider-nrepl %s. The version mismatch might break some functionality!"
|
|
cider-version cider-required-middleware-version middleware-version)))))
|
|
|
|
(declare-function cider-interactive-eval-handler "cider-eval")
|
|
;; TODO: Use some null handler here
|
|
(defun cider--subscribe-repl-to-server-out ()
|
|
"Subscribe to the nREPL server's *out*."
|
|
(cider-nrepl-send-request '("op" "out-subscribe")
|
|
(cider-interactive-eval-handler (current-buffer))))
|
|
|
|
(declare-function cider-mode "cider-mode")
|
|
(defun cider-enable-on-existing-clojure-buffers ()
|
|
"Enable CIDER's minor mode on existing Clojure buffers.
|
|
See command `cider-mode'."
|
|
(interactive)
|
|
(add-hook 'clojure-mode-hook #'cider-mode)
|
|
(dolist (buffer (cider-util--clojure-buffers))
|
|
(with-current-buffer buffer
|
|
(cider-mode +1))))
|
|
|
|
(defun cider-disable-on-existing-clojure-buffers ()
|
|
"Disable command `cider-mode' on existing Clojure buffers."
|
|
(interactive)
|
|
(dolist (buffer (cider-util--clojure-buffers))
|
|
(with-current-buffer buffer
|
|
(cider-mode -1))))
|
|
|
|
(defun cider-possibly-disable-on-existing-clojure-buffers ()
|
|
"If not connected, disable command `cider-mode' on existing Clojure buffers."
|
|
(unless (cider-connected-p)
|
|
(cider-disable-on-existing-clojure-buffers)))
|
|
|
|
(declare-function cider--debug-init-connection "cider-debug")
|
|
(declare-function cider-repl-init "cider-repl")
|
|
(defun cider--connected-handler ()
|
|
"Handle CIDER initialization after nREPL connection has been established.
|
|
This function is appended to `nrepl-connected-hook' in the client process
|
|
buffer."
|
|
;; `nrepl-connected-hook' is run in the connection buffer
|
|
;; `cider-enlighten-mode' changes eval to include the debugger, so we inhibit
|
|
;; it here as the debugger isn't necessarily initialized yet
|
|
(let ((cider-enlighten-mode nil))
|
|
;; after initialization, set mode-line and buffer name.
|
|
(cider-set-repl-type cider-repl-type)
|
|
(cider-repl-init
|
|
(current-buffer)
|
|
(lambda ()
|
|
(cider--check-required-nrepl-version)
|
|
(cider--check-clojure-version-supported)
|
|
(cider--check-middleware-compatibility)
|
|
(when cider-redirect-server-output-to-repl
|
|
(cider--subscribe-repl-to-server-out))
|
|
(when cider-auto-mode
|
|
(cider-enable-on-existing-clojure-buffers))
|
|
;; Middleware on cider-nrepl's side is deferred until first usage, but
|
|
;; loading middleware concurrently can lead to occasional "require" issues
|
|
;; (likely a Clojure bug). Thus, we load the heavy debug middleware towards
|
|
;; the end, allowing for the faster "server-out" middleware to load
|
|
;; first.
|
|
(cider--debug-init-connection)
|
|
(when cider-repl-init-function
|
|
(funcall cider-repl-init-function))
|
|
(run-hooks 'cider-connected-hook)))))
|
|
|
|
(defun cider--disconnected-handler ()
|
|
"Cleanup after nREPL connection has been lost or closed.
|
|
This function is appended to `nrepl-disconnected-hook' in the client
|
|
process buffer."
|
|
;; `nrepl-connected-hook' is run in the connection buffer
|
|
(cider-possibly-disable-on-existing-clojure-buffers)
|
|
(run-hooks 'cider-disconnected-hook))
|
|
|
|
|
|
;;; Connection Info
|
|
|
|
(defun cider--java-version ()
|
|
"Retrieve the underlying connection's Java version."
|
|
(with-current-buffer (cider-current-repl)
|
|
(when nrepl-versions
|
|
(thread-first nrepl-versions
|
|
(nrepl-dict-get "java")
|
|
(nrepl-dict-get "version-string")))))
|
|
|
|
(defun cider--clojure-version ()
|
|
"Retrieve the underlying connection's Clojure version."
|
|
(with-current-buffer (cider-current-repl)
|
|
(when nrepl-versions
|
|
(thread-first nrepl-versions
|
|
(nrepl-dict-get "clojure")
|
|
(nrepl-dict-get "version-string")))))
|
|
|
|
(defun cider--nrepl-version ()
|
|
"Retrieve the underlying connection's nREPL version."
|
|
(with-current-buffer (cider-current-repl)
|
|
(when nrepl-versions
|
|
(thread-first nrepl-versions
|
|
(nrepl-dict-get "nrepl")
|
|
(nrepl-dict-get "version-string")))))
|
|
|
|
(defun cider--connection-info (connection-buffer &optional genericp)
|
|
"Return info about CONNECTION-BUFFER.
|
|
Info contains project name, current REPL namespace, host:port endpoint and
|
|
Clojure version. When GENERICP is non-nil, don't provide specific info
|
|
about this buffer (like variable `cider-repl-type')."
|
|
(with-current-buffer connection-buffer
|
|
(format "%s%s@%s:%s (Java %s, Clojure %s, nREPL %s)"
|
|
(if genericp "" (upcase (concat (symbol-name cider-repl-type) " ")))
|
|
(or (cider--project-name nrepl-project-dir) "<no project>")
|
|
(plist-get nrepl-endpoint :host)
|
|
(plist-get nrepl-endpoint :port)
|
|
(cider--java-version)
|
|
(cider--clojure-version)
|
|
(cider--nrepl-version))))
|
|
|
|
|
|
;;; Cider's Connection Management UI
|
|
|
|
(defun cider-quit (&optional repl)
|
|
"Quit the CIDER connection associated with REPL.
|
|
REPL defaults to the current REPL."
|
|
(interactive)
|
|
(let ((repl (or repl
|
|
(sesman-browser-get 'object)
|
|
(cider-current-repl nil 'ensure))))
|
|
(cider--close-connection repl))
|
|
;; if there are no more connections we can kill all ancillary buffers
|
|
(unless (cider-connected-p)
|
|
(cider-close-ancillary-buffers))
|
|
;; need this to refresh sesman browser
|
|
(run-hooks 'sesman-post-command-hook))
|
|
|
|
(defun cider-restart (&optional repl)
|
|
"Restart CIDER connection associated with REPL.
|
|
REPL defaults to the current REPL. Don't restart the server or other
|
|
connections within the same session. Use `sesman-restart' to restart the
|
|
entire session."
|
|
(interactive)
|
|
(let* ((repl (or repl
|
|
(sesman-browser-get 'object)
|
|
(cider-current-repl nil 'ensure)))
|
|
(params (thread-first ()
|
|
(cider--gather-connect-params repl)
|
|
(plist-put :session-name (sesman-session-name-for-object 'CIDER repl))
|
|
(plist-put :repl-buffer repl))))
|
|
(cider--close-connection repl 'no-kill)
|
|
(cider-nrepl-connect params)
|
|
;; need this to refresh sesman browser
|
|
(run-hooks 'sesman-post-command-hook)))
|
|
|
|
(defun cider-close-ancillary-buffers ()
|
|
"Close buffers that are shared across connections."
|
|
(interactive)
|
|
(dolist (buf-name cider-ancillary-buffers)
|
|
(when (get-buffer buf-name)
|
|
(kill-buffer buf-name))))
|
|
|
|
(defun cider-describe-connection (&optional repl)
|
|
"Display information about the connection associated with REPL.
|
|
REPL defaults to the current REPL."
|
|
(interactive)
|
|
(let ((repl (or repl
|
|
(sesman-browser-get 'object)
|
|
(cider-current-repl nil 'ensure))))
|
|
(message "%s" (cider--connection-info repl))))
|
|
(define-obsolete-function-alias 'cider-display-connection-info 'cider-describe-connection "0.18.0")
|
|
|
|
(defconst cider-nrepl-session-buffer "*cider-nrepl-session*")
|
|
|
|
(defun cider-describe-nrepl-session ()
|
|
"Describe an nREPL session."
|
|
(interactive)
|
|
(cider-ensure-connected)
|
|
(let* ((repl (cider-current-repl nil 'ensure))
|
|
(selected-session (completing-read "Describe nREPL session: " (nrepl-sessions repl))))
|
|
(when (and selected-session (not (equal selected-session "")))
|
|
(let* ((session-info (nrepl-sync-request:describe repl))
|
|
(ops (nrepl-dict-keys (nrepl-dict-get session-info "ops")))
|
|
(session-id (nrepl-dict-get session-info "session"))
|
|
(session-type (cond
|
|
((equal session-id (cider-nrepl-eval-session)) "Active eval")
|
|
((equal session-id (cider-nrepl-tooling-session)) "Active tooling")
|
|
(t "Unknown"))))
|
|
(with-current-buffer (cider-popup-buffer cider-nrepl-session-buffer 'select nil 'ancillary)
|
|
(read-only-mode -1)
|
|
(insert (format "Session: %s\n" session-id)
|
|
(format "Type: %s session\n" session-type)
|
|
(format "Supported ops:\n"))
|
|
(mapc (lambda (op) (insert (format " * %s\n" op))) ops)))
|
|
(display-buffer cider-nrepl-session-buffer))))
|
|
|
|
|
|
;;; Sesman's Session-Wise Management UI
|
|
|
|
(cl-defmethod sesman-project ((_system (eql CIDER)))
|
|
(clojure-project-dir (cider-current-dir)))
|
|
|
|
(cl-defmethod sesman-more-relevant-p ((_system (eql CIDER)) session1 session2)
|
|
(sesman-more-recent-p (cdr session1) (cdr session2)))
|
|
|
|
(cl-defmethod sesman-friendly-session-p ((_system (eql CIDER)) session)
|
|
(setcdr session (seq-filter #'buffer-live-p (cdr session)))
|
|
(when-let* ((repl (cadr session))
|
|
(proc (get-buffer-process repl))
|
|
(file (file-truename (or (buffer-file-name) default-directory))))
|
|
;; With avfs paths look like /path/to/.avfs/path/to/some.jar#uzip/path/to/file.clj
|
|
(when (string-match-p "#uzip" file)
|
|
(let ((avfs-path (directory-file-name (expand-file-name (or (getenv "AVFSBASE") "~/.avfs/")))))
|
|
(setq file (replace-regexp-in-string avfs-path "" file t t))))
|
|
(when (process-live-p proc)
|
|
(let* ((classpath (or (process-get proc :cached-classpath)
|
|
(let ((cp (with-current-buffer repl
|
|
(cider-classpath-entries))))
|
|
(process-put proc :cached-classpath cp)
|
|
cp)))
|
|
(classpath-roots (or (process-get proc :cached-classpath-roots)
|
|
(let ((cp (thread-last classpath
|
|
(seq-filter (lambda (path) (not (string-match-p "\\.jar$" path))))
|
|
(mapcar #'file-name-directory))))
|
|
(process-put proc :cached-classpath-roots cp)
|
|
cp))))
|
|
(or (seq-find (lambda (path) (string-prefix-p path file))
|
|
classpath)
|
|
(seq-find (lambda (path) (string-prefix-p path file))
|
|
classpath-roots))))))
|
|
|
|
(defvar cider-sesman-browser-map
|
|
(let ((map (make-sparse-keymap)))
|
|
(define-key map (kbd "j q") #'cider-quit)
|
|
(define-key map (kbd "j k") #'cider-quit)
|
|
(define-key map (kbd "j r") #'cider-restart)
|
|
(define-key map (kbd "j d") #'cider-describe-connection)
|
|
(define-key map (kbd "j i") #'cider-describe-connection)
|
|
(define-key map (kbd "C-c C-q") #'cider-quit)
|
|
(define-key map (kbd "C-c C-q") #'cider-quit)
|
|
(define-key map (kbd "C-c C-r") #'cider-restart)
|
|
(define-key map (kbd "C-c M-r") #'cider-restart)
|
|
(define-key map (kbd "C-c C-d") #'cider-describe-connection)
|
|
(define-key map (kbd "C-c M-d") #'cider-describe-connection)
|
|
(define-key map (kbd "C-c C-i") #'cider-describe-connection)
|
|
map)
|
|
"Map active on REPL objects in sesman browser.")
|
|
|
|
(cl-defmethod sesman-session-info ((_system (eql CIDER)) session)
|
|
(interactive "P")
|
|
(list :objects (cdr session)
|
|
:map cider-sesman-browser-map))
|
|
|
|
(declare-function cider "cider")
|
|
(cl-defmethod sesman-start-session ((_system (eql CIDER)))
|
|
"Start a connection of any type interactively.
|
|
Fallback on `cider' command."
|
|
(call-interactively #'cider))
|
|
|
|
(cl-defmethod sesman-quit-session ((_system (eql CIDER)) session)
|
|
(mapc #'cider--close-connection (cdr session))
|
|
;; if there are no more connections we can kill all ancillary buffers
|
|
(unless (cider-connected-p)
|
|
(cider-close-ancillary-buffers)))
|
|
|
|
(cl-defmethod sesman-restart-session ((_system (eql CIDER)) session)
|
|
(let* ((ses-name (car session))
|
|
(repls (cdr session))
|
|
(srv-buf (cider--session-server session)))
|
|
(if srv-buf
|
|
;; session with a server
|
|
(let ((s-params (cider--gather-connect-params nil srv-buf)))
|
|
;; 1) kill all connections, but keep the buffers
|
|
(mapc (lambda (conn)
|
|
(cider--close-connection conn 'no-kill))
|
|
repls)
|
|
;; 2) kill the server
|
|
(nrepl-kill-server-buffer srv-buf)
|
|
;; 3) start server
|
|
(nrepl-start-server-process
|
|
(plist-get s-params :project-dir)
|
|
(plist-get s-params :server-command)
|
|
(lambda (server-buf)
|
|
;; 4) restart the repls reusing the buffer
|
|
(dolist (r repls)
|
|
(cider-nrepl-connect
|
|
(thread-first ()
|
|
(cider--gather-connect-params r)
|
|
;; server params (:port, :project-dir etc) have precedence
|
|
(cider--gather-connect-params server-buf)
|
|
(plist-put :session-name ses-name)
|
|
(plist-put :repl-buffer r))))
|
|
(sesman-browser-revert-all 'CIDER)
|
|
(message "Restarted CIDER %s session" ses-name))))
|
|
;; server-less session
|
|
(dolist (r repls)
|
|
(cider--close-connection r 'no-kill)
|
|
(cider-nrepl-connect
|
|
(thread-first ()
|
|
(cider--gather-connect-params r)
|
|
(plist-put :session-name ses-name)
|
|
(plist-put :repl-buffer r)))))))
|
|
|
|
(defun cider-format-connection-params (template params)
|
|
"Format PARAMS with TEMPLATE string.
|
|
The following formats can be used in TEMPLATE string:
|
|
|
|
%h - host
|
|
%H - remote host, empty for local hosts
|
|
%p - port
|
|
%j - short project name, or directory name if no project
|
|
%J - long project name including parent dir name
|
|
%r - REPL type (clj or cljs)
|
|
%S - type of the ClojureScript runtime (Nashorn, Node, Figwheel etc.)
|
|
%s - session name as defined by `cider-session-name-template'.
|
|
|
|
In case some values are empty, extra separators (: and -) are automatically
|
|
removed."
|
|
(let* ((dir (directory-file-name
|
|
(abbreviate-file-name
|
|
(or (plist-get params :project-dir)
|
|
(clojure-project-dir (cider-current-dir))
|
|
default-directory))))
|
|
(short-proj (file-name-nondirectory (directory-file-name dir)))
|
|
(parent-dir (ignore-errors
|
|
(thread-first dir file-name-directory
|
|
directory-file-name file-name-nondirectory
|
|
file-name-as-directory)))
|
|
(long-proj (format "%s%s" (or parent-dir "") short-proj))
|
|
;; use `dir` if it is shorter than `long-proj` or `short-proj`
|
|
(short-proj (if (>= (length short-proj) (length dir))
|
|
dir
|
|
short-proj))
|
|
(long-proj (if (>= (length long-proj) (length dir))
|
|
dir
|
|
long-proj))
|
|
(port (or (plist-get params :port) ""))
|
|
(host (or (plist-get params :host) "localhost"))
|
|
(remote-host (if (member host '("localhost" "127.0.0.1"))
|
|
""
|
|
host))
|
|
(repl-type (or (plist-get params :repl-type) "unknown"))
|
|
(cljs-repl-type (or (and (eq repl-type 'cljs)
|
|
(plist-get params :cljs-repl-type))
|
|
""))
|
|
(specs `((?h . ,host)
|
|
(?H . ,remote-host)
|
|
(?p . ,port)
|
|
(?j . ,short-proj)
|
|
(?J . ,long-proj)
|
|
(?r . ,repl-type)
|
|
(?S . ,cljs-repl-type)))
|
|
(ses-name (or (plist-get params :session-name)
|
|
(format-spec cider-session-name-template specs)))
|
|
(specs (append `((?s . ,ses-name)) specs)))
|
|
(thread-last (format-spec template specs)
|
|
;; remove extraneous separators
|
|
(replace-regexp-in-string "\\([:-]\\)[:-]+" "\\1")
|
|
(replace-regexp-in-string "\\(^[:-]\\)\\|\\([:-]$\\)" "")
|
|
(replace-regexp-in-string "[:-]\\([])*]\\)" "\\1"))))
|
|
|
|
(defun cider-make-session-name (params)
|
|
"Create new session name given plist of connection PARAMS.
|
|
Session name can be customized with `cider-session-name-template'."
|
|
(let* ((root-name (cider-format-connection-params cider-session-name-template params))
|
|
(other-names (mapcar #'car (sesman-sessions 'CIDER)))
|
|
(name root-name)
|
|
(i 2))
|
|
(while (member name other-names)
|
|
(setq name (concat root-name "#" (number-to-string i))
|
|
i (+ i 1)))
|
|
name))
|
|
|
|
|
|
;;; REPL Buffer Init
|
|
|
|
(defvar-local cider-cljs-repl-type nil
|
|
"The type of the ClojureScript runtime (Nashorn, Node etc.)")
|
|
|
|
(defvar-local cider-repl-type nil
|
|
"The type of this REPL buffer, usually either clj or cljs.")
|
|
|
|
(defun cider-repl-type (repl-buffer)
|
|
"Get REPL-BUFFER's type."
|
|
(buffer-local-value 'cider-repl-type repl-buffer))
|
|
|
|
(defun cider-repl-type-for-buffer (&optional buffer)
|
|
"Return the matching connection type (clj or cljs) for BUFFER.
|
|
BUFFER defaults to the `current-buffer'. In cljc buffers return
|
|
multi. This function infers connection type based on the major mode.
|
|
For the REPL type use the function `cider-repl-type'."
|
|
(with-current-buffer (or buffer (current-buffer))
|
|
(cond
|
|
((derived-mode-p 'clojurescript-mode) 'cljs)
|
|
((derived-mode-p 'clojurec-mode) 'multi)
|
|
((derived-mode-p 'clojure-mode) 'clj)
|
|
(cider-repl-type))))
|
|
|
|
(defun cider-set-repl-type (&optional type)
|
|
"Set REPL TYPE to clj or cljs.
|
|
Assume that the current buffer is a REPL."
|
|
(interactive)
|
|
(let ((type (cider-maybe-intern (or type (completing-read
|
|
(format "Set REPL type (currently `%s') to: "
|
|
cider-repl-type)
|
|
'(clj cljs))))))
|
|
(when (or (not (equal cider-repl-type type))
|
|
(null mode-name))
|
|
(setq cider-repl-type type)
|
|
(setq mode-name (format "REPL[%s]" type))
|
|
(let ((params (cider--gather-connect-params)))
|
|
;; We need to set current name to something else temporarily to avoid
|
|
;; false name duplication in `nrepl-repl-buffer-name`.
|
|
(rename-buffer (generate-new-buffer-name "*dummy-cider-repl-buffer*"))
|
|
(rename-buffer (nrepl-repl-buffer-name params))
|
|
(when (and nrepl-log-messages nrepl-messages-buffer)
|
|
(with-current-buffer nrepl-messages-buffer
|
|
(rename-buffer (nrepl-messages-buffer-name params))))))))
|
|
|
|
(defun cider--choose-reusable-repl-buffer (params)
|
|
"Find connection-less REPL buffer and ask the user for confirmation.
|
|
Return nil if no such buffers exists or the user has chosen not to reuse
|
|
the buffer. If multiple dead REPLs exist, ask the user to choose one.
|
|
PARAMS is a plist as received by `cider-repl-create'."
|
|
(when-let* ((repls (seq-filter (lambda (b)
|
|
(with-current-buffer b
|
|
(and (derived-mode-p 'cider-repl-mode)
|
|
(not (process-live-p (get-buffer-process b))))))
|
|
(buffer-list))))
|
|
(let* ((proj-dir (plist-get params :project-dir))
|
|
(host (plist-get params :host))
|
|
(port (plist-get params :port))
|
|
(cljsp (member (plist-get params :repl-type) '(cljs pending-cljs)))
|
|
(scored-repls
|
|
(delq nil
|
|
(mapcar (lambda (b)
|
|
(let ((bparams (cider--gather-connect-params nil b)))
|
|
(when (eq cljsp (member (plist-get bparams :repl-type)
|
|
'(cljs pending-cljs)))
|
|
(cons (buffer-name b)
|
|
(+
|
|
(if (equal proj-dir (plist-get bparams :project-dir)) 8 0)
|
|
(if (equal host (plist-get bparams :host)) 4 0)
|
|
(if (equal port (plist-get bparams :port)) 2 0))))))
|
|
repls))))
|
|
(when scored-repls
|
|
(if (> (length scored-repls) 1)
|
|
(when (y-or-n-p "Dead REPLs exist. Reuse? ")
|
|
(let ((sorted-repls (seq-sort (lambda (a b) (> (cdr a) (cdr b))) scored-repls)))
|
|
(get-buffer (completing-read "REPL to reuse: "
|
|
(mapcar #'car sorted-repls) nil t nil nil (caar sorted-repls)))))
|
|
(when (y-or-n-p (format "A dead REPL %s exists. Reuse? " (caar scored-repls)))
|
|
(get-buffer (caar scored-repls))))))))
|
|
|
|
(declare-function cider-default-err-handler "cider-eval")
|
|
(declare-function cider-repl-mode "cider-repl")
|
|
(declare-function cider-repl--state-handler "cider-repl")
|
|
(declare-function cider-repl-reset-markers "cider-repl")
|
|
(defvar-local cider-session-name nil)
|
|
(defvar-local cider-repl-init-function nil)
|
|
(defun cider-repl-create (params)
|
|
"Create new repl buffer.
|
|
PARAMS is a plist which contains :repl-type, :host, :port, :project-dir,
|
|
:repl-init-function and :session-name. When non-nil, :repl-init-function
|
|
must be a function with no arguments which is called after repl creation
|
|
function with the repl buffer set as current."
|
|
;; Connection might not have been set as yet. Please don't send requests in
|
|
;; this function, but use cider--connected-handler instead.
|
|
(let ((buffer (or (plist-get params :repl-buffer)
|
|
(cider--choose-reusable-repl-buffer params)
|
|
(get-buffer-create (generate-new-buffer-name "*cider-uninitialized-repl*"))))
|
|
(ses-name (or (plist-get params :session-name)
|
|
(cider-make-session-name params))))
|
|
(with-current-buffer buffer
|
|
(setq-local sesman-system 'CIDER)
|
|
(setq-local default-directory (or (plist-get params :project-dir) default-directory))
|
|
;; creates a new session if session with ses-name doesn't already exist
|
|
(sesman-add-object 'CIDER ses-name buffer 'allow-new)
|
|
(unless (derived-mode-p 'cider-repl-mode)
|
|
(cider-repl-mode))
|
|
(setq nrepl-err-handler #'cider-default-err-handler
|
|
;; used as a new-repl marker in cider-set-repl-type
|
|
mode-name nil
|
|
cider-session-name ses-name
|
|
nrepl-project-dir (plist-get params :project-dir)
|
|
;; REPLs start with clj and then "upgrade" to a different type
|
|
cider-repl-type (plist-get params :repl-type)
|
|
;; ran at the end of cider--connected-handler
|
|
cider-repl-init-function (plist-get params :repl-init-function))
|
|
(cider-repl-reset-markers)
|
|
(add-hook 'nrepl-response-handler-functions #'cider-repl--state-handler nil 'local)
|
|
(add-hook 'nrepl-connected-hook #'cider--connected-handler nil 'local)
|
|
(add-hook 'nrepl-disconnected-hook #'cider--disconnected-handler nil 'local)
|
|
(current-buffer))))
|
|
|
|
|
|
;;; Current/other REPLs
|
|
|
|
(defun cider--no-repls-user-error (type)
|
|
"Throw \"No REPL\" user error customized for TYPE."
|
|
(let ((type (cond
|
|
((or (eq type 'multi) (eq type 'any))
|
|
"clj or cljs")
|
|
((listp type)
|
|
(mapconcat #'identity type " or "))
|
|
(type))))
|
|
(user-error "No %s REPLs in current session \"%s\""
|
|
type (car (sesman-current-session 'CIDER)))))
|
|
|
|
(defun cider-current-repl (&optional type ensure)
|
|
"Get the most recent REPL of TYPE from the current session.
|
|
TYPE is either clj, cljs, multi or any.
|
|
When nil, infer the type from the current buffer.
|
|
If ENSURE is non-nil, throw an error if either there is
|
|
no linked session or there is no REPL of TYPE within the current session."
|
|
(let ((type (cider-maybe-intern type)))
|
|
(if (and (derived-mode-p 'cider-repl-mode)
|
|
(or (null type)
|
|
(eq 'any type)
|
|
(eq cider-repl-type type)))
|
|
;; shortcut when in REPL buffer
|
|
(current-buffer)
|
|
(let* ((type (or type (cider-repl-type-for-buffer)))
|
|
(repls (cider-repls type ensure))
|
|
(repl (if (<= (length repls) 1)
|
|
(car repls)
|
|
;; pick the most recent one
|
|
(seq-find (lambda (b)
|
|
(member b repls))
|
|
(buffer-list)))))
|
|
(if (and ensure (null repl))
|
|
(cider--no-repls-user-error type)
|
|
repl)))))
|
|
|
|
(defun cider--match-repl-type (type buffer)
|
|
"Return non-nil if TYPE matches BUFFER's REPL type."
|
|
(let ((buffer-repl-type (cider-repl-type buffer)))
|
|
(cond ((null buffer-repl-type) nil)
|
|
((or (null type) (eq type 'multi) (eq type 'any)) t)
|
|
((listp type) (member buffer-repl-type type))
|
|
(t (string= type buffer-repl-type)))))
|
|
|
|
(defun cider-repls (&optional type ensure)
|
|
"Return cider REPLs of TYPE from the current session.
|
|
If TYPE is nil or multi, return all repls. If TYPE is a list of types,
|
|
return only REPLs of type contained in the list. If ENSURE is non-nil,
|
|
throw an error if no linked session exists."
|
|
(let ((type (cond
|
|
((listp type)
|
|
(mapcar #'cider-maybe-intern type))
|
|
((cider-maybe-intern type))))
|
|
(repls (cdr (if ensure
|
|
(sesman-ensure-session 'CIDER)
|
|
(sesman-current-session 'CIDER)))))
|
|
(or (seq-filter (lambda (b)
|
|
(cider--match-repl-type type b))
|
|
repls)
|
|
(when ensure
|
|
(cider--no-repls-user-error type)))))
|
|
|
|
(defun cider-map-repls (which function)
|
|
"Call FUNCTION once for each appropriate REPL as indicated by WHICH.
|
|
The function is called with one argument, the REPL buffer. The appropriate
|
|
connections are found by inspecting the current buffer. WHICH is one of
|
|
the following keywords:
|
|
:auto - Act on the connections whose type matches the current buffer. In
|
|
`cljc' files, mapping happens over both types of REPLs.
|
|
:clj (:cljs) - Map over clj (cljs)) REPLs only.
|
|
:clj-strict (:cljs-strict) - Map over clj (cljs) REPLs but signal a
|
|
`user-error' in `clojurescript-mode' (`clojure-mode'). Use this for
|
|
commands only supported in Clojure (ClojureScript).
|
|
Error is signaled if no REPL buffers of specified type exist in current
|
|
session."
|
|
(declare (indent 1))
|
|
(let ((cur-type (cider-repl-type-for-buffer)))
|
|
(cl-case which
|
|
(:clj-strict (when (eq cur-type 'cljs)
|
|
(user-error "Clojure-only operation requested in a ClojureScript buffer")))
|
|
(:cljs-strict (when (eq cur-type 'clj)
|
|
(user-error "ClojureScript-only operation requested in a Clojure buffer"))))
|
|
(let* ((type (cl-case which
|
|
((:clj :clj-strict) 'clj)
|
|
((:cljs :cljs-strict) 'cljs)
|
|
(:auto (if (eq cur-type 'multi)
|
|
'(clj cljs)
|
|
cur-type))))
|
|
(ensure (cl-case which
|
|
(:auto nil)
|
|
(t 'ensure)))
|
|
(repls (cider-repls type ensure)))
|
|
(mapcar function repls))))
|
|
|
|
;; REPLs double as connections in CIDER, so it's useful to be able to refer to
|
|
;; them as connections in certain contexts.
|
|
(defalias 'cider-current-connection #'cider-current-repl)
|
|
(defalias 'cider-connections #'cider-repls)
|
|
(defalias 'cider-map-connections #'cider-map-repls)
|
|
(defalias 'cider-connection-type-for-buffer #'cider-repl-type-for-buffer)
|
|
|
|
|
|
;; Deprecation after #2324
|
|
|
|
(define-obsolete-function-alias 'cider-current-repl-buffer 'cider-current-repl "0.18")
|
|
(define-obsolete-function-alias 'cider-repl-buffers 'cider-repls "0.18")
|
|
(define-obsolete-function-alias 'cider-current-session 'cider-nrepl-eval-session "0.18")
|
|
(define-obsolete-function-alias 'cider-current-tooling-session 'cider-nrepl-tooling-session "0.18")
|
|
(define-obsolete-function-alias 'cider-display-connection-info 'cider-describe-connection "0.18")
|
|
(define-obsolete-function-alias 'nrepl-connection-buffer-name 'nrepl-repl-buffer-name "0.18")
|
|
(define-obsolete-function-alias 'cider-repl-set-type 'cider-set-repl-type "0.18")
|
|
|
|
(make-obsolete 'cider-assoc-buffer-with-connection 'sesman-link-with-buffer "0.18")
|
|
(make-obsolete 'cider-assoc-project-with-connection 'sesman-link-with-project "0.18")
|
|
(make-obsolete 'cider-change-buffers-designation nil "0.18")
|
|
(make-obsolete 'cider-clear-buffer-local-connection nil "0.18")
|
|
(make-obsolete 'cider-close-nrepl-session 'cider-quit "0.18")
|
|
(make-obsolete 'cider-create-sibling-cljs-repl 'cider-connect-sibling-cljs "0.18")
|
|
(make-obsolete 'cider-current-messages-buffer nil "0.18")
|
|
(make-obsolete 'cider-default-connection "see sesman." "0.18")
|
|
(make-obsolete 'cider-extract-designation-from-current-repl-buffer nil "0.18")
|
|
(make-obsolete 'cider-find-connection-buffer-for-project-directory 'sesman-current-sessions "0.18")
|
|
(make-obsolete 'cider-find-reusable-repl-buffer nil "0.18")
|
|
(make-obsolete 'cider-make-connection-default "see sesman." "0.18")
|
|
(make-obsolete 'cider-other-connection nil "0.18")
|
|
(make-obsolete 'cider-project-connections 'sesman-current-sessions "0.18")
|
|
(make-obsolete 'cider-project-connections-types nil "0.18")
|
|
(make-obsolete 'cider-prompt-for-project-on-connect nil "0.18")
|
|
(make-obsolete 'cider-read-connection `sesman-ask-for-session "0.18")
|
|
(make-obsolete 'cider-replicate-connection nil "0.18")
|
|
(make-obsolete 'cider-request-dispatch "see sesman." "0.18")
|
|
(make-obsolete 'cider-rotate-default-connection "see sesman." "0.18")
|
|
(make-obsolete 'cider-toggle-buffer-connection nil "0.18")
|
|
(make-obsolete 'cider-toggle-request-dispatch nil "0.18")
|
|
(make-obsolete 'nrepl-connection-buffer-name-template 'nrepl-repl-buffer-name-template "0.18")
|
|
(make-obsolete 'nrepl-create-client-buffer-function nil "0.18")
|
|
(make-obsolete 'nrepl-post-client-callback nil "0.18")
|
|
(make-obsolete 'nrepl-prompt-to-kill-server-buffer-on-quit nil "0.18")
|
|
(make-obsolete 'nrepl-use-this-as-repl-buffer nil "0.18")
|
|
|
|
;; connection manager
|
|
(make-obsolete 'cider-client-name-repl-type "see sesman." "0.18")
|
|
(make-obsolete 'cider-connection-browser "see sesman." "0.18")
|
|
(make-obsolete 'cider-connections-buffer-mode "see sesman." "0.18")
|
|
(make-obsolete 'cider-connections-buffer-mode-map "see sesman." "0.18")
|
|
(make-obsolete 'cider-connections-close-connection "see sesman." "0.18")
|
|
(make-obsolete 'cider-connections-goto-connection "see sesman." "0.18")
|
|
(make-obsolete 'cider-connections-make-default "see sesman." "0.18")
|
|
(make-obsolete 'cider-display-connected-message "see sesman." "0.18")
|
|
(make-obsolete 'cider-project-name "see sesman." "0.18")
|
|
|
|
(provide 'cider-connection)
|
|
|
|
;;; cider-connection.el ends here
|