Final UCI helpers renaming
[stockfish] / src / uci.h
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 #ifndef UCIOPTION_H_INCLUDED
21 #define UCIOPTION_H_INCLUDED
22
23 #include <map>
24 #include <string>
25
26 #include "types.h"
27
28 class Position;
29
30 namespace UCI {
31
32 class Option;
33
34 /// Custom comparator because UCI options should be case insensitive
35 struct CaseInsensitiveLess {
36   bool operator() (const std::string&, const std::string&) const;
37 };
38
39 /// Our options container is actually a std::map
40 typedef std::map<std::string, Option, CaseInsensitiveLess> OptionsMap;
41
42 /// Option class implements an option as defined by UCI protocol
43 class Option {
44
45   typedef void (*OnChange)(const Option&);
46
47 public:
48   Option(OnChange = NULL);
49   Option(bool v, OnChange = NULL);
50   Option(const char* v, OnChange = NULL);
51   Option(int v, int min, int max, OnChange = NULL);
52
53   Option& operator=(const std::string& v);
54   void operator<<(const Option& o);
55   operator int() const;
56   operator std::string() const;
57
58 private:
59   friend std::ostream& operator<<(std::ostream&, const OptionsMap&);
60
61   std::string defaultValue, currentValue, type;
62   int min, max;
63   size_t idx;
64   OnChange on_change;
65 };
66
67 void init(OptionsMap&);
68 void loop(int argc, char* argv[]);
69
70 Move to_move(const Position& pos, std::string& str);
71 std::string format_move(Move m, bool chess960);
72 std::string format_value(Value v, Value alpha = -VALUE_INFINITE, Value beta = VALUE_INFINITE);
73 std::string format_square(Square s);
74
75 } // namespace UCI
76
77 extern UCI::OptionsMap Options;
78
79 #endif // #ifndef UCIOPTION_H_INCLUDED