# Derived from portconquery.py
#
# SPDX-License-Identifier: LGPL-2.1-only
#
from collections.abc import Iterable
import typing

from . import mixins, policyrep, query

__all__: typing.Final[tuple[str, ...]] = ("PcideviceconQuery",)


class PcideviceconQuery(mixins.MatchContext, query.PolicyQuery):

    """
    Pcidevicecon context query.

    Parameter:
    policy          The policy to query.

    Keyword Parameters/Class attributes:
    device          A single PCI device ID.

    user            The criteria to match the context's user.
    user_regex      If true, regular expression matching
                    will be used on the user.

    role            The criteria to match the context's role.
    role_regex      If true, regular expression matching
                    will be used on the role.

    type_           The criteria to match the context's type.
    type_regex      If true, regular expression matching
                    will be used on the type.

    range_          The criteria to match the context's range.
    range_subset    If true, the criteria will match if it is a subset
                    of the context's range.
    range_overlap   If true, the criteria will match if it overlaps
                    any of the context's range.
    range_superset  If true, the criteria will match if it is a superset
                    of the context's range.
    range_proper    If true, use proper superset/subset operations.
                    No effect if not using set operations.
    """

    required_platform = policyrep.PolicyTarget.xen

    _device: int | None = None

    @property
    def device(self) -> int | None:
        return self._device

    @device.setter
    def device(self, value: int | None) -> None:
        if value:
            if value < 1:
                raise ValueError(f"PCI device ID must be positive: {value}")

            self._device = value
        else:
            self._device = None

    def _build_repr_args(self) -> list[str]:
        return [f"device={self.device!r}"] + self._build_context_repr_args()

    def results(self) -> Iterable[policyrep.Pcidevicecon]:
        """Generator which yields all matching pcidevicecons."""
        self.log.info(f"Generating results from {self.policy}")
        self.log.debug(f"{self.device=}")
        self._match_context_debug(self.log)

        for pcidevicecon in self.policy.pcidevicecons():

            if self.device and self.device != pcidevicecon.device:
                continue

            if not self._match_context(pcidevicecon.context):
                continue

            yield pcidevicecon
