summaryrefslogtreecommitdiff
path: root/tests/test_hdl.py
blob: ec4028ec4bbac039b3399b0d5a0c3931d7113b04 (plain)
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
# -*- coding: utf-8 -*-
"""
    HDL Tests
    ~~~~~~~~~

    :copyright: Copyright 2006-2019 by the Pygments team, see AUTHORS.
    :license: BSD, see LICENSE for details.
"""

import pytest

from pygments.lexers import SystemVerilogLexer
from pygments.token import (Comment, Keyword, Name, Number, Operator,
                            Punctuation, Text)


@pytest.fixture(scope='module')
def lexer():
    yield SystemVerilogLexer()


SYSTEMVERILOG_BASIC_FRAGMENT = """\
// Adder flops the sum of its inputs
module Adder #(
    parameter int N = 42
) (
    output logic [N-1:0] y,
    output logic         co,

    input  logic [N-1:0] a,
    input  logic [N-1:0] b,
    input  logic         ci,

    input  logic clk
);
    always_ff @(posedge clk) begin
        {co, y} <= a + b + ci;
    end
endmodule : Adder
"""

def test_systemverilog_basic(lexer):
    """A basic SystemVerilog test.

    Examine tokens emitted by the SV lexer for a trivial module.
    Not intended to stress any particular corner of the language.
    """
    tokens = [
        (Comment.Single, '// Adder flops the sum of its inputs\n'),
        (Keyword, 'module'),
        (Text, ' '),
        (Name, 'Adder'),
        (Text, ' '),
        (Punctuation, '#'),
        (Punctuation, '('),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'parameter'),
        (Text, ' '),
        (Keyword.Type, 'int'),
        (Text, ' '),
        (Name, 'N'),
        (Text, ' '),
        (Operator, '='),
        (Text, ' '),
        (Number.Integer, '42'),
        (Text, '\n'),

        (Punctuation, ')'),
        (Text, ' '),
        (Punctuation, '('),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'output'),
        (Text, ' '),
        (Keyword.Type, 'logic'),
        (Text, ' '),
        (Punctuation, '['),
        (Name, 'N'),
        (Operator, '-'),
        (Number.Integer, '1'),
        (Operator, ':'),
        (Number.Integer, '0'),
        (Punctuation, ']'),
        (Text, ' '),
        (Name, 'y'),
        (Punctuation, ','),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'output'),
        (Text, ' '),
        (Keyword.Type, 'logic'),
        (Text, '         '),
        (Name, 'co'),
        (Punctuation, ','),
        (Text, '\n'),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'input'),
        (Text, '  '),
        (Keyword.Type, 'logic'),
        (Text, ' '),
        (Punctuation, '['),
        (Name, 'N'),
        (Operator, '-'),
        (Number.Integer, '1'),
        # Note: This ':' should be Punctuation
        (Operator, ':'),
        (Number.Integer, '0'),
        (Punctuation, ']'),
        (Text, ' '),
        (Name, 'a'),
        (Punctuation, ','),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'input'),
        (Text, '  '),
        (Keyword.Type, 'logic'),
        (Text, ' '),
        (Punctuation, '['),
        (Name, 'N'),
        (Operator, '-'),
        (Number.Integer, '1'),
        (Operator, ':'),
        (Number.Integer, '0'),
        (Punctuation, ']'),
        (Text, ' '),
        (Name, 'b'),
        (Punctuation, ','),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'input'),
        (Text, '  '),
        (Keyword.Type, 'logic'),
        (Text, '         '),
        (Name, 'ci'),
        (Punctuation, ','),
        (Text, '\n'),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'input'),
        (Text, '  '),
        (Keyword.Type, 'logic'),
        (Text, ' '),
        (Name, 'clk'),
        (Text, '\n'),

        (Punctuation, ')'),
        (Punctuation, ';'),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'always_ff'),
        (Text, ' '),
        (Punctuation, '@'),
        (Punctuation, '('),
        (Keyword, 'posedge'),
        (Text, ' '),
        (Name, 'clk'),
        (Punctuation, ')'),
        (Text, ' '),
        (Keyword, 'begin'),
        (Text, '\n'),

        (Text, '        '),
        (Punctuation, '{'),
        (Name, 'co'),
        (Punctuation, ','),
        (Text, ' '),
        (Name, 'y'),
        (Punctuation, '}'),
        (Text, ' '),
        (Operator, '<'),
        (Operator, '='),
        (Text, ' '),
        (Name, 'a'),
        (Text, ' '),
        (Operator, '+'),
        (Text, ' '),
        (Name, 'b'),
        (Text, ' '),
        (Operator, '+'),
        (Text, ' '),
        (Name, 'ci'),
        (Punctuation, ';'),
        (Text, '\n'),

        (Text, '    '),
        (Keyword, 'end'),
        (Text, '\n'),

        (Keyword, 'endmodule'),
        (Text, ' '),
        (Operator, ':'),
        (Text, ' '),
        (Name, 'Adder'),
        (Text, '\n'),
    ]
    assert list(lexer.get_tokens(SYSTEMVERILOG_BASIC_FRAGMENT)) == tokens


