A logfile class. More...

#include <QwLog.h>

Inherits std::ostream.

Public Types
enum	QwLogLevel { kAlways = -1, kError = 0, kWarning = 1, kMessage = 2, kVerbose = 3, kDebug = 4 }
	Loglevels. More...

Public Member Functions
void	ProcessOptions (QwOptions *options)
	Process class options for QwOptions. More...

	QwLog ()
	The constructor. More...

virtual	~QwLog ()
	The destructor. More...

bool	IsDebugFunction (const string func_name)
	Determine whether the function name matches a specified list of regular expressions. More...

void	InitLogFile (const std::string name, const std::ios_base::openmode mode=kAppend)
	Initialize the log file with name 'name'. More...

void	SetScreenColor (bool flag)
	Set the screen color mode. More...

void	SetScreenThreshold (int thr)
	Set the screen log level. More...

void	SetFileThreshold (int thr)
	Set the file log level. More...

QwLog &	operator() (const QwLogLevel level, const std::string func_sig="<unknown>")
	Set the stream log level. More...

template<class T >
QwLog &	operator<< (const T &t)
	Stream an object to the output stream. More...

QwLog &	operator<< (std::ostream &(*manip)(std::ostream &))
	Pass the ios_base manipulators. More...

Static Public Member Functions
static void	DefineOptions (QwOptions *options)
	Define available class options for QwOptions. More...

static std::ostream &	endl (std::ostream &)
	End of the line. More...

static std::ostream &	flush (std::ostream &)
	Flush the streams. More...

Static Public Attributes
static const std::ios_base::openmode	kTruncate = std::ios::trunc
	Log file open modes. More...

static const std::ios_base::openmode	kAppend = std::ios::app

Private Member Functions
const char *	GetTime ()
	Get the local time. More...

Private Attributes
char	fTimeString [128]

QwLogLevel	fScreenThreshold
	Screen thresholds and stream. More...

std::ostream *	fScreen

QwLogLevel	fFileThreshold
	File thresholds and stream. More...

std::ostream *	fFile

QwLogLevel	fLogLevel
	Log level of this stream. More...

bool	fPrintFunctionSignature
	Flag to print function signature on warning or error. More...

std::map< std::string, bool >	fIsDebugFunction
	List of regular expressions for functions that will have increased log level. More...

std::vector< std::string >	fDebugFunctionRegexString

bool	fUseColor
	Flag to disable color. More...

Static Private Attributes
static bool	fFileAtNewLine = true
	Flags only relevant for current line, but static for use in static function. More...

static bool	fScreenInColor = false

static bool	fScreenAtNewLine = true

Detailed Description

A logfile class.

This class should not be used directly. Instead one can write text to the screen or a log file via the predefined log drains QwError, QwWarning, QwMessage, QwVerbose and QwDebug. A special log drain QwOut will always be printed and is reserved for output explicitly requested by the user.

An example could be:

 QwMessage << "Hello World !!!" << QwLog::endl;

Definition at line 78 of file QwLog.h.

Member Enumeration Documentation

enum QwLog::QwLogLevel

Loglevels.

enum of possible log levels

Enumerator
kAlways	Explicit output
kError	Error loglevel
kWarning	Warning loglevel
kMessage	Message loglevel
kVerbose	Verbose loglevel
kDebug	Debug loglevel

Definition at line 93 of file QwLog.h.

                     {
       kAlways    = -1, /*!< Explicit output  */
       kError     =  0, /*!< Error loglevel   */
       kWarning   =  1, /*!< Warning loglevel */
       kMessage   =  2, /*!< Message loglevel */
       kVerbose   =  3, /*!< Verbose loglevel */
       kDebug     =  4  /*!< Debug loglevel   */
     };

Constructor & Destructor Documentation

QwLog::QwLog ( )

The constructor.

The constructor initializes the screen stream and resets the file stream

Definition at line 35 of file QwLog.cc.

References fFile, fFileThreshold, fLogLevel, fPrintFunctionSignature, fScreen, fScreenThreshold, fUseColor, and kMessage.

 : std::ostream(std::cout.rdbuf())
 {
   fScreenThreshold = kMessage;
   fScreen = &std::cout;
 
   fFileThreshold = kMessage;
   fFile = 0;
 
   fLogLevel = kMessage;
 
   fUseColor = true;
 
   fPrintFunctionSignature = false;
 }

QwLog::~QwLog ( )

virtual

The destructor.

The destructor destroys the log file, if it was present

Definition at line 53 of file QwLog.cc.

References fFile.

 {
   if (fFile) {
     delete fFile;
     fFile = 0;
   }
 }

Member Function Documentation

void QwLog::DefineOptions ( QwOptions * options )

static

Define available class options for QwOptions.

