1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

mod raw_gui_message;
use raw_gui_message::RawGuiMessage;

dry_mods::mods! {
    pub mod use go, register, set_option, set_position;
}

// TODO: Tests

use crate::define_message_enum::define_message_enum;
use crate::{MessageParseError, MessageTryFromRawMessageError};
use std::fmt::{Debug, Display, Formatter};
use std::str::FromStr;

define_message_enum! {
    /// A message sent from the GUI to the engine.
    enum GuiMessage {
        /// <https://backscattering.de/chess/uci/#gui-uci>
        %["uci"]
        UseUci,
        /// <https://backscattering.de/chess/uci/#gui-debug>
        %["debug"]
        Debug(%bool),
        /// <https://backscattering.de/chess/uci/#gui-isready>
        %["isready"]
        IsReady,
        /// <https://backscattering.de/chess/uci/#gui-setoption>
        %["setoption"]
        %%[parameters = [(Name, "name"), (Value, "value")]]
        SetOption(%SetOptionMessage),
        /// <https://backscattering.de/chess/uci/#gui-register>
        %["register"]
        %%[parameters = [(Name, "name"), (Code, "code")]]
        Register(%RegisterMessageKind),
        /// <https://backscattering.de/chess/uci/#gui-ucinewgame>
        %["ucinewgame"]
        UciNewGame,
        /// <https://backscattering.de/chess/uci/#gui-position>
        %["position"]
        %%[parameters = [(Fen, "fen"), (Moves, "moves")]]
        SetPosition(%SetPositionMessageKind),
        /// <https://backscattering.de/chess/uci/#gui-go>
        %["go"]
        %%[parameters = [(SearchMoves, "searchmoves"), **(Ponder, "ponder"), (WhiteTime, "wtime"), (BlackTime, "btime"), (WhiteIncrement, "winc"), (BlackIncrement, "binc"), (MovesToGo, "movestogo"), (Depth, "depth"), (Nodes, "nodes"), (Mate, "mate"), (MoveTime, "movetime"), **(Infinite, "infinite")]]
        Go(%GoMessage),
        /// <https://backscattering.de/chess/uci/#gui-stop>
        %["stop"]
        Stop,
        /// <https://backscattering.de/chess/uci/#gui-ponderhit>
        %["ponderhit"]
        PonderHit,
        /// <https://backscattering.de/chess/uci/#gui-quit>
        %["quit"]
        Quit
    }
}

impl FromStr for GuiMessage {
    type Err = MessageParseError<GuiMessageParameterPointer>;

    /// Tries to parse a string into this message.
    ///
    /// # Errors
    ///
    /// - Errors with [`MessageParseError::RawMessageParseError`] if the string could not be parsed into a [`RawGuiMessage`].
    /// - Errors with [`MessageParseError::MessageTryFromRawMessageError`] if the [`RawUciMessage`] could not be parsed into [`Self`].
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let raw_message =
            RawGuiMessage::from_str(s).map_err(MessageParseError::RawMessageParseError)?;

        Self::try_from(raw_message).map_err(MessageParseError::MessageTryFromRawMessageError)
    }
}

impl TryFrom<RawGuiMessage> for GuiMessage {
    type Error = MessageTryFromRawMessageError<GuiMessageParameterPointer>;

    #[allow(clippy::too_many_lines)]
    fn try_from(raw_message: RawGuiMessage) -> Result<Self, Self::Error> {
        match raw_message.message_pointer {
            // Value-less, parameter-less messages
            GuiMessagePointer::UseUci => Ok(Self::UseUci),
            GuiMessagePointer::IsReady => Ok(Self::IsReady),
            GuiMessagePointer::UciNewGame => Ok(Self::UciNewGame),
            GuiMessagePointer::Stop => Ok(Self::Stop),
            GuiMessagePointer::PonderHit => Ok(Self::PonderHit),
            GuiMessagePointer::Quit => Ok(Self::Quit),
            // Messages with values/parameters
            GuiMessagePointer::Debug => match raw_message
                .value
                .ok_or(Self::Error::MissingValue)?
                .as_bytes()
            {
                b"on" => Ok(Self::Debug(true)),
                b"off" => Ok(Self::Debug(false)),
                _ => Err(Self::Error::ValueParseError),
            },
            GuiMessagePointer::SetOption => {
                Ok(Self::SetOption(SetOptionMessage::try_from(raw_message)?))
            }
            GuiMessagePointer::Register => {
                Ok(Self::Register(RegisterMessageKind::try_from(raw_message)?))
            }
            GuiMessagePointer::SetPosition => Ok(Self::SetPosition(
                SetPositionMessageKind::try_from(raw_message)?,
            )),
            GuiMessagePointer::Go => Ok(Self::Go(GoMessage::try_from(raw_message)?)),
        }
    }
}

impl Display for GuiMessage {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::UseUci => f.write_str("uci\n"),
            Self::Debug(value) => writeln!(f, "debug {}", if *value { "on" } else { "off" }),
            Self::IsReady => f.write_str("isready\n"),
            Self::SetOption(message) => f.write_str(&message.to_string()),
            Self::Register(kind) => f.write_str(&kind.to_string()),
            Self::UciNewGame => f.write_str("ucinewgame\n"),
            Self::SetPosition(kind) => f.write_str(&kind.to_string()),
            Self::Go(message) => f.write_str(&message.to_string()),
            Self::Stop => f.write_str("stop\n"),
            Self::PonderHit => f.write_str("ponderhit\n"),
            Self::Quit => f.write_str("quit\n"),
        }
    }
}