logger.hpp

Go to the documentation of this file.

#pragma once

#include <condition_variable>
#include <filesystem>
#include <fstream>
#include <thread>

#include "Mountain/core.hpp"
#include "Mountain/utils/concepts.hpp"
#include "Mountain/utils/ts_queue.hpp"


#define DEBUG_LOG(message, ...) Mountain::Logger::LogDebug(message, __FILE__, __LINE__, __VA_ARGS__)

namespace Mountain
{
    class Logger final
    {
        STATIC_CLASS(Logger)

    public:
        enum class LogLevel : uint8_t
        {
            Debug,
            Verbose,
            Info,
            Warning,
            Error,
            Fatal
        };

    private:
        struct LogEntry
        {
            std::string message;
            LogLevel level;
            std::chrono::system_clock::time_point time;

            bool_t printToConsole, printToFile;

            std::string file;
            int32_t line = -1;

            bool_t sameAsPrevious = false;

            std::shared_ptr<LogEntry> previousLog = nullptr;

            MOUNTAIN_API LogEntry();

            MOUNTAIN_API LogEntry(std::string&& message, LogLevel level);

            MOUNTAIN_API LogEntry(std::string&& message, LogLevel level, const std::string& file, int32_t line);

            MOUNTAIN_API LogEntry(std::string&& message, LogLevel level, std::chrono::system_clock::time_point timePoint);

            MOUNTAIN_API LogEntry(std::string&& message, LogLevel level, std::chrono::system_clock::duration duration);

            MOUNTAIN_API bool_t operator==(const LogEntry& other) const;
        };

        // We thought about using std::list here instead but because the allocations are made on the logger thread anyway we can make it a std::vector
        MOUNTAIN_API static inline std::vector<std::shared_ptr<LogEntry>> m_Logs;

    public:
        MOUNTAIN_API static inline LogLevel minimumConsoleLevel =
    #ifdef _DEBUG
            LogLevel::Debug;
    #else
            LogLevel::Info;
    #endif

        MOUNTAIN_API static inline LogLevel minimumFileLevel = LogLevel::Info;

        template <Concepts::FormattableT... Args>
        static void Log(LogLevel level, const std::string& format, Args&&... args);

        template <Concepts::FormattableT... Args>
        static void LogDebug(const std::string& format, const char_t* file, int32_t line, Args&&... args);

        template <Concepts::FormattableT... Args>
        static void LogVerbose(const std::string& format, Args&&... args);

        template <Concepts::FormattableT... Args>
        static void LogInfo(const std::string& format, Args&&... args);

        template <Concepts::FormattableT... Args>
        static void LogWarning(const std::string& format, Args&&... args);

        template <Concepts::FormattableT... Args>
        static void LogError(const std::string& format, Args&&... args);

        template <Concepts::FormattableT... Args>
        static void LogFatal(const std::string& format, Args&&... args);

        MOUNTAIN_API static void OpenFile(const std::filesystem::path& filepath);

        MOUNTAIN_API static void OpenDefaultFile();

        MOUNTAIN_API static bool HasFileOpen();

        MOUNTAIN_API static void CloseFile();

        MOUNTAIN_API static void Synchronize();

        MOUNTAIN_API static void Start();

        MOUNTAIN_API static void Stop();

        MOUNTAIN_API static const decltype(m_Logs)& GetLogList();

        MOUNTAIN_API static void Clear();

    private:
        MOUNTAIN_API static inline TsQueue<std::shared_ptr<LogEntry>> m_NewLogs;

        MOUNTAIN_API static inline std::shared_ptr<LogEntry> m_LastLog;

        MOUNTAIN_API static inline bool_t m_LastLogCollapsed = false;

        MOUNTAIN_API static inline std::condition_variable m_CondVar;

        MOUNTAIN_API static void Run();

        MOUNTAIN_API static inline std::thread m_Thread;

        MOUNTAIN_API static inline std::mutex m_Mutex;

        MOUNTAIN_API static inline bool_t m_Running = false;

        MOUNTAIN_API static inline bool_t m_Synchronizing = false;

        MOUNTAIN_API static inline std::ofstream m_File;

        MOUNTAIN_API static inline std::filesystem::path m_Filepath;

        MOUNTAIN_API static inline uint32_t m_LogIndex = 0;

        MOUNTAIN_API static void PushLog(const std::shared_ptr<LogEntry>& log);

        MOUNTAIN_API static void PrintLog(const std::shared_ptr<LogEntry>& log);

        MOUNTAIN_API static std::pair<std::string, const char_t*> BuildLogPrefix(const std::shared_ptr<LogEntry>& log);
    };
}

#include "Mountain/utils/logger.inl"