retroboard 0.2.9

use std::fmt;

use arrayvec::ArrayVec;
use lazy_static::lazy_static;
use regex::Regex;
use shakmaty::{Role, Square};

/// A container for unmoves that can be stored inline on the stack.
///
/// The capacity is limited, but there is enough space to hold the legal unmoves of any chess position.
pub type UnMoveList = ArrayVec<UnMove, 512>; // TODO check if reducing that number is possible (256 used for std in shakmaty)

/// Error when parsing an invalid retro UCI.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ParseRetroUciError;

/// Enum representing the different kind of type an [`UnMove`] can be.
#[derive(Debug, Hash, Eq, PartialEq, Clone, Copy)]
pub enum MoveKind {
    Normal,
    EnPassant,
    UnPromotion(Option<Role>),
    Uncapture(Role),
}

impl MoveKind {
    pub fn new(
        special_move: Option<&str>,
        uncapture: Option<&str>,
    ) -> Result<Self, ParseRetroUciError> {
        let role_opt = uncapture
            .and_then(|x| x.chars().next())
            .and_then(Role::from_char);
        match special_move {
            Some("U") => Ok(Self::UnPromotion(role_opt)),
            Some("E") if role_opt.is_none() => Ok(Self::EnPassant),
            Some("") if role_opt.is_some() => Ok(Self::Uncapture(role_opt.unwrap())), // if let guard experimental
            Some("") => Ok(Self::Normal),
            _ => Err(ParseRetroUciError),
        }
    }

    #[must_use]
    pub fn is_uncapture(&self) -> bool {
        matches!(self, Self::Uncapture(_))
    }

    #[must_use]
    pub fn is_en_passant(&self) -> bool {
        matches!(self, Self::EnPassant)
    }

    #[must_use]
    pub fn is_unpromotion(&self) -> bool {
        matches!(self, Self::UnPromotion(_))
    }

    #[must_use]
    pub fn to_retro_uci(&self) -> String {
        match self {
            Self::Normal => "".to_string(),
            Self::EnPassant => "E".to_string(),
            Self::Uncapture(role) => role.upper_char().to_string(),
            Self::UnPromotion(role_opt) => {
                "U".to_string()
                    + &role_opt.map_or_else(|| "".to_owned(), |role| role.upper_char().to_string())
            }
        }
    }
}

/// Information about a move.
///
/// Called [`UnMove`] not to be confused with [`shakmaty::Move`]. When there is no doubt about which one is reffered to, can be called "move".
#[derive(Hash, Eq, PartialEq, Clone)]
pub struct UnMove {
    pub from: Square,
    pub to: Square,
    move_kind: MoveKind,
}

impl UnMove {
    /// movements are represented with uci, but for uncapture and unpromote
    /// a special syntax is used:
    ///
    /// -Uncapture: the piece left at the source square is indicated at the beginning, follow by normal uci move.
    /// e.g: "Re2e4" the piece on e2 goes on e4 and leaves a Rook from the opposite color on e2.
    ///
    /// -Unpromotion: "U" and after the square from which the piece will underpromote and the
    /// source square must be on the 8th or 1st rank, and dest square must be on first or second rank.
    /// e.g: "Ue8e7".
    /// An unpromotion can also be an uncapture, in this case it's noted "<PieceType>U<from_square><to_square>"
    /// e.g "UNe8e7"
    ///
    /// -En passant: "E" then the source square of the pawn and the destination of it.
    /// When a move is en-passsant, it cannot Uncapture anything (since the pawn uncapture is already implied)
    /// e.g "Ed6e5". Note than it's different than "Pd6e5". In the first example, the uncaptured pawn is in `d5`,
    /// while in the second one it's in `d6`.
    ///
    /// regex: r"\[UE\]?\[NBRQ\]?(\[abcdefgh\]\[1-8\]){2}"
    ///
    /// Note: A unmove being accepted does not means it is for sure legal, just syntaxically correct
    /// # Examples
    ///
    /// ```
    /// use retroboard::UnMove;
    /// use shakmaty::{Square, Role};
    ///
    /// let simple_move: UnMove = UnMove::from_retro_uci("Pe2e4").unwrap();
    /// assert_eq!(simple_move.from, Square::E2);
    /// assert_eq!(simple_move.to, Square::E4);
    /// assert_eq!(simple_move.uncapture(), Some(Role::Pawn));
    ///
    /// let unpromotion: UnMove = UnMove::from_retro_uci("Ue8e7").unwrap();
    /// assert_eq!(unpromotion.from, Square::E8);
    /// assert_eq!(unpromotion.to, Square::E7);
    /// assert!(unpromotion.is_unpromotion());
    /// assert!(!unpromotion.is_en_passant());
    ///
    /// let en_passant: UnMove = UnMove::from_retro_uci("Ee3d4").unwrap();
    /// assert_eq!(en_passant.from, Square::E3);
    /// assert_eq!(en_passant.to, Square::D4);
    /// assert!(en_passant.is_en_passant());
    /// assert!(!en_passant.is_unpromotion());
    /// ```

