src/support/debugstream.h

   1 // -*- C++ -*-
   2 /**
   3  * \file debugstream.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef DEBUG_STREAM_HPP
  13 #define DEBUG_STREAM_HPP
  14
  15 #include <iostream>
  16
  17 #include <boost/version.hpp>
  18
  19
  20 //namespace lyx {
  21
  22 #if BOOST_VERSION < 103300
  23 #  include <boost/test/detail/nullstream.hpp>
  24 #else
  25 #  include <boost/test/utils/nullstream.hpp>
  26 #endif
  27
  28 #ifdef DEBUG
  29 # define TEMPORARY_DEBUG_MACRO DEBUG
  30 # undef DEBUG
  31 #endif
  32
  33 struct debug_trait {
  34         enum type {
  35                 NONE   = 0,
  36                 EMERG  = 1,
  37                 ALERT  = 2,
  38                 CRIT   = 3,
  39                 ERR    = 4,
  40                 WARN   = 5,
  41                 NOTICE = 6,
  42                 INFO   = 7,
  43                 DEBUG  = 8,
  44                 ANY = 0xffffff
  45         };
  46
  47         static bool match(type a, type b) {
  48                 return (b <= a || (b == ANY && a > NONE));
  49         }
  50 };
  51
  52 #ifdef TEMPORARY_DEBUG_MACRO
  53 # define DEBUG TEMPORARY_DEBUG_MACRO
  54 # undef TEMPORARY_DEBUG_MACRO
  55 #endif
  56
  57
  58 template <class dtrait,
  59           class charT = char,
  60           class traits = std::char_traits<charT> >
  61 class basic_debugstream : public std::basic_ostream<charT, traits> {
  62 public:
  63         typedef dtrait debug;
  64         typedef typename debug::type Type;
  65
  66         basic_debugstream()
  67                 : std::basic_ostream<charT, traits>(0), dt(debug::NONE)
  68         {}
  69
  70         /// Constructor, sets the debug level to t.
  71         explicit basic_debugstream(std::basic_streambuf<charT, traits> * buf)
  72                 : std::basic_ostream<charT, traits>(buf), dt(debug::NONE)
  73         {}
  74
  75         /// Sets the debug level to t.
  76         void level(Type t) {
  77                 dt = t;
  78         }
  79
  80         /// Returns the current debug level.
  81         Type level() const {
  82                 return dt;
  83         }
  84
  85         /// Returns true if t is part of the current debug level.
  86         bool debugging(Type t = debug::ANY) const
  87         {
  88                 if (debug::match(dt, t)) return true;
  89                 return false;
  90         }
  91
  92         /** Returns the no-op stream if t is not part of the
  93             current debug level otherwise the real debug stream
  94             is used.
  95             Use: dbgstream[Debug::INFO] << "Info!\n";
  96         */
  97         std::basic_ostream<charT, traits> & operator[](Type t) {
  98                 if (debug::match(dt, t))
  99                         return *this;
 100                 return nullstream;
 101         }
 102 private:
 103         /// The current debug level
 104         Type dt;
 105         /// The no-op stream.
 106         boost::basic_onullstream<charT, traits> nullstream;
 107 };
 108
 109 typedef basic_debugstream<debug_trait> debugstream;
 110
 111
 112 //} // namespace lyx
 113
 114 #endif