EngineBase.hpp

Go to the documentation of this file.

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

 
#pragma once
 
#include <libchess/uci/CommandParsing.hpp>
#include <span>
#include <string>
#include <string_view>
 
namespace chess::game {
struct Position;
} // namespace chess::game
 
namespace chess::uci {
 
using game::Position;
using std::string_view;
 
struct Option;

struct EngineBase {
    EngineBase() = default;
 
    virtual ~EngineBase();
 
    EngineBase(const EngineBase&)            = default;
    EngineBase(EngineBase&&)                 = default;
    EngineBase& operator=(const EngineBase&) = default;
    EngineBase& operator=(EngineBase&&)      = default;

    [[nodiscard]] virtual auto get_name() const -> std::string = 0;

    [[nodiscard]] virtual auto get_author() const -> string_view = 0;

    [[nodiscard]] virtual auto get_options() -> std::span<Option*> { return { }; }

    virtual void wait() { }

    [[nodiscard]] virtual auto is_searching() const noexcept -> bool = 0;

    virtual void new_game([[maybe_unused]] bool firstCall) { }

    virtual void abort_search() { }

    virtual void ponder_hit() { }

    virtual void set_position([[maybe_unused]] const Position& pos) { }

    virtual void go([[maybe_unused]] const GoCommandOptions& opts) = 0;

    virtual void set_debug([[maybe_unused]] bool shouldDebug) { }

    void handle_command(string_view command);

    virtual void handle_custom_command(
        [[maybe_unused]] string_view command,
        [[maybe_unused]] string_view options) { }

    void loop();

    virtual void handle_registration([[maybe_unused]] const RegisterOptions& opts) { }
 
private:
    void respond_to_uci();
 
    void handle_setpos(string_view arguments);
    void handle_setoption(string_view arguments);
 
    bool shouldExit { false }; // used as flag for exiting the loop() function
 
    bool initialized { false };
 
    Position position;
};
 
} // namespace chess::uci