diff --git a/example/bench.cpp b/example/bench.cpp index 9780e85f..82b47bc0 100644 --- a/example/bench.cpp +++ b/example/bench.cpp @@ -7,6 +7,7 @@ // bench.cpp : spdlog benchmarks // #include "spdlog/async.h" +#include "spdlog/sinks/file_sinks.h" #include "spdlog/sinks/null_sink.h" #include "spdlog/spdlog.h" diff --git a/example/example.cpp b/example/example.cpp index e5d7fa45..00111a2d 100644 --- a/example/example.cpp +++ b/example/example.cpp @@ -1,4 +1,4 @@ -// +// // Copyright(c) 2015 Gabi Melman. // Distributed under the MIT License (http://opensource.org/licenses/MIT) // @@ -10,9 +10,8 @@ #define SPDLOG_TRACE_ON #define SPDLOG_DEBUG_ON - -#include "spdlog/sinks/stdout_color_sinks.h" #include "spdlog/sinks/file_sinks.h" +#include "spdlog/sinks/stdout_color_sinks.h" #include #include @@ -25,104 +24,103 @@ namespace spd = spdlog; int main(int, char *[]) { - try - { - auto console = spdlog::stdout_color_st("console"); - console->info("Welcome to spdlog!"); + try + { + auto console = spdlog::stdout_color_st("console"); + console->info("Welcome to spdlog!"); - console->info("Welcome to spdlog!"); - console->error("Some error message with arg: {}", 1); - err_handler_example(); - // Formatting examples - console->warn("Easy padding in numbers like {:08d}", 12); - console->critical("Support for int: {0:d}; hex: {0:x}; oct: {0:o}; bin: {0:b}", 42); - console->info("Support for floats {:03.2f}", 1.23456); - console->info("Positional args are {1} {0}..", "too", "supported"); - console->info("{:<30}", "left aligned"); + console->info("Welcome to spdlog!"); + console->error("Some error message with arg: {}", 1); + err_handler_example(); + // Formatting examples + console->warn("Easy padding in numbers like {:08d}", 12); + console->critical("Support for int: {0:d}; hex: {0:x}; oct: {0:o}; bin: {0:b}", 42); + console->info("Support for floats {:03.2f}", 1.23456); + console->info("Positional args are {1} {0}..", "too", "supported"); + console->info("{:<30}", "left aligned"); - spd::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name) function"); + spd::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name) function"); - // Create basic file logger (not rotated) - auto my_logger = spd::basic_logger_mt("basic_logger", "logs/basic-log.txt"); - my_logger->info("Some log message"); + // Create basic file logger (not rotated) + auto my_logger = spd::basic_logger_mt("basic_logger", "logs/basic-log.txt"); + my_logger->info("Some log message"); - // Create a file rotating logger with 5mb size max and 3 rotated files - auto rotating_logger = spd::rotating_logger_mt("some_logger_name", "logs/rotating.txt", 1048576 * 5, 3); - for (int i = 0; i < 10; ++i) - { - rotating_logger->info("{} * {} equals {:>10}", i, i, i * i); - } + // Create a file rotating logger with 5mb size max and 3 rotated files + auto rotating_logger = spd::rotating_logger_mt("some_logger_name", "logs/rotating.txt", 1048576 * 5, 3); + for (int i = 0; i < 10; ++i) + { + rotating_logger->info("{} * {} equals {:>10}", i, i, i * i); + } - // Create a daily logger - a new file is created every day on 2:30am - auto daily_logger = spd::daily_logger_mt("daily_logger", "logs/daily.txt", 2, 30); - // trigger flush if the log severity is error or higher - daily_logger->flush_on(spd::level::err); - daily_logger->info(123.44); + // Create a daily logger - a new file is created every day on 2:30am + auto daily_logger = spd::daily_logger_mt("daily_logger", "logs/daily.txt", 2, 30); + // trigger flush if the log severity is error or higher + daily_logger->flush_on(spd::level::err); + daily_logger->info(123.44); - // Customize msg format for all messages - //spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); //crash + // Customize msg format for all messages + // spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); //crash - console->info("This an info message with custom format"); - console->error("This an error message with custom format"); + console->info("This an info message with custom format"); + console->error("This an error message with custom format"); - // Runtime log levels - spd::set_level(spd::level::info); // Set global log level to info - console->debug("This message should not be displayed!"); - console->set_level(spd::level::debug); // Set specific logger's log level - console->debug("This message should be displayed.."); + // Runtime log levels + spd::set_level(spd::level::info); // Set global log level to info + console->debug("This message should not be displayed!"); + console->set_level(spd::level::debug); // Set specific logger's log level + console->debug("This message should be displayed.."); - // Compile time log levels - // define SPDLOG_DEBUG_ON or SPDLOG_TRACE_ON - SPDLOG_TRACE(console, "Enabled only #ifdef SPDLOG_TRACE_ON..{} ,{}", 1, 3.23); - SPDLOG_DEBUG(console, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23); + // Compile time log levels + // define SPDLOG_DEBUG_ON or SPDLOG_TRACE_ON + SPDLOG_TRACE(console, "Enabled only #ifdef SPDLOG_TRACE_ON..{} ,{}", 1, 3.23); + SPDLOG_DEBUG(console, "Enabled only #ifdef SPDLOG_DEBUG_ON.. {} ,{}", 1, 3.23); - // Asynchronous logging is very fast.. - // Just call spdlog::set_async_mode(q_size) and all created loggers from now on will be asynchronous.. - async_example(); - + // Asynchronous logging is very fast.. + // Just call spdlog::set_async_mode(q_size) and all created loggers from now on will be asynchronous.. + async_example(); - // Log user-defined types example - user_defined_example(); + // Log user-defined types example + user_defined_example(); - // Change default log error handler - err_handler_example(); + // Change default log error handler + err_handler_example(); - // Apply a function on all registered loggers - spd::apply_all([&](std::shared_ptr l) { l->info("End of example."); }); + // Apply a function on all registered loggers + spd::apply_all([&](std::shared_ptr l) { l->info("End of example."); }); - // Release and close all loggers - spdlog::drop_all(); - } - // Exceptions will only be thrown upon failed logger or sink construction (not during logging) - catch (const spd::spdlog_ex &ex) - { - std::cout << "Log init failed: " << ex.what() << std::endl; - return 1; - } + // Release and close all loggers + spdlog::drop_all(); + } + // Exceptions will only be thrown upon failed logger or sink construction (not during logging) + catch (const spd::spdlog_ex &ex) + { + std::cout << "Log init failed: " << ex.what() << std::endl; + return 1; + } } // must be included to use async logger #include "spdlog/async.h" void async_example() { - auto async_file = spd::basic_logger_mt("async_file_logger", "logs/async_log.txt"); - for (int i = 0; i < 100; ++i) - { - async_file->info("Async message #{}", i); - } + auto async_file = spd::basic_logger_mt("async_file_logger", "logs/async_log.txt"); + for (int i = 0; i < 100; ++i) + { + async_file->info("Async message #{}", i); + } - // you can also modify thread pool settings *before* creating the logger: - // spdlog::init_thread_pool(32768, 4); // queue with 32k of pre allocated items and 4 backing threads. - // if not called a defaults are: preallocated 8192 queue items and 1 worker thread. + // you can also modify thread pool settings *before* creating the logger: + // spdlog::init_thread_pool(32768, 4); // queue with 32k of pre allocated items and 4 backing threads. + // if not called a defaults are: preallocated 8192 queue items and 1 worker thread. } // syslog example (linux/osx/freebsd) #ifndef _WIN32 -#incude "spdlog/sinks/syslog_sink.h" +#include "spdlog/sinks/syslog_sink.h" void syslog_example() { - std::string ident = "spdlog-example"; - auto syslog_logger = spd::syslog_logger("syslog", ident, LOG_PID); - syslog_logger->warn("This is warning that will end up in syslog."); + std::string ident = "spdlog-example"; + auto syslog_logger = spd::syslog_logger("syslog", ident, LOG_PID); + syslog_logger->warn("This is warning that will end up in syslog."); } #endif @@ -131,9 +129,9 @@ void syslog_example() #incude "spdlog/sinks/android_sink.h" void android_example() { - std::string tag = "spdlog-android"; - auto android_logger = spd::android_logger("android", tag); - android_logger->critical("Use \"adb shell logcat\" to view this message."); + std::string tag = "spdlog-android"; + auto android_logger = spd::android_logger("android", tag); + android_logger->critical("Use \"adb shell logcat\" to view this message."); } #endif @@ -141,18 +139,18 @@ void android_example() // user defined types logging by implementing operator<< struct my_type { - int i; - template - friend OStream &operator<<(OStream &os, const my_type &c) - { - return os << "[my_type i=" << c.i << "]"; - } + int i; + template + friend OStream &operator<<(OStream &os, const my_type &c) + { + return os << "[my_type i=" << c.i << "]"; + } }; #include "spdlog/fmt/ostr.h" // must be included void user_defined_example() { - spd::get("console")->info("user defined type: {}", my_type{ 14 }); + spd::get("console")->info("user defined type: {}", my_type{14}); } // @@ -160,8 +158,8 @@ void user_defined_example() // void err_handler_example() { - // can be set globaly or per logger(logger->set_error_handler(..)) - spdlog::set_error_handler([](const std::string &msg) { spd::get("console")->error("*******my err handler: {}", msg); }); - spd::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3); - //spd::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3); + // can be set globaly or per logger(logger->set_error_handler(..)) + spdlog::set_error_handler([](const std::string &msg) { spd::get("console")->error("*******my err handler: {}", msg); }); + spd::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3); + // spd::get("console")->info("some invalid message to trigger an error {}{}{}{}", 3); } diff --git a/include/spdlog/async.h b/include/spdlog/async.h index 07368b04..3aee06fd 100644 --- a/include/spdlog/async.h +++ b/include/spdlog/async.h @@ -41,7 +41,7 @@ struct create_async auto new_logger = std::make_shared(logger_name, std::move(sink), std::move(tp), async_overflow_policy::block_retry); registry::instance().register_and_init(new_logger); return new_logger; - } + } }; template diff --git a/include/spdlog/details/async_logger_impl.h b/include/spdlog/details/async_logger_impl.h index 8c80cd2f..969ec72b 100644 --- a/include/spdlog/details/async_logger_impl.h +++ b/include/spdlog/details/async_logger_impl.h @@ -37,18 +37,18 @@ inline spdlog::async_logger::async_logger( // send the log message to the thread pool inline void spdlog::async_logger::_sink_it(details::log_msg &msg) -{ +{ #if defined(SPDLOG_ENABLE_MESSAGE_COUNTER) - _incr_msg_counter(msg); + _incr_msg_counter(msg); #endif - if (auto pool_ptr = _thread_pool.lock()) - { - pool_ptr->post_log(shared_from_this(), std::move(msg), _overflow_policy); - } - else - { - throw spdlog_ex("async log: thread pool doens't exist anymore"); - } + if (auto pool_ptr = _thread_pool.lock()) + { + pool_ptr->post_log(shared_from_this(), std::move(msg), _overflow_policy); + } + else + { + throw spdlog_ex("async log: thread pool doens't exist anymore"); + } } // send flush request to the thread pool @@ -89,10 +89,10 @@ inline void spdlog::async_logger::_backend_log(details::log_msg &incoming_log_ms _err_handler("Unknown exception in async logger " + _name); } - if (_should_flush(incoming_log_msg)) - { - _backend_flush(); - } + if (_should_flush(incoming_log_msg)) + { + _backend_flush(); + } } inline void spdlog::async_logger::_backend_flush() diff --git a/include/spdlog/details/logger_impl.h b/include/spdlog/details/logger_impl.h index f2e0f8e1..19c22924 100644 --- a/include/spdlog/details/logger_impl.h +++ b/include/spdlog/details/logger_impl.h @@ -5,9 +5,6 @@ #pragma once -#include "../logger.h" -#include "../sinks/stdout_sinks.h" - #include #include diff --git a/include/spdlog/details/os.h b/include/spdlog/details/os.h index 50d8516e..ba421ff1 100644 --- a/include/spdlog/details/os.h +++ b/include/spdlog/details/os.h @@ -13,11 +13,11 @@ #include #include #include +#include #include #include #include #include -#include #ifdef _WIN32 @@ -476,18 +476,6 @@ inline bool in_terminal(FILE *file) #endif } -// stdout/stderr global mutexes -inline std::mutex& stdout_mutex() -{ - static std::mutex &mutex = std::mutex{}; - return mutex; -} - -inline std::mutex& stderr_mutex() -{ - static std::mutex &mutex = std::mutex{}; - return mutex; -} } // namespace os } // namespace details } // namespace spdlog diff --git a/include/spdlog/details/registry.h b/include/spdlog/details/registry.h index 0e4b0dec..00f09848 100644 --- a/include/spdlog/details/registry.h +++ b/include/spdlog/details/registry.h @@ -148,16 +148,15 @@ public: void drop_all() { - { - std::lock_guard lock(_mutex); - _loggers.clear(); - } + { + std::lock_guard lock(_mutex); + _loggers.clear(); + } - { - std::lock_guard lock(_tp_mutex); - _tp.reset(); - } - + { + std::lock_guard lock(_tp_mutex); + _tp.reset(); + } } Mutex &tp_mutex() diff --git a/include/spdlog/details/traits.h b/include/spdlog/details/traits.h index fb44fa18..6ce2cb27 100644 --- a/include/spdlog/details/traits.h +++ b/include/spdlog/details/traits.h @@ -6,41 +6,53 @@ #include "stdio.h" namespace spdlog { - namespace details { - struct console_stdout_trait - { - static FILE* stream() {return stdout;} +namespace details { +struct console_stdout_trait +{ + static FILE *stream() + { + return stdout; + } #ifdef _WIN32 - static HANDLE handle() { return ::GetStdHandle(STD_OUTPUT_HANDLE); } + static HANDLE handle() + { + return ::GetStdHandle(STD_OUTPUT_HANDLE); + } #endif - }; +}; - struct console_stderr_trait - { - static FILE* stream() { return stdout; } +struct console_stderr_trait +{ + static FILE *stream() + { + return stdout; + } #ifdef _WIN32 - static HANDLE handle() { return ::GetStdHandle(STD_ERROR_HANDLE); } + static HANDLE handle() + { + return ::GetStdHandle(STD_ERROR_HANDLE); + } #endif - }; +}; - struct console_mutex_trait - { - using mutex_t = std::mutex; - static mutex_t& console_mutex() - { - static auto &mutex = mutex_t{}; - return mutex; - } - }; +struct console_mutex_trait +{ + using mutex_t = std::mutex; + static mutex_t &console_mutex() + { + static mutex_t mutex; + return mutex; + } +}; - struct console_null_mutex_trait - { - using mutex_t = null_mutex; - static mutex_t& console_mutex() - { - static auto mutex = mutex_t{}; - return mutex; - } - }; - } -} +struct console_null_mutex_trait +{ + using mutex_t = null_mutex; + static mutex_t &console_mutex() + { + static mutex_t mutex; + return mutex; + } +}; +} // namespace details +} // namespace spdlog diff --git a/include/spdlog/logger.h b/include/spdlog/logger.h index bdb41f65..fa7de956 100644 --- a/include/spdlog/logger.h +++ b/include/spdlog/logger.h @@ -13,8 +13,8 @@ // 3. Pass the formatted message to its sinks to performa the actual logging #include "common.h" -#include "sinks/sink.h" #include "formatter.h" +#include "sinks/sink.h" #include #include diff --git a/include/spdlog/sinks/android_sink.h b/include/spdlog/sinks/android_sink.h index 1b1d9b66..dd00fffe 100644 --- a/include/spdlog/sinks/android_sink.h +++ b/include/spdlog/sinks/android_sink.h @@ -21,81 +21,79 @@ #endif namespace spdlog { - namespace sinks { +namespace sinks { - /* - * Android sink (logging using __android_log_write) - * __android_log_write is thread-safe. No lock is needed. - */ - class android_sink : public sink - { - public: - explicit android_sink(const std::string &tag = "spdlog", bool use_raw_msg = false) - : _tag(tag) - , _use_raw_msg(use_raw_msg) - { - } +/* + * Android sink (logging using __android_log_write) + * __android_log_write is thread-safe. No lock is needed. + */ +class android_sink : public sink +{ +public: + explicit android_sink(const std::string &tag = "spdlog", bool use_raw_msg = false) + : _tag(tag) + , _use_raw_msg(use_raw_msg) + { + } - void log(const details::log_msg &msg) override - { - const android_LogPriority priority = convert_to_android(msg.level); - const char *msg_output = (_use_raw_msg ? msg.raw.c_str() : msg.formatted.c_str()); + void log(const details::log_msg &msg) override + { + const android_LogPriority priority = convert_to_android(msg.level); + const char *msg_output = (_use_raw_msg ? msg.raw.c_str() : msg.formatted.c_str()); - // See system/core/liblog/logger_write.c for explanation of return value - int ret = __android_log_write(priority, _tag.c_str(), msg_output); - int retry_count = 0; - while ((ret == -11 /*EAGAIN*/) && (retry_count < SPDLOG_ANDROID_RETRIES)) - { - details::os::sleep_for_millis(5); - ret = __android_log_write(priority, _tag.c_str(), msg_output); - retry_count++; - } + // See system/core/liblog/logger_write.c for explanation of return value + int ret = __android_log_write(priority, _tag.c_str(), msg_output); + int retry_count = 0; + while ((ret == -11 /*EAGAIN*/) && (retry_count < SPDLOG_ANDROID_RETRIES)) + { + details::os::sleep_for_millis(5); + ret = __android_log_write(priority, _tag.c_str(), msg_output); + retry_count++; + } - if (ret < 0) - { - throw spdlog_ex("__android_log_write() failed", ret); - } - } + if (ret < 0) + { + throw spdlog_ex("__android_log_write() failed", ret); + } + } - void flush() override {} + void flush() override {} - private: - static android_LogPriority convert_to_android(spdlog::level::level_enum level) - { - switch (level) - { - case spdlog::level::trace: - return ANDROID_LOG_VERBOSE; - case spdlog::level::debug: - return ANDROID_LOG_DEBUG; - case spdlog::level::info: - return ANDROID_LOG_INFO; - case spdlog::level::warn: - return ANDROID_LOG_WARN; - case spdlog::level::err: - return ANDROID_LOG_ERROR; - case spdlog::level::critical: - return ANDROID_LOG_FATAL; - default: - return ANDROID_LOG_DEFAULT; - } - } +private: + static android_LogPriority convert_to_android(spdlog::level::level_enum level) + { + switch (level) + { + case spdlog::level::trace: + return ANDROID_LOG_VERBOSE; + case spdlog::level::debug: + return ANDROID_LOG_DEBUG; + case spdlog::level::info: + return ANDROID_LOG_INFO; + case spdlog::level::warn: + return ANDROID_LOG_WARN; + case spdlog::level::err: + return ANDROID_LOG_ERROR; + case spdlog::level::critical: + return ANDROID_LOG_FATAL; + default: + return ANDROID_LOG_DEFAULT; + } + } - std::string _tag; - bool _use_raw_msg; - }; + std::string _tag; + bool _use_raw_msg; +}; - } // namespace sinks +} // namespace sinks +// Create and register android syslog logger - // Create and register android syslog logger - - template - inline std::shared_ptr android_logger(const std::string &logger_name, const std::string &tag = "spdlog") - { - return return Factory::template create(logger_name, tag); - } - +template +inline std::shared_ptr android_logger(const std::string &logger_name, const std::string &tag = "spdlog") +{ + return return Factory::template create(logger_name, tag); +} } // namespace spdlog diff --git a/include/spdlog/sinks/ansicolor_sink.h b/include/spdlog/sinks/ansicolor_sink.h index 41eb0f7f..40424fc2 100644 --- a/include/spdlog/sinks/ansicolor_sink.h +++ b/include/spdlog/sinks/ansicolor_sink.h @@ -9,137 +9,131 @@ #include "../details/os.h" #include "../details/traits.h" -#include -#include #include #include +#include +#include namespace spdlog { - namespace sinks { +namespace sinks { - /** - * This sink prefixes the output with an ANSI escape sequence color code depending on the severity - * of the message. - * If no color terminal detected, omit the escape codes. - */ - template - class ansicolor_sink : public sink - { - public: - using mutex_t = typename ConsoleMutexTrait::mutex_t; - ansicolor_sink() - : target_file_(StdoutTrait::stream()), - _mutex(ConsoleMutexTrait::mutex()) +/** + * This sink prefixes the output with an ANSI escape sequence color code depending on the severity + * of the message. + * If no color terminal detected, omit the escape codes. + */ +template +class ansicolor_sink : public sink +{ +public: + using mutex_t = typename ConsoleMutexTrait::mutex_t; + ansicolor_sink() + : target_file_(StdoutTrait::stream()) + , _mutex(ConsoleMutexTrait::console_mutex()) - { - should_do_colors_ = details::os::in_terminal(file) && details::os::is_color_terminal(); - colors_[level::trace] = white; - colors_[level::debug] = cyan; - colors_[level::info] = green; - colors_[level::warn] = yellow + bold; - colors_[level::err] = red + bold; - colors_[level::critical] = bold + on_red; - colors_[level::off] = reset; - } + { + should_do_colors_ = details::os::in_terminal(target_file_) && details::os::is_color_terminal(); + colors_[level::trace] = white; + colors_[level::debug] = cyan; + colors_[level::info] = green; + colors_[level::warn] = yellow + bold; + colors_[level::err] = red + bold; + colors_[level::critical] = bold + on_red; + colors_[level::off] = reset; + } - ~ansicolor_sink() override - { - _flush(); - } + ~ansicolor_sink() override = default; - ansicolor_sink(const ansicolor_sink &other) = delete; - ansicolor_sink &operator=(const ansicolor_sink &other) = delete; + ansicolor_sink(const ansicolor_sink &other) = delete; + ansicolor_sink &operator=(const ansicolor_sink &other) = delete; - void set_color(level::level_enum color_level, const std::string &color) - { - std::lock_guard lock(_mutex); - colors_[color_level] = color; - } + void set_color(level::level_enum color_level, const std::string &color) + { + std::lock_guard lock(_mutex); + colors_[color_level] = color; + } - /// Formatting codes - const std::string reset = "\033[m"; - const std::string bold = "\033[1m"; - const std::string dark = "\033[2m"; - const std::string underline = "\033[4m"; - const std::string blink = "\033[5m"; - const std::string reverse = "\033[7m"; - const std::string concealed = "\033[8m"; - const std::string clear_line = "\033[K"; + /// Formatting codes + const std::string reset = "\033[m"; + const std::string bold = "\033[1m"; + const std::string dark = "\033[2m"; + const std::string underline = "\033[4m"; + const std::string blink = "\033[5m"; + const std::string reverse = "\033[7m"; + const std::string concealed = "\033[8m"; + const std::string clear_line = "\033[K"; - // Foreground colors - const std::string black = "\033[30m"; - const std::string red = "\033[31m"; - const std::string green = "\033[32m"; - const std::string yellow = "\033[33m"; - const std::string blue = "\033[34m"; - const std::string magenta = "\033[35m"; - const std::string cyan = "\033[36m"; - const std::string white = "\033[37m"; + // Foreground colors + const std::string black = "\033[30m"; + const std::string red = "\033[31m"; + const std::string green = "\033[32m"; + const std::string yellow = "\033[33m"; + const std::string blue = "\033[34m"; + const std::string magenta = "\033[35m"; + const std::string cyan = "\033[36m"; + const std::string white = "\033[37m"; - /// Background colors - const std::string on_black = "\033[40m"; - const std::string on_red = "\033[41m"; - const std::string on_green = "\033[42m"; - const std::string on_yellow = "\033[43m"; - const std::string on_blue = "\033[44m"; - const std::string on_magenta = "\033[45m"; - const std::string on_cyan = "\033[46m"; - const std::string on_white = "\033[47m"; + /// Background colors + const std::string on_black = "\033[40m"; + const std::string on_red = "\033[41m"; + const std::string on_green = "\033[42m"; + const std::string on_yellow = "\033[43m"; + const std::string on_blue = "\033[44m"; + const std::string on_magenta = "\033[45m"; + const std::string on_cyan = "\033[46m"; + const std::string on_white = "\033[47m"; + void log(const details::log_msg &msg) SPDLOG_FINAL override + { + // Wrap the originally formatted message in color codes. + // If color is not supported in the terminal, log as is instead. + std::lock_guard lock(_mutex); + if (should_do_colors_ && msg.color_range_end > msg.color_range_start) + { + // before color range + _print_range(msg, 0, msg.color_range_start); + // in color range + _print_ccode(colors_[msg.level]); + _print_range(msg, msg.color_range_start, msg.color_range_end); + _print_ccode(reset); + // after color range + _print_range(msg, msg.color_range_end, msg.formatted.size()); + } + else // no color + { + _print_range(msg, 0, msg.formatted.size()); + } + fflush(target_file_); + } - void log(const details::log_msg &msg) SPDLOG_FINAL override - { - // Wrap the originally formatted message in color codes. - // If color is not supported in the terminal, log as is instead. - std::lock_guard lock(_mutex); - if (should_do_colors_ && msg.color_range_end > msg.color_range_start) - { - // before color range - _print_range(msg, 0, msg.color_range_start); - // in color range - _print_ccode(colors_[msg.level]); - _print_range(msg, msg.color_range_start, msg.color_range_end); - _print_ccode(reset); - // after color range - _print_range(msg, msg.color_range_end, msg.formatted.size()); - } - else // no color - { - _print_range(msg, 0, msg.formatted.size()); - } - fflush(target_file_); - } + void flush() SPDLOG_FINAL override + { + std::lock_guard lock(_mutex); + fflush(target_file_); + } - void flush() SPDLOG_FINAL override - { - std::lock_guard lock(_mutex); - fflush(target_file_); - } +private: + void _print_ccode(const std::string &color_code) + { + fwrite(color_code.data(), sizeof(char), color_code.size(), target_file_); + } + void _print_range(const details::log_msg &msg, size_t start, size_t end) + { + fwrite(msg.formatted.data() + start, sizeof(char), end - start, target_file_); + } + FILE *target_file_; + mutex_t &_mutex; - private: + bool should_do_colors_; + std::unordered_map colors_; +}; - void _print_ccode(const std::string &color_code) - { - fwrite(color_code.data(), sizeof(char), color_code.size(), target_file_); - } - void _print_range(const details::log_msg &msg, size_t start, size_t end) - { - fwrite(msg.formatted.data() + start, sizeof(char), end - start, target_file_); - } +using ansicolor_stdout_sink_mt = ansicolor_sink; +using ansicolor_stdout_sink_st = ansicolor_sink; +using ansicolor_stderr_sink_mt = ansicolor_sink; +using ansicolor_stderr_sink_st = ansicolor_sink; - FILE *target_file_; - mutex_t & _mutex; - - bool should_do_colors_; - std::unordered_map colors_; - }; - - using ansicolor_stdout_sink_mt = ansicolor_sink; - using ansicolor_stdout_sink_st = ansicolor_sink; - using ansicolor_stderr_sink_mt = ansicolor_sink; - using ansicolor_stderr_sink_st = ansicolor_sink; - - } // namespace sinks +} // namespace sinks } // namespace spdlog diff --git a/include/spdlog/sinks/file_sinks.h b/include/spdlog/sinks/file_sinks.h index 39e341eb..b4c39f99 100644 --- a/include/spdlog/sinks/file_sinks.h +++ b/include/spdlog/sinks/file_sinks.h @@ -4,10 +4,10 @@ // #pragma once - #include "../details/file_helper.h" #include "../details/null_mutex.h" #include "../fmt/fmt.h" +#include "../spdlog.h" #include "base_sink.h" #include @@ -19,286 +19,286 @@ #include namespace spdlog { - namespace sinks { - /* - * Trivial file sink with single file as target - */ - template - class simple_file_sink SPDLOG_FINAL : public base_sink - { - public: - explicit simple_file_sink(const filename_t &filename, bool truncate = false) - : _force_flush(false) - { - _file_helper.open(filename, truncate); - } +namespace sinks { +/* + * Trivial file sink with single file as target + */ +template +class simple_file_sink SPDLOG_FINAL : public base_sink +{ +public: + explicit simple_file_sink(const filename_t &filename, bool truncate = false) + : _force_flush(false) + { + _file_helper.open(filename, truncate); + } - void set_force_flush(bool force_flush) - { - _force_flush = force_flush; - } + void set_force_flush(bool force_flush) + { + _force_flush = force_flush; + } - protected: - void _sink_it(const details::log_msg &msg) override - { - _file_helper.write(msg); - if (_force_flush) - { - _file_helper.flush(); - } - } +protected: + void _sink_it(const details::log_msg &msg) override + { + _file_helper.write(msg); + if (_force_flush) + { + _file_helper.flush(); + } + } - void _flush() override - { - _file_helper.flush(); - } + void _flush() override + { + _file_helper.flush(); + } - private: - details::file_helper _file_helper; - bool _force_flush; - }; +private: + details::file_helper _file_helper; + bool _force_flush; +}; - using simple_file_sink_mt = simple_file_sink; - using simple_file_sink_st = simple_file_sink; +using simple_file_sink_mt = simple_file_sink; +using simple_file_sink_st = simple_file_sink; - /* - * Rotating file sink based on size - */ - template - class rotating_file_sink SPDLOG_FINAL : public base_sink - { - public: - rotating_file_sink(filename_t base_filename, std::size_t max_size, std::size_t max_files) - : _base_filename(std::move(base_filename)) - , _max_size(max_size) - , _max_files(max_files) - { - _file_helper.open(calc_filename(_base_filename, 0)); - _current_size = _file_helper.size(); // expensive. called only once - } +/* + * Rotating file sink based on size + */ +template +class rotating_file_sink SPDLOG_FINAL : public base_sink +{ +public: + rotating_file_sink(filename_t base_filename, std::size_t max_size, std::size_t max_files) + : _base_filename(std::move(base_filename)) + , _max_size(max_size) + , _max_files(max_files) + { + _file_helper.open(calc_filename(_base_filename, 0)); + _current_size = _file_helper.size(); // expensive. called only once + } - // calc filename according to index and file extension if exists. - // e.g. calc_filename("logs/mylog.txt, 3) => "logs/mylog.3.txt". - static filename_t calc_filename(const filename_t &filename, std::size_t index) - { - typename std::conditional::value, fmt::MemoryWriter, fmt::WMemoryWriter>::type w; - if (index != 0u) - { - filename_t basename, ext; - std::tie(basename, ext) = details::file_helper::split_by_extenstion(filename); - w.write(SPDLOG_FILENAME_T("{}.{}{}"), basename, index, ext); - } - else - { - w.write(SPDLOG_FILENAME_T("{}"), filename); - } - return w.str(); - } + // calc filename according to index and file extension if exists. + // e.g. calc_filename("logs/mylog.txt, 3) => "logs/mylog.3.txt". + static filename_t calc_filename(const filename_t &filename, std::size_t index) + { + typename std::conditional::value, fmt::MemoryWriter, fmt::WMemoryWriter>::type w; + if (index != 0u) + { + filename_t basename, ext; + std::tie(basename, ext) = details::file_helper::split_by_extenstion(filename); + w.write(SPDLOG_FILENAME_T("{}.{}{}"), basename, index, ext); + } + else + { + w.write(SPDLOG_FILENAME_T("{}"), filename); + } + return w.str(); + } - protected: - void _sink_it(const details::log_msg &msg) override - { - _current_size += msg.formatted.size(); - if (_current_size > _max_size) - { - _rotate(); - _current_size = msg.formatted.size(); - } - _file_helper.write(msg); - } +protected: + void _sink_it(const details::log_msg &msg) override + { + _current_size += msg.formatted.size(); + if (_current_size > _max_size) + { + _rotate(); + _current_size = msg.formatted.size(); + } + _file_helper.write(msg); + } - void _flush() override - { - _file_helper.flush(); - } + void _flush() override + { + _file_helper.flush(); + } - private: - // Rotate files: - // log.txt -> log.1.txt - // log.1.txt -> log.2.txt - // log.2.txt -> log.3.txt - // log.3.txt -> delete - void _rotate() - { - using details::os::filename_to_str; - _file_helper.close(); - for (auto i = _max_files; i > 0; --i) - { - filename_t src = calc_filename(_base_filename, i - 1); - filename_t target = calc_filename(_base_filename, i); +private: + // Rotate files: + // log.txt -> log.1.txt + // log.1.txt -> log.2.txt + // log.2.txt -> log.3.txt + // log.3.txt -> delete + void _rotate() + { + using details::os::filename_to_str; + _file_helper.close(); + for (auto i = _max_files; i > 0; --i) + { + filename_t src = calc_filename(_base_filename, i - 1); + filename_t target = calc_filename(_base_filename, i); - if (details::file_helper::file_exists(target)) - { - if (details::os::remove(target) != 0) - { - throw spdlog_ex("rotating_file_sink: failed removing " + filename_to_str(target), errno); - } - } - if (details::file_helper::file_exists(src) && details::os::rename(src, target) != 0) - { - throw spdlog_ex("rotating_file_sink: failed renaming " + filename_to_str(src) + " to " + filename_to_str(target), errno); - } - } - _file_helper.reopen(true); - } + if (details::file_helper::file_exists(target)) + { + if (details::os::remove(target) != 0) + { + throw spdlog_ex("rotating_file_sink: failed removing " + filename_to_str(target), errno); + } + } + if (details::file_helper::file_exists(src) && details::os::rename(src, target) != 0) + { + throw spdlog_ex("rotating_file_sink: failed renaming " + filename_to_str(src) + " to " + filename_to_str(target), errno); + } + } + _file_helper.reopen(true); + } - filename_t _base_filename; - std::size_t _max_size; - std::size_t _max_files; - std::size_t _current_size; - details::file_helper _file_helper; - }; + filename_t _base_filename; + std::size_t _max_size; + std::size_t _max_files; + std::size_t _current_size; + details::file_helper _file_helper; +}; - using rotating_file_sink_mt = rotating_file_sink; - using rotating_file_sink_st = rotating_file_sink; +using rotating_file_sink_mt = rotating_file_sink; +using rotating_file_sink_st = rotating_file_sink; - /* - * Default generator of daily log file names. - */ - struct default_daily_file_name_calculator - { - // Create filename for the form filename.YYYY-MM-DD_hh-mm.ext - static filename_t calc_filename(const filename_t &filename) - { - std::tm tm = spdlog::details::os::localtime(); - filename_t basename, ext; - std::tie(basename, ext) = details::file_helper::split_by_extenstion(filename); - std::conditional::value, fmt::MemoryWriter, fmt::WMemoryWriter>::type w; - w.write(SPDLOG_FILENAME_T("{}_{:04d}-{:02d}-{:02d}_{:02d}-{:02d}{}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, - tm.tm_hour, tm.tm_min, ext); - return w.str(); - } - }; +/* + * Default generator of daily log file names. + */ +struct default_daily_file_name_calculator +{ + // Create filename for the form filename.YYYY-MM-DD_hh-mm.ext + static filename_t calc_filename(const filename_t &filename) + { + std::tm tm = spdlog::details::os::localtime(); + filename_t basename, ext; + std::tie(basename, ext) = details::file_helper::split_by_extenstion(filename); + std::conditional::value, fmt::MemoryWriter, fmt::WMemoryWriter>::type w; + w.write(SPDLOG_FILENAME_T("{}_{:04d}-{:02d}-{:02d}_{:02d}-{:02d}{}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, + tm.tm_hour, tm.tm_min, ext); + return w.str(); + } +}; - /* - * Generator of daily log file names in format basename.YYYY-MM-DD.ext - */ - struct dateonly_daily_file_name_calculator - { - // Create filename for the form basename.YYYY-MM-DD - static filename_t calc_filename(const filename_t &filename) - { - std::tm tm = spdlog::details::os::localtime(); - filename_t basename, ext; - std::tie(basename, ext) = details::file_helper::split_by_extenstion(filename); - std::conditional::value, fmt::MemoryWriter, fmt::WMemoryWriter>::type w; - w.write(SPDLOG_FILENAME_T("{}_{:04d}-{:02d}-{:02d}{}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, ext); - return w.str(); - } - }; +/* + * Generator of daily log file names in format basename.YYYY-MM-DD.ext + */ +struct dateonly_daily_file_name_calculator +{ + // Create filename for the form basename.YYYY-MM-DD + static filename_t calc_filename(const filename_t &filename) + { + std::tm tm = spdlog::details::os::localtime(); + filename_t basename, ext; + std::tie(basename, ext) = details::file_helper::split_by_extenstion(filename); + std::conditional::value, fmt::MemoryWriter, fmt::WMemoryWriter>::type w; + w.write(SPDLOG_FILENAME_T("{}_{:04d}-{:02d}-{:02d}{}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, ext); + return w.str(); + } +}; - /* - * Rotating file sink based on date. rotates at midnight - */ - template - class daily_file_sink SPDLOG_FINAL : public base_sink - { - public: - // create daily file sink which rotates on given time - daily_file_sink(filename_t base_filename, int rotation_hour, int rotation_minute) - : _base_filename(std::move(base_filename)) - , _rotation_h(rotation_hour) - , _rotation_m(rotation_minute) - { - if (rotation_hour < 0 || rotation_hour > 23 || rotation_minute < 0 || rotation_minute > 59) - { - throw spdlog_ex("daily_file_sink: Invalid rotation time in ctor"); - } - _rotation_tp = _next_rotation_tp(); - _file_helper.open(FileNameCalc::calc_filename(_base_filename)); - } +/* + * Rotating file sink based on date. rotates at midnight + */ +template +class daily_file_sink SPDLOG_FINAL : public base_sink +{ +public: + // create daily file sink which rotates on given time + daily_file_sink(filename_t base_filename, int rotation_hour, int rotation_minute) + : _base_filename(std::move(base_filename)) + , _rotation_h(rotation_hour) + , _rotation_m(rotation_minute) + { + if (rotation_hour < 0 || rotation_hour > 23 || rotation_minute < 0 || rotation_minute > 59) + { + throw spdlog_ex("daily_file_sink: Invalid rotation time in ctor"); + } + _rotation_tp = _next_rotation_tp(); + _file_helper.open(FileNameCalc::calc_filename(_base_filename)); + } - protected: - void _sink_it(const details::log_msg &msg) override - { - if (std::chrono::system_clock::now() >= _rotation_tp) - { - _file_helper.open(FileNameCalc::calc_filename(_base_filename)); - _rotation_tp = _next_rotation_tp(); - } - _file_helper.write(msg); - } +protected: + void _sink_it(const details::log_msg &msg) override + { + if (std::chrono::system_clock::now() >= _rotation_tp) + { + _file_helper.open(FileNameCalc::calc_filename(_base_filename)); + _rotation_tp = _next_rotation_tp(); + } + _file_helper.write(msg); + } - void _flush() override - { - _file_helper.flush(); - } + void _flush() override + { + _file_helper.flush(); + } - private: - std::chrono::system_clock::time_point _next_rotation_tp() - { - auto now = std::chrono::system_clock::now(); - time_t tnow = std::chrono::system_clock::to_time_t(now); - tm date = spdlog::details::os::localtime(tnow); - date.tm_hour = _rotation_h; - date.tm_min = _rotation_m; - date.tm_sec = 0; - auto rotation_time = std::chrono::system_clock::from_time_t(std::mktime(&date)); - if (rotation_time > now) - { - return rotation_time; - } - return { rotation_time + std::chrono::hours(24) }; - } +private: + std::chrono::system_clock::time_point _next_rotation_tp() + { + auto now = std::chrono::system_clock::now(); + time_t tnow = std::chrono::system_clock::to_time_t(now); + tm date = spdlog::details::os::localtime(tnow); + date.tm_hour = _rotation_h; + date.tm_min = _rotation_m; + date.tm_sec = 0; + auto rotation_time = std::chrono::system_clock::from_time_t(std::mktime(&date)); + if (rotation_time > now) + { + return rotation_time; + } + return {rotation_time + std::chrono::hours(24)}; + } - filename_t _base_filename; - int _rotation_h; - int _rotation_m; - std::chrono::system_clock::time_point _rotation_tp; - details::file_helper _file_helper; - }; + filename_t _base_filename; + int _rotation_h; + int _rotation_m; + std::chrono::system_clock::time_point _rotation_tp; + details::file_helper _file_helper; +}; - using daily_file_sink_mt = daily_file_sink; - using daily_file_sink_st = daily_file_sink; +using daily_file_sink_mt = daily_file_sink; +using daily_file_sink_st = daily_file_sink; - } // namespace sinks +} // namespace sinks - // - // factory functions to create and register file loggers - // - - // Basic logger simply writes to given file without any limitations or rotations. - template - inline std::shared_ptr basic_logger_mt(const std::string &logger_name, const filename_t &filename, bool truncate = false) - { - return Factory::template create(logger_name, filename, truncate); - } +// +// factory functions to create and register file loggers +// - template - inline std::shared_ptr basic_logger_st(const std::string &logger_name, const filename_t &filename, bool truncate = false) - { - return Factory::template create(logger_name, filename, truncate); - } +// Basic logger simply writes to given file without any limitations or rotations. +template +inline std::shared_ptr basic_logger_mt(const std::string &logger_name, const filename_t &filename, bool truncate = false) +{ + return Factory::template create(logger_name, filename, truncate); +} - // - // Create and register multi/single threaded rotating file logger - // - template - inline std::shared_ptr rotating_logger_mt( - const std::string &logger_name, const filename_t &filename, size_t max_file_size, size_t max_files) - { - return Factory::template create(logger_name, filename, max_file_size, max_files); - } +template +inline std::shared_ptr basic_logger_st(const std::string &logger_name, const filename_t &filename, bool truncate = false) +{ + return Factory::template create(logger_name, filename, truncate); +} - template - inline std::shared_ptr rotating_logger_st( - const std::string &logger_name, const filename_t &filename, size_t max_file_size, size_t max_files) - { - return Factory::template create(logger_name, filename, max_file_size, max_files); - } +// +// Create and register multi/single threaded rotating file logger +// +template +inline std::shared_ptr rotating_logger_mt( + const std::string &logger_name, const filename_t &filename, size_t max_file_size, size_t max_files) +{ + return Factory::template create(logger_name, filename, max_file_size, max_files); +} - // - // Create file logger which creates new file on the given time (default in midnight): - // - template - inline std::shared_ptr daily_logger_mt(const std::string &logger_name, const filename_t &filename, int hour = 0, int minute = 0) - { - return Factory::template create(logger_name, filename, hour, minute); - } +template +inline std::shared_ptr rotating_logger_st( + const std::string &logger_name, const filename_t &filename, size_t max_file_size, size_t max_files) +{ + return Factory::template create(logger_name, filename, max_file_size, max_files); +} - template - inline std::shared_ptr daily_logger_st(const std::string &logger_name, const filename_t &filename, int hour = 0, int minute = 0) - { - return Factory::template create(logger_name, filename, hour, minute); - } +// +// Create file logger which creates new file on the given time (default in midnight): +// +template +inline std::shared_ptr daily_logger_mt(const std::string &logger_name, const filename_t &filename, int hour = 0, int minute = 0) +{ + return Factory::template create(logger_name, filename, hour, minute); +} + +template +inline std::shared_ptr daily_logger_st(const std::string &logger_name, const filename_t &filename, int hour = 0, int minute = 0) +{ + return Factory::template create(logger_name, filename, hour, minute); +} } // namespace spdlog diff --git a/include/spdlog/sinks/stdout_color_sinks.h b/include/spdlog/sinks/stdout_color_sinks.h index f4669de3..5b0d7272 100644 --- a/include/spdlog/sinks/stdout_color_sinks.h +++ b/include/spdlog/sinks/stdout_color_sinks.h @@ -12,44 +12,43 @@ #include "ansicolor_sink.h" #endif -namespace { - using namespace spdlog::sinks; +namespace { +using namespace spdlog::sinks; #ifdef _WIN32 - using stdout_color_sink_mt = wincolor_stdout_sink_mt; - using stdout_color_sink_st = wincolor_stdout_sink_st; - using stderr_color_sink_mt = wincolor_stderr_sink_mt; - using stderr_color_sink_st = wincolor_stderr_sink_st; +using stdout_color_sink_mt = wincolor_stdout_sink_mt; +using stdout_color_sink_st = wincolor_stdout_sink_st; +using stderr_color_sink_mt = wincolor_stderr_sink_mt; +using stderr_color_sink_st = wincolor_stderr_sink_st; #else - using stdout_color_sink_mt = ansicolor_stdout_sink_mt; - using stdout_color_sink_st = ansicolor_stdout_sink_st; - using stderr_color_sink_mt = ansicolor_stderr_sink_mt; - using stderr_color_sink_st = ansicolor_stderr_sink_st; +using stdout_color_sink_mt = ansicolor_stdout_sink_mt; +using stdout_color_sink_st = ansicolor_stdout_sink_st; +using stderr_color_sink_mt = ansicolor_stderr_sink_mt; +using stderr_color_sink_st = ansicolor_stderr_sink_st; #endif +} // namespace + +namespace spdlog { +template +inline std::shared_ptr stdout_color_mt(const std::string &logger_name) +{ + return Factory::template create(logger_name); +} +template +inline std::shared_ptr stdout_color_st(const std::string &logger_name) +{ + return Factory::template create(logger_name); } -namespace spdlog -{ - template - inline std::shared_ptr stdout_color_mt(const std::string &logger_name) - { - return Factory::template create(logger_name); - } - template - inline std::shared_ptr stdout_color_st(const std::string &logger_name) - { - return Factory::template create(logger_name); - } +template +inline std::shared_ptr stderr_color_mt(const std::string &logger_name) +{ + return Factory::template create(logger_name); +} - template - inline std::shared_ptr stderr_color_mt(const std::string &logger_name) - { - return Factory::template create(logger_name); - } - - template - inline std::shared_ptr stderr_color_st(const std::string &logger_name) - { - return Factory::template createstderr_color_sink_mt>(logger_name); - } -} \ No newline at end of file +template +inline std::shared_ptr stderr_color_st(const std::string &logger_name) +{ + return Factory::template createstderr_color_sink_mt > (logger_name); +} +} // namespace spdlog \ No newline at end of file diff --git a/include/spdlog/sinks/stdout_sinks.h b/include/spdlog/sinks/stdout_sinks.h index dd05817e..af5c7dcc 100644 --- a/include/spdlog/sinks/stdout_sinks.h +++ b/include/spdlog/sinks/stdout_sinks.h @@ -7,73 +7,78 @@ #include "../details/null_mutex.h" #include "../details/traits.h" +#include "../spdlog.h" #include #include #include namespace spdlog { - namespace sinks { - template - class stdout_sink : public sink - { - public: - using mutex_t = typename ConsoleMutexTrait::mutex_t; - stdout_sink() : - _mutex(ConsoleMutexTrait::console_mutex()), - _file(StdoutTrait::stream()) {} - ~stdout_sink() = default; +namespace sinks { - stdout_sink(const stdout_sink &other) = delete; - stdout_sink &operator=(const stdout_sink &other) = delete; +template +class stdout_sink : public sink +{ +public: + using mutex_t = typename ConsoleMutexTrait::mutex_t; + stdout_sink() + : _mutex(ConsoleMutexTrait::console_mutex()) + , _file(StdoutTrait::stream()) + { + } + ~stdout_sink() = default; - void log(const details::log_msg &msg) override - { - std::lock_guard lock(_mutex); - fwrite(msg.formatted.data(), sizeof(char), msg.formatted.size(), _file); - fflush(StdoutTrait::stream()); - } + stdout_sink(const stdout_sink &other) = delete; + stdout_sink &operator=(const stdout_sink &other) = delete; - void flush() override - { - std::lock_guard lock(_mutex); - fflush(StdoutTrait::stream()); - } - private: - typename mutex_t& _mutex; - FILE* _file; - }; + void log(const details::log_msg &msg) override + { + std::lock_guard lock(_mutex); + fwrite(msg.formatted.data(), sizeof(char), msg.formatted.size(), _file); + fflush(StdoutTrait::stream()); + } - using stdout_sink_mt = stdout_sink; - using stdout_sink_st = stdout_sink; - using stderr_sink_mt = stdout_sink; - using stderr_sink_st = stdout_sink; + void flush() override + { + std::lock_guard lock(_mutex); + fflush(StdoutTrait::stream()); + } - } // namespace sinks +private: + mutex_t &_mutex; + FILE *_file; +}; - // factory methods - template - inline std::shared_ptr stdout_logger_mt(const std::string &logger_name) - { - return Factory::template create(logger_name); - } +using stdout_sink_mt = stdout_sink; +using stdout_sink_st = stdout_sink; +using stderr_sink_mt = stdout_sink; +using stderr_sink_st = stdout_sink; - template - inline std::shared_ptr stdout_logger_st(const std::string &logger_name) - { - return Factory::template create(logger_name); - } +} // namespace sinks - template - inline std::shared_ptr stderr_logger_mt(const std::string &logger_name) - { - return Factory::template create(logger_name); - } +// factory methods +template +inline std::shared_ptr stdout_logger_mt(const std::string &logger_name) +{ + return Factory::template create(logger_name); +} - template - inline std::shared_ptr stderr_logger_st(const std::string &logger_name) - { - return Factory::template create(logger_name); - } +template +inline std::shared_ptr stdout_logger_st(const std::string &logger_name) +{ + return Factory::template create(logger_name); +} + +template +inline std::shared_ptr stderr_logger_mt(const std::string &logger_name) +{ + return Factory::template create(logger_name); +} + +template +inline std::shared_ptr stderr_logger_st(const std::string &logger_name) +{ + return Factory::template create(logger_name); +} } // namespace spdlog diff --git a/include/spdlog/sinks/syslog_sink.h b/include/spdlog/sinks/syslog_sink.h index c5209f10..39082709 100644 --- a/include/spdlog/sinks/syslog_sink.h +++ b/include/spdlog/sinks/syslog_sink.h @@ -7,8 +7,6 @@ #include "../common.h" -#ifdef SPDLOG_ENABLE_SYSLOG - #include "../details/log_msg.h" #include "sink.h" @@ -17,68 +15,66 @@ #include namespace spdlog { - namespace sinks { - /** - * Sink that write to syslog using the `syscall()` library call. - * - * Locking is not needed, as `syslog()` itself is thread-safe. - */ - class syslog_sink : public sink - { - public: - // - syslog_sink(const std::string &ident = "", int syslog_option = 0, int syslog_facility = LOG_USER) - : _ident(ident) - { - _priorities[static_cast(level::trace)] = LOG_DEBUG; - _priorities[static_cast(level::debug)] = LOG_DEBUG; - _priorities[static_cast(level::info)] = LOG_INFO; - _priorities[static_cast(level::warn)] = LOG_WARNING; - _priorities[static_cast(level::err)] = LOG_ERR; - _priorities[static_cast(level::critical)] = LOG_CRIT; - _priorities[static_cast(level::off)] = LOG_INFO; +namespace sinks { +/** + * Sink that write to syslog using the `syscall()` library call. + * + * Locking is not needed, as `syslog()` itself is thread-safe. + */ +class syslog_sink : public sink +{ +public: + // + syslog_sink(const std::string &ident = "", int syslog_option = 0, int syslog_facility = LOG_USER) + : _ident(ident) + { + _priorities[static_cast(level::trace)] = LOG_DEBUG; + _priorities[static_cast(level::debug)] = LOG_DEBUG; + _priorities[static_cast(level::info)] = LOG_INFO; + _priorities[static_cast(level::warn)] = LOG_WARNING; + _priorities[static_cast(level::err)] = LOG_ERR; + _priorities[static_cast(level::critical)] = LOG_CRIT; + _priorities[static_cast(level::off)] = LOG_INFO; - // set ident to be program name if empty - ::openlog(_ident.empty() ? nullptr : _ident.c_str(), syslog_option, syslog_facility); - } + // set ident to be program name if empty + ::openlog(_ident.empty() ? nullptr : _ident.c_str(), syslog_option, syslog_facility); + } - ~syslog_sink() override - { - ::closelog(); - } + ~syslog_sink() override + { + ::closelog(); + } - syslog_sink(const syslog_sink &) = delete; - syslog_sink &operator=(const syslog_sink &) = delete; + syslog_sink(const syslog_sink &) = delete; + syslog_sink &operator=(const syslog_sink &) = delete; - void log(const details::log_msg &msg) override - { - ::syslog(syslog_prio_from_level(msg), "%s", msg.raw.str().c_str()); - } + void log(const details::log_msg &msg) override + { + ::syslog(syslog_prio_from_level(msg), "%s", msg.raw.str().c_str()); + } - void flush() override {} + void flush() override {} - private: - std::array _priorities; - // must store the ident because the man says openlog might use the pointer as is and not a string copy - const std::string _ident; +private: + std::array _priorities; + // must store the ident because the man says openlog might use the pointer as is and not a string copy + const std::string _ident; - // - // Simply maps spdlog's log level to syslog priority level. - // - int syslog_prio_from_level(const details::log_msg &msg) const - { - return _priorities[static_cast(msg.level)]; - } - }; - } // namespace sinks + // + // Simply maps spdlog's log level to syslog priority level. + // + int syslog_prio_from_level(const details::log_msg &msg) const + { + return _priorities[static_cast(msg.level)]; + } +}; +} // namespace sinks - // Create and register a syslog logger - template - inline std::shared_ptr syslog_logger( - const std::string &logger_name, const std::string &ident = "", int syslog_option = 0, int syslog_facilty = (1 << 3)) - { - return return Factory::template create(logger_name, syslog_ident, syslog_option, syslog_facility); - } +// Create and register a syslog logger +template +inline std::shared_ptr syslog_logger( + const std::string &logger_name, const std::string &syslog_ident = "", int syslog_option = 0, int syslog_facility = (1 << 3)) +{ + return Factory::template create(logger_name, syslog_ident, syslog_option, syslog_facility); +} } // namespace spdlog - -#endif diff --git a/include/spdlog/sinks/wincolor_sink.h b/include/spdlog/sinks/wincolor_sink.h index ef8c9a6a..b5aefb9f 100644 --- a/include/spdlog/sinks/wincolor_sink.h +++ b/include/spdlog/sinks/wincolor_sink.h @@ -5,124 +5,120 @@ #pragma once -#include "sink.h" #include "../common.h" #include "../details/null_mutex.h" #include "../details/traits.h" +#include "sink.h" - -#include #include +#include #include #include #include namespace spdlog { - namespace sinks { - /* - * Windows color console sink. Uses WriteConsoleA to write to the console with colors - */ - template - class wincolor_sink : public sink - { - public: +namespace sinks { +/* + * Windows color console sink. Uses WriteConsoleA to write to the console with colors + */ +template +class wincolor_sink : public sink +{ +public: + const WORD BOLD = FOREGROUND_INTENSITY; + const WORD RED = FOREGROUND_RED; + const WORD GREEN = FOREGROUND_GREEN; + const WORD CYAN = FOREGROUND_GREEN | FOREGROUND_BLUE; + const WORD WHITE = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE; + const WORD YELLOW = FOREGROUND_RED | FOREGROUND_GREEN; - const WORD BOLD = FOREGROUND_INTENSITY; - const WORD RED = FOREGROUND_RED; - const WORD GREEN = FOREGROUND_GREEN; - const WORD CYAN = FOREGROUND_GREEN | FOREGROUND_BLUE; - const WORD WHITE = FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE; - const WORD YELLOW = FOREGROUND_RED | FOREGROUND_GREEN; + wincolor_sink() + : out_handle_(HandleTrait::handle()) + , _mutex(ConsoleMutexTrait::console_mutex()) + { + colors_[level::trace] = WHITE; + colors_[level::debug] = CYAN; + colors_[level::info] = GREEN; + colors_[level::warn] = YELLOW | BOLD; + colors_[level::err] = RED | BOLD; // red bold + colors_[level::critical] = BACKGROUND_RED | WHITE | BOLD; // white bold on red background + colors_[level::off] = 0; + } - wincolor_sink() - : out_handle_(HandleTrait::handle()), - _mutex(ConsoleMutexTrait::console_mutex()) - { - colors_[level::trace] = WHITE; - colors_[level::debug] = CYAN; - colors_[level::info] = GREEN; - colors_[level::warn] = YELLOW | BOLD; - colors_[level::err] = RED | BOLD; // red bold - colors_[level::critical] = BACKGROUND_RED | WHITE | BOLD; // white bold on red background - colors_[level::off] = 0; - } + ~wincolor_sink() override + { + this->flush(); + } + wincolor_sink(const wincolor_sink &other) = delete; + wincolor_sink &operator=(const wincolor_sink &other) = delete; - ~wincolor_sink() override - { - this->flush(); - } + // change the color for the given level + void set_color(level::level_enum level, WORD color) + { + std::lock_guard lock(_mutex); + colors_[level] = color; + } - wincolor_sink(const wincolor_sink &other) = delete; - wincolor_sink &operator=(const wincolor_sink &other) = delete; + void log(const details::log_msg &msg) SPDLOG_FINAL override + { + std::lock_guard lock(_mutex); - // change the color for the given level - void set_color(level::level_enum level, WORD color) - { - std::lock_guard lock(_mutex); - colors_[level] = color; - } + if (msg.color_range_end > msg.color_range_start) + { + // before color range + _print_range(msg, 0, msg.color_range_start); - void log(const details::log_msg &msg) SPDLOG_FINAL override - { - std::lock_guard lock(_mutex); + // in color range + auto orig_attribs = set_console_attribs(colors_[msg.level]); + _print_range(msg, msg.color_range_start, msg.color_range_end); + ::SetConsoleTextAttribute(out_handle_, orig_attribs); // reset to orig colors + // after color range + _print_range(msg, msg.color_range_end, msg.formatted.size()); + } + else // print without colors if color range is invalid + { + _print_range(msg, 0, msg.formatted.size()); + } + } - if (msg.color_range_end > msg.color_range_start) - { - // before color range - _print_range(msg, 0, msg.color_range_start); + void flush() SPDLOG_FINAL override + { + // windows console always flushed? + } - // in color range - auto orig_attribs = set_console_attribs(colors_[msg.level]); - _print_range(msg, msg.color_range_start, msg.color_range_end); - ::SetConsoleTextAttribute(out_handle_, orig_attribs); // reset to orig colors - // after color range - _print_range(msg, msg.color_range_end, msg.formatted.size()); - } - else // print without colors if color range is invalid - { - _print_range(msg, 0, msg.formatted.size()); - } - } +private: + using mutex_t = typename ConsoleMutexTrait::mutex_t; + // set color and return the orig console attributes (for resetting later) + WORD set_console_attribs(WORD attribs) + { + CONSOLE_SCREEN_BUFFER_INFO orig_buffer_info; + ::GetConsoleScreenBufferInfo(out_handle_, &orig_buffer_info); + WORD back_color = orig_buffer_info.wAttributes; + // retrieve the current background color + back_color &= static_cast(~(FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE | FOREGROUND_INTENSITY)); + // keep the background color unchanged + ::SetConsoleTextAttribute(out_handle_, attribs | back_color); + return orig_buffer_info.wAttributes; // return orig attribs + } - void flush() SPDLOG_FINAL override - { - // windows console always flushed? - } + // print a range of formatted message to console + void _print_range(const details::log_msg &msg, size_t start, size_t end) + { + auto size = static_cast(end - start); + ::WriteConsoleA(out_handle_, msg.formatted.data() + start, size, nullptr, nullptr); + } - private: - using mutex_t = typename ConsoleMutexTrait::mutex_t; - // set color and return the orig console attributes (for resetting later) - WORD set_console_attribs(WORD attribs) - { - CONSOLE_SCREEN_BUFFER_INFO orig_buffer_info; - ::GetConsoleScreenBufferInfo(out_handle_, &orig_buffer_info); - WORD back_color = orig_buffer_info.wAttributes; - // retrieve the current background color - back_color &= static_cast(~(FOREGROUND_RED | FOREGROUND_GREEN | FOREGROUND_BLUE | FOREGROUND_INTENSITY)); - // keep the background color unchanged - ::SetConsoleTextAttribute(out_handle_, attribs | back_color); - return orig_buffer_info.wAttributes; // return orig attribs - } + HANDLE out_handle_; + mutex_t &_mutex; + std::unordered_map colors_; +}; - // print a range of formatted message to console - void _print_range(const details::log_msg &msg, size_t start, size_t end) - { - auto size = static_cast(end - start); - ::WriteConsoleA(out_handle_, msg.formatted.data() + start, size, nullptr, nullptr); - } +using wincolor_stdout_sink_mt = wincolor_sink; +using wincolor_stdout_sink_st = wincolor_sink; - HANDLE out_handle_; - mutex_t &_mutex; - std::unordered_map colors_; - }; +using wincolor_stderr_sink_mt = wincolor_sink; +using wincolor_stderr_sink_st = wincolor_sink; - - using wincolor_stdout_sink_mt = wincolor_sink; - using wincolor_stdout_sink_st = wincolor_sink; - - using wincolor_stderr_sink_mt = wincolor_sink; - using wincolor_stderr_sink_st = wincolor_sink; - - } // namespace sinks +} // namespace sinks } // namespace spdlog diff --git a/include/spdlog/spdlog.h b/include/spdlog/spdlog.h index 5e552cce..7e49724d 100644 --- a/include/spdlog/spdlog.h +++ b/include/spdlog/spdlog.h @@ -7,8 +7,8 @@ #pragma once -#include "details/registry.h" #include "common.h" +#include "details/registry.h" #include "logger.h" #include @@ -32,7 +32,6 @@ struct default_factory } }; - // Create and register a logger with a templated sink type // The logger's level, formatter and flush level will be set according the global settings. // Example: @@ -116,7 +115,6 @@ inline void drop_all() details::registry::instance().drop_all(); } - /////////////////////////////////////////////////////////////////////////////// // // Trace & Debug can be switched on/off at compile time for zero cost debug statements. diff --git a/tests/includes.h b/tests/includes.h index 3c0bec01..365dd773 100644 --- a/tests/includes.h +++ b/tests/includes.h @@ -12,9 +12,8 @@ #define SPDLOG_TRACE_ON #define SPDLOG_DEBUG_ON -#include "../include/spdlog/spdlog.h" #include "../include/spdlog/async.h" -#include "../include/spdlog/sinks/null_sink.h" #include "../include/spdlog/sinks/file_sinks.h" +#include "../include/spdlog/sinks/null_sink.h" #include "../include/spdlog/sinks/ostream_sink.h" - +#include "../include/spdlog/spdlog.h"