Make server address into an UCI option.
[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-2019 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 "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(o); }
43 void on_logger(const Option& o) { start_logger(o); }
44 void on_threads(const Option& o) { Threads.set(o); }
45 void on_tb_path(const Option& o) { Tablebases::init(o); }
46 void on_rpc_server_address(const Option& o) {
47         if (hash_probe_thread) {
48                 hash_probe_thread->Shutdown();
49         }
50         std::string addr = o;
51         hash_probe_thread.reset(new HashProbeThread(addr));
52 }
53
54 /// Our case insensitive less() function as required by UCI protocol
55 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
56
57   return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(),
58          [](char c1, char c2) { return tolower(c1) < tolower(c2); });
59 }
60
61
62 /// init() initializes the UCI options to their hard-coded default values
63
64 void init(OptionsMap& o) {
65
66   // at most 2^32 clusters.
67   constexpr int MaxHashMB = Is64Bit ? 131072 : 2048;
68
69   o["Debug Log File"]        << Option("", on_logger);
70   o["Contempt"]              << Option(24, -100, 100);
71   o["Analysis Contempt"]     << Option("Both var Off var White var Black var Both", "Both");
72   o["Threads"]               << Option(1, 1, 512, on_threads);
73   o["Hash"]                  << Option(16, 1, MaxHashMB, on_hash_size);
74   o["Clear Hash"]            << Option(on_clear_hash);
75   o["Ponder"]                << Option(false);
76   o["MultiPV"]               << Option(1, 1, 500);
77   o["Skill Level"]           << Option(20, 0, 20);
78   o["Move Overhead"]         << Option(30, 0, 5000);
79   o["Minimum Thinking Time"] << Option(20, 0, 5000);
80   o["Slow Mover"]            << Option(84, 10, 1000);
81   o["nodestime"]             << Option(0, 0, 10000);
82   o["UCI_Chess960"]          << Option(false);
83   o["UCI_AnalyseMode"]       << Option(false);
84   o["SyzygyPath"]            << Option("<empty>", on_tb_path);
85   o["SyzygyProbeDepth"]      << Option(1, 1, 100);
86   o["Syzygy50MoveRule"]      << Option(true);
87   o["SyzygyProbeLimit"]      << Option(7, 0, 7);
88   o["RPCServerAddress"]      << Option("<empty>", on_rpc_server_address);
89 }
90
91
92 /// operator<<() is used to print all the options default values in chronological
93 /// insertion order (the idx field) and in the format defined by the UCI protocol.
94
95 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
96
97   for (size_t idx = 0; idx < om.size(); ++idx)
98       for (const auto& it : om)
99           if (it.second.idx == idx)
100           {
101               const Option& o = it.second;
102               os << "\noption name " << it.first << " type " << o.type;
103
104               if (o.type == "string" || o.type == "check" || o.type == "combo")
105                   os << " default " << o.defaultValue;
106
107               if (o.type == "spin")
108                   os << " default " << int(stof(o.defaultValue))
109                      << " min "     << o.min
110                      << " max "     << o.max;
111
112               break;
113           }
114
115   return os;
116 }
117
118
119 /// Option class constructors and conversion operators
120
121 Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
122 { defaultValue = currentValue = v; }
123
124 Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
125 { defaultValue = currentValue = (v ? "true" : "false"); }
126
127 Option::Option(OnChange f) : type("button"), min(0), max(0), on_change(f)
128 {}
129
130 Option::Option(double v, int minv, int maxv, OnChange f) : type("spin"), min(minv), max(maxv), on_change(f)
131 { defaultValue = currentValue = std::to_string(v); }
132
133 Option::Option(const char* v, const char* cur, OnChange f) : type("combo"), min(0), max(0), on_change(f)
134 { defaultValue = v; currentValue = cur; }
135
136 Option::operator double() const {
137   assert(type == "check" || type == "spin");
138   return (type == "spin" ? stof(currentValue) : currentValue == "true");
139 }
140
141 Option::operator std::string() const {
142   assert(type == "string");
143   return currentValue;
144 }
145
146 bool Option::operator==(const char* s) const {
147   assert(type == "combo");
148   return    !CaseInsensitiveLess()(currentValue, s)
149          && !CaseInsensitiveLess()(s, currentValue);
150 }
151
152
153 /// operator<<() inits options and assigns idx in the correct printing order
154
155 void Option::operator<<(const Option& o) {
156
157   static size_t insert_order = 0;
158
159   *this = o;
160   idx = insert_order++;
161 }
162
163
164 /// operator=() updates currentValue and triggers on_change() action. It's up to
165 /// the GUI to check for option's limits, but we could receive the new value from
166 /// the user by console window, so let's check the bounds anyway.
167
168 Option& Option::operator=(const string& v) {
169
170   assert(!type.empty());
171
172   if (   (type != "button" && v.empty())
173       || (type == "check" && v != "true" && v != "false")
174       || (type == "spin" && (stof(v) < min || stof(v) > max)))
175       return *this;
176
177   if (type != "button")
178       currentValue = v;
179
180   if (on_change)
181       on_change(*this);
182
183   return *this;
184 }
185
186 } // namespace UCI