#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright © Nekoka.tt 2019-2020
#
# This file is part of Hikari.
#
# Hikari is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Hikari is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Hikari. If not, see <https://www.gnu.org/licenses/>.
"""Components and entities that are used to describe both custom and Unicode
emojis on Discord.
"""
import typing

from hikari._internal import marshaller
from hikari.core import entities
from hikari.core import snowflakes
from hikari.core import users

__all__ = ["Emoji", "UnicodeEmoji", "UnknownEmoji", "GuildEmoji"]


@marshaller.attrs(slots=True)
class Emoji(entities.HikariEntity, entities.Deserializable):
    """Base class for all emojis."""


@marshaller.attrs(slots=True)
class UnicodeEmoji(Emoji):
    """Represents a unicode emoji."""

    #: The codepoints that form the emoji.
    #:
    #: :type: :obj:`str`
    name: str = marshaller.attrib(deserializer=str)


@marshaller.attrs(slots=True)
class UnknownEmoji(Emoji, snowflakes.UniqueEntity):
    """Represents a unknown emoji."""

    #: The name of the emoji.
    #:
    #: :type: :obj:`str`, optional
    name: typing.Optional[str] = marshaller.attrib(deserializer=str, if_none=None)

    #: Wheter the emoji is animated.
    #:
    #: :type: :obj:`bool`
    is_animated: bool = marshaller.attrib(raw_name="animated", deserializer=bool, if_undefined=False)


@marshaller.attrs(slots=True)
class GuildEmoji(UnknownEmoji):
    """Represents a guild emoji."""

    #: The whitelisted role IDs to use this emoji.
    #:
    #: :type: :obj:`typing.Set` [ :obj:`snowflakes.Snowflake` ]
    role_ids: typing.Set[snowflakes.Snowflake] = marshaller.attrib(
        raw_name="roles",
        deserializer=lambda roles: {snowflakes.Snowflake.deserialize(r) for r in roles},
        if_undefined=dict,
    )

    #: The user that created the emoji.
    #:
    #: Note
    #: ----
    #: This will be ``None`` if you are missing ``MANAGE_EMOJIS``` permission
    #: in the server the emoji is from
    #: (<https://github.com/discordapp/discord-api-docs/issues/593#issuecomment-386477863>)
    #:
    #: :type: :obj:`users.User`, optional
    user: typing.Optional[users.User] = marshaller.attrib(
        deserializer=users.User.deserialize, if_none=None, if_undefined=None
    )

    #: Whether this emoji must be wrapped in colons.
    #:
    #: :type: :obj:`bool`, optional
    is_colons_required: typing.Optional[bool] = marshaller.attrib(
        raw_name="require_colons", deserializer=bool, if_undefined=None
    )

    #: Wheter the emoji is managed by an integration.
    #:
    #: :type: :obj:`bool`, optional
    is_managed: typing.Optional[bool] = marshaller.attrib(raw_name="managed", deserializer=bool, if_undefined=None)


def deserialize_reaction_emoji(payload: typing.Dict) -> typing.Union[UnicodeEmoji, UnknownEmoji]:
    """Deserialize a reaction emoji into an emoji."""
    if payload.get("id"):
        return UnknownEmoji.deserialize(payload)

    return UnicodeEmoji.deserialize(payload)
