[u/mrichter/AliRoot.git] / STEER / AliLog.h

#ifndef ALILOG_H
#define ALILOG_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id$ */

#include <TClass.h>
#include <TObjArray.h>
#include <TObject.h>
#include <TString.h>

// deprecation macro
#if defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
#define ALIROOT_DEPRECATED(func) func  __attribute__ ((deprecated))
#elif defined(_MSC_VER) && _MSC_VER >= 1300
#define ALIROOT_DEPRECATED(func) __declspec(deprecated) func
# else
#define ALIROOT_DEPRECATED(func) func
#endif

/**
 * class for logging debug, info and error messages
 */
class AliLog: public TObject
{
 public:

		// Log4j log levels: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
  enum EType_t {kFatal = 0, kError, kWarning, kInfo, kDebug, kMaxType};
  typedef void (*AliLogNotification)(EType_t type, const char* message );

		// NB: singleton constructor & destructor should not be public!
		// ALIROOT_DEPRECATED(AliLog());
		// ALIROOT_DEPRECATED(virtual ~AliLog());

		// NB: singleton deprecated static instance method
		// ALIROOT_DEPRECATED(static AliLog* Instance() {return fgInstance;};)

		// get root logger singleton instance
		static AliLog *GetRootLogger();

		// delete root logger singleton instance
		static void DeleteRootLogger();

		// NB: the following functions should not be static
		// NB: deprecated: logging configuration should be made through to a configuration file
  static void  EnableDebug(Bool_t enabled);
  static void  SetGlobalLogLevel(EType_t type);
  static Int_t GetGlobalLogLevel();
  static void  SetGlobalDebugLevel(Int_t level);
  static Int_t GetGlobalDebugLevel();
  static void  SetModuleDebugLevel(const char* module, Int_t level);
  static void  ClearModuleDebugLevel(const char* module);
  static void  SetClassDebugLevel(const char* className, Int_t level);
  static void  ClearClassDebugLevel(const char* className);

  static void  SetStandardOutput();
  static void  SetStandardOutput(EType_t type);
  static void  SetErrorOutput();
  static void  SetErrorOutput(EType_t type);
  static void  SetFileOutput(const char* fileName);
  static void  SetFileOutput(EType_t type, const char* fileName);
  static void  SetStreamOutput(ostream* stream);
  static void  SetStreamOutput(EType_t type, ostream* stream);
  static void  SetLogNotification(AliLogNotification pCallBack);
  static void  SetLogNotification(EType_t type, AliLogNotification pCallBack);
  static void  Flush();

  static void  SetHandleRootMessages(Bool_t on);

  static void  SetPrintType(Bool_t on);
  static void  SetPrintType(EType_t type, Bool_t on);
  static void  SetPrintModule(Bool_t on);
  static void  SetPrintModule(EType_t type, Bool_t on);
  static void  SetPrintScope(Bool_t on);
  static void  SetPrintScope(EType_t type, Bool_t on);
  static void  SetPrintLocation(Bool_t on);
  static void  SetPrintLocation(EType_t type, Bool_t on);

  static void  SetPrintRepetitions(Bool_t on);

  static void  WriteToFile(const char* name, Int_t option = 0);

  // the following public methods are used by the preprocessor macros 
  // and should not be called directly
  static Bool_t IsDebugEnabled() {return fgDebugEnabled;}
  static Int_t GetDebugLevel(const char* module, const char* className);
  static void  Message(UInt_t level, const char* message, 
                       const char* module, const char* className,
                       const char* function, const char* file, Int_t line);
  static void  Debug(UInt_t level, const char* message, 
                     const char* module, const char* className,
                     const char* function, const char* file, Int_t line);

  static Int_t RedirectStdoutTo(EType_t type, UInt_t level, const char* module, 
                                const char* className, const char* function,
                                const char* file, Int_t line, Bool_t print);
  static Int_t RedirectStderrTo(EType_t type, UInt_t level, const char* module, 
                                const char* className, const char* function,
                                const char* file, Int_t line, Bool_t print);
  static void  RestoreStdout(Int_t original);
  static void  RestoreStderr(Int_t original);

  static ostream& Stream(EType_t type, UInt_t level,
                         const char* module, const char* className,
                         const char* function, const char* file, Int_t line);

 private:

		// constructor is made private for implementing a singleton
		AliLog();
		virtual ~AliLog();

		// NOT IMPLEMENTED?
  AliLog(const AliLog& log);
  AliLog& operator = (const AliLog& log);

  void           ReadEnvSettings();

  static void    RootErrorHandler(Int_t level, Bool_t abort, 
				  const char* location, const char* message);

  void           CloseFile(Int_t type);
  FILE*          GetOutputStream(Int_t type);

  UInt_t         GetLogLevel(const char* module, const char* className) const;
  void           PrintMessage(UInt_t type, const char* message, 
                              const char* module, const char* className,
                              const char* function, 
                              const char* file, Int_t line);

  void           PrintString(Int_t type, FILE* stream, const char* format, ...);
  void           PrintRepetitions();

  Int_t          RedirectTo(FILE* stream, EType_t type, UInt_t level,
                            const char* module, const char* className,
                            const char* function,
                            const char* file, Int_t line, Bool_t print);

