seer/src/board/castle_rights.rs

use super::{Bitboard, Color, File, Square};

/// Current castle rights for a player.
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum CastleRights {
    /// No castling allowed.
    NoSide,
    /// King-side castling only.
    KingSide,
    /// Queen-side castling only.
    QueenSide,
    /// Either side allowed.
    BothSides,
}

impl CastleRights {
    /// The number of [CastleRights] variants.
    pub const NUM_VARIANTS: usize = 4;

    const ALL: [Self; Self::NUM_VARIANTS] = [
        Self::NoSide,
        Self::KingSide,
        Self::QueenSide,
        Self::BothSides,
    ];

    /// Iterate over all castle-rights variants.
    pub fn iter() -> impl Iterator<Item = Self> {
        Self::ALL.iter().cloned()
    }

    /// Convert from a castle rights index into a [CastleRights] type.
    ///
    /// # Panics
    ///
    /// Panics if the index is out of bounds.
    #[inline(always)]
    pub fn from_index(index: usize) -> Self {
        Self::try_from_index(index).expect("index out of bouds")
    }

    /// Convert from a castle rights index into a [CastleRights] type. Returns [None] if the index
    /// is out of bounds.
    pub fn try_from_index(index: usize) -> Option<Self> {
        if index < Self::NUM_VARIANTS {
            // SAFETY: we know the value is in-bounds
            Some(unsafe { Self::from_index_unchecked(index) })
        } else {
            None
        }
    }

    /// Convert from a castle rights index into a [CastleRights] type, no bounds checking.
    ///
    /// # Safety
    ///
    /// This should only be called with values that can be output by [CastleRights::index()].
    #[inline(always)]
    pub unsafe fn from_index_unchecked(index: usize) -> Self {
        std::mem::transmute(index as u8)
    }

    /// Return the index of a given [CastleRights].
    #[inline(always)]
    pub fn index(self) -> usize {
        self as usize
    }

    /// Can the player castle king-side.
    #[inline(always)]
    pub fn has_king_side(self) -> bool {
        (self.index() & 1) != 0
    }

    /// Can the player castle king-side.
    #[inline(always)]
    pub fn has_queen_side(self) -> bool {
        (self.index() & 2) != 0
    }

    /// Add king-side castling rights.
    #[inline(always)]
    pub fn with_king_side(self) -> Self {
        self.add(Self::KingSide)
    }

    /// Add queen-side castling rights.
    #[inline(always)]
    pub fn with_queen_side(self) -> Self {
        self.add(Self::QueenSide)
    }

    /// Add some [CastleRights], and return the resulting [CastleRights].
    #[inline(always)]
    fn add(self, additional_rights: CastleRights) -> Self {
        // SAFETY: we know the value is in-bounds
        unsafe { Self::from_index_unchecked(self.index() | additional_rights.index()) }
    }

    /// Remove king-side castling rights.
    #[inline(always)]
    pub fn without_king_side(self) -> Self {
        self.remove(Self::KingSide)
    }

    /// Remove queen-side castling rights.
    #[inline(always)]
    pub fn without_queen_side(self) -> Self {
        self.remove(Self::QueenSide)
    }

    /// Remove some [CastleRights], and return the resulting [CastleRights].
    #[inline(always)]
    pub fn remove(self, to_remove: CastleRights) -> Self {
        // SAFETY: we know the value is in-bounds
        unsafe { Self::from_index_unchecked(self.index() & !to_remove.index()) }
    }

    /// Which rooks have not been moved for a given [CastleRights] and [Color].
    #[inline(always)]
    pub fn unmoved_rooks(self, color: Color) -> Bitboard {
        let rank = color.first_rank();

        let king_side_square = Square::new(File::H, rank);
        let queen_side_square = Square::new(File::A, rank);

        match self {
            Self::NoSide => Bitboard::EMPTY,
            Self::KingSide => king_side_square.into_bitboard(),
            Self::QueenSide => queen_side_square.into_bitboard(),
            Self::BothSides => king_side_square | queen_side_square,
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn from_index() {
        assert_eq!(CastleRights::from_index(0), CastleRights::NoSide);
        assert_eq!(CastleRights::from_index(1), CastleRights::KingSide);
        assert_eq!(CastleRights::from_index(2), CastleRights::QueenSide);
        assert_eq!(CastleRights::from_index(3), CastleRights::BothSides);
    }

    #[test]
    fn index() {
        assert_eq!(CastleRights::NoSide.index(), 0);
        assert_eq!(CastleRights::KingSide.index(), 1);
        assert_eq!(CastleRights::QueenSide.index(), 2);
        assert_eq!(CastleRights::BothSides.index(), 3);
    }

    #[test]
    fn has_kingside() {
        assert!(!CastleRights::NoSide.has_king_side());
        assert!(!CastleRights::QueenSide.has_king_side());
        assert!(CastleRights::KingSide.has_king_side());
        assert!(CastleRights::BothSides.has_king_side());
    }

    #[test]
    fn has_queenside() {
        assert!(!CastleRights::NoSide.has_queen_side());
        assert!(!CastleRights::KingSide.has_queen_side());
        assert!(CastleRights::QueenSide.has_queen_side());
        assert!(CastleRights::BothSides.has_queen_side());
    }

    #[test]
    fn without_king_side() {
        assert_eq!(
            CastleRights::NoSide.without_king_side(),
            CastleRights::NoSide
        );
        assert_eq!(
            CastleRights::KingSide.without_king_side(),
            CastleRights::NoSide
        );
        assert_eq!(
            CastleRights::QueenSide.without_king_side(),
            CastleRights::QueenSide
        );
        assert_eq!(
            CastleRights::BothSides.without_king_side(),
            CastleRights::QueenSide
        );
    }

    #[test]
    fn without_queen_side() {
        assert_eq!(
            CastleRights::NoSide.without_queen_side(),
            CastleRights::NoSide
        );
        assert_eq!(
            CastleRights::QueenSide.without_queen_side(),
            CastleRights::NoSide
        );
        assert_eq!(
            CastleRights::KingSide.without_queen_side(),
            CastleRights::KingSide
        );
        assert_eq!(
            CastleRights::BothSides.without_queen_side(),
            CastleRights::KingSide
        );
    }

    #[test]
    fn unmoved_rooks() {
        assert_eq!(
            CastleRights::NoSide.unmoved_rooks(Color::White),
            Bitboard::EMPTY
        );
        assert_eq!(
            CastleRights::NoSide.unmoved_rooks(Color::Black),
            Bitboard::EMPTY
        );
        assert_eq!(
            CastleRights::KingSide.unmoved_rooks(Color::White),
            Square::H1.into_bitboard()
        );
        assert_eq!(
            CastleRights::KingSide.unmoved_rooks(Color::Black),
            Square::H8.into_bitboard()
        );
        assert_eq!(
            CastleRights::QueenSide.unmoved_rooks(Color::White),
            Square::A1.into_bitboard()
        );
        assert_eq!(
            CastleRights::QueenSide.unmoved_rooks(Color::Black),
            Square::A8.into_bitboard()
        );
        assert_eq!(
            CastleRights::BothSides.unmoved_rooks(Color::White),
            Square::A1 | Square::H1
        );
        assert_eq!(
            CastleRights::BothSides.unmoved_rooks(Color::Black),
            Square::A8 | Square::H8
        );
    }
}