"""
This modules provides an API to specify the lexical environments to build for
each node ("env specs").

See the "Lexical environment" section in Langkit's Sphinx doc for an
introduction to their usage.
"""

from __future__ import annotations

from contextlib import AbstractContextManager
import dataclasses
from enum import Enum
from funcy import lsplit_by
from itertools import count
from typing import Dict, List, Optional, Type, cast, overload

from langkit import names
from langkit.compile_context import CompileCtx, get_context
from langkit.compiled_types import (ASTNodeType, AbstractNodeData,
                                    CompiledType, T, TypeRepo)
from langkit.diagnostics import (
    Location,
    check_source_language,
    diagnostic_context,
    error,
    extract_library_location,
)
from langkit.expressions import (AbstractExpression, FieldAccess, PropertyDef,
                                 Self, resolve_property, unsugar)


# Public API for env actions

def add_env(no_parent: bool = False,
            transitive_parent: bool = False,
            names: Optional[AbstractExpression] = None) -> AddEnv:
    """Create a new lexical environment.

    This action creates an environment related to this node. Using this action
    has restrictions:

    * there can be only one such action per env spec;
    * it must be a pre action.

    :param no_parent: If passed, the new env will be created with no parent
        env.
    :param transitive_parent: TODO.
    :param names: Optional array of names (symbols) for the created
        environment. If not passed or if this is an empty array, the created
        environment is not named.
    """
    return AddEnv(no_parent, unsugar(transitive_parent), names)


class RefKind(Enum):
    """
    Represents the kind of a referenced env. Here are the different kinds:

    * transitive: The reference is transitive, e.g. it will be explored in
      every case (whether the lookup is recursive or not). It will be explored
      *before* parent environments.

    * prioritary: The reference is non transitive, e.g. it will be explored
      only if the lookup on the env is recursive. It will be explored *before*
      parent environments.

    * normal: The reference is non transitive, e.g. it will be explored only
      if the lookup on the env is recursive. It will be explored *after*
      parent environments.
    """
    transitive = "Transitive"
    prioritary = "Prioritary"
    normal = "Normal"


def reference(nodes: AbstractExpression,
              through: PropertyDef,
              kind: RefKind = RefKind.normal,
              dest_env: Optional[AbstractExpression] = None,
              cond: Optional[AbstractExpression] = None,
              category: Optional[str] = None,
              shed_corresponding_rebindings: bool = False) -> RefEnvs:
    """
    Reference a group of lexical environments, that will be lazily yielded by
    calling the `through` property on the array of nodes `nodes`.

    :param nodes: An expression that yields a list of nodes.
    :param through: A property reference.

    :param kind: Kind of reference.
    :param dest_env: If passed, the destination environment for this reference.
    :param cond: If passed, an expression evaluating to a boolean condition. If
        False, reference won't be made and the others expressions won't be
        evaluated.

    :param category: If passed, must be a string representing a category name.
        String must represent a valid Ada name. A category in set of possible
        referenced envs categories will be implicitly created for each unique
        string passed to a call to reference, in a given compilation context.

    :param shed_corresponding_rebindings: If True, when shedding rebindings
        during an env lookup, this referenced env will be followed to check,
        and eventually shed rebindings associated to the referenced env.
    """
    return RefEnvs(through, nodes, kind, dest_env=dest_env, cond=cond,
                   category=category and category.lower(),
                   shed_rebindings=shed_corresponding_rebindings)


def add_to_env(mappings: AbstractExpression,
               resolver: Optional[PropertyDef] = None) -> AddToEnv:
    """
    Specify elements to add to the lexical environment.

    :param mappings: One or several mappings of key to node to add to the
        environment. Must be either of type T.env_assoc, or T.env_assoc.array.
        All nodes must belong to the same unit as the node that owns this
        EnvSpec. See langkit.expressions.envs.new_env_assoc for more precision
        on how to create an env assoc.

    :param resolver: Optional property that returns an AST node. If provided,
        the lexical environment lookup that will try to return the given
        mappings will first run this property on all nodes and return its
        result instead.
    """
    return AddToEnv(mappings, resolver)


