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
|
;;; lsp-verilog.el --- Verilog Client settings -*- lexical-binding: t; -*-
;; Copyright (C) 2019 Patrick Grogan
;; Author: Patrick Grogan <pogrogan@gmail.com>
;; Created: 7 December 2019
;; Keywords: languages, lsp, verilog
;; 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 client support for Verilog/SystemVerilog. Two language servers
;; are available:
;; 1) HDL Checker. See https://github.com/suoto/hdl_checker
;; 2) SVLangserver. See https://github.com/imc-trading/svlangserver
;;
;; This file is based on the lsp-vhdl.el file.
;;
;;; Code:
(require 'lsp-mode)
(defgroup lsp-svlangserver nil
"Settings for the SystemVerilog language server client."
:group 'lsp-mode
:link '(url-link "https://github.com/imc-trading/svlangserver")
:package-version '(lsp-mode . "8.0.0"))
(defcustom lsp-clients-svlangserver-includeIndexing '["**/*.{sv,svh}"]
"Files included for indexing (glob pattern)"
:group 'lsp-svlangserver
:type '(lsp-repeatable-vector string)
:safe (lambda (x) (seq-every-p #'stringp x)))
(defcustom lsp-clients-svlangserver-excludeIndexing '["test/**/*.{sv,svh}"]
"Files excluded for indexing (glob pattern)"
:group 'lsp-svlangserver
:type '(lsp-repeatable-vector string)
:safe (lambda (x) (seq-every-p #'stringp x)))
(defcustom lsp-clients-svlangserver-defines nil
"Defines needed for linting"
:group 'lsp-svlangserver
:type '(lsp-repeatable-vector string)
:safe (lambda (x) (seq-every-p #'stringp x)))
(defcustom lsp-clients-svlangserver-launchConfiguration "verilator -sv --lint-only -Wall"
"Verilator command used for linting"
:group 'lsp-svlangserver
:type 'string
:safe (lambda (x) (stringp x)))
(defcustom lsp-clients-svlangserver-lintOnUnsaved t
"Enable linting on unsaved files"
:group 'lsp-svlangserver
:type 'boolean
:safe (lambda (x) (booleanp x)))
(defcustom lsp-clients-svlangserver-formatCommand "verible-verilog-format"
"Verible verilog format command"
:group 'lsp-svlangserver
:type 'string
:safe (lambda (x) (stringp x)))
(defcustom lsp-clients-svlangserver-disableCompletionProvider nil
"Disable auto completion provided by the language server"
:group 'lsp-svlangserver
:type 'boolean
:safe (lambda (x) (booleanp x)))
(defcustom lsp-clients-svlangserver-disableHoverProvider nil
"Disable hover over help provided by the language server"
:group 'lsp-svlangserver
:type 'boolean
:safe (lambda (x) (booleanp x)))
(defcustom lsp-clients-svlangserver-disableSignatureHelpProvider nil
"Disable signature help provided by the language server"
:group 'lsp-svlangserver
:type 'boolean
:safe (lambda (x) (booleanp x)))
(defcustom lsp-clients-svlangserver-disableLinting nil
"Disable verilator linting"
:group 'lsp-svlangserver
:type 'boolean
:safe (lambda (x) (booleanp x)))
(defcustom lsp-clients-svlangserver-workspace-additional-dirs nil
"Additional directories to be managed by this instance of svlangserver"
:group 'lsp-svlangserver
:type '(lsp-repeatable-vector string)
:safe (lambda (x) (seq-every-p #'stringp x)))
(defcustom lsp-clients-svlangserver-bin-path "svlangserver"
"svlangserver binary path"
:group 'lsp-svlangserver
:type 'string
:safe (lambda (x) (stringp x)))
(defcustom lsp-clients-svlangserver-bin-args nil
"command line arguments for svlangserver binary"
:group 'lsp-svlangserver
:type '(lsp-repeatable-vector string)
:safe (lambda (x) (seq-every-p #'stringp x)))
(defcustom lsp-clients-svlangserver-node-command "node"
"node binary path"
:group 'lsp-svlangserver
:type 'string
:safe (lambda (x) (stringp x)))
(defcustom lsp-clients-svlangserver-module-path "svlangserver.js"
"svlangserver module path"
:group 'lsp-svlangserver
:type 'string
:safe (lambda (x) (stringp x)))
(defun lsp-clients-svlangserver-build-index ()
(interactive)
(lsp-send-execute-command "systemverilog.build_index"))
(defun lsp-clients-svlangserver-report-hierarchy (container-name)
(interactive (list (read-string "Module/interface: " (cond ((use-region-p) (buffer-substring (region-beginning) (region-end))) (t "")))))
(lsp-send-execute-command "systemverilog.report_hierarchy" (vector container-name)))
(lsp-dependency 'svlangserver
'(:system "svlangserver"))
(defun lsp-clients-svlangserver-get-workspace-additional-dirs (_workspace)
lsp-clients-svlangserver-workspace-additional-dirs)
(defun lsp-clients-svlangserver-command ()
(let ((svlangserver-bin-path (lsp-package-path 'svlangserver)))
(if svlangserver-bin-path
(cons svlangserver-bin-path lsp-clients-svlangserver-bin-args)
(if (file-exists-p lsp-clients-svlangserver-bin-path)
(cons lsp-clients-svlangserver-bin-path lsp-clients-svlangserver-bin-args)
(if (file-exists-p lsp-clients-svlangserver-module-path)
`(,lsp-clients-svlangserver-node-command ,lsp-clients-svlangserver-module-path ,"--stdio")
`(,"svlangserver"))))))
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection 'lsp-clients-svlangserver-command)
:major-modes '(verilog-mode)
:priority -1
:library-folders-fn 'lsp-clients-svlangserver-get-workspace-additional-dirs
:server-id 'svlangserver))
(lsp-register-custom-settings '(("systemverilog.includeIndexing" lsp-clients-svlangserver-includeIndexing)
("systemverilog.excludeIndexing" lsp-clients-svlangserver-excludeIndexing)
("systemverilog.defines" lsp-clients-svlangserver-defines)
("systemverilog.launchConfiguration" lsp-clients-svlangserver-launchConfiguration)
("systemverilog.lintOnUnsaved" lsp-clients-svlangserver-lintOnUnsaved)
("systemverilog.formatCommand" lsp-clients-svlangserver-formatCommand)
("systemverilog.disableCompletionProvider" lsp-clients-svlangserver-disableCompletionProvider)
("systemverilog.disableHoverProvider" lsp-clients-svlangserver-disableHoverProvider)
("systemverilog.disableSignatureHelpProvider" lsp-clients-svlangserver-disableSignatureHelpProvider)
("systemverilog.disableLinting" lsp-clients-svlangserver-disableLinting)))
(defgroup lsp-verilog nil
"LSP support for Verilog/SystemVerilog."
:group 'lsp-mode
:link '(url-link "https://github.com/suoto/hdl_checker"))
(defcustom lsp-clients-verilog-executable '("hdl_checker" "--lsp")
"Command to start the hdl_checker language server."
:group 'lsp-verilog
:risky t
:type 'file)
(lsp-register-client
(make-lsp-client :new-connection (lsp-stdio-connection lsp-clients-verilog-executable)
:major-modes '(verilog-mode)
:language-id "verilog"
:priority -2
:server-id 'lsp-verilog))
(lsp-consistency-check lsp-verilog)
(provide 'lsp-verilog)
;;; lsp-verilog.el ends here
|
