Improve eglot-eldoc-function

Use the :range key if the server provided it. Also simplify code with
a new eglot--with-lsp-range macro.

* eglot.el (eglot--format-markup): Tweak comment.
(eglot--with-lsp-range): New helper macro.
(eglot--server-textDocument/publishDiagnostics)
(eglot--apply-text-edits): Use it.
(eglot-eldoc-function): Use range if server provides it.

diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index d1e4d1548a48e8d1524f6cc27d6bcf5a68cbf52d..b2709a6ae472f39777d71e94288f2a254e88069c 100644 (file)
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -740,7 +740,7 @@ DEFERRED is passed to `eglot--request', which see."
   "Format MARKUP according to LSP's spec."
   (cond ((stringp markup)
          (with-temp-buffer
-           (ignore-errors (funcall (intern "markdown-mode"))) ;escape bytecompiler
+           (ignore-errors (funcall (intern "markdown-mode"))) ;escape bytecomp
            (font-lock-ensure)
            (insert markup)
            (string-trim (buffer-string))))
@@ -757,6 +757,15 @@ DEFERRED is passed to `eglot--request', which see."
   "Determine if current server is capable of FEAT."
   (plist-get (eglot--capabilities (eglot--current-process-or-lose)) feat))
 
+(cl-defmacro eglot--with-lsp-range ((start end) range &body body
+                                    &aux (range-sym (cl-gensym)))
+  "Bind LSP RANGE to START and END. Evaluate BODY."
+  (declare (indent 2) (debug (sexp sexp &rest form)))
+  `(let* ((,range-sym ,range)
+          (,start (eglot--lsp-position-to-point (plist-get ,range-sym :start)))
+          (,end (eglot--lsp-position-to-point (plist-get ,range-sym :end))))
+     ,@body))
+
 \f
 ;;; Minor modes
 ;;;
@@ -965,17 +974,13 @@ called interactively."
          collect (cl-destructuring-bind (&key range severity _group
                                               _code source message)
                      diag-spec
-                   (cl-destructuring-bind (&key start end)
-                       range
-                     (let* ((begin-pos (eglot--lsp-position-to-point start))
-                            (end-pos (eglot--lsp-position-to-point end)))
-                       (flymake-make-diagnostic
-                        (current-buffer)
-                        begin-pos end-pos
-                        (cond ((<= severity 1) :error)
-                              ((= severity 2)  :warning)
-                              (t               :note))
-                        (concat source ": " message)))))
+                   (eglot--with-lsp-range (beg end) range
+                     (flymake-make-diagnostic (current-buffer)
+                                              beg end
+                                              (cond ((<= severity 1) :error)
+                                                    ((= severity 2)  :warning)
+                                                    (t               :note))
+                                              (concat source ": " message))))
          into diags
          finally (cond (eglot--current-flymake-report-fn
                         (funcall eglot--current-flymake-report-fn diags)
@@ -1302,15 +1307,23 @@ DUMMY is ignored"
         (proc (eglot--current-process-or-lose))
         (position-params (eglot--current-buffer-TextDocumentPositionParams)))
     (when (eglot--server-capable :hoverProvider)
-      (eglot--request proc :textDocument/hover position-params
-                      :success-fn (eglot--lambda (&key contents _range)
-                                    (eldoc-message
-                                     (mapconcat #'eglot--format-markup
-                                                (if (vectorp contents)
-                                                    contents
-                                                  (list contents))
-                                                "\n")))
-                      :deferred :textDocument/hover))
+      (eglot--request
+       proc :textDocument/hover position-params
+       :success-fn (eglot--lambda (&key contents range)
+                     (when (get-buffer-window buffer)
+                       (with-current-buffer buffer
+                         (eldoc-message
+                          (concat
+                           (and range
+                                (eglot--with-lsp-range (beg end) range
+                                  (concat (buffer-substring beg end)  ": ")))
+                           (mapconcat #'eglot--format-markup
+                                      (append
+                                       (cond ((vectorp contents)
+                                              contents)
+                                             (contents
+                                              (list contents)))) "\n"))))))
+       :deferred :textDocument/hover))
     (when (eglot--server-capable :documentHighlightProvider)
       (eglot--request
        proc :textDocument/documentHighlight position-params
@@ -1321,11 +1334,8 @@ DUMMY is ignored"
                              (with-current-buffer buffer
                                (eglot--mapply
                                 (eglot--lambda (&key range kind)
-                                  (cl-destructuring-bind (&key start end) range
-                                    (let ((ov (make-overlay
-                                               (eglot--lsp-position-to-point start)
-                                               (eglot--lsp-position-to-point end)
-                                               buffer)))
+                                  (eglot--with-lsp-range (beg end) range
+                                    (let ((ov (make-overlay beg end)))
                                       (overlay-put ov 'face 'highlight)
                                       (overlay-put ov 'evaporate t)
                                       (overlay-put ov :kind kind)
@@ -1366,11 +1376,8 @@ DUMMY is ignored"
        (save-restriction
          (widen)
          (save-excursion
-           (let ((start (eglot--lsp-position-to-point (plist-get range :start))))
-             (goto-char start)
-             (delete-region start
-                            (eglot--lsp-position-to-point (plist-get range :end)))
-             (insert newText)))))
+           (eglot--with-lsp-range (beg end) range
+             (goto-char beg) (delete-region beg end) (insert newText)))))
      edits)
     (eglot--message "%s: Performed %s edits" (current-buffer) (length edits))))