rsffish 0.0.20

A Rust wrapper for fairystockfish based on https://github.com/mind-sports-games/Fairy-Stockfish-Lib
Documentation 
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

#pragma once

//----------------------------------------------------------------------------
// Unfortunately the `cxx` crate is not directly compatible with by-value
// strings. This means that we have to convert strings to/from it's wrapped
// version of a rust-compatible string. 
//
// TODO: evaluate the impact on copying data tha this has. It may not show up
//       in our use case, but it probably is impactful.
//----------------------------------------------------------------------------
#include "rust/cxx.h"

#include "fairystockfish.h"

#include <memory>

namespace rsffish {
    using Notation = fairystockfish::Notation;
    using Square = fairystockfish::Square;
    struct PieceInfo;
    struct TestWithGameResult;
    struct TestByPlayers;
    struct Piece;
    struct PieceOnBoard;

    struct Position {
        // Member implementation
        std::unique_ptr<fairystockfish::Position> impl;

        // Construct from a moved in unique_ptr
        Position(std::unique_ptr<fairystockfish::Position> &&p) 
            : impl{std::move(p)} {}

        // Construct from a position by value. (Makes a copy)
        Position(fairystockfish::Position const &p)
            : impl{new fairystockfish::Position(p)} {}

        // Public API
        std::unique_ptr<Position> makeMoves(rust::Vec<rust::String> const &moves) const;
        rust::String getFEN() const;
        rust::String getFENWithArgs(bool sFen, bool showPromoted, std::uint32_t countStarted) const;
        rust::String getSAN(rust::String const &uci) const;
        rust::String getSANWithNotation(rust::String const &uci, Notation notation) const;
        rust::Vec<rust::String> getSANMoves(rust::Vec<rust::String> const &uci) const;
        rust::Vec<rust::String> getSANMovesWithNotation(rust::Vec<rust::String> const &uci, Notation notation) const;
        rust::Vec<rust::String> getLegalMoves() const;
        rust::Vec<rsffish::Piece> piecesInHand() const;
        rust::Vec<rsffish::PieceOnBoard> piecesOnBoard() const;
        bool givesCheck() const;
        bool hasRepeated() const;
        bool isDraw(std::uint32_t ply) const;
        bool hasGameCycle(std::uint32_t ply) const;
        std::int32_t gameResult() const;
        rsffish::TestWithGameResult isImmediateGameEnd() const;
        rsffish::TestWithGameResult isOptionalGameEnd() const;
        rsffish::TestByPlayers hasInsufficientMaterial() const;

    };

    std::vector<std::string> toCpp(rust::Vec<rust::String> const &vals);

    rust::Vec<rust::String> toRust(std::vector<std::string> const &vals);
    rust::Vec<Piece> toRust(std::vector<fairystockfish::Piece> const &vals);
    TestWithGameResult toRust(std::tuple<bool, int> res);
    rsffish::PieceInfo toRust(fairystockfish::PieceInfo const &p);
    rsffish::Piece toRust(fairystockfish::Piece const &p);
    rsffish::PieceOnBoard toRust(std::string square, fairystockfish::Piece const &p);

    void init();
    rust::String version();
    void info();
    void setUCIOption(rust::String const &name, rust::String const &value);
    void loadVariantConfig(rust::String const &config);
    rust::Vec<rust::String> availableVariants();
    rust::String initialFen(rust::String const &variantName);
    rust::Vec<rsffish::PieceInfo> availablePieces();
    rust::String availablePieceChars();
    rust::String availablePromotablePieceChars();
    bool validateFEN(rust::String const &variantName, rust::String const &fen, bool isChess960);
    rust::Vec<rust::String> to960Uci(rust::String const &variantName, rust::Vec<rust::String> const &moves);
    std::unique_ptr<Position> startingPosition(rust::String const &variantName, bool isChess960);
    std::unique_ptr<Position> positionFromFen(rust::String const &variantName, rust::String const &fen, bool isChess960);
}