# Copyright 2022 dogeystamp <dogeystamp@disroot.org>
# See LICENSE file for more details.

from bitmask import Bitmask
from enum import IntFlag
import pytest

class Desc(IntFlag):
    SMALL = 1
    ROUND = 1 << 1
    FUNKY = 1 << 2
    SONAR = 1 << 4

def test_eq():
    """Test equality checks."""
    assert Bitmask(Desc) == Bitmask(Desc)
    assert Bitmask(Desc, Desc.SMALL) == Bitmask(Desc, Desc.SMALL)
    assert Bitmask(Desc, Desc.SMALL, Desc.ROUND) == Bitmask(Desc, Desc.SMALL, Desc.ROUND)
    assert Bitmask(Desc, Desc.ROUND, Desc.SMALL) == Bitmask(Desc, Desc.SMALL, Desc.ROUND)

    assert Bitmask(Desc, Desc.SMALL) != Bitmask(Desc, Desc.SMALL, Desc.ROUND)
    assert Bitmask(Desc, Desc.SMALL) != Bitmask(Desc, Desc.ROUND)
    assert Bitmask(Desc, Desc.SMALL) != Bitmask(Desc)
    assert Bitmask(Desc, Desc.SMALL) != Desc.SMALL
    assert Bitmask(Desc, Desc.SMALL) != Desc.ROUND
    assert Bitmask(Desc) != Desc.ROUND

def test_repr():
    """Ensure evaluating __repr__ creates an identical object."""
    mask = Bitmask(Desc, Desc.ROUND, Desc.FUNKY)
    assert eval(repr(mask)) == mask

    empty_mask = Bitmask(Desc)
    assert eval(repr(empty_mask)) == empty_mask

def test_add():
    """Test Bitmask.add() method."""
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    mask.add(Desc.ROUND)
    assert mask == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)

    mask = Bitmask(Desc)
    mask.add(Desc.ROUND)
    assert mask == Bitmask(Desc, Desc.ROUND)
    mask.add(Desc.ROUND)
    assert mask == Bitmask(Desc, Desc.ROUND)

def test_add_operator():
    """Test + operator."""
    # Individual flags
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    assert mask + Desc.ROUND == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Desc.ROUND + mask == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Desc.SMALL + mask == Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    assert Bitmask(Desc) + Desc.ROUND == Bitmask(Desc, Desc.ROUND)

    # Union of bitmasks
    assert Bitmask(Desc, Desc.SMALL) + Bitmask(Desc, Desc.FUNKY, Desc.ROUND) \
        == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Bitmask(Desc, Desc.FUNKY, Desc.ROUND) + Bitmask(Desc, Desc.SMALL) \
        == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Bitmask(Desc) + Bitmask(Desc) == Bitmask(Desc)

def test_add_inline():
    """Test += operator."""
    # Individual flags
    mask = Bitmask(Desc)
    mask += Desc.FUNKY
    assert mask == Bitmask(Desc, Desc.FUNKY)
    mask += Desc.ROUND
    assert mask == Bitmask(Desc, Desc.FUNKY, Desc.ROUND)

    # Bitmasks
    mask = Bitmask(Desc)
    mask += Bitmask(Desc, Desc.ROUND, Desc.FUNKY)
    assert mask == Bitmask(Desc, Desc.FUNKY, Desc.ROUND)

def test_or_operator():
    """Test | operator."""
    # Individual flags
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    assert mask | Desc.ROUND == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Desc.ROUND | mask == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Desc.SMALL | mask == Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    assert Bitmask(Desc) | Desc.ROUND == Bitmask(Desc, Desc.ROUND)

    # Union of bitmasks
    assert Bitmask(Desc, Desc.SMALL) | Bitmask(Desc, Desc.FUNKY, Desc.ROUND) == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Bitmask(Desc, Desc.FUNKY, Desc.ROUND) | Bitmask(Desc, Desc.SMALL) == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Bitmask(Desc) | Bitmask(Desc) == Bitmask(Desc)

