NewLog Class Reference

a small and simple logging system. More...

#include "LogNew.h"

Inheritance diagram for NewLog:

Collaboration diagram for NewLog:

Public Member Functions
	NewLog ()
	Primary constructor, initializes logging. More...
	NewLog (std::string logPath)
	~NewLog ()
	Destructor, closes the logfile. More...
void	Initialize ()
void	InitializeLogging (std::string logPath)
	Initializes and sets the Log file path. More...
void	Log (const char *source, const char *fmt,...)
	Logs a message to file. More...
void	Error (const char *source, const char *fmt,...)
	Logs error message to console and file. More...
void	Warning (const char *source, const char *fmt,...)
	Logs a warning message to file. More...
void	White (const char *source, const char *fmt,...)
	Logs a message to console in white. More...
void	Green (const char *source, const char *fmt,...)
	Logs a message to console in green. More...
void	Blue (const char *source, const char *fmt,...)
	Logs a message to console in blue. More...
void	Magenta (const char *source, const char *fmt,...)
	Logs a message to console in magenta. More...
void	Yellow (const char *source, const char *fmt,...)
	Logs a message to console in yellow. More...
void	Cyan (const char *source, const char *fmt,...)
	Logs a message to console in cyan. More...
void	Debug (const char *source, const char *fmt,...)
	Logs a debug message to file and console. More...
bool	SetLogfile (const char *filename)
	Sets the logfile to be used. More...
bool	SetLogfile (FILE *file)
	Sets the logfile to be used. More...
void	SetTime (time_t time)
	Sets the log system time every main loop. More...
Public Member Functions inherited from Singleton< NewLog >
	Singleton ()
	Primary constructor. More...

Protected Types
enum	Color {   COLOR_DEFAULT, COLOR_BLACK, COLOR_RED, COLOR_GREEN,   COLOR_YELLOW, COLOR_BLUE, COLOR_MAGENTA, COLOR_CYAN,   COLOR_WHITE, COLOR_COUNT }
	A convenience color enum. More...

Protected Member Functions
void	PrintMsg (Color color, char pfx, const char *source, const char *fmt, va_list ap)
	Prints a message. More...
void	PrintTime ()
	Prints current time. More...
void	Print (const char *fmt,...)
	Prints a raw message. More...
void	PrintVa (const char *fmt, va_list ap)
	Prints a raw message. More...
void	SetColor (Color color)
	Sets the color of the output text. More...
void	SetLogfileDefault (std::string logPath)
	Sets the default logfile. More...

Protected Attributes
FILE *	mLogfile
	The active logfile. More...
time_t	mTime
	Current timestamp. More...
Mutex	mMutex
	Protection against concurrent log messages. More...
bool	m_initialized

Static Protected Attributes
static const char *const	COLOR_TABLE [COLOR_COUNT]
	Color translation table. More...
Static Protected Attributes inherited from Singleton< NewLog >
static std::shared_ptr< NewLog >	mInstance

Additional Inherited Members
Static Public Member Functions inherited from Singleton< NewLog >
static NewLog &	get ()

Detailed Description

a small and simple logging system.

This class is designed to be a simple logging system that both logs to file and console regarding the settings.

Author

Captnoord.

Date

August 2009

Definition at line 41 of file LogNew.h.

Member Enumeration Documentation

enum NewLog::Color

protected

A convenience color enum.

Enumerator
COLOR_DEFAULT	A default color.
COLOR_BLACK	Black color.
COLOR_RED	Red color.
COLOR_GREEN	Green color.
COLOR_YELLOW	Yellow color.
COLOR_BLUE	Blue color.
COLOR_MAGENTA	Magenta color.
COLOR_CYAN	Cyan color.
COLOR_WHITE	White color.
COLOR_COUNT	Number of colors.

Definition at line 162 of file LogNew.h.

    {
        COLOR_DEFAULT, 
        COLOR_BLACK,   
        COLOR_RED,     
        COLOR_GREEN,   
        COLOR_YELLOW,  
        COLOR_BLUE,    
        COLOR_MAGENTA, 
        COLOR_CYAN,    
        COLOR_WHITE,   

        COLOR_COUNT    
    };