Defines configuration options for logging class using QwOptions functionality.

Note: this uses a pointer as opposed to a reference, because as indicated above the QwLog class cannot depend on the QwOptions class. When using a pointer we only need a forward declaration and we do not need to include the header file QwOptions.h.

Parameters

options Options object

Definition at line 73 of file QwLog.cc.

References QwOptions::AddOptions(), default_bool_value, and kMessage.

Referenced by QwOptions::DefineOptions().

 {
   // Define the logging options
   options->AddOptions("Logging options")("QwLog.color",
                 po::value<bool>()->default_value(true),
                 "colored screen output");
   options->AddOptions("Logging options")("QwLog.logfile",
                 po::value<string>(),
                 "log file");
   options->AddOptions("Logging options")("QwLog.loglevel-file",
                 po::value<int>()->default_value(kMessage),
                 "log level for file output");
   options->AddOptions("Logging options")("QwLog.loglevel-screen",
                 po::value<int>()->default_value(kMessage),
                 "log level for screen output");
   options->AddOptions("Logging options")("QwLog.print-signature",
                 po::value<bool>()->default_bool_value(false),
                 "print signature on error or warning");
   options->AddOptions("Logging options")("QwLog.debug-function",
                 po::value< std::vector<string> >()->multitoken(),
                 "print debugging output of function with signatures satisfying the specified regex");
 }

Here is the call graph for this function:

Here is the caller graph for this function:

std::ostream & QwLog::endl ( std::ostream & strm )

static

End of the line.

End of the line

Definition at line 299 of file QwLog.cc.

References fFile, fFileAtNewLine, fFileThreshold, fLogLevel, fScreen, fScreenAtNewLine, fScreenInColor, fScreenThreshold, and Qw::kNormal.

 {
   if (gQwLog.fScreen && gQwLog.fLogLevel <= gQwLog.fScreenThreshold) {
     if (fScreenInColor)
       *(gQwLog.fScreen) << QwColor(Qw::kNormal) << std::endl;
     else
       *(gQwLog.fScreen) << std::endl;
     fScreenAtNewLine = true;
     fScreenInColor = false;
   }
   if (gQwLog.fFile && gQwLog.fLogLevel <= gQwLog.fFileThreshold) {
     *(gQwLog.fFile) << std::endl;
     fFileAtNewLine = true;
   }
 
   return strm;
 }

std::ostream & QwLog::flush ( std::ostream & strm )

static

Flush the streams.

Flush the streams

Definition at line 319 of file QwLog.cc.

References fFile, and fScreen.

Referenced by QwInterpolator< value_t, value_n >::ReadBinaryFile(), QwMagneticField::ReadFieldMapStream(), QwInterpolator< value_t, value_n >::ReadText(), QwInterpolator< value_t, value_n >::WriteBinaryFile(), and QwInterpolator< value_t, value_n >::WriteText().

 {
   if (gQwLog.fScreen) {
     *(gQwLog.fScreen) << std::flush;
   }
   if (gQwLog.fFile) {
     *(gQwLog.fFile) << std::flush;
   }
   return strm;
 }

Here is the caller graph for this function:

const char * QwLog::GetTime ( )

private

Get the local time.

Get the local time

Definition at line 332 of file QwLog.cc.

References fTimeString.

Referenced by operator()().

 {
   time_t now = time(0);
   if (now >= 0) {
     struct tm *currentTime = localtime(&now);
     strftime(fTimeString, 128, "%Y-%m-%d, %T", currentTime);
     return fTimeString;
   } else {
     return "";
   }
 }

Here is the caller graph for this function:

void QwLog::InitLogFile	(	const std::string	name,
		const std::ios_base::openmode	mode = `kAppend`
	)

Initialize the log file with name 'name'.

Initialize the log file with name 'name'

Definition at line 157 of file QwLog.cc.

References fFile, fFileThreshold, and kMessage.

Referenced by main(), and ProcessOptions().

 {
   if (fFile) {
     delete fFile;
     fFile = 0;
   }
 
   std::ios_base::openmode flags = std::ios::out | mode;
   fFile = new std::ofstream(name.c_str(), flags);
   fFileThreshold = kMessage;
 }

Here is the caller graph for this function:

bool QwLog::IsDebugFunction ( const string func_sig )

Determine whether the function name matches a specified list of regular expressions.

Determine whether the function name matches a specified list of regular expressions

Definition at line 137 of file QwLog.cc.

References fDebugFunctionRegexString, fIsDebugFunction, and regex.

