MsgService.h

Go to the documentation of this file.

// $Id: MsgService.h,v 1.29 2008/08/19 19:02:59 gmieg Exp $
//
// MsgService
//
// A class to create and provide access to various named, filtered, and
// formatted output streams
//
// messier@huhepl.harvard.edu
#ifndef MSGSERVICE_H
#define MSGSERVICE_H
#ifndef IOSFWD
#include <iosfwd>
#define IOSFWD
#endif
#ifndef MAP
#include <map>
#define MAP
#endif
#ifndef STRING
#define STRING
#include <string>
#endif
#ifndef STDEXCEPT
#define STDEXCEPT
#include <stdexcept>
#endif
#ifndef MSG_H
#include "MessageService/Msg.h"
#endif
#ifndef MSGSTREAM_H
#include "MessageService/MsgStream.h"
#endif
#ifndef MSGCATSTREAM_H
#include "MessageService/MsgCatStream.h"
#endif

using namespace std;

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

//......................................................................
class MsgService 
{
  friend std::ostream& operator<<(std::ostream& os, const MsgService& m);
public:
  ~MsgService();
  static MsgService* Instance();
  
  // Is this stream active at this level?
  bool IsActive(const char* str_name, Msg::LogLevel_t lvl) {
    if (lvl < fsGlobalLogLevel ) return false; // Is ANY stream active at this level?
    if (MsgStream* m = this->GetStream(str_name)) return m->IsActive(lvl);
    return false;
  }
  
  static void StackTrace(const char* stream, Msg::LogLevel_t lvl, int depth = 100, int ignore = 0);

  static void SetGlobalLevel(); // Resets the global level.

  void       AddCatStream(const char* fileName, 
                          const char* streamName, Msg::LogLevel_t lvl);
  MsgStream* GetStream(const char* name) {
    std::string msgName(name);
    MsgStream* m;
    if ((m = fMsgStreamTable[msgName])!=0) return m;
    return this->CreateStream(name);
  }
  void PrintStatistics();
  void PrintStatistics(std::ostream& os);

  void SetDefaultFormat(int fmt, int level=99); // 99=all levels

  void SetCurrentRunSnarl( int  run, int  snarl ) { fCurrentRun = run; fCurrentSnarl = snarl; };
  void GetCurrentRunSnarl( int& run, int& snarl ) { run = fCurrentRun; snarl = fCurrentSnarl; };

  void SetkFatalAbort(int abortflag = 1) {fkFatalAbort = abortflag;}
  int  GetkFatalAbort() {return fkFatalAbort;}


  // A helper class to handle begin/end initializations of the MsgService
  // This ensures that the message service outlives all of its clients
  class Init
  {
  public:
    static int count;
    Init()  { ++count; }
    ~Init() { if (--count==0) { delete fInstance; fInstance=0; } }
  };

private:
  // MsgService is a singleton
  MsgService();
  const char* GetTmpCatFileName(const char *streamName, int lvl);
  MsgStream*  CreateStream(const char* name);

private:  
  static MsgService *fInstance; // The sole instance of the message service
  
  Msg::LogLevel_t fDefaultLogLevel;                     // The log level
  char            fDefaultOStream[Msg::kNLogLevel][64]; // Default output
  int             fDefaultFormat[Msg::kNLogLevel];      // Default format
  std::map<std::string,MsgStream*> fMsgStreamTable;     // Streams
  std::vector<MsgCatStream>        fMsgCatList; // Streams to concatenate

  static Msg::LogLevel_t fsGlobalLogLevel; // The lowest log level currently on.
  int fCurrentRun;   // Current run number
  int fCurrentSnarl; // Current snarl number
  int fkFatalAbort;  // kFatal has set flag to abort job at opportunity
};

#ifdef MACOSX
static string __CVSID__ = "__CVSID__ undefined";

class SetMsgCVSID {
public:
  SetMsgCVSID(const char* cvsid) { __CVSID__ = cvsid; }
};
#endif

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

// This adds to the count of message servce clients - one per #include
static struct MsgService::Init __msginit;

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

// Utility macros:
// Macro to concatenate two symbols:
#define TOKCAT(x,y) x##y

// Macro to expand preprocessor variables and concatenate:
#define TOKCAT2(x,y) TOKCAT(x,y)

// Macro to concatenate source line with a symbol:
#define LINECAT(x) TOKCAT2(x, __LINE__ )

// Macros to simplify the use of the Message Service
#ifdef MACOSX
  #define CVSID(x) static SetMsgCVSID setmsgcvsid(x)
  #else
  #if (( __GNUC__ >= 3) && !(__CINT__))
    // This defines the variable in such a way that it doesn't generate compiler errors if unused.
    #define CVSID(x) static const char* __CVSID__  __attribute__ ((__unused__)) = x
  #else
    #define CVSID(x) static const char* __CVSID__ = x
  #endif
#endif

// MSG uses negative test so that so that this "if" 
// doesn't steal any trailing "else"'s
#ifdef MACOSX
#define MSG(s,l) \
if ( !MsgService::Instance()->IsActive(s,l) ) { ; } else \
   ((*(MsgService::Instance())->GetStream(s))(l,__FILE__,__CVSID__.c_str(),__LINE__))
#define MSGSTREAM(s,l) \
   ((*(MsgService::Instance())->GetStream(s))(l,__FILE__,__CVSID__.c_str(),__LINE__))
#else
#define MSG(s,l) \
if ( !MsgService::Instance()->IsActive(s,l) ) { ; } else \
   ((*(MsgService::Instance())->GetStream(s))(l,__FILE__,__CVSID__,__LINE__))
#define MSGSTREAM(s,l) \
   ((*(MsgService::Instance())->GetStream(s))(l,__FILE__,__CVSID__,__LINE__))
#endif

// MAXMSG can be used just like the MSG macro, but will print 
// it's output only c times.  The last time it prepends 
// "..Last Mesage.. " before the message.
// (Cunning preprocessor magic here allows multiple use in the same source file.)
// Added R1.4 by Nathaniel n.tagg1@physics.ox.ac.uk
//
// Note from bv: if you get compile time errors involving MSGCNT when
// using MAXMSG you probably are using a one line branch/loop like:
//
// if (foo) MAXMSG(...) << "bar\n";
//
// this runs afoul of the "cunning cpp magic".  To fix it you must put
// braces:
//
// if (foo) { MAXMSG(...) << "bar\n"; }
//
// This must be done in the code that uses MAXMSG, there's no way to
// fix it here.
#define MSG_ONLY_COUNT(s,l) \
if ( !MsgService::Instance()->IsActive(s,l) ) { ; } else \
   ((MsgService::Instance())->GetStream(s)->LogPrint(l,__FILE__))

#define MAXMSG(s,l,c)  \
  static int LINECAT(MSGCNT) =0; \
  const char* LINECAT(MSGADD) = (++LINECAT(MSGCNT)==c)?"..Last Message (counting continues).. ":""; \
  if(LINECAT(MSGCNT) > c || LINECAT(MSGCNT) < 0) {MSG_ONLY_COUNT(s,l);} else MSG(s,l) << LINECAT(MSGADD) 

#endif // MSGSERVICE_H

---