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
|
# ==================================================================================================================== #
# _____ ____ _ _ ___ ______ ____ ____ __ #
# _ __ _ _| ____| _ \ / \ / \ / _ \/ ___\ \ / /\ \ / / \/ | #
# | '_ \| | | | _| | | | |/ _ \ / _ \ | | | \___ \\ \ / / \ \ / /| |\/| | #
# | |_) | |_| | |___| |_| / ___ \ / ___ \ | |_| |___) |\ V / \ V / | | | | #
# | .__/ \__, |_____|____/_/ \_\/_/ \_(_)___/|____/ \_/ \_/ |_| |_| #
# |_| |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2025-2025 Patrick Lehmann - Boetzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
from pathlib import Path
from typing import Optional as Nullable, Tuple
from pyTooling.Decorators import export
from pyVHDLModel import VHDLVersion
from pyEDAA.OSVVM import OSVVMException
from pyEDAA.OSVVM.Environment import osvvmContext, VHDLSourceFile, GenericValue
@export
def build(file: str) -> None:
include(file)
@export
def include(file: str) -> None:
currentDirectory = osvvmContext._currentDirectory
includeFile = osvvmContext.IncludeFile(Path(file))
osvvmContext.EvaluateFile(includeFile)
osvvmContext._currentDirectory = currentDirectory
@export
def library(libraryName: str, libraryPath: Nullable[str] = None) -> None:
osvvmContext.SetLibrary(libraryName)
@export
def analyze(file: str) -> None:
file = Path(file)
fullPath = (osvvmContext._currentDirectory / file).resolve()
if not fullPath.exists(): # pragma: no cover
ex = OSVVMException(f"Path '{fullPath}' can't be analyzed.")
ex.__cause__ = FileNotFoundError(fullPath)
osvvmContext.LastException = ex
raise ex
if fullPath.suffix in (".vhd", ".vhdl"):
vhdlFile = VHDLSourceFile(fullPath.relative_to(osvvmContext._workingDirectory, walk_up=True))
osvvmContext.AddVHDLFile(vhdlFile)
else: # pragma: no cover
ex = OSVVMException(f"Path '{fullPath}' is no VHDL file.")
osvvmContext.LastException = ex
raise ex
@export
def simulate(toplevelName: str, *options: Tuple[int]) -> None:
testcase = osvvmContext.SetTestcaseToplevel(toplevelName)
for optionID in options:
try:
option = osvvmContext._options[int(optionID)]
except KeyError as e: # pragma: no cover
ex = OSVVMException(f"Option {optionID} not found in option dictionary.")
ex.__cause__ = e
osvvmContext.LastException = ex
raise ex
if isinstance(option, GenericValue):
testcase.AddGeneric(option)
else: # pragma: no cover
ex = OSVVMException(f"Option {optionID} is not a GenericValue.")
ex.__cause__ = TypeError()
osvvmContext.LastException = ex
raise ex
# osvvmContext._testcase = None
@export
def generic(name: str, value: str) -> GenericValue:
genericValue = GenericValue(name, value)
optionID = osvvmContext.AddOption(genericValue)
return optionID
@export
def TestSuite(name: str) -> None:
osvvmContext.SetTestsuite(name)
@export
def TestName(name: str) -> None:
osvvmContext.AddTestcase(name)
@export
def RunTest(file: str, *options: Tuple[int]) -> None:
file = Path(file)
testName = file.stem
# Analyze file
fullPath = (osvvmContext._currentDirectory / file).resolve()
if not fullPath.exists(): # pragma: no cover
ex = OSVVMException(f"Path '{fullPath}' can't be analyzed.")
ex.__cause__ = FileNotFoundError(fullPath)
osvvmContext.LastException = ex
raise ex
if fullPath.suffix in (".vhd", ".vhdl"):
vhdlFile = VHDLSourceFile(fullPath.relative_to(osvvmContext._workingDirectory, walk_up=True))
osvvmContext.AddVHDLFile(vhdlFile)
else: # pragma: no cover
ex = OSVVMException(f"Path '{fullPath}' is no VHDL file.")
osvvmContext.LastException = ex
raise ex
# Add testcase
testcase = osvvmContext.AddTestcase(testName)
testcase.SetToplevel(testName)
for optionID in options:
try:
option = osvvmContext._options[int(optionID)]
except KeyError as e: # pragma: no cover
ex = OSVVMException(f"Option {optionID} not found in option dictionary.")
ex.__cause__ = e
osvvmContext.LastException = ex
raise ex
if isinstance(option, GenericValue):
testcase.AddGeneric(option)
else: # pragma: no cover
ex = OSVVMException(f"Option {optionID} is not a GenericValue.")
ex.__cause__ = TypeError()
osvvmContext.LastException = ex
raise ex
# osvvmContext._testcase = None
@export
def LinkLibrary(libraryName: str, libraryPath: Nullable[str] = None):
print(f"[LinkLibrary] {libraryPath}")
@export
def LinkLibraryDirectory(libraryDirectory: str):
print(f"[LinkLibraryDirectory] {libraryDirectory}")
@export
def SetVHDLVersion(value: str) -> None:
try:
value = int(value)
except ValueError as e: # pragma: no cover
ex = OSVVMException(f"Unsupported VHDL version '{value}'.")
ex.__cause__ = e
osvvmContext.LastException = ex
raise ex
match value:
case 1987:
osvvmContext.VHDLVersion = VHDLVersion.VHDL87
case 1993:
osvvmContext.VHDLVersion = VHDLVersion.VHDL93
case 2002:
osvvmContext.VHDLVersion = VHDLVersion.VHDL2002
case 2008:
osvvmContext.VHDLVersion = VHDLVersion.VHDL2008
case 2019:
osvvmContext.VHDLVersion = VHDLVersion.VHDL2019
case _: # pragma: no cover
ex = OSVVMException(f"Unsupported VHDL version '{value}'.")
osvvmContext.LastException = ex
raise ex
@export
def GetVHDLVersion() -> int:
if osvvmContext.VHDLVersion is VHDLVersion.VHDL87:
return 1987
elif osvvmContext.VHDLVersion is VHDLVersion.VHDL93:
return 1993
elif osvvmContext.VHDLVersion is VHDLVersion.VHDL2002:
return 2002
elif osvvmContext.VHDLVersion is VHDLVersion.VHDL2008:
return 2008
elif osvvmContext.VHDLVersion is VHDLVersion.VHDL2019:
return 2019
else: # pragma: no cover
ex = OSVVMException(f"Unsupported VHDL version '{osvvmContext.VHDLVersion}'.")
osvvmContext.LastException = ex
raise ex
@export
def SetCoverageAnalyzeEnable(value: bool) -> None:
print(f"[SetCoverageAnalyzeEnable] {value}:{value.__class__.__name__}")
@export
def SetCoverageSimulateEnable(value: bool) -> None:
print(f"[SetCoverageSimulateEnable] {value}")
@export
def FileExists(file: str) -> bool:
return (osvvmContext._currentDirectory / file).is_file()
@export
def DirectoryExists(directory: str) -> bool:
return (osvvmContext._currentDirectory / directory).is_dir()
@export
def ChangeWorkingDirectory(directory: str) -> None:
osvvmContext._currentDirectory = (newDirectory := osvvmContext._currentDirectory / directory)
if not newDirectory.is_dir(): # pragma: no cover
ex = OSVVMException(f"Directory '{newDirectory}' doesn't exist.")
ex.__cause__ = NotADirectoryError(newDirectory)
osvvmContext.LastException = ex
raise ex
@export
def FindOsvvmSettingsDirectory(*args):
pass
@export
def CreateOsvvmScriptSettingsPkg(*args):
pass
@export
def noop(*args):
pass
|