MsgStream.h

Go to the documentation of this file.

// $Id: MsgStream.h,v 1.25 2006/10/28 05:07:14 gmieg Exp $
//
// MsgStream
//
// Allows messages to be filtered, formatted and send to one or many
// output streams 
//
// messier@huhepl.harvard.edu
#ifndef MSGSTREAM_H
#define MSGSTREAM_H
#ifndef IOSFWD
#include <iosfwd>
#define IOSFWD
#endif
#ifndef IOSTREAM
#include <iostream> // Needed for __omanip and __manip and others
#define IOSTREAM
#endif
#ifndef IOMANIP
#include <iomanip> // Needed for smanip
#define IOMANIP
#endif
#ifndef VECTOR
#include <vector>
#define VECTOR
#endif
#ifndef MAP
#include <map>
#endif
#ifndef STRING
#define STRING
#include <string> // Needed for string << operator
#endif
#ifndef STDEXCEPT
#define STDEXCEPT
#include <stdexcept>
#endif
#ifndef MSG_H
#include "MessageService/Msg.h"
#endif
#ifndef MSGOSTREAM_H
#include "MessageService/MsgOStream.h"
#endif
#ifndef MSGSTATISTIC_H
#include "MessageService/MsgStatistic.h"
#endif

class MsgBoundFormat;
class MsgOStream;

using namespace std;

class MSGException : public std::runtime_error
{
 public:
  MSGException() : std::runtime_error("MSGException") {}
};

//......................................................................

class MsgStream
{
  friend ostream& operator<<(ostream& os, const MsgStream& s);
public:
  MsgStream();
  MsgStream(const char* name);

  bool            IsActive(Msg::LogLevel_t lvl) const { return lvl>=fLogLevel; }
  Msg::LogLevel_t GetLogLevel() const { return fLogLevel; };
  void            PrintStatistics(ostream& os);

  void AttachOStream(Msg::LogLevel_t lvl, const char *name);
  void DetachOStream(Msg::LogLevel_t lvl, const char *name);
  void Close();
  void Flush();
  void AddFormat(Msg::LogLevel_t lvl, int fmt);
  void RemoveFormat(Msg::LogLevel_t lvl, int fmt) { fFormat[lvl]&=(~fmt); }
  void SetLogLevel(Msg::LogLevel_t lvl);
  void SetFormat(Msg::LogLevel_t lvl, int fmt)    { fFormat[lvl] = fmt;   }

  MsgStream& operator()(Msg::LogLevel_t priority, const char* file, 
                        const char* cvsid, int line);
  void LogPrint(Msg::LogLevel_t priority, const char* file);

  //====================================================================
  // The set of << operators - basically these just loop over the
  // output streams attached to the message stream an use the <<
  // operator defined for that stream
  //
  // << operator for most normal classes
  template<class TP> MsgStream& operator<<(const TP& t) {
    if (fCurrentLogLevel >= fLogLevel) {
      vector<MsgOStream*>::iterator vend(fMsgOStream[fCurrentLogLevel].end());
      for (vector<MsgOStream*>::iterator 
             iter(fMsgOStream[fCurrentLogLevel].begin());
           iter != vend;
           ++iter) {
        (*iter)->Os() << t;
      }
    }
    return (*this);
  }

  // << operator for omanips...
  typedef std::ostream& (*__MSGomanip)(std::ostream&);
  MsgStream& operator<<(__MSGomanip func) {
    if (fCurrentLogLevel >= fLogLevel) {
      vector<MsgOStream*>::iterator vend(fMsgOStream[fCurrentLogLevel].end());
      for (vector<MsgOStream*>::iterator 
             iter(fMsgOStream[fCurrentLogLevel].begin());
           iter != vend;
           ++iter) {
        (*iter)->Os() << func;
      }
    }
    return (*this);
  }

  //====================================================================
  // Handle differences between gcc V3 and eariler versions here
  //====================================================================
#if ( __GNUC__ >= 3)
  // << operator for ios_base...
  typedef ios_base& (*__MSGios_base)(ios_base&);
  MsgStream& operator<<(__MSGios_base iosb) {
    if (fCurrentLogLevel >= fLogLevel) {
      vector<MsgOStream*>::iterator vend(fMsgOStream[fCurrentLogLevel].end());
      for (vector<MsgOStream*>::iterator
             iter = fMsgOStream[fCurrentLogLevel].begin();
           iter != vend;
           ++iter) {
        (*iter)->Os() << iosb;
      }
    }
    return (*this);
  }
#else // (__GNUC__ < 3)
  // << operator for manips...
  typedef ios& (*__MSGmanip)(ios&);
  MsgStream& operator<<(__MSGmanip func) {
    if (fCurrentLogLevel >= fLogLevel) {
      vector<MsgOStream*>::iterator vend(fMsgOStream[fCurrentLogLevel].end());
      for (vector<MsgOStream*>::iterator
             iter(fMsgOStream[fCurrentLogLevel].begin());
           iter != vend;
           ++iter) {
        (*iter)->Os() << func;
      }
    }
    return (*this);
  }
#endif // __GNUC__

private:
  void Init();
  void StatPrint(ostream& os, const char* label, int n) const;
  void SetCurrentDateString();
  void SetCVSVersion(const char* CVSId);

  enum { kMaxNameSize = 8 };
  char                fName[kMaxNameSize+1];        // Name of this MsgStream
  Msg::LogLevel_t     fLogLevel;                    // Threshold for print
  int                 fFormat[Msg::kNLogLevel];     // Formatting flags
  vector<MsgOStream*> fMsgOStream[Msg::kNLogLevel]; // Output streams
  map<string,MsgStatistic> fFileStat;          // Print stats by file name
  
  Msg::LogLevel_t fCurrentLogLevel; // The log level of messages being printed
  char fCurrentDate[32];            // Time stamp for current message
  char fCVSVersion[128];            // CVS version for current message
};




#endif // MSGSTREAM_H

---