Centralized logging system with configurable output and formatting. More...

#include <logger.hpp>

Public Member Functions
	Logger (const Logger &)=delete

	Logger (Logger &&)=delete

	~Logger () noexcept=default

Logger &	operator= (const Logger &)=delete

Logger &	operator= (Logger &&)=delete

template<LoggerTrait T>
void	AddLogger (T logger, LoggerConfig config=LoggerConfigOf< T >()) noexcept
	Adds a logger with the specified type and configuration.

template<LoggerTrait T>
void	RemoveLogger (T logger={}) noexcept
	Removes a logger with the given type.

void	FlushAll () noexcept
	Flushes all registered loggers.

template<LoggerTrait T>
void	Flush (T logger={}) noexcept
	Flushes a specific logger.

template<LoggerTrait T>
void	LogMessage (T logger, LogLevel level, const std::source_location &loc, std::string_view message) noexcept
	Logs a string message with typed logger.

template<LoggerTrait T, typename... Args> requires (sizeof...(Args) > 0)
void	LogMessage (T logger, LogLevel level, const std::source_location &loc, std::format_string< Args... > fmt, Args &&... args) noexcept
	Logs a formatted message with typed logger.

void	LogMessage (LogLevel level, const std::source_location &loc, std::string_view message) noexcept
	Logs a string message with default logger.

template<typename... Args> requires (sizeof...(Args) > 0)
void	LogMessage (LogLevel level, const std::source_location &loc, std::format_string< Args... > fmt, Args &&... args) noexcept
	Logs a formatted message with default logger.

template<LoggerTrait T>
void	LogAssertionFailure (T logger, std::string_view condition, const std::source_location &loc, std::string_view message) noexcept
	Logs assertion failure with typed logger.

template<LoggerTrait T, typename... Args> requires (sizeof...(Args) > 0)
void	LogAssertionFailure (T logger, std::string_view condition, const std::source_location &loc, std::format_string< Args... > fmt, Args &&... args) noexcept
	Logs assertion failure with typed logger (formatted).

void	LogAssertionFailure (std::string_view condition, const std::source_location &loc, std::string_view message) noexcept
	Logs assertion failure with default logger.

template<typename... Args> requires (sizeof...(Args) > 0)
void	LogAssertionFailure (std::string_view condition, const std::source_location &loc, std::format_string< Args... > fmt, Args &&... args) noexcept
	Logs assertion failure with default logger (formatted).

void	SetDefaultConfig (const LoggerConfig &config) noexcept
	Sets the global default configuration for new loggers.

template<LoggerTrait T>
void	SetLevel (T logger, LogLevel level) noexcept
	Sets the minimum log level for a typed logger.

void	SetLevel (LogLevel level) noexcept
	Sets the minimum log level for the default logger.

template<LoggerTrait T>
bool	HasLogger (T logger={}) const noexcept
	Checks if a logger with the given type exists.

bool	ShouldLog (LogLevel level) const noexcept
	Checks if the default logger should log messages at the given level.

template<LoggerTrait T>
bool	ShouldLog (T logger, LogLevel level) const noexcept
	Checks if a typed logger should log messages at the given level.

template<LoggerTrait T>
LogLevel	GetLevel (T logger={}) const noexcept
	Gets the current log level for a typed logger.

LogLevel	GetLevel () const noexcept
	Gets the current log level for the default logger.

const LoggerConfig &	GetDefaultConfig () const noexcept
	Gets the current default configuration.

Static Public Member Functions
static Logger &	GetInstance () noexcept
	Gets the singleton instance.

Detailed Description

Centralized logging system with configurable output and formatting.

Note: Thread-safe.

Definition at line 231 of file logger.hpp.

Constructor & Destructor Documentation

◆ Logger() [1/2]

helios::Logger::Logger ( const Logger & )

delete

◆ Logger() [2/2]

helios::Logger::Logger ( Logger && )

delete

◆ ~Logger()

helios::Logger::~Logger ( )

defaultnoexcept

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Member Function Documentation

◆ AddLogger()

template<LoggerTrait T>

void helios::Logger::AddLogger	(	T	logger,
		LoggerConfig	config = `LoggerConfigOf<T>()`
	)

inlinenoexcept

Adds a logger with the specified type and configuration.

Template Parameters

T	Logger type

Parameters

