Phoenix Logger. More...

#include <PLog.h>

Collaboration diagram for PLog:

Public Types
enum	Level { DEBUG = 1 , INFO = 2 , WARNING = 3 , ERROR = 4 , CRITICAL = 5 , ALWAYS = 6 }
	Log level to be used in the logger. More...

enum	Mode { FILE_ONLY , STRING_ONLY , STDOUT_ONLY , FILE_CAPTURE_STDOUT_STDERR , DISABLE }
	Mode to be used on the logger. More...

Public Member Functions
void	appendLog (std::stringstream &str)
	Append the log (STRING_ONLY mode) into an other log. More...

void	clear ()
	Clear the children of the current PLog. More...

void	close ()
	Close the current PLog and its children. More...

const PPath &	getFileName () const
	Get the filename of the current log. More...

std::ostream &	getLog (PLog::Level logLevel=PLog::INFO)
	Write log into the PLog. More...

PLog &	getLog (size_t threadIndex)
	Get the PLog at given index. More...

std::ostream &	getLogAlways ()
	Write always message into the PLog. More...

std::ostream &	getLogCritical ()
	Write critical message into the PLog. More...

std::ostream &	getLogDebug ()
	Write debug message into the PLog. More...

std::ostream &	getLogError ()
	Write error message into the PLog. More...

std::ofstream &	getLogFile ()
	Get the current log file. More...

std::ostream &	getLogInfo ()
	Write info message into the PLog. More...

PLog::Level	getLogLevel () const
	Get the log level of the current PLog. More...

std::stringstream &	getLogString ()
	Get the log string. More...

std::ostream &	getLogWarning ()
	Write warning message into the PLog. More...

PLog::Mode	getMode () const
	Get the mode of the current PLog. More...

size_t	getThreadIndex () const
	Get the thread index of the current PLog. More...

bool	isOpen () const
	Say if the current PLog is opened or not. More...

bool	open ()
	Open the current PLog and its children. More...

	PLog ()
	Default constructor of PLog. More...

void	resize (size_t nbThread)
	Resize the number of cihldren log file. More...

void	setFileName (const PPath &fileName)
	Set the output filename of the current PLog. More...

void	setLogLevel (PLog::Level logLevel)
	Set the log level of the current PLog. More...

void	setMode (PLog::Mode mode)
	Set the mode of the current PLog. More...

void	setThreadIndex (size_t threadIndex)
	Set the thread index of the current PLog. More...

virtual	~PLog ()
	Destructor of PLog. More...

Private Member Functions
void	allocateStream (std::streambuf *buffer)
	Allocate the stream. More...

void	initialisationPLog ()
	Initialisation function of the class PLog. More...

bool	streamOpen ()
	Open the streams. More...

Private Attributes
PPath	p_fileName
	Output filename of the current PLog. More...

bool	p_isOpen
	True of the log is opened. More...

std::ofstream	p_logFile
	Current log file to be used. More...

PLog::Level	p_logLevel
	Current log level of the PLog (all log greater or equal to the p_logLevel will be logged) More...

std::stringstream	p_logString
	Log string. More...

PLog::Mode	p_mode
	Mode of the logger. More...

std::ostream *	p_nullStream
	Stream used to disable log output. More...

std::streambuf *	p_oldStdCerrBuffer
	Old std::cerr buffer. More...

std::streambuf *	p_oldStdCoutBuffer
	Old std::cout buffer. More...

std::ostream *	p_stream
	Current stream to be used to log things. More...

size_t	p_threadIndex
	Index of the current thread. More...

std::vector< PLog * >	p_vecLog
	Vector of sur log file to be used (mainly for multithreaded programs) More...

Detailed Description

Phoenix Logger.

Definition at line 21 of file PLog.h.

Member Enumeration Documentation

◆ Level

enum PLog::Level

Log level to be used in the logger.

Enumerator
DEBUG
INFO
WARNING
ERROR
CRITICAL
ALWAYS

