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
|
from pathlib import Path
from unittest import TestCase, expectedFailure
import pyGHDL.libghdl as libghdl
from pyGHDL.libghdl import name_table, files_map, errorout_console, flags
from pyGHDL.libghdl import file_comments
from pyGHDL.libghdl.vhdl import nodes, flists, sem_lib
if __name__ == "__main__":
print("Use: 'python -m unitest <testcase module>'")
exit(1)
class Base(TestCase):
_root = Path(__file__).resolve().parent / "examples"
@staticmethod
def getIdentifier(node) -> str:
"""Return the Python string from node :obj:`node` identifier."""
return name_table.Get_Name_Ptr(nodes.Get_Identifier(node))
@classmethod
def setUpClass(cls):
libghdl.initialize()
# Print error messages on the console.
errorout_console.Install_Handler()
# Set options. This must be done before analyze_init()
flags.Flag_Gather_Comments.value = True
libghdl.set_option("--std=08")
# Finish initialization. This will load the standard package.
if libghdl.analyze_init_status() != 0:
cls.fail("libghdl initialization error")
def checkComments(self, node, name) -> None:
f = files_map.Location_To_File(nodes.Get_Location(node))
idx = file_comments.Find_First_Comment(f, node)
while idx != file_comments.No_Comment_Index:
commentText = file_comments.Get_Comment(f, idx)
commentStart = file_comments.Get_Comment_Start(f, idx)
commentEnd = file_comments.Get_Comment_Last(f, idx)
self.assertTrue(commentText.find(':'+name+':') >= 0, f"no :{name}: in [{commentStart}..{commentEnd}] '{commentText}'({len(commentText)})")
idx = file_comments.Get_Next_Comment(f, idx)
def checkFlist(self, flist) -> None:
for i in range(flists.Length(flist)):
e = flists.Get_Nth_Element(flist, i)
self.checkComments(e, self.getIdentifier(e))
def checkDecls(self, first) -> None:
decl = first
while decl != nodes.Null_Iir:
k = nodes.Get_Kind(decl)
if (k not in nodes.Iir_Kinds.Specification
and k not in nodes.Iir_Kinds.Clause):
self.checkComments(decl, self.getIdentifier(decl))
if k == nodes.Iir_Kind.Type_Declaration:
tdef = nodes.Get_Type_Definition(decl)
defk = nodes.Get_Kind(tdef)
if defk == nodes.Iir_Kind.Record_Type_Definition:
self.checkFlist(nodes.Get_Elements_Declaration_List(tdef))
elif defk == nodes.Iir_Kind.Enumeration_Type_Definition:
self.checkFlist(nodes.Get_Enumeration_Literal_List(tdef))
elif k in nodes.Iir_Kinds.Subprogram_Declaration:
self.checkDecls(nodes.Get_Interface_Declaration_Chain(decl))
decl = nodes.Get_Chain(decl)
def checkConc(self, first) -> None:
stmt = first
while stmt != nodes.Null_Iir:
k = nodes.Get_Kind(stmt)
if k in nodes.Iir_Kinds.Process_Statement:
self.checkDecls(nodes.Get_Declaration_Chain(stmt))
id = nodes.Get_Identifier(stmt)
if id != name_table.Null_Identifier:
self.checkComments(stmt, name_table.Get_Name_Ptr(id))
stmt = nodes.Get_Chain(stmt)
def checkFile(self, filename) -> None:
# Load the file
file_id = name_table.Get_Identifier(str(filename))
sfe = files_map.Read_Source_File(name_table.Null_Identifier, file_id)
if sfe == files_map.No_Source_File_Entry:
self.fail(f"Cannot read file '{filename!s}'")
# Parse
file = sem_lib.Load_File(sfe)
# Display all design units
designUnit = nodes.Get_First_Design_Unit(file)
while designUnit != nodes.Null_Iir:
unit = nodes.Get_Library_Unit(designUnit)
k = nodes.Get_Kind(unit)
name = self.getIdentifier(unit)
if k == nodes.Iir_Kind.Entity_Declaration:
self.checkComments(designUnit, name)
self.checkComments(unit, name)
self.checkDecls(nodes.Get_Generic_Chain(unit))
self.checkDecls(nodes.Get_Port_Chain(unit))
elif k == nodes.Iir_Kind.Architecture_Body:
self.checkComments(designUnit, name)
self.checkComments(unit, name)
self.checkDecls(nodes.Get_Declaration_Chain(unit))
self.checkConc(nodes.Get_Concurrent_Statement_Chain(unit))
elif k == nodes.Iir_Kind.Package_Declaration:
self.checkComments(designUnit, name)
self.checkComments(unit, name)
self.checkDecls(nodes.Get_Declaration_Chain(unit))
elif k == nodes.Iir_Kind.Context_Declaration:
self.checkComments(designUnit, name)
self.checkComments(unit, name)
elif k == nodes.Iir_Kind.Configuration_Declaration:
self.checkComments(designUnit, name)
self.checkComments(unit, name)
else:
self.fail("Unknown unit.")
designUnit = nodes.Get_Chain(designUnit)
class CommentAssociation(Base):
def test_Comments(self) -> None:
"""Very first test"""
self.checkFile(self._root / "comments/DesignComment.vhdl")
def test_entity_before(self) -> None:
self.checkFile(self._root / "comments/ent_bef.vhdl")
def test_arch_before(self) -> None:
self.checkFile(self._root / "comments/arch_bef.vhdl")
def test_pkg_before(self) -> None:
self.checkFile(self._root / "comments/pkg_bef.vhdl")
def test_ctxt_before(self) -> None:
self.checkFile(self._root / "comments/ctxt_bef.vhdl")
def test_conf_before(self) -> None:
self.checkFile(self._root / "comments/conf_bef.vhdl")
def test_entity_inside(self) -> None:
self.checkFile(self._root / "comments/ent_inside.vhdl")
def test_entity_arch(self) -> None:
self.checkFile(self._root / "comments/ent_arch.vhdl")
@expectedFailure
def test_arch_inside_fail(self) -> None:
self.checkFile(self._root / "comments/arch_inside_fail.vhdl")
def test_arch_inside(self) -> None:
self.checkFile(self._root / "comments/arch_inside.vhdl")
def test_arch_inside_2(self) -> None:
self.checkFile(self._root / "comments/arch_inside_2.vhdl")
@expectedFailure
def test_pkg_inside_fail(self) -> None:
self.checkFile(self._root / "comments/pkg_inside_fail.vhdl")
@expectedFailure
def test_pkg_inside_fail2(self) -> None:
self.checkFile(self._root / "comments/pkg_inside_fail2.vhdl")
def test_pkg_inside(self) -> None:
self.checkFile(self._root / "comments/pkg_inside.vhdl")
@expectedFailure
def test_ctxt_inside_fail(self) -> None:
self.checkFile(self._root / "comments/ctxt_inside_fail.vhdl")
def test_ctxt_inside(self) -> None:
self.checkFile(self._root / "comments/ctxt_inside.vhdl")
@expectedFailure
def test_conf_inside_fail(self) -> None:
self.checkFile(self._root / "comments/conf_inside_fail.vhdl")
def test_conf_inside(self) -> None:
self.checkFile(self._root / "comments/conf_inside.vhdl")
@expectedFailure
def test_const_fail(self) -> None:
self.checkFile(self._root / "comments/const_fail.vhdl")
def test_const(self) -> None:
self.checkFile(self._root / "comments/const.vhdl")
@expectedFailure
def test_sig_fail(self) -> None:
self.checkFile(self._root / "comments/sig_fail.vhdl")
def test_sig(self) -> None:
self.checkFile(self._root / "comments/sig.vhdl")
def test_sig_2(self) -> None:
self.checkFile(self._root / "comments/sig_2.vhdl")
@expectedFailure
def test_var_fail(self) -> None:
self.checkFile(self._root / "comments/var_fail.vhdl")
def test_var(self) -> None:
self.checkFile(self._root / "comments/var.vhdl")
@expectedFailure
def test_type_fail(self) -> None:
self.checkFile(self._root / "comments/type_fail.vhdl")
def test_type(self) -> None:
self.checkFile(self._root / "comments/type.vhdl")
def test_array(self) -> None:
self.checkFile(self._root / "comments/array.vhdl")
@expectedFailure
def test_record_fail(self) -> None:
self.checkFile(self._root / "comments/record_fail.vhdl")
def test_record(self) -> None:
self.checkFile(self._root / "comments/record.vhdl")
@expectedFailure
def test_elements_fail(self) -> None:
self.checkFile(self._root / "comments/elements_fail.vhdl")
def test_element_1(self) -> None:
self.checkFile(self._root / "comments/element_1.vhdl")
def test_element_2(self) -> None:
self.checkFile(self._root / "comments/element_2.vhdl")
def test_element_3(self) -> None:
self.checkFile(self._root / "comments/element_3.vhdl")
def test_element_4(self) -> None:
self.checkFile(self._root / "comments/element_4.vhdl")
@expectedFailure
def test_enum_fail(self) -> None:
self.checkFile(self._root / "comments/enum_fail.vhdl")
def test_enum(self) -> None:
self.checkFile(self._root / "comments/enum.vhdl")
@expectedFailure
def test_enumlit_fail(self) -> None:
self.checkFile(self._root / "comments/enumlit_fail.vhdl")
def test_enumlit_1(self) -> None:
self.checkFile(self._root / "comments/enumlit_1.vhdl")
def test_enumlit_2(self) -> None:
self.checkFile(self._root / "comments/enumlit_2.vhdl")
def test_enumlit_3(self) -> None:
self.checkFile(self._root / "comments/enumlit_3.vhdl")
@expectedFailure
def test_func_fail(self) -> None:
self.checkFile(self._root / "comments/func_fail.vhdl")
def test_func(self) -> None:
self.checkFile(self._root / "comments/func.vhdl")
@expectedFailure
def test_func_param_fail(self) -> None:
self.checkFile(self._root / "comments/func_param_fail.vhdl")
def test_func_param(self) -> None:
self.checkFile(self._root / "comments/func_param.vhdl")
@expectedFailure
def test_process_fail(self) -> None:
self.checkFile(self._root / "comments/process_fail.vhdl")
def test_process(self) -> None:
self.checkFile(self._root / "comments/process.vhdl")
def test_multi1(self) -> None:
self.checkFile(self._root / "comments/multi1.vhdl")
def test_line1(self) -> None:
self.checkFile(self._root / "comments/line1.vhdl")
class Complex(Base):
@expectedFailure # "not yet handled"
def test_Comment2(self) -> None:
"""More exhaustive"""
self.checkFile(self._root / "Complex.vhdl")
# Empty line before to easy cut & put
|