def test_or_inline():
    """Test |= operator."""
    # Individual flags
    mask = Bitmask(Desc)
    mask |= Desc.FUNKY
    assert mask == Bitmask(Desc, Desc.FUNKY)
    mask |= Desc.ROUND
    assert mask == Bitmask(Desc, Desc.FUNKY, Desc.ROUND)

    # Bitmasks
    mask = Bitmask(Desc)
    mask |= Bitmask(Desc, Desc.ROUND, Desc.FUNKY)
    assert mask == Bitmask(Desc, Desc.FUNKY, Desc.ROUND)

def test_and_operator():
    """Test & operator."""
    # Individual flags
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    assert mask & Desc.SMALL == Bitmask(Desc, Desc.SMALL)
    assert Desc.SMALL & mask == Bitmask(Desc, Desc.SMALL)
    assert Desc.ROUND & mask == Bitmask(Desc)
    assert Bitmask(Desc) & Desc.ROUND == Bitmask(Desc)

    # AND of bitmasks
    assert Bitmask(Desc, Desc.FUNKY, Desc.SONAR) & Bitmask(Desc, Desc.FUNKY, Desc.ROUND) == Bitmask(Desc, Desc.FUNKY)
    assert Bitmask(Desc, Desc.FUNKY, Desc.ROUND) & Bitmask(Desc, Desc.SMALL) == Bitmask(Desc)
    assert Bitmask(Desc) & Bitmask(Desc) == Bitmask(Desc)

def test_and_inline():
    """Test &= operator."""
    # Individual flags
    mask = Bitmask(Desc, Desc.FUNKY, Desc.SMALL)
    mask &= Desc.FUNKY
    assert mask == Bitmask(Desc, Desc.FUNKY)
    mask &= Desc.ROUND
    assert mask == Bitmask(Desc)

    # Bitmasks
    mask = Bitmask(Desc, Desc.ROUND, Desc.FUNKY)
    mask &= Bitmask(Desc, Desc.SMALL)
    assert mask == Bitmask(Desc)
        
def test_remove():
    """Test the `Bitmask.remove()` method."""
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    mask.remove(Desc.SMALL)
    assert mask == Bitmask(Desc, Desc.FUNKY)
    with pytest.raises(KeyError):
        mask.remove(Desc.SMALL)

    empty_mask = Bitmask(Desc)
    with pytest.raises(KeyError):
        empty_mask.remove(Desc.SMALL)

def test_discard():
    """Test the `Bitmask.discard()` method."""
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    mask.discard(Desc.SMALL)
    assert mask == Bitmask(Desc, Desc.FUNKY)
    mask.discard(Desc.SMALL)
    assert mask == Bitmask(Desc, Desc.FUNKY)

    empty_mask = Bitmask(Desc)
    empty_mask.discard(Desc.SMALL)
    assert empty_mask == Bitmask(Desc)
    with pytest.raises(TypeError):
        empty_mask.discard(Bitmask(Desc, Desc.SMALL))

def test_subtract():
    """Test - operator."""
    # Individual flag
    assert Bitmask(Desc, Desc.SMALL, Desc.FUNKY) - Desc.SMALL == Bitmask(Desc, Desc.FUNKY)
    assert Bitmask(Desc, Desc.FUNKY, Desc.SMALL) - Desc.SMALL == Bitmask(Desc, Desc.FUNKY)

    # Two bitmasks
    assert Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND) \
        - Bitmask(Desc, Desc.SMALL, Desc.ROUND) == Bitmask(Desc, Desc.FUNKY)
    assert Bitmask(Desc, Desc.FUNKY, Desc.SMALL) \
        - Bitmask(Desc, Desc.SMALL, Desc.FUNKY) == Bitmask(Desc)