def add_to_env_kv(key: AbstractExpression,
                  value: AbstractExpression,
                  dest_env: Optional[AbstractExpression] = None,
                  metadata: Optional[AbstractExpression] = None,
                  resolver: Optional[PropertyDef] = None) -> AddToEnv:
    """
    Specify a single element to add to the lexical environment. See
    langkit.expressions.envs.new_env_assoc for more precision about the first
    four arguments.

    :param resolver: Optional property that returns an AST node. If provided,
        the lexical environment lookup that will try to return the given
        mappings will first run this property on all nodes and return its
        result instead.
    """
    from langkit.expressions import new_env_assoc

    result = add_to_env(
        new_env_assoc(key, value, dest_env, metadata), resolver
    )
    result.kv_params = AddToEnv.KVParams(
        key, value, dest_env, metadata, resolver
    )
    return result


def handle_children() -> HandleChildren:
    """
    Handle the node's children lexical environments.
    """
    return HandleChildren()


def set_initial_env(env: AbstractExpression) -> SetInitialEnv:
    """
    Action that sets the initial env in which the rest of the environment
    actions are evaluated. Except for Do() hooks, this action must be first in
    the list of actions.

    :param env: Expression that returns a ``DesignatedEnv`` struct, for the
        environment that must become the initial one.
    """
    return SetInitialEnv(env)


def do(expr: AbstractExpression) -> Do:
    """
    Evaluate given expression for its side effects, discarding its result.
    """
    return Do(expr)


