slidy 0.3.2

//! Defines the [`ColorScheme`] trait, and some related traits and implementations.

pub mod balanced_split;
pub mod grid_tiled;
pub mod multi_layer;
pub mod scheme_list;
pub mod tiled;

use palette::rgb::Rgba;
use thiserror::Error;

use crate::puzzle::{
    coloring::Coloring,
    grids::Grids,
    label::{label::Label, rect_partition::Rect},
    size::Size,
};

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Error type for [`ColorScheme`].
#[derive(Clone, Debug, Error, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum ColorSchemeError {
    /// Returned when the `(x, y)` position is outside the bounds of the puzzle.
    #[error("PositionOutOfBounds: position {pos:?} is out of bounds on a {size} puzzle")]
    PositionOutOfBounds {
        /// Size of the puzzle.
        size: Size,
        /// Piece position.
        pos: (u64, u64),
    },
}

/// Provides a function mapping `(x, y)` coordinate on a puzzle to a color.
pub trait ColorScheme {
    /// See [`ColorScheme::try_color`].
    ///
    /// This function may not check whether `pos` is within the bounds of the puzzle. If this
    /// condition is not satisfied, the function may panic or return any other color.
    #[must_use]
    fn color(&self, size: Size, pos: (u64, u64)) -> Rgba;

    /// Returns the color of the piece in position `pos` on a solved puzzle of the given size.
    fn try_color(&self, size: Size, pos: (u64, u64)) -> Result<Rgba, ColorSchemeError> {
        if size.is_within_bounds(pos) {
            Ok(self.color(size, pos))
        } else {
            Err(ColorSchemeError::PositionOutOfBounds { size, pos })
        }
    }

    /// Restricts the [`ColorScheme`] to a single size.
    #[must_use]
    fn fixed_size(self, size: Size) -> FixedSize<Self>
    where
        Self: Sized,
    {
        FixedSize { scheme: self, size }
    }

    /// Restricts the [`ColorScheme`] to a single size, holding a reference to the inner scheme
    /// rather than taking ownership.
    #[must_use]
    fn fixed_size_ref(&self, size: Size) -> FixedSize<&Self>
    where
        Self: Sized,
    {
        FixedSize { scheme: self, size }
    }
}

impl<C: ColorScheme + ?Sized> ColorScheme for &C {
    fn color(&self, size: Size, pos: (u64, u64)) -> Rgba {
        (**self).color(size, pos)
    }
}

impl<C: ColorScheme + ?Sized> ColorScheme for &mut C {
    fn color(&self, size: Size, pos: (u64, u64)) -> Rgba {
        (**self).color(size, pos)
    }
}

impl<C: ColorScheme + ?Sized> ColorScheme for Box<C> {
    fn color(&self, size: Size, pos: (u64, u64)) -> Rgba {
        (**self).color(size, pos)
    }
}

/// A [`ColorScheme`] that is defined for a puzzle of a single size.
pub trait FixedSizeColorScheme {
    /// Returns the [`Size`] of the puzzle that this label is defined for.
    #[must_use]
    fn size(&self) -> Size;

    /// See [`ColorScheme::color`].
    #[must_use]
    fn color(&self, pos: (u64, u64)) -> Rgba;

    /// See [`ColorScheme::try_color`].
    fn try_color(&self, pos: (u64, u64)) -> Result<Rgba, ColorSchemeError> {
        let size = self.size();

        if size.is_within_bounds(pos) {
            Ok(self.color(pos))
        } else {
            Err(ColorSchemeError::PositionOutOfBounds { size, pos })
        }
    }
}

impl<C: FixedSizeColorScheme + ?Sized> FixedSizeColorScheme for &C {
    fn size(&self) -> Size {
        (**self).size()
    }

    fn color(&self, pos: (u64, u64)) -> Rgba {
        (**self).color(pos)
    }
}

impl<C: FixedSizeColorScheme + ?Sized> FixedSizeColorScheme for &mut C {
    fn size(&self) -> Size {
        (**self).size()
    }

    fn color(&self, pos: (u64, u64)) -> Rgba {
        (**self).color(pos)
    }
}

impl<C: FixedSizeColorScheme + ?Sized> FixedSizeColorScheme for Box<C> {
    fn size(&self) -> Size {
        (**self).size()
    }

    fn color(&self, pos: (u64, u64)) -> Rgba {
        (**self).color(pos)
    }
}

/// A [`ColorScheme`] restricted to a single size.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct FixedSize<C: ColorScheme> {
    scheme: C,
    size: Size,
}

impl<C: ColorScheme> FixedSize<C> {
    /// Returns a reference to the inner [`ColorScheme`].
    pub fn inner(&self) -> &C {
        &self.scheme
    }

    /// Extracts the inner [`ColorScheme`], consuming `self`.
    pub fn into_inner(self) -> C {
        self.scheme
    }
}

impl<C: ColorScheme> FixedSizeColorScheme for FixedSize<C> {
    fn size(&self) -> Size {
        self.size
    }

    fn color(&self, pos: (u64, u64)) -> Rgba {
        self.scheme.color(self.size, pos)
    }
}

/// A color scheme formed by composing a [`Label`] and a [`Coloring`].
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Scheme<L: Label, C: Coloring> {
    label: L,
    coloring: C,
}

impl<L: Label, C: Coloring> Scheme<L, C> {
    /// Create a new [`Scheme`] from a [`Label`] and a [`Coloring`].
    #[must_use]
    pub fn new(label: L, coloring: C) -> Self {
        Self { label, coloring }
    }

    /// The [`Label`] of the [`Scheme`].
    #[must_use]
    pub fn label(&self) -> &L {
        &self.label
    }

    /// The [`Coloring`] of the [`Scheme`].
    #[must_use]
    pub fn coloring(&self) -> &C {
        &self.coloring
    }
}

impl<L: Label, C: Coloring> ColorScheme for Scheme<L, C> {
    fn color(&self, size: Size, pos: (u64, u64)) -> Rgba {
        let label = self.label.position_label(size, pos);
        let num_labels = self.label.num_labels(size);
        self.coloring.color(label, num_labels)
    }
}

impl<L: Label + Grids, C: Coloring> Grids for Scheme<L, C> {
    fn grid_containing_pos(&self, size: Size, pos: (u64, u64)) -> Rect {
        self.label().grid_containing_pos(size, pos)
    }
}

/// A [`ColorScheme`] that always outputs black. This is just to make using [`Renderer`] more
/// convenient (because most of the time, we probably want black text and black borders).
///
/// [`Renderer`]: ../renderer.html
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Black;

impl ColorScheme for Black {
    fn color(&self, _size: Size, _pos: (u64, u64)) -> Rgba {
        Rgba::new(0.0, 0.0, 0.0, 1.0)
    }
}