Source code for pyGHDL.dom.PSL

# =============================================================================
#               ____ _   _ ____  _          _
#  _ __  _   _ / ___| | | |  _ \| |      __| | ___  _ __ ___
# | '_ \| | | | |  _| |_| | | | | |     / _` |/ _ \| '_ ` _ \
# | |_) | |_| | |_| |  _  | |_| | |___ | (_| | (_) | | | | | |
# | .__/ \__, |\____|_| |_|____/|_____(_)__,_|\___/|_| |_| |_|
# |_|    |___/
# =============================================================================
# Authors:
#   Patrick Lehmann
#
# Package module:   DOM: VHDL design units (e.g. context or package).
#
# License:
# ============================================================================
#  Copyright (C) 2019-2021 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 contains all DOM classes for VHDL's design units (:class:`context <Entity>`,
:class:`architecture <Architecture>`, :class:`package <Package>`,
:class:`package body <PackageBody>`, :class:`context <Context>` and
:class:`configuration <Configuration>`.

"""

from __future__ import annotations

from re import sub, fullmatch, IGNORECASE

from pyTooling.Decorators import export, InheritDocString, DocStringMergeStrategy

from pyVHDLModel.PSLModel import VerificationUnit as VHDLModel_VerificationUnit
from pyVHDLModel.PSLModel import VerificationProperty as VHDLModel_VerificationProperty
from pyVHDLModel.PSLModel import VerificationMode as VHDLModel_VerificationMode
from pyVHDLModel.PSLModel import DefaultClock as VHDLModel_DefaultClock

from pyGHDL.libghdl._types import Iir
from pyGHDL.dom import DOMMixin, DOMException, Position
from pyGHDL.dom._Utils import GetNameOfNode, GetDocumentationOfNode, GetSourceTextOfNode


[docs] @export @InheritDocString(VHDLModel_VerificationUnit, strategy=DocStringMergeStrategy.BaseLast) class VerificationUnit(VHDLModel_VerificationUnit, DOMMixin): """ This class implements a :mod:`pyGHDL.dom` object derived from :class:`pyVHDLModel.PSLModel.VerificationUnit`. """
[docs] def __init__( self, node: Iir, identifier: str, ) -> None: """ Initializes a PSL verification unit (:vhdlkw:`vunit`). :param node: The IIR node this object was translated from. :param identifier: The verification unit's identifier. """ super().__init__(identifier) DOMMixin.__init__(self, node)
[docs] @classmethod def parse(cls, vunitNode: Iir): """ Translates the IIR node of the verification unit to a :class:`VerificationUnit`. :param vunitNode: The IIR node of the verification unit. :returns: The translated verification unit. """ name = GetNameOfNode(vunitNode) # FIXME: needs an implementation return cls(vunitNode, name)
[docs] @export @InheritDocString(VHDLModel_VerificationProperty, strategy=DocStringMergeStrategy.BaseLast) class VerificationProperty(VHDLModel_VerificationProperty, DOMMixin): """ This class implements a :mod:`pyGHDL.dom` object derived from :class:`pyVHDLModel.PSLModel.VerificationProperty`. """
[docs] def __init__( self, node: Iir, identifier: str, ) -> None: """ Initializes a PSL verification property (:vhdlkw:`vprop`). :param node: The IIR node this object was translated from. :param identifier: The verification property's identifier. """ super().__init__(identifier) DOMMixin.__init__(self, node)
[docs] @classmethod def parse(cls, vpropNode: Iir): """ Translates the IIR node of the verification property to a :class:`VerificationProperty`. :param vpropNode: The IIR node of the verification property. :returns: The translated verification property. """ name = GetNameOfNode(vpropNode) # FIXME: needs an implementation return cls(vpropNode, name)
[docs] @export @InheritDocString(VHDLModel_VerificationMode, strategy=DocStringMergeStrategy.BaseLast) class VerificationMode(VHDLModel_VerificationMode, DOMMixin): """ This class implements a :mod:`pyGHDL.dom` object derived from :class:`pyVHDLModel.PSLModel.VerificationMode`. """
[docs] def __init__( self, node: Iir, identifier: str, ) -> None: """ Initializes a PSL verification mode (:vhdlkw:`vmode`). :param node: The IIR node this object was translated from. :param identifier: The verification mode's identifier. """ super().__init__(identifier) DOMMixin.__init__(self, node)
[docs] @classmethod def parse(cls, vmodeNode: Iir): """ Translates the IIR node of the verification mode to a :class:`VerificationMode`. :param vmodeNode: The IIR node of the verification mode. :returns: The translated verification mode. """ name = GetNameOfNode(vmodeNode) # FIXME: needs an implementation return cls(vmodeNode, name)
[docs] @export @InheritDocString(VHDLModel_DefaultClock, strategy=DocStringMergeStrategy.BaseLast) class DefaultClock(VHDLModel_DefaultClock, DOMMixin): """ This class implements a :mod:`pyGHDL.dom` object derived from :class:`pyVHDLModel.PSLModel.DefaultClock`. """
[docs] def __init__( self, node: Iir, identifier: str, documentation: str = None, ) -> None: """ Initializes a PSL default clock declaration. :param node: The IIR node this object was translated from. :param identifier: The default clock's identifier. :param documentation: Optional, the documentation comment associated with this declaration. """ super().__init__(identifier, documentation) DOMMixin.__init__(self, node)
[docs] @classmethod def parse(cls, defaultClockNode: Iir): """ Translates the IIR node of the PSL default clock to a :class:`DefaultClock`. A PSL default clock declaration (``default clock is rising_edge(clk);``) has no identifier. *libghdl* keeps the clock expression as a PSL node, which has no Python binding, so the clock expression's source text (comments removed, whitespace collapsed) becomes the identifier: ``rising_edge(clk)``. :param defaultClockNode: The IIR node of the PSL default clock. :returns: The translated PSL default clock. :raises DOMException: If the source text at the node's location is no PSL default clock declaration. """ sourceText = GetSourceTextOfNode(defaultClockNode) declaration = sub(r"--[^\n]*", "", sourceText[: sourceText.find(";")]) match = fullmatch(r"default\s+clock\s+is\s+(.+)", " ".join(declaration.split()), IGNORECASE) if match is None: position = Position.parse(defaultClockNode) raise DOMException(f"Unexpected source text of PSL default clock declaration at {position}.") documentation = GetDocumentationOfNode(defaultClockNode) return cls(defaultClockNode, match.group(1), documentation)