Constructor & Destructor Documentation

NewLog::NewLog

(

)

Primary constructor, initializes logging.

Definition at line 48 of file LogNew.cpp.

References m_initialized, and SetLogfileDefault().

: mLogfile( NULL ),
  mTime( 0 ),
  m_initialized(false)
{
    // open default logfile
    std::string logPath = EVEMU_ROOT "/logs/";
    SetLogfileDefault(logPath);

    m_initialized = true;
}

Here is the call graph for this function:

NewLog::NewLog

(

std::string

logPath

)

Definition at line 60 of file LogNew.cpp.

References m_initialized, and SetLogfileDefault().

: mLogfile( NULL ),
mTime( 0 )
{
    // open default logfile
    if( logPath.empty() )
        logPath = EVEMU_ROOT "/logs/";

    SetLogfileDefault(logPath);

    m_initialized = true;
}

Here is the call graph for this function:

NewLog::~NewLog

(

)

Destructor, closes the logfile.

Definition at line 74 of file LogNew.cpp.

References Debug(), and SetLogfile().

{
    Debug( "Log", "Log system shutting down" );

    // close logfile
    SetLogfile( (FILE*)NULL );
}

Here is the call graph for this function:

Member Function Documentation

void NewLog::Blue	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a message to console in blue.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 161 of file LogNew.cpp.

References COLOR_BLUE, and PrintMsg().

Referenced by Initialize().

