GLogMessage.hh

Go to the documentation of this file.

//======================================================================
/*! \file GLogMessage.hh
 *
 *  Include file for the GLogMessage class
 */
//======================================================================

#ifndef G_LOG_MESSAGE_HH
#define G_LOG_MESSAGE_HH

#include "GGlobal.hh"
#include "GBaseFunctions.hh"
#include "GStringFunctions.hh"

//======================================================================
//  Short-cut functions

extern void   GSetVerboseLevel ( u_int v ); // inline
extern u_int  GGetVerboseLevel ( );               // inline

extern void GSetLogFile   ( const string & fname, bool term = true ); // inline
extern void GCloseLogFile ( );                                        // inline

extern void GLogMessage ( const string & text, u_int verb = 0 );  // inline
extern void GLogMessage ( const string & text, u_int verb, u_int ref_level ); // inline
extern void GLogInfo    ( const string & text );  // inline
extern void GLogWarning ( const string & text );  // inline
extern void GLogError   ( const string & text,
                          bool abort = true );    // inline

extern void GLogMessage ( ostream & os, const string & text, u_int verb = 0 );  // inline
extern void GLogInfo    ( ostream & os, const string & text );  // inline
extern void GLogWarning ( ostream & os, const string & text );  // inline
extern void GLogError   ( ostream & os, const string & text,
                                        bool abort = true );    // inline

// Special messages for debugging (if GDEBUG preprocessor variable is defined)
extern void GDebugLine  ( const string & text, u_int verb = 0 );  // inline
extern void GDebug      ( const string & text, u_int verb = 0 );  // inline

//======================================================================

/*! \class GLogMessage
 *
 *  This class provides a set of static functions to send messages to
 *  a terminal output and/or to a log file.
 *
 *  The different types of text messages are the following:
 *  - \b Info : a message with information marker (prefix)
 *  - \b Warning : a message with warning marker (prefix) and highlightiong.
 *  - \b Error : a message with error marker (prefix) and highlightiong, than
 *               may also stop the program.
 *  - \b Message : a message with no marker, but with a user-defined verbose
 *                 level condition
 *
 */
class GLogMessage
{
  //------------------------------------------------------------
  /*! \object_doc */
  GObject(GLogMessage)
  //------------------------------------------------------------

  protected:
    static u_int    verbose_level;    ///< Current verbose level

    // messages and log files
    static bool     log_file;         ///< Indicates if there is a log file
    static bool     log_term;         ///< Indicates if there is a log output on terminal
    static string   log_file_name;    ///< Log file name
    static ofstream log_file_stream;  ///< Log file stream

  //------------------------------------------------------------
  //  Constructor / Destructor / Affectation
  protected:
    GLogMessage ( );

  public:
    virtual ~GLogMessage ( );

    //----------------------------------------------------------
    static u_int        GetVerboseLevel ( );          // inline
    static void         SetVerboseLevel ( u_int v );  // inline

    // terminal and log file messages
    static void         SetLogFile      ( const string & fname, bool term = true );
    static void   CloseLogFile    ( );

    static void         SendLogMessage  ( const string & text, u_int verb = 1 );  // inline
    static void         SendLogMessage  ( const string & text, u_int verb, u_int ref_level ); // inline
    static void         SendLogInfo     ( const string & text );                  // inline
    static void         SendLogWarning  ( const string & text );                  // inline
    static void         SengLogError    ( const string & text,
                                    bool abort = true );                    // inline

    static void         SendLogMessage  ( ostream & os, const string & text, u_int verb = 1 );
    static void         SendLogMessage  ( ostream & os, const string & text, u_int verb, u_int ref_level );
    static void         SendLogInfo     ( ostream & os, const string & text );
    static void         SendLogWarning  ( ostream & os, const string & text );
    static void         SengLogError    ( ostream & os, const string & text,
                                                  bool abort = true );
};

//----------------------------------------------------------------------
// Inline functions
#include "icc/GLogMessage.icc"

//======================================================================
#endif