Definition at line 32 of file PLog.h.

                           {
                         DEBUG = 1,
                         INFO = 2,
                         WARNING = 3,
                         ERROR = 4,
                         CRITICAL = 5,
                         ALWAYS = 6
                 };

◆ Mode

enum PLog::Mode

Mode to be used on the logger.

Enumerator
FILE_ONLY
STRING_ONLY
STDOUT_ONLY
FILE_CAPTURE_STDOUT_STDERR
DISABLE

Definition at line 24 of file PLog.h.

                          {
                         FILE_ONLY,
                         STRING_ONLY,
                         STDOUT_ONLY,
                         FILE_CAPTURE_STDOUT_STDERR,
                         DISABLE
                 };

Constructor & Destructor Documentation

◆ PLog()

PLog::PLog ( )

Default constructor of PLog.

Definition at line 46 of file PLog.cpp.

           {
         initialisationPLog();
 }

References initialisationPLog().

Referenced by resize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~PLog()

PLog::~PLog ( )

virtual

Destructor of PLog.

Definition at line 51 of file PLog.cpp.

            {
         close();
         clear();
         delete p_nullStream;
 }

References clear(), close(), and p_nullStream.

Here is the call graph for this function:

Member Function Documentation

◆ allocateStream()

void PLog::allocateStream ( std::streambuf * buffer )

private

Allocate the stream.

Parameters

buffer : buffer to be used

Definition at line 299 of file PLog.cpp.

                                              {
         if(p_stream != NULL){
                 delete p_stream;
         }
         p_stream = new std::ostream(buffer);
 }

References p_stream.

Referenced by streamOpen().

Here is the caller graph for this function:

◆ appendLog()

void PLog::appendLog ( std::stringstream & str )

Append the log (STRING_ONLY mode) into an other log.

Parameters

str	: log string to be appended

Definition at line 168 of file PLog.cpp.

                                          {
         getLog(PLog::ALWAYS) << "Append log" << std::endl << str.str();
 }

References ALWAYS, and getLog().

Referenced by testStringLogAppend().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void PLog::clear ( )

Clear the children of the current PLog.

Definition at line 153 of file PLog.cpp.

                 {
         if(p_vecLog.size() != 0lu){
                 for(std::vector<PLog*>::iterator it(p_vecLog.begin()); it != p_vecLog.end(); ++it){
                         PLog* log = *it;
                         if(log != NULL){
                                 delete log;
                         }
                 }
                 p_vecLog.clear();
         }
 }

References p_vecLog.

Referenced by resize(), and ~PLog().

Here is the caller graph for this function:

◆ close()

void PLog::close ( )

Close the current PLog and its children.

Definition at line 123 of file PLog.cpp.

                 {
         if(p_stream != NULL && p_isOpen){
                 getLogAlways() << "Close Log File at " << phoenix_getDate() << std::endl;
         }
         if(p_logFile.is_open()){
                 p_logFile.close();
         }
 //      if(p_mode == PLog::STRING_ONLY){
 //              p_logString.close();
 //      }
         if(p_oldStdCerrBuffer != NULL){
                 std::cerr.rdbuf(p_oldStdCerrBuffer);    //Let's get back to previous std::cerr buffer
         }
         if(p_oldStdCoutBuffer != NULL){
                 std::cout.rdbuf(p_oldStdCoutBuffer);    //Let's get back to previous std::cout buffer
         }
         if(p_stream != NULL){
                 delete p_stream;
                 p_stream = NULL;
         }
         p_isOpen = false;
         for(std::vector<PLog*>::iterator it(p_vecLog.begin()); it != p_vecLog.end(); ++it){
                 PLog* log = *it;
                 if(log != NULL){
                         log->close();
                 }
         }
 }

References close(), getLogAlways(), p_isOpen, p_logFile, p_oldStdCerrBuffer, p_oldStdCoutBuffer, p_stream, p_vecLog, and phoenix_getDate().

