logger.h

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <vector>
 
#include "Strings/components/resources/color/BlamColor.h"
#include "Strings/components/utils/datetime/datetime.h"
 
#ifdef STRINGS_EXPORTS
#define STRINGS_API __declspec(dllexport) 
#else
#define STRINGS_API __declspec(dllimport) 
#endif
 
#define LOGGER_ID_GUERILLA 1
#define LOGGER_ID_KEYSTONE 2
#define LOGGER_ID_STRINGS 3
#define LOGGER_ID_TOOL 4
#define LOGGER_ID_UNIFIED 5
 
// Warning severities
#define WSV_NONE BlamLogLevel::None          
#define WSV_ERROR BlamLogLevel::Error        
#define WSV_WARNING BlamLogLevel::Warning    
#define WSV_SEVERE BlamLogLevel::Severe      
 
class BlamBasicLogger;
 
enum class TerminalColor
{
    Black,
    Blue,
    Green,
    Cyan,
    Red,
    Magenta,
    Gold,
    Gray,
 
    DarkGray,
    BrightBlue,
    BrightGreen,
    BrightCyan,
    BrightRed,
    BrightMagenta,
    Yellow,
    White,
    Reset
};
 
enum class BlamLogLevel
{
    None,      
    Warning,   
    Error,     
    Severe,    
};
 
// 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, 
    OgreDebug,    
    HSLog,        
 
    // Possible Future Report Types
    AIDebug,                    
    AnimationAudioContentDebug, 
    AnimationDebug,             
    BandwidthDebug,             
    Content,                    
    DesignDebug,                
    EffectsDebug,               
    EnvironmentDebug,           
    EnvironmentMaterialsDebug,  
    GeometryDebug,              
    IncidentDebug,              
    LeaderboardDebug,           
    LocalizationDebug,          
    MultiplayerDebug,           
    NetworkingDebug,            
    ObjectMaterialsDebug,       
    ObjectsDebug,               
    PlayerRewardsDebug,         
    SoundDebug,                 
    StreamManagerDebug,         
    SystemLog,                  
};
 
struct STRINGS_API 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 STRINGS_API BlamBasicLogMessage
{
public:
    BlamBasicLogger* logger = nullptr; 
    BlamLogLevel log_level = BlamLogLevel::None; 
    TerminalColor color = TerminalColor::Reset; 
    bool has_custom_color = false; 
    std::string message = "";   
    std::string timestamp = ""; 
 
    std::string GetMessageLine();
 
    bool Equals(BlamBasicLogMessage other_message);
};
 
class STRINGS_API BlamLogReceiver
{
public:
    virtual void LogMessageReceived(BlamBasicLogMessage message) {};
};
 
class STRINGS_API BlamBasicLogger
{
private:
    bool print_to_stdout = false;
    std::string log_name = "";
    std::string save_directory = "";
 
    std::vector<BlamBasicLogMessage> history = std::vector<BlamBasicLogMessage>(); 
    std::vector<BlamLogReceiver*> receivers = std::vector<BlamLogReceiver*>(); 
 
    int unique_id = -1;
    bool has_id = false;
 
public:
    BlamBasicLogger();
 
    BlamBasicLogger(int _unique_id);
 
    BlamBasicLogger(int _unique_id, std::string _save_directory, std::string _log_name);
 
    void ClearHistory(std::string _save_directory = "", std::string _file_name = "");
 
    void SetCommandLinePrintingEnabled(bool print_to_cmd);
 
    std::vector<BlamBasicLogMessage> GetHistory();
 
    void LogEvent(BlamBasicLogMessage message);
 
    void LogEvent(std::string message);
 
    void LogEvent(std::string message, BlamLogLevel log_level);
 
    void LogEvent(std::string message, TerminalColor color);
 
    void AddReceiver(BlamLogReceiver* receiver);
 
    void RemoveReceiver(BlamLogReceiver* receiver);
 
    bool WriteToFile(std::string directory_path = "", std::string file_name = "log");
};
 
namespace BlamStrings::Interface::Logger
{
    STRINGS_API std::string GenerateLogLevelPrefix(BlamLogLevel log_level);
 
    STRINGS_API TerminalColor TranslateLogLevelAsColor(BlamLogLevel log_level);
 
    STRINGS_API void PrintMessageToStdout(std::string message, TerminalColor color);
}