-
Notifications
You must be signed in to change notification settings - Fork 213
/
lsp-bridge-inlay-hint.el
209 lines (175 loc) · 7.81 KB
/
lsp-bridge-inlay-hint.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
;;; lsp-bridge-inlay-hint.el --- Inlay hint protocol -*- lexical-binding: t; no-byte-compile: t; -*-*-
;; Filename: lsp-bridge-inlay-hint.el
;; Description: Inlay hint protocol
;; Author: Andy Stewart <lazycat.manatee@gmail.com>
;; Maintainer: Andy Stewart <lazycat.manatee@gmail.com>
;; Copyright (C) 2023, Andy Stewart, all rights reserved.
;; Created: 2023-10-03 21:35:08
;; Version: 0.1
;; Last-Updated: 2023-10-03 21:35:08
;; By: Andy Stewart
;; URL: https://www.github.org/manateelazycat/lsp-bridge-inlay-hint
;; Keywords:
;; Compatibility: GNU Emacs 30.0.50
;;
;; Features that might be required by this library:
;;
;;
;;
;;; This file is NOT part of GNU Emacs
;;; License
;;
;; 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, 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; see the file COPYING. If not, write to
;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth
;; Floor, Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; Inlay hint protocol
;;
;;; Installation:
;;
;; Put lsp-bridge-inlay-hint.el to your load-path.
;; The load-path is usually ~/elisp/.
;; It's set in your ~/.emacs like this:
;; (add-to-list 'load-path (expand-file-name "~/elisp"))
;;
;; And the following to your ~/.emacs startup file.
;;
;; (require 'lsp-bridge-inlay-hint)
;;
;; No need more.
;;; Customize:
;;
;;
;;
;; All of the above can customize by:
;; M-x customize-group RET lsp-bridge-inlay-hint RET
;;
;;; Change log:
;;
;; 2023/10/03
;; * First released.
;;
;;; Acknowledgements:
;;
;;
;;
;;; TODO
;;
;;
;;
;;; Require
;;; Code:
(defcustom lsp-bridge-enable-inlay-hint nil
"Whether to enable inlay hint."
:type 'boolean
:safe #'booleanp
:group 'lsp-bridge)
(defface lsp-bridge-inlay-hint-face
`((t :foreground "#aaaaaa"))
"Face for inlay hint."
:group 'lsp-bridge-inlay-hint)
(defvar-local lsp-bridge-inlay-hint-last-update-pos nil)
(defvar-local lsp-bridge-inlay-hint-cache nil
"We use `lsp-bridge-inlay-hint-cache' avoid screen flicker if two respond result is same.")
(defvar-local lsp-bridge-inlay-hint-overlays '())
(defun lsp-bridge-inlay-hint-monitor-window-scroll ()
(when lsp-bridge-enable-inlay-hint
(let ((window-pos (window-end nil t)))
(when (not (equal lsp-bridge-inlay-hint-last-update-pos window-pos))
(lsp-bridge-inlay-hint-try-send-request)
(setq-local lsp-bridge-inlay-hint-last-update-pos window-pos)))))
(defun lsp-bridge-inlay-hint-try-send-request ()
(when lsp-bridge-enable-inlay-hint
(lsp-bridge-inlay-hint)))
(defun lsp-bridge-inlay-hint ()
;; `window-start' won't return valid value of window start position if we not call `redisplay' before 'window-start',
;; but call `redisplay' will cause current line scroll to window start postion, like issue https://github.com/manateelazycat/lsp-bridge/issues/1029
;;
;; So we use `window-end' to test window is scroll or not, and always pass `point-min' and `point-max' to LSP server.
(lsp-bridge-call-file-api "inlay_hint"
(lsp-bridge--point-position (point-min))
(lsp-bridge--point-position (point-max))))
(defun lsp-bridge-inlay-hint-hide-overlays ()
(when lsp-bridge-inlay-hint-overlays
(dolist (inlay-hint-overlay lsp-bridge-inlay-hint-overlays)
(delete-overlay inlay-hint-overlay)))
(setq-local lsp-bridge-inlay-hint-overlays nil))
(defun lsp-bridge-inlay-hint-padding-text (hint-padding is-left)
(and hint-padding
(not (eq hint-padding :json-false))
(not (memq (if is-left
(char-before)
(char-after))
'(32 9)))
" "))
(defun lsp-bridge-inlay-hint-label-text (label-info)
(format "%s"
(if (listp label-info)
;; We concat value of list if label is list.
(mapconcat (lambda (label)
(plist-get label :value))
label-info
"") ; Separator for mapconcat
;; Otherwise label is string, just return itself.
label-info)))
(defvar lsp-bridge-inlay-hint-lock (make-mutex "lsp-bridge-inlay-hint-lock"))
(defun lsp-bridge-inlay-hint--render (filepath filehost inlay-hints)
;; lsp-bridge is too fast, use locks to avoid interface disorder issues caused by multi-threaded rendering of overlays
(with-mutex lsp-bridge-inlay-hint-lock
(lsp-bridge--with-file-buffer
filepath filehost
(unless (or (equal inlay-hints lsp-bridge-inlay-hint-cache)
(and lsp-bridge-inlay-hint-cache
(time-less-p (time-since lsp-bridge-inlay-hint-cache-time) 0.5)))
;; Hide previous overlays first.
(lsp-bridge-inlay-hint-hide-overlays)
(setq-local lsp-bridge-inlay-hint-cache inlay-hints)
(setq-local lsp-bridge-inlay-hint-cache-time (current-time))
;; Render new overlays.
(save-excursion
(save-restriction
(let ((hint-index 0))
(dolist (hint inlay-hints)
(goto-char (acm-backend-lsp-position-to-point (plist-get hint :position)))
(let* ((hint-kind (plist-get hint :kind))
;; InlayHintKind is 1 mean is an inlay hint that for a type annotation.
;; 2 mean is an inlay hint that is for a parameter.
;; type annotation is hint need render at end of line, we use `after-string' overlay to implement it.
(hint-render-use-after-string-p (eql hint-kind 1))
;; Hint text need concat padding-left, label and padding-right.
(hint-text (concat
(lsp-bridge-inlay-hint-padding-text (plist-get hint :paddingLeft) t)
(lsp-bridge-inlay-hint-label-text (plist-get hint :label))
(lsp-bridge-inlay-hint-padding-text (plist-get hint :paddingRight) nil)))
(overlay (if hint-render-use-after-string-p
(make-overlay (point) (1+ (point)) nil t)
(make-overlay (1- (point)) (point) nil nil nil))))
(when (and (equal hint-index 0)
hint-render-use-after-string-p)
(put-text-property 0 1 'cursor 1 hint-text))
(overlay-put overlay
(if hint-render-use-after-string-p 'before-string 'after-string)
(propertize hint-text 'face 'lsp-bridge-inlay-hint-face))
(overlay-put overlay 'evaporate t) ; NOTE, `evaporate' is import
(push overlay lsp-bridge-inlay-hint-overlays)
(setq hint-index (1+ hint-index))
)))))))))
(defun lsp-bridge-inlay-hint-retry (filepath)
"InlayHint will got error 'content modified' error if it followed immediately by a didChange request.
If lsp-bridge detect this error, lsp-bridge will call `lsp-bridge-inlay-hint-retry' function again to avoid inlayHint request no respond."
(when (string-prefix-p "file://" filepath)
(setq filepath (string-remove-prefix "file://" filepath)))
(when (string-equal filepath (buffer-file-name))
(lsp-bridge-inlay-hint-try-send-request)))
(provide 'lsp-bridge-inlay-hint)
;;; lsp-bridge-inlay-hint.el ends here