TGo4Log.h

Go to the documentation of this file.

// $Id: TGo4Log.h 1879 2016-04-04 17:10:38Z linev $
//-----------------------------------------------------------------------
//       The GSI Online Offline Object Oriented (Go4) Project
//         Experiment Data Processing at EE department, GSI
//-----------------------------------------------------------------------
// Copyright (C) 2000- GSI Helmholtzzentrum für Schwerionenforschung GmbH
//                     Planckstr. 1, 64291 Darmstadt, Germany
// Contact:            http://go4.gsi.de
//-----------------------------------------------------------------------
// This software can be used under the license agreements as stated
// in Go4License.txt file which is part of the distribution.
//-----------------------------------------------------------------------

#ifndef TGO4LOG_H
#define TGO4LOG_H

#include "TString.h"
#include "RVersion.h"

class TMutex;
class TLogTimer;

#define __MESSAGETEXTLENGTH__ 1024

// define previous trace macro void
#define GO4TRACE(X) ;

#if ROOT_VERSION_CODE < ROOT_VERSION(5,99,0)
// one need to remove TRACE macro when using ROOT v 6
#define TRACE(X) ;
#endif

// optional definitions
#define GO4MESSAGE( X ) TGo4Log::Message X;
#define GO4INFO(X) TGo4Log::Info X ;
#define GO4WARN(X) TGo4Log::Warn X ;
#define GO4ERROR(X) TGo4Log::Error X ;

#ifdef __CINT__
class TGo4Log {
#else
#ifdef GO4_EXPORT
class __declspec(dllimport) TGo4Log {
#else
class TGo4Log {
#endif
#endif

   public:
      static TGo4Log *Instance();

      static const char* GO4SYS();

      static const char* GO4INCPATH();

      static TString subGO4SYS(const char* subdir);

      static void SetIgnoreLevel(Int_t level);

      static Int_t GetIgnoreLevel();

      static void OutputEnable(Bool_t on=kTRUE);

      static Bool_t IsOutputEnabled();

      static void LogfileEnable(Bool_t on=kTRUE);

      static Bool_t IsLogfileEnabled();

      static void AutoEnable(Bool_t on=kTRUE);

      static Bool_t IsAutoEnabled();

      static void OpenLogfile(const char* name=0,
            const char* headercomment=0,
            Bool_t appendmode=kFALSE);

      static void CloseLogfile();

      static const char* GetLogname();

      static const char* Message(Int_t prio, const char* text,...);

      static void Debug(const char* text,...);

      static void Info(const char* text,...);

      static void Warn(const char* text,...);

      static void Error(const char* text,...);

      static void Printf(Bool_t _stdout, const char* text);

      static void WriteLogfile(const char* text, Bool_t withtime=kTRUE);

      static void set_trace_level(int) {}

      static void SetTracePriority(int) {}

      static void StartTracing() { Instance(); SetIgnoreLevel(0); }

      static void StopTracing() { Instance(); SetIgnoreLevel(1); }

      static const char* GetDefaultLogname();

      static const char* GetPrintfArg(Int_t type_id);

      static const char* fgcLEFT; 

      static const char* fgcRIGHT;

      static const char* fgcDEBUG; 

      static const char* fgcINFO; 

      static const char* fgcWARN;

      static const char* fgcERR; 

      static const char* fgcDEFAULTLOG; 

      enum { fguMESLEN = __MESSAGETEXTLENGTH__ };

      virtual ~TGo4Log();

      static void SetSniffer(TNamed* sniff);

      static void EnableRedirection();

   private:

      friend class TLogTimer;

      TGo4Log();

      static void ProcessRedirection(int kind = 0);

      static TGo4Log* fgxInstance; 

      static TMutex* fgxMutex; 

      static Int_t fgiIgnoreLevel;  

      static Bool_t fgbOutputEnabled;   

      static Bool_t fgbLogfileEnabled;   

      static Bool_t fgbAutoMode;    

      static char fgcMessagetext[__MESSAGETEXTLENGTH__]; 

      static void* fgxLogfile;   

      static TString fgxLogName;    

      static TString fgsGO4SYS; 

      static TNamed* fgSniffer; 

      static int fgStdPipe[2]; 
      static int fgStdSave; 

      static TLogTimer* fgTimer;  

   ClassDef(TGo4Log,1)
};

/* for backward compatibility in user code: */
typedef TGo4Log TGo4Trace;

#endif //TGO4LOG_H