ConsoleLogger Class Reference

#include <ConsoleLogger.hpp>

Inheritance diagram for ConsoleLogger:

Collaboration diagram for ConsoleLogger:

Public Member Functions
	ConsoleLogger ()=default
	~ConsoleLogger ()
	ConsoleLogger (const ConsoleLogger &)=delete
ConsoleLogger &	operator= (const ConsoleLogger &)=delete
	ConsoleLogger (ConsoleLogger &&other) noexcept
ConsoleLogger &	operator= (ConsoleLogger &&other) noexcept
void	debug (const std::string &message, const std::string &caller="") override
	Log a debug message.
void	info (const std::string &message, const std::string &caller="") override
	Log an info message.
void	warning (const std::string &message, const std::string &caller="") override
	Log a warning message.
void	error (const std::string &message, const std::string &caller="") override
	Log an error message.
void	critical (const std::string &message, const std::string &caller="") override
	Log a critical message.
void	log (dotnamecpp::logging::Level level, const std::string &message, const std::string &caller)
	Logs a message with a specified level to the console and optionally to a file.
void	setLevel (dotnamecpp::logging::Level level) override
	Set the Level object.
dotnamecpp::logging::Level	getLevel () const override
	Get the Level object.
void	setAppPrefix (const std::string &prefix) override
	Set the application prefix for log messages.
std::string	getAppPrefix () const override
	Get the App Prefix object.
bool	enableFileLogging (const std::string &filename) override
	Enable logging to a file.
void	disableFileLogging () override
	Disable logging to a file.
void	setHeaderName (const std::string &headerName)
	Set the Header Name object.
void	showHeaderName (bool includeName)
	Show or hide the header name in the log output.
void	showHeaderTime (bool includeTime)
	Show or hide the header time in the log output.
void	showHeaderCaller (bool includeCaller)
	Show or hide the header caller in the log output.
void	showHeaderLevel (bool includeLevel)
	Show or hide the header level in the log output.
void	noHeader (bool noHeader)
	Show or hide all headers in the log output.
void	visibleHeaders (bool incName, bool incTime, bool incCaller, bool incLevel)
	Show or hide specific headers in the log output.
void	setColorEnabled (bool enabled)
	Enable or disable colored output.
void	setAutoDetectColor (bool autoDetect)
	Enable automatic color detection based on TTY.
Public Member Functions inherited from dotnamecpp::logging::ILogger
	ILogger ()=default
virtual	~ILogger ()=default
LogStream	stream (Level level, const std::string &caller="")
	Create a LogStream for streaming log messages.
LogStream	debugStream (const std::string &caller="")
	Create a LogStream for streaming debug messages.
LogStream	infoStream (const std::string &caller="")
	Create a LogStream for streaming info messages.
LogStream	warningStream (const std::string &caller="")
	Create a LogStream for streaming warning messages.
LogStream	errorStream (const std::string &caller="")
	Create a LogStream for streaming error messages.
LogStream	criticalStream (const std::string &caller="")
	Create a LogStream for streaming critical messages.
template<typename... Args>
void	debugFmt (const std::string &format, Args &&...args)
	Create a formatted debug message.
template<typename... Args>
void	infoFmt (const std::string &format, Args &&...args)
	Create a formatted info message.
template<typename... Args>
void	warningFmt (const std::string &format, Args &&...args)
	Create a formatted warning message.
template<typename... Args>
void	errorFmt (const std::string &format, Args &&...args)
	Create a formatted error message.
template<typename... Args>
void	criticalFmt (const std::string &format, Args &&...args)
	Create a formatted critical message.

Static Public Member Functions
static std::string	levelToString (dotnamecpp::logging::Level level)
	Convert a logging level to its string representation.
static void	resetConsoleColor ()
	Reset the console color to default.
static void	setConsoleColorUnix (dotnamecpp::logging::Level level)
static void	setConsoleColor (dotnamecpp::logging::Level level)

Constructor & Destructor Documentation

ConsoleLogger() [1/3]

ConsoleLogger::ConsoleLogger ( )

default

Here is the caller graph for this function:

~ConsoleLogger()

ConsoleLogger::~ConsoleLogger ( )

inline

ConsoleLogger() [2/3]

ConsoleLogger::ConsoleLogger ( const ConsoleLogger & )

delete

Here is the call graph for this function:

ConsoleLogger() [3/3]

ConsoleLogger::ConsoleLogger ( ConsoleLogger && other )

inlinenoexcept

Here is the call graph for this function:

Member Function Documentation

critical()

void ConsoleLogger::critical ( const std::string & message, const std::string & caller = "" )

inlineoverridevirtual

Log a critical message.

Parameters

message
caller

Implements dotnamecpp::logging::ILogger.

Here is the call graph for this function:

debug()

void ConsoleLogger::debug ( const std::string & message, const std::string & caller = "" )

inlineoverridevirtual

Log a debug message.

Parameters

message
caller

Implements dotnamecpp::logging::ILogger.

Here is the call graph for this function:

disableFileLogging()

void ConsoleLogger::disableFileLogging ( )

inlineoverridevirtual

Disable logging to a file.

