From 108382ed54e4df4bdfb6b469f512ab4603d08fc2 Mon Sep 17 00:00:00 2001 From: SeanOMik Date: Sat, 29 Oct 2022 16:20:28 -0400 Subject: [PATCH] Finish writting the logger --- .clang-tidy | 2 +- CMakeLists.txt | 10 +- cmrc | 2 +- examples/dev_testing/src/main.cpp | 5 +- include/simpleengine/log/logger.h | 293 ++++++++++++++++++++++++++++-- 5 files changed, 291 insertions(+), 21 deletions(-) diff --git a/.clang-tidy b/.clang-tidy index 593434a..0b2bb05 100644 --- a/.clang-tidy +++ b/.clang-tidy @@ -1,6 +1,6 @@ --- Checks: "clang-diagnostic-*,clang-analyzer-*,cppcoreguidelines-*,modernize-*,-modernize-use-trailing-return-type, - -*-non-private-member-variables-in-classes,-*-magic-numbers" + -*-non-private-member-variables-in-classes,-*-magic-numbers,-*-macro-usage" WarningsAsErrors: true HeaderFilterRegex: "" AnalyzeTemporaryDtors: false diff --git a/CMakeLists.txt b/CMakeLists.txt index ea9d78e..e69a6ab 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -21,8 +21,8 @@ find_package(GLEW REQUIRED) find_package(glfw3 CONFIG REQUIRED) find_package(glm CONFIG REQUIRED) find_package(OpenGL REQUIRED) -find_package(fmt REQUIRED) -find_package(spdlog REQUIRED) +find_package(fmt CONFIG REQUIRED) +find_package(spdlog CONFIG REQUIRED) find_package(assimp CONFIG REQUIRED) # Link sources @@ -47,14 +47,16 @@ cmrc_add_resource_library( # Link dependencies target_link_libraries(simpleengine PUBLIC GLEW::GLEW) target_link_libraries(simpleengine PUBLIC glfw) -target_link_libraries(simpleengine PUBLIC fmt) -target_link_libraries(simpleengine PUBLIC spdlog) target_link_libraries(simpleengine PUBLIC ${GLM_LIBRARIES}) target_link_libraries(simpleengine PUBLIC ${OPENGL_LIBRARIES}) if(WIN32) target_link_libraries(simpleengine PUBLIC assimp::assimp) + target_link_libraries(simpleengine PUBLIC fmt::fmt) + target_link_libraries(simpleengine PUBLIC spdlog::spdlog) else() target_link_libraries(simpleengine PUBLIC assimp) + target_link_libraries(simpleengine PUBLIC fmt) + target_link_libraries(simpleengine PUBLIC spdlog) endif() # Link resources diff --git a/cmrc b/cmrc index e386a62..a64bea5 160000 --- a/cmrc +++ b/cmrc @@ -1 +1 @@ -Subproject commit e386a629eb537d384811e598a3c96b9ca928f65e +Subproject commit a64bea50c05594c8e7cf1f08e441bb9507742e2e diff --git a/examples/dev_testing/src/main.cpp b/examples/dev_testing/src/main.cpp index e3a1f39..d0f2a5a 100644 --- a/examples/dev_testing/src/main.cpp +++ b/examples/dev_testing/src/main.cpp @@ -107,7 +107,10 @@ int main(int argc, char *argv[]) { se::log::LoggerManager::set_level(spdlog::level::trace); se::log::LoggerPtr logger = se::log::LoggerManager::get_core_logger(); - logger->info("Hmmmm very cool"); + logger->info("Hmmmm very cool. {}", "Yeah, I guess..."); + + SE_CLOG(spdlog::level::info, "This is a test. {}", "Did it work?"); + SE_CINFO("This is a 2nd test. {}!", "Did it work?"); // Load core shaders from SimpleEngine resources se::gfx::shaders::Core3dShader core_shader; diff --git a/include/simpleengine/log/logger.h b/include/simpleengine/log/logger.h index 0febd5b..a077573 100644 --- a/include/simpleengine/log/logger.h +++ b/include/simpleengine/log/logger.h @@ -14,6 +14,13 @@ namespace simpleengine::log { private: std::shared_ptr inner; public: + /** + * @brief Construct a new Logger object from a name + * + * This will first check if the logger exists, if it does not it will create a new `color_mt` logger + * + * @param name The name of the logger. + */ Logger(std::string name) { inner = spdlog::get(name); @@ -22,79 +29,192 @@ namespace simpleengine::log { } } + /** + * @brief Construct a new Logger object using a spdlog::logger + * + * @param logger The inner spdlog::logger that this object will use + */ Logger(std::shared_ptr logger) : inner(logger) { } + /** + * @brief Get the inner spdlog logger object + * + * @return std::shared_ptr + */ std::shared_ptr get_inner() { return inner; } + /** + * @brief Set the log level. + * + * @param lvl The level to set the log to + */ void set_level(spdlog::level::level_enum lvl) { inner->set_level(lvl); } + /** + * @brief Log a message. + * + * @param lvl Level to log at + * @param msg The message to log + */ void log(spdlog::level::level_enum lvl, spdlog::string_view_t msg) { inner->log(spdlog::source_loc{}, lvl, msg); } + /** + * @brief Log a formatted message. + * + * @tparam Args + * @param lvl Level to log at + * @param fmt The string that will be formatted + * @param args The arguments to format into the message. + */ + template + void log(spdlog::level::level_enum lvl, fmt::format_string fmt, Args &&...args) + { + inner->log(spdlog::source_loc{}, lvl, fmt, std::forward(args)...); + } + + /** + * @brief Log a trace message. + * + * @tparam T + * @param msg The message that will be logged. + */ template void trace(const T &msg) { log(spdlog::level::trace, msg); } + /** + * @brief Log a debug message. + * + * @tparam T + * @param msg The message that will be logged. + */ template void debug(const T &msg) { log(spdlog::level::debug, msg); } + /** + * @brief Log an info message. + * + * @tparam T + * @param msg The message that will be logged. + */ template void info(const T &msg) { log(spdlog::level::info, msg); } + /** + * @brief Log a warning message. + * + * @tparam T + * @param msg The message that will be logged. + */ template void warn(const T &msg) { log(spdlog::level::warn, msg); } + /** + * @brief Log an error message. + * + * @tparam T + * @param msg The message that will be logged. + */ template void error(const T &msg) { log(spdlog::level::err, msg); } + /** + * @brief Log a critical message. + * + * @tparam T + * @param msg The message that will be logged. + */ template void critical(const T &msg) { log(spdlog::level::critical, msg); } + /** + * @brief Log a trace message. + * + * @tparam Args + * @param fmt String that will be formatted + * @param args Arguments to format into the message + */ template - void trace(spdlog::format_string_t fmt, Args &&... args) { + void trace(fmt::format_string fmt, Args &&... args) { log(spdlog::level::trace, fmt, std::forward(args)...); } + /** + * @brief Log a debug message. + * + * @tparam Args + * @param fmt String that will be formatted + * @param args Arguments to format into the message + */ template - void debug(spdlog::format_string_t fmt, Args &&... args) { + void debug(fmt::format_string fmt, Args &&... args) { log(spdlog::level::debug, fmt, std::forward(args)...); } + /** + * @brief Log an info message. + * + * @tparam Args + * @param fmt String that will be formatted + * @param args Arguments to format into the message + */ template - void info(spdlog::format_string_t fmt, Args &&... args) { + void info(fmt::format_string fmt, Args &&... args) { log(spdlog::level::info, fmt, std::forward(args)...); } + /** + * @brief Log a warning message. + * + * @tparam Args + * @param fmt String that will be formatted + * @param args Arguments to format into the message + */ template - void warn(spdlog::format_string_t fmt, Args &&... args) { + void warn(fmt::format_string fmt, Args &&... args) { log(spdlog::level::warn, fmt, std::forward(args)...); } + /** + * @brief Log an error message. + * + * @tparam Args + * @param fmt String that will be formatted + * @param args Arguments to format into the message + */ template - void error(spdlog::format_string_t fmt, Args &&... args) { + void error(fmt::format_string fmt, Args &&... args) { log(spdlog::level::err, fmt, std::forward(args)...); } + /** + * @brief Log a critical message. + * + * @tparam Args + * @param fmt String that will be formatted + * @param args Arguments to format into the message + */ template - void critical(spdlog::format_string_t fmt, Args &&... args) { + void critical(fmt::format_string fmt, Args &&... args) { log(spdlog::level::critical, fmt, std::forward(args)...); } }; @@ -103,20 +223,165 @@ namespace simpleengine::log { class LoggerManager { private: - static std::shared_ptr core_logger; + const static std::shared_ptr core_logger; public: - /* LoggerManager() { - spdlog::set_pattern("[%R - %D] [%l] [thread %t] [%n] %v"); - - core_logger = std::make_shared("Engine"); - } */ - + /** + * @brief Initialize the logger. + * + */ static void init(); + + /** + * @brief Set the core log level. + * + * @param lvl + */ static void set_level(spdlog::level::level_enum lvl); + /** + * @brief Get the core logger. + * + * @return std::shared_ptr + */ static std::shared_ptr get_core_logger(); + /** + * @brief Create a new logger. + * + * @param name The name of the logger + * @return Logger + */ static Logger create_logger(std::string name); + + /** + * @brief Get a logger using its name. + * + * @param name The name of the logger + * @return Logger + */ static Logger get_logger(std::string name); }; -} \ No newline at end of file +} + +// Log macros + +/** + * @brief Log to a logger. + * + * @param logger_name The name of the logger to log to. + * @param level The level to log at. + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_LOG(logger_name, level, message, ...) simpleengine::log::LoggerManager::get_logger(logger_name).log(level, fmt::format(message, ##__VA_ARGS__)); + +/** + * @brief Log to the core logger. + * + * @param level The level to log at. + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_CLOG(level, message, ...) simpleengine::log::LoggerManager::get_core_logger()->log(level, fmt::format(message, ##__VA_ARGS__)); + +/** + * @brief Log a critical message to a logger. + * + * @param logger_name The name of the logger to log to. + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_CRIT(logger_name, message, ...) SE_LOG(logger_name, spdlog::level::critical, message, ##__VA_ARGS__); + +/** + * @brief Log a critical message to the core logger. + * + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_CCRIT(message, ...) SE_CLOG(spdlog::level::critical, message, ##__VA_ARGS__); + +/** + * @brief Log an error message to a logger. + * + * @param logger_name The name of the logger to log to. + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_ERROR(logger_name, message, ...) SE_LOG(logger_name, spdlog::level::error, message, ##__VA_ARGS__); + +/** + * @brief Log an error message to the core logger. + * + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_CERROR(message, ...) SE_CLOG(spdlog::level::error, message, ##__VA_ARGS__); + +/** + * @brief Log a warning message to a logger. + * + * @param logger_name The name of the logger to log to. + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_WARN(logger_name, message, ...) SE_LOG(logger_name, spdlog::level::warn, message, ##__VA_ARGS__); + +/** + * @brief Log a warning message to the core logger. + * + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_CWARN(message, ...) SE_CLOG(spdlog::level::warn, message, ##__VA_ARGS__); + +/** + * @brief Log an info message to a logger. + * + * @param logger_name The name of the logger to log to. + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_INFO(logger_name, message, ...) SE_LOG(logger_name, spdlog::level::info, message, ##__VA_ARGS__); + +/** + * @brief Log an info message to the core logger. + * + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_CINFO(message, ...) SE_CLOG(spdlog::level::info, message, ##__VA_ARGS__); + +/** + * @brief Log a debug message to a logger. + * + * @param logger_name The name of the logger to log to. + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_DEBUG(logger_name, message, ...) SE_LOG(logger_name, spdlog::level::debug, message, ##__VA_ARGS__); + +/** + * @brief Log a debug message to the core logger. + * + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_CDEBUG(message, ...) SE_CLOG(spdlog::level::debug, message, ##__VA_ARGS__); + +/** + * @brief Log a trace message to a logger. + * + * @param logger_name The name of the logger to log to. + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_TRACE(logger_name, message, ...) SE_LOG(logger_name, spdlog::level::trace, message, ##__VA_ARGS__); + +/** + * @brief Log a trace message to the core logger. + * + * @param message The (to be) formatted message to log. + * @param ... The variables that will be formatted in the text. + */ +#define SE_CTRACE(message, ...) SE_CLOG(spdlog::level::trace, message, ##__VA_ARGS__); \ No newline at end of file