aboutsummaryrefslogtreecommitdiffstats
path: root/pyGHDL/dom/Object.py
blob: f1028c3054cee5773d38433853670aa78e8088ef (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
# =============================================================================
#               ____ _   _ ____  _          _
#  _ __  _   _ / ___| | | |  _ \| |      __| | ___  _ __ ___
# | '_ \| | | | |  _| |_| | | | | |     / _` |/ _ \| '_ ` _ \
# | |_) | |_| | |_| |  _  | |_| | |___ | (_| | (_) | | | | | |
# | .__/ \__, |\____|_| |_|____/|_____(_)__,_|\___/|_| |_| |_|
# |_|    |___/
# =============================================================================
# Authors:
#   Patrick Lehmann
#
# Package module:   DOM: Interface items (e.g. generic or port)
#
# License:
# ============================================================================
#  Copyright (C) 2019-2022 Tristan Gingold
#
#  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 2 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 <gnu.org/licenses>.
#
# SPDX-License-Identifier: GPL-2.0-or-later
# ============================================================================
from typing import Union, List, Iterable

from pyTooling.Decorators import export

from pyVHDLModel.Base import ExpressionUnion
from pyVHDLModel.Symbol import Symbol
from pyVHDLModel.Object import Constant as VHDLModel_Constant
from pyVHDLModel.Object import DeferredConstant as VHDLModel_DeferredConstant
from pyVHDLModel.Object import Variable as VHDLModel_Variable
from pyVHDLModel.Object import SharedVariable as VHDLModel_SharedVariable
from pyVHDLModel.Object import Signal as VHDLModel_Signal
from pyVHDLModel.Object import File as VHDLModel_File

from pyGHDL.libghdl._types import Iir
from pyGHDL.libghdl.vhdl import nodes
from pyGHDL.dom import DOMMixin
from pyGHDL.dom._Utils import GetNameOfNode, GetDocumentationOfNode


@export
class Constant(VHDLModel_Constant, DOMMixin):
    def __init__(
        self,
        node: Iir,
        identifiers: List[str],
        subtype: Symbol,
        defaultExpression: ExpressionUnion,
        documentation: str = None,
    ):
        super().__init__(identifiers, subtype, defaultExpression, documentation)
        DOMMixin.__init__(self, node)

    @classmethod
    def parse(
        cls, constantNode: Iir, furtherIdentifiers: Iterable[str] = None
    ) -> Union["Constant", "DeferredConstant"]:
        from pyGHDL.dom._Translate import (
            GetSubtypeIndicationFromNode,
            GetExpressionFromNode,
        )

        name = GetNameOfNode(constantNode)
        documentation = GetDocumentationOfNode(constantNode)
        identifiers = [name]
        if furtherIdentifiers is not None:
            identifiers.extend(furtherIdentifiers)
        subtypeIndication = GetSubtypeIndicationFromNode(constantNode, "constant", name)
        defaultValue = nodes.Get_Default_Value(constantNode)
        if defaultValue != nodes.Null_Iir:
            defaultExpression = GetExpressionFromNode(defaultValue)

            return cls(constantNode, identifiers, subtypeIndication, defaultExpression, documentation)
        else:
            return DeferredConstant(constantNode, identifiers, subtypeIndication, documentation)


@export
class DeferredConstant(VHDLModel_DeferredConstant, DOMMixin):
    def __init__(self, node: Iir, identifiers: List[str], subtype: Symbol, documentation: str = None):
        super().__init__(identifiers, subtype, documentation)
        DOMMixin.__init__(self, node)

    @classmethod
    def parse(cls, constantNode: Iir, furtherIdentifiers: Iterable[str] = None) -> "DeferredConstant":
        from pyGHDL.dom._Translate import GetSubtypeIndicationFromNode

        name = GetNameOfNode(constantNode)
        documentation = GetDocumentationOfNode(constantNode)
        identifiers = [name]
        if furtherIdentifiers is not None:
            identifiers.extend(furtherIdentifiers)
        subtypeIndication = GetSubtypeIndicationFromNode(constantNode, "deferred constant", name)

        return cls(constantNode, identifiers, subtypeIndication, documentation)


@export
class Variable(VHDLModel_Variable, DOMMixin):
    def __init__(
        self,
        node: Iir,
        identifiers: List[str],
        subtype: Symbol,
        defaultExpression: ExpressionUnion,
        documentation: str = None,
    ):
        super().__init__(identifiers, subtype, defaultExpression, documentation)
        DOMMixin.__init__(self, node)

    @classmethod
    def parse(cls, variableNode: Iir, furtherIdentifiers: Iterable[str] = None) -> "Variable":
        from pyGHDL.dom._Translate import (
            GetSubtypeIndicationFromNode,
            GetExpressionFromNode,
        )

        name = GetNameOfNode(variableNode)
        documentation = GetDocumentationOfNode(variableNode)
        identifiers = [name]
        if furtherIdentifiers is not None:
            identifiers.extend(furtherIdentifiers)
        subtypeIndication = GetSubtypeIndicationFromNode(variableNode, "variable", name)
        defaultValue = nodes.Get_Default_Value(variableNode)
        defaultExpression = None
        if defaultValue != nodes.Null_Iir:
            defaultExpression = GetExpressionFromNode(defaultValue)

        return cls(variableNode, identifiers, subtypeIndication, defaultExpression, documentation)


@export
class SharedVariable(VHDLModel_SharedVariable, DOMMixin):
    def __init__(self, node: Iir, identifiers: List[str], subtype: Symbol, documentation: str = None):
        super().__init__(identifiers, subtype, documentation)
        DOMMixin.__init__(self, node)

    @classmethod
    def parse(cls, variableNode: Iir, furtherIdentifiers: Iterable[str] = None) -> "SharedVariable":
        from pyGHDL.dom._Translate import GetSubtypeIndicationFromNode

        name = GetNameOfNode(variableNode)
        documentation = GetDocumentationOfNode(variableNode)
        identifiers = [name]
        if furtherIdentifiers is not None:
            identifiers.extend(furtherIdentifiers)
        subtypeIndication = GetSubtypeIndicationFromNode(variableNode, "variable", name)

        return cls(variableNode, identifiers, subtypeIndication, documentation)


@export
class Signal(VHDLModel_Signal, DOMMixin):
    def __init__(
        self,
        node: Iir,
        identifiers: List[str],
        subtype: Symbol,
        defaultExpression: ExpressionUnion,
        documentation: str = None,
    ):
        super().__init__(identifiers, subtype, defaultExpression, documentation)
        DOMMixin.__init__(self, node)

    @classmethod
    def parse(cls, signalNode: Iir, furtherIdentifiers: Iterable[str] = None) -> "Signal":
        from pyGHDL.dom._Translate import (
            GetSubtypeIndicationFromNode,
            GetExpressionFromNode,
        )

        name = GetNameOfNode(signalNode)
        documentation = GetDocumentationOfNode(signalNode)
        identifiers = [name]
        if furtherIdentifiers is not None:
            identifiers.extend(furtherIdentifiers)
        subtypeIndication = GetSubtypeIndicationFromNode(signalNode, "signal", name)
        default = nodes.Get_Default_Value(signalNode)
        defaultExpression = GetExpressionFromNode(default) if default else None

        return cls(signalNode, identifiers, subtypeIndication, defaultExpression, documentation)


@export
class File(VHDLModel_File, DOMMixin):
    def __init__(self, node: Iir, identifiers: List[str], subtype: Symbol, documentation: str = None):
        super().__init__(identifiers, subtype, documentation)
        DOMMixin.__init__(self, node)

    @classmethod
    def parse(cls, fileNode: Iir, furtherIdentifiers: Iterable[str] = None) -> "File":
        from pyGHDL.dom._Translate import GetSubtypeIndicationFromNode

        name = GetNameOfNode(fileNode)
        documentation = GetDocumentationOfNode(fileNode)
        identifiers = [name]
        if furtherIdentifiers is not None:
            identifiers.extend(furtherIdentifiers)
        subtypeIndication = GetSubtypeIndicationFromNode(fileNode, "file", name)

        # FIXME: handle file open stuff

        return cls(fileNode, identifiers, subtypeIndication, documentation)