Referenced by close(), testLogCoutDedirectInFile(), testLogDisable(), testLogStdoutOnly(), testStringLogAppend(), and ~PLog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileName()

const PPath & PLog::getFileName ( ) const

Get the filename of the current log.

Returns: filename of the current log

Definition at line 252 of file PLog.cpp.

                                      {
         return p_fileName;
 }

References p_fileName.

Referenced by testStringPLog(), and testStringPLogLevel().

Here is the caller graph for this function:

◆ getLog() [1/2]

std::ostream & PLog::getLog ( PLog::Level logLevel = PLog::INFO )

Write log into the PLog.

Parameters

logLevel : log level of the current line

Returns: ofstream to be written

Definition at line 197 of file PLog.cpp.

                                            {
         if(logLevel >= p_logLevel){
                 *p_stream << "[" << phoenix_getTime() << "][" << phoenix_getDateCompact() << "][" << p_threadIndex << "]["<<phoenix_logLevelToStr(logLevel)<<"] : ";
                 return *p_stream;
         }else{
                 return *p_nullStream;
         }
 }

References p_logLevel, p_nullStream, p_stream, p_threadIndex, phoenix_getDateCompact(), phoenix_getTime(), and phoenix_logLevelToStr().

Here is the call graph for this function:

◆ getLog() [2/2]

PLog & PLog::getLog ( size_t threadIndex )

Get the PLog at given index.

Returns: PLog at Index

Definition at line 175 of file PLog.cpp.

                                      {
         return *(p_vecLog[threadIndex]);
 }

References p_vecLog.

Referenced by appendLog(), getLogAlways(), getLogCritical(), getLogDebug(), getLogError(), getLogInfo(), getLogWarning(), testLogCoutDedirectInFile(), testLogDisable(), testLogStdoutOnly(), testStringLogAppend(), testStringMultiPLog(), testStringPLog(), and testStringPLogLevel().

Here is the caller graph for this function:

◆ getLogAlways()

std::ostream & PLog::getLogAlways ( )

Write always message into the PLog.

Returns: ofstream to be written

Definition at line 244 of file PLog.cpp.

                                {
         return getLog(PLog::ALWAYS);
 }

References ALWAYS, and getLog().

Referenced by close(), and open().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogCritical()

std::ostream & PLog::getLogCritical ( )

Write critical message into the PLog.

Returns: ofstream to be written

Definition at line 237 of file PLog.cpp.

                                  {
         return getLog(PLog::CRITICAL);
 }

References CRITICAL, and getLog().

Referenced by testStringLogAppend(), and testStringPLogLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogDebug()

std::ostream & PLog::getLogDebug ( )

Write debug message into the PLog.

Returns: ofstream to be written

Definition at line 209 of file PLog.cpp.

                               {
         return getLog(PLog::DEBUG);
 }

References DEBUG, and getLog().

Referenced by testStringLogAppend(), and testStringPLogLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogError()

std::ostream & PLog::getLogError ( )

Write error message into the PLog.

Returns: ofstream to be written

Definition at line 230 of file PLog.cpp.

                               {
         return getLog(PLog::ERROR);
 }

References ERROR, and getLog().

Referenced by testStringLogAppend(), and testStringPLogLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogFile()

std::ofstream & PLog::getLogFile ( )

Get the current log file.

Returns: current log file

Definition at line 182 of file PLog.cpp.

                               {
         return p_logFile;
 }

References p_logFile.

◆ getLogInfo()

std::ostream & PLog::getLogInfo ( )

Write info message into the PLog.

Returns: ofstream to be written

Definition at line 216 of file PLog.cpp.

                              {
         return getLog(PLog::INFO);
 }

References getLog(), and INFO.

Referenced by testStringLogAppend(), and testStringPLogLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogLevel()

PLog::Level PLog::getLogLevel ( ) const

Get the log level of the current PLog.

Returns: log level of the current PLog

Definition at line 266 of file PLog.cpp.

                                  {
         return p_logLevel;
 }

References p_logLevel.

