rendering_engine::Logger Class Reference

Singleton engine-wide logging system. More...

#include <logger.hpp>

Public Member Functions
void	Initialize (const std::string &appName)
	Initializes logging system and creates a new log file.
void	Shutdown ()
	Finalizes logging system and closes the log file.
void	Log (LogLevel level, const std::string &message, const char *file, int line)
	Writes a formatted log message.

Static Public Member Functions
static Logger &	Get ()
	Returns singleton logger instance.

Detailed Description

Singleton engine-wide logging system.

Responsibilities:

• Create log file per application run
• Write formatted log entries
• Apply runtime log-level filtering
• Ensure thread-safe file access

The logger must be initialized during application startup and shutdown during application termination.

Definition at line 75 of file logger.hpp.

Member Function Documentation

Get()

Logger & rendering_engine::Logger::Get ( )

static

Returns singleton logger instance.

Definition at line 33 of file logger.cpp.

{
    static Logger instance;
    return instance;
}

Initialize()

void rendering_engine::Logger::Initialize

(

const std::string &

appName

)

Initializes logging system and creates a new log file.

Parameters

appName

Name of the application (used in log filename).

Definition at line 39 of file logger.cpp.

{
    std::lock_guard<std::mutex> lock(mMutex);
 
    if (mFile.is_open())
        return;
 
    auto logFolderPath = Utility::GetLogsFolderPath();
    if (!std::filesystem::exists(logFolderPath))
    {
        std::filesystem::create_directory(logFolderPath);
    }
 
    // System clock for human-readable timestamp
    auto now = std::chrono::system_clock::now();
    auto nowTimeT = std::chrono::system_clock::to_time_t(now);
 
    std::tm localTime{};
#ifdef _WIN32
    localtime_s(&localTime, &nowTimeT);
#else
    localtime_r(&nowTimeT, &localTime);
#endif
 
    std::ostringstream filename;
    filename << logFolderPath.string() << "/"
        << appName << "_"
        << std::put_time(&localTime, "%Y-%m-%d_%H-%M-%S")
        << ".log";
 
    mFile.open(filename.str(), std::ios::out | std::ios::trunc);
 
    mCurrentLevel = ReadConfiguredLogLevel();
 
    if (mFile.is_open())
    {
        mFile << "===== Engine Log Started =====" << std::endl;
        mFile.flush();
    }
}

Log()

void rendering_engine::Logger::Log	(	LogLevel	level,
		const std::string &	message,
		const char *	file,
		int	line
	)

Writes a formatted log message.

Parameters

level	Log severity level.
message	Log message string.
file	Source file name.
line	Source line number.

Definition at line 119 of file logger.cpp.

{
    if (level < mCurrentLevel)
        return;
 
    if (!mFile.is_open())
        return;
 
    // Capture time outside lock for minimal contention
    auto nowSystem = std::chrono::system_clock::now();
    auto nowTimeT = std::chrono::system_clock::to_time_t(nowSystem);
    auto nowMs = std::chrono::duration_cast<std::chrono::milliseconds>(
        nowSystem.time_since_epoch()) % 1000;
 
    std::tm localTime{};
#ifdef _WIN32
    localtime_s(&localTime, &nowTimeT);
#else
    localtime_r(&nowTimeT, &localTime);
#endif
 
    std::ostringstream timestampStream;
    timestampStream << std::put_time(&localTime, "%Y-%m-%d %H:%M:%S")
        << "." << std::setfill('0') << std::setw(3) << nowMs.count();
 
    const auto threadId = std::this_thread::get_id();
 
    std::lock_guard<std::mutex> lock(mMutex);
 
    mFile << "[" << timestampStream.str() << "] "
        << "[" << LogLevelToString(level) << "] "
        << "[Thread " << threadId << "] "
        << message
        << " (" << file << ":" << line << ")"
        << std::endl;
 
    mFile.flush();
}

Shutdown()

void rendering_engine::Logger::Shutdown

(

)

Finalizes logging system and closes the log file.

Definition at line 80 of file logger.cpp.

{
    std::lock_guard<std::mutex> lock(mMutex);
 
    if (mFile.is_open())
    {
        mFile << "===== Engine Log Shutdown =====" << std::endl;
        mFile.flush();
        mFile.close();
    }
}

---

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

• logger.hpp
• logger.cpp