class EnvSpec:
    """
    Class defining a lexical environment specification for an ASTNode subclass.
    """

    PROPERTY_COUNT = count(0)

    def __init__(self, *actions: EnvAction) -> None:
        """
        :param actions: A list of environment actions to execute.
        """
        self.location = extract_library_location()

        self.ast_node: Optional[ASTNodeType] = None
        """
        ASTNodeType subclass associated to this environment specification.
        Initialized when creating ASTNodeType subclasses.
        """

        self.initial_env: Optional[SetInitialEnv] = None
        """
        The SetInitialEnv action associated to this EnvSpec, if any.
        Initialized during the parsing of actions.
        """

        # Analyze the given list of actions
        self._parse_actions(list(actions))
        self.pre_actions: list[EnvAction]
        self.post_actions: list[EnvAction]
        self.actions: list[EnvAction]

        self.adds_env = any(isinstance(a, AddEnv) for a in self.pre_actions)
        """
        Whether this spec create an environment.
        """

        self.properties_created = False
        """
        When types are defined in Lkt sources, properties are created during
        types lowering: no need to do it in the "create_properties" method.
        """

    def _parse_actions(self, actions: List[EnvAction]) -> None:
        """
        Analyze the given list of actions and extract pre/post actions, i.e.
        actions executed before and after handling children.
        """
        def filter(
            cls: Type[EnvAction],
            sequence: List[EnvAction],
        ) -> list[EnvAction]:
            """
            Return the number of ``cls`` instances in ``sequence``.
            """
            return [a for a in sequence if isinstance(a, cls)]

        # If present, allow Do actions to come before SetInitialEnv
        first_actions = []
        if any(isinstance(a, SetInitialEnv) for a in actions):
            while actions and isinstance(actions[0], Do):
                first_actions.append(actions.pop(0))

        # After that, allow at most one call to SetInitialEnv
        self.initial_env = None
        if actions and isinstance(actions[0], SetInitialEnv):
            with actions[0].diagnostic_context:
                check_source_language(
                    isinstance(actions[0], SetInitialEnv),
                    'The initial environment must come first after the'
                    ' potential do()'
                )
            self.initial_env = cast(SetInitialEnv, actions.pop(0))
            first_actions.append(self.initial_env)

        spurious_sie = filter(SetInitialEnv, actions)
        if spurious_sie:
            with spurious_sie[0].diagnostic_context:
                error("set_initial_env can only be preceded by do()")

        add_envs = filter(AddEnv, actions)
        if len(add_envs) > 1:
            with diagnostic_context(add_envs[1].location):
                error("There can be at most one call to add_env()")

        # Separate actions that must occur before and after the handling of
        # children. Get also rid of the HandleChildren delimiter action.
        pre, post = lsplit_by(lambda a: not isinstance(a, HandleChildren),
                              actions)
        post = post and post[1:]

        post_add_envs = filter(AddEnv, post)
        if post_add_envs:
            with diagnostic_context(post_add_envs[0].location):
                error('add_env() must occur before processing children')

        self.pre_actions = first_actions + pre
        self.post_actions = post
        self.actions = self.pre_actions + self.post_actions

    @property
    def diagnostic_context(self) -> AbstractContextManager[None]:
        """
        Diagnostic context for env specs.
        """
        assert self.location is not None
        return diagnostic_context(self.location)

    @overload
    def create_internal_property(self,
                                 name: str,
                                 expr: None,
                                 type: Optional[CompiledType]) -> None: ...

    @overload
    def create_internal_property(
        self,
        name: str,
        expr: AbstractExpression,
        type: Optional[CompiledType]
    ) -> PropertyDef: ...

    def create_internal_property(
        self,
        name: str,
        expr: Optional[AbstractExpression],
        type: Optional[CompiledType]
    ) -> Optional[PropertyDef]:
        """
        Create an internal property for this env spec.

        If ``expr`` is None, do not create a property and return None.
        Otherwise, unsugar it.

        :param name: Lower-case name to use to create this property name.
            Since the property is internal, the name is decorated.
        """
        assert self.ast_node is not None

        if expr is None:
            return None

        expr = unsugar(expr)
        p = PropertyDef(
            expr, AbstractNodeData.PREFIX_INTERNAL,
            name=names.Name.from_lower(f"{name}_{next(self.PROPERTY_COUNT)}"),
            public=False,
            type=type,
        )
        p._indexing_name = '_{}'.format(p.original_name.lower())
        p._original_name = p._indexing_name
        p.location = getattr(expr, 'location') or self.location
        self.ast_node.add_field(p)
        return p

    def create_properties(self, context: CompileCtx) -> None:
        """
        Turn the various abstract expression attributes for this env spec into
        internal properties and add them to `astnode`.
        """
        if not self.properties_created:
            for action in self.actions:
                action.create_internal_properties(self)

    def register_categories(self, context: CompileCtx) -> None:
        """
        Compilation pass to register all category names from RefEnvs actions.
        """
        for action in self.actions:
            if isinstance(action, RefEnvs) and action.category:
                low_name = action.category.lower
                check_source_language(
                    low_name not in ('nocat', 'default'),
                    '{} is not a valid name for a referenced env category'
                    .format(low_name)
                )
                context.ref_cats.add(action.category)

    def check_spec(self, context: CompileCtx) -> None:
        """
        ASTNode pass which checks that properties generated by the env spec are
        conforming. This relies on type information and property attributes
        (privacy, implicit envs), so it must run only after these can be
        computed.
        """
        has_add_env = False

        with self.diagnostic_context:

            for action in self.actions:
                action.check()

                if isinstance(action, AddEnv):
                    check_source_language(not has_add_env,
                                          'There can be only one add_env'
                                          ' action per EnvSpec')
                    has_add_env = True

    def _render_field_access(self, p: PropertyDef) -> str:
        """
        Helper to render a simple field access to the property P in the context
        of an environment specification.

        :param p: The property to access. It must accept no explicit argument.
        """
        assert not p.natural_arguments

        with PropertyDef.bind_none(), \
                Self.bind_type(self.ast_node):
            return FieldAccess.Expr(
                Self.construct_nocheck(), p, []
            ).render_expr()

    @property
    def initial_env_expr(self) -> str:
        """
        The initial environment expression.
        """
        assert self.initial_env
        return self._render_field_access(self.initial_env.env_prop)


class EnvAction:

    resolver: PropertyDef | TypeRepo.Defer | None = None
    """
    Some env actions use resolvers, that are property that will yield a lexical
    environment from a Node. To facilitate accessing it in general, we'll set a
    class attribute to None on the base class.
    """

    def __init__(self, location: Location | None = None) -> None:
        self.location = location or extract_library_location()

    @property
    def diagnostic_context(self) -> AbstractContextManager[None]:
        """
        Diagnostic context for env actions.
        """
        assert self.location is not None
        return diagnostic_context(self.location)

    @property
    def str_location(self) -> str:
        return ('unknown location'
                if self.location is None else
                self.location.gnu_style_repr())

    def check(self) -> None:
        """
        Check that the env action is legal.
        """
        pass

    def create_internal_properties(self, env_spec: EnvSpec) -> None:
        """
        Create properties needed for the emission of this env action.
        """
        pass

    def rewrite_property_refs(self,
                              mapping: Dict[PropertyDef, PropertyDef]) -> None:
        """
        Rewrite `PropertyDef` references according to `mapping`. See
        CompileCtx.lower_properties_dispatching.

        :param mapping: PropertyDef reference substitution mapping.
        """
        pass


