Merge remote-tracking branch 'upstream/master'
[stockfish] / 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-2020 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 #include <sstream>
25
26 #include "misc.h"
27 #include "search.h"
28 #include "thread.h"
29 #include "tt.h"
30 #include "uci.h"
31 #include "hashprobe.h"
32 #include "syzygy/tbprobe.h"
33
34 using std::string;
35
36 UCI::OptionsMap Options; // Global object
37 std::unique_ptr<HashProbeThread> hash_probe_thread;
38
39 namespace UCI {
40
41 /// 'On change' actions, triggered by an option's value change
42 void on_clear_hash(const Option&) { Search::clear(); }
43 void on_hash_size(const Option& o) { TT.resize(o); }
44 void on_logger(const Option& o) { start_logger(o); }
45 void on_threads(const Option& o) { Threads.set(o); }
46 void on_tb_path(const Option& o) { Tablebases::init(o); }
47 void on_rpc_server_address(const Option& o) {
48         if (hash_probe_thread) {
49                 hash_probe_thread->Shutdown();
50         }
51         std::string addr = o;
52         hash_probe_thread.reset(new HashProbeThread(addr));
53 }
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 /// init() initializes the UCI options to their hard-coded default values
64
65 void init(OptionsMap& o) {
66
67   // at most 2^32 clusters.
68   constexpr int MaxHashMB = Is64Bit ? 131072 : 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(30, 0, 5000);
80   o["Minimum Thinking Time"] << Option(20, 0, 5000);
81   o["Slow Mover"]            << Option(84, 10, 1000);
82   o["nodestime"]             << Option(0, 0, 10000);
83   o["UCI_Chess960"]          << Option(false);
84   o["UCI_AnalyseMode"]       << Option(false);
85   o["UCI_LimitStrength"]     << Option(false);
86   o["UCI_Elo"]               << Option(1350, 1350, 2850);
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["RPCServerAddress"]      << Option("<empty>", on_rpc_server_address);
92 }
93
94
95 /// operator<<() is used to print all the options default values in chronological
96 /// insertion order (the idx field) and in the format defined by the UCI protocol.
97
98 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
99
100   for (size_t idx = 0; idx < om.size(); ++idx)
101       for (const auto& it : om)
102           if (it.second.idx == idx)
103           {
104               const Option& o = it.second;
105               os << "\noption name " << it.first << " type " << o.type;
106
107               if (o.type == "string" || o.type == "check" || o.type == "combo")
108                   os << " default " << o.defaultValue;
109
110               if (o.type == "spin")
111                   os << " default " << int(stof(o.defaultValue))
112                      << " min "     << o.min
113                      << " max "     << o.max;
114
115               break;
116           }
117
118   return os;
119 }
120
121
122 /// Option class constructors and conversion operators
123
124 Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
125 { defaultValue = currentValue = v; }
126
127 Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
128 { defaultValue = currentValue = (v ? "true" : "false"); }
129
130 Option::Option(OnChange f) : type("button"), min(0), max(0), on_change(f)
131 {}
132
133 Option::Option(double v, int minv, int maxv, OnChange f) : type("spin"), min(minv), max(maxv), on_change(f)
134 { defaultValue = currentValue = std::to_string(v); }
135
136 Option::Option(const char* v, const char* cur, OnChange f) : type("combo"), min(0), max(0), on_change(f)
137 { defaultValue = v; currentValue = cur; }
138
139 Option::operator double() const {
140   assert(type == "check" || type == "spin");
141   return (type == "spin" ? stof(currentValue) : currentValue == "true");
142 }
143
144 Option::operator std::string() const {
145   assert(type == "string");
146   return currentValue;
147 }
148
149 bool Option::operator==(const char* s) const {
150   assert(type == "combo");
151   return   !CaseInsensitiveLess()(currentValue, s)
152         && !CaseInsensitiveLess()(s, currentValue);
153 }
154
155
156 /// operator<<() inits options and assigns idx in the correct printing order
157
158 void Option::operator<<(const Option& o) {
159
160   static size_t insert_order = 0;
161
162   *this = o;
163   idx = insert_order++;
164 }
165
166
167 /// operator=() updates currentValue and triggers on_change() action. It's up to
168 /// the GUI to check for option's limits, but we could receive the new value
169 /// from the user by console window, so let's check the bounds anyway.
170
171 Option& Option::operator=(const string& v) {
172
173   assert(!type.empty());
174
175   if (   (type != "button" && v.empty())
176       || (type == "check" && v != "true" && v != "false")
177       || (type == "spin" && (stof(v) < min || stof(v) > max)))
178       return *this;
179
180   if (type == "combo")
181   {
182       OptionsMap comboMap; // To have case insensitive compare
183       string token;
184       std::istringstream ss(defaultValue);
185       while (ss >> token)
186           comboMap[token] << Option();
187       if (!comboMap.count(v) || v == "var")
188           return *this;
189   }
190
191   if (type != "button")
192       currentValue = v;
193
194   if (on_change)
195       on_change(*this);
196
197   return *this;
198 }
199
200 } // namespace UCI