/*
Stockfish, a UCI chess playing engine derived from Glaurung 2.1
- Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
- Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
+ Copyright (C) 2004-2024 The Stockfish developers (see AUTHORS file)
Stockfish is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#include "ucioption.h"
+
+#include <algorithm>
+#include <cassert>
#include <cctype>
#include <iostream>
#include <sstream>
+#include <utility>
#include "misc.h"
-#include "thread.h"
-#include "ucioption.h"
-using std::string;
-using std::cout;
-using std::endl;
+namespace Stockfish {
-OptionsMap Options; // Global object
+bool CaseInsensitiveLess::operator()(const std::string& s1, const std::string& s2) const {
+ return std::lexicographical_compare(
+ s1.begin(), s1.end(), s2.begin(), s2.end(),
+ [](char c1, char c2) { return std::tolower(c1) < std::tolower(c2); });
+}
-// Our case insensitive less() function as required by UCI protocol
-bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
-
- int c1, c2;
- size_t i = 0;
+void OptionsMap::add_info_listener(InfoListener&& message_func) { info = std::move(message_func); }
- while (i < s1.size() && i < s2.size())
- {
- c1 = tolower(s1[i]);
- c2 = tolower(s2[i++]);
+void OptionsMap::setoption(std::istringstream& is) {
+ std::string token, name, value;
- if (c1 != c2)
- return c1 < c2;
- }
- return s1.size() < s2.size();
-}
+ is >> token; // Consume the "name" token
+ // Read the option name (can contain spaces)
+ while (is >> token && token != "value")
+ name += (name.empty() ? "" : " ") + token;
-// stringify() converts a numeric value of type T to a std::string
-template<typename T>
-static string stringify(const T& v) {
+ // Read the option value (can contain spaces)
+ while (is >> token)
+ value += (value.empty() ? "" : " ") + token;
- std::ostringstream ss;
- ss << v;
- return ss.str();
+ if (options_map.count(name))
+ options_map[name] = value;
+ else
+ sync_cout << "No such option: " << name << sync_endl;
}
+Option OptionsMap::operator[](const std::string& name) const {
+ auto it = options_map.find(name);
+ return it != options_map.end() ? it->second : Option(this);
+}
-/// init_uci_options() initializes the UCI options to their hard coded default
-/// values and initializes the default value of "Threads" and "Minimum Split Depth"
-/// parameters according to the number of CPU cores.
-
-void init_uci_options() {
-
- Options["Use Search Log"] = Option(false);
- Options["Search Log Filename"] = Option("SearchLog.txt");
- Options["Book File"] = Option("book.bin");
- Options["Best Book Move"] = Option(false);
- Options["Mobility (Middle Game)"] = Option(100, 0, 200);
- Options["Mobility (Endgame)"] = Option(100, 0, 200);
- Options["Pawn Structure (Middle Game)"] = Option(100, 0, 200);
- Options["Pawn Structure (Endgame)"] = Option(100, 0, 200);
- Options["Passed Pawns (Middle Game)"] = Option(100, 0, 200);
- Options["Passed Pawns (Endgame)"] = Option(100, 0, 200);
- Options["Space"] = Option(100, 0, 200);
- Options["Aggressiveness"] = Option(100, 0, 200);
- Options["Cowardice"] = Option(100, 0, 200);
- Options["Check Extension (PV nodes)"] = Option(2, 0, 2);
- Options["Check Extension (non-PV nodes)"] = Option(1, 0, 2);
- Options["Single Evasion Extension (PV nodes)"] = Option(2, 0, 2);
- Options["Single Evasion Extension (non-PV nodes)"] = Option(2, 0, 2);
- Options["Mate Threat Extension (PV nodes)"] = Option(2, 0, 2);
- Options["Mate Threat Extension (non-PV nodes)"] = Option(2, 0, 2);
- Options["Pawn Push to 7th Extension (PV nodes)"] = Option(1, 0, 2);
- Options["Pawn Push to 7th Extension (non-PV nodes)"] = Option(1, 0, 2);
- Options["Passed Pawn Extension (PV nodes)"] = Option(1, 0, 2);
- Options["Passed Pawn Extension (non-PV nodes)"] = Option(0, 0, 2);
- Options["Pawn Endgame Extension (PV nodes)"] = Option(2, 0, 2);
- Options["Pawn Endgame Extension (non-PV nodes)"] = Option(2, 0, 2);
- Options["Minimum Split Depth"] = Option(4, 4, 7);
- Options["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
- Options["Threads"] = Option(1, 1, MAX_THREADS);
- Options["Use Sleeping Threads"] = Option(true);
- Options["Hash"] = Option(32, 4, 8192);
- Options["Clear Hash"] = Option(false, "button");
- Options["Ponder"] = Option(true);
- Options["OwnBook"] = Option(true);
- Options["MultiPV"] = Option(1, 1, 500);
- Options["Emergency Move Horizon"] = Option(40, 0, 50);
- Options["Emergency Base Time"] = Option(200, 0, 30000);
- Options["Emergency Move Time"] = Option(70, 0, 5000);
- Options["Minimum Thinking Time"] = Option(20, 0, 5000);
- Options["UCI_Chess960"] = Option(false);
- Options["UCI_AnalyseMode"] = Option(false);
-
- // Set some SMP parameters accordingly to the detected CPU count
- Option& thr = Options["Threads"];
- Option& msd = Options["Minimum Split Depth"];
-
- thr.defaultValue = thr.currentValue = stringify(cpu_count());
-
- if (cpu_count() >= 8)
- msd.defaultValue = msd.currentValue = stringify(7);
+Option& OptionsMap::operator[](const std::string& name) {
+ if (!options_map.count(name))
+ options_map[name] = Option(this);
+ return options_map[name];
}
+std::size_t OptionsMap::count(const std::string& name) const { return options_map.count(name); }
+
+Option::Option(const OptionsMap* map) :
+ parent(map) {}
+
+Option::Option(const char* v, OnChange f) :
+ type("string"),
+ min(0),
+ max(0),
+ on_change(std::move(f)) {
+ defaultValue = currentValue = v;
+}
-/// print_uci_options() prints all the UCI options to the standard output,
-/// in chronological insertion order (the idx field) and in the format
-/// defined by the UCI protocol.
+Option::Option(bool v, OnChange f) :
+ type("check"),
+ min(0),
+ max(0),
+ on_change(std::move(f)) {
+ defaultValue = currentValue = (v ? "true" : "false");
+}
-void print_uci_options() {
+Option::Option(OnChange f) :
+ type("button"),
+ min(0),
+ max(0),
+ on_change(std::move(f)) {}
+
+Option::Option(double v, int minv, int maxv, OnChange f) :
+ type("spin"),
+ min(minv),
+ max(maxv),
+ on_change(std::move(f)) {
+ defaultValue = currentValue = std::to_string(v);
+}
- for (size_t i = 0; i <= Options.size(); i++)
- for (OptionsMap::const_iterator it = Options.begin(); it != Options.end(); ++it)
- if (it->second.idx == i)
- {
- const Option& o = it->second;
- cout << "\noption name " << it->first << " type " << o.type;
+Option::Option(const char* v, const char* cur, OnChange f) :
+ type("combo"),
+ min(0),
+ max(0),
+ on_change(std::move(f)) {
+ defaultValue = v;
+ currentValue = cur;
+}
- if (o.type != "button")
- cout << " default " << o.defaultValue;
+Option::operator int() const {
+ assert(type == "check" || type == "spin");
+ return (type == "spin" ? std::stoi(currentValue) : currentValue == "true");
+}
- if (o.type == "spin")
- cout << " min " << o.minValue << " max " << o.maxValue;
+Option::operator std::string() const {
+ assert(type == "string");
+ return currentValue;
+}
- break;
- }
- cout << endl;
+bool Option::operator==(const char* s) const {
+ assert(type == "combo");
+ return !CaseInsensitiveLess()(currentValue, s) && !CaseInsensitiveLess()(s, currentValue);
}
+bool Option::operator!=(const char* s) const { return !(*this == s); }
-/// Option class c'tors
-Option::Option(const char* def) : type("string"), idx(Options.size()), minValue(0), maxValue(0)
-{ defaultValue = currentValue = def; }
+// Inits options and assigns idx in the correct printing order
-Option::Option(bool def, string t) : type(t), idx(Options.size()), minValue(0), maxValue(0)
-{ defaultValue = currentValue = (def ? "true" : "false"); }
+void Option::operator<<(const Option& o) {
-Option::Option(int def, int minv, int maxv) : type("spin"), idx(Options.size()), minValue(minv), maxValue(maxv)
-{ defaultValue = currentValue = stringify(def); }
+ static size_t insert_order = 0;
+ auto p = this->parent;
+ *this = o;
-/// set_value() updates currentValue of the Option object. Normally it's up to
-/// the GUI to check for option's limits, but we could receive the new value
-/// directly from the user by teminal window. So let's check the bounds anyway.
+ this->parent = p;
+ idx = insert_order++;
+}
+
+// Updates currentValue and triggers on_change() action. It's up to
+// the GUI to check for option's limits, but we could receive the new value
+// from the user by console window, so let's check the bounds anyway.
+Option& Option::operator=(const std::string& v) {
+
+ assert(!type.empty());
+
+ if ((type != "button" && type != "string" && v.empty())
+ || (type == "check" && v != "true" && v != "false")
+ || (type == "spin" && (std::stof(v) < min || std::stof(v) > max)))
+ return *this;
+
+ if (type == "combo")
+ {
+ OptionsMap comboMap; // To have case insensitive compare
+ std::string token;
+ std::istringstream ss(defaultValue);
+ while (ss >> token)
+ comboMap[token] << Option();
+ if (!comboMap.count(v) || v == "var")
+ return *this;
+ }
+
+ if (type == "string")
+ currentValue = v == "<empty>" ? "" : v;
+ else if (type != "button")
+ currentValue = v;
+
+ if (on_change)
+ {
+ const auto ret = on_change(*this);
+
+ if (ret && parent != nullptr && parent->info != nullptr)
+ parent->info(ret);
+ }
+
+ return *this;
+}
-void Option::set_value(const string& value) {
+std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
+ for (size_t idx = 0; idx < om.options_map.size(); ++idx)
+ for (const auto& it : om.options_map)
+ if (it.second.idx == idx)
+ {
+ const Option& o = it.second;
+ os << "\noption name " << it.first << " type " << o.type;
- assert(!type.empty());
+ if (o.type == "check" || o.type == "combo")
+ os << " default " << o.defaultValue;
- if ( (type == "check" || type == "button")
- && !(value == "true" || value == "false"))
- return;
+ else if (o.type == "string")
+ {
+ std::string defaultValue = o.defaultValue.empty() ? "<empty>" : o.defaultValue;
+ os << " default " << defaultValue;
+ }
- if (type == "spin")
- {
- int v = atoi(value.c_str());
- if (v < minValue || v > maxValue)
- return;
- }
+ else if (o.type == "spin")
+ os << " default " << int(stof(o.defaultValue)) << " min " << o.min << " max "
+ << o.max;
- currentValue = value;
+ break;
+ }
+
+ return os;
+}
}