  ostream&       GetStream(EType_t type, UInt_t level,
                           const char* module, const char* className,
                           const char* function, const char* file, Int_t line);

  enum {kDebugOffset = kDebug-1};

  static AliLog* fgInstance;                 //! pointer to current instance
  static Bool_t  fgDebugEnabled;             // flag for debug en-/disabling

  UInt_t         fGlobalLogLevel;            // global logging level
  TObjArray      fModuleDebugLevels;         // debug levels for modules
  TObjArray      fClassDebugLevels;          // debug levels for classes

  Int_t          fOutputTypes[kMaxType];     // types of output streams
  TString        fFileNames[kMaxType];       // file names
  FILE*          fOutputFiles[kMaxType];     //! log output files
  ostream*       fOutputStreams[kMaxType];   //! log output streams

  Bool_t         fPrintType[kMaxType];       // print type on/off
  Bool_t         fPrintModule[kMaxType];     // print module on/off
  Bool_t         fPrintScope[kMaxType];      // print scope/class name on/off
  Bool_t         fPrintLocation[kMaxType];   // print file and line on/off

  Bool_t         fPrintRepetitions;          // print number of repetitions instead of repeated message on/off

  Int_t          fRepetitions;               //! counter of repetitions
  UInt_t         fLastType;                  //! type of last message
  TString        fLastMessage;               //! last message
  TString        fLastModule;                //! module name of last message
  TString        fLastClassName;             //! class name of last message
  TString        fLastFunction;              //! function name of last message
  TString        fLastFile;                  //! file name of last message
  Int_t          fLastLine;                  //! line number of last message
  AliLogNotification fCallBacks[kMaxType];   //! external notification callback

  ClassDef(AliLog, 1)   // class for logging debug, info and error messages
};


// module name macro
#ifdef _MODULE_
#define MODULENAME() _MODULE_
#else
#define MODULENAME() "NoModule"
#endif

// function name macro
#if defined(__GNUC__) || defined(__ICC) || defined(__ECC) || defined(__APPLE__)
#define FUNCTIONNAME() __FUNCTION__
// #elif defined(__HP_aCC) || defined(__alpha) || defined(__DECCXX)
// #define FUNCTIONNAME() __FUNC__
#else
#define FUNCTIONNAME() "???"
#endif

// redirection
#define REDIRECTSTDOUT(type, level, scope, whatever) {Int_t originalStdout = AliLog::RedirectStdoutTo(type, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__, kFALSE); whatever; AliLog::RestoreStdout(originalStdout);}
#define REDIRECTSTDERR(type, level, scope, whatever) {Int_t originalStderr = AliLog::RedirectStderrTo(type, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__, kFALSE); whatever; AliLog::RestoreStderr(originalStderr);}
#define REDIRECTSTDOUTANDSTDERR(type, level, scope, whatever) {Int_t originalStdout = AliLog::RedirectStdoutTo(type, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__, kFALSE); Int_t originalStderr = AliLog::RedirectStderrTo(type, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__, kFALSE); whatever; AliLog::RestoreStderr(originalStderr); AliLog::RestoreStdout(originalStdout);}


// debug level
#ifdef LOG_NO_DEBUG
#define AliDebugLevel() -1
#define AliDebugLevelClass() -1
#define AliDebugLevelGeneral(scope) -1
#else
#define AliDebugLevel() ((AliLog::IsDebugEnabled()) ? AliLog::GetDebugLevel(MODULENAME(), ClassName()) : -1)
#define AliDebugLevelClass() ((AliLog::IsDebugEnabled()) ? AliLog::GetDebugLevel(MODULENAME(), Class()->GetName()) : -1)
#define AliDebugLevelGeneral(scope) ((AliLog::IsDebugEnabled()) ? AliLog::GetDebugLevel(MODULENAME(), scope) : -1)
#endif

// debug messages
#ifdef LOG_NO_DEBUG
#define AliDebug(level, message)
#define AliDebugClass(level, message)
#define AliDebugGeneral(scope, level, message)
#else

// inspired by log4cxx code (see log4cxx/Logger.h)
// implements GCC branch prediction for increasing logging performance
#if !defined(ALIROOT_UNLIKELY)
#if defined(__GNUC__) && (__GNUC__ >= 3)
/**
Provides optimization hint to the compiler
to optimize for the expression being false.
@param expr boolean expression.
@returns value of expression.
*/
#define ALIROOT_UNLIKELY(expr) __builtin_expect(expr, 0)
#else
/**
Provides optimization hint to the compiler
to optimize for the expression being false.
@param expr boolean expression.
@returns value of expression.
**/
#define ALIROOT_UNLIKELY(expr) expr
#endif
#endif 

/**
Logs a message to a specified logger with the DEBUG level.

@param logLevel the debug level.
@param message message to print in the following format: Form(message).
    Note, that message should contain balanced parenthesis, like 
    <code>AliDebug(1, Form("Failed to decode line %d of %s", line, filename));</code> 
*/
#define AliDebug(logLevel, message) \
        do { if (ALIROOT_UNLIKELY(AliLog::IsDebugEnabled() && AliLog::GetDebugLevel(MODULENAME(), ClassName()) >= logLevel)) {\
	  AliLog::Debug(logLevel, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__); }} while (0)

