Async UCI options actions
[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-2012 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 #include <algorithm>
21 #include <sstream>
22
23 #include "misc.h"
24 #include "thread.h"
25 #include "tt.h"
26 #include "ucioption.h"
27
28 using std::string;
29
30 OptionsMap Options; // Global object
31
32
33 /// 'On change' actions, triggered by an option's change event
34 static void on_threads(UCIOption&) { Threads.read_uci_options(); }
35 static void on_hash_size(UCIOption& o) { TT.set_size(o); }
36 static void on_clear_hash(UCIOption& o) { TT.clear(); o = false; } // UCI button
37
38
39 /// Our case insensitive less() function as required by UCI protocol
40 static bool ci_less(char c1, char c2) { return tolower(c1) < tolower(c2); }
41
42 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
43   return lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(), ci_less);
44 }
45
46
47 /// OptionsMap c'tor initializes the UCI options to their hard coded default
48 /// values and initializes the default value of "Threads" and "Min Split Depth"
49 /// parameters according to the number of CPU cores detected.
50
51 OptionsMap::OptionsMap() {
52
53   int cpus = std::min(cpu_count(), MAX_THREADS);
54   int msd = cpus < 8 ? 4 : 7;
55   OptionsMap& o = *this;
56
57   o["Use Search Log"]              = UCIOption(false);
58   o["Search Log Filename"]         = UCIOption("SearchLog.txt");
59   o["Book File"]                   = UCIOption("book.bin");
60   o["Best Book Move"]              = UCIOption(false);
61   o["Mobility (Middle Game)"]      = UCIOption(100, 0, 200);
62   o["Mobility (Endgame)"]          = UCIOption(100, 0, 200);
63   o["Passed Pawns (Middle Game)"]  = UCIOption(100, 0, 200);
64   o["Passed Pawns (Endgame)"]      = UCIOption(100, 0, 200);
65   o["Space"]                       = UCIOption(100, 0, 200);
66   o["Aggressiveness"]              = UCIOption(100, 0, 200);
67   o["Cowardice"]                   = UCIOption(100, 0, 200);
68   o["Min Split Depth"]             = UCIOption(msd, 4, 7, on_threads);
69   o["Max Threads per Split Point"] = UCIOption(5, 4, 8, on_threads);
70   o["Threads"]                     = UCIOption(cpus, 1, MAX_THREADS);
71   o["Use Sleeping Threads"]        = UCIOption(true, on_threads);
72   o["Hash"]                        = UCIOption(32, 4, 8192, on_hash_size);
73   o["Clear Hash"]                  = UCIOption(false, on_clear_hash);
74   o["Ponder"]                      = UCIOption(true);
75   o["OwnBook"]                     = UCIOption(true);
76   o["MultiPV"]                     = UCIOption(1, 1, 500);
77   o["Skill Level"]                 = UCIOption(20, 0, 20);
78   o["Emergency Move Horizon"]      = UCIOption(40, 0, 50);
79   o["Emergency Base Time"]         = UCIOption(200, 0, 30000);
80   o["Emergency Move Time"]         = UCIOption(70, 0, 5000);
81   o["Minimum Thinking Time"]       = UCIOption(20, 0, 5000);
82   o["Slow Mover"]                  = UCIOption(100, 10, 1000);
83   o["UCI_Chess960"]                = UCIOption(false);
84   o["UCI_AnalyseMode"]             = UCIOption(false);
85 }
86
87
88 /// operator<<() is used to output all the UCI options in chronological insertion
89 /// order (the idx field) and in the format defined by the UCI protocol.
90 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
91
92   for (size_t idx = 0; idx < om.size(); idx++)
93       for (OptionsMap::const_iterator it = om.begin(); it != om.end(); ++it)
94           if (it->second.idx == idx)
95           {
96               const UCIOption& o = it->second;
97               os << "\noption name " << it->first << " type " << o.type;
98
99               if (o.type != "button")
100                   os << " default " << o.defaultValue;
101
102               if (o.type == "spin")
103                   os << " min " << o.min << " max " << o.max;
104
105               break;
106           }
107   return os;
108 }
109
110
111 /// UCIOption class c'tors
112
113 UCIOption::UCIOption(const char* v, Fn* f) : type("string"), min(0), max(0), idx(Options.size()), on_change_action(f)
114 { defaultValue = currentValue = v; }
115
116 UCIOption::UCIOption(bool v, Fn* f) : type("check"), min(0), max(0), idx(Options.size()), on_change_action(f)
117 { defaultValue = currentValue = (v ? "true" : "false"); }
118
119 UCIOption::UCIOption(int v, int minv, int maxv, Fn* f) : type("spin"), min(minv), max(maxv), idx(Options.size()), on_change_action(f)
120 { std::ostringstream ss; ss << v; defaultValue = currentValue = ss.str(); }
121
122
123 /// UCIOption::operator=() updates currentValue. Normally it's up to the GUI to
124 /// check for option's limits, but we could receive the new value directly from
125 /// the user by teminal window, so let's check the bounds anyway.
126
127 void UCIOption::operator=(const string& v) {
128
129   assert(!type.empty());
130
131   if (   !v.empty()
132       && (type == "check") == (v == "true" || v == "false")
133       && (type != "spin" || (atoi(v.c_str()) >= min && atoi(v.c_str()) <= max)))
134   {
135       currentValue = v;
136
137       if (on_change_action)
138           (*on_change_action)(*this);
139   }
140 }