"""

@relation(SDOC-SRS-137, SDOC-SRS-139, scope=file)

"""

from copy import copy

from enum import Enum

from typing import Any, List, Optional

from strictdoc.backend.sdoc_source_code.models.requirement_marker import Req

from strictdoc.helpers.auto_described import auto_described

class RangeMarkerType(Enum):

    FUNCTION = "function"

    CLASS = "class"

    FILE = "file"

@auto_described

class LanguageItemMarker:

    def __init__(

        self, parent: Any, reqs_objs: List[Req], scope: str, role: Optional[str]

    ):

        assert isinstance(reqs_objs, list)

        assert isinstance(scope, str), scope

        self.parent = parent

        self.reqs_objs: List[Req] = reqs_objs

        self.reqs: List[str] = list(map(lambda req: req.uid, reqs_objs))

        self.role: Optional[str] = (

            role if role is not None and len(role) > 0 else None

        )

        self.scope: RangeMarkerType = RangeMarkerType(scope)

        # Line number of the marker in the source code.

        self.ng_source_line_begin: Optional[int] = None

        self.ng_source_column_begin: Optional[int] = None

        # Line number of the marker range in the source code:

        # TODO: Improve description.

        # For Begin ranges:

        #   ng_range_line_begin == ng_source_line_begin  # noqa: ERA001

        #   ng_range_line_end == ng_source_line_begin of the End marker  # noqa: ERA001, E501

        # For End ranges:

        #   ng_range_line_begin == ng_range_line_begin of the Begin marker  # noqa: ERA001, E501

        #   ng_range_line_end == ng_source_line_begin  # noqa: ERA001

        self.ng_range_line_begin: Optional[int] = None

        self.ng_range_line_end: Optional[int] = None

        self.ng_marker_line: Optional[int] = None

        self.ng_marker_column: Optional[int] = None

        self.ng_is_nodoc = "skip" in self.reqs

        self.begin_or_end: bool = True

        self._description: Optional[str] = None

    def is_forward(self) -> bool:

        return False

    def is_range_marker(self) -> bool:

        return True

    def is_line_marker(self) -> bool:

        return False

    def is_begin(self) -> bool:

        return self.begin_or_end

    def is_end(self) -> bool:

        return not self.begin_or_end

    def get_description(self) -> Optional[str]:

        return self._description

    def set_description(self, description: str) -> None:

        assert isinstance(description, str)

        self._description = description

    def create_end_marker(self) -> "LanguageItemMarker":

        marker_copy = copy(self)

        marker_copy.begin_or_end = False

        marker_copy.ng_range_line_begin = self.ng_range_line_begin

        marker_copy.ng_source_line_begin = self.ng_range_line_end

        return marker_copy

@auto_described

class ForwardLanguageItemMarker(LanguageItemMarker):

    def __init__(

        self,

        parent: Any,

        reqs_objs: List[Req],

        scope: str,

        role: Optional[str] = None,

    ):

        super().__init__(parent, reqs_objs, scope, role)

    def is_forward(self) -> bool:

        return True