logger	Logger type instance
config	Configuration for the logger

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 521 of file logger.hpp.

                                                               {
  constexpr LoggerId logger_id = LoggerIdOf<T>();
  constexpr std::string_view logger_name = LoggerNameOf<T>();
 
  const std::scoped_lock lock(loggers_mutex_);
  if (loggers_.contains(logger_id)) [[unlikely]] {
    return;
  }
 
  if (auto spdlog_logger = CreateLogger(logger_name, config)) [[likely]] {
    loggers_.emplace(logger_id, std::move(spdlog_logger));
    logger_configs_.emplace(logger_id, std::move(config));
    logger_levels_.emplace(logger_id, LogLevel::kTrace);
  }
}

◆ Flush()

template<LoggerTrait T>

void helios::Logger::Flush ( T logger = {} )

inlinenoexcept

Flushes a specific logger.

Template Parameters

T	Logger type

Parameters

logger Logger type instance

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 269 of file logger.hpp.

                                         {}) noexcept {
    FlushImpl(LoggerIdOf<T>());
  }

◆ FlushAll()

void helios::Logger::FlushAll ( )

noexcept

Flushes all registered loggers.

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 304 of file logger.cpp.

                               {
  const std::shared_lock lock(loggers_mutex_);
  for (const auto& [_, logger] : loggers_) {
    if (logger) [[likely]] {
      try {
        logger->flush();
      } catch (...) {
        // Silently ignore flush errors
      }
    }
  }
}

◆ GetDefaultConfig()

const LoggerConfig & helios::Logger::GetDefaultConfig ( ) const

inlinenoexcept

Gets the current default configuration.

Returns: The default logger configuration

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 441 of file logger.hpp.

441{ return default_config_; }

◆ GetInstance()

static Logger & helios::Logger::GetInstance ( )

inlinestaticnoexcept

Gets the singleton instance.

Returns: Reference to the Logger instance

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 447 of file logger.hpp.

                                                      {
    static Logger instance;
    return instance;
  }

◆ GetLevel() [1/2]

LogLevel helios::Logger::GetLevel ( ) const

noexcept

Gets the current log level for the default logger.

Returns: The current log level

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 340 of file logger.cpp.

                                         {
  if (const auto logger = GetDefaultLogger()) [[likely]] {
    return static_cast<LogLevel>(logger->level());
  }
  return LogLevel::kTrace;
}

◆ GetLevel() [2/2]

template<LoggerTrait T>

LogLevel helios::Logger::GetLevel ( T logger = {} ) const

inlinenoexcept

Gets the current log level for a typed logger.

Template Parameters

T	Logger type

Parameters

logger Logger type instance

Returns: The current log level, or LogLevel::kTrace if logger doesn't exist

Definition at line 427 of file logger.hpp.

                                                              {}) const noexcept {
    return GetLevelImpl(LoggerIdOf<T>());
  }

◆ HasLogger()

template<LoggerTrait T>

bool helios::Logger::HasLogger ( T logger = {} ) const

inlinenoexcept

Checks if a logger with the given type exists.

Template Parameters

T	Logger type

Parameters

logger Logger type instance

Returns: True if the logger exists, false otherwise

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 636 of file logger.hpp.

                                                {
  const std::shared_lock lock(loggers_mutex_);
  return loggers_.contains(LoggerIdOf<T>());
}

◆ LogAssertionFailure() [1/4]

template<typename... Args>
requires (sizeof...(Args) > 0)

void helios::Logger::LogAssertionFailure	(	std::string_view	condition,
		const std::source_location &	loc,
		std::format_string< Args... >	fmt,
		Args &&...	args
	)

inlinenoexcept

Logs assertion failure with default logger (formatted).

Template Parameters

Args	Types of the format arguments

Parameters

condition	The failed condition as a string
loc	Source location where the assertion failed
fmt	Format string for the failure message
args	Arguments for the format string

Definition at line 625 of file logger.hpp.

                                                                                                {
  try {
    const std::string message = std::format(fmt, std::forward<Args>(args)...);
    LogAssertionFailure(condition, loc, message);
  } catch (...) {
    LogAssertionFailure(condition, loc, "Formatting error in assertion message");
  }
}

◆ LogAssertionFailure() [2/4]

void helios::Logger::LogAssertionFailure	(	std::string_view	condition,
		const std::source_location &	loc,
		std::string_view	message
	)

inlinenoexcept

Logs assertion failure with default logger.

Parameters

condition	The failed condition as a string
loc	Source location where the assertion failed
message	Additional message describing the failure

Definition at line 616 of file logger.hpp.

                                                                         {
  if (auto logger = GetDefaultLogger()) [[likely]] {
    LogAssertionFailureImpl(logger, condition, loc, message);
  }
}

