#include <einhard.hpp>

template<LogLevel MAX = ALL>
class einhard::Logger< MAX >

A Logger object can be used to output messages to stdout.

The Logger object is created with a certain verbosity. All messages of a more verbose LogLevel will be filtered out. The way the class is build this can happen at compile time up to the level restriction given by the template parameter.

The class can automatically detect non-tty output and will not colorize output in that case.

Definition at line 347 of file einhard.hpp.

Public Member Functions
	Logger (const LogLevel verbosity=WARN)
	Create a new Logger object. More...

	Logger (const LogLevel verbosity, const bool colorize)
	Create a new Logger object explicitly selecting whether to colorize the output or not. More...

void	setAreaName (const char *name)
	Set an area name. More...

EINHARD_ALWAYS_INLINE_ void	setAreaName (const std::string &name)

OutputFormatter	trace () const
	Access to the trace message stream. More...

template<typename... Ts>
void	trace (Ts &&... args) const noexcept

OutputFormatter	debug () const
	Access to the debug message stream. More...

template<typename... Ts>
void	debug (Ts &&... args) const noexcept

OutputFormatter	info () const
	Access to the info message stream. More...

template<typename... Ts>
void	info (Ts &&... args) const noexcept

OutputFormatter	warn () const
	Access to the warning message stream. More...

template<typename... Ts>
void	warn (Ts &&... args) const noexcept

OutputFormatter	error () const
	Access to the error message stream. More...

template<typename... Ts>
void	error (Ts &&... args) const noexcept

OutputFormatter	fatal () const
	Access to the fatal message stream. More...

template<typename... Ts>
void	fatal (Ts &&... args) const noexcept
	Will print stacktrace. More...

template<LogLevel LEVEL>
bool	isEnabled () const noexcept

void	setVerbosity (LogLevel verbosity) noexcept
	Modify the verbosity of the Logger. More...

LogLevel	getVerbosity () const noexcept
	Retrieve the current log level. More...

char const *	getVerbosityString () const
	Retrieve a human readable representation of the current log level. More...

void	setColorize (bool colorize) noexcept
	Select whether the output stream should be colorized. More...

bool	getColorize () const noexcept
	Check whether the output stream is colorized. More...

Private Attributes
char	areaName [32 - sizeof(LogLevel) - sizeof(bool)] = {'\0'}

LogLevel	verbosity

bool	colorize_stdout

bool	colorize_stderr

Constructor & Destructor Documentation

◆ Logger() [1/2]

template<LogLevel MAX = ALL>

einhard::Logger< MAX >::Logger ( const LogLevel verbosity = WARN )

inline

Create a new Logger object.

The object will automatically colorize output on ttys and not colorize output on non ttys.

Definition at line 362 of file einhard.hpp.

                                                       : verbosity( verbosity )
             {
                 // use some, sadly not c++-ways to figure out whether we are writing ot a terminal
                 // only colorize when we are writing ot a terminal
                 colorize_stdout = isatty( fileno( stdout ) );
                 colorize_stderr = isatty( fileno( stderr ) );
             };

◆ Logger() [2/2]

template<LogLevel MAX = ALL>

einhard::Logger< MAX >::Logger	(	const LogLevel	verbosity,
		const bool	colorize
	)

inline

Create a new Logger object explicitly selecting whether to colorize the output or not.

Be aware that if output colorization is selected output will even be colorized if output is to a non tty.

Definition at line 375 of file einhard.hpp.

376 : verbosity( verbosity ), colorize_stdout( colorize ), colorize_stderr( colorize ) {};

Member Function Documentation

◆ setAreaName() [1/2]

template<LogLevel MAX = ALL>

void einhard::Logger< MAX >::setAreaName ( const char * name )

inline

Set an area name.

This will be printed after the LogLevel to identify the place in the code where the output is coming from. This can be used to identify the different Logger objects in the log output.

Parameters

name	A string. Only the first 30, or so, characters will be used. The rest will not be displayed. You can reset the name with an empty string.

Warning: Passing a nullptr is not allowed!

Definition at line 387 of file einhard.hpp.

             {
                 assert( name );
                 std::strncpy( &areaName[0], name, sizeof( areaName ) - 1 );
                 areaName[sizeof( areaName ) - 1] = '\0';
             }

◆ setAreaName() [2/2]

template<LogLevel MAX = ALL>

EINHARD_ALWAYS_INLINE_ void einhard::Logger< MAX >::setAreaName ( const std::string & name )

inline

Definition at line 394 of file einhard.hpp.

             {
                 setAreaName(name.c_str());
             }

◆ trace() [1/2]

template<LogLevel MAX = ALL>