/**
Logs a message to a specified logger with the DEBUG level.

@param logLevel the debug level.
@param message message to print in the following format: Form(message).
    Note, that message should contain balanced parenthesis, like 
    <code>AliDebug(1, Form("Failed to decode line %d of %s", line, filename));</code> 
*/
#define AliDebugClass(logLevel, message) \
	do { if (ALIROOT_UNLIKELY(AliLog::IsDebugEnabled() && AliLog::GetDebugLevel(MODULENAME(), Class()->GetName()) >= logLevel)) {\
	  AliLog::Debug(logLevel, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__); }} while (0)

/**
Logs a message to a specified logger with the DEBUG level.

@param scope the logging scope.
@param logLevel the debug level.
@param message message to print in the following format: Form(message).
    Note, that message should contain balanced parenthesis, like 
    <code>AliDebug(1, Form("Failed to decode line %d of %s", line, filename));</code> 
*/
#define AliDebugGeneral(scope, logLevel, message) \
	do { if (ALIROOT_UNLIKELY(AliLog::IsDebugEnabled() && AliLog::GetDebugLevel(MODULENAME(), scope) >= logLevel)) {\
	  AliLog::Debug(logLevel, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__); }} while (0)

#endif

// redirection to debug
#define StdoutToAliDebug(level, whatever) REDIRECTSTDOUT(AliLog::kDebug, level, ClassName(), whatever)
#define StderrToAliDebug(level, whatever) REDIRECTSTDERR(AliLog::kDebug, level, ClassName(), whatever)
#define ToAliDebug(level, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kDebug, level, ClassName(), whatever)
#define StdoutToAliDebugClass(level, whatever) REDIRECTSTDOUT(AliLog::kDebug, level, Class()->GetName(), whatever)
#define StderrToAliDebugClass(level, whatever) REDIRECTSTDERR(AliLog::kDebug, level, Class()->GetName(), whatever)
#define ToAliDebugClass(level, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kDebug, level, Class()->GetName(), whatever)
#define StdoutToAliDebugGeneral(scope, level, whatever) REDIRECTSTDOUT(AliLog::kDebug, level, scope, whatever)
#define StderrToAliDebugGeneral(scope, level, whatever) REDIRECTSTDERR(AliLog::kDebug, level, scope, whatever)
#define ToAliDebugGeneral(scope, level, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kDebug, level, scope, whatever)

// debug stream objects
#define AliDebugStream(level) AliLog::Stream(AliLog::kDebug, level, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__)
#define AliDebugClassStream(level) AliLog::Stream(AliLog::kDebug, level, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__)
#define AliDebugGeneralStream(scope, level) AliLog::Stream(AliLog::kDebug, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__)


// info messages
#ifdef LOG_NO_INFO
#define AliInfo(message)
#define AliInfoClass(message)
#define AliInfoGeneral(scope, message)
#else
#define AliInfo(message) {AliLog::Message(AliLog::kInfo, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__);}
#define AliInfoClass(message) {AliLog::Message(AliLog::kInfo, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__);}
#define AliInfoGeneral(scope, message) {AliLog::Message(AliLog::kInfo, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__);}
#endif

// redirection to info
#define StdoutToAliInfo(whatever) REDIRECTSTDOUT(AliLog::kInfo, 0, ClassName(), whatever)
#define StderrToAliInfo(whatever) REDIRECTSTDERR(AliLog::kInfo, 0, ClassName(), whatever)
#define ToAliInfo(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kInfo, 0, ClassName(), whatever)
#define StdoutToAliInfoClass(whatever) REDIRECTSTDOUT(AliLog::kInfo, 0, Class()->GetName(), whatever)
#define StderrToAliInfoClass(whatever) REDIRECTSTDERR(AliLog::kInfo, 0, Class()->GetName(), whatever)
#define ToAliInfoClass(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kInfo, 0, Class()->GetName(), whatever)
#define StdoutToAliInfoGeneral(scope, whatever) REDIRECTSTDOUT(AliLog::kInfo, 0, scope, whatever)
#define StderrToAliInfoGeneral(scope, whatever) REDIRECTSTDERR(AliLog::kInfo, 0, scope, whatever)
#define ToAliInfoGeneral(scope, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kInfo, 0, scope, whatever)

// info stream objects
#define AliInfoStream() AliLog::Stream(AliLog::kInfo, 0, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__)
#define AliInfoClassStream() AliLog::Stream(AliLog::kInfo, 0, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__)
#define AliInfoGeneralStream(scope) AliLog::Stream(AliLog::kInfo, 0, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__)

// warning messages
#ifdef LOG_NO_WARNING
#define AliWarning(message)
#define AliWarningClass(message)
#define AliWarningGeneral(scope, message)
#else
#define AliWarning(message) {AliLog::Message(AliLog::kWarning, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__);}
#define AliWarningClass(message) {AliLog::Message(AliLog::kWarning, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__);}
#define AliWarningGeneral(scope, message) {AliLog::Message(AliLog::kWarning, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__);}
#endif