{
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_BLUE, 'B', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void NewLog::Cyan	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a message to console in cyan.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 141 of file LogNew.cpp.

References COLOR_CYAN, and PrintMsg().

{
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_CYAN, 'C', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

void NewLog::Debug	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a debug message to file and console.

Optimized out on a release build.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 191 of file LogNew.cpp.

References COLOR_WHITE, is_log_enabled, and PrintMsg().

Referenced by ~NewLog().

{
    if (!is_log_enabled(DEBUG__DEBUG))
        return;
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_WHITE, 'D', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void NewLog::Error	(	const char *	source,
		const char *	fmt,
			...
	)

Logs error message to console and file.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the error message itself.

Definition at line 121 of file LogNew.cpp.

References COLOR_RED, and PrintMsg().

{
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_RED, 'E', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

void NewLog::Green	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a message to console in green.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 151 of file LogNew.cpp.

References COLOR_GREEN, and PrintMsg().

{
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_GREEN, 'G', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

void NewLog::Initialize

(

)

Definition at line 82 of file LogNew.cpp.

References Blue().

{
    Blue("       Log System", "Log System Initialized.");
}

Here is the call graph for this function:

void NewLog::InitializeLogging

(

std::string

logPath

)

Initializes and sets the Log file path.

Parameters

[in]

logPath

is the absolute or relative path where log files are to be stored

Definition at line 88 of file LogNew.cpp.

References m_initialized, and SetLogfileDefault().

{
    // open default logfile
    if( logPath.empty() )
        logPath = EVEMU_ROOT "/logs/";

    m_initialized = true;

    SetLogfileDefault(logPath);
}

Here is the call graph for this function:

void NewLog::Log	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a message to file.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 99 of file LogNew.cpp.

References COLOR_DEFAULT, and PrintMsg().

{
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_DEFAULT, 'L', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

void NewLog::Magenta	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a message to console in magenta.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 171 of file LogNew.cpp.

References COLOR_MAGENTA, and PrintMsg().

{
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_MAGENTA, 'M', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

void NewLog::Print ( const char *  fmt,   ...  )

protected

Prints a raw message.

This method only handles printing to all desired destinations (standard output and logfile at the moment).

Parameters

[in]	fmt	The format string.
[in]	...	The arguments.

Definition at line 269 of file LogNew.cpp.

References PrintVa().

Referenced by PrintMsg(), and PrintTime().

{
    va_list ap;
    va_start( ap, fmt );

    PrintVa( fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void NewLog::PrintMsg ( Color  color, char  pfx, const char *  source, const char *  fmt, va_list  ap  )

protected

Prints a message.

This prints a generic message.

Parameters

[in]	color	Color of the message.
[in]	pfx	Single-character prefix/identificator.
[in]	source	Origin of message.
[in]	fmt	The format string.
[in]	ap	The arguments.

Definition at line 230 of file LogNew.cpp.

References COLOR_DEFAULT, COLOR_WHITE, m_initialized, mMutex, Print(), PrintTime(), PrintVa(), and SetColor().

Referenced by Blue(), Cyan(), Debug(), Error(), Green(), Log(), Magenta(), Warning(), White(), and Yellow().

{
    if( !m_initialized )
        return;

    MutexLock l( mMutex );

    PrintTime();

    SetColor( color );
    Print( " %c ", pfx );

    if( source && *source )
    {
        SetColor( COLOR_WHITE );
        Print( "%s: ", source );

        SetColor( color );
    }

    PrintVa( fmt, ap );
    Print( "\n" );

    SetColor( COLOR_DEFAULT );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void NewLog::PrintTime ( )

protected

Prints current time.

Definition at line 256 of file LogNew.cpp.

References localtime_r(), mMutex, mTime, Print(), and SetTime().

Referenced by PrintMsg().

{
    MutexLock l( mMutex );

    // this will be replaced my a timing thread somehow
    SetTime( time( NULL ) );

    tm t;
    localtime_r( &mTime, &t );

    Print( "%02u:%02u:%02u", t.tm_hour, t.tm_min, t.tm_sec );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void NewLog::PrintVa ( const char *  fmt, va_list  ap  )

protected

Prints a raw message.

This method only handles printing to all desired destinations (standard output and logfile at the moment).

Parameters

[in]	fmt	The format string.
[in]	ap	The arguments.

Definition at line 279 of file LogNew.cpp.

References mLogfile, mMutex, and va_copy.

Referenced by Print(), and PrintMsg().

{
    MutexLock l( mMutex );

    if( NULL != mLogfile )
    {
        // this is a design flaw ( UNIX related )
        va_list ap2;
        va_copy( ap2, ap );

        vfprintf( mLogfile, fmt, ap2 );

#ifndef NDEBUG
        // flush immediately so logfile is accurate if we crash
        fflush( mLogfile );
#endif /* !NDEBUG */

        va_end( ap2 );
    }

    vprintf( fmt, ap );
}

Here is the caller graph for this function:

void NewLog::SetColor ( Color  color )

protected

Sets the color of the output text.

Parameters

[in]

color

The new color of output text.

Definition at line 302 of file LogNew.cpp.

References COLOR_COUNT, COLOR_TABLE, and mMutex.

Referenced by PrintMsg().

{
    assert( 0 <= color && color < COLOR_COUNT );

    MutexLock l( mMutex );

#ifdef HAVE_WINDOWS_H
    ::SetConsoleTextAttribute( mStdOutHandle, COLOR_TABLE[ color ] );
#else /* !HAVE_WINDOWS_H */
    ::fputs( COLOR_TABLE[ color ], stdout );
#endif /* !HAVE_WINDOWS_H */
}

Here is the caller graph for this function:

bool NewLog::SetLogfile

(

const char *

filename

)

Sets the logfile to be used.

Parameters

[in]

filename

A name of file.

Return values

true	The new logfile was successfully opened.
false	Failed to open the new logfile.

Definition at line 203 of file LogNew.cpp.

References mMutex.

Referenced by SetLogfileDefault(), and ~NewLog().

{
    MutexLock l( mMutex );

    FILE* file = NULL;

    if( NULL != filename )
    {
        file = fopen( filename, "w" );
        if( NULL == file )
            return false;
    }

    return SetLogfile( file );
}

Here is the caller graph for this function:

bool NewLog::SetLogfile

(

FILE *

file

)

Sets the logfile to be used.

Passed file is closed during destruction.

Parameters

[in]

file

A handle to file.

Return values

true	The new logfile was successfully opened.
false	Failed to open the new logfile.

Definition at line 219 of file LogNew.cpp.

References mLogfile, and mMutex.

{
    MutexLock l( mMutex );

    if( NULL != mLogfile )
        assert( 0 == fclose( mLogfile ) );

    mLogfile = file;
    return true;
}

void NewLog::SetLogfileDefault ( std::string  logPath )

protected

Sets the default logfile.

Definition at line 315 of file LogNew.cpp.

References localtime_r(), mMutex, mTime, SetLogfile(), SetTime(), snprintf, and Warning().

Referenced by InitializeLogging(), and NewLog().

{
    MutexLock l( mMutex );

    // set initial log system time
    SetTime( time( NULL ) );

    tm t;
    localtime_r( &mTime, &t );

    // open default logfile
    char filename[ FILENAME_MAX + 1 ];
    std::string logFile = logPath + "%02u-%02u-%04u-%02u-%02u.log";
    snprintf( filename, FILENAME_MAX + 1, logFile.c_str(),
              t.tm_mday, t.tm_mon + 1, t.tm_year + 1900, t.tm_hour, t.tm_min );
    //snprintf( filename, FILENAME_MAX + 1, EVEMU_ROOT "/logs/%02u-%02u-%04u-%02u-%02u.log",
    //          t.tm_mday, t.tm_mon + 1, t.tm_year + 1900, t.tm_hour, t.tm_min );

    // this isnt accurate as log system is not initalized yet.  all Print calls will fail
    if (!SetLogfile(filename))
        Warning( "Log", "Unable to open logfile '%s': %s", filename, strerror( errno ) );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void NewLog::SetTime ( time_t  time )

inline

Sets the log system time every main loop.

Parameters

[in]

time

is the timestamp.

Definition at line 158 of file LogNew.h.

References mTime.

Referenced by PrintTime(), and SetLogfileDefault().

{ mTime = time; }

Here is the caller graph for this function:

void NewLog::Warning	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a warning message to file.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 131 of file LogNew.cpp.

References COLOR_YELLOW, and PrintMsg().

Referenced by SetLogfileDefault().

{
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_YELLOW, 'W', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void NewLog::White	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a message to console in white.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 109 of file LogNew.cpp.

References COLOR_WHITE, is_log_enabled, and PrintMsg().

{
    if (!is_log_enabled(DEBUG__DEV_LOG))
        return;
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_WHITE, 'W', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

void NewLog::Yellow	(	const char *	source,
		const char *	fmt,
			...
	)

Logs a message to console in yellow.

Parameters

[in]	source	is the source from where the message is printed.
[in]	fmt	is the message itself.

Definition at line 181 of file LogNew.cpp.

References COLOR_YELLOW, and PrintMsg().

{
    va_list ap;
    va_start( ap, fmt );

    PrintMsg( COLOR_YELLOW, 'Y', source, fmt, ap );

    va_end( ap );
}

Here is the call graph for this function:

Member Data Documentation

const char *const NewLog::COLOR_TABLE

staticprotected

Initial value:

=
{
    "\033[" "00"    "m", 
    "\033[" "30;22" "m", 
    "\033[" "31;22" "m", 
    "\033[" "32;22" "m", 
    "\033[" "33;01" "m", 
    "\033[" "34;01" "m", 
    "\033[" "35;22" "m", 
    "\033[" "36;01" "m", 
    "\033[" "37;01" "m"  
}

Color translation table.

Definition at line 245 of file LogNew.h.

Referenced by SetColor().

bool NewLog::m_initialized

protected

Definition at line 233 of file LogNew.h.

Referenced by InitializeLogging(), NewLog(), and PrintMsg().

FILE* NewLog::mLogfile

protected

The active logfile.

Definition at line 227 of file LogNew.h.

Referenced by PrintVa(), and SetLogfile().

Mutex NewLog::mMutex

protected

Protection against concurrent log messages.

Definition at line 231 of file LogNew.h.

Referenced by PrintMsg(), PrintTime(), PrintVa(), SetColor(), SetLogfile(), and SetLogfileDefault().

time_t NewLog::mTime

protected

Current timestamp.

Definition at line 229 of file LogNew.h.

Referenced by PrintTime(), SetLogfileDefault(), and SetTime().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/log/LogNew.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/log/LogNew.cpp