Logger.hpp

Go to the documentation of this file.

#ifndef _LOGGER_H_
#define _LOGGER_H_
 
#include <Core/OSDef.hpp>
 
#define SPDLOG_WCHAR_SUPPORT
 
#include <spdlog/async.h>
#include <spdlog/sinks/basic_file_sink.h>
#include <spdlog/sinks/stdout_color_sinks.h>
#include <spdlog/spdlog.h>
 
#ifdef SLEAK_ENGINE
#define _LOGGER Sleak::Logger::GetCoreLogger()
#else
#define _LOGGER Sleak::Logger::GetLogger()
#endif
 
#define SLEAK_LOG(...) _LOGGER->trace(__VA_ARGS__);
#define SLEAK_INFO(...) _LOGGER->info(__VA_ARGS__);
#define SLEAK_WARN(...) _LOGGER->warn(__VA_ARGS__);
#define SLEAK_ERROR(...) _LOGGER->error(__VA_ARGS__);
#define SLEAK_FATAL(...) _LOGGER->critical(__VA_ARGS__);
 
#define SLEAK_RETURN_ERR(...)    \
    {                            \
        SLEAK_ERROR(__VA_ARGS__) \
        return false;            \
    }
 
namespace Sleak {
 
/// Sets up the engine and game spdlog sinks. Access via the SLEAK_LOG /
/// SLEAK_INFO / SLEAK_WARN / SLEAK_ERROR macros rather than directly.
///
/// Call Init() once from `main()` before anything else logs, passing your
/// project name. It creates a colored console sink and a file sink, and
/// registers two loggers behind them: one for engine internals and one for
/// game code. The macros pick the right logger automatically based on
/// which target is compiling, so game code and engine code both just use
/// SLEAK_LOG and friends.
///
/// Messages use fmt-style `{}` placeholders, not printf specifiers. The
/// five levels, from quietest to loudest, are SLEAK_LOG (trace),
/// SLEAK_INFO, SLEAK_WARN, SLEAK_ERROR, and SLEAK_FATAL. SLEAK_RETURN_ERR
/// logs at error level and returns false, which suits initialization
/// paths.
///
/// @code{.cpp}
/// int main(int argc, char** argv) {
///     Sleak::CommandLine::Parse(argc, argv);
///     Sleak::Logger::Init("MyGame");
///     // ...
/// }
///
/// // Anywhere afterward
/// SLEAK_INFO("Loaded {} chunks in {:.2f} ms", count, elapsedMs);
/// SLEAK_WARN("Texture {} is not power of two", path);
///
/// bool LoadLevel(const std::string& path) {
///     if (!Exists(path)) SLEAK_RETURN_ERR("Missing level {}", path);
///     return true;
/// }
/// @endcode
///
/// @see Application, CommandLine
/// @ingroup core
class ENGINE_API Logger {
   public:
    /// Creates the console + file sinks and registers both loggers. Call once at startup.
    static void Init(const std::string& ProjectName);
 
    /// Logger used by engine code (SLEAK_ENGINE builds).
    static std::shared_ptr<spdlog::logger>& GetCoreLogger();
    /// Logger used by game code.
    static std::shared_ptr<spdlog::logger>& GetLogger();
 
   private:
    static std::shared_ptr<spdlog::logger> CoreLogger;
    static std::shared_ptr<spdlog::logger> GameLogger;
};
 
}  // namespace Sleak
 
#endif  // _LOGGER_H_