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 <map>
  23 #include <string>
  24
  25 #include "types.h"
  26
  27 namespace Stockfish {
  28
  29 class Position;
  30
  31 namespace UCI {
  32
  33 // Normalizes the internal value as reported by evaluate or search
  34 // to the UCI centipawn result used in output. This value is derived from
  35 // the win_rate_model() such that Stockfish outputs an advantage of
  36 // "100 centipawns" for a position if the engine has a 50% probability to win
  37 // from this position in selfplay at fishtest LTC time control.
  38 const int NormalizeToPawnValue = 394;
  39
  40 class Option;
  41
  42 /// Define a custom comparator, because the UCI options should be case-insensitive
  43 struct CaseInsensitiveLess {
  44   bool operator() (const std::string&, const std::string&) const;
  45 };
  46
  47 /// The options container is defined as a std::map
  48 using OptionsMap = std::map<std::string, Option, CaseInsensitiveLess>;
  49
  50 /// The Option class implements each option as specified by the UCI protocol
  51 class Option {
  52
  53   using OnChange = void (*)(const Option&);
  54
  55 public:
  56   Option(OnChange = nullptr);
  57   Option(bool v, OnChange = nullptr);
  58   Option(const char* v, OnChange = nullptr);
  59   Option(double v, int minv, int maxv, OnChange = nullptr);
  60   Option(const char* v, const char* cur, OnChange = nullptr);
  61
  62   Option& operator=(const std::string&);
  63   void operator<<(const Option&);
  64   operator double() const;
  65   operator std::string() const;
  66   bool operator==(const char*) const;
  67
  68 private:
  69   friend std::ostream& operator<<(std::ostream&, const OptionsMap&);
  70
  71   std::string defaultValue, currentValue, type;
  72   int min, max;
  73   size_t idx;
  74   OnChange on_change;
  75 };
  76
  77 void init(OptionsMap&);
  78 void loop(int argc, char* argv[]);
  79 std::string value(Value v);
  80 std::string square(Square s);
  81 std::string move(Move m, bool chess960);
  82 std::string pv(const Position& pos, Depth depth);
  83 std::string wdl(Value v, int ply);
  84 Move to_move(const Position& pos, std::string& str);
  85
  86 } // namespace UCI
  87
  88 extern UCI::OptionsMap Options;
  89
  90 } // namespace Stockfish
  91
  92 #endif // #ifndef UCI_H_INCLUDED