Referenced by operator()().

 {
   // If not in our cached list
   if (fIsDebugFunction.find(func_sig) == fIsDebugFunction.end()) {
     // Look through all regexes
     fIsDebugFunction[func_sig] = false;
     for (size_t i = 0; i < fDebugFunctionRegexString.size(); i++) {
       // When we find a match, cache it and break out
       boost::regex regex(fDebugFunctionRegexString.at(i));
       if (boost::regex_match(func_sig, regex)) {
         fIsDebugFunction[func_sig] = true;
         break;
       }
     }
   }
   return fIsDebugFunction[func_sig];
 }

Here is the caller graph for this function:

QwLog & QwLog::operator()	(	const QwLogLevel	level,
		const std::string	func_sig = `"<unknown>"`
	)

Set the stream log level.

Set the stream log level

Definition at line 192 of file QwLog.cc.

References fFile, fFileAtNewLine, fFileThreshold, fLogLevel, fPrintFunctionSignature, fScreen, fScreenAtNewLine, fScreenInColor, fScreenThreshold, fUseColor, GetTime(), IsDebugFunction(), kAlways, kDebug, kError, kMessage, Qw::kNormal, Qw::kRed, kVerbose, and kWarning.

 {
   // Set the log level of this sink
   fLogLevel = level;
 
   // Override log level of this sink when in a debugged function
   if (IsDebugFunction(func_sig)) fLogLevel = QwLog::kAlways;
 
   if (fScreen && fLogLevel <= fScreenThreshold) {
     if (fScreenAtNewLine) {
       // Put something at the beginning of a new line
       switch (level) {
       case kError:
         if (fUseColor) {
           *(fScreen) << QwColor(Qw::kRed);
           fScreenInColor = true;
         }
         if (fPrintFunctionSignature)
           *(fScreen) << "Error (in " << func_sig << "): ";
         else
           *(fScreen) << "Error: ";
         break;
       case kWarning:
         if (fUseColor) {
           *(fScreen) << QwColor(Qw::kRed);
           fScreenInColor = true;
         }
         if (fPrintFunctionSignature)
           *(fScreen) << "Warning (in " << func_sig << "): ";
         else
           *(fScreen) << "Warning: ";
         if (fUseColor) {
           *(fScreen) << QwColor(Qw::kNormal);
           fScreenInColor = false;
         }
         break;
       default:
         fScreenInColor = false;
         break;
       }
     }
     fScreenAtNewLine = false;
   }
 
   if (fFile && fLogLevel <= fFileThreshold) {
     if (fFileAtNewLine) {
       *(fFile) << GetTime();
       switch (level) {
       case kError:   *(fFile) << " EE"; break;
       case kWarning: *(fFile) << " WW"; break;
       case kMessage: *(fFile) << " MM"; break;
       case kVerbose: *(fFile) << " VV"; break;
       case kDebug:   *(fFile) << " DD"; break;
       default: *(fFile) << "   "; break;
       }
       *(fFile) << " - ";
       fFileAtNewLine = false;
     }
   }
 
   return *this;
 }

Here is the call graph for this function:

template<class T >

QwLog& QwLog::operator<< ( const T & t )

inline

Stream an object to the output stream.

Definition at line 141 of file QwLog.h.

References fFile, fFileThreshold, fLogLevel, fScreen, and fScreenThreshold.

                                                        {
       if (fScreen && fLogLevel <= fScreenThreshold) {
         *(fScreen) << t;
       }
       if (fFile && fLogLevel <= fFileThreshold) {
         *(fFile) << t;
       }
       return *this;
     }

QwLog & QwLog::operator<< ( std::ostream &(*)(std::ostream &) manip )

Pass the ios_base manipulators.

Definition at line 280 of file QwLog.cc.

References fFileThreshold, fLogLevel, fScreen, and fScreenThreshold.

 {
   if (fScreen && (fLogLevel <= fScreenThreshold || fLogLevel <= fFileThreshold) ) {
     *(fScreen) << manip;
   }
 
 // The following solution leads to double calls to QwLog::endl
 //   if (fScreen && fLogLevel <= fScreenThreshold) {
 //     *(fScreen) << manip;
 //   }
 //   if (fFile && fLogLevel <= fFileThreshold) {
 //     *(fFile) << manip;
 //   }
 
   return *this;
 }

void QwLog::ProcessOptions ( QwOptions * options )

Process class options for QwOptions.

Process configuration options for logging class using QwOptions functionality.

Note: this uses a pointer as opposed to a reference, because as indicated above the QwLog class cannot depend on the QwOptions class. When using a pointer we only need a forward declaration and we do not need to include the header file QwOptions.h.

Parameters

options Options object

Definition at line 108 of file QwLog.cc.

References fDebugFunctionRegexString, fPrintFunctionSignature, QwOptions::GetValue(), QwOptions::GetValueVector(), QwOptions::HasValue(), InitLogFile(), SetFileThreshold(), SetScreenColor(), and SetScreenThreshold().

