forked from emacs-lsp/lsp-mode
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lsp-modeline.el
354 lines (308 loc) · 14.7 KB
/
lsp-modeline.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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
;;; lsp-modeline.el --- LSP modeline features -*- lexical-binding: t; -*-
;;
;; Copyright (C) 2020 emacs-lsp maintainers
;;
;; 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 <https://www.gnu.org/licenses/>.
;;
;;; Commentary:
;;
;; LSP modeline
;;
;;; Code:
(require 'lsp-mode)
(defgroup lsp-modeline nil
"LSP support for modeline"
:prefix "lsp-modeline-"
:group 'lsp-mode
:tag "LSP Modeline")
(defcustom lsp-modeline-code-actions-kind-regex "$\\|quickfix.*\\|refactor.*"
"Regex for the code actions kinds to show in the modeline."
:type 'string
:group 'lsp-modeline)
(defcustom lsp-modeline-code-actions-segments '(count icon)
"Define what should display on the modeline when code actions are available."
:type '(repeat (choice
(const :tag "Show the lightbulb icon" icon)
(const :tag "Show the name of the preferred code action" name)
(const :tag "Show the count of how many code actions available" count)))
:group 'lsp-modeline
:package-version '(lsp-mode . "7.1"))
(defcustom lsp-modeline-code-action-fallback-icon "💡"
"Define what should display on the modeline when code actions are available."
:type 'string
:group 'lsp-modeline
:package-version '(lsp-mode . "7.1"))
(defface lsp-modeline-code-actions-face
'((t :inherit homoglyph))
"Face used to code action text on modeline."
:group 'lsp-modeline)
(defface lsp-modeline-code-actions-preferred-face
'((t :foreground "yellow"))
"Face used to code action text on modeline."
:group 'lsp-modeline)
;;;###autoload
(define-obsolete-variable-alias 'lsp-diagnostics-modeline-scope
'lsp-modeline-diagnostics-scope "lsp-mode 7.0.1")
(defcustom lsp-modeline-diagnostics-scope :workspace
"The modeline diagnostics scope."
:group 'lsp-modeline
:type '(choice (const :tag "File" :file)
(const :tag "Project" :workspace)
(const :tag "All Projects" :global))
:package-version '(lsp-mode . "6.3"))
(declare-function all-the-icons-octicon "ext:all-the-icons" t t)
(declare-function lsp-treemacs-errors-list "ext:lsp-treemacs" t)
;; code actions
(defvar-local lsp-modeline--code-actions-string nil
"Holds the current code action string on modeline.")
(defun lsp-modeline--code-action-face (preferred-code-action)
"Return the face checking if there is any PREFERRED-CODE-ACTION."
(if preferred-code-action
'lsp-modeline-code-actions-preferred-face
'lsp-modeline-code-actions-face))
(defun lsp-modeline--code-actions-icon (face)
"Build the icon for modeline code actions using FACE."
(if (require 'all-the-icons nil t)
(all-the-icons-octicon "light-bulb"
:face face
:v-adjust -0.0575)
(propertize lsp-modeline-code-action-fallback-icon 'face face)))
(defun lsp-modeline--code-action-name (actions preferred-code-action-title)
"Return the code action name from ACTIONS and PREFERRED-CODE-ACTION-TITLE."
(or preferred-code-action-title
(->> actions
lsp-seq-first
lsp-modeline--code-action->string)))
(defun lsp-modeline--code-action->string (action)
"Convert code ACTION to friendly string."
(->> action
lsp:code-action-title
(replace-regexp-in-string "[\n\t ]+" " ")))
(defun lsp-modeline--build-code-actions-segments (actions)
"Build the code ACTIONS string from the defined segments."
(let* ((preferred-code-action (-some->> actions
(-first #'lsp:code-action-is-preferred?)
lsp-modeline--code-action->string))
(face (lsp-modeline--code-action-face preferred-code-action)))
(mapconcat
(lambda (segment)
(pcase segment
('icon (lsp-modeline--code-actions-icon face))
('name (propertize (lsp-modeline--code-action-name actions preferred-code-action)
'face face))
('count (propertize (number-to-string (seq-length actions))
'face face))))
lsp-modeline-code-actions-segments " ")))
(defun lsp-modeline--build-code-actions-string (actions)
"Build the string to be presented on modeline for code ACTIONS."
(-let* ((single-action? (= (length actions) 1))
(keybinding (concat "("
(-some->> #'lsp-execute-code-action
where-is-internal
(-find (lambda (o)
(not (member (aref o 0) '(menu-bar normal-state)))))
key-description)
")"))
(built-string (lsp-modeline--build-code-actions-segments actions))
(preferred-code-action (-some->> actions
(-first #'lsp:code-action-is-preferred?)
lsp-modeline--code-action->string)))
(add-text-properties 0 (length built-string)
(list 'help-echo
(concat (format "Apply code actions %s\nmouse-1: " keybinding)
(if single-action?
(lsp-modeline--code-action-name actions preferred-code-action)
"select from multiple code actions"))
'mouse-face 'mode-line-highlight
'local-map (make-mode-line-mouse-map
'mouse-1 (lambda ()
(interactive)
(if single-action?
(lsp-execute-code-action (lsp-seq-first actions))
(lsp-execute-code-action (lsp--select-action actions))))))
built-string)
(unless (string= "" built-string)
(concat built-string " "))))
(defun lsp--modeline-update-code-actions (actions)
"Update modeline with new code ACTIONS."
(when lsp-modeline-code-actions-kind-regex
(setq actions (seq-filter (-lambda ((&CodeAction :kind?))
(or (not kind?)
(s-match lsp-modeline-code-actions-kind-regex kind?)))
actions)))
(setq lsp-modeline--code-actions-string
(if (seq-empty-p actions) ""
(lsp-modeline--build-code-actions-string actions)))
(force-mode-line-update))
(defun lsp-modeline--check-code-actions (&rest _)
"Request code actions to update modeline for given BUFFER."
(when (lsp-feature? "textDocument/codeAction")
(lsp-request-async
"textDocument/codeAction"
(lsp--text-document-code-action-params)
#'lsp--modeline-update-code-actions
:mode 'unchanged
:cancel-token :lsp-modeline-code-actions)))
(defun lsp-modeline--enable-code-actions ()
"Enable code actions on modeline mode."
(when (and lsp-modeline-code-actions-enable
(lsp-feature? "textDocument/codeAction"))
(lsp-modeline-code-actions-mode 1)))
(defun lsp-modeline--disable-code-actions ()
"Disable code actions on modeline mode."
(lsp-modeline-code-actions-mode -1))
;;;###autoload
(define-minor-mode lsp-modeline-code-actions-mode
"Toggle code actions on modeline."
:group 'lsp-modeline
:global nil
:lighter ""
(cond
(lsp-modeline-code-actions-mode
(add-to-list 'global-mode-string '(t (:eval lsp-modeline--code-actions-string)))
(add-hook 'lsp-on-idle-hook 'lsp-modeline--check-code-actions nil t)
(add-hook 'lsp-configure-hook #'lsp-modeline--enable-code-actions nil t)
(add-hook 'lsp-unconfigure-hook #'lsp-modeline--disable-code-actions nil t))
(t
(remove-hook 'lsp-on-idle-hook 'lsp-modeline--check-code-actions t)
(remove-hook 'lsp-configure-hook #'lsp-modeline--enable-code-actions t)
(remove-hook 'lsp-unconfigure-hook #'lsp-modeline--disable-code-actions t)
(setq global-mode-string (remove '(t (:eval lsp-modeline--code-actions-string)) global-mode-string)))))
;; diagnostics
(defvar-local lsp-modeline--diagnostics-string nil
"Value of current buffer diagnostics statistics.")
(defvar lsp-modeline--diagnostics-wks->strings nil
"Plist of workspaces to their modeline strings.
The `:global' workspace is global one.")
(defun lsp-modeline-diagnostics-statistics ()
"Calculate diagnostics statistics based on `lsp-modeline-diagnostics-scope'."
(let ((diagnostics (cond
((equal :file lsp-modeline-diagnostics-scope)
(list (lsp--get-buffer-diagnostics)))
(t (->> (eq :workspace lsp-modeline-diagnostics-scope)
(lsp-diagnostics)
(ht-values)))))
(stats (make-vector lsp/diagnostic-severity-max 0))
strs
(i 0))
(mapc (lambda (buf-diags)
(mapc (lambda (diag)
(-let [(&Diagnostic? :severity?) diag]
(when severity?
(cl-incf (aref stats severity?)))))
buf-diags))
diagnostics)
(while (< i lsp/diagnostic-severity-max)
(when (> (aref stats i) 0)
(setq strs
(nconc strs
`(,(propertize
(format "%s" (aref stats i))
'face
(cond
((= i lsp/diagnostic-severity-error) 'error)
((= i lsp/diagnostic-severity-warning) 'warning)
((= i lsp/diagnostic-severity-information) 'success)
((= i lsp/diagnostic-severity-hint) 'success)))))))
(cl-incf i))
(-> (s-join "/" strs)
(propertize 'mouse-face 'mode-line-highlight
'help-echo "mouse-1: Show diagnostics"
'local-map (when (require 'lsp-treemacs nil t)
(make-mode-line-mouse-map
'mouse-1 #'lsp-treemacs-errors-list))))))
(defun lsp-modeline--diagnostics-reset-modeline-cache ()
"Reset the modeline diagnostics cache."
(plist-put lsp-modeline--diagnostics-wks->strings (car (lsp-workspaces)) nil)
(plist-put lsp-modeline--diagnostics-wks->strings :global nil)
(setq lsp-modeline--diagnostics-string nil))
(defun lsp-modeline--diagnostics-update-modeline ()
"Update diagnostics modeline string."
(cl-labels ((calc-modeline ()
(let ((str (lsp-modeline-diagnostics-statistics)))
(if (string-empty-p str) ""
(concat str " ")))))
(setq lsp-modeline--diagnostics-string
(cl-case lsp-modeline-diagnostics-scope
(:file (or lsp-modeline--diagnostics-string
(calc-modeline)))
(:workspace
(let ((wk (car (lsp-workspaces))))
(or (plist-get lsp-modeline--diagnostics-wks->strings wk)
(let ((ml (calc-modeline)))
(setq lsp-modeline--diagnostics-wks->strings
(plist-put lsp-modeline--diagnostics-wks->strings wk ml))
ml))))
(:global
(or (plist-get lsp-modeline--diagnostics-wks->strings :global)
(let ((ml (calc-modeline)))
(setq lsp-modeline--diagnostics-wks->strings
(plist-put lsp-modeline--diagnostics-wks->strings :global ml))
ml)))))))
(defun lsp-modeline--enable-diagnostics ()
"Enable diagnostics on modeline mode."
(when (and lsp-modeline-diagnostics-enable
(lsp-feature? "textDocument/publishDiagnostics"))
(lsp-modeline-diagnostics-mode 1)))
(defun lsp-modeline--disable-diagnostics ()
"Disable diagnostics on modeline mode."
(lsp-modeline-diagnostics-mode -1))
;;;###autoload
(define-obsolete-function-alias 'lsp-diagnostics-modeline-mode
'lsp-modeline-diagnostics-mode "lsp-mode 7.0.1")
;;;###autoload
(define-minor-mode lsp-modeline-diagnostics-mode
"Toggle diagnostics modeline."
:group 'lsp-modeline
:global nil
:lighter ""
(cond
(lsp-modeline-diagnostics-mode
(add-hook 'lsp-configure-hook #'lsp-modeline--enable-diagnostics nil t)
(add-hook 'lsp-unconfigure-hook #'lsp-modeline--disable-diagnostics nil t)
(add-to-list 'global-mode-string '(t (:eval (lsp-modeline--diagnostics-update-modeline))))
(add-hook 'lsp-diagnostics-updated-hook 'lsp-modeline--diagnostics-reset-modeline-cache))
(t
(remove-hook 'lsp-configure-hook #'lsp-modeline--enable-diagnostics t)
(remove-hook 'lsp-unconfigure-hook #'lsp-modeline--disable-diagnostics t)
(remove-hook 'lsp-diagnostics-updated-hook 'lsp-modeline--diagnostics-reset-modeline-cache)
(setq global-mode-string (remove '(t (:eval (lsp-modeline--diagnostics-update-modeline))) global-mode-string)))))
;; workspace status
(defun lsp-modeline--workspace-status-string ()
"Build the workspace status string."
'(t (:eval (-keep #'lsp--workspace-status-string (lsp-workspaces)))))
(defun lsp-modeline--enable-workspace-status ()
"Enable workspace status on modeline."
(let ((status (lsp-modeline--workspace-status-string)))
(setq-local global-mode-string (if (-contains? global-mode-string status)
global-mode-string
(cons status global-mode-string)))))
(defun lsp-modeline--disable-workspace-status ()
"Disable workspace status on modeline."
(let ((status (lsp-modeline--workspace-status-string)))
(setq-local global-mode-string (remove status global-mode-string))))
;;;###autoload
(define-minor-mode lsp-modeline-workspace-status-mode
"Toggle workspace status on modeline."
:group 'lsp-modeline
:global nil
:lighter ""
(cond
(lsp-modeline-workspace-status-mode
(add-hook 'lsp-configure-hook #'lsp-modeline--enable-workspace-status nil t)
(add-hook 'lsp-unconfigure-hook #'lsp-modeline--disable-workspace-status nil t))
(t
(remove-hook 'lsp-configure-hook #'lsp-modeline--enable-workspace-status t)
(remove-hook 'lsp-unconfigure-hook #'lsp-modeline--disable-workspace-status t))))
(lsp-consistency-check lsp-modeline)
(provide 'lsp-modeline)
;;; lsp-modeline.el ends here