OutputFormatter einhard::Logger< MAX >::trace ( ) const

inline

Access to the trace message stream.

Definition at line 410 of file einhard.hpp.

             {
                 return {isEnabled<TRACE>(), colorize_stdout, areaName,
                     std::integral_constant<LogLevel, TRACE>()};
             }

◆ trace() [2/2]

template<LogLevel MAX = ALL>

template<typename... Ts>

void einhard::Logger< MAX >::trace ( Ts &&... args ) const

inlinenoexcept

Definition at line 416 of file einhard.hpp.

             {
                 if( isEnabled<TRACE>() )
                 {
                     UnconditionalOutput o{colorize_stdout, areaName,
                                   std::integral_constant<LogLevel, TRACE>()};
                     auto &&unused = {&( o << args )...};
                     o.doCleanup();
                 }
             }

◆ debug() [1/2]

template<LogLevel MAX = ALL>

OutputFormatter einhard::Logger< MAX >::debug ( ) const

inline

Access to the debug message stream.

Definition at line 437 of file einhard.hpp.

             {
                 return {isEnabled<DEBUG>(), colorize_stdout, areaName,
                     std::integral_constant<LogLevel, DEBUG>()};
             }

◆ debug() [2/2]

template<LogLevel MAX = ALL>

template<typename... Ts>

void einhard::Logger< MAX >::debug ( Ts &&... args ) const

inlinenoexcept

Definition at line 442 of file einhard.hpp.

             {
                 if( isEnabled<DEBUG>() )
                 {
                     UnconditionalOutput o{colorize_stdout, areaName,
                               std::integral_constant<LogLevel, DEBUG>()};
                     auto &&unused = {&( o << args )...};
                     o.doCleanup();
                 }
             }

◆ info() [1/2]

template<LogLevel MAX = ALL>

OutputFormatter einhard::Logger< MAX >::info ( ) const

inline

Access to the info message stream.

Definition at line 454 of file einhard.hpp.

             {
                 return {isEnabled<INFO>(), colorize_stdout, areaName,
                     std::integral_constant<LogLevel, INFO>()};
             }

◆ info() [2/2]

template<LogLevel MAX = ALL>

template<typename... Ts>

void einhard::Logger< MAX >::info ( Ts &&... args ) const

inlinenoexcept

Definition at line 459 of file einhard.hpp.

             {
                 if( isEnabled<INFO>() )
                 {
                     UnconditionalOutput o{colorize_stdout, areaName,
                               std::integral_constant<LogLevel, INFO>()};
                     auto &&unused = {&( o << args )...};
                     o.doCleanup();
                 }
             }

◆ warn() [1/2]

template<LogLevel MAX = ALL>

OutputFormatter einhard::Logger< MAX >::warn ( ) const

inline

Access to the warning message stream.

Definition at line 470 of file einhard.hpp.

             {
                 return {isEnabled<WARN>(), colorize_stderr, areaName,
                     std::integral_constant<LogLevel, WARN>(), stderr};
             }

◆ warn() [2/2]

template<LogLevel MAX = ALL>

template<typename... Ts>

void einhard::Logger< MAX >::warn ( Ts &&... args ) const

inlinenoexcept

Definition at line 475 of file einhard.hpp.

             {
                 if( isEnabled<WARN>() )
                 {
                     UnconditionalOutput o{colorize_stderr, areaName,
                               std::integral_constant<LogLevel, WARN>()};
                     auto &&unused = {&( o << args )...};
                     o.doCleanup(stderr);
                 }
             }

◆ error() [1/2]

template<LogLevel MAX = ALL>

OutputFormatter einhard::Logger< MAX >::error ( ) const

inline

Access to the error message stream.

Definition at line 486 of file einhard.hpp.

             {
                 return {isEnabled<ERROR>(), colorize_stderr, areaName,
                     std::integral_constant<LogLevel, ERROR>(), stderr};
             }

◆ error() [2/2]

template<LogLevel MAX = ALL>

template<typename... Ts>

void einhard::Logger< MAX >::error ( Ts &&... args ) const

inlinenoexcept

Definition at line 491 of file einhard.hpp.

             {
                 if( isEnabled<ERROR>() )
                 {
                     UnconditionalOutput o{colorize_stderr, areaName,
                               std::integral_constant<LogLevel, ERROR>()};
                     auto &&unused = {&( o << args )...};
                     o.doCleanup(stderr);
                 }
             }

◆ fatal() [1/2]

template<LogLevel MAX = ALL>

OutputFormatter einhard::Logger< MAX >::fatal ( ) const

inline

Access to the fatal message stream.