    #[allow(clippy::doc_markdown)]
    pub fn from_retro_uci(retro_uci: &str) -> Result<UnMove, ParseRetroUciError> {
        lazy_static! {
        static ref UNMOVE_REGEX: Regex = Regex::new(r"^(?P<special_move>[UE]?)(?P<uncapture>[PNBRQ]?)(?P<from>([abcdefgh][1-8]))(?P<to>([abcdefgh][1-8]))$").unwrap();
        }
        UNMOVE_REGEX
            .captures(retro_uci)
            .and_then(|cap| {
                Some(UnMove {
                    from: cap
                        .name("from")
                        .and_then(|x| Square::from_ascii(x.as_str().as_bytes()).ok())?,
                    to: cap
                        .name("to")
                        .and_then(|x| Square::from_ascii(x.as_str().as_bytes()).ok())?,
                    move_kind: MoveKind::new(
                        cap.name("special_move").map(|m| m.as_str()),
                        cap.name("uncapture").map(|m| m.as_str()),
                    )
                    .ok()?,
                })
            })
            .ok_or(ParseRetroUciError)
    }

    /// Retuns a new [`UnMove`].
    #[inline]
    #[must_use]
    pub fn new(from: Square, to: Square, move_kind: MoveKind) -> Self {
        Self {
            from,
            to,
            move_kind,
        }
    }

    /// Returns a string following the retro uci standard. See [`UnMove::from_retro_uci`] for more information.
    #[must_use]
    pub fn to_retro_uci(&self) -> String {
        format!("{}{}{}", self.move_kind.to_retro_uci(), self.from, self.to)
    }

    #[inline]
    #[must_use]
    pub fn is_uncapture(&self) -> bool {
        self.move_kind.is_uncapture()
    }

    #[inline]
    #[must_use]
    pub fn uncapture(&self) -> Option<Role> {
        match self.move_kind {
            MoveKind::Normal => None,
            MoveKind::Uncapture(role) => Some(role),
            MoveKind::UnPromotion(role_opt) => role_opt,
            MoveKind::EnPassant => Some(Role::Pawn),
        }
    }

    #[inline]
    #[must_use]
    pub fn is_unpromotion(&self) -> bool {
        self.move_kind.is_unpromotion()
    }

    #[inline]
    #[must_use]
    pub fn is_en_passant(&self) -> bool {
        self.move_kind.is_en_passant()
    }

    /// If the move is an uncapture moves, returns the square when the piece uncaptured will land.
    /// It is always the `from` square, except for en-passant move.
    /// # Examples
    ///
    /// ```
    /// use retroboard::UnMove;
    /// use shakmaty::Square;
    ///
    /// assert_eq!(
    ///     UnMove::from_retro_uci("Ed3e4")
    ///         .unwrap()
    ///         .uncapture_square()
    ///         .unwrap(),
    ///     Square::D4,
    /// );
    /// assert_eq!(
    ///     UnMove::from_retro_uci("Qa8h1")
    ///         .unwrap()
    ///         .uncapture_square()
    ///         .unwrap(),
    ///     Square::A8,
    /// );
    /// ```
    #[must_use]
    pub fn uncapture_square(&self) -> Option<Square> {
        self.uncapture().map(|_| {
            if self.is_en_passant() {
                Square::from_coords(self.from.file(), self.to.rank())
            } else {
                self.from
            }
        })
    }