Referenced by main().

 {
   // Initialize log file
   if (options->HasValue("QwLog.logfile"))
     InitLogFile(options->GetValue<std::string>("QwLog.logfile"));
 
   // Set the logging thresholds
   SetFileThreshold(options->GetValue<int>("QwLog.loglevel-file"));
   SetScreenThreshold(options->GetValue<int>("QwLog.loglevel-screen"));
 
   // Set color flag
   SetScreenColor(options->GetValue<bool>("QwLog.color"));
 
   // Set the flags for function name and signature printing
   fPrintFunctionSignature = options->GetValue<bool>("QwLog.print-signature");
 
   // Set the list of regular expressions for functions to debug
   fDebugFunctionRegexString = options->GetValueVector<std::string>("QwLog.debug-function");
   if (fDebugFunctionRegexString.size() > 0)
     std::cout << "Debug regex list:" << std::endl;
   for (size_t i = 0; i < fDebugFunctionRegexString.size(); i++) {
     std::cout << fDebugFunctionRegexString.back() << std::endl;
   }
 }

Here is the call graph for this function:

Here is the caller graph for this function:

void QwLog::SetFileThreshold ( int thr )

Set the file log level.

Set the file log level

Definition at line 185 of file QwLog.cc.

References fFileThreshold.

Referenced by main(), and ProcessOptions().

 {
   fFileThreshold = QwLogLevel(thr);
 }

Here is the caller graph for this function:

void QwLog::SetScreenColor ( bool flag )

Set the screen color mode.

Set the screen color mode

Definition at line 171 of file QwLog.cc.

References fUseColor.

Referenced by main(), and ProcessOptions().

 {
   fUseColor = flag;
 }

Here is the caller graph for this function:

void QwLog::SetScreenThreshold ( int thr )

Set the screen log level.

Set the screen log level

Definition at line 178 of file QwLog.cc.

References fScreenThreshold.

Referenced by main(), and ProcessOptions().

 {
   fScreenThreshold = QwLogLevel(thr);
 }

Here is the caller graph for this function:

Field Documentation

std::vector<std::string> QwLog::fDebugFunctionRegexString

private

Definition at line 187 of file QwLog.h.

Referenced by IsDebugFunction(), and ProcessOptions().

std::ostream* QwLog::fFile

private

Definition at line 178 of file QwLog.h.

Referenced by endl(), flush(), InitLogFile(), operator()(), operator<<(), QwLog(), and ~QwLog().

bool QwLog::fFileAtNewLine = true

staticprivate

Flags only relevant for current line, but static for use in static function.

Definition at line 193 of file QwLog.h.

Referenced by endl(), and operator()().

QwLogLevel QwLog::fFileThreshold

private

File thresholds and stream.

Definition at line 177 of file QwLog.h.

Referenced by endl(), InitLogFile(), operator()(), operator<<(), QwLog(), and SetFileThreshold().

std::map<std::string,bool> QwLog::fIsDebugFunction

private

List of regular expressions for functions that will have increased log level.

Definition at line 186 of file QwLog.h.

Referenced by IsDebugFunction().

QwLogLevel QwLog::fLogLevel

private

Log level of this stream.

Definition at line 180 of file QwLog.h.

Referenced by endl(), operator()(), operator<<(), and QwLog().

bool QwLog::fPrintFunctionSignature

private

Flag to print function signature on warning or error.

Definition at line 183 of file QwLog.h.

Referenced by operator()(), ProcessOptions(), and QwLog().

std::ostream* QwLog::fScreen

private

Definition at line 175 of file QwLog.h.

Referenced by endl(), flush(), operator()(), operator<<(), and QwLog().

bool QwLog::fScreenAtNewLine = true

staticprivate

Definition at line 195 of file QwLog.h.

Referenced by endl(), and operator()().

bool QwLog::fScreenInColor = false

staticprivate

Definition at line 194 of file QwLog.h.

Referenced by endl(), and operator()().

QwLogLevel QwLog::fScreenThreshold

private

Screen thresholds and stream.

Definition at line 174 of file QwLog.h.

Referenced by endl(), operator()(), operator<<(), QwLog(), and SetScreenThreshold().

char QwLog::fTimeString[128]

private

Definition at line 171 of file QwLog.h.

Referenced by GetTime().

bool QwLog::fUseColor

private

Flag to disable color.

Definition at line 190 of file QwLog.h.

Referenced by operator()(), QwLog(), and SetScreenColor().

const std::ios_base::openmode QwLog::kAppend = std::ios::app

static

Definition at line 104 of file QwLog.h.

const std::ios_base::openmode QwLog::kTruncate = std::ios::trunc

static

Log file open modes.

Definition at line 103 of file QwLog.h.

Referenced by main().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation