Logger Class Reference

Classes
struct	LogEntry
struct	LogLevelInfo

Public Types
enum class	LogLevel {   Info , Warning , Error , Shutdown ,   Initialize , Update , Render , Input ,   Physics , Audio , Network , Scripting ,   AI , Resource , Memory , Debug ,   Count }

Public Member Functions
	Logger (Logger const &)=delete
void	operator= (Logger const &)=delete
	Logger ()
void	Log (const std::string &message, const std::string &fileName, int lineNumber, LogLevel level=LogLevel::Info)
void	Log (const std::string &message, LogLevel level)
const std::deque< LogEntry > &	GetLogBuffer () const
void	ManageLogFiles (const std::string &directoryPath)

Static Public Member Functions
static Logger &	Get ()
static const LogLevelInfo	GetLogLevelInfo (LogLevel level)

Public Attributes
bool	m_disabledLogLevels [LogLevelCount]
std::string	m_logFilePath

Static Public Attributes
static constexpr int	LogLevelCount = static_cast<int>(LogLevel::Count)

Detailed Description

Definition at line 13 of file Logger.h.

Member Enumeration Documentation

LogLevel

enum class Logger::LogLevel

strong

Enum class representing different log levels. Each log level has a corresponding color for display purposes. The last entry, Count, is used to determine the number of log levels.

Definition at line 37 of file Logger.h.

    {
        Info,
        Warning,
        Error,
        Shutdown,
        Initialize,
        Update,
        Render,
        Input,
        Physics,
        Audio,
        Network,
        Scripting,
        AI,
        Resource,
        Memory,
        Debug,
        Count // Do not use this, it's just to get the number of log levels it must at the end
    };

Constructor & Destructor Documentation

Logger() [1/2]

Logger::Logger ( Logger const & )

delete

Delete the copy constructor and assignment operator to prevent copying.

Logger() [2/2]

Logger::Logger ( )

inline

Constructor for the Logger class. Initializes the logger, sets up the log file path, and manages log files.

Definition at line 116 of file Logger.h.

    {
        char* appdata = nullptr;
        size_t len;
        _dupenv_s(&appdata, &len, "APPDATA");
        if (appdata == nullptr)
        {
            m_appdataPath = "log.log";
        }
        else
        {
            m_appdataPath = appdata;
        }
        free(appdata);
        std::string directoryPath = m_appdataPath + "\\Khaotic Engine";
        CreateDirectoryA(directoryPath.c_str(), NULL);
 
        ManageLogFiles(directoryPath);
 
        m_logFilePath = directoryPath + "\\" + m_logFileName;
 
        // Enable only the Error warning and shutdown log levels
        for (int i = 0; i < LogLevelCount; i++)
        {
            m_disabledLogLevels[i] = true;
 
            if (i == static_cast<int>(LogLevel::Error) || i == static_cast<int>(LogLevel::Warning) || i == static_cast<int>(LogLevel::Shutdown))
            {
                m_disabledLogLevels[i] = false;
 
            }
        }
 
    }

Member Function Documentation

Get()

static Logger & Logger::Get ( )

inlinestatic

Get the singleton instance of the Logger class.

Returns

A reference to the Logger instance.

Definition at line 20 of file Logger.h.

    {
        static Logger instance;
        return instance;
    }

GetLogBuffer()

const std::deque< LogEntry > & Logger::GetLogBuffer ( ) const

inline

Get the loggBuffer deque.

Returns

A constant reference to the logBuffer deque containing log entries.

Definition at line 220 of file Logger.h.

{ return logBuffer; }

GetLogLevelInfo()

static const LogLevelInfo Logger::GetLogLevelInfo ( LogLevel level )

inlinestatic

Get the LogLevelInfo for a given log level. This function returns a LogLevelInfo struct containing the name, value, and color of the log level.

Parameters

level

The log level for which to get the information.

Returns

A LogLevelInfo struct containing the information for the specified log level.