// redirection to warning
#define StdoutToAliWarning(whatever) REDIRECTSTDOUT(AliLog::kWarning, 0, ClassName(), whatever)
#define StderrToAliWarning(whatever) REDIRECTSTDERR(AliLog::kWarning, 0, ClassName(), whatever)
#define ToAliWarning(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kWarning, 0, ClassName(), whatever)
#define StdoutToAliWarningClass(whatever) REDIRECTSTDOUT(AliLog::kWarning, 0, Class()->GetName(), whatever)
#define StderrToAliWarningClass(whatever) REDIRECTSTDERR(AliLog::kWarning, 0, Class()->GetName(), whatever)
#define ToAliWarningClass(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kWarning, 0, Class()->GetName(), whatever)
#define StdoutToAliWarningGeneral(scope, whatever) REDIRECTSTDOUT(AliLog::kWarning, 0, scope, whatever)
#define StderrToAliWarningGeneral(scope, whatever) REDIRECTSTDERR(AliLog::kWarning, 0, scope, whatever)
#define ToAliWarningGeneral(scope, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kWarning, 0, scope, whatever)

// warning stream objects
#define AliWarningStream() AliLog::Stream(AliLog::kWarning, 0, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__)
#define AliWarningClassStream() AliLog::Stream(AliLog::kWarning, 0, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__)
#define AliWarningGeneralStream(scope) AliLog::Stream(AliLog::kWarning, 0, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__)


// error messages
#define AliError(message) {AliLog::Message(AliLog::kError, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__);}
#define AliErrorClass(message) {AliLog::Message(AliLog::kError, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__);}
#define AliErrorGeneral(scope, message) {AliLog::Message(AliLog::kError, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__);}

// redirection to error
#define StdoutToAliError(whatever) REDIRECTSTDOUT(AliLog::kError, 0, ClassName(), whatever)
#define StderrToAliError(whatever) REDIRECTSTDERR(AliLog::kError, 0, ClassName(), whatever)
#define ToAliError(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kError, 0, ClassName(), whatever)
#define StdoutToAliErrorClass(whatever) REDIRECTSTDOUT(AliLog::kError, 0, Class()->GetName(), whatever)
#define StderrToAliErrorClass(whatever) REDIRECTSTDERR(AliLog::kError, 0, Class()->GetName(), whatever)
#define ToAliErrorClass(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kError, 0, Class()->GetName(), whatever)
#define StdoutToAliErrorGeneral(scope, whatever) REDIRECTSTDOUT(AliLog::kError, 0, scope, whatever)
#define StderrToAliErrorGeneral(scope, whatever) REDIRECTSTDERR(AliLog::kError, 0, scope, whatever)
#define ToAliErrorGeneral(scope, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kError, 0, scope, whatever)

// error stream objects
#define AliErrorStream() AliLog::Stream(AliLog::kError, 0, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__)
#define AliErrorClassStream() AliLog::Stream(AliLog::kError, 0, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__)
#define AliErrorGeneralStream(scope) AliLog::Stream(AliLog::kError, 0, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__)


// fatal messages
#define AliFatal(message) {AliLog::Message(AliLog::kFatal, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__);}
#define AliFatalClass(message) {AliLog::Message(AliLog::kFatal, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__);}
#define AliFatalGeneral(scope, message) {AliLog::Message(AliLog::kFatal, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__);}

#endif
Commit	Line	Data
6ab674bd	1	#ifndef ALILOG_H
	2	#define ALILOG_H
	3	/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
	4	* See cxx source for full Copyright notice */
	5
	6	/* $Id$ */
	7
5a9a01d4	8	#include <TClass.h>
6ab674bd	9	#include <TObjArray.h>
5a9a01d4	10	#include <TObject.h>
6ab674bd	11	#include <TString.h>
6ab674bd	12
6d7793cf	13	// deprecation macro
	14	#if defined(__GNUC__) && (__GNUC__ > 3 \|\| (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
	15	#define ALIROOT_DEPRECATED(func) func __attribute__ ((deprecated))
	16	#elif defined(_MSC_VER) && _MSC_VER >= 1300
	17	#define ALIROOT_DEPRECATED(func) __declspec(deprecated) func
	18	# else
	19	#define ALIROOT_DEPRECATED(func) func
	20	#endif
