From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Chinmay Dalal Newsgroups: gmane.emacs.bugs Subject: bug#61412: [PATCH v3] Add inlay hints to eglot Date: Wed, 15 Feb 2023 18:38:28 +0530 Message-ID: References: <20230211081335.312224-1-dalal.chinmay.0101@gmail.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="3861"; mail-complaints-to="usenet@ciao.gmane.io" To: 61412@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Feb 15 15:39:39 2023 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1pSIwc-0000kj-Md for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 15 Feb 2023 15:39:38 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pSIw6-000619-Jg; Wed, 15 Feb 2023 09:39:06 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pSIw3-00060Q-Pj for bug-gnu-emacs@gnu.org; Wed, 15 Feb 2023 09:39:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pSIw3-0005gi-Gh for bug-gnu-emacs@gnu.org; Wed, 15 Feb 2023 09:39:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pSIw3-00056F-D3 for bug-gnu-emacs@gnu.org; Wed, 15 Feb 2023 09:39:03 -0500 X-Loop: help-debbugs@gnu.org In-Reply-To: <20230211081335.312224-1-dalal.chinmay.0101@gmail.com> Resent-From: Chinmay Dalal Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 15 Feb 2023 14:39:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 61412 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 61412-submit@debbugs.gnu.org id=B61412.167647191019506 (code B ref 61412); Wed, 15 Feb 2023 14:39:03 +0000 Original-Received: (at 61412) by debbugs.gnu.org; 15 Feb 2023 14:38:30 +0000 Original-Received: from localhost ([127.0.0.1]:58395 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pSIvU-00054Q-1X for submit@debbugs.gnu.org; Wed, 15 Feb 2023 09:38:29 -0500 Original-Received: from mail-pj1-f42.google.com ([209.85.216.42]:53113) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pSHYH-00069f-VP for 61412@debbugs.gnu.org; Wed, 15 Feb 2023 08:10:28 -0500 Original-Received: by mail-pj1-f42.google.com with SMTP id o13so18127620pjg.2 for <61412@debbugs.gnu.org>; Wed, 15 Feb 2023 05:10:25 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=mime-version:date:subject:to:from:message-id:from:to:cc:subject :date:message-id:reply-to; bh=PPLOmQU40NPZSUCpo7yMLnmVqAGYjk/DycGVeoKJ3pI=; b=JMcEYUUn4JHAp2k9y+Uke1HTvthqa2U89+LUSBXWAIfcoO15vZZrAdwzJBLFN9YFbt 74zS7M3iMTCSDCo/QyMlT/a55+TAvSWM2cZfsucZLdLWkAfq8mtDWH728Pa5qFSEflIJ 99RUtXIUKd8bOedTYaCR0fDT5KA+tN1agqmnfZngvd37KGTqMsqeoijwC7MrZrzGJ2Qs 9KriqisQTUIOlbkL1AFMlrTGNGbBTj28PHzYYcghgivYmFoUXN3GCtJLVIlPeSsXntRM uIFwjpQazhbnIOfmcSxAqq7b5LXXfXzyHPW8MstvFNZWKAJQ7lcBWn/hDUGFTHPDZry3 FY9w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=mime-version:date:subject:to:from:message-id:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=PPLOmQU40NPZSUCpo7yMLnmVqAGYjk/DycGVeoKJ3pI=; b=kJ8LO1KweZlQL4P1kg11VRHYdYOFckuDPAvsv8qU+Yt/YvngwXuBUFTLSgL+VlA/tL Nk2VmplokVBc7DAM1RkwlLkNaNJXD888fNhWl+eK5/+RbvAqlASaVjEiHmNge/lJUi92 TFxk/Zlkg3cUF/+0O4LgE5hqG28ahBRt1J1i3qlo3hJasJB4sWgHJ9Kpv8JkKAdAkugF B5jvEeOJzN+a5hgXHm4FiY58MeTesT5NTc1+0HBKqDhP7DBS8nuwILiG7oLTgcVb+gCm r6NEJJm5IK0U1DQvaPhDXufP/YaXvVeDbpTPrpRzN4G+uG1RtC/8pbDFlx8mZcEoMWMz G6sg== X-Gm-Message-State: AO0yUKWEDzF8uGmEA70QUMf0ONaZ/IpM8N81Bp7xyYQzpW+CR+vAx4DS VuZ/+x1b3l+Gd+AewkGsstWRyY0M7DA= X-Google-Smtp-Source: AK7set+llOXWeKdGPYGaCfiIZPbfIzHIWdI+Nq4JxLqeoX+LOelKBx0A8KS5VdRQaJ0NMpKAtk/BQQ== X-Received: by 2002:a17:903:686:b0:196:5b76:8e6e with SMTP id ki6-20020a170903068600b001965b768e6emr1888275plb.1.1676466619816; Wed, 15 Feb 2023 05:10:19 -0800 (PST) Original-Received: from ganymede ([182.75.45.1]) by smtp.gmail.com with ESMTPSA id y4-20020a170902ed4400b00188c9c11559sm10153320plb.1.2023.02.15.05.10.18 for <61412@debbugs.gnu.org> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Feb 2023 05:10:19 -0800 (PST) X-Mailman-Approved-At: Wed, 15 Feb 2023 09:38:24 -0500 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:255722 Archived-At: --=-=-= Content-Type: text/plain This adds the "-face" suffix to the `:inherit` definitions of the new kind-based faces --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Add-inlay-hints-to-eglot.patch >From 3092a1d3828985857298ead604f44c67737550ef Mon Sep 17 00:00:00 2001 From: Chinmay Dalal Date: Sat, 11 Feb 2023 10:00:20 +0530 Subject: [PATCH] Add inlay hints to eglot Hello all, I have improved upon the patch from bug#61066. >From the original email: > - I can't figure out a way to show the hints on a document without causing lags or timeouts from the lsp server This might have been because they were sending an asynchronous request, waiting for the response, collecting the hints and displaying them. I have instead used `jsonrpc-async-request` with a handler function which should remedy this issue. I have tried this with rust-analyzer and faced no lags. The original patch also checked the wrong condition (`cond (eglot--managed-mode`) in `eglot-inlay-mode` and had a superfluous `(run-hooks 'eglot-managed-mode-hook)` (presumably copy-pasted from `define-minor-mode eglot--managed-mode`), I have fixed that. >From a reply to the original email: > AFAIU, inlay hints provide information of the same kind as ElDoc and > in similar manner from the display and UX POV. So I think this > feature should work via ElDoc, not as a separate from-the-scratch > implementation. This can't be done via ElDoc because the purpose of inlay hints is to display variable types and parameter names without moving the cursor to the location. One can already see this information if they move their cursor to the variable or function and wait for the "hover" - inlay hints were added to the spec after this which (IMHO) clearly means something like overlays should be used. A couple of issues at present: 1. I have not implemented "complex" hints (whose `label` is an array of `InlayHintLabelPart` instead of a string) because I don't know what to do when there are multiple labels at the same location. rust-analyzer uses these hints to show a clickable link at the end of a function block, which points to the beginning of the function. 2. I need to save the buffer or disable and re-enable `eglot-inlay-mode` to get hints for the first time after opening a file, even though I call `eglot--update-hints` once in `eglot-inlay-mode`. Regards, Chinmay Dalal --- This uses different faces based on the "kind" of the hint: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#inlayHintKind --- This adds the "-face" suffix to the `:inherit` definitions of the new kind-based faces --- lisp/progmodes/eglot.el | 85 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 84 insertions(+), 1 deletion(-) diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el index 6caf589..d3fb329 100644 --- a/lisp/progmodes/eglot.el +++ b/lisp/progmodes/eglot.el @@ -404,6 +404,10 @@ This can be useful when using docker to run a language server.") (when (assoc 'flex completion-styles-alist) (add-to-list 'completion-category-defaults '(eglot (styles flex basic)))) +(defcustom eglot-inlay-hints t + "If non-nil, enable inlay hints." + :type 'boolean) + ;;; Constants ;;; @@ -1624,7 +1628,8 @@ under cursor." (const :tag "Highlight links in document" :documentLinkProvider) (const :tag "Decorate color references" :colorProvider) (const :tag "Fold regions of buffer" :foldingRangeProvider) - (const :tag "Execute custom commands" :executeCommandProvider))) + (const :tag "Execute custom commands" :executeCommandProvider) + (const :tag "Inlay hints" :inlayHintProvider))) (defun eglot--server-capable (&rest feats) "Determine if current server is capable of FEATS." @@ -1845,6 +1850,8 @@ If it is activated, also signal textDocument/didOpen." (when (and buffer-file-name (eglot-current-server)) (setq eglot--diagnostics nil) (eglot--managed-mode) + (unless (not eglot-inlay-hints) + (eglot-inlay-mode)) (eglot--signal-textDocument/didOpen)))) (add-hook 'find-file-hook 'eglot--maybe-activate-editing-mode) @@ -3456,6 +3463,82 @@ If NOERROR, return predicate, else erroring function." (revert-buffer) (pop-to-buffer (current-buffer))))) +(defface eglot-inlay-hint-face + '((t (:height 0.8 :inherit shadow))) + "Face used for inlay hint overlays.") + +(defface eglot-type-hint-face + '((t (:inherit eglot-inlay-hint-face))) + "Face used for type hints.") + +(defface eglot-parameter-hint-face + '((t (:inherit eglot-inlay-hint-face))) + "Face used for parameter hints.") + +(define-minor-mode eglot-inlay-mode + "Mode for displaying inlay hints." + :lighter " inlay" + (if eglot-inlay-mode + (progn + (add-hook 'after-save-hook 'eglot--update-hints 0 t) + (eglot--update-hints)) + (progn + (remove-hook 'after-save-hook 'eglot--update-hints t) + (eglot--remove-hints)))) + +(defun eglot--inlay-handler (buffer hints) + "Apply vector of inlay hints HINTS on buffer BUFFER." + (seq-doseq (hint hints) + (let* ((position (plist-get hint :position)) + (line (plist-get position :line)) + (character (plist-get position :character)) + (kind (plist-get hint :kind)) + (face (cond ((eq kind 1) + 'eglot-type-hint-face) + ((eq kind 2) + 'eglot-parameter-hint-face) + (t + 'eglot-inlay-hint-face))) + (label (plist-get hint :label))) + (when (stringp label) + (with-current-buffer buffer + (eglot--widening + (goto-char (point-min)) + (forward-line line) + (eglot-move-to-column character) + (let ((overlay (make-overlay (point) (point)))) + (overlay-put overlay 'before-string (propertize + (concat (if (plist-get hint :paddingLeft) " " "") + label + (if (plist-get hint :paddingRight) " " "")) + 'face face)) + (overlay-put overlay 'is-eglot-inlay-hint t)))))))) + +(defun eglot--remove-hints () + "Remove inlay hints from the buffer." + (remove-overlays nil nil 'is-eglot-inlay-hint t)) + +(defun eglot--update-hints () + "Request inlay hints for the current buffer and apply them." + (unless (eglot--server-capable :inlayHintProvider) + (eglot--error "This LSP server isn't an :inlayHintProvider")) + ;; Remove existing hints + (eglot--remove-hints) + (let ((buffer (current-buffer))) + (jsonrpc-async-request + (eglot--current-server-or-lose) + :textDocument/inlayHint + (list + :textDocument (eglot--TextDocumentIdentifier) + :range (list + :start (list :line 0 :character 0) + :end (list + :line (count-lines (point-min) (point-max)) + :character 0))) + :success-fn (lambda (hints) + (eglot--inlay-handler buffer hints)) + :deferred t))) + ;;; Hacks ;;; -- 2.39.1 --=-=-=--