Logging.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/Macros.hpp"
 
#include "CeresEngine/Foundation/SmartPtr.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
#include "CeresEngine/Foundation/Threading/Threading.hpp"
 
#if __has_include(<spdlog/logger.h>)
#define CE_HAS_LOGGING 1
#endif
 
#if defined(CE_HAS_LOGGING)
#include <spdlog/logger.h>
#include <spdlog/sinks/base_sink.h>
 
#include <fmt/ostream.h>
 
namespace CeresEngine {
 
    class Logger final {
    private:
        mutable spdlog::logger logger;
 
    public:
        Logger(const char* name) noexcept; // NOLINT(google-explicit-constructor,hicpp-explicit-conversions)
 
        Logger(const String& name) noexcept; // NOLINT(google-explicit-constructor,hicpp-explicit-conversions)
 
    public:
        template<typename... Args> void trace(fmt::format_string<Args...> fmt, const Args&... args) const {
#if !defined(CE_LOGGER_NO_TRACE)
            logger.trace(fmt, args...);
#endif
        }
 
        template<typename... Args> void debug(fmt::format_string<Args...> fmt, const Args&... args) const {
#if !defined(CE_LOGGER_NO_DEBUG)
            logger.debug(fmt, args...);
#endif
        }
 
        template<typename... Args> void info(fmt::format_string<Args...> fmt, const Args&... args) const { logger.info(fmt, args...); }
 
        template<typename... Args> void warn(fmt::format_string<Args...> fmt, const Args&... args) const { logger.warn(fmt, args...); }
 
        template<typename... Args> void error(fmt::format_string<Args...> fmt, const Args&... args) const { logger.error(fmt, args...); }
 
        template<typename... Args> void critical(fmt::format_string<Args...> fmt, const Args&... args) const { logger.critical(fmt, args...); }
 
        template<typename... Args> void log(spdlog::level::level_enum level, fmt::format_string<Args...> fmt, const Args&... args) const {
            logger.log(level, fmt, args...);
        }
 
        void setLevel(const spdlog::level::level_enum level) const { logger.set_level(level); }
 
        void flush() const { logger.flush(); }
    };
 
    extern const Logger& gDefaultLogger();
 
    template<typename... Args> void trace(fmt::format_string<Args...> fmt, const Args&... args) { gDefaultLogger().trace(fmt, args...); }
 
    template<typename... Args> void debug(fmt::format_string<Args...> fmt, const Args&... args) { gDefaultLogger().debug(fmt, args...); }
 
    template<typename... Args> constexpr void info(fmt::format_string<Args...> fmt, const Args&... args) { gDefaultLogger().info(fmt, args...); }
 
    template<typename... Args> void warn(fmt::format_string<Args...> fmt, const Args&... args) { gDefaultLogger().warn(fmt, args...); }
 
    template<typename... Args> void error(fmt::format_string<Args...> fmt, const Args&... args) { gDefaultLogger().error(fmt, args...); }
 
    template<typename... Args> void critical(fmt::format_string<Args...> fmt, const Args&... args) { gDefaultLogger().critical(fmt, args...); }
 
    class BufferedSink : public spdlog::sinks::base_sink<Mutex> {
    private:
        Vector<String> messages;
 
    public:
        BufferedSink(); // NOLINT(google-explicit-constructor)
 
    public:
        [[nodiscard]] Vector<StringView> getMessages() const;
 
    protected:
        void sink_it_(const spdlog::details::log_msg& msg) final;
 
        void flush_() final;
    };
 
    extern SPtr<BufferedSink> bufferedSink;
 
} // namespace CeresEngine
 
 
//template <typename T> requires (fmt::detail::is_streamable<T, char>::value) struct fmt::formatter<T> : fmt::ostream_formatter {};
 
#endif