    /// Map the `from` and `to` attribute vertically. Represent the same move if player's color were swapped
    /// # Examples
    ///
    /// ```
    /// use retroboard::UnMove;
    ///
    /// assert_eq!(
    ///     UnMove::from_retro_uci("Ua1a2").unwrap().mirror(),
    ///     UnMove::from_retro_uci("Ua8a7").unwrap()
    /// );
    /// ```
    #[inline]
    #[must_use]
    pub fn mirror(&self) -> Self {
        Self {
            from: self.from.flip_vertical(),
            to: self.to.flip_vertical(),
            move_kind: self.move_kind,
        }
    }
}

impl fmt::Debug for UnMove {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(&self.to_retro_uci())
    }
}

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

    #[test]
    fn test_parse_retro_uci_simple_move() {
        let simple_move: UnMove = UnMove::from_retro_uci("e2e4").unwrap();
        assert_eq!(simple_move.from, Square::E2);
        assert_eq!(simple_move.to, Square::E4);
        assert_eq!(simple_move.uncapture(), None);
        assert!(!simple_move.is_unpromotion());
        assert!(!simple_move.is_en_passant());
    }

    #[test]
    fn test_parse_retro_uci_uncapture() {
        let simple_move: UnMove = UnMove::from_retro_uci("Pe2e4").unwrap();
        assert_eq!(simple_move.from, Square::E2);
        assert_eq!(simple_move.to, Square::E4);
        assert_eq!(simple_move.uncapture(), Some(Role::Pawn));
        assert!(!simple_move.is_unpromotion());
        assert!(!simple_move.is_en_passant());
    }

    #[test]
    fn test_parse_retro_uci_unpromotion() {
        let simple_move: UnMove = UnMove::from_retro_uci("Ue8e7").unwrap();
        assert_eq!(simple_move.from, Square::E8);
        assert_eq!(simple_move.to, Square::E7);
        assert!(simple_move.is_unpromotion());
        assert!(!simple_move.is_en_passant());
    }

    #[test]
    fn test_parse_retro_uci_en_passant() {
        let simple_move: UnMove = UnMove::from_retro_uci("Ee3d4").unwrap();
        assert_eq!(simple_move.from, Square::E3);
        assert_eq!(simple_move.to, Square::D4);
        assert!(simple_move.is_en_passant());
        assert!(!simple_move.is_unpromotion());
    }

    #[test]
    fn test_parse_retro_uci_en_passant_error() {
        let e: Result<UnMove, ParseRetroUciError> = Err(ParseRetroUciError);
        assert_eq!(UnMove::from_retro_uci("EPe3d4"), e);
        assert_eq!(UnMove::from_retro_uci("EQe3d4"), e);
    }

    #[test]
    fn test_to_uci() {
        for x in &["e2e4", "Pe2e4", "Ue8e7", "Ee3d4", "Qa1a2", "Ba1a2", "Nd4d5"] {
            let unmove: UnMove = UnMove::from_retro_uci(x).unwrap();
            assert_eq!(*x, &unmove.to_retro_uci());
            assert_eq!(format!("{:?}", unmove), *x);
        }
    }

    #[test]
    fn test_mirror() {
        assert_eq!(
            UnMove::from_retro_uci("a1a8").unwrap().mirror(),
            UnMove::from_retro_uci("a8a1").unwrap()
        );
        assert_eq!(
            UnMove::from_retro_uci("Qa1a8").unwrap().mirror(),
            UnMove::from_retro_uci("Qa8a1").unwrap()
        );
        assert_eq!(
            UnMove::from_retro_uci("Ua1a2").unwrap().mirror(),
            UnMove::from_retro_uci("Ua8a7").unwrap()
        );
        assert_eq!(
            UnMove::from_retro_uci("Ua1b2").unwrap().mirror(),
            UnMove::from_retro_uci("Ua8b7").unwrap()
        );
        assert_eq!(
            UnMove::from_retro_uci("Ef3e4").unwrap().mirror(),
            UnMove::from_retro_uci("Ef6e5").unwrap()
        );
    }

    #[test]
    fn test_uncapture_square() {
        // part of the test is in rust-doc
        assert_eq!(
            UnMove::from_retro_uci("Eb6c5")
                .unwrap()
                .uncapture_square()
                .unwrap(),
            Square::B5,
        );
    }
}