Definition at line 502 of file einhard.hpp.

             {
                 return {isEnabled<FATAL>(), colorize_stderr, areaName,
                     std::integral_constant<LogLevel, FATAL>(), stderr};
             }

◆ fatal() [2/2]

template<LogLevel MAX = ALL>

template<typename... Ts>

void einhard::Logger< MAX >::fatal ( Ts &&... args ) const

inlinenoexcept

Will print stacktrace.

Definition at line 508 of file einhard.hpp.

             {
                 if( isEnabled<FATAL>() )
                 {
                     UnconditionalOutput o{colorize_stderr, areaName,
                               std::integral_constant<LogLevel, FATAL>()};
                     auto &&unused = {&( o << args )...};
                     o.doCleanup(stderr);
                     print_stacktrace(stderr, 63, 2);
                 }
             }

◆ isEnabled()

template<LogLevel MAX = ALL>

template<LogLevel LEVEL>

bool einhard::Logger< MAX >::isEnabled ( ) const

inlinenoexcept

Definition at line 520 of file einhard.hpp.

             {
 #ifdef NDEBUG
                 if( LEVEL == DEBUG || LEVEL == TRACE ) {
                     return false;
                 }
 #endif
                 return ( MAX <= LEVEL && verbosity <= LEVEL );
             }

◆ setVerbosity()

template<LogLevel MAX = ALL>

void einhard::Logger< MAX >::setVerbosity ( LogLevel verbosity )

inlinenoexcept

Modify the verbosity of the Logger.

Be aware that the verbosity can not be increased over the level given by the template parameter

Definition at line 535 of file einhard.hpp.

             {
                 this->verbosity = verbosity;
             }

◆ getVerbosity()

template<LogLevel MAX = ALL>

LogLevel einhard::Logger< MAX >::getVerbosity ( ) const

inlinenoexcept

Retrieve the current log level.

If you want to check whether messages of a certain LogLevel will be output the method isEnabled() should be preffered.

Definition at line 545 of file einhard.hpp.

             {
                 return this->verbosity;
             }

◆ getVerbosityString()

template<LogLevel MAX = ALL>

char const* einhard::Logger< MAX >::getVerbosityString ( ) const

inline

Retrieve a human readable representation of the current log level.

Definition at line 552 of file einhard.hpp.

             {
                 return getLogLevelString(verbosity);
             }

◆ setColorize()

template<LogLevel MAX = ALL>

void einhard::Logger< MAX >::setColorize ( bool colorize )

inlinenoexcept

Select whether the output stream should be colorized.

Definition at line 559 of file einhard.hpp.

             {
                 this->colorize_stdout = colorize;
                 this->colorize_stderr = colorize;
             }

◆ getColorize()

template<LogLevel MAX = ALL>

bool einhard::Logger< MAX >::getColorize ( ) const

inlinenoexcept

Check whether the output stream is colorized.

Definition at line 567 of file einhard.hpp.

             {
                 return this->colorize_stdout || this->colorize_stderr;
             }

Member Data Documentation

◆ areaName

template<LogLevel MAX = ALL>

char einhard::Logger< MAX >::areaName[32 - sizeof(LogLevel) - sizeof(bool)] = {'\0'}

private

Definition at line 350 of file einhard.hpp.

◆ verbosity

template<LogLevel MAX = ALL>

LogLevel einhard::Logger< MAX >::verbosity

private

Definition at line 351 of file einhard.hpp.

◆ colorize_stdout

template<LogLevel MAX = ALL>

bool einhard::Logger< MAX >::colorize_stdout

private

Definition at line 352 of file einhard.hpp.

◆ colorize_stderr

template<LogLevel MAX = ALL>

bool einhard::Logger< MAX >::colorize_stderr

private

Definition at line 353 of file einhard.hpp.

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

3rdparty/einhard/einhard.hpp

template<LogLevel MAX = ALL> class einhard::Logger< MAX >

Public Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ Logger() [1/2]

◆ Logger() [2/2]

Member Function Documentation

◆ setAreaName() [1/2]

◆ setAreaName() [2/2]

◆ trace() [1/2]

◆ trace() [2/2]

◆ debug() [1/2]

◆ debug() [2/2]

◆ info() [1/2]

◆ info() [2/2]

◆ warn() [1/2]

◆ warn() [2/2]

◆ error() [1/2]

◆ error() [2/2]

◆ fatal() [1/2]

◆ fatal() [2/2]

◆ isEnabled()

◆ setVerbosity()

◆ getVerbosity()

◆ getVerbosityString()

◆ setColorize()

◆ getColorize()

Member Data Documentation

◆ areaName

◆ verbosity

◆ colorize_stdout

◆ colorize_stderr

template<LogLevel MAX = ALL>
class einhard::Logger< MAX >