Source code for python2verilog.ir.signals

"""
Protocol signals used by the converter
"""

from typing import Iterator

from python2verilog.ir.expressions import ExclusiveVar, Var




class InstanceSignals:
    """
    Signals that are often named differently for each instance
    """



    @staticmethod
    def apply_prefix(name: str, prefix: str):
        """
        Creates a Var with prefix
        """
        return ExclusiveVar(f"{prefix}{name}", f"__{prefix}{name}")


    def __init__(self, prefix: str = ""):
        self.prefix = prefix
        self.start = self.apply_prefix("start", self.prefix)
        self.done = self.apply_prefix("done", self.prefix)
        self.ready = self.apply_prefix("ready", self.prefix)
        self.valid = self.apply_prefix("valid", self.prefix)





class ProtocolSignals(InstanceSignals):
    """
    Protocol signals

    Includes ready, valid, clock, reset, done, etc.
    """

    def __init__(self, prefix: str = ""):
        super().__init__(prefix)
        self.reset = Var("reset", "__reset")
        self.clock = Var("clock", "__clock")



    def variable_values(self) -> Iterator[Var]:
        """
        Values
        """
        for _, value in self.variable_items():
            yield value




    def variable_items(self) -> Iterator[tuple[str, Var]]:
        """
        Key, Value pairs
        """
        for key, value in self.__dict__.items():
            if isinstance(value, Var):
                yield key, value




    def instance_specific_items(self) -> Iterator[tuple[str, Var]]:
        """
        Get the instance-specific signals
        """
        instance_signals = InstanceSignals().__dict__
        for key, value in self.variable_items():
            if key in instance_signals:
                yield key, value




    def instance_specific_values(self) -> Iterator[Var]:
        """
        Get the instance-specific signals
        """
        for _, value in self.instance_specific_items():
            yield value