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 // Initializes the UCI options to their hard-coded default values
  64 void init(OptionsMap& o) {
  65
  66     constexpr int MaxHashMB = Is64Bit ? 33554432 : 2048;
  67
  68     o["Debug Log File"] << Option("", on_logger);
  69     o["Threads"] << Option(1, 1, 1024, on_threads);
  70     o["Hash"] << Option(16, 1, MaxHashMB, on_hash_size);
  71     o["Clear Hash"] << Option(on_clear_hash);
  72     o["Ponder"] << Option(false);
  73     o["MultiPV"] << Option(1, 1, 500);
  74     o["Skill Level"] << Option(20, 0, 20);
  75     o["Move Overhead"] << Option(10, 0, 5000);
  76     o["nodestime"] << Option(0, 0, 10000);
  77     o["UCI_Chess960"] << Option(false);
  78     o["UCI_AnalyseMode"] << Option(false);
  79     o["UCI_LimitStrength"] << Option(false);
  80     o["UCI_Elo"] << Option(1320, 1320, 3190);
  81     o["UCI_ShowWDL"] << Option(false);
  82     o["SyzygyPath"] << Option("<empty>", on_tb_path);
  83     o["SyzygyProbeDepth"] << Option(1, 1, 100);
  84     o["Syzygy50MoveRule"] << Option(true);
  85     o["SyzygyProbeLimit"] << Option(7, 0, 7);
  86     o["EvalFile"] << Option(EvalFileDefaultName, on_eval_file);
  87 }
  88
  89
  90 // Used to print all the options default values in chronological
  91 // insertion order (the idx field) and in the format defined by the UCI protocol.
  92 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
  93
  94     for (size_t idx = 0; idx < om.size(); ++idx)
  95         for (const auto& it : om)
  96             if (it.second.idx == idx)
  97             {
  98                 const Option& o = it.second;
  99                 os << "\noption name " << it.first << " type " << o.type;
 100
 101                 if (o.type == "string" || o.type == "check" || o.type == "combo")
 102                     os << " default " << o.defaultValue;
 103
 104                 if (o.type == "spin")
 105                     os << " default " << int(stof(o.defaultValue)) << " min " << o.min << " max "
 106                        << o.max;
 107
 108                 break;
 109             }
 110
 111     return os;
 112 }
 113
 114
 115 // Option class constructors and conversion operators
 116
 117 Option::Option(const char* v, OnChange f) :
 118     type("string"),
 119     min(0),
 120     max(0),
 121     on_change(f) {
 122     defaultValue = currentValue = v;
 123 }
 124
 125 Option::Option(bool v, OnChange f) :
 126     type("check"),
 127     min(0),
 128     max(0),
 129     on_change(f) {
 130     defaultValue = currentValue = (v ? "true" : "false");
 131 }
 132
 133 Option::Option(OnChange f) :
 134     type("button"),
 135     min(0),
 136     max(0),
 137     on_change(f) {}
 138
 139 Option::Option(double v, int minv, int maxv, OnChange f) :
 140     type("spin"),
 141     min(minv),
 142     max(maxv),
 143     on_change(f) {
 144     defaultValue = currentValue = std::to_string(v);
 145 }
 146
 147 Option::Option(const char* v, const char* cur, OnChange f) :
 148     type("combo"),
 149     min(0),
 150     max(0),
 151     on_change(f) {
 152     defaultValue = v;
 153     currentValue = cur;
 154 }
 155
 156 Option::operator int() const {
 157     assert(type == "check" || type == "spin");
 158     return (type == "spin" ? std::stoi(currentValue) : currentValue == "true");
 159 }
 160
 161 Option::operator std::string() const {
 162     assert(type == "string");
 163     return currentValue;
 164 }
 165
 166 bool Option::operator==(const char* s) const {
 167     assert(type == "combo");
 168     return !CaseInsensitiveLess()(currentValue, s) && !CaseInsensitiveLess()(s, currentValue);
 169 }
 170
 171
 172 // Inits options and assigns idx in the correct printing order
 173
 174 void Option::operator<<(const Option& o) {
 175
 176     static size_t insert_order = 0;
 177
 178     *this = o;
 179     idx   = insert_order++;
 180 }
 181
 182
 183 // Updates currentValue and triggers on_change() action. It's up to
 184 // the GUI to check for option's limits, but we could receive the new value
 185 // from the user by console window, so let's check the bounds anyway.
 186 Option& Option::operator=(const string& v) {
 187
 188     assert(!type.empty());
 189
 190     if ((type != "button" && type != "string" && v.empty())
 191         || (type == "check" && v != "true" && v != "false")
 192         || (type == "spin" && (stof(v) < min || stof(v) > max)))
 193         return *this;
 194
 195     if (type == "combo")
 196     {
 197         OptionsMap         comboMap;  // To have case insensitive compare
 198         string             token;
 199         std::istringstream ss(defaultValue);
 200         while (ss >> token)
 201             comboMap[token] << Option();
 202         if (!comboMap.count(v) || v == "var")
 203             return *this;
 204     }
 205
 206     if (type != "button")
 207         currentValue = v;
 208
 209     if (on_change)
 210         on_change(*this);
 211
 212     return *this;
 213 }
 214
 215 }  // namespace UCI
 216
 217 }  // namespace Stockfish