Referenced by open().

Here is the caller graph for this function:

◆ getLogString()

std::stringstream & PLog::getLogString ( )

Get the log string.

Returns: log string

Definition at line 189 of file PLog.cpp.

                                     {
         return p_logString;
 }

References p_logString.

Referenced by testStringLogAppend().

Here is the caller graph for this function:

◆ getLogWarning()

std::ostream & PLog::getLogWarning ( )

Write warning message into the PLog.

Returns: ofstream to be written

Definition at line 223 of file PLog.cpp.

                                 {
         return getLog(PLog::WARNING);
 }

References getLog(), and WARNING.

Referenced by testStringLogAppend(), and testStringPLogLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMode()

PLog::Mode PLog::getMode ( ) const

Get the mode of the current PLog.

Returns: mode of the current PLog

Definition at line 259 of file PLog.cpp.

                             {
         return p_mode;
 }

References p_mode.

◆ getThreadIndex()

size_t PLog::getThreadIndex ( ) const

Get the thread index of the current PLog.

Returns: thread index of the current PLog

Definition at line 273 of file PLog.cpp.

                                  {
         return p_threadIndex;
 }

References p_threadIndex.

Referenced by testStringPLog().

Here is the caller graph for this function:

◆ initialisationPLog()

void PLog::initialisationPLog ( )

private

Initialisation function of the class PLog.

Definition at line 285 of file PLog.cpp.

                              {
         p_mode = PLog::FILE_ONLY;
         p_logLevel = PLog::INFO;
         p_oldStdCerrBuffer = NULL;
         p_oldStdCoutBuffer = NULL;
         p_isOpen = false;
         p_stream = NULL;
         p_nullStream = new std::ostream(NULL);
         p_threadIndex = 0lu;
 }

References FILE_ONLY, INFO, p_isOpen, p_logLevel, p_mode, p_nullStream, p_oldStdCerrBuffer, p_oldStdCoutBuffer, p_stream, and p_threadIndex.

Referenced by PLog().

Here is the caller graph for this function:

◆ isOpen()

bool PLog::isOpen ( ) const

Say if the current PLog is opened or not.

Returns: true if the current PLog is opened, false otherwise

Definition at line 280 of file PLog.cpp.

                        {
         return p_isOpen;
 }

References p_isOpen.

Referenced by testStringPLog().

Here is the caller graph for this function:

◆ open()

bool PLog::open ( )

Open the current PLog and its children.

Returns: true on success, false otherwise

Definition at line 104 of file PLog.cpp.

                {
         bool b(true);
         b &= streamOpen();
         p_isOpen = b;
         if(b){
                 getLogAlways() << "[UTC][Date][ThreadIndex][LogLevel] : log message" << std::endl;
                 getLogAlways() << "Start logging at " << phoenix_getDate() << std::endl;
                 getLogAlways() << "Current logging level '"<<phoenix_logLevelToStr(getLogLevel())<<"'" << std::endl;
         }
         for(std::vector<PLog*>::iterator it(p_vecLog.begin()); it != p_vecLog.end(); ++it){
                 PLog* log = *it;
                 if(log != NULL){
                         b &= log->open();
                 }
         }
         return b;
 }

References getLogAlways(), getLogLevel(), open(), p_isOpen, p_vecLog, phoenix_getDate(), phoenix_logLevelToStr(), and streamOpen().

Referenced by open(), testLogCoutDedirectInFile(), testLogDisable(), testLogStdoutOnly(), testStringLogAppend(), testStringMultiPLog(), testStringPLog(), and testStringPLogLevel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resize()

void PLog::resize ( size_t nbThread )

Resize the number of cihldren log file.

Parameters

nbThread : number of sub log files to be created (typically the number of threads of a program)