Implements dotnamecpp::logging::ILogger.

enableFileLogging()

bool ConsoleLogger::enableFileLogging ( const std::string & filename )

inlineoverridevirtual

Enable logging to a file.

Parameters

filename

Returns

true

false

Implements dotnamecpp::logging::ILogger.

error()

void ConsoleLogger::error ( const std::string & message, const std::string & caller = "" )

inlineoverridevirtual

Log an error message.

Parameters

message
caller

Implements dotnamecpp::logging::ILogger.

Here is the call graph for this function:

getAppPrefix()

std::string ConsoleLogger::getAppPrefix ( ) const

inlinenodiscardoverridevirtual

Get the App Prefix object.

Returns

std::string

Implements dotnamecpp::logging::ILogger.

getLevel()

dotnamecpp::logging::Level ConsoleLogger::getLevel ( ) const

inlinenodiscardoverridevirtual

Get the Level object.

Returns

Level

Implements dotnamecpp::logging::ILogger.

info()

void ConsoleLogger::info ( const std::string & message, const std::string & caller = "" )

inlineoverridevirtual

Log an info message.

Parameters

message
caller

Implements dotnamecpp::logging::ILogger.

Here is the call graph for this function:

Here is the caller graph for this function:

levelToString()

std::string ConsoleLogger::levelToString ( dotnamecpp::logging::Level level )

inlinestatic

Convert a logging level to its string representation.

Parameters

level

Returns

std::string

Here is the caller graph for this function:

log()

void ConsoleLogger::log ( dotnamecpp::logging::Level level, const std::string & message, const std::string & caller )

inline

Logs a message with a specified level to the console and optionally to a file.

Parameters

level
message
caller

Here is the call graph for this function:

Here is the caller graph for this function:

noHeader()

void ConsoleLogger::noHeader ( bool noHeader )

inline

Show or hide all headers in the log output.

Parameters

noHeader

Whether to hide all headers

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

ConsoleLogger & ConsoleLogger::operator= ( ConsoleLogger && other )

inlinenoexcept

Here is the call graph for this function:

operator=() [2/2]

ConsoleLogger & ConsoleLogger::operator= ( const ConsoleLogger & )

delete

Here is the call graph for this function:

resetConsoleColor()

void ConsoleLogger::resetConsoleColor ( )

inlinestatic

Reset the console color to default.

Here is the caller graph for this function:

setAppPrefix()

void ConsoleLogger::setAppPrefix ( const std::string & prefix )

inlineoverridevirtual

Set the application prefix for log messages.

Parameters

prefix

Implements dotnamecpp::logging::ILogger.

setAutoDetectColor()

void ConsoleLogger::setAutoDetectColor ( bool autoDetect )

inline

Enable automatic color detection based on TTY.

Parameters

autoDetect

Whether to auto-detect color support

setColorEnabled()

void ConsoleLogger::setColorEnabled ( bool enabled )

inline

Enable or disable colored output.

Parameters

enabled

Whether to use colored output (overrides auto-detection)

setConsoleColor()

void ConsoleLogger::setConsoleColor ( dotnamecpp::logging::Level level )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

setConsoleColorUnix()

void ConsoleLogger::setConsoleColorUnix ( dotnamecpp::logging::Level level )

inlinestatic

Here is the call graph for this function:

Here is the caller graph for this function:

setHeaderName()

void ConsoleLogger::setHeaderName ( const std::string & headerName )

inline

Set the Header Name object.

Parameters

headerName

Here is the caller graph for this function:

setLevel()

void ConsoleLogger::setLevel ( dotnamecpp::logging::Level level )

inlineoverridevirtual

Set the Level object.

Parameters

level

Implements dotnamecpp::logging::ILogger.

showHeaderCaller()

void ConsoleLogger::showHeaderCaller ( bool includeCaller )

inline

Show or hide the header caller in the log output.

Parameters

includeCaller

Whether to include the header caller

Here is the caller graph for this function:

showHeaderLevel()

void ConsoleLogger::showHeaderLevel ( bool includeLevel )

inline

Show or hide the header level in the log output.

Parameters

includeLevel

Whether to include the header level

Here is the caller graph for this function:

showHeaderName()

void ConsoleLogger::showHeaderName ( bool includeName )

inline

Show or hide the header name in the log output.

Parameters

includeName

Whether to include the header name

Here is the caller graph for this function:

showHeaderTime()

void ConsoleLogger::showHeaderTime ( bool includeTime )

inline

Show or hide the header time in the log output.

Parameters

includeTime

Whether to include the header time

Here is the caller graph for this function:

visibleHeaders()

void ConsoleLogger::visibleHeaders ( bool incName, bool incTime, bool incCaller, bool incLevel )

inline

Show or hide specific headers in the log output.

Parameters

incName
incTime
incCaller
incLevel

Here is the call graph for this function:

warning()

void ConsoleLogger::warning ( const std::string & message, const std::string & caller = "" )

inlineoverridevirtual

Log a warning message.

Parameters

message
caller

Implements dotnamecpp::logging::ILogger.

Here is the call graph for this function:

---

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

• src/Utils/Logger/ConsoleLogger.hpp