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-2008 Tord Romstad (Glaurung author)
   4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
   5   Copyright (C) 2015-2018 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
   6
   7   Stockfish is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   Stockfish is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include <algorithm>
  22 #include <cassert>
  23 #include <ostream>
  24
  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 UCI::OptionsMap Options; // Global object
  35
  36 namespace UCI {
  37
  38 /// 'On change' actions, triggered by an option's value change
  39 void on_clear_hash(const Option&) { Search::clear(); }
  40 void on_hash_size(const Option& o) { TT.resize(o); }
  41 void on_logger(const Option& o) { start_logger(o); }
  42 void on_threads(const Option& o) { Threads.set(o); }
  43 void on_tb_path(const Option& o) { Tablebases::init(o); }
  44
  45
  46 /// Our case insensitive less() function as required by UCI protocol
  47 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
  48
  49   return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
  50          [](char c1, char c2) { return tolower(c1) < tolower(c2); });
  51 }
  52
  53
  54 /// init() initializes the UCI options to their hard-coded default values
  55
  56 void init(OptionsMap& o) {
  57
  58   // at most 2^32 clusters.
  59   constexpr int MaxHashMB = Is64Bit ? 131072 : 2048;
  60
  61   o["Debug Log File"]        << Option("", on_logger);
  62   o["Contempt"]              << Option(12, -100, 100);
  63   o["Threads"]               << Option(1, 1, 512, 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(30, 0, 5000);
  70   o["Minimum Thinking Time"] << Option(20, 0, 5000);
  71   o["Slow Mover"]            << Option(84, 10, 1000);
  72   o["nodestime"]             << Option(0, 0, 10000);
  73   o["UCI_Chess960"]          << Option(false);
  74   o["SyzygyPath"]            << Option("<empty>", on_tb_path);
  75   o["SyzygyProbeDepth"]      << Option(1, 1, 100);
  76   o["Syzygy50MoveRule"]      << Option(true);
  77   o["SyzygyProbeLimit"]      << Option(6, 0, 6);
  78 }
  79
  80
  81 /// operator<<() is used to print all the options default values in chronological
  82 /// insertion order (the idx field) and in the format defined by the UCI protocol.
  83
  84 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
  85
  86   for (size_t idx = 0; idx < om.size(); ++idx)
  87       for (const auto& it : om)
  88           if (it.second.idx == idx)
  89           {
  90               const Option& o = it.second;
  91               os << "\noption name " << it.first << " type " << o.type;
  92
  93               if (o.type != "button")
  94                   os << " default " << o.defaultValue;
  95
  96               if (o.type == "spin")
  97                   os << " min " << o.min << " max " << o.max;
  98
  99               break;
 100           }
 101
 102   return os;
 103 }
 104
 105
 106 /// Option class constructors and conversion operators
 107
 108 Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
 109 { defaultValue = currentValue = v; }
 110
 111 Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
 112 { defaultValue = currentValue = (v ? "true" : "false"); }
 113
 114 Option::Option(OnChange f) : type("button"), min(0), max(0), on_change(f)
 115 {}
 116
 117 Option::Option(int v, int minv, int maxv, OnChange f) : type("spin"), min(minv), max(maxv), on_change(f)
 118 { defaultValue = currentValue = std::to_string(v); }
 119
 120 Option::operator int() const {
 121   assert(type == "check" || type == "spin");
 122   return (type == "spin" ? stoi(currentValue) : currentValue == "true");
 123 }
 124
 125 Option::operator std::string() const {
 126   assert(type == "string");
 127   return currentValue;
 128 }
 129
 130
 131 /// operator<<() inits options and assigns idx in the correct printing order
 132
 133 void Option::operator<<(const Option& o) {
 134
 135   static size_t insert_order = 0;
 136
 137   *this = o;
 138   idx = insert_order++;
 139 }
 140
 141
 142 /// operator=() updates currentValue and triggers on_change() action. It's up to
 143 /// the GUI to check for option's limits, but we could receive the new value from
 144 /// the user by console window, so let's check the bounds anyway.
 145
 146 Option& Option::operator=(const string& v) {
 147
 148   assert(!type.empty());
 149
 150   if (   (type != "button" && v.empty())
 151       || (type == "check" && v != "true" && v != "false")
 152       || (type == "spin" && (stoi(v) < min || stoi(v) > max)))
 153       return *this;
 154
 155   if (type != "button")
 156       currentValue = v;
 157
 158   if (on_change)
 159       on_change(*this);
 160
 161   return *this;
 162 }
 163
 164 } // namespace UCI