◆ LogAssertionFailure() [3/4]

template<LoggerTrait T, typename... Args>
requires (sizeof...(Args) > 0)

void helios::Logger::LogAssertionFailure	(	T	logger,
		std::string_view	condition,
		const std::source_location &	loc,
		std::format_string< Args... >	fmt,
		Args &&...	args
	)

inlinenoexcept

Logs assertion failure with typed logger (formatted).

Template Parameters

T	Logger type
Args	Types of the format arguments

Parameters

logger	Logger type instance
condition	The failed condition as a string
loc	Source location where the assertion failed
fmt	Format string for the failure message
args	Arguments for the format string

Definition at line 606 of file logger.hpp.

                                                                                                {
  try {
    const std::string message = std::format(fmt, std::forward<Args>(args)...);
    LogAssertionFailure(logger, condition, loc, message);
  } catch (...) {
    LogAssertionFailure(logger, condition, loc, "Formatting error in assertion message");
  }
}

◆ LogAssertionFailure() [4/4]

template<LoggerTrait T>

void helios::Logger::LogAssertionFailure	(	T	logger,
		std::string_view	condition,
		const std::source_location &	loc,
		std::string_view	message
	)

inlinenoexcept

Logs assertion failure with typed logger.

Template Parameters

T	Logger type

Parameters

logger	Logger type instance
condition	The failed condition as a string
loc	Source location where the assertion failed
message	Additional message describing the failure

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 595 of file logger.hpp.

                                                                         {
  if (auto spdlog_logger = GetLogger(LoggerIdOf<T>())) [[likely]] {
    LogAssertionFailureImpl(spdlog_logger, condition, loc, message);
  } else if (auto default_logger = GetDefaultLogger()) [[likely]] {
    LogAssertionFailureImpl(default_logger, condition, loc, message);
  }
}

◆ LogMessage() [1/4]

template<typename... Args>
requires (sizeof...(Args) > 0)

void helios::Logger::LogMessage	(	LogLevel	level,
		const std::source_location &	loc,
		std::format_string< Args... >	fmt,
		Args &&...	args
	)

inlinenoexcept

Logs a formatted message with default logger.

Template Parameters

Args	Types of the format arguments

Parameters

level	Log severity level
loc	Source location where the log was triggered
fmt	Format string
args	Arguments for the format string

Definition at line 584 of file logger.hpp.

                                                        {
  try {
    const std::string message = std::format(fmt, std::forward<Args>(args)...);
    LogMessage(level, loc, message);
  } catch (...) {
    // Silently ignore formatting errors
  }
}

◆ LogMessage() [2/4]

void helios::Logger::LogMessage	(	LogLevel	level,
		const std::source_location &	loc,
		std::string_view	message
	)

inlinenoexcept

Logs a string message with default logger.

Parameters

level	Log severity level
loc	Source location where the log was triggered
message	Message to log

Definition at line 576 of file logger.hpp.

                                                                                                             {
  if (auto logger = GetDefaultLogger()) [[likely]] {
    LogMessageImpl(logger, level, loc, message);
  }
}

◆ LogMessage() [3/4]

template<LoggerTrait T, typename... Args>
requires (sizeof...(Args) > 0)

void helios::Logger::LogMessage	(	T	logger,
		LogLevel	level,
		const std::source_location &	loc,
		std::format_string< Args... >	fmt,
		Args &&...	args
	)

inlinenoexcept

Logs a formatted message with typed logger.

Template Parameters

T	Logger type
Args	Types of the format arguments

Parameters

logger	Logger type instance
level	Log severity level
loc	Source location where the log was triggered
fmt	Format string
args	Arguments for the format string

Definition at line 566 of file logger.hpp.

                                                                                       {
  try {
    const std::string message = std::format(fmt, std::forward<Args>(args)...);
    LogMessage(logger, level, loc, message);
  } catch (...) {
    // Silently ignore formatting errors
  }
}

◆ LogMessage() [4/4]

template<LoggerTrait T>

void helios::Logger::LogMessage	(	T	logger,
		LogLevel	level,
		const std::source_location &	loc,
		std::string_view	message
	)

inlinenoexcept

Logs a string message with typed logger.

Template Parameters

T	Logger type

Parameters

logger	Logger type instance
level	Log severity level
loc	Source location where the log was triggered
message	Message to log

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 557 of file logger.hpp.

                                                                {
  if (auto spdlog_logger = GetLogger(LoggerIdOf<T>())) [[likely]] {
    LogMessageImpl(spdlog_logger, level, loc, message);
  }
}

