Files
2025-05-08 14:45:44 +01:00

83 lines
2.5 KiB
C++

namespace LX
{
// Static class used for logging information //
class COMMON_API Log
{
public:
// This class should never be constructed //
// It acts like a fancy namespace //
Log() = delete;
// The different formats the log supports //
enum class Format
{
// Default, with a new line character added after every call //
AUTO,
// No new line characters after all the provided arguments //
NONE
};
// Different priorities in the logger //
enum class Priority
{
HIGH, // Shows in all logs
LOW // Default
};
// Variadic template to allow an undefined ammount of arguments //
template<Priority priority = Priority::LOW, Format format = Format::AUTO, typename... Args>
requires AllLogable<Args...> // <- Checks all types can be outputted to the console
// Logs information (if the log is initalised) //
static void out(Args... args)
{
// Returns if not high enough priority //
if constexpr (priority == Priority::LOW)
{
RETURN_IF(s_Priority == Priority::HIGH);
}
// Prints out the args ending with a new line unless specified //
if constexpr (format == Format::AUTO) { ((*s_LogFile << ... << args) << "\n"); }
// Else prints out the args as provided //
else { (*s_LogFile << ... << args); }
// Flushes the log (only if debugger is attached) //
// Only flushes then as that is when the log is monitered during the process //
if (IsDebuggerPresent()) { s_LogFile->flush(); }
}
// Variadic template to allow an undefined ammount of arguments //
template<typename... Args>
requires AllLogable<Args...> // <- Checks all types can be outputted to the console
// Adds a named break between different sections in the log //
static void LogNewSection(Args... args)
{
// Constant for how a break is represented in the log //
static const char* BREAK = "-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-";
// Outputs the arguments between two breaks //
*s_LogFile << '\n' << BREAK << '\n';
(*s_LogFile << ... << args);
*s_LogFile << '\n' << BREAK << '\n';
// Flushes the log (only if debugger is attached) //
// Only flushes then as that is when the log is monitered during the process //
if (IsDebuggerPresent()) { s_LogFile->flush(); }
}
// Initalises the log //
static void Init(Priority _default);
private:
// Keeps the pointer hidden to stop accidental changes //
static std::ofstream* s_LogFile;
// The current priority of the log output //
static Priority s_Priority;
};
}