git.sesse.net Git - stockfish/blob - src/uci.h

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
   4
   5   Stockfish is free software: you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation, either version 3 of the License, or
   8   (at your option) any later version.
   9
  10   Stockfish is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 #ifndef UCI_H_INCLUDED
  20 #define UCI_H_INCLUDED
  21
  22 #include <cstddef>
  23 #include <iosfwd>
  24 #include <map>
  25 #include <string>
  26
  27 #include "types.h"
  28
  29 namespace Stockfish {
  30
  31 class Position;
  32
  33 namespace UCI {
  34
  35 // Normalizes the internal value as reported by evaluate or search
  36 // to the UCI centipawn result used in output. This value is derived from
  37 // the win_rate_model() such that Stockfish outputs an advantage of
  38 // "100 centipawns" for a position if the engine has a 50% probability to win
  39 // from this position in self-play at fishtest LTC time control.
  40 const int NormalizeToPawnValue = 328;
  41
  42 class Option;
  43
  44 // Define a custom comparator, because the UCI options should be case-insensitive
  45 struct CaseInsensitiveLess {
  46     bool operator()(const std::string&, const std::string&) const;
  47 };
  48
  49 // The options container is defined as a std::map
  50 using OptionsMap = std::map<std::string, Option, CaseInsensitiveLess>;
  51
  52 // The Option class implements each option as specified by the UCI protocol
  53 class Option {
  54
  55     using OnChange = void (*)(const Option&);
  56
  57    public:
  58     Option(OnChange = nullptr);
  59     Option(bool v, OnChange = nullptr);
  60     Option(const char* v, OnChange = nullptr);
  61     Option(double v, int minv, int maxv, OnChange = nullptr);
  62     Option(const char* v, const char* cur, OnChange = nullptr);
  63
  64     Option& operator=(const std::string&);
  65     void    operator<<(const Option&);
  66     operator int() const;
  67     operator std::string() const;
  68     bool operator==(const char*) const;
  69
  70    private:
  71     friend std::ostream& operator<<(std::ostream&, const OptionsMap&);
  72
  73     std::string defaultValue, currentValue, type;
  74     int         min, max;
  75     size_t      idx;
  76     OnChange    on_change;
  77 };
  78
  79 void        init(OptionsMap&);
  80 void        loop(int argc, char* argv[]);
  81 int         to_cp(Value v);
  82 std::string value(Value v);
  83 std::string square(Square s);
  84 std::string move(Move m, bool chess960);
  85 std::string pv(const Position& pos, Depth depth);
  86 std::string wdl(Value v, int ply);
  87 Move        to_move(const Position& pos, std::string& str);
  88
  89 }  // namespace UCI
  90
  91 extern UCI::OptionsMap Options;
  92
  93 }  // namespace Stockfish
  94
  95 #endif  // #ifndef UCI_H_INCLUDED