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
|
# ==================================================================================================================== #
# __ ___ _ ____ _ __ __ _ _ #
# _ __ _ \ \ / / | | | _ \| | | \/ | ___ __| | ___| | #
# | '_ \| | | \ \ / /| |_| | | | | | | |\/| |/ _ \ / _` |/ _ \ | #
# | |_) | |_| |\ V / | _ | |_| | |___| | | | (_) | (_| | __/ | #
# | .__/ \__, | \_/ |_| |_|____/|_____|_| |_|\___/ \__,_|\___|_| #
# |_| |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2023 Patrick Lehmann - Boetzingen, Germany #
# Copyright 2016-2017 Patrick Lehmann - Dresden, 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 #
# ==================================================================================================================== #
#
"""This module contains library and package declarations for VHDL library ``STD``."""
from pyTooling.Decorators import export
from pyVHDLModel.Base import Range, Direction
from pyVHDLModel.Name import SimpleName
from pyVHDLModel.Symbol import SimpleSubtypeSymbol
from pyVHDLModel.Expression import EnumerationLiteral, IntegerLiteral, PhysicalIntegerLiteral
from pyVHDLModel.Type import EnumeratedType, IntegerType, Subtype, PhysicalType, ArrayType
from pyVHDLModel.Predefined import PredefinedLibrary, PredefinedPackage, PredefinedPackageBody
@export
class Std(PredefinedLibrary):
"""
Predefined VHDL library ``std``.
The following predefined packages are in this library:
* :class:`~pyVHDLModel.STD.Standard`
* :class:`~pyVHDLModel.STD.Env`
* :class:`~pyVHDLModel.STD.TextIO`
.. seealso::
Other predefined libraries:
* Library :class:`~pyVHDLModel.IEEE.Ieee`
"""
def __init__(self):
super().__init__(PACKAGES)
@export
class Standard(PredefinedPackage):
"""
Predefined package ``std.standard``.
Predefined types:
* ``boolean``, ``boolean_vector``
* ``bit``, ``bit_vector``
* ``character``, ``string``
* ``integer``, ``integer_vector``
* ``natural``, ``positive``
* ``real``, ``real_vector``
* ``time``, ``time_vector``
* ``open_file_kind``, ``open_file_status``
.. seealso::
Matching :class:`Package Body <pyVHDLModel.STD.Standard_Body>` declaration.
"""
def __init__(self):
super().__init__()
boolean = EnumeratedType("boolean", (EnumerationLiteral("false"), EnumerationLiteral("true")))
self._types[boolean._normalizedIdentifier] = boolean
self._declaredItems.append(boolean)
bit = EnumeratedType("bit", (EnumerationLiteral("'0'"), EnumerationLiteral("'1'")))
self._types[bit._normalizedIdentifier] = bit
self._declaredItems.append(bit)
chars = \
"nul", "soh", "stx", "etx", "eot", "enq", "ack", "bel", "bs", "ht", "lf", "vt", "ff", "cr", "so", "si", "dle", "dc1", "dc2", "dc3",\
"dc4", "nak", "syn", "etb", "can", "em", "sub", "esc", "fsp", "gsp", "rsp", "usp", "' '", "'!'", "'\"'", "'#'", "'$'", "'%'", "'&'", "'''",\
"'('", "')'", "'*'", "'+'", "','", "'-'", "'.'", "'/'", "'0'", "'1'", "'2'", "'3'", "'4'", "'5'", "'6'", "'7'", "'8'", "'9'", "':'", "';'",\
"'<'", "'='", "'>'", "'?'", "'@'", "'A'", "'B'", "'C'", "'D'", "'E'", "'F'", "'G'", "'H'", "'I'", "'J'", "'K'", "'L'", "'M'", "'N'", "'O'",\
"'P'", "'Q'", "'R'", "'S'", "'T'", "'U'", "'V'", "'W'", "'X'", "'Y'", "'Z'", "'['", "'\'", "']'", "'^'", "'_'", "'`'", "'a'", "'b'", "'c'",\
"'d'", "'e'", "'f'", "'g'", "'h'", "'i'", "'j'", "'k'", "'l'", "'m'", "'n'", "'o'", "'p'", "'q'", "'r'", "'s'", "'t'", "'u'", "'v'", "'w'",\
"'x'", "'y'", "'z'", "'{'", "'|'", "'}'", "'~'", "del", "c128", "c129", "c130", "c131", "c132", "c133", "c134", "c135", "c136", "c137", "c138", "c139",\
"c140", "c141", "c142", "c143", "c144", "c145", "c146", "c147", "c148", "c149", "c150", "c151", "c152", "c153", "c154", "c155", "c156", "c157", "c158", "c159",\
"' '", "'¡'", "'¢'", "'£'", "'¤'", "'¥'", "'¦'", "'§'", "'¨'", "'©'", "'ª'", "'«'", "'¬'", "''", "'®'", "'¯'", "'°'", "'±'", "'²'", "'³'",\
"'´'", "'µ'", "'¶'", "'·'", "'¸'", "'¹'", "'º'", "'»'", "'¼'", "'½'", "'¾'", "'¿'", "'À'", "'Á'", "'Â'", "'Ã'", "'Ä'", "'Å'", "'Æ'", "'Ç'",\
"'È'", "'É'", "'Ê'", "'Ë'", "'Ì'", "'Í'", "'Î'", "'Ï'", "'Ð'", "'Ñ'", "'Ò'", "'Ó'", "'Ô'", "'Õ'", "'Ö'", "'×'", "'Ø'", "'Ù'", "'Ú'", "'Û'",\
"'Ü'", "'Ý'", "'Þ'", "'ß'", "'à'", "'á'", "'â'", "'ã'", "'ä'", "'å'", "'æ'", "'ç'", "'è'", "'é'", "'ê'", "'ë'", "'ì'", "'í'", "'î'", "'ï'",\
"'ð'", "'ñ'", "'ò'", "'ó'", "'ô'", "'õ'", "'ö'", "'÷'", "'ø'", "'ù'", "'ú'", "'û'", "'ü'", "'ý'", "'þ'", "'ÿ'"
character = EnumeratedType("character", [EnumerationLiteral(char) for char in chars])
self._types[character._normalizedIdentifier] = character
self._declaredItems.append(character)
levels = "note", "warning", "error", "failure"
severityLevel = EnumeratedType("severityLevel", [EnumerationLiteral(level) for level in levels])
self._types[severityLevel._normalizedIdentifier] = severityLevel
self._declaredItems.append(severityLevel)
integer = IntegerType("integer", Range(IntegerLiteral(-2**31), IntegerLiteral(2**31-1), Direction.To))
self._types[integer._normalizedIdentifier] = integer
self._declaredItems.append(integer)
# real
time = PhysicalType(
"time",
Range(IntegerLiteral(-2**63), IntegerLiteral(2**63-1), Direction.To),
primaryUnit="fs",
units=(
("ps", PhysicalIntegerLiteral(1000, "fs")),
("ns", PhysicalIntegerLiteral(1000, "ps")),
("us", PhysicalIntegerLiteral(1000, "ns")),
("ms", PhysicalIntegerLiteral(1000, "us")),
("sec", PhysicalIntegerLiteral(1000, "ms")),
("min", PhysicalIntegerLiteral(60, "sec")),
("hr", PhysicalIntegerLiteral(60, "min")),
)
)
self._types[time._normalizedIdentifier] = time
self._declaredItems.append(time)
# delay_length
# now
natural = Subtype("natural", SimpleSubtypeSymbol(SimpleName("integer")))
natural._baseType = integer
natural._range = Range(IntegerLiteral(0), IntegerLiteral(2**31-1), Direction.To)
self._subtypes[natural._normalizedIdentifier] = natural
self._declaredItems.append(natural)
positive = Subtype("positive", SimpleSubtypeSymbol(SimpleName("integer")))
positive._baseType = integer
positive._range = Range(IntegerLiteral(1), IntegerLiteral(2**31-1), Direction.To)
self._subtypes[positive._normalizedIdentifier] = positive
self._declaredItems.append(positive)
string = ArrayType("string", (SimpleSubtypeSymbol(SimpleName("positive")), ), SimpleSubtypeSymbol(SimpleName("character")))
self._types[string._normalizedIdentifier] = string
self._declaredItems.append(string)
booleanVector = ArrayType("boolean_vector", (SimpleSubtypeSymbol(SimpleName("natural")), ), SimpleSubtypeSymbol(SimpleName("boolean")))
self._types[booleanVector._normalizedIdentifier] = booleanVector
self._declaredItems.append(booleanVector)
bitVector = ArrayType("bit_vector", (SimpleSubtypeSymbol(SimpleName("natural")), ), SimpleSubtypeSymbol(SimpleName("bit")))
self._types[bitVector._normalizedIdentifier] = bitVector
self._declaredItems.append(bitVector)
integerVector = ArrayType("integer_vector", (SimpleSubtypeSymbol(SimpleName("natural")), ), SimpleSubtypeSymbol(SimpleName("integer")))
self._types[integerVector._normalizedIdentifier] = integerVector
self._declaredItems.append(integerVector)
# real_vector
timeVector = ArrayType("time_vector", (SimpleSubtypeSymbol(SimpleName("natural")), ), SimpleSubtypeSymbol(SimpleName("time")))
self._types[timeVector._normalizedIdentifier] = timeVector
self._declaredItems.append(timeVector)
fileOpenKinds = "read_mode", "write_mode", "append_mode"
openFileKind = EnumeratedType("open_file_kind", [EnumerationLiteral(kind) for kind in fileOpenKinds])
self._types[openFileKind._normalizedIdentifier] = openFileKind
self._declaredItems.append(openFileKind)
fileOpenStati = "open_ok", "status_error", "name_error", "mode_error"
fileOpenStatus = EnumeratedType("open_file_status", [EnumerationLiteral(status) for status in fileOpenStati])
self._types[fileOpenStatus._normalizedIdentifier] = fileOpenStatus
self._declaredItems.append(fileOpenStatus)
# attribute foreign
@export
class Standard_Body(PredefinedPackageBody):
"""
Predefined package body of package ``std.standard``.
.. seealso::
Matching :class:`Package <pyVHDLModel.STD.Standard>` declaration.
"""
@export
class TextIO(PredefinedPackage):
"""
Predefined package ``std.textio``.
.. seealso::
Matching :class:`Package Body <pyVHDLModel.STD.TextIO_Body>` declaration.
"""
@export
class TextIO_Body(PredefinedPackageBody):
"""
Predefined package body of package ``std.textio``.
.. seealso::
Matching :class:`Package <pyVHDLModel.STD.TextIO>` declaration.
"""
@export
class Env(PredefinedPackage):
"""
Predefined package ``std.env``.
.. seealso::
Matching :class:`Package Body <pyVHDLModel.STD.Env_Body>` declaration.
"""
def __init__(self):
super().__init__()
self._AddPackageClause(("work.textio.all",))
@export
class Env_Body(PredefinedPackageBody):
"""
Predefined package body of package ``std.env``.
.. seealso::
Matching :class:`Package <pyVHDLModel.STD.Env>` declaration.
"""
PACKAGES = (
(Standard, Standard_Body),
(TextIO, TextIO_Body),
(Env, Env_Body),
)
|