class AddEnv(EnvAction):

    def __init__(
        self,
        no_parent: bool = False,
        transitive_parent: AbstractExpression | PropertyDef | None = None,
        names: AbstractExpression | PropertyDef | None = None,
        location: Location | None = None,
    ) -> None:
        super().__init__(location)
        self.no_parent = no_parent
        if isinstance(transitive_parent, PropertyDef):
            self.transitive_parent_prop: PropertyDef | None = transitive_parent
        else:
            self.transitive_parent_prop = None
            self.transitive_parent = transitive_parent or False
        if isinstance(names, PropertyDef):
            self.names_prop: PropertyDef | None = names
        else:
            self.names_prop = None
            self.names = names

    def create_internal_properties(self, env_spec: EnvSpec) -> None:
        self.transitive_parent_prop = env_spec.create_internal_property(
            'env_trans_parent', unsugar(self.transitive_parent), T.Bool
        )
        self.names_prop = env_spec.create_internal_property(
            'env_names', self.names, T.Symbol.array
        )


class AddToEnv(EnvAction):

    @dataclasses.dataclass
    class KVParams:
        """
        Arguments for the "add_to_env_kv()" action constructor.
        """
        key: AbstractExpression
        value: AbstractExpression
        dest_env: Optional[AbstractExpression]
        metadata: Optional[AbstractExpression]
        resolver: Optional[PropertyDef]

    def __init__(
        self,
        mappings: AbstractExpression | PropertyDef,
        resolver: PropertyDef | TypeRepo.Defer | None,
        location: Location | None = None,
    ) -> None:
        super().__init__(location)
        if isinstance(mappings, PropertyDef):
            self.mappings_prop: PropertyDef = mappings
        else:
            self.mappings = mappings
        self.resolver = resolver

        self.kv_params: AddToEnv.KVParams | None = None

    def create_internal_properties(self, env_spec: EnvSpec) -> None:
        self.mappings_prop = env_spec.create_internal_property(
            'env_mappings', self.mappings, None
        )

    def rewrite_property_refs(self,
                              mapping: Dict[PropertyDef, PropertyDef]) -> None:
        if self.resolver is not None:
            resolver = resolve_property(self.resolver)
            self.resolver = mapping.get(resolver, resolver)

    def check(self) -> None:
        ctx = get_context()
        resolver = self.resolver = resolve_property(self.resolver)
        with self.mappings_prop.diagnostic_context:
            mapping_type = self.mappings_prop.type
            if mapping_type.matches(T.env_assoc):
                ctx.has_env_assoc = True
            elif mapping_type.matches(T.env_assoc.array):
                ctx.has_env_assoc = True
                ctx.has_env_assoc_array = True
            else:
                check_source_language(
                    False,
                    'The bindings expression in environment specification must'
                    ' must be either an env_assoc or an array of env_assocs:'
                    ' got {} instead'.format(mapping_type.dsl_name)
                )

            if resolver:
                # Ask for the creation of untyped wrappers for all
                # properties used as entity resolvers.
                resolver.require_untyped_wrapper()

                check_source_language(
                    resolver.type.matches(T.entity),
                    'Entity resolver properties must return entities'
                    ' (got {})'.format(resolver.type.dsl_name)
                )
                check_source_language(
                    not resolver.dynamic_vars,
                    'Entity resolver properties must have no dynamically'
                    ' bound variable'
                )
                check_source_language(
                    not resolver.natural_arguments,
                    'Entity resolver properties must have no argument'
                )


