吸血鬼-uci

吸血鬼 UCI 是一个 通用棋类接口（UCI）协议 解析器和序列化器。

UCI 协议是棋类引擎与棋盘图形用户界面（如 Cute Chess）通信的一种方式。

Vampirc 项目 是一个用 Rust 编写的棋类引擎和棋类库套件，以斯洛文尼亚特级大师 Vasja Pirc 的名字命名，以及，我想，吸血鬼？我不知道。

吸血鬼 UCI 使用 PEST 解析器 来解析 UCI 消息。如果您想构建自己对该协议的抽象，相应的 PEG 语法可以在 这里 获取。

安装库

要使用此包，请在您的 Cargo.toml 文件中声明对其的依赖项

[dependencies]
vampirc-uci = "0.11"

然后，在您的包根目录中引用 vampirc_uci 包

extern crate vampirc_uci;

使用方法

1. 选择并导入一个 parse.. 函数。请参阅 选择解析函数。

use vampirc_uci::parse;

2. 一些其他有用的导入（用于消息表示）

use vampirc_uci::{UciMessage, MessageList, UciTimeControl, Serializable};

3. 解析一些输入

let messages: MessageList = parse("uci\nposition startpos moves e2e4 e7e5\ngo ponder\n");

4. 对解析后的消息进行一些操作

for m in messages {
    match m {
        UciMessage::Uci => {
            // Initialize the UCI mode of the chess engine.
        }
        UciMessage::Position { startpos, fen, moves } => {
            // Set up the starting position in the engine and play the moves e2-e4 and e7-e5
        }
        UciMessage::Go { time_control, search_control } {
            if let Some(tc) = time_control {
                match tc {
                    UciTimeControl::Ponder => {
                        // Put the engine into ponder mode ("think" on opponent's time)
                    }
                    _ => {...}
                }
            }
        }
        _ => {...}
    }
}

5. 输出消息

    let message = UciMessage::Option(UciOptionConfig::Spin {
                name: "Selectivity".to_string(),
                default: Some(2),
                min: Some(0),
                max: Some(4),
            });
    
    println!(message); // Outputs "option name Selectivity type spin default 2 min 0 max 4"

6. 或者，按行解析并处理输入，例如从 stdin

use std::io::{self, BufRead};
use vampirc_uci::{UciMessage, parse_one};

for line in io::stdin().lock().lines() {
     let msg: UciMessage = parse_one(&line.unwrap());
     println!("Received message: {}", msg);
}

选择解析函数

根据您的需求和用例，有几个解析函数可用。它们在返回值和如何处理未识别输入方面有所不同。以下表格可能有助于选择解析函数

根据我的经验，如果你字符串可以包含多个命令，我建议使用parse_with_unknown，否则如果你是逐行解析，请使用parse_one。这样，你的棋引擎或工具至少可以记录未识别的输入，可以从UciMessage::Unknown(String, Error)变体中获取。

与 chess crate 的集成（自 0.9.0 版起）

此库（可选）与chess crate集成。首先，使用chess功能将vampirc-uci crate包含到你的项目中

[dependencies]
vampirc-uci = {version = "0.11", features = ["chess"]}

这将导致vampirc_uci对走法、棋子和棋盘的内部表示被替换为chess crate对这些概念的解释。完整的表格如下

警告

chess是一个相当重的crate，有一些重依赖，所以可能只有在您使用它构建自己的棋引擎或工具时才使用集成功能。

API

完整的API文档可在docs.rs找到。

新功能 0.11.1

• 改进了parse_with_unknown(&str)，以便尽可能正确地识别输入。例如，之前输入uci\ndebug on\nucinewgame\nabc\nstop\nquit会返回一个单独的Uci::Unknown消息，改进的语法支持将返回六个独立的消息，其中五个将是正确的UCI消息，而将'abc'包裹在Uci::Unknown中。
• 对btime参数错误序列化的修复，感谢@analog_hors。
• 支持 chess crate v. 3.2.0。