]> git.sesse.net Git - stockfish/blobdiff - src/ucioption.cpp
Remove cruft from Logger class
[stockfish] / src / ucioption.cpp
index 764324d6f01694b44e61e2537993c3002497ecf5..df73670b23d090df0922b25604fd2b16c226100b 100644 (file)
 /*
-  Glaurung, a UCI chess playing engine.
-  Copyright (C) 2004-2008 Tord Romstad
+  Stockfish, a UCI chess playing engine derived from Glaurung 2.1
+  Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
+  Copyright (C) 2008-2012 Marco Costalba, Joona Kiiski, Tord Romstad
 
-  Glaurung is free software: you can redistribute it and/or modify
+  Stockfish is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
-  
-  Glaurung is distributed in the hope that it will be useful,
+
+  Stockfish is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
-  
+
   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+#include <algorithm>
+#include <sstream>
 
-////
-//// Includes
-////
-
-#include <cassert>
-#include <cstdarg>
-#include <cstdio>
-
+#include "evaluate.h"
 #include "misc.h"
 #include "thread.h"
+#include "tt.h"
 #include "ucioption.h"
 
+using std::string;
 
-////
-//// Variables
-////
-
-bool Chess960 = false;
-
-
-////
-//// Local definitions
-////
+OptionsMap Options; // Global object
 
 namespace {
 
-  ///
-  /// Types
-  ///
-
-  enum OptionType { SPIN, COMBO, CHECK, STRING, BUTTON, OPTION_TYPE_NONE};
-
-  struct Option {
-    char name[50], defaultValue[300], currentValue[300];
-    OptionType type;
-    int minValue, maxValue;
-    char comboValues[8][64];
-  };
-    
-
-  ///
-  /// Variables
-  ///
-
-  Option Options[] = {
-    { "Use Search Log", "false", "false", CHECK, 0, 0, {""} },
-    { "Search Log Filename", "SearchLog.txt", "SearchLog.txt", STRING, 0, 0, {""} },
-    { "Book File", "book.bin", "book.bin", STRING, 0, 0, {""} },
-    { "Mobility (Middle Game)", "100", "100", SPIN, 0, 200, {""} },
-    { "Mobility (Endgame)", "100", "100", SPIN, 0, 200, {""} },
-    { "Pawn Structure (Middle Game)", "100", "100", SPIN, 0, 200, {""} },
-    { "Pawn Structure (Endgame)", "100", "100", SPIN, 0, 200, {""} },
-    { "Passed Pawns (Middle Game)", "100", "100", SPIN, 0, 200, {""} },
-    { "Passed Pawns (Endgame)", "100", "100", SPIN, 0, 200, {""} },
-    { "Aggressiveness", "100", "100", SPIN, 0, 200, {""} },
-    { "Cowardice", "100", "100", SPIN, 0, 200, {""} },
-    { "King Safety Curve", "Quadratic", "Quadratic", COMBO, 0, 0,
-      { "Quadratic", "Linear" /*, "From File"*/ } },
-    { "King Safety Coefficient", "40", "40", SPIN, 1, 100 , {""} },
-    { "King Safety X Intercept", "0", "0", SPIN, 0, 20, {""} },
-    { "King Safety Max Slope", "30", "30", SPIN, 10, 100, {""} },
-    { "King Safety Max Value", "500", "500", SPIN, 100, 1000, {""} },
-    { "Queen Contact Check Bonus", "4", "4", SPIN, 0, 8, {""} },
-    { "Rook Contact Check Bonus", "2", "2", SPIN, 0, 4, {""} },
-    { "Queen Check Bonus", "2", "2", SPIN, 0, 4, {""} },
-    { "Rook Check Bonus", "1", "1", SPIN, 0, 4, {""} },
-    { "Bishop Check Bonus", "1", "1", SPIN, 0, 4, {""} },
-    { "Knight Check Bonus", "1", "1", SPIN, 0, 4, {""} },
-    { "Discovered Check Bonus", "3", "3", SPIN, 0, 8, {""} },
-    { "Mate Threat Bonus", "3", "3", SPIN, 0, 8, {""} },
-    { "Check Extension (PV nodes)", "2", "2", SPIN, 0, 2, {""} },
-    { "Check Extension (non-PV nodes)", "1", "1", SPIN, 0, 2, {""} },
-    { "Single Reply Extension (PV nodes)", "2", "2", SPIN, 0, 2, {""} },
-    { "Single Reply Extension (non-PV nodes)", "2", "2", SPIN, 0, 2, {""} },
-    { "Mate Threat Extension (PV nodes)", "0", "0", SPIN, 0, 2, {""} },
-    { "Mate Threat Extension (non-PV nodes)", "0", "0", SPIN, 0, 2, {""} },
-    { "Pawn Push to 7th Extension (PV nodes)", "1", "1", SPIN, 0, 2, {""} },
-    { "Pawn Push to 7th Extension (non-PV nodes)", "1", "1", SPIN, 0, 2, {""} },
-    { "Passed Pawn Extension (PV nodes)", "1", "1", SPIN, 0, 2, {""} },
-    { "Passed Pawn Extension (non-PV nodes)", "0", "0", SPIN, 0, 2, {""} },
-    { "Pawn Endgame Extension (PV nodes)", "2", "2", SPIN, 0, 2, {""} },
-    { "Pawn Endgame Extension (non-PV nodes)", "2", "2", SPIN, 0, 2, {""} },
-    { "Full Depth Moves (PV nodes)", "14", "14", SPIN, 1, 100, {""} },
-    { "Full Depth Moves (non-PV nodes)", "3", "3", SPIN, 1, 100, {""} },
-    { "Threat Depth", "5", "5", SPIN, 0, 100, {""} },
-    { "Selective Plies", "7", "7", SPIN, 0, 10, {""} },
-    { "Futility Pruning (Main Search)", "true", "true", CHECK, 0, 0, {""} },
-    { "Futility Pruning (Quiescence Search)", "true", "true", CHECK, 0, 0, {""} },
-    { "Futility Margin 0", "50", "50", SPIN, 0, 1000, {""} },
-    { "Futility Margin 1", "100", "100", SPIN, 0, 1000, {""} },
-    { "Futility Margin 2", "300", "300", SPIN, 0, 1000, {""} },
-    { "Maximum Razoring Depth", "3", "3", SPIN, 0, 4, {""} },
-    { "Razoring Margin", "300", "300", SPIN, 150, 600, {""} },
-    { "Randomness", "0", "0", SPIN, 0, 10, {""} },
-    { "Minimum Split Depth", "4", "4", SPIN, 4, 7, {""} },
-    { "Maximum Number of Threads per Split Point", "5", "5", SPIN, 4, 8, {""} },
-    { "Threads", "1", "1", SPIN, 1, 8, {""} },
-    { "Hash", "32", "32", SPIN, 4, 4096, {""} },
-    { "Clear Hash", "false", "false", BUTTON, 0, 0, {""} },
-    { "Ponder", "true", "true", CHECK, 0, 0, {""} },
-    { "OwnBook", "true", "true", CHECK, 0, 0, {""} },
-    { "MultiPV", "1", "1", SPIN, 1, 500, {""} },
-    { "UCI_ShowCurrLine", "false", "false", CHECK, 0, 0, {""} },
-    { "UCI_Chess960", "false", "false", CHECK, 0, 0, {""} },
-    { "", "", "", OPTION_TYPE_NONE, 0, 0, {""}}
-  };
-    
-
-  ///
-  /// Functions
-  ///
-
-  Option *option_with_name(const char *optionName);
-
-}
-
-
-////
-//// Functions
-////
-
-/// init_uci_options() initializes the UCI options.  Currently, the only
-/// thing this function does is to initialize the default value of the
-/// "Threads" parameter to the number of available CPU cores.
-
-void init_uci_options() {
-  Option *o;
-
-  o = option_with_name("Threads");
-  assert(o != NULL);
+/// 'On change' actions, triggered by an option's value change
+void on_logger(const UCIOption& opt) { start_logger(opt); }
+void on_eval(const UCIOption&) { Eval::init(); }
+void on_threads(const UCIOption&) { Threads.read_uci_options(); }
+void on_hash_size(const UCIOption& opt) { TT.set_size(opt); }
+void on_clear_hash(const UCIOption&) { TT.clear(); }
 
-  // Limit the default value of "Threads" to 7 even if we have 8 CPU cores.
-  // According to Ken Dail's tests, Glaurung plays much better with 7 than
-  // with 8 threads.  This is weird, but it is probably difficult to find out
-  // why before I have a 8-core computer to experiment with myself.
-  sprintf(o->defaultValue, "%d", Min(cpu_count(), 7));
-  sprintf(o->currentValue, "%d", Min(cpu_count(), 7));
+/// Our case insensitive less() function as required by UCI protocol
+bool ci_less(char c1, char c2) { return tolower(c1) < tolower(c2); }
 
-  // Increase the minimum split depth when the number of CPUs is big.
-  // It would probably be better to let this depend on the number of threads
-  // instead.
-  o = option_with_name("Minimum Split Depth");
-  assert(o != NULL);
-  if(cpu_count() > 4) {
-    sprintf(o->defaultValue, "%d", 6);
-    sprintf(o->defaultValue, "%d", 6);
-  }
 }
 
