PGN.hpp

Go to the documentation of this file.

/*
 * ======================================================================================
 *
 * ░▒▓███████▓▒░░▒▓████████▓▒░▒▓███████▓▒░       ░▒▓███████▓▒░ ░▒▓██████▓▒░▒▓████████▓▒░
 * ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓███████▓▒░░▒▓██████▓▒░ ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓███████▓▒░░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░ ░▒▓█▓▒░
 * ░▒▓███████▓▒░░▒▓████████▓▒░▒▓█▓▒░░▒▓█▓▒░      ░▒▓███████▓▒░ ░▒▓██████▓▒░  ░▒▓█▓▒░
 *
 * ======================================================================================
 */

 
#pragma once
 
#include <cstdint> // IWYU pragma: keep - for std::uint_least8_t
#include <expected>
#include <libchess/game/Position.hpp>
#include <libchess/game/Result.hpp>
#include <libchess/moves/Move.hpp>
#include <optional>
#include <string>
#include <string_view>
#include <unordered_map>
#include <vector>
 
namespace chess::notation {
 
using game::Position;
using std::string;

enum class NAG : std::uint_least8_t {
    Null                   = 0,  
    Good                   = 1,  
    Brilliant              = 3,  
    Inaccuracy             = 2,  
    Blunder                = 4,  
    Interesting            = 5,  
    Dubious                = 6,  
    Forced                 = 7,  
    Drawish                = 10, 
    Unclear                = 13, 
    WhiteSlightAdvantage   = 14, 
    WhiteModerateAdvantage = 16, 
    WhiteDecisiveAdvantage = 18, 
    WhiteCrushingAdvantage = 20, 
    BlackSlightAdvantage   = 15, 
    BlackModerateAdvantage = 17, 
    BlackDecisiveAdvantage = 19, 
    BlackCrushingAdvantage = 21, 
    WhiteZugzwang          = 22, 
    WhiteInitiative        = 36, 
    BlackInitiative        = 37  
};

struct [[nodiscard]] GameRecord final {
    std::unordered_map<string, string> metadata;

    Position startingPosition;

    std::optional<game::Result> result;

    struct Move final {
        moves::Move move;

        string comment;

        std::vector<NAG> nags;

        using Variation = std::vector<Move>;

        std::vector<Variation> variations;
    };

    std::vector<Move> moves;

    [[nodiscard]] auto get_final_position() const -> Position;
};

[[nodiscard]] auto from_pgn(std::string_view pgnText)
    -> std::expected<GameRecord, std::string_view>;

[[nodiscard]] auto parse_all_pgns(std::string_view fileContent)
    -> std::vector<GameRecord>;

[[nodiscard]] auto to_pgn(const GameRecord& game, bool useBlockComments = true) -> string;
 
} // namespace chess::notation