#include <Debug.hpp>

Public Member Functions
	Debug (const std::string &_id, const pd::DebugSettings &_settings)
	Construct the debugger with specified ID and settings Call the inner __init() function to Initialize.
	~Debug ()
	Call the pd::Debug::close() function to free all allocated memory.
bool	close ()
	Free all the allocated memory and resources, return true if it succeeded, return false if it did not.
std::pair< bool, std::string >	constructInfo ()
	Construct debug information You can use it if it failed to construct properly to get the error message.
std::fstream *	getFile () const
	Get file for more control over the processing and for more actions.
std::string	getID () const
	Return the ID of the created Debug object.
DebugSettings	getSettings () const
	Get the settings set for the created Debug object.
std::string	log (const std::string &_type, const std::string &_msg, unsigned int _level=0)
	Log the message with specific custom type, message and log level.

Private Member Functions
bool	__init ()
	Initialize the Debug object that is going (or was) to be constructed.

Private Attributes
bool	constructed
std::string	constructError
std::fstream *	file
std::string	id
const DebugSettings	settings

Detailed Description

Definition at line 45 of file Debug.hpp.

Constructor & Destructor Documentation

◆ Debug()

pd::Debug::Debug	(	const std::string &	_id,
		const pd::DebugSettings &	_settings )

Construct the debugger with specified ID and settings Call the inner __init() function to Initialize.

Parameters

_id	Set the ID of this object
_settings	Set the settings of this object

Definition at line 42 of file Debug.cpp.

        : id(_id), settings(_settings)
    {
        this->constructed = this->__init();
 
        if (!this->constructed)
            return;
    }

References __init(), constructed, id, and settings.

◆ ~Debug()

pd::Debug::~Debug ( )

Call the pd::Debug::close() function to free all allocated memory.

Definition at line 51 of file Debug.cpp.

    {
        this->close();
    }

References close().

Member Function Documentation

◆ __init()

bool pd::Debug::__init ( )

private

Initialize the Debug object that is going (or was) to be constructed.

Returns: bool Did it fail? True = Success, False = Failiture

Definition at line 17 of file Debug.cpp.

    {
        if (!this->settings.filePath.empty())
        {
            this->file = new std::fstream(this->settings.filePath, this->settings.openMode);
 
            if (!this->file->is_open())
            {
                this->constructError = "File could not open : " + this->id;
 
                return false;
            }
 
            if (!this->file->good())
            {
                this->constructError = "File is not good for opening : " + this->id;
 
                return false;
            }
        }
 
        return true;
    }

References constructError, file, id, and settings.

Referenced by Debug().

◆ close()

bool pd::Debug::close ( )

Free all the allocated memory and resources, return true if it succeeded, return false if it did not.

Returns: bool True if success, false if failiture

Definition at line 123 of file Debug.cpp.

    {
        if (this->file)
        {
            this->file->close();
 
            delete this->file; this->file = nullptr;
        }
 
        else return false;
 
        return true;
    }

References file.

Referenced by ~Debug().

◆ constructInfo()

std::pair< bool, std::string > pd::Debug::constructInfo ( )

Construct debug information You can use it if it failed to construct properly to get the error message.

Returns: std::pair<bool, std::string> .first: Did it succeed? .second: Error reason

Definition at line 137 of file Debug.cpp.

138 { return { this->constructed, this->constructError }; }

References constructed, and constructError.

◆ getFile()

std::fstream * pd::Debug::getFile ( ) const

Get file for more control over the processing and for more actions.

Returns: std::fstream Allocated file to Debug object

Definition at line 143 of file Debug.cpp.

144 { return this->file; }

References file.

◆ getID()

std::string pd::Debug::getID ( ) const

Return the ID of the created Debug object.

Returns: std::string The ID of this object

Definition at line 140 of file Debug.cpp.

141 { return this->id; }

References id.

◆ getSettings()

DebugSettings pd::Debug::getSettings ( ) const

Get the settings set for the created Debug object.

Returns: pd::DebugSettings Debug settings to return

Definition at line 146 of file Debug.cpp.

