Logging.h

Go to the documentation of this file.

// File: Logging.h
// Description:
//  .h file for Logging class that does the basic logging functionality
//  contains all the methods and variables needed for logging
// Author(s): Marcelo Escamilla (marcelo.escamilla@digipen.edu)
// 2025 / 09 / 14
// (C) Digipen 2025
//   ____   __                  __  __
// /\__  _\/\ \                /\ \/\ \
// \/_/\ \/\ \ \___      __    \ \ \_\ \    ___   __  __    ____     __
//    \ \ \ \ \  _ `\  /'__`\   \ \  _  \  / __`\/\ \/\ \  /',__\  /'__`\
//     \ \ \ \ \ \ \ \/\  __/    \ \ \ \ \/\ \L\ \ \ \_\ \/\__, `\/\  __/
//      \ \_\ \ \_\ \_\ \____\    \ \_\ \_\ \____/\ \____/\/\____/\ \____\
//       \/_/  \/_/\/_/\/____/     \/_/\/_/\/___/  \/___/  \/___/  \/____/
#pragma once
 
#include <spdlog/spdlog.h>
#include <nlohmann/json.hpp>
 
namespace sol
{
class state;
}
 
class Logging
{
 
public:
    // Initialize the logging system ONE TIME USE in the AllocConsole section of wWinMain
    // Add anything that is needed for logging to work any extra files, etc.
    static auto initializeLogging() -> void;
 
    // Methods
 
    // Test output to console
    static auto testOutput() -> void;
 
    static auto bindLuaTypes(sol::state& lua) -> void;
 
private:
    // Variables
    // static variable to keep track of log number
    int logNumber;
 
};
 
namespace hlg
{
 
// LogMessage: Verbose information
// Send a message to the console with very detailed information you want others to know
template <typename... Args>
auto Trace(spdlog::format_string_t<Args...> message, Args&&... args) -> void
{
    spdlog::trace(message, std::forward<Args>(args)...);
}
 
// LogMessage: Verbose information
// Send a message to the console with very detailed information you want others to know
template <typename T>
auto Trace(const T& message) -> void
{
    spdlog::trace(message);
}
 
// LogMessage: Debugging information
// Send a message to the console with any debug information you want others to know
template <typename... Args>
auto Debug(spdlog::format_string_t<Args...> message, Args&&... args) -> void
{
    spdlog::debug(message, std::forward<Args>(args)...);
}
 
// LogMessage: Debugging information
// Send a message to the console with any debug information you want others to know
template <typename T>
auto Debug(const T& message) -> void
{
    spdlog::debug(message);
}
 
// LogMessage: General information
// Send a message to the console with any information you want others to know
template <typename... Args>
auto Message(spdlog::format_string_t<Args...> message, Args&&... args) -> void
{
    spdlog::info(message, std::forward<Args>(args)...);
}
 
// LogMessage: General information
// Send a message to the console with any information you want others to know
template <typename T>
auto Message(const T& message) -> void
{
    spdlog::info(message);
}
 
// LogWarning: Warning information
// Send a message to the console with any warning information you want others to know
template <typename... Args>
auto Warning(spdlog::format_string_t<Args...> message, Args&&... args) -> void
{
    spdlog::warn(message, std::forward<Args>(args)...);
}
 
// LogWarning: Warning information
// Send a message to the console with any warning information you want others to know
template <typename T>
auto Warning(const T& message) -> void
{
    spdlog::warn(message);
}
 
// LogError: Error information
// Send a message to the console with any error information you want others to know
template <typename... Args>
auto Error(spdlog::format_string_t<Args...> message, Args&&... args) -> void
{
    spdlog::error(message, std::forward<Args>(args)...);
}
 
// LogError: Error information
// Send a message to the console with any error information you want others to know
template <typename T>
auto Error(const T& message) -> void
{
    spdlog::error(message);
}
 
// LogCritical: Critical information
// Send a message to the console with any critical information you want others to know
template <typename... Args>
auto Critical(spdlog::format_string_t<Args...> message, Args&&... args) -> void
{
    spdlog::critical(message, std::forward<Args>(args)...);
}
 
// LogCritical: Critical information
// Send a message to the console with any critical information you want others to know
template <typename T>
auto Critical(const T& message) -> void
{
    spdlog::critical(message);
}
 
} // namespace log
 
// formatter for nlohmann::json to use with spdlog
template <>
struct fmt::formatter<nlohmann::json> : formatter<std::string>
{
    template <typename FormatContext>
    auto format(const nlohmann::json& j, FormatContext& ctx) const
    {
        return formatter<std::string>::format(j.dump(), ctx);
    }
};