Source code for macro_polo.macros.types

"""Macro type definitions."""

from abc import abstractmethod
from collections.abc import Sequence
from typing import Protocol

from ..tokens import Token




class Macro(Protocol):
    """Transforms a token sequence."""

    @abstractmethod
    def __call__(self, tokens: Sequence[Token]) -> Sequence[Token] | None:
        """Transform a token sequence.

        This method should return a new token sequence, or ``None`` if the input sequence
        fails to match or should be left unchanged.
        """





class PartialMatchMacro(Protocol):
    """Transforms the beginning of a token sequence."""

    @abstractmethod
    def __call__(self, tokens: Sequence[Token]) -> tuple[Sequence[Token], int]:
        """Transform the beginning of a token sequence.

        This method should return a tuple of (token sequence, number of tokens matched).
        """





class ParameterizedMacro(Protocol):
    """Macro that takes additional parameters."""

    @abstractmethod
    def __call__(
        self, parameters: Sequence[Token], tokens: Sequence[Token]
    ) -> Sequence[Token] | None:
        """Transform a token sequence.

        This method should return a new token sequence, or ``None`` if the input sequence
        fails to match.
        """