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 <ostream>
  22 #include <sstream>
  23
  24 #include "evaluate.h"
  25 #include "misc.h"
  26 #include "search.h"
  27 #include "thread.h"
  28 #include "tt.h"
  29 #include "uci.h"
  30 #include "syzygy/tbprobe.h"
  31
  32 using std::string;
  33
  34 namespace Stockfish {
  35
  36 UCI::OptionsMap Options; // Global object
  37
  38 namespace UCI {
  39
  40 /// 'On change' actions, triggered by an option's value change
  41 static void on_clear_hash(const Option&) { Search::clear(); }
  42 static void on_hash_size(const Option& o) { TT.resize(size_t(o)); }
  43 static void on_logger(const Option& o) { start_logger(o); }
  44 static void on_threads(const Option& o) { Threads.set(size_t(o)); }
  45 static void on_tb_path(const Option& o) { Tablebases::init(o); }
  46 static void on_eval_file(const Option&) { Eval::NNUE::init(); }
  47
  48 /// Our case insensitive less() function as required by UCI protocol
  49 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
  50
  51   return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
  52          [](char c1, char c2) { return tolower(c1) < tolower(c2); });
  53 }
  54
  55
  56 /// UCI::init() initializes the UCI options to their hard-coded default values
  57
  58 void init(OptionsMap& o) {
  59
  60   constexpr int MaxHashMB = Is64Bit ? 33554432 : 2048;
  61
  62   o["Debug Log File"]        << Option("", on_logger);
  63   o["Threads"]               << Option(1, 1, 1024, on_threads);
  64   o["Hash"]                  << Option(16, 1, MaxHashMB, on_hash_size);
  65   o["Clear Hash"]            << Option(on_clear_hash);
  66   o["Ponder"]                << Option(false);
  67   o["MultiPV"]               << Option(1, 1, 500);
  68   o["Skill Level"]           << Option(20, 0, 20);
  69   o["Move Overhead"]         << Option(10, 0, 5000);
  70   o["Slow Mover"]            << Option(100, 10, 1000);
  71   o["nodestime"]             << Option(0, 0, 10000);
  72   o["UCI_Chess960"]          << Option(false);
  73   o["UCI_AnalyseMode"]       << Option(false);
  74   o["UCI_LimitStrength"]     << Option(false);
  75   o["UCI_Elo"]               << Option(1320, 1320, 3190);
  76   o["UCI_ShowWDL"]           << Option(false);
  77   o["SyzygyPath"]            << Option("<empty>", on_tb_path);
  78   o["SyzygyProbeDepth"]      << Option(1, 1, 100);
  79   o["Syzygy50MoveRule"]      << Option(true);
  80   o["SyzygyProbeLimit"]      << Option(7, 0, 7);
  81   o["EvalFile"]              << Option(EvalFileDefaultName, on_eval_file);
  82 }
  83
  84
  85 /// operator<<() is used to print all the options default values in chronological
  86 /// insertion order (the idx field) and in the format defined by the UCI protocol.
  87
  88 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
  89
  90   for (size_t idx = 0; idx < om.size(); ++idx)
  91       for (const auto& it : om)
  92           if (it.second.idx == idx)
  93           {
  94               const Option& o = it.second;
  95               os << "\noption name " << it.first << " type " << o.type;
  96
  97               if (o.type == "string" || o.type == "check" || o.type == "combo")
  98                   os << " default " << o.defaultValue;
  99
 100               if (o.type == "spin")
 101                   os << " default " << int(stof(o.defaultValue))
 102                      << " min "     << o.min
 103                      << " max "     << o.max;
 104
 105               break;
 106           }
 107
 108   return os;
 109 }
 110
 111
 112 /// Option class constructors and conversion operators
 113
 114 Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
 115 { defaultValue = currentValue = v; }
 116
 117 Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
 118 { defaultValue = currentValue = (v ? "true" : "false"); }
 119
 120 Option::Option(OnChange f) : type("button"), min(0), max(0), on_change(f)
 121 {}
 122
 123 Option::Option(double v, int minv, int maxv, OnChange f) : type("spin"), min(minv), max(maxv), on_change(f)
 124 { defaultValue = currentValue = std::to_string(v); }
 125
 126 Option::Option(const char* v, const char* cur, OnChange f) : type("combo"), min(0), max(0), on_change(f)
 127 { defaultValue = v; currentValue = cur; }
 128
 129 Option::operator int() const {
 130   assert(type == "check" || type == "spin");
 131   return (type == "spin" ? std::stoi(currentValue) : currentValue == "true");
 132 }
 133
 134 Option::operator std::string() const {
 135   assert(type == "string");
 136   return currentValue;
 137 }
 138
 139 bool Option::operator==(const char* s) const {
 140   assert(type == "combo");
 141   return   !CaseInsensitiveLess()(currentValue, s)
 142         && !CaseInsensitiveLess()(s, currentValue);
 143 }
 144
 145
 146 /// operator<<() inits options and assigns idx in the correct printing order
 147
 148 void Option::operator<<(const Option& o) {
 149
 150   static size_t insert_order = 0;
 151
 152   *this = o;
 153   idx = insert_order++;
 154 }
 155
 156
 157 /// operator=() updates currentValue and triggers on_change() action. It's up to
 158 /// the GUI to check for option's limits, but we could receive the new value
 159 /// from the user by console window, so let's check the bounds anyway.
 160
 161 Option& Option::operator=(const string& v) {
 162
 163   assert(!type.empty());
 164
 165   if (   (type != "button" && type != "string" && v.empty())
 166       || (type == "check" && v != "true" && v != "false")
 167       || (type == "spin" && (stof(v) < min || stof(v) > max)))
 168       return *this;
 169
 170   if (type == "combo")
 171   {
 172       OptionsMap comboMap; // To have case insensitive compare
 173       string token;
 174       std::istringstream ss(defaultValue);
 175       while (ss >> token)
 176           comboMap[token] << Option();
 177       if (!comboMap.count(v) || v == "var")
 178           return *this;
 179   }
 180
 181   if (type != "button")
 182       currentValue = v;
 183
 184   if (on_change)
 185       on_change(*this);
 186
 187   return *this;
 188 }
 189
 190 } // namespace UCI
 191
 192 } // namespace Stockfish