Definition at line 88 of file PLog.cpp.

                                 {
         clear();
         p_vecLog.resize(nbThread);
         PString baseFileName(p_fileName.eraseExtension());
         PString extention(p_fileName.getExtension());
         for(size_t i(0lu); i < nbThread; ++i){
                 p_vecLog[i] = new PLog;
                 p_vecLog[i]->setFileName(PString(baseFileName + "_" + PString(valueToString(i)) + "." + extention));
                 p_vecLog[i]->setMode(p_mode);
                 p_vecLog[i]->setLogLevel(p_logLevel);
         }
 }

References clear(), PPath::eraseExtension(), PPath::getExtension(), p_fileName, p_logLevel, p_mode, p_vecLog, PLog(), and valueToString().

Referenced by testStringMultiPLog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFileName()

void PLog::setFileName ( const PPath & fileName )

Set the output filename of the current PLog.

Parameters

fileName : output filename of the current PLog

Definition at line 60 of file PLog.cpp.

                                             {
         p_fileName = fileName;
 }

References p_fileName.

Referenced by testLogCoutDedirectInFile(), testLogDisable(), testLogStdoutOnly(), testStringLogAppend(), testStringMultiPLog(), testStringPLog(), and testStringPLogLevel().

Here is the caller graph for this function:

◆ setLogLevel()

void PLog::setLogLevel ( PLog::Level logLevel )

Set the log level of the current PLog.

Parameters

logLevel : log level of the current PLog

Definition at line 74 of file PLog.cpp.

                                         {
         p_logLevel = logLevel;
 }

References p_logLevel.

Referenced by testStringLogAppend(), and testStringPLogLevel().

Here is the caller graph for this function:

◆ setMode()

void PLog::setMode ( PLog::Mode mode )

Set the mode of the current PLog.

Parameters

mode	: mode of the current PLog

Definition at line 67 of file PLog.cpp.

                                {
         p_mode = mode;
 }

References p_mode.

Referenced by testLogCoutDedirectInFile(), testLogDisable(), testLogStdoutOnly(), and testStringLogAppend().

Here is the caller graph for this function:

◆ setThreadIndex()

void PLog::setThreadIndex ( size_t threadIndex )

Set the thread index of the current PLog.

Parameters

threadIndex : thread index of the current PLog

Definition at line 81 of file PLog.cpp.

                                            {
         p_threadIndex = threadIndex;
 }

References p_threadIndex.

Referenced by testStringLogAppend(), and testStringPLog().

Here is the caller graph for this function:

◆ streamOpen()

bool PLog::streamOpen ( )

private

Open the streams.

Returns: true on success, false otherwise

Definition at line 309 of file PLog.cpp.

                      {
         bool b(true);
         if(p_mode == PLog::FILE_ONLY){
                 p_logFile.open(p_fileName);
                 b &= p_logFile.is_open();
                 if(b){
                         allocateStream(p_logFile.rdbuf());
                 }
         }else if(p_mode == PLog::STRING_ONLY){
                 std::cerr << "PLog::streamOpen : p_logString.rdbuf() = " << p_logString.rdbuf() << std::endl;
                 allocateStream(p_logString.rdbuf());
         }else if(p_mode == PLog::FILE_CAPTURE_STDOUT_STDERR){
                 p_logFile.open(p_fileName);
                 b &= p_logFile.is_open();
                 if(b){
                         p_oldStdCerrBuffer = std::cerr.rdbuf(p_logFile.rdbuf());
                         p_oldStdCoutBuffer = std::cout.rdbuf(p_logFile.rdbuf());
                         allocateStream(p_logFile.rdbuf());
                 }
         }else if(p_mode == PLog::STDOUT_ONLY){
                 allocateStream(std::cout.rdbuf());
         }else if(p_mode == PLog::DISABLE){
                 allocateStream(NULL);
         }
         return b;
 }

References allocateStream(), DISABLE, FILE_CAPTURE_STDOUT_STDERR, FILE_ONLY, p_fileName, p_logFile, p_logString, p_mode, p_oldStdCerrBuffer, p_oldStdCoutBuffer, STDOUT_ONLY, and STRING_ONLY.

Referenced by open().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ p_fileName

