Source code for aac.context.lexeme

"""Provides lexical unit for a parsed AaC definition."""

from attr import attrib, attrs, validators

from aac.in_out.paths import is_same_file
from aac.context.source_location import SourceLocation




@attrs(eq=False)
class Lexeme:
    """A lexical unit for a parsed AaC definition.

    Attributes:
        location (SourceLocation): The location at which the object was found.
        source (str): The source in which the object was found.
        value (str): The value of the parsed object.
    """

    location: SourceLocation = attrib(validator=validators.instance_of(SourceLocation))
    source: str = attrib(validator=validators.instance_of(str))
    value: str = attrib(validator=validators.instance_of(str))

    def __init__(self, location: SourceLocation, source: str, value: str):
        """
        An init constructor for the Lexeme Class.

        Args:
            location (SourceLocation): The position in the source file.
            source (str): The source file.
            value (str): The value stored in the lexeme.
        """
        self.location = location
        self.source = source
        self.value = value



    def __eq__(self, __o) -> bool:
        """Return whether this Lexeme is the same as __o."""
        return (
            isinstance(__o, Lexeme)
            and self.value == __o.value
            and self.location == __o.location
            and is_same_file(self.source, __o.source)
        )




    def __str__(self) -> str:
        """Return a string representation of this Lexeme."""
        return f"{self.value} at {self.location} in {self.source}"