Definition at line 88 of file Logger.h.

    {
        switch (level)
        {
        case LogLevel::Info: return LogLevelInfo{ "Info", 0, ImVec4(0.0f, 1.0f, 0.0f, 1.0f) };
        case LogLevel::Warning: return LogLevelInfo{ "Warning", 1, ImVec4(1.0f, 1.0f, 0.0f, 1.0f) };
        case LogLevel::Error: return LogLevelInfo{ "Error", 2, ImVec4(1.0f, 0.0f, 0.0f, 1.0f) };
        case LogLevel::Shutdown: return LogLevelInfo{ "shutdown", 3, ImVec4(0.5f, 0.0f, 0.0f, 1.0f) };
        case LogLevel::Initialize: return LogLevelInfo{ "initialize", 4, ImVec4(0.0f, 1.0f, 1.0f, 1.0f) };
        case LogLevel::Update: return LogLevelInfo{ "Update", 5, ImVec4(1.0f, 0.0f, 1.0f, 1.0f) };
        case LogLevel::Render: return LogLevelInfo{ "render", 6, ImVec4(1.0f, 1.0f, 1.0f, 1.0f) };
        case LogLevel::Input: return LogLevelInfo{ "Input", 7, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        case LogLevel::Physics: return LogLevelInfo{ "physics", 8, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        case LogLevel::Audio: return LogLevelInfo{ "Audio", 9, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        case LogLevel::Network: return LogLevelInfo{ "Network", 10, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        case LogLevel::Scripting: return LogLevelInfo{ "Scripting", 11, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        case LogLevel::AI: return LogLevelInfo{ "AI", 12, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        case LogLevel::Resource: return LogLevelInfo{ "Resource", 13, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        case LogLevel::Memory: return LogLevelInfo{ "Memory", 14, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        case LogLevel::Debug: return LogLevelInfo{ "Debug", 15, ImVec4(0.5f, 0.5f, 0.5f, 1.0f) };
        default: return LogLevelInfo{ "Unknown", 16, ImVec4(1.0f, 1.0f, 1.0f, 1.0f) };
        }
    }

Log() [1/2]

void Logger::Log ( const std::string & message, const std::string & fileName, int lineNumber, LogLevel level = LogLevel::Info )

inline

Write a log message to the log file and console.

Parameters

message
fileName
lineNumber
level

Definition at line 158 of file Logger.h.

    {
 
        auto now = std::chrono::system_clock::now();
        auto in_time_t = std::chrono::system_clock::to_time_t(now);
 
        std::tm buf;
        localtime_s(&buf, &in_time_t);
 
        // Obtenez les millisecondes à partir de maintenant
        auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(now.time_since_epoch()) % 1000;
 
        // Utilisez LogLevelToString pour obtenir la chaîne de caractères du niveau de log
        std::string levelStr = GetLogLevelInfo(level).name;
 
        std::stringstream ss;
        ss << "[" << std::put_time(&buf, "%Y-%m-%d") << "] "
            << "[" << std::put_time(&buf, "%X") << "." << std::setfill('0') << std::setw(3) << ms.count() << "] "
            << "[" << levelStr << "] "
            << "[" << fileName << ":" << lineNumber << "] "
            << message;
 
        Log(ss.str(), level);
 
        std::ofstream file(m_logFilePath, std::ios::app);
        if (file.is_open())
        {
            file << ss.str() << std::endl;
            file.close();
        }
    }

Log() [2/2]

void Logger::Log ( const std::string & message, LogLevel level )

inline

Write a log message to the log buffer. This is the fonction wich is used to send log messages to the gui. It's using a buffer to store the log messages with a maximum size. The buffer default size is 100 messages. This limit can be changed by changing the logBufferSize variable. But it is not recommended to change it because it can cause performance issues.

Parameters

message	The log message to write.
level	The log level for the message.

Definition at line 200 of file Logger.h.

    {
 
        // Si le niveau de log est désactivé, ne faites rien
        if (m_disabledLogLevels[GetLogLevelInfo(level).value])
        {
            return;
        }
 
        if (logBuffer.size() >= logBufferSize)
        {
            logBuffer.pop_front();
        }
        logBuffer.push_back({ message, level });
    }

ManageLogFiles()

void Logger::ManageLogFiles ( const std::string & directoryPath )

inline

This function manages log files in the specified directory. It checks for log files with the ".log" extension, Then it keeps only the three most recent log files, deleting the oldest ones if there are more than three. It also creates a new log file for the current execution with a timestamp in its name.

Parameters

directoryPath

Definition at line 230 of file Logger.h.

    {
        std::vector<std::filesystem::path> logFiles;
 
        // Parcourez tous les fichiers dans le dossier
        for (const auto& entry : std::filesystem::directory_iterator(directoryPath))
        {
            // Si le fichier est un fichier de log, ajoutez-le à la liste
            if (entry.path().extension() == ".log")
            {
                logFiles.push_back(entry.path());
            }
        }
 
        // Si nous avons plus de trois fichiers de log, supprimez le plus ancien
        while (logFiles.size() >= 3)
        {
            // Triez les fichiers par date de modification, le plus ancien en premier
            std::sort(logFiles.begin(), logFiles.end(), [](const std::filesystem::path& a, const std::filesystem::path& b)
                {
                    return std::filesystem::last_write_time(a) < std::filesystem::last_write_time(b);
                });
 
            // Supprimez le fichier le plus ancien
            std::filesystem::remove(logFiles[0]);
 
            // Supprimez-le de la liste
            logFiles.erase(logFiles.begin());
        }
 
        // Créez un nouveau fichier de log pour cette exécution
        auto now = std::chrono::system_clock::now();
        auto in_time_t = std::chrono::system_clock::to_time_t(now);
        std::tm buf;
        localtime_s(&buf, &in_time_t);
 
        std::stringstream ss;
        ss << "Khaotic_log_" << std::put_time(&buf, "%Y_%m_%d_%Hh%Mm%Ss") << ".log";
        m_logFileName = ss.str();
    }

Member Data Documentation

LogLevelCount

int Logger::LogLevelCount = static_cast<int>(LogLevel::Count)

staticconstexpr

Definition at line 59 of file Logger.h.

m_disabledLogLevels

bool Logger::m_disabledLogLevels[LogLevelCount]

Definition at line 271 of file Logger.h.

m_logFilePath

std::string Logger::m_logFilePath

Definition at line 272 of file Logger.h.

---

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

• enginecustom/src/inc/system/Logger.h