From: Marco Costalba <mcostalba@gmail.com>
Date: Tue, 20 Mar 2012 13:40:09 +0000 (+0100)
Subject: Remove cruft from Logger class
X-Git-Url: https://git.sesse.net/?p=stockfish;a=commitdiff_plain;h=17d1940278aadde3d9d844f7c913ca6c8655bbf3

Remove cruft from Logger class

A big code simplification and cruft removing, make
Logger class a singleton and fully self conteined.
Also add direction indicators (">>" and "<<") to
better differentiate input and output lines in the
log file.

No functional change.

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

diff --git a/src/misc.cpp b/src/misc.cpp
index 0db22dd2..bdb2cc27 100644
--- a/src/misc.cpp
+++ b/src/misc.cpp
@@ -39,7 +39,6 @@
 #include <iomanip>
 #include <iostream>
 #include <sstream>
-#include <streambuf>
 
 #include "misc.h"
 #include "thread.h"
@@ -106,94 +105,60 @@ 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
+/// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
+/// cout.rdbuf() with this one that tees cin and cout to a file stream. We can
+/// toggle the logging of std::cout and std:cin at runtime while preserving i/o
+/// functionality and without changing a single line of code!
+/// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
 
-class Tee: public streambuf {
-public:
-  typedef char_traits<char> traits_type;
-  typedef traits_type::int_type int_type;
-
-  Tee(ios& s, ofstream& f) : stream(s), file(f), stream_buf(s.rdbuf()) {}
-  ~Tee() { set(false); }
-
-  void set(bool b) { stream.rdbuf(b ? this : stream_buf); }
-
-private:
-  int_type overflow(int_type c) {
-
-    if (traits_type::eq_int_type(c, traits_type::eof()))
-        return traits_type::not_eof(c);
-
-    c = stream_buf->sputc(traits_type::to_char_type(c));
+class Logger: public streambuf {
 
-    if (!traits_type::eq_int_type(c, traits_type::eof()))
-        c = file.rdbuf()->sputc(traits_type::to_char_type(c));
+  Logger() : cinbuf(cin.rdbuf()), coutbuf(cout.rdbuf()) {}
+  ~Logger() { start(false); }
 
-    return c;
-  }
-
-  int sync() {
-
-    int c = stream_buf->pubsync();
+public:
+  static void start(bool b) {
 
-    if (c != -1)
-        c = file.rdbuf()->pubsync();
+    static Logger l;
 
-    return c;
+    if (b && !l.file.is_open())
+    {
+        l.file.open("io_log.txt", ifstream::out | ifstream::app);
+        cin.rdbuf(&l);
+        cout.rdbuf(&l);
+    }
+    else if (!b && l.file.is_open())
+    {
+        cout.rdbuf(l.coutbuf);
+        cin.rdbuf(l.cinbuf);
+        l.file.close();
+    }
   }
 
-  int underflow() { return traits_type::not_eof(stream_buf->sgetc()); }
-
-  int uflow() {
-
-      int c = stream_buf->sbumpc();
-
-      if (!traits_type::eq_int_type(c, traits_type::eof()))
-          file.rdbuf()->sputc(traits_type::to_char_type(c));
-
-      return traits_type::not_eof(c);
-  }
+private:
+  int sync() { return file.rdbuf()->pubsync(), coutbuf->pubsync(); }
+  int overflow(int c) { return log(coutbuf->sputc((char)c), "<< ") ; }
+  int underflow() { return cinbuf->sgetc(); }
+  int uflow() { return log(cinbuf->sbumpc(), ">> "); }
 
-  ios& stream;
-  ofstream& file;
-  streambuf* stream_buf;
-};
+  int log(int c, const char* prefix) {
 
-class Logger {
-public:
-   Logger() : in(cin, file), out(cout, file) {}
-  ~Logger() { set(false); }
+    static int last = '\n';
 
-  void set(bool b) {
+    if (last == '\n')
+        file.rdbuf()->sputn(prefix, 3);
 
-    if (b && !file.is_open())
-    {
-        file.open("io_log.txt", ifstream::out | ifstream::app);
-        in.set(true);
-        out.set(true);
-    }
-    else if (!b && file.is_open())
-    {
-        out.set(false);
-        in.set(false);
-        file.close();
-    }
+    return last = file.rdbuf()->sputc((char)c);
   }
 
 private:
-  Tee in, out;
   ofstream file;
+  streambuf *cinbuf, *coutbuf;
 };
 
-void logger_set(bool b) {
 
-  static Logger l;
-  l.set(b);
-}
+/// Trampoline helper to avoid moving Logger to misc.h header
+void start_logger(bool b) { Logger::start(b); }
 
 
 /// cpu_count() tries to detect the number of CPU cores
diff --git a/src/misc.h b/src/misc.h
index ecec391b..f37fd5ef 100644
--- a/src/misc.h
+++ b/src/misc.h
@@ -60,6 +60,6 @@ private:
   sys_time_t t;
 };
 
-extern void logger_set(bool b);
+extern void start_logger(bool b);
 
 #endif // !defined(MISC_H_INCLUDED)
diff --git a/src/ucioption.cpp b/src/ucioption.cpp
index 03946e8b..df73670b 100644
--- a/src/ucioption.cpp
+++ b/src/ucioption.cpp
@@ -33,7 +33,7 @@ OptionsMap Options; // Global object
 namespace {
 
 /// 'On change' actions, triggered by an option's value change
-void on_logger(const UCIOption& opt) { logger_set(opt); }
+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); }