Add (smart) logging facility

By means of "Use Debug Log" UCI option it is possible to toggle
the logging of std::cout to file "out.txt" while preserving
the usual output to stdout. There is zero overhead when logging
is disabled and we achieved this without changing a single line
of exsisting code, in particular we still use std::cout as usual.

The idea and part of the code comes from this article:
http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81

No functional change.

Signed-off-by: Marco Costalba <mcostalba@gmail.com>

diff --git a/src/misc.cpp b/src/misc.cpp
index 8cfba7341fa7fe7256fdaafa440dc3140ae9dbcd..125115a4cd57f8dc33724291b49014f0ce014b56 100644 (file)
--- a/src/misc.cpp
+++ b/src/misc.cpp
@@ -39,6 +39,7 @@
 #include <iomanip>
 #include <iostream>
 #include <sstream>
+#include <streambuf>
 
 #include "misc.h"
 #include "thread.h"
@@ -105,6 +106,69 @@ void dbg_print() {
 }
 
 
+/// Our fancy logging facility. The trick here is to replace cout.rdbuf() with
+/// this one that sends the output both to console and to a file, this allow us
+/// to toggle the logging of std::cout to a file while preserving output to
+/// stdout and without changing a single line of code! Idea and code from:
+/// http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
+
+class Logger: public streambuf {
+public:
+  typedef char_traits<char> traits_type;
+  typedef traits_type::int_type int_type;
+
+  Logger() : cout_buf(cout.rdbuf()) {}
+  ~Logger() { set(false); }
+
+  void set(bool b) {
+
+    if (b && !file.is_open())
+    {
+        file.open("out.txt", ifstream::out | ifstream::app);
+        cout.rdbuf(this);
+    }
+    else if (!b && file.is_open())
+    {
+        cout.rdbuf(cout_buf);
+        file.close();
+    }
+  }
+
+private:
+  int_type overflow(int_type c) {
+
+    if (traits_type::eq_int_type(c, traits_type::eof()))
+        return traits_type::not_eof(c);
+
+    c = cout_buf->sputc(traits_type::to_char_type(c));
+
+    if (!traits_type::eq_int_type(c, traits_type::eof()))
+        c = file.rdbuf()->sputc(traits_type::to_char_type(c));
+
+    return c;
+  }
+
+  int sync() {
+
+    int c = cout_buf->pubsync();
+
+    if (c != -1)
+        c = file.rdbuf()->pubsync();
+
+    return c;
+  }
+
+  ofstream file;
+  streambuf* cout_buf;
+};
+
+void logger_set(bool b) {
+
+  static Logger l;
+  l.set(b);
+}
+
+
 /// cpu_count() tries to detect the number of CPU cores
 
 int cpu_count() {

diff --git a/src/misc.h b/src/misc.h
index 7c33211e884616de3b2cee5648a4b637c89f0540..ecec391ba72ac3d54d7fe0b40277b5bd376d8202 100644 (file)
--- a/src/misc.h
+++ b/src/misc.h
@@ -60,4 +60,6 @@ private:
   sys_time_t t;
 };
 
+extern void logger_set(bool b);
+
 #endif // !defined(MISC_H_INCLUDED)

diff --git a/src/ucioption.cpp b/src/ucioption.cpp
index 126726440fd22960a903c6d1e85f924e922abbe9..b4ed59dc2f33bdfe6582376aa0bfb9ec04216c7d 100644 (file)
--- a/src/ucioption.cpp
+++ b/src/ucioption.cpp
@@ -33,6 +33,7 @@ OptionsMap Options; // Global object
 namespace {
 
 /// 'On change' actions, triggered by an option's value change
+void on_logger(const UCIOption& o) { logger_set(o); }
 void on_eval(const UCIOption&) { Eval::init(); }
 void on_threads(const UCIOption&) { Threads.read_uci_options(); }
 void on_hash_size(const UCIOption& o) { TT.set_size(o); }
@@ -58,6 +59,7 @@ OptionsMap::OptionsMap() {
   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");