git.sesse.net Git - stockfish/blob - src/ucioption.cpp

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
   4
   5   Stockfish is free software: you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation, either version 3 of the License, or
   8   (at your option) any later version.
   9
  10   Stockfish is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 #include <algorithm>
  20 #include <cassert>
  21 #include <cctype>
  22 #include <cstddef>
  23 #include <iosfwd>
  24 #include <istream>
  25 #include <map>
  26 #include <ostream>
  27 #include <sstream>
  28 #include <string>
  29
  30 #include "evaluate.h"
  31 #include "misc.h"
  32 #include "search.h"
  33 #include "syzygy/tbprobe.h"
  34 #include "thread.h"
  35 #include "tt.h"
  36 #include "types.h"
  37 #include "uci.h"
  38
  39 using std::string;
  40
  41 namespace Stockfish {
  42
  43 UCI::OptionsMap Options;  // Global object
  44
  45 namespace UCI {
  46
  47 // 'On change' actions, triggered by an option's value change
  48 static void on_clear_hash(const Option&) { Search::clear(); }
  49 static void on_hash_size(const Option& o) { TT.resize(size_t(o)); }
  50 static void on_logger(const Option& o) { start_logger(o); }
  51 static void on_threads(const Option& o) { Threads.set(size_t(o)); }
  52 static void on_tb_path(const Option& o) { Tablebases::init(o); }
  53 static void on_eval_file(const Option&) { Eval::NNUE::init(); }
  54
  55 // Our case insensitive less() function as required by UCI protocol
  56 bool CaseInsensitiveLess::operator()(const string& s1, const string& s2) const {
  57
  58     return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
  59                                         [](char c1, char c2) { return tolower(c1) < tolower(c2); });
  60 }
  61
  62
  63 // UCI::init() initializes the UCI options to their hard-coded default values
  64
  65 void init(OptionsMap& o) {
  66
  67     constexpr int MaxHashMB = Is64Bit ? 33554432 : 2048;
  68
  69     o["Debug Log File"] << Option("", on_logger);
  70     o["Threads"] << Option(1, 1, 1024, on_threads);
  71     o["Hash"] << Option(16, 1, MaxHashMB, on_hash_size);
  72     o["Clear Hash"] << Option(on_clear_hash);
  73     o["Ponder"] << Option(false);
  74     o["MultiPV"] << Option(1, 1, 500);
  75     o["Skill Level"] << Option(20, 0, 20);
  76     o["Move Overhead"] << Option(10, 0, 5000);
  77     o["Slow Mover"] << Option(100, 10, 1000);
  78     o["nodestime"] << Option(0, 0, 10000);
  79     o["UCI_Chess960"] << Option(false);
  80     o["UCI_AnalyseMode"] << Option(false);
  81     o["UCI_LimitStrength"] << Option(false);
  82     o["UCI_Elo"] << Option(1320, 1320, 3190);
  83     o["UCI_ShowWDL"] << Option(false);
  84     o["SyzygyPath"] << Option("<empty>", on_tb_path);
  85     o["SyzygyProbeDepth"] << Option(1, 1, 100);
  86     o["Syzygy50MoveRule"] << Option(true);
  87     o["SyzygyProbeLimit"] << Option(7, 0, 7);
  88     o["EvalFile"] << Option(EvalFileDefaultName, on_eval_file);
  89 }
  90
  91
  92 // operator<<() is used to print all the options default values in chronological
  93 // insertion order (the idx field) and in the format defined by the UCI protocol.
  94
  95 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
  96
  97     for (size_t idx = 0; idx < om.size(); ++idx)
  98         for (const auto& it : om)
  99             if (it.second.idx == idx)
 100             {
 101                 const Option& o = it.second;
 102                 os << "\noption name " << it.first << " type " << o.type;
 103
 104                 if (o.type == "string" || o.type == "check" || o.type == "combo")
 105                     os << " default " << o.defaultValue;
 106
 107                 if (o.type == "spin")
 108                     os << " default " << int(stof(o.defaultValue)) << " min " << o.min << " max "
 109                        << o.max;
 110
 111                 break;
 112             }
 113
 114     return os;
 115 }
 116
 117
 118 // Option class constructors and conversion operators
 119
 120 Option::Option(const char* v, OnChange f) :
 121     type("string"),
 122     min(0),
 123     max(0),
 124     on_change(f) {
 125     defaultValue = currentValue = v;
 126 }
 127
 128 Option::Option(bool v, OnChange f) :
 129     type("check"),
 130     min(0),
 131     max(0),
 132     on_change(f) {
 133     defaultValue = currentValue = (v ? "true" : "false");
 134 }
 135
 136 Option::Option(OnChange f) :
 137     type("button"),
 138     min(0),
 139     max(0),
 140     on_change(f) {}
 141
 142 Option::Option(double v, int minv, int maxv, OnChange f) :
 143     type("spin"),
 144     min(minv),
 145     max(maxv),
 146     on_change(f) {
 147     defaultValue = currentValue = std::to_string(v);
 148 }
 149
 150 Option::Option(const char* v, const char* cur, OnChange f) :
 151     type("combo"),
 152     min(0),
 153     max(0),
 154     on_change(f) {
 155     defaultValue = v;
 156     currentValue = cur;
 157 }
 158
 159 Option::operator int() const {
 160     assert(type == "check" || type == "spin");
 161     return (type == "spin" ? std::stoi(currentValue) : currentValue == "true");
 162 }
 163
 164 Option::operator std::string() const {
 165     assert(type == "string");
 166     return currentValue;
 167 }
 168
 169 bool Option::operator==(const char* s) const {
 170     assert(type == "combo");
 171     return !CaseInsensitiveLess()(currentValue, s) && !CaseInsensitiveLess()(s, currentValue);
 172 }
 173
 174
 175 // operator<<() inits options and assigns idx in the correct printing order
 176
 177 void Option::operator<<(const Option& o) {
 178
 179     static size_t insert_order = 0;
 180
 181     *this = o;
 182     idx   = insert_order++;
 183 }
 184
 185
 186 // operator=() updates currentValue and triggers on_change() action. It's up to
 187 // the GUI to check for option's limits, but we could receive the new value
 188 // from the user by console window, so let's check the bounds anyway.
 189
 190 Option& Option::operator=(const string& v) {
 191
 192     assert(!type.empty());
 193
 194     if ((type != "button" && type != "string" && v.empty())
 195         || (type == "check" && v != "true" && v != "false")
 196         || (type == "spin" && (stof(v) < min || stof(v) > max)))
 197         return *this;
 198
 199     if (type == "combo")
 200     {
 201         OptionsMap         comboMap;  // To have case insensitive compare
 202         string             token;
 203         std::istringstream ss(defaultValue);
 204         while (ss >> token)
 205             comboMap[token] << Option();
 206         if (!comboMap.count(v) || v == "var")
 207             return *this;
 208     }
 209
 210     if (type != "button")
 211         currentValue = v;
 212
 213     if (on_change)
 214         on_change(*this);
 215
 216     return *this;
 217 }
 218
 219 }  // namespace UCI
 220
 221 }  // namespace Stockfish