◆ operator=() [1/2]

Logger & helios::Logger::operator= ( const Logger & )

delete

◆ operator=() [2/2]

Logger & helios::Logger::operator= ( Logger && )

delete

◆ RemoveLogger()

template<LoggerTrait T>

void helios::Logger::RemoveLogger ( T logger = {} )

inlinenoexcept

Removes a logger with the given type.

Note: Cannot remove the default logger

Template Parameters

T	Logger type

Parameters

logger Logger type instance

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 538 of file logger.hpp.

                                             {
  constexpr LoggerId logger_id = LoggerIdOf<T>();
 
  // Cannot remove the default logger
  if (logger_id == LoggerIdOf<DefaultLogger>()) [[unlikely]] {
    return;
  }
 
  const std::scoped_lock lock(loggers_mutex_);
  if (const auto it = loggers_.find(logger_id); it != loggers_.end()) {
    // Unregister from spdlog before erasing
    DropLoggerFromSpdlog(it->second);
    loggers_.erase(it);
    logger_configs_.erase(logger_id);
    logger_levels_.erase(logger_id);
  }
}

◆ SetDefaultConfig()

void helios::Logger::SetDefaultConfig ( const LoggerConfig & config )

inlinenoexcept

Sets the global default configuration for new loggers.

Parameters

config The configuration to use as default

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 373 of file logger.hpp.

373{ default_config_ = config; }

◆ SetLevel() [1/2]

void helios::Logger::SetLevel ( LogLevel level )

noexcept

Sets the minimum log level for the default logger.

Parameters

level Minimum log level to set

Definition at line 327 of file logger.cpp.

                                             {
  if (const auto logger = GetDefaultLogger()) [[likely]] {
    logger->set_level(static_cast<spdlog::level::level_enum>(std::to_underlying(level)));
  }
}

◆ SetLevel() [2/2]

template<LoggerTrait T>

void helios::Logger::SetLevel	(	T	logger,
		LogLevel	level
	)

inlinenoexcept

Sets the minimum log level for a typed logger.

Template Parameters

T	Logger type

Parameters

logger	Logger type instance
level	Minimum log level to set

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 382 of file logger.hpp.

                                                                    {
    SetLevelImpl(LoggerIdOf<T>(), level);
  }

◆ ShouldLog() [1/2]

bool helios::Logger::ShouldLog ( LogLevel level ) const

noexcept

Checks if the default logger should log messages at the given level.

Parameters

level The log level to check

Returns: True if messages at this level should be logged

Examples: /home/runner/work/HeliosEngine/HeliosEngine/src/core/include/helios/core/logger.hpp.

Definition at line 333 of file logger.cpp.

                                                    {
  if (const auto logger = GetDefaultLogger()) [[likely]] {
    return logger->should_log(static_cast<spdlog::level::level_enum>(std::to_underlying(level)));
  }
  return false;
}

◆ ShouldLog() [2/2]

template<LoggerTrait T>

bool helios::Logger::ShouldLog	(	T	logger,
		LogLevel	level
	)		const

inlinenoexcept

Checks if a typed logger should log messages at the given level.

Template Parameters

T	Logger type

Parameters

logger	Logger type instance
level	The log level to check

Returns: True if messages at this level should be logged

Definition at line 416 of file logger.hpp.

                                                                                         {
    return ShouldLogImpl(LoggerIdOf<T>(), level);
  }

	Helios Engine 0.1.0 A modular ECS based data-oriented C++23 game engine

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Logger() [1/2]

◆ Logger() [2/2]

◆ ~Logger()

Member Function Documentation

◆ AddLogger()

◆ Flush()

◆ FlushAll()

◆ GetDefaultConfig()

◆ GetInstance()

◆ GetLevel() [1/2]

◆ GetLevel() [2/2]

◆ HasLogger()

◆ LogAssertionFailure() [1/4]

◆ LogAssertionFailure() [2/4]

◆ LogAssertionFailure() [3/4]

◆ LogAssertionFailure() [4/4]

◆ LogMessage() [1/4]

◆ LogMessage() [2/4]

◆ LogMessage() [3/4]

◆ LogMessage() [4/4]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ RemoveLogger()

◆ SetDefaultConfig()

◆ SetLevel() [1/2]

◆ SetLevel() [2/2]

◆ ShouldLog() [1/2]

◆ ShouldLog() [2/2]