6a4dfd6d703d79b7ba15208c833b091501ed9e6b
[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-2014 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 <cassert>
22 #include <cstdlib>
23 #include <sstream>
24
25 #include "evaluate.h"
26 #include "misc.h"
27 #include "thread.h"
28 #include "tt.h"
29 #include "ucioption.h"
30
31 using std::string;
32
33 UCI::OptionsMap Options; // Global object
34
35 namespace UCI {
36
37 /// 'On change' actions, triggered by an option's value change
38 void on_logger(const Option& o) { start_logger(o); }
39 void on_eval(const Option&) { Eval::init(); }
40 void on_threads(const Option&) { Threads.read_uci_options(); }
41 void on_hash_size(const Option& o) { TT.resize(o); }
42 void on_clear_hash(const Option&) { TT.clear(); }
43
44
45 /// Our case insensitive less() function as required by UCI protocol
46 bool ci_less(char c1, char c2) { return tolower(c1) < tolower(c2); }
47
48 bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
49   return std::lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(), ci_less);
50 }
51
52
53 /// init() initializes the UCI options to their hard-coded default values
54
55 void init(OptionsMap& o) {
56
57   o["Write Debug Log"]          << Option(false, on_logger);
58   o["Write Search Log"]         << Option(false);
59   o["Search Log Filename"]      << Option("SearchLog.txt");
60   o["Book File"]                << Option("book.bin");
61   o["Best Book Move"]           << Option(false);
62   o["Contempt Factor"]          << Option(0, -50,  50);
63   o["Min Split Depth"]          << Option(0, 0, 12, on_threads);
64   o["Threads"]                  << Option(1, 1, MAX_THREADS, on_threads);
65   o["Hash"]                     << Option(32, 1, 16384, on_hash_size);
66   o["Clear Hash"]               << Option(on_clear_hash);
67   o["Ponder"]                   << Option(true);
68   o["OwnBook"]                  << Option(false);
69   o["MultiPV"]                  << Option(1, 1, 500);
70   o["Skill Level"]              << Option(20, 0, 20);
71   o["Emergency Move Horizon"]   << Option(40, 0, 50);
72   o["Emergency Base Time"]      << Option(60, 0, 30000);
73   o["Emergency Move Time"]      << Option(30, 0, 5000);
74   o["Minimum Thinking Time"]    << Option(20, 0, 5000);
75   o["Slow Mover"]               << Option(80, 10, 1000);
76   o["UCI_Chess960"]             << Option(false);
77 }
78
79
80 /// operator<<() is used to print all the options default values in chronological
81 /// insertion order (the idx field) and in the format defined by the UCI protocol.
82
83 std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
84
85   for (size_t idx = 0; idx < om.size(); ++idx)
86       for (OptionsMap::const_iterator it = om.begin(); it != om.end(); ++it)
87           if (it->second.idx == idx)
88           {
89               const Option& o = it->second;
90               os << "\noption name " << it->first << " type " << o.type;
91
92               if (o.type != "button")
93                   os << " default " << o.defaultValue;
94
95               if (o.type == "spin")
96                   os << " min " << o.min << " max " << o.max;
97
98               break;
99           }
100   return os;
101 }
102
103
104 /// Option class constructors and conversion operators
105
106 Option::Option(const char* v, OnChange f) : type("string"), min(0), max(0), on_change(f)
107 { defaultValue = currentValue = v; }
108
109 Option::Option(bool v, OnChange f) : type("check"), min(0), max(0), on_change(f)
110 { defaultValue = currentValue = (v ? "true" : "false"); }
111
112 Option::Option(OnChange f) : type("button"), min(0), max(0), on_change(f)
113 {}
114
115 Option::Option(int v, int minv, int maxv, OnChange f) : type("spin"), min(minv), max(maxv), on_change(f)
116 { std::ostringstream ss; ss << v; defaultValue = currentValue = ss.str(); }
117
118
119 Option::operator int() const {
120   assert(type == "check" || type == "spin");
121   return (type == "spin" ? atoi(currentValue.c_str()) : currentValue == "true");
122 }
123
124 Option::operator std::string() const {
125   assert(type == "string");
126   return currentValue;
127 }
128
129
130 /// operator<<() inits options and assigns idx in the correct printing order
131
132 void Option::operator<<(const Option& o) {
133
134   static size_t insert_order = 0;
135
136   *this = o;
137   idx = insert_order++;
138 }
139
140
141 /// operator=() updates currentValue and triggers on_change() action. It's up to
142 /// the GUI to check for option's limits, but we could receive the new value from
143 /// the user by console window, so let's check the bounds anyway.
144
145 Option& Option::operator=(const string& v) {
146
147   assert(!type.empty());
148
149   if (   (type != "button" && v.empty())
150       || (type == "check" && v != "true" && v != "false")
151       || (type == "spin" && (atoi(v.c_str()) < min || atoi(v.c_str()) > max)))
152       return *this;
153
154   if (type != "button")
155       currentValue = v;
156
157   if (on_change)
158       on_change(*this);
159
160   return *this;
161 }
162
163 } // namespace UCI