147 { return this->settings; }

References settings.

◆ log()

std::string pd::Debug::log	(	const std::string &	_type,
		const std::string &	_msg,
		unsigned int	_level = 0 )

Log the message with specific custom type, message and log level.

Parameters

_type	Set the type of the debug message (Ex: Information, Success, Warning, Error, ...)
_msg	Set the message for debugging
_level	Set the debug level level of the log (default as 0, non-debug-level specific)

Returns: The total string of the total debug message

Definition at line 56 of file Debug.cpp.

    {
        std::string msg;
        std::string type = _type;
 
        std::transform(type.begin(), type.end(), type.begin(), ::toupper);
 
        msg += this->settings.preStartMsg;
 
        if (!this->settings.custom)
        {
            msg += "[ " + this->settings.startMsg + type + (this->settings.debugID ? + " | " + this->id : "");
 
            // DATE AND TIME INFORMATION
            if (this->settings.timeStamp)
            {
                timeUtils::TimeInfo timeInfo;
                timeUtils::DateInfo dateInfo;
                timeUtils::Time time("debug-time");
 
                time.update(timeInfo);
                time.update(dateInfo);
 
                msg += " | " + std::to_string(dateInfo.year) + "-" + std::to_string(dateInfo.month) + "-" + std::to_string(dateInfo.day) + " | ";
                msg += std::to_string(timeInfo.hour) + ":" + std::to_string(timeInfo.min) + ":" + std::to_string(timeInfo.sec) + "." + std::to_string(timeInfo.ms)
                    + (this->settings.timeZone ? " +" + std::to_string(time.getUTCOffset().hour) + ":" + std::to_string(time.getUTCOffset().min) : "");
            }
 
            else msg += " ";
 
            // FINISG MSG
        }
 
        else msg = "[ " + this->settings.startMsg + this->settings.totalCustom;
 
        msg += this->settings.endMsg + "] " + (this->settings.postEndMsg) + _msg + this->settings.totalEndMsg + "\n";
 
        if (this->settings.output)
        {
            if ((!this->settings.logLevelIgnoreOutput && this->settings.logLevel == 0) || 
                    (this->settings.logLevel > 0 && _level <= this->settings.logLevel))
            {
                std::cout << msg;
            }
        }
 
        if (!this->settings.blockedSave)
        {
            if ((!this->settings.logLevelIgnoreSave && this->settings.logLevel == 0) || 
                    (this->settings.logLevel > 0 && _level <= this->settings.logLevel))
            {
#               ifndef __PD_NO_FULL_SUPPORT
                if (!fs::exists(fs::path(this->settings.filePath).parent_path()))
                {
                    fs::create_directories(fs::path(this->settings.filePath).parent_path());
 
                    this->file->close(); this->file->open(this->settings.filePath, this->settings.openMode);
                }
#               endif
 
                *this->file << msg;
            }
        }
 
        return msg;
    }

References file, id, and settings.

Member Data Documentation

◆ constructed

bool pd::Debug::constructed

private

Definition at line 54 of file Debug.hpp.

Referenced by Debug(), and constructInfo().

◆ constructError

std::string pd::Debug::constructError

private

Definition at line 55 of file Debug.hpp.

Referenced by __init(), and constructInfo().

◆ file

std::fstream* pd::Debug::file

private

Definition at line 50 of file Debug.hpp.

Referenced by __init(), close(), getFile(), and log().

◆ id

std::string pd::Debug::id

private

Definition at line 48 of file Debug.hpp.

Referenced by Debug(), __init(), getID(), and log().

◆ settings

const DebugSettings pd::Debug::settings

private

Definition at line 52 of file Debug.hpp.

Referenced by Debug(), __init(), getSettings(), and log().

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

inc/Debug.hpp
src/Debug.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Debug()

◆ ~Debug()

Member Function Documentation

◆ __init()

◆ close()

◆ constructInfo()

◆ getFile()

◆ getID()

◆ getSettings()

◆ log()

Member Data Documentation

◆ constructed

◆ constructError

◆ file

◆ id

◆ settings