Options.hpp

Go to the documentation of this file.

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

 
#pragma once
 
#include <functional>
#include <stdexcept>
#include <string>
#include <string_view>
#include <variant>
#include <vector>
 
namespace chess::uci {
 
using std::string;
using std::string_view;

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

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

    [[nodiscard]] virtual auto get_declaration_string() const -> string = 0;

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

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

    [[nodiscard]] virtual auto has_value() const noexcept -> bool { return true; }

    using Variant = std::variant<bool, int, string_view>;

    [[nodiscard]] virtual auto get_value_variant() const -> Variant = 0;

    [[nodiscard]] virtual auto get_default_value_variant() const -> Variant = 0;

    virtual void handle_setvalue(string_view arguments) = 0;
};

struct BoolOption final : Option {
    using Value    = bool;
    using Callback = std::function<void(bool)>;

    BoolOption(
        string name, bool defaultValue,
        string     helpString,
        Callback&& changeCallback = [](bool) { });

    [[nodiscard]] auto get_value() const noexcept -> bool { return value; }

    void set_value(bool newValue);
 
    [[nodiscard]] auto get_value_variant() const -> Variant override { return value; }

    [[nodiscard]] auto get_default_value() const noexcept -> bool { return optionDefault; }
 
    [[nodiscard]] auto get_default_value_variant() const -> Variant override { return optionDefault; }
 
    [[nodiscard]] auto get_name() const noexcept -> string_view override { return optionName; }
 
    [[nodiscard]] auto get_declaration_string() const -> string override;
 
    [[nodiscard]] auto get_type() const noexcept -> string_view override { return "Toggle"; }
 
    [[nodiscard]] auto get_help() const noexcept -> string_view override { return help; }
 
    void handle_setvalue(string_view arguments) override;
 
private:
    string optionName;
 
    bool optionDefault { true };
 
    bool value { optionDefault };
 
    string help;
 
    Callback onChange { [](bool) { } };
};

struct IntOption final : Option {
    using Value    = int;
    using Callback = std::function<void(int)>;

    IntOption(
        string name,
        int minValue, int maxValue,
        int        defaultValue,
        string     helpString,
        Callback&& changeCallback = [](int) { });

    [[nodiscard]] auto get_value() const noexcept -> int { return value; }

    void set_value(int newValue);
 
    [[nodiscard]] auto get_value_variant() const -> Variant override { return value; }

    [[nodiscard]] auto get_default_value() const noexcept -> int { return optionDefault; }
 
    [[nodiscard]] auto get_default_value_variant() const -> Variant override { return optionDefault; }
 
    [[nodiscard]] auto get_name() const noexcept -> string_view override { return optionName; }
 
    [[nodiscard]] auto get_declaration_string() const -> string override;
 
    [[nodiscard]] auto get_type() const noexcept -> string_view override { return "Integer"; }
 
    [[nodiscard]] auto get_help() const noexcept -> string_view override { return help; }
 
    void handle_setvalue(string_view arguments) override;
 
private:
    string optionName;
 
    int optionMin { 0 };
    int optionMax { 100 };
 
    int optionDefault { 0 };
 
    int value { optionDefault };
 
    string help;
 
    Callback onChange { [](int) { } };
};

struct ComboOption final : Option {
    using Value    = string_view;
    using Callback = std::function<void(string_view)>;

    ComboOption(
        string              name,
        std::vector<string> values,
        string              defaultValue,
        string              helpString,
        Callback&&          changeCallback = [](string_view) { });
 
    [[nodiscard]] auto get_value() const noexcept -> string_view { return value; } // cppcheck-suppress returnByReference

    void set_value(string_view newValue);
 
    [[nodiscard]] auto get_value_variant() const -> Variant override { return get_value(); }

    [[nodiscard]] auto get_default_value() const noexcept -> string_view { return optionDefault; } // cppcheck-suppress returnByReference
 
    [[nodiscard]] auto get_default_value_variant() const -> Variant override { return get_default_value(); }
 
    [[nodiscard]] auto get_name() const noexcept -> string_view override { return optionName; }
 
    [[nodiscard]] auto get_declaration_string() const -> string override;
 
    [[nodiscard]] auto get_type() const noexcept -> string_view override { return "Multichoice"; }
 
    [[nodiscard]] auto get_help() const noexcept -> string_view override { return help; }
 
    void handle_setvalue(string_view arguments) override;
 
private:
    string optionName;
 
    std::vector<string> possibleValues;
 
    string optionDefault;
 
    string value { optionDefault };
 
    string help;
 
    Callback onChange { [](string_view) { } };
};

struct StringOption final : Option {
    using Value    = string_view;
    using Callback = std::function<void(string_view)>;

    StringOption(
        string     name,
        string     defaultValue,
        string     helpString,
        Callback&& changeCallback = [](string_view) { });
 
    [[nodiscard]] auto get_value() const noexcept -> string_view
    {
        if (value == "<empty>")
            return { };
 
        return value;
    }

    void set_value(string_view newValue);
 
    [[nodiscard]] auto get_value_variant() const -> Variant override { return get_value(); }
 
    [[nodiscard]] auto get_default_value_variant() const -> Variant override { return string_view { }; }
 
    [[nodiscard]] auto get_name() const noexcept -> string_view override { return optionName; }
 
    [[nodiscard]] auto get_declaration_string() const -> string override;
 
    [[nodiscard]] auto get_type() const noexcept -> string_view override { return "String"; }
 
    [[nodiscard]] auto get_help() const noexcept -> string_view override { return help; }
 
    void handle_setvalue(string_view arguments) override;
 
private:
    string optionName;
 
    string value;
 
    string help;
 
    Callback onChange { [](string_view) { } };
};

struct Action final : Option {
    using Value    = void;
    using Callback = std::function<void()>;

    Action(
        string     name,
        Callback&& action,
        string     helpString);
 
    [[nodiscard]] auto get_value_variant() const -> Variant override { throw_value_error(); }
    [[nodiscard]] auto get_default_value_variant() const -> Variant override { throw_value_error(); }
 
    [[nodiscard]] auto get_name() const noexcept -> string_view override { return optionName; }
 
    [[nodiscard]] auto get_declaration_string() const -> string override;
 
    [[nodiscard]] auto get_type() const noexcept -> string_view override { return "Button"; }
 
    [[nodiscard]] auto get_help() const noexcept -> string_view override { return help; }
 
    [[nodiscard]] auto has_value() const noexcept -> bool override { return false; }
 
    void handle_setvalue(string_view arguments) override;
 
private:
    [[noreturn]] static void throw_value_error()
    {
        throw std::logic_error { "get_value_variant() called on option of Action type" };
    }
 
    string optionName;
 
    Callback callback;
 
    string help;
};
 
} // namespace chess::uci