-
-/// print_uci_options() prints all the UCI options to the standard output,
-/// in the format defined by the UCI protocol.
-
-void print_uci_options() {
-  static const char optionTypeName[][16] = {
-    "spin", "combo", "check", "string", "button"
-  };
-  for(Option *o = Options; o->type != OPTION_TYPE_NONE; o++) {
-    printf("option name %s type %s", o->name, optionTypeName[o->type]);
-    if(o->type != BUTTON) {
-      printf(" default %s", o->defaultValue);
-      if(o->type == SPIN)
-        printf(" min %d max %d", o->minValue, o->maxValue);
-      else if(o->type == COMBO)
-        for(int i = 0; strlen(o->comboValues[i]) > 0; i++)
-          printf(" var %s", o->comboValues[i]);
-    }
-    printf("\n");
-  }
+bool CaseInsensitiveLess::operator() (const string& s1, const string& s2) const {
+  return lexicographical_compare(s1.begin(), s1.end(), s2.begin(), s2.end(), ci_less);
 }
 
 
-/// get_option_value_bool() returns the current value of a UCI parameter of
-/// type "check".
-
-bool get_option_value_bool(const std::string &optionName) {
-  Option *o = option_with_name(optionName.c_str());
-  return o != NULL && strcmp(o->currentValue, "true") == 0;
+/// OptionsMap c'tor initializes the UCI options to their hard coded default
+/// values and initializes the default value of "Threads" and "Min Split Depth"
+/// parameters according to the number of CPU cores detected.
+
+OptionsMap::OptionsMap() {
+
+  int cpus = std::min(cpu_count(), MAX_THREADS);
+  int msd = cpus < 8 ? 4 : 7;
+  OptionsMap& o = *this;
+
+  o["Use Debug Log"]               = UCIOption(false, on_logger);
+  o["Use Search Log"]              = UCIOption(false);
+  o["Search Log Filename"]         = UCIOption("SearchLog.txt");
+  o["Book File"]                   = UCIOption("book.bin");
+  o["Best Book Move"]              = UCIOption(false);
+  o["Mobility (Middle Game)"]      = UCIOption(100, 0, 200, on_eval);
+  o["Mobility (Endgame)"]          = UCIOption(100, 0, 200, on_eval);
+  o["Passed Pawns (Middle Game)"]  = UCIOption(100, 0, 200, on_eval);
+  o["Passed Pawns (Endgame)"]      = UCIOption(100, 0, 200, on_eval);
+  o["Space"]                       = UCIOption(100, 0, 200, on_eval);
+  o["Aggressiveness"]              = UCIOption(100, 0, 200, on_eval);
+  o["Cowardice"]                   = UCIOption(100, 0, 200, on_eval);
+  o["Min Split Depth"]             = UCIOption(msd, 4, 7, on_threads);
+  o["Max Threads per Split Point"] = UCIOption(5, 4, 8, on_threads);
+  o["Threads"]                     = UCIOption(cpus, 1, MAX_THREADS);
+  o["Use Sleeping Threads"]        = UCIOption(true, on_threads);
+  o["Hash"]                        = UCIOption(32, 4, 8192, on_hash_size);
+  o["Clear Hash"]                  = UCIOption(on_clear_hash);
+  o["Ponder"]                      = UCIOption(true);
+  o["OwnBook"]                     = UCIOption(false);
+  o["MultiPV"]                     = UCIOption(1, 1, 500);
+  o["Skill Level"]                 = UCIOption(20, 0, 20);
+  o["Emergency Move Horizon"]      = UCIOption(40, 0, 50);
+  o["Emergency Base Time"]         = UCIOption(200, 0, 30000);
+  o["Emergency Move Time"]         = UCIOption(70, 0, 5000);
+  o["Minimum Thinking Time"]       = UCIOption(20, 0, 5000);
+  o["Slow Mover"]                  = UCIOption(100, 10, 1000);
+  o["UCI_Chess960"]                = UCIOption(false);
+  o["UCI_AnalyseMode"]             = UCIOption(false, on_eval);
 }
 
 
-/// get_option_value_int() returns the value of a UCI parameter as an integer.
-/// Normally, this function will be used for a parameter of type "spin", but
-/// it could also be used with a "combo" parameter, where all the available
-/// values are integers.
+/// operator<<() is used to output all the UCI options in chronological insertion
+/// order (the idx field) and in the format defined by the UCI protocol.
 
-int get_option_value_int(const std::string &optionName) {
-  Option *o = option_with_name(optionName.c_str());
-  return atoi(o->currentValue);
-}
+std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
+
+  for (size_t idx = 0; idx < om.size(); idx++)
+      for (OptionsMap::const_iterator it = om.begin(); it != om.end(); ++it)
+          if (it->second.idx == idx)
+          {
+              const UCIOption& o = it->second;
+              os << "\noption name " << it->first << " type " << o.type;
 
+              if (o.type != "button")
+                  os << " default " << o.defaultValue;
 
-/// get_option_value_string() returns the current value of a UCI parameter as
-/// a string.  It is used with parameters of type "combo" and "string".
+              if (o.type == "spin")
+                  os << " min " << o.min << " max " << o.max;
 
-const std::string get_option_value_string(const std::string &optionName) {
-  Option *o = option_with_name(optionName.c_str());
-  return o->currentValue;
+              break;
+          }
+  return os;
 }
 
 
-/// button_was_pressed() tests whether a UCI parameter of type "button" has
-/// been selected since the last time the function was called.
-
-bool button_was_pressed(const std::string &buttonName) {
-  if(get_option_value_bool(buttonName)) {
-    set_option_value(buttonName, "false");
-    return true;
-  }
-  else
-    return false;
-}
+/// UCIOption class c'tors
 
+UCIOption::UCIOption(const char* v, Fn* f) : type("string"), min(0), max(0), idx(Options.size()), on_change(f)
+{ defaultValue = currentValue = v; }
 
-/// set_option_value() inserts a new value for a UCI parameter.  Note that
-/// the function does not check that the new value is legal for the given
-/// parameter:  This is assumed to be the responsibility of the GUI.
+UCIOption::UCIOption(bool v, Fn* f) : type("check"), min(0), max(0), idx(Options.size()), on_change(f)
+{ defaultValue = currentValue = (v ? "true" : "false"); }
 
-void set_option_value(const std::string &optionName,
-                      const std::string &newValue) {
-  Option *o = option_with_name(optionName.c_str());
+UCIOption::UCIOption(Fn* f) : type("button"), min(0), max(0), idx(Options.size()), on_change(f)
+{}
 
-  if(o != NULL)
-    strcpy(o->currentValue, newValue.c_str());
-  else
-    std::cout << "No such option: " << optionName << std::endl;
-}
+UCIOption::UCIOption(int v, int minv, int maxv, Fn* f) : type("spin"), min(minv), max(maxv), idx(Options.size()), on_change(f)
+{ std::ostringstream ss; ss << v; defaultValue = currentValue = ss.str(); }
 
 
-/// push_button() is used to tell the engine that a UCI parameter of type
-/// "button" has been selected:
+/// UCIOption::operator=() updates currentValue. Normally it's up to the GUI to
+/// check for option's limits, but we could receive the new value directly from
+/// the user by console window, so let's check the bounds anyway.
 
-void push_button(const std::string &buttonName) {
-  set_option_value(buttonName, "true");
-}
+void UCIOption::operator=(const string& v) {
 
+  assert(!type.empty());
 
-namespace {
+  if (   (type == "button" || !v.empty())
+      && (type != "check"  || (v == "true" || v == "false"))
+      && (type != "spin"   || (atoi(v.c_str()) >= min && atoi(v.c_str()) <= max)))
+  {
+      if (type != "button")
+          currentValue = v;
 
-  // option_with_name() tries to find a UCI option with a given
-  // name.  It returns a pointer to the UCI option or the null pointer,
-  // depending on whether an option with the given name exists.
-  
-  Option *option_with_name(const char *optionName) {
-    for(Option *o = Options; o->type != OPTION_TYPE_NONE; o++)
-      if(strcmp(o->name, optionName) == 0)
-        return o;
-    return NULL;
+      if (on_change)
+          (*on_change)(*this);
   }
-
 }