PPath PLog::p_fileName

private

Output filename of the current PLog.

Definition at line 80 of file PLog.h.

Referenced by getFileName(), resize(), setFileName(), and streamOpen().

◆ p_isOpen

bool PLog::p_isOpen

private

True of the log is opened.

Definition at line 96 of file PLog.h.

Referenced by close(), initialisationPLog(), isOpen(), and open().

◆ p_logFile

std::ofstream PLog::p_logFile

private

Current log file to be used.

Definition at line 82 of file PLog.h.

Referenced by close(), getLogFile(), and streamOpen().

◆ p_logLevel

PLog::Level PLog::p_logLevel

private

Current log level of the PLog (all log greater or equal to the p_logLevel will be logged)

Definition at line 78 of file PLog.h.

Referenced by getLog(), getLogLevel(), initialisationPLog(), resize(), and setLogLevel().

◆ p_logString

std::stringstream PLog::p_logString

private

Log string.

Definition at line 84 of file PLog.h.

Referenced by getLogString(), and streamOpen().

◆ p_mode

PLog::Mode PLog::p_mode

private

Mode of the logger.

Definition at line 76 of file PLog.h.

Referenced by getMode(), initialisationPLog(), resize(), setMode(), and streamOpen().

◆ p_nullStream

std::ostream* PLog::p_nullStream

private

Stream used to disable log output.

Definition at line 88 of file PLog.h.

Referenced by getLog(), initialisationPLog(), and ~PLog().

◆ p_oldStdCerrBuffer

std::streambuf* PLog::p_oldStdCerrBuffer

private

Old std::cerr buffer.

Definition at line 90 of file PLog.h.

Referenced by close(), initialisationPLog(), and streamOpen().

◆ p_oldStdCoutBuffer

std::streambuf* PLog::p_oldStdCoutBuffer

private

Old std::cout buffer.

Definition at line 92 of file PLog.h.

Referenced by close(), initialisationPLog(), and streamOpen().

◆ p_stream

std::ostream* PLog::p_stream

private

Current stream to be used to log things.

Definition at line 86 of file PLog.h.

Referenced by allocateStream(), close(), getLog(), and initialisationPLog().

◆ p_threadIndex

size_t PLog::p_threadIndex

private

Index of the current thread.

Definition at line 98 of file PLog.h.

Referenced by getLog(), getThreadIndex(), initialisationPLog(), and setThreadIndex().

◆ p_vecLog

std::vector<PLog*> PLog::p_vecLog

private

Vector of sur log file to be used (mainly for multithreaded programs)

Definition at line 94 of file PLog.h.

Referenced by clear(), close(), getLog(), open(), and resize().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixCore/src/PLog.h
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixPresentation/tmp_project/PhoenixBeamerCreator/tmp_project/PhoenixCore/src/PLog.cpp

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Level

◆ Mode

Constructor & Destructor Documentation

◆ PLog()

◆ ~PLog()

Member Function Documentation

◆ allocateStream()

◆ appendLog()

◆ clear()

◆ close()

◆ getFileName()

◆ getLog() [1/2]

◆ getLog() [2/2]

◆ getLogAlways()

◆ getLogCritical()

◆ getLogDebug()

◆ getLogError()

◆ getLogFile()

◆ getLogInfo()

◆ getLogLevel()

◆ getLogString()

◆ getLogWarning()

◆ getMode()

◆ getThreadIndex()

◆ initialisationPLog()

◆ isOpen()

◆ open()

◆ resize()

◆ setFileName()

◆ setLogLevel()

◆ setMode()

◆ setThreadIndex()

◆ streamOpen()

Member Data Documentation

◆ p_fileName

◆ p_isOpen

◆ p_logFile

◆ p_logLevel

◆ p_logString

◆ p_mode

◆ p_nullStream

◆ p_oldStdCerrBuffer

◆ p_oldStdCoutBuffer

◆ p_stream

◆ p_threadIndex

◆ p_vecLog