6ab674bd	21
6d7793cf	22	/**
	23	* class for logging debug, info and error messages
	24	*/
	25	class AliLog: public TObject
	26	{
6ab674bd	27	public:
6ab674bd	28
6d7793cf	29	// Log4j log levels: TRACE, DEBUG, INFO, WARN, ERROR, FATAL
44ce6bbe	30	enum EType_t {kFatal = 0, kError, kWarning, kInfo, kDebug, kMaxType};
1948744e	31	typedef void (AliLogNotification)(EType_t type, const char message );
1948744e	32
6d7793cf	33	// NB: singleton constructor & destructor should not be public!
	34	// ALIROOT_DEPRECATED(AliLog());
	35	// ALIROOT_DEPRECATED(virtual ~AliLog());
	36
	37	// NB: singleton deprecated static instance method
	38	// ALIROOT_DEPRECATED(static AliLog* Instance() {return fgInstance;};)
	39
	40	// get root logger singleton instance
	41	static AliLog *GetRootLogger();
6ab674bd	42
6d7793cf	43	// delete root logger singleton instance
	44	static void DeleteRootLogger();
	45
	46	// NB: the following functions should not be static
	47	// NB: deprecated: logging configuration should be made through to a configuration file
6ab674bd	48	static void EnableDebug(Bool_t enabled);
44ce6bbe	49	static void SetGlobalLogLevel(EType_t type);
6ab674bd	50	static Int_t GetGlobalLogLevel();
	51	static void SetGlobalDebugLevel(Int_t level);
	52	static Int_t GetGlobalDebugLevel();
	53	static void SetModuleDebugLevel(const char* module, Int_t level);
	54	static void ClearModuleDebugLevel(const char* module);
	55	static void SetClassDebugLevel(const char* className, Int_t level);
	56	static void ClearClassDebugLevel(const char* className);
	57
	58	static void SetStandardOutput();
44ce6bbe	59	static void SetStandardOutput(EType_t type);
6ab674bd	60	static void SetErrorOutput();
44ce6bbe	61	static void SetErrorOutput(EType_t type);
6ab674bd	62	static void SetFileOutput(const char* fileName);
44ce6bbe	63	static void SetFileOutput(EType_t type, const char* fileName);
1948744e	64	static void SetStreamOutput(ostream* stream);
	65	static void SetStreamOutput(EType_t type, ostream* stream);
	66	static void SetLogNotification(AliLogNotification pCallBack);
	67	static void SetLogNotification(EType_t type, AliLogNotification pCallBack);
6ab674bd	68	static void Flush();
	69
	70	static void SetHandleRootMessages(Bool_t on);
	71
	72	static void SetPrintType(Bool_t on);
44ce6bbe	73	static void SetPrintType(EType_t type, Bool_t on);
6ab674bd	74	static void SetPrintModule(Bool_t on);
44ce6bbe	75	static void SetPrintModule(EType_t type, Bool_t on);
6ab674bd	76	static void SetPrintScope(Bool_t on);
44ce6bbe	77	static void SetPrintScope(EType_t type, Bool_t on);
6ab674bd	78	static void SetPrintLocation(Bool_t on);
44ce6bbe	79	static void SetPrintLocation(EType_t type, Bool_t on);
6ab674bd	80
45fa0297	81	static void SetPrintRepetitions(Bool_t on);
45fa0297	82
c4cb6153	83	static void WriteToFile(const char* name, Int_t option = 0);
6ab674bd	84
	85	// the following public methods are used by the preprocessor macros
	86	// and should not be called directly
20848f77	87	static Bool_t IsDebugEnabled() {return fgDebugEnabled;}
6ab674bd	88	static Int_t GetDebugLevel(const char* module, const char* className);
	89	static void Message(UInt_t level, const char* message,
	90	const char* module, const char* className,
	91	const char* function, const char* file, Int_t line);
	92	static void Debug(UInt_t level, const char* message,
	93	const char* module, const char* className,
	94	const char* function, const char* file, Int_t line);
	95
44ce6bbe	96	static Int_t RedirectStdoutTo(EType_t type, UInt_t level, const char* module,
eeb769e2	97	const char* className, const char* function,
eeb769e2	98	const char* file, Int_t line, Bool_t print);
44ce6bbe	99	static Int_t RedirectStderrTo(EType_t type, UInt_t level, const char* module,
eeb769e2	100	const char* className, const char* function,
	101	const char* file, Int_t line, Bool_t print);
	102	static void RestoreStdout(Int_t original);
	103	static void RestoreStderr(Int_t original);
	104
44ce6bbe	105	static ostream& Stream(EType_t type, UInt_t level,
eeb769e2	106	const char* module, const char* className,
	107	const char* function, const char* file, Int_t line);
	108
6ab674bd	109	private:
6d7793cf	110
	111	// constructor is made private for implementing a singleton
	112	AliLog();
	113	virtual ~AliLog();
	114
	115	// NOT IMPLEMENTED?
6ab674bd	116	AliLog(const AliLog& log);
	117	AliLog& operator = (const AliLog& log);
	118
eeb769e2	119	void ReadEnvSettings();
eeb769e2	120
6ab674bd	121	static void RootErrorHandler(Int_t level, Bool_t abort,
	122	const char* location, const char* message);
	123
	124	void CloseFile(Int_t type);
	125	FILE* GetOutputStream(Int_t type);
	126
	127	UInt_t GetLogLevel(const char* module, const char* className) const;
eeb769e2	128	void PrintMessage(UInt_t type, const char* message,
	129	const char* module, const char* className,
	130	const char* function,
	131	const char* file, Int_t line);
1948744e	132
1948744e	133	void PrintString(Int_t type, FILE* stream, const char* format, ...);
45fa0297	134	void PrintRepetitions();
eeb769e2	135
44ce6bbe	136	Int_t RedirectTo(FILE* stream, EType_t type, UInt_t level,
eeb769e2	137	const char* module, const char* className,
	138	const char* function,
	139	const char* file, Int_t line, Bool_t print);
	140
44ce6bbe	141	ostream& GetStream(EType_t type, UInt_t level,
eeb769e2	142	const char* module, const char* className,
eeb769e2	143	const char* function, const char* file, Int_t line);
6ab674bd	144
	145	enum {kDebugOffset = kDebug-1};
	146
	147	static AliLog* fgInstance; //! pointer to current instance
6ab674bd	148	static Bool_t fgDebugEnabled; // flag for debug en-/disabling
	149
	150	UInt_t fGlobalLogLevel; // global logging level
	151	TObjArray fModuleDebugLevels; // debug levels for modules
	152	TObjArray fClassDebugLevels; // debug levels for classes
	153
	154	Int_t fOutputTypes[kMaxType]; // types of output streams
	155	TString fFileNames[kMaxType]; // file names
	156	FILE* fOutputFiles[kMaxType]; //! log output files
1948744e	157	ostream* fOutputStreams[kMaxType]; //! log output streams
6ab674bd	158
	159	Bool_t fPrintType[kMaxType]; // print type on/off
	160	Bool_t fPrintModule[kMaxType]; // print module on/off
	161	Bool_t fPrintScope[kMaxType]; // print scope/class name on/off
	162	Bool_t fPrintLocation[kMaxType]; // print file and line on/off
	163
45fa0297	164	Bool_t fPrintRepetitions; // print number of repetitions instead of repeated message on/off
	165
	166	Int_t fRepetitions; //! counter of repetitions
	167	UInt_t fLastType; //! type of last message
	168	TString fLastMessage; //! last message
	169	TString fLastModule; //! module name of last message
	170	TString fLastClassName; //! class name of last message
	171	TString fLastFunction; //! function name of last message
	172	TString fLastFile; //! file name of last message
	173	Int_t fLastLine; //! line number of last message
1948744e	174	AliLogNotification fCallBacks[kMaxType]; //! external notification callback
45fa0297	175
6ab674bd	176	ClassDef(AliLog, 1) // class for logging debug, info and error messages
	177	};
	178
eeb769e2	179
6d7793cf	180	// module name macro
eb5bc777	181	#ifdef _MODULE_
eb5bc777	182	#define MODULENAME() _MODULE_
eeb769e2	183	#else
eeb769e2	184	#define MODULENAME() "NoModule"
cd676389	185	#endif
eeb769e2	186
6d7793cf	187	// function name macro
eeb769e2	188	#if defined(__GNUC__) \|\| defined(__ICC) \|\| defined(__ECC) \|\| defined(__APPLE__)
eeb769e2	189	#define FUNCTIONNAME() __FUNCTION__
92154bc0	190	// #elif defined(__HP_aCC) \|\| defined(__alpha) \|\| defined(__DECCXX)
92154bc0	191	// #define FUNCTIONNAME() __FUNC__
eeb769e2	192	#else
eeb769e2	193	#define FUNCTIONNAME() "???"
cd676389	194	#endif
6ab674bd	195
eeb769e2	196	// redirection
	197	#define REDIRECTSTDOUT(type, level, scope, whatever) {Int_t originalStdout = AliLog::RedirectStdoutTo(type, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__, kFALSE); whatever; AliLog::RestoreStdout(originalStdout);}
	198	#define REDIRECTSTDERR(type, level, scope, whatever) {Int_t originalStderr = AliLog::RedirectStderrTo(type, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__, kFALSE); whatever; AliLog::RestoreStderr(originalStderr);}
	199	#define REDIRECTSTDOUTANDSTDERR(type, level, scope, whatever) {Int_t originalStdout = AliLog::RedirectStdoutTo(type, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__, kFALSE); Int_t originalStderr = AliLog::RedirectStderrTo(type, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__, kFALSE); whatever; AliLog::RestoreStderr(originalStderr); AliLog::RestoreStdout(originalStdout);}
	200
	201
	202	// debug level
6ab674bd	203	#ifdef LOG_NO_DEBUG
	204	#define AliDebugLevel() -1
	205	#define AliDebugLevelClass() -1
	206	#define AliDebugLevelGeneral(scope) -1
	207	#else
eeb769e2	208	#define AliDebugLevel() ((AliLog::IsDebugEnabled()) ? AliLog::GetDebugLevel(MODULENAME(), ClassName()) : -1)
	209	#define AliDebugLevelClass() ((AliLog::IsDebugEnabled()) ? AliLog::GetDebugLevel(MODULENAME(), Class()->GetName()) : -1)
	210	#define AliDebugLevelGeneral(scope) ((AliLog::IsDebugEnabled()) ? AliLog::GetDebugLevel(MODULENAME(), scope) : -1)
6ab674bd	211	#endif
6ab674bd	212
eeb769e2	213	// debug messages
6ab674bd	214	#ifdef LOG_NO_DEBUG
	215	#define AliDebug(level, message)
	216	#define AliDebugClass(level, message)
	217	#define AliDebugGeneral(scope, level, message)
	218	#else
c2deee9d	219
	220	// inspired by log4cxx code (see log4cxx/Logger.h)
	221	// implements GCC branch prediction for increasing logging performance
	222	#if !defined(ALIROOT_UNLIKELY)
6d7793cf	223	#if defined(__GNUC__) && (__GNUC__ >= 3)
c2deee9d	224	/**
	225	Provides optimization hint to the compiler
	226	to optimize for the expression being false.
	227	@param expr boolean expression.
	228	@returns value of expression.
	229	*/
	230	#define ALIROOT_UNLIKELY(expr) __builtin_expect(expr, 0)
	231	#else
	232	/**
	233	Provides optimization hint to the compiler
	234	to optimize for the expression being false.
	235	@param expr boolean expression.
	236	@returns value of expression.
	237	**/
	238	#define ALIROOT_UNLIKELY(expr) expr
	239	#endif
	240	#endif
	241
	242	/**
	243	Logs a message to a specified logger with the DEBUG level.
	244
	245	@param logLevel the debug level.
	246	@param message message to print in the following format: Form(message).
	247	Note, that message should contain balanced parenthesis, like
	248	<code>AliDebug(1, Form("Failed to decode line %d of %s", line, filename));</code>
267f939c	249	*/
c2deee9d	250	#define AliDebug(logLevel, message) \
	251	do { if (ALIROOT_UNLIKELY(AliLog::IsDebugEnabled() && AliLog::GetDebugLevel(MODULENAME(), ClassName()) >= logLevel)) {\
	252	AliLog::Debug(logLevel, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__); }} while (0)
	253
	254	/**
	255	Logs a message to a specified logger with the DEBUG level.
	256
	257	@param logLevel the debug level.
	258	@param message message to print in the following format: Form(message).
	259	Note, that message should contain balanced parenthesis, like
	260	<code>AliDebug(1, Form("Failed to decode line %d of %s", line, filename));</code>
	261	*/
	262	#define AliDebugClass(logLevel, message) \
	263	do { if (ALIROOT_UNLIKELY(AliLog::IsDebugEnabled() && AliLog::GetDebugLevel(MODULENAME(), Class()->GetName()) >= logLevel)) {\
	264	AliLog::Debug(logLevel, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__); }} while (0)
	265
	266	/**
	267	Logs a message to a specified logger with the DEBUG level.
	268
	269	@param scope the logging scope.
	270	@param logLevel the debug level.
	271	@param message message to print in the following format: Form(message).
	272	Note, that message should contain balanced parenthesis, like
	273	<code>AliDebug(1, Form("Failed to decode line %d of %s", line, filename));</code>
	274	*/
	275	#define AliDebugGeneral(scope, logLevel, message) \
	276	do { if (ALIROOT_UNLIKELY(AliLog::IsDebugEnabled() && AliLog::GetDebugLevel(MODULENAME(), scope) >= logLevel)) {\
	277	AliLog::Debug(logLevel, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__); }} while (0)
	278
6ab674bd	279	#endif
6ab674bd	280
eeb769e2	281	// redirection to debug
	282	#define StdoutToAliDebug(level, whatever) REDIRECTSTDOUT(AliLog::kDebug, level, ClassName(), whatever)
	283	#define StderrToAliDebug(level, whatever) REDIRECTSTDERR(AliLog::kDebug, level, ClassName(), whatever)
	284	#define ToAliDebug(level, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kDebug, level, ClassName(), whatever)
	285	#define StdoutToAliDebugClass(level, whatever) REDIRECTSTDOUT(AliLog::kDebug, level, Class()->GetName(), whatever)
	286	#define StderrToAliDebugClass(level, whatever) REDIRECTSTDERR(AliLog::kDebug, level, Class()->GetName(), whatever)
	287	#define ToAliDebugClass(level, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kDebug, level, Class()->GetName(), whatever)
	288	#define StdoutToAliDebugGeneral(scope, level, whatever) REDIRECTSTDOUT(AliLog::kDebug, level, scope, whatever)
	289	#define StderrToAliDebugGeneral(scope, level, whatever) REDIRECTSTDERR(AliLog::kDebug, level, scope, whatever)
	290	#define ToAliDebugGeneral(scope, level, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kDebug, level, scope, whatever)
	291
	292	// debug stream objects
	293	#define AliDebugStream(level) AliLog::Stream(AliLog::kDebug, level, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__)
	294	#define AliDebugClassStream(level) AliLog::Stream(AliLog::kDebug, level, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__)
	295	#define AliDebugGeneralStream(scope, level) AliLog::Stream(AliLog::kDebug, level, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__)
	296
	297
	298	// info messages
6ab674bd	299	#ifdef LOG_NO_INFO
	300	#define AliInfo(message)
	301	#define AliInfoClass(message)
	302	#define AliInfoGeneral(scope, message)
	303	#else
eeb769e2	304	#define AliInfo(message) {AliLog::Message(AliLog::kInfo, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__);}
	305	#define AliInfoClass(message) {AliLog::Message(AliLog::kInfo, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__);}
	306	#define AliInfoGeneral(scope, message) {AliLog::Message(AliLog::kInfo, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__);}
6ab674bd	307	#endif
6ab674bd	308
eeb769e2	309	// redirection to info
	310	#define StdoutToAliInfo(whatever) REDIRECTSTDOUT(AliLog::kInfo, 0, ClassName(), whatever)
	311	#define StderrToAliInfo(whatever) REDIRECTSTDERR(AliLog::kInfo, 0, ClassName(), whatever)
	312	#define ToAliInfo(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kInfo, 0, ClassName(), whatever)
	313	#define StdoutToAliInfoClass(whatever) REDIRECTSTDOUT(AliLog::kInfo, 0, Class()->GetName(), whatever)
	314	#define StderrToAliInfoClass(whatever) REDIRECTSTDERR(AliLog::kInfo, 0, Class()->GetName(), whatever)
	315	#define ToAliInfoClass(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kInfo, 0, Class()->GetName(), whatever)
	316	#define StdoutToAliInfoGeneral(scope, whatever) REDIRECTSTDOUT(AliLog::kInfo, 0, scope, whatever)
	317	#define StderrToAliInfoGeneral(scope, whatever) REDIRECTSTDERR(AliLog::kInfo, 0, scope, whatever)
	318	#define ToAliInfoGeneral(scope, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kInfo, 0, scope, whatever)
	319
	320	// info stream objects
	321	#define AliInfoStream() AliLog::Stream(AliLog::kInfo, 0, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__)
	322	#define AliInfoClassStream() AliLog::Stream(AliLog::kInfo, 0, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__)
	323	#define AliInfoGeneralStream(scope) AliLog::Stream(AliLog::kInfo, 0, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__)
	324
eeb769e2	325	// warning messages
6ab674bd	326	#ifdef LOG_NO_WARNING
	327	#define AliWarning(message)
	328	#define AliWarningClass(message)
	329	#define AliWarningGeneral(scope, message)
	330	#else
eeb769e2	331	#define AliWarning(message) {AliLog::Message(AliLog::kWarning, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__);}
	332	#define AliWarningClass(message) {AliLog::Message(AliLog::kWarning, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__);}
	333	#define AliWarningGeneral(scope, message) {AliLog::Message(AliLog::kWarning, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__);}
6ab674bd	334	#endif
6ab674bd	335
eeb769e2	336	// redirection to warning
	337	#define StdoutToAliWarning(whatever) REDIRECTSTDOUT(AliLog::kWarning, 0, ClassName(), whatever)
	338	#define StderrToAliWarning(whatever) REDIRECTSTDERR(AliLog::kWarning, 0, ClassName(), whatever)
	339	#define ToAliWarning(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kWarning, 0, ClassName(), whatever)
	340	#define StdoutToAliWarningClass(whatever) REDIRECTSTDOUT(AliLog::kWarning, 0, Class()->GetName(), whatever)
	341	#define StderrToAliWarningClass(whatever) REDIRECTSTDERR(AliLog::kWarning, 0, Class()->GetName(), whatever)
	342	#define ToAliWarningClass(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kWarning, 0, Class()->GetName(), whatever)
	343	#define StdoutToAliWarningGeneral(scope, whatever) REDIRECTSTDOUT(AliLog::kWarning, 0, scope, whatever)
	344	#define StderrToAliWarningGeneral(scope, whatever) REDIRECTSTDERR(AliLog::kWarning, 0, scope, whatever)
	345	#define ToAliWarningGeneral(scope, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kWarning, 0, scope, whatever)
	346
	347	// warning stream objects
	348	#define AliWarningStream() AliLog::Stream(AliLog::kWarning, 0, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__)
	349	#define AliWarningClassStream() AliLog::Stream(AliLog::kWarning, 0, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__)
	350	#define AliWarningGeneralStream(scope) AliLog::Stream(AliLog::kWarning, 0, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__)
	351
	352
	353	// error messages
	354	#define AliError(message) {AliLog::Message(AliLog::kError, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__);}
	355	#define AliErrorClass(message) {AliLog::Message(AliLog::kError, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__);}
	356	#define AliErrorGeneral(scope, message) {AliLog::Message(AliLog::kError, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__);}
	357
	358	// redirection to error
	359	#define StdoutToAliError(whatever) REDIRECTSTDOUT(AliLog::kError, 0, ClassName(), whatever)
	360	#define StderrToAliError(whatever) REDIRECTSTDERR(AliLog::kError, 0, ClassName(), whatever)
	361	#define ToAliError(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kError, 0, ClassName(), whatever)
	362	#define StdoutToAliErrorClass(whatever) REDIRECTSTDOUT(AliLog::kError, 0, Class()->GetName(), whatever)
	363	#define StderrToAliErrorClass(whatever) REDIRECTSTDERR(AliLog::kError, 0, Class()->GetName(), whatever)
	364	#define ToAliErrorClass(whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kError, 0, Class()->GetName(), whatever)
	365	#define StdoutToAliErrorGeneral(scope, whatever) REDIRECTSTDOUT(AliLog::kError, 0, scope, whatever)
	366	#define StderrToAliErrorGeneral(scope, whatever) REDIRECTSTDERR(AliLog::kError, 0, scope, whatever)
	367	#define ToAliErrorGeneral(scope, whatever) REDIRECTSTDOUTANDSTDERR(AliLog::kError, 0, scope, whatever)
	368
	369	// error stream objects
	370	#define AliErrorStream() AliLog::Stream(AliLog::kError, 0, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__)
	371	#define AliErrorClassStream() AliLog::Stream(AliLog::kError, 0, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__)
	372	#define AliErrorGeneralStream(scope) AliLog::Stream(AliLog::kError, 0, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__)
	373
6ab674bd	374
eeb769e2	375	// fatal messages
	376	#define AliFatal(message) {AliLog::Message(AliLog::kFatal, message, MODULENAME(), ClassName(), FUNCTIONNAME(), __FILE__, __LINE__);}
	377	#define AliFatalClass(message) {AliLog::Message(AliLog::kFatal, message, MODULENAME(), Class()->GetName(), FUNCTIONNAME(), __FILE__, __LINE__);}
	378	#define AliFatalGeneral(scope, message) {AliLog::Message(AliLog::kFatal, message, MODULENAME(), scope, FUNCTIONNAME(), __FILE__, __LINE__);}
6ab674bd	379
6ab674bd	380	#endif