class RefEnvs(EnvAction):
    """
    Couple of a property and an expression to evaluate referenced envs.
    """

    def __init__(
        self,
        resolver: PropertyDef | TypeRepo.Defer,
        nodes_expr: AbstractExpression | PropertyDef,
        kind: RefKind = RefKind.normal,
        dest_env: AbstractExpression | PropertyDef | None = None,
        cond: AbstractExpression | PropertyDef | None = None,
        category: str | None = None,
        shed_rebindings: bool = False,
        location: Location | None = None,
    ) -> None:
        """
        All nodes that nodes_expr yields must belong to the same analysis unit
        as the AST node that triggers this RefEnvs. Besides, the lexical
        environment to which these referenced environments are added must also
        belong to the same analysis unit. Attempts to add referenced
        environments that do not respect these rules will trigger a
        Property_Error.

        :param resolver: Property that takes no argument (explicit or implicit)
            appart from Self, and that returns a lexical environment.

        :param nodes_expr: Abstract expression that returns an array of AST
            nodes. Each node will be given to the above resolver in order to
            get corresponding referenced lexical envs.  In this array, null
            nodes are allowed: they are simply discarded.

        :param kind: Kind of reference.

        :param dest_env: Optional expression designating the destination env.
        """
        assert resolver
        assert nodes_expr

        super().__init__(location)

        self.resolver: PropertyDef | TypeRepo.Defer = resolver
        if isinstance(nodes_expr, PropertyDef):
            self.nodes_property = nodes_expr
        else:
            self.nodes_expr = nodes_expr
        self.kind = kind
        if isinstance(dest_env, PropertyDef):
            self.dest_env_prop: PropertyDef | None = dest_env
        else:
            self.dest_env_prop = None
            self.dest_env = dest_env
        if isinstance(cond, PropertyDef):
            self.cond_prop: PropertyDef | None = cond
        else:
            self.cond_prop = None
            self.cond = cond
        self.category = category and names.Name.from_lower(category)
        self.shed_rebindings = shed_rebindings

    def create_internal_properties(self, env_spec: EnvSpec) -> None:
        """
        Create the property that returns the list of nodes to resolve into
        referenced lexical envs.
        """
        self.nodes_property = env_spec.create_internal_property(
            'ref_env_nodes', self.nodes_expr, T.root_node.array
        )

        self.dest_env_prop = env_spec.create_internal_property(
            'env_dest', self.dest_env, T.LexicalEnv
        )

        self.cond_prop = env_spec.create_internal_property(
            'ref_cond', self.cond, T.Bool
        )

    def check(self) -> None:
        """
        Check that the resolver property is conforming.
        """
        ctx = get_context()
        ctx.has_ref_env = True

        self.resolver = resolver = resolve_property(self.resolver)
        resolver.require_untyped_wrapper()

        check_source_language(
            resolver.type.matches(T.LexicalEnv),
            'Referenced environment resolver must return a lexical'
            ' environment (not {})'.format(
                resolver.type.dsl_name
            )
        )
        check_source_language(
            not resolver.natural_arguments,
            'Referenced environment resolver must take no argument'
        )
        check_source_language(
            not resolver.dynamic_vars,
            'Referenced environment resolver must have no dynamically bound'
            ' variable'
        )

    def rewrite_property_refs(self,
                              mapping: Dict[PropertyDef, PropertyDef]) -> None:
        resolver = resolve_property(self.resolver)
        self.resolver = mapping.get(resolver, resolver)


class HandleChildren(EnvAction):
    """
    Stub class to delimit pre and post env actions.
    """
    pass


class SetInitialEnv(EnvAction):
    def __init__(
        self,
        env_expr: AbstractExpression | PropertyDef,
        location: Location | None = None,
    ):
        super().__init__(location)
        if isinstance(env_expr, PropertyDef):
            self.env_prop = env_expr
        else:
            self.env_expr = env_expr

    def create_internal_properties(self, env_spec: EnvSpec) -> None:
        self.env_prop = env_spec.create_internal_property(
            'initial_env', self.env_expr, T.DesignatedEnv
        )


class Do(EnvAction):
    def __init__(
        self,
        expr: AbstractExpression | PropertyDef,
        location: Location | None = None,
    ) -> None:
        super().__init__(location)
        if isinstance(expr, PropertyDef):
            self.do_property = expr
        else:
            self.expr = expr

    def create_internal_properties(self, spec: EnvSpec) -> None:
        self.do_property = spec.create_internal_property(
            'env_do', self.expr, None
        )
