# =============================================================================
# ____ _ _ ____ _ _
# _ __ _ _ / ___| | | | _ \| | __| | ___ _ __ ___
# | '_ \| | | | | _| |_| | | | | | / _` |/ _ \| '_ ` _ \
# | |_) | |_| | |_| | _ | |_| | |___ | (_| | (_) | | | | | |
# | .__/ \__, |\____|_| |_|____/|_____(_)__,_|\___/|_| |_| |_|
# |_| |___/
# =============================================================================
# Authors:
# Patrick Lehmann
#
# Package module: DOM: Elements not covered by the VHDL standard.
#
# 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
# ============================================================================
"""
This module implements derived classes for VHDL constructs not covered by another module, e.g. an alias.
"""
from pyTooling.Decorators import export, InheritDocString
from pyVHDLModel.Declaration import Alias as VHDLModel_Alias
from pyVHDLModel.Symbol import Symbol, PossibleReference
from pyGHDL.libghdl._types import Iir
from pyGHDL.libghdl.vhdl import nodes
from pyGHDL.dom import DOMMixin
from pyGHDL.dom._Utils import GetNameOfNode, GetDocumentationOfNode, GetIirKindOfNode
[docs]
@export
@InheritDocString(VHDLModel_Alias, merge=True)
class Alias(VHDLModel_Alias, DOMMixin):
"""
This class implements a :mod:`pyGHDL.dom` object derived from :class:`pyVHDLModel.Declaration.Alias`.
"""
[docs]
def __init__(
self,
node: Iir,
aliasName: str,
name: Symbol,
subtype: Symbol = None,
documentation: str = None,
) -> None:
"""
Initializes an alias declaration.
:param node: The IIR node this object was translated from.
:param aliasName: The alias' identifier.
:param name: Reference to the name being aliased.
:param subtype: Reference to the alias' subtype, or ``None`` if none was given.
:param documentation: The documentation comment associated with this declaration.
"""
super().__init__(aliasName, name, subtype, documentation)
DOMMixin.__init__(self, node)
[docs]
@classmethod
def parse(cls, aliasNode: Iir):
"""
Translates the IIR node of the alias declaration to an :class:`Alias`.
:param aliasNode: The IIR node of the alias declaration.
:returns: The translated alias declaration.
"""
from pyGHDL.dom._Translate import GetName, GetSubtypeIndicationFromNode
from pyGHDL.dom.Symbol import Symbol as DOMSymbol
aliasName = GetNameOfNode(aliasNode)
documentation = GetDocumentationOfNode(aliasNode)
nameNode = nodes.Get_Name(aliasNode)
if GetIirKindOfNode(nameNode) == nodes.Iir_Kind.Signature:
# FIXME: the parameter/return type marks of the signature (used to disambiguate between
# overloaded subprograms/operators, e.g. 'add[integer, integer return integer]')
# are not captured - only the aliased name itself (the signature's prefix).
nameNode = nodes.Get_Signature_Prefix(nameNode)
subtypeIndicationNode = nodes.Get_Subtype_Indication(aliasNode)
if subtypeIndicationNode == nodes.Null_Iir:
subtype = None
# Without a subtype indication, the alias can refer to almost anything nameable.
possibleReferences = PossibleReference.PackageMember | PossibleReference.EnumLiteral
else:
subtype = GetSubtypeIndicationFromNode(aliasNode, "alias", aliasName)
# With a subtype indication, the LRM restricts this to referencing an object.
possibleReferences = PossibleReference.Object
name = DOMSymbol(nameNode, GetName(nameNode), possibleReferences)
return cls(aliasNode, aliasName, name, subtype, documentation)