Debug/logstream.hxx

   1 // Stream based logging mechanism.
   2 //
   3 // Written by Bernie Bright, 1998
   4 //
   5 // Copyright (C) 1998  Bernie Bright - bbright@c031.aone.net.au
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20 //
  21 // $Id$
  22 // (Log is kept at end of this file)
  23
  24 #ifndef _LOGSTREAM_H
  25 #define _LOGSTREAM_H
  26
  27 #ifdef HAVE_CONFIG_H
  28 #  include <config.h>
  29 #endif
  30
  31
  32 #include "Include/compiler.h"
  33
  34 #ifdef FG_HAVE_STD_INCLUDES
  35 # include <streambuf>
  36 # include <iostream>
  37 //# include <ostream>
  38 #else
  39 # include <iostream.h>
  40 # include "Include/fg_traits.hxx"
  41 #endif
  42
  43 #include "debug_types.h"
  44
  45 FG_USING_STD(streambuf);
  46 FG_USING_STD(ostream);
  47 FG_USING_STD(cerr);
  48 FG_USING_STD(endl);
  49
  50 //
  51 // TODO:
  52 //
  53 // 1. Change output destination. Done.
  54 // 2. Make logbuf thread safe.
  55 // 3. Read environment for default debugClass and debugPriority.
  56 //
  57
  58 //-----------------------------------------------------------------------------
  59 //
  60 // logbuf is an output-only streambuf with the ability to disable sets of
  61 // messages at runtime. Only messages with priority >= logbuf::logPriority
  62 // and debugClass == logbuf::logClass are output.
  63 //
  64 class logbuf : public streambuf
  65 {
  66 public:
  67
  68 #ifndef FG_HAVE_STD_INCLUDES
  69     typedef char_traits<char>           traits_type;
  70     typedef char_traits<char>::int_type int_type;
  71     typedef char_traits<char>::pos_type pos_type;
  72     typedef char_traits<char>::off_type off_type;
  73 #endif
  74 //     logbuf( streambuf* sb ) : sbuf(sb) {}
  75     logbuf();
  76     ~logbuf();
  77
  78     // Is logging enabled?
  79     bool enabled() { return logging_enabled; }
  80
  81     // Set the logging level of subsequent messages.
  82     void set_log_state( fgDebugClass c, fgDebugPriority p );
  83
  84     // Set the global logging level.
  85     static void set_log_level( fgDebugClass c, fgDebugPriority p );
  86
  87     //
  88     void set_sb( streambuf* sb );
  89
  90 protected:
  91
  92     inline virtual int sync();
  93     int_type overflow( int ch );
  94 //     int xsputn( const char* s, istreamsize n );
  95
  96 private:
  97
  98     // The streambuf used for actual output. Defaults to cerr.rdbuf().
  99     static streambuf* sbuf;
 100
 101     static bool logging_enabled;
 102     static fgDebugClass logClass;
 103     static fgDebugPriority logPriority;
 104
 105 private:
 106
 107     // Not defined.
 108     logbuf( const logbuf& );
 109     void operator= ( const logbuf& );
 110 };
 111
 112 inline int
 113 logbuf::sync()
 114 {
 115 #ifdef FG_HAVE_STD_INCLUDES
 116         return sbuf->pubsync();
 117 #else
 118         return sbuf->sync();
 119 #endif
 120 }
 121
 122 inline void
 123 logbuf::set_log_state( fgDebugClass c, fgDebugPriority p )
 124 {
 125     logging_enabled = ((c & logClass) != 0 && p >= logPriority);
 126 }
 127
 128 inline logbuf::int_type
 129 logbuf::overflow( int c )
 130 {
 131     return logging_enabled ? sbuf->sputc(c) : (EOF == 0 ? 1: 0);
 132 }
 133
 134 //-----------------------------------------------------------------------------
 135 //
 136 // logstream manipulator for setting the log level of a message.
 137 //
 138 struct loglevel
 139 {
 140     loglevel( fgDebugClass c, fgDebugPriority p )
 141         : logClass(c), logPriority(p) {}
 142
 143     fgDebugClass logClass;
 144     fgDebugPriority logPriority;
 145 };
 146
 147 //-----------------------------------------------------------------------------
 148 //
 149 // A helper class that ensures a streambuf and ostream are constructed and
 150 // destroyed in the correct order.  The streambuf must be created before the
 151 // ostream but bases are constructed before members.  Thus, making this class
 152 // a private base of logstream, declared to the left of ostream, we ensure the
 153 // correct order of construction and destruction.
 154 //
 155 struct logstream_base
 156 {
 157 //     logstream_base( streambuf* sb ) : lbuf(sb) {}
 158     logstream_base() {}
 159
 160     logbuf lbuf;
 161 };
 162
 163 //-----------------------------------------------------------------------------
 164 //
 165 //
 166 //
 167 class logstream : private logstream_base, public ostream
 168 {
 169 public:
 170     // The default is to send messages to cerr.
 171     logstream( ostream& out )
 172 //      : logstream_base(out.rdbuf()),
 173         : logstream_base(),
 174           ostream(&lbuf) { lbuf.set_sb(out.rdbuf());}
 175
 176     void set_output( ostream& out ) { lbuf.set_sb( out.rdbuf() ); }
 177
 178     // Set the global log class and priority level.
 179      void setLogLevels( fgDebugClass c, fgDebugPriority p );
 180
 181     // Output operator to capture the debug level and priority of a message.
 182     inline ostream& operator<< ( const loglevel& l );
 183 };
 184
 185 inline ostream&
 186 logstream::operator<< ( const loglevel& l )
 187 {
 188     lbuf.set_log_state( l.logClass, l.logPriority );
 189     return *this;
 190 }
 191
 192 //-----------------------------------------------------------------------------
 193 //
 194 // Return the one and only logstream instance.
 195 // We use a function instead of a global object so we are assured that cerr
 196 // has been initialised.
 197 //
 198 inline logstream&
 199 fglog()
 200 {
 201     static logstream logstrm( cerr );
 202     return logstrm;
 203 }
 204
 205 #ifdef FG_NDEBUG
 206 # define FG_LOG(C,P,M)
 207 #else
 208 # define FG_LOG(C,P,M) fglog() << loglevel(C,P) << M << endl
 209 #endif
 210
 211 #endif // _LOGSTREAM_H
 212
 213 // $Log$
 214 // Revision 1.3  1999/01/19 20:53:35  curt
 215 // Portability updates by Bernie Bright.
 216 //
 217 // Revision 1.2  1998/11/07 19:07:02  curt
 218 // Enable release builds using the --without-logging option to the configure
 219 // script.  Also a couple log message cleanups, plus some C to C++ comment
 220 // conversion.
 221 //
 222 // Revision 1.1  1998/11/06 21:20:42  curt
 223 // Initial revision.
 224 //