# Believe it or not, SystemVerilog supports spaces before and after the base
# specifier (ie 'b, 'd, 'h). See IEEE 1800-2017 Section 5.7.1 for examples.
SVNUMS = """
8'b10101010
8 'b10101010
8'b 10101010
8'sb10101010
8'Sb10101010
8'B10101010
8'b1010_1010
8'b10xXzZ?10

24'o01234567
24 'o01234567
24'o 01234567
24'so01234567
24'So01234567
24'O01234567
24'o0123_4567
24'o01xXzZ?7

32'd27182818
32 'd27182818
32'd 27182818
32'sd27182818
32'Sd27182818
32'D27182818
32'd2718_2818
32'd27xXzZ?8

32'hdeadbeef
32 'hdeadbeef
32'h deadbeef
32'shdeadbeef
32'Shdeadbeef
32'Hdeadbeef
32'hdead_beef
32'hdexXzZ?f

'0 '1 'x 'X 'z 'Z

42 1234_5678
"""

def test_systemverilog_numbers(lexer):
    """Test most types of numbers"""

    tokens = [
        (Number.Bin, "8'b10101010"),
        (Text, '\n'),
        (Number.Bin, "8 'b10101010"),
        (Text, '\n'),
        (Number.Bin, "8'b 10101010"),
        (Text, '\n'),
        (Number.Bin, "8'sb10101010"),
        (Text, '\n'),
        (Number.Bin, "8'Sb10101010"),
        (Text, '\n'),
        (Number.Bin, "8'B10101010"),
        (Text, '\n'),
        (Number.Bin, "8'b1010_1010"),
        (Text, '\n'),
        (Number.Bin, "8'b10xXzZ?10"),
        (Text, '\n'),
        (Text, '\n'),
        (Number.Oct, "24'o01234567"),
        (Text, '\n'),
        (Number.Oct, "24 'o01234567"),
        (Text, '\n'),
        (Number.Oct, "24'o 01234567"),
        (Text, '\n'),
        (Number.Oct, "24'so01234567"),
        (Text, '\n'),
        (Number.Oct, "24'So01234567"),
        (Text, '\n'),
        (Number.Oct, "24'O01234567"),
        (Text, '\n'),
        (Number.Oct, "24'o0123_4567"),
        (Text, '\n'),
        (Number.Oct, "24'o01xXzZ?7"),
        (Text, '\n'),
        (Text, '\n'),
        (Number.Integer, "32'd27182818"),
        (Text, '\n'),
        (Number.Integer, "32 'd27182818"),
        (Text, '\n'),
        (Number.Integer, "32'd 27182818"),
        (Text, '\n'),
        (Number.Integer, "32'sd27182818"),
        (Text, '\n'),
        (Number.Integer, "32'Sd27182818"),
        (Text, '\n'),
        (Number.Integer, "32'D27182818"),
        (Text, '\n'),
        (Number.Integer, "32'd2718_2818"),
        (Text, '\n'),
        (Number.Integer, "32'd27xXzZ?8"),
        (Text, '\n'),
        (Text, '\n'),
        (Number.Hex, "32'hdeadbeef"),
        (Text, '\n'),
        (Number.Hex, "32 'hdeadbeef"),
        (Text, '\n'),
        (Number.Hex, "32'h deadbeef"),
        (Text, '\n'),
        (Number.Hex, "32'shdeadbeef"),
        (Text, '\n'),
        (Number.Hex, "32'Shdeadbeef"),
        (Text, '\n'),
        (Number.Hex, "32'Hdeadbeef"),
        (Text, '\n'),
        (Number.Hex, "32'hdead_beef"),
        (Text, '\n'),
        (Number.Hex, "32'hdexXzZ?f"),
        (Text, '\n'),
        (Text, '\n'),
        (Number, "'0"),
        (Text, ' '),
        (Number, "'1"),
        (Text, ' '),
        (Number, "'x"),
        (Text, ' '),
        (Number, "'X"),
        (Text, ' '),
        (Number, "'z"),
        (Text, ' '),
        (Number, "'Z"),
        (Text, '\n'),
        (Text, '\n'),
        (Number.Integer, '42'),
        (Text, ' '),
        (Number.Integer, '1234_5678'),
        (Text, '\n'),
    ]
    assert list(lexer.get_tokens(SVNUMS)) == tokens