def test_subtract_inline():
    """Test -= operator."""
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    mask -= Desc.SMALL
    assert mask == Bitmask(Desc, Desc.FUNKY)

def test_xor_operator():
    """Test ^ operator."""
    # Individual flags
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    assert mask ^ Desc.ROUND == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Desc.ROUND ^ mask == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Desc.SMALL ^ mask == Bitmask(Desc, Desc.FUNKY)
    assert Bitmask(Desc) ^ Desc.ROUND == Bitmask(Desc, Desc.ROUND)

    # XOR bitmasks
    assert Bitmask(Desc, Desc.SMALL) ^ Bitmask(Desc, Desc.FUNKY, Desc.ROUND) == Bitmask(Desc, Desc.SMALL, Desc.FUNKY, Desc.ROUND)
    assert Bitmask(Desc, Desc.FUNKY, Desc.ROUND) \
        ^ Bitmask(Desc, Desc.FUNKY, Desc.ROUND) == Bitmask(Desc)
    assert Bitmask(Desc) ^ Bitmask(Desc) == Bitmask(Desc)

def test_xor_inline():
    """Test ^= operator."""
    # Individual flags
    mask = Bitmask(Desc)
    mask ^= Desc.FUNKY
    assert mask == Bitmask(Desc, Desc.FUNKY)
    mask ^= Desc.ROUND
    assert mask == Bitmask(Desc, Desc.FUNKY, Desc.ROUND)
    mask ^= Desc.ROUND
    assert mask == Bitmask(Desc, Desc.FUNKY)

    # Bitmasks
    mask = Bitmask(Desc, Desc.ROUND)
    mask ^= Bitmask(Desc, Desc.ROUND, Desc.FUNKY)
    assert mask == Bitmask(Desc, Desc.FUNKY)

def test_value():
    """Ensure Bitmask.value lines up with the state."""
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    assert mask.value == 5
    mask.add(Desc.ROUND)
    assert mask.value ==  7

    assert Bitmask(Desc).value == 0

    # Setting values directly
    mask.value = 0
    assert mask == Bitmask(Desc)
    mask.value = 1
    assert mask == Bitmask(Desc, Desc.SMALL)
    with pytest.raises(TypeError):
        mask.value = 1j
    with pytest.raises(TypeError):
        mask.value = 2.5

def test_contains():
    """Test `flag in mask` check."""
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    empty_mask = Bitmask(Desc)

    # Individual flags
    assert Desc.FUNKY in mask
    assert Desc.SMALL in mask
    assert Desc.ROUND not in mask
    assert Desc.ROUND not in empty_mask

    # Bitmasks
    assert mask in mask
    assert Bitmask(Desc, Desc.SMALL, Desc.FUNKY) in mask
    assert Bitmask(Desc, Desc.FUNKY) in mask
    with pytest.raises(TypeError):
        x = 1 in mask

def test_iter():
    """Test iteration."""
    assert [i for i in Bitmask(Desc, Desc.SMALL, Desc.FUNKY)] == [Desc.SMALL, Desc.FUNKY]

def test_str():
    """Test string conversion."""
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)

    assert str(mask) == "SMALL|FUNKY"
    mask.add(Desc.ROUND)
    assert str(mask) == "SMALL|ROUND|FUNKY"
    assert str(Bitmask(Desc, Desc.ROUND)) == "ROUND"
    assert str(Bitmask(Desc)) == "0"

def test_int():
    """Test int conversion."""
    mask = Bitmask(Desc, Desc.SMALL, Desc.FUNKY)
    assert int(mask) == mask.value
    mask.value = 4
    assert int(mask) == mask.value

def test_hex():
    """Test hexadecimal conversion."""
    assert hex(Bitmask(Desc, Desc.SMALL)) == "0x1"
    assert hex(Bitmask(Desc)) == "0x0"
    assert hex(Bitmask(Desc, Desc.SONAR)) == "0x10"