logger.h

Go to the documentation of this file.

#pragma once
 
#include <Windows.h>
#include <vector>
#include <fstream>
#include <Strings/components/interface/logger/logger.h>
 
#include "components/resources/engine_globals/globals.h"
 
#define DEFAULT_LOG_FILENAME "debug" 
 
#ifndef BLAM
#define BLAM
#endif
 
class BlamReport;
 
// Visibility options
#define WVIS_NONE BlamLogVisibility::None               
#define WVIS_ALL BlamLogVisibility::All                 
#define WVIS_STDOUT_ONLY BlamLogVisibility::StdoutOnly  
#define WVIS_FILE_ONLY BlamLogVisibility::FileOnly      
#define WVIS_HTML_ONLY BlamLogVisibility::HTMLOnly      
#define WVIS_TXT_ONLY BlamLogVisibility::TXTOnly        
 
 
enum class BlamLogVisibility
{
    None,        
    All,         
    StdoutOnly,  
    FileOnly,    
    HTMLOnly,    
    TXTOnly      
};
 
enum class BlamReportType
{
    Debug,       
    DebugFull,   
    TagDebug,    
    UIDebug,     
    ShadersDebug 
};
 
enum class BlamLogFileFormat
{
    HTML,      
    PlainText, 
    Both       
};
 
struct BlamLogMessage
{
    BlamReportType report_type = BlamReportType::Debug;  
 
    std::string timestamp;            
    std::string message;              
    BlamLogLevel severity = WSV_NONE;  
    bool show_timestamp = true;       
 
    bool override_color = false;      
    BlamColor color;                  
 
    BlamLogVisibility visibility = WVIS_ALL;    
 
    bool override_duplicate_limit = false;  
};
 
 
class BlamReportFile
{
private:
    std::string file_title = ""; 
    std::string file_path = "";  
    BlamLogFileFormat format = BlamLogFileFormat::PlainText; 
    bool stylized_html_logs = false; 
    BlamReport* report = nullptr;    
    std::string file_contents = "";  
 
    bool PrepareAsHTML();
 
    bool PrepareAsPlainText();
 
    bool AppendMessageToHTML(BlamLogMessage message);
 
    bool AppendMessageToPlainText(BlamLogMessage message);
 
public:
 
    BlamReportFile(BlamLogFileFormat file_format, std::string base_dir, BlamReport* _report);
 
    BlamReportFile(BlamLogFileFormat file_format, std::string base_dir, BlamReport* _report, bool is_timestamped_file);
 
    ~BlamReportFile();
 
    bool PrepareFile();
 
    bool AppendMessage(BlamLogMessage message);
 
    void Flush();
};
 
class BlamReport
{
private:
    bool stylized_html_logs = false; 
    bool log_ready = false;          
    BlamLogFileFormat log_format = BlamLogFileFormat::PlainText;             
    std::vector<BlamReportFile*> log_files = std::vector<BlamReportFile*>(); 
 
public:
    std::string report_filename = "debug";              
    BlamReportType report_type = BlamReportType::Debug; 
 
    BlamReport(BlamReportType type, std::string filename);
 
    void Initialize();
 
    bool LogEvent(BlamLogMessage message);
 
    void PrintStartupHeader();
 
    bool IsReady();
 
    void MarkAsReady();
 
    void Flush();
};
 
namespace Blam::Logger
{
    namespace Queue
    {
        BLAM void Initialize();
 
        BLAM void Shutdown();
 
        BLAM void Flush();
 
        BLAM void AddMessage(BlamLogMessage message);
 
        BLAM std::vector<BlamLogMessage>* GetQueue();
 
        
        BLAM void FlushThread();
 
        BLAM void StartFlushThread();
 
        BLAM void StopFlushThread();
    }
 
    BLAM BlamReport* GetReport(BlamReportType type);
 
    BLAM std::vector<BlamReport*> GetReports();
 
    BLAM std::string GetLogLevelCSSClass(BlamLogLevel log_level);
 
    BLAM void Initialize();
 
    BLAM void Shutdown();
 
    BLAM void LogEventAsync(std::string message);
 
    BLAM void LogEvent(std::string message);
 
    BLAM void LogEvent(std::string message, bool show_timestamp);
 
    BLAM void LogEvent(std::string message, BlamReportType report_type);
 
    BLAM void LogEvent(std::string message, bool show_timestamp, BlamLogLevel severity);
 
    BLAM void LogEvent(std::string message, bool show_timestamp, BlamLogLevel severity, short r, short g, short b);
 
    BLAM void LogEvent(std::string message, BlamLogLevel severity);
 
    BLAM void LogEvent(std::string message, BlamLogLevel severity, BlamReportType report_type);
 
    BLAM void LogEvent(std::string message, BlamLogLevel severity, BlamLogVisibility visibility);
 
    BLAM void LogEvent(std::string message, BlamColor color);
 
    BLAM void LogEvent(BlamLogMessage message);
 
    BLAM void LogEventForce(std::string message);
 
    BLAM void LogEventForce(std::string message, BlamLogLevel severity);
 
    BLAM void LogEventForce(std::string message, BlamColor color);
 
    BLAM void LogEventForce(std::string message, BlamLogLevel severity, BlamLogVisibility visibility);
 
    BLAM void LogEventForce(std::string message, BlamLogLevel severity, BlamReportType report_type);
 
    BLAM void LogEventForce(BlamLogMessage message);
}