af568a37953799786ce4f15aec954cc18b817e2a
[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-2010 Marco Costalba, Joona Kiiski, Tord Romstad
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20
21 ////
22 //// Includes
23 ////
24
25 #include <algorithm>
26 #include <cassert>
27 #include <map>
28 #include <string>
29 #include <sstream>
30 #include <vector>
31
32 #include "misc.h"
33 #include "thread.h"
34 #include "ucioption.h"
35
36 using std::string;
37
38 ////
39 //// Local definitions
40 ////
41
42 namespace {
43
44   ///
45   /// Types
46   ///
47
48   enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON };
49
50   typedef std::vector<string> ComboValues;
51
52   struct Option {
53
54     string name, defaultValue, currentValue;
55     OptionType type;
56     size_t idx;
57     int minValue, maxValue;
58     ComboValues comboValues;
59
60     Option();
61     Option(const char* defaultValue, OptionType = STRING);
62     Option(bool defaultValue, OptionType = CHECK);
63     Option(int defaultValue, int minValue, int maxValue);
64
65     bool operator<(const Option& o) const { return this->idx < o.idx; }
66   };
67
68   typedef std::map<string, Option> Options;
69
70   ///
71   /// Constants
72   ///
73
74   // load_defaults populates the options map with the hard
75   // coded names and default values.
76
77   void load_defaults(Options& o) {
78
79     o["Use Search Log"] = Option(false);
80     o["Search Log Filename"] = Option("SearchLog.txt");
81     o["Book File"] = Option("book.bin");
82     o["Mobility (Middle Game)"] = Option(100, 0, 200);
83     o["Mobility (Endgame)"] = Option(100, 0, 200);
84     o["Pawn Structure (Middle Game)"] = Option(100, 0, 200);
85     o["Pawn Structure (Endgame)"] = Option(100, 0, 200);
86     o["Passed Pawns (Middle Game)"] = Option(100, 0, 200);
87     o["Passed Pawns (Endgame)"] = Option(100, 0, 200);
88     o["Space"] = Option(100, 0, 200);
89     o["Aggressiveness"] = Option(100, 0, 200);
90     o["Cowardice"] = Option(100, 0, 200);
91     o["Check Extension (PV nodes)"] = Option(2, 0, 2);
92     o["Check Extension (non-PV nodes)"] = Option(1, 0, 2);
93     o["Single Evasion Extension (PV nodes)"] = Option(2, 0, 2);
94     o["Single Evasion Extension (non-PV nodes)"] = Option(2, 0, 2);
95     o["Mate Threat Extension (PV nodes)"] = Option(0, 0, 2);
96     o["Mate Threat Extension (non-PV nodes)"] = Option(0, 0, 2);
97     o["Pawn Push to 7th Extension (PV nodes)"] = Option(1, 0, 2);
98     o["Pawn Push to 7th Extension (non-PV nodes)"] = Option(1, 0, 2);
99     o["Passed Pawn Extension (PV nodes)"] = Option(1, 0, 2);
100     o["Passed Pawn Extension (non-PV nodes)"] = Option(0, 0, 2);
101     o["Pawn Endgame Extension (PV nodes)"] = Option(2, 0, 2);
102     o["Pawn Endgame Extension (non-PV nodes)"] = Option(2, 0, 2);
103     o["Randomness"] = Option(0, 0, 10);
104     o["Minimum Split Depth"] = Option(4, 4, 7);
105     o["Maximum Number of Threads per Split Point"] = Option(5, 4, 8);
106     o["Threads"] = Option(1, 1, MAX_THREADS);
107     o["Hash"] = Option(32, 4, 8192);
108     o["Clear Hash"] = Option(false, BUTTON);
109     o["New Game"] = Option(false, BUTTON);
110     o["Ponder"] = Option(true);
111     o["OwnBook"] = Option(true);
112     o["MultiPV"] = Option(1, 1, 500);
113     o["UCI_Chess960"] = Option(false);
114     o["UCI_AnalyseMode"] = Option(false);
115
116     // Any option should know its name so to be easily printed
117     for (Options::iterator it = o.begin(); it != o.end(); ++it)
118         it->second.name = it->first;
119   }
120
121   ///
122   /// Variables
123   ///
124
125   Options options;
126
127   // stringify converts a value of type T to a std::string
128   template<typename T>
129   string stringify(const T& v) {
130
131      std::ostringstream ss;
132      ss << v;
133      return ss.str();
134   }
135
136
137   // get_option_value implements the various get_option_value_<type>
138   // functions defined later, because only the option value
139   // type changes a template seems a proper solution.
140
141   template<typename T>
142   T get_option_value(const string& optionName) {
143
144       T ret = T();
145       if (options.find(optionName) == options.end())
146           return ret;
147
148       std::istringstream ss(options[optionName].currentValue);
149       ss >> ret;
150       return ret;
151   }
152
153   // Specialization for std::string where instruction 'ss >> ret;'
154   // would erroneusly tokenize a string with spaces.
155
156   template<>
157   string get_option_value<string>(const string& optionName) {
158
159       if (options.find(optionName) == options.end())
160           return string();
161
162       return options[optionName].currentValue;
163   }
164
165 }
166
167 ////
168 //// Functions
169 ////
170
171 /// init_uci_options() initializes the UCI options.  Currently, the only
172 /// thing this function does is to initialize the default value of the
173 /// "Threads" parameter to the number of available CPU cores.
174
175 void init_uci_options() {
176
177   load_defaults(options);
178
179   // Set optimal value for parameter "Minimum Split Depth"
180   // according to number of available cores.
181   assert(options.find("Threads") != options.end());
182   assert(options.find("Minimum Split Depth") != options.end());
183
184   Option& thr = options["Threads"];
185   Option& msd = options["Minimum Split Depth"];
186
187   thr.defaultValue = thr.currentValue = stringify(cpu_count());
188
189   if (cpu_count() >= 8)
190       msd.defaultValue = msd.currentValue = stringify(7);
191 }
192
193
194 /// print_uci_options() prints all the UCI options to the standard output,
195 /// in the format defined by the UCI protocol.
196
197 void print_uci_options() {
198
199   static const char optionTypeName[][16] = {
200     "spin", "combo", "check", "string", "button"
201   };
202
203   // Build up a vector out of the options map and sort it according to idx
204   // field, that is the chronological insertion order in options map.
205   std::vector<Option> vec;
206   for (Options::const_iterator it = options.begin(); it != options.end(); ++it)
207       vec.push_back(it->second);
208
209   std::sort(vec.begin(), vec.end());
210
211   for (std::vector<Option>::const_iterator it = vec.begin(); it != vec.end(); ++it)
212   {
213       std::cout << "\noption name " << it->name
214                 << " type "         << optionTypeName[it->type];
215
216       if (it->type == BUTTON)
217           continue;
218
219       if (it->type == CHECK)
220           std::cout << " default " << (it->defaultValue == "1" ? "true" : "false");
221       else
222           std::cout << " default " << it->defaultValue;
223
224       if (it->type == SPIN)
225           std::cout << " min " << it->minValue << " max " << it->maxValue;
226       else if (it->type == COMBO)
227           for (ComboValues::const_iterator itc = it->comboValues.begin();
228               itc != it->comboValues.end(); ++itc)
229               std::cout << " var " << *itc;
230   }
231   std::cout << std::endl;
232 }
233
234
235 /// get_option_value_bool() returns the current value of a UCI parameter of
236 /// type "check".
237
238 bool get_option_value_bool(const string& optionName) {
239
240   return get_option_value<bool>(optionName);
241 }
242
243
244 /// get_option_value_int() returns the value of a UCI parameter as an integer.
245 /// Normally, this function will be used for a parameter of type "spin", but
246 /// it could also be used with a "combo" parameter, where all the available
247 /// values are integers.
248
249 int get_option_value_int(const string& optionName) {
250
251   return get_option_value<int>(optionName);
252 }
253
254
255 /// get_option_value_string() returns the current value of a UCI parameter as
256 /// a string. It is used with parameters of type "combo" and "string".
257
258 string get_option_value_string(const string& optionName) {
259
260    return get_option_value<string>(optionName);
261 }
262
263
264 /// set_option_value() inserts a new value for a UCI parameter. Note that
265 /// the function does not check that the new value is legal for the given
266 /// parameter: This is assumed to be the responsibility of the GUI.
267
268 void set_option_value(const string& name, const string& value) {
269
270   // UCI protocol uses "true" and "false" instead of "1" and "0", so convert
271   // value according to standard C++ convention before to store it.
272   string v(value);
273   if (v == "true")
274       v = "1";
275   else if (v == "false")
276       v = "0";
277
278   if (options.find(name) == options.end())
279   {
280       std::cout << "No such option: " << name << std::endl;
281       return;
282   }
283
284   // Normally it's up to the GUI to check for option's limits,
285   // but we could receive the new value directly from the user
286   // by teminal window. So let's check the bounds anyway.
287   Option& opt = options[name];
288
289   if (opt.type == CHECK && v != "0" && v != "1")
290       return;
291
292   else if (opt.type == SPIN)
293   {
294       int val = atoi(v.c_str());
295       if (val < opt.minValue || val > opt.maxValue)
296           return;
297   }
298
299   opt.currentValue = v;
300 }
301
302
303 /// push_button() is used to tell the engine that a UCI parameter of type
304 /// "button" has been selected:
305
306 void push_button(const string& buttonName) {
307
308   set_option_value(buttonName, "true");
309 }
310
311
312 /// button_was_pressed() tests whether a UCI parameter of type "button" has
313 /// been selected since the last time the function was called, in this case
314 /// it also resets the button.
315
316 bool button_was_pressed(const string& buttonName) {
317
318   if (!get_option_value<bool>(buttonName))
319       return false;
320
321   set_option_value(buttonName, "false");
322   return true;
323 }
324
325
326 namespace {
327
328   // Define constructors of Option class.
329
330   Option::Option() {} // To allow insertion in a std::map
331
332   Option::Option(const char* def, OptionType t)
333   : defaultValue(def), currentValue(def), type(t), idx(options.size()), minValue(0), maxValue(0) {}
334
335   Option::Option(bool def, OptionType t)
336   : defaultValue(stringify(def)), currentValue(stringify(def)), type(t), idx(options.size()), minValue(0), maxValue(0) {}
337
338   Option::Option(int def, int minv, int maxv)
339   : defaultValue(stringify(def)), currentValue(stringify(def)), type(SPIN), idx(options.size()), minValue(minv), maxValue(maxv) {}
340
341 }