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