From c8610d9a86ae8b237895f7c2d6baa42cdf292d96 Mon Sep 17 00:00:00 2001 From: gabime Date: Fri, 6 Apr 2018 02:24:07 +0300 Subject: [PATCH 01/26] support for color formatting --- bench/boost-bench-mt.cpp | 1 - bench/easylogging-bench-async.cpp | 2 +- bench/easylogging-bench-mt.cpp | 2 +- bench/easylogging-bench.cpp | 4 +-- bench/g3log-async.cpp | 5 +-- bench/glog-bench.cpp | 1 - bench/log4cplus-bench-mt.cpp | 14 ++++----- bench/log4cplus-bench.cpp | 12 +++---- bench/log4cpp-bench-mt.cpp | 12 +++---- bench/log4cpp-bench.cpp | 10 +++--- bench/p7-bench-mt.cpp | 23 ++++++-------- bench/p7-bench.cpp | 18 +++++------ bench/spdlog-async.cpp | 6 ++-- bench/spdlog-bench-mt.cpp | 2 +- include/spdlog/details/log_msg.h | 3 ++ include/spdlog/details/os.h | 2 +- .../spdlog/details/pattern_formatter_impl.h | 31 ++++++++++++++++++- include/spdlog/sinks/ansicolor_sink.h | 30 ++++++++++++------ 18 files changed, 105 insertions(+), 73 deletions(-) diff --git a/bench/boost-bench-mt.cpp b/bench/boost-bench-mt.cpp index 3a6eeea8..a076e6e4 100644 --- a/bench/boost-bench-mt.cpp +++ b/bench/boost-bench-mt.cpp @@ -82,6 +82,5 @@ int main(int argc, char *argv[]) std::cout << "Delta = " << deltaf << " seconds" << std::endl; std::cout << "Rate = " << rate << "/sec" << std::endl; - return 0; } diff --git a/bench/easylogging-bench-async.cpp b/bench/easylogging-bench-async.cpp index 81985a6a..e9b0dc84 100644 --- a/bench/easylogging-bench-async.cpp +++ b/bench/easylogging-bench-async.cpp @@ -11,8 +11,8 @@ #define ELPP_THREAD_SAFE #define ELPP_EXPERIMENTAL_ASYNC -#include "easylogging++.h" #include "easylogging++.cc" +#include "easylogging++.h" INITIALIZE_EASYLOGGINGPP using namespace std; diff --git a/bench/easylogging-bench-mt.cpp b/bench/easylogging-bench-mt.cpp index cfcf3348..7601d3c0 100644 --- a/bench/easylogging-bench-mt.cpp +++ b/bench/easylogging-bench-mt.cpp @@ -10,8 +10,8 @@ #include #define ELPP_THREAD_SAFE -#include "easylogging++.h" #include "easylogging++.cc" +#include "easylogging++.h" INITIALIZE_EASYLOGGINGPP using namespace std; diff --git a/bench/easylogging-bench.cpp b/bench/easylogging-bench.cpp index 06b66134..15c093d8 100644 --- a/bench/easylogging-bench.cpp +++ b/bench/easylogging-bench.cpp @@ -6,8 +6,8 @@ #include #include -#include "easylogging++.h" #include "easylogging++.cc" +#include "easylogging++.h" INITIALIZE_EASYLOGGINGPP int main(int, char *[]) @@ -21,7 +21,7 @@ int main(int, char *[]) el::Configurations conf("easyl.conf"); el::Loggers::reconfigureLogger("default", conf); - el::Logger* defaultLogger = el::Loggers::getLogger("default"); + el::Logger *defaultLogger = el::Loggers::getLogger("default"); auto start = clock::now(); for (int i = 0; i < howmany; ++i) diff --git a/bench/g3log-async.cpp b/bench/g3log-async.cpp index b5e15a2b..61ed72df 100644 --- a/bench/g3log-async.cpp +++ b/bench/g3log-async.cpp @@ -13,7 +13,8 @@ #include "g3log/logworker.hpp" using namespace std; -template std::string format(const T &value); +template +std::string format(const T &value); int main(int argc, char *argv[]) { @@ -27,7 +28,7 @@ int main(int argc, char *argv[]) int howmany = 1000000; auto worker = g3::LogWorker::createLogWorker(); - auto handle= worker->addDefaultLogger(argv[0], "logs"); + auto handle = worker->addDefaultLogger(argv[0], "logs"); g3::initializeLogging(worker.get()); std::atomic msg_counter{0}; diff --git a/bench/glog-bench.cpp b/bench/glog-bench.cpp index 6b4445a9..7469896c 100644 --- a/bench/glog-bench.cpp +++ b/bench/glog-bench.cpp @@ -8,7 +8,6 @@ #include "glog/logging.h" - int main(int, char *argv[]) { using namespace std::chrono; diff --git a/bench/log4cplus-bench-mt.cpp b/bench/log4cplus-bench-mt.cpp index 6acbf3fa..72e2681c 100644 --- a/bench/log4cplus-bench-mt.cpp +++ b/bench/log4cplus-bench-mt.cpp @@ -10,17 +10,17 @@ #include #include -#include "log4cplus/logger.h" #include "log4cplus/fileappender.h" -#include "log4cplus/layout.h" -#include "log4cplus/ndc.h" #include "log4cplus/helpers/loglog.h" #include "log4cplus/helpers/property.h" +#include "log4cplus/layout.h" +#include "log4cplus/logger.h" #include "log4cplus/loggingmacros.h" +#include "log4cplus/ndc.h" using namespace log4cplus; -int main(int argc, char * argv[]) +int main(int argc, char *argv[]) { using namespace std::chrono; using clock = steady_clock; @@ -32,13 +32,11 @@ int main(int argc, char * argv[]) int howmany = 1000000; log4cplus::initialize(); - SharedFileAppenderPtr append( - new FileAppender(LOG4CPLUS_TEXT("logs/log4cplus-bench-mt.log"), std::ios_base::trunc, - true, true)); + SharedFileAppenderPtr append(new FileAppender(LOG4CPLUS_TEXT("logs/log4cplus-bench-mt.log"), std::ios_base::trunc, true, true)); append->setName(LOG4CPLUS_TEXT("File")); log4cplus::tstring pattern = LOG4CPLUS_TEXT("%d{%Y-%m-%d %H:%M:%S.%Q}: %p - %m %n"); - append->setLayout( std::auto_ptr(new PatternLayout(pattern)) ); + append->setLayout(std::auto_ptr(new PatternLayout(pattern))); append->getloc(); Logger::getRoot().addAppender(SharedAppenderPtr(append.get())); diff --git a/bench/log4cplus-bench.cpp b/bench/log4cplus-bench.cpp index e522e85a..e738aecd 100644 --- a/bench/log4cplus-bench.cpp +++ b/bench/log4cplus-bench.cpp @@ -7,13 +7,13 @@ #include #include -#include "log4cplus/logger.h" #include "log4cplus/fileappender.h" -#include "log4cplus/layout.h" -#include "log4cplus/ndc.h" #include "log4cplus/helpers/loglog.h" #include "log4cplus/helpers/property.h" +#include "log4cplus/layout.h" +#include "log4cplus/logger.h" #include "log4cplus/loggingmacros.h" +#include "log4cplus/ndc.h" using namespace log4cplus; @@ -25,13 +25,11 @@ int main(int, char *[]) int howmany = 1000000; log4cplus::initialize(); - SharedFileAppenderPtr append( - new FileAppender(LOG4CPLUS_TEXT("logs/log4cplus-bench.log"), std::ios_base::trunc, - true, true)); + SharedFileAppenderPtr append(new FileAppender(LOG4CPLUS_TEXT("logs/log4cplus-bench.log"), std::ios_base::trunc, true, true)); append->setName(LOG4CPLUS_TEXT("File")); log4cplus::tstring pattern = LOG4CPLUS_TEXT("%d{%Y-%m-%d %H:%M:%S.%Q}: %p - %m %n"); - append->setLayout( std::auto_ptr(new PatternLayout(pattern)) ); + append->setLayout(std::auto_ptr(new PatternLayout(pattern))); append->getloc(); Logger::getRoot().addAppender(SharedAppenderPtr(append.get())); diff --git a/bench/log4cpp-bench-mt.cpp b/bench/log4cpp-bench-mt.cpp index dc6a5f58..b96b8e1b 100644 --- a/bench/log4cpp-bench-mt.cpp +++ b/bench/log4cpp-bench-mt.cpp @@ -10,15 +10,15 @@ #include #include -#include "log4cpp/Category.hh" #include "log4cpp/Appender.hh" +#include "log4cpp/BasicLayout.hh" +#include "log4cpp/Category.hh" #include "log4cpp/FileAppender.hh" #include "log4cpp/Layout.hh" -#include "log4cpp/BasicLayout.hh" -#include "log4cpp/Priority.hh" #include "log4cpp/PatternLayout.hh" +#include "log4cpp/Priority.hh" -int main(int argc, char * argv[]) +int main(int argc, char *argv[]) { using namespace std::chrono; using clock = steady_clock; @@ -29,12 +29,12 @@ int main(int argc, char * argv[]) int howmany = 1000000; - log4cpp::Appender *appender = new log4cpp::FileAppender("default", "logs/log4cpp-bench-mt.log"); + log4cpp::Appender *appender = new log4cpp::FileAppender("default", "logs/log4cpp-bench-mt.log"); log4cpp::PatternLayout *layout = new log4cpp::PatternLayout(); layout->setConversionPattern("%d{%Y-%m-%d %H:%M:%S.%l}: %p - %m %n"); appender->setLayout(layout); - log4cpp::Category& root = log4cpp::Category::getRoot(); + log4cpp::Category &root = log4cpp::Category::getRoot(); root.addAppender(appender); root.setPriority(log4cpp::Priority::INFO); diff --git a/bench/log4cpp-bench.cpp b/bench/log4cpp-bench.cpp index a21526c8..75029817 100644 --- a/bench/log4cpp-bench.cpp +++ b/bench/log4cpp-bench.cpp @@ -7,13 +7,13 @@ #include #include -#include "log4cpp/Category.hh" #include "log4cpp/Appender.hh" +#include "log4cpp/BasicLayout.hh" +#include "log4cpp/Category.hh" #include "log4cpp/FileAppender.hh" #include "log4cpp/Layout.hh" -#include "log4cpp/BasicLayout.hh" -#include "log4cpp/Priority.hh" #include "log4cpp/PatternLayout.hh" +#include "log4cpp/Priority.hh" int main(int, char *[]) { @@ -22,12 +22,12 @@ int main(int, char *[]) int howmany = 1000000; - log4cpp::Appender *appender = new log4cpp::FileAppender("default", "logs/log4cpp-bench.log"); + log4cpp::Appender *appender = new log4cpp::FileAppender("default", "logs/log4cpp-bench.log"); log4cpp::PatternLayout *layout = new log4cpp::PatternLayout(); layout->setConversionPattern("%d{%Y-%m-%d %H:%M:%S.%l}: %p - %m %n"); appender->setLayout(layout); - log4cpp::Category& root = log4cpp::Category::getRoot(); + log4cpp::Category &root = log4cpp::Category::getRoot(); root.addAppender(appender); root.setPriority(log4cpp::Priority::INFO); diff --git a/bench/p7-bench-mt.cpp b/bench/p7-bench-mt.cpp index a3195208..996922c9 100644 --- a/bench/p7-bench-mt.cpp +++ b/bench/p7-bench-mt.cpp @@ -5,15 +5,14 @@ #include #include +#include #include +#include #include #include -#include -#include #include "P7_Trace.h" - int main(int argc, char *argv[]) { using namespace std::chrono; @@ -27,10 +26,9 @@ int main(int argc, char *argv[]) IP7_Trace::hModule module = NULL; - //create P7 client object - std::unique_ptr> client( - P7_Create_Client(TM("/P7.Pool=1024 /P7.Sink=FileTxt /P7.Dir=logs/p7-bench-mt")), - [&](IP7_Client *ptr){ + // create P7 client object + std::unique_ptr> client( + P7_Create_Client(TM("/P7.Pool=1024 /P7.Sink=FileTxt /P7.Dir=logs/p7-bench-mt")), [&](IP7_Client *ptr) { if (ptr) ptr->Release(); }); @@ -41,10 +39,9 @@ int main(int argc, char *argv[]) return 1; } - //create P7 trace object 1 - std::unique_ptr> trace( - P7_Create_Trace(client.get(), TM("Trace channel 1")), - [&](IP7_Trace *ptr){ + // create P7 trace object 1 + std::unique_ptr> trace( + P7_Create_Trace(client.get(), TM("Trace channel 1")), [&](IP7_Trace *ptr) { if (ptr) ptr->Release(); }); @@ -65,7 +62,7 @@ int main(int argc, char *argv[]) for (int t = 0; t < thread_count; ++t) { threads.push_back(std::thread([&]() { - trace->Register_Thread(TM("Application"), t+1); + trace->Register_Thread(TM("Application"), t + 1); while (true) { int counter = ++msg_counter; @@ -73,7 +70,7 @@ int main(int argc, char *argv[]) break; trace->P7_INFO(module, TM("p7 message #%d: This is some text for your pleasure"), counter); } - trace->Register_Thread(TM("Application"), t+1); + trace->Register_Thread(TM("Application"), t + 1); })); } diff --git a/bench/p7-bench.cpp b/bench/p7-bench.cpp index 15513ca5..25c39b03 100644 --- a/bench/p7-bench.cpp +++ b/bench/p7-bench.cpp @@ -4,13 +4,12 @@ // #include +#include #include #include -#include #include "P7_Trace.h" - int main(int, char *[]) { using namespace std::chrono; @@ -20,10 +19,9 @@ int main(int, char *[]) IP7_Trace::hModule module = NULL; - //create P7 client object - std::unique_ptr> client( - P7_Create_Client(TM("/P7.Pool=1024 /P7.Sink=FileTxt /P7.Dir=logs/p7-bench")), - [&](IP7_Client *ptr){ + // create P7 client object + std::unique_ptr> client( + P7_Create_Client(TM("/P7.Pool=1024 /P7.Sink=FileTxt /P7.Dir=logs/p7-bench")), [&](IP7_Client *ptr) { if (ptr) ptr->Release(); }); @@ -34,10 +32,9 @@ int main(int, char *[]) return 1; } - //create P7 trace object 1 - std::unique_ptr> trace( - P7_Create_Trace(client.get(), TM("Trace channel 1")), - [&](IP7_Trace *ptr){ + // create P7 trace object 1 + std::unique_ptr> trace( + P7_Create_Trace(client.get(), TM("Trace channel 1")), [&](IP7_Trace *ptr) { if (ptr) ptr->Release(); }); @@ -55,7 +52,6 @@ int main(int, char *[]) for (int i = 0; i < howmany; ++i) trace->P7_INFO(module, TM("p7 message #%d: This is some text for your pleasure"), i); - duration delta = clock::now() - start; float deltaf = delta.count(); auto rate = howmany / deltaf; diff --git a/bench/spdlog-async.cpp b/bench/spdlog-async.cpp index e1d1a95f..e8b70009 100644 --- a/bench/spdlog-async.cpp +++ b/bench/spdlog-async.cpp @@ -5,8 +5,8 @@ #include #include -#include #include +#include #include #include @@ -36,7 +36,7 @@ int main(int argc, char *argv[]) run = false; })); - while(run) + while (run) { std::atomic msg_counter{0}; std::vector threads; @@ -68,7 +68,7 @@ int main(int argc, char *argv[]) std::cout << "Threads: " << thread_count << std::endl; std::cout << "Delta = " << std::fixed << deltaf << " seconds" << std::endl; std::cout << "Rate = " << std::fixed << rate << "/sec" << std::endl; - } //while + } // while stoper.join(); diff --git a/bench/spdlog-bench-mt.cpp b/bench/spdlog-bench-mt.cpp index b4948e73..62dd9cc7 100644 --- a/bench/spdlog-bench-mt.cpp +++ b/bench/spdlog-bench-mt.cpp @@ -5,8 +5,8 @@ #include #include -#include #include +#include #include #include diff --git a/include/spdlog/details/log_msg.h b/include/spdlog/details/log_msg.h index 9a03318d..1d079aaf 100644 --- a/include/spdlog/details/log_msg.h +++ b/include/spdlog/details/log_msg.h @@ -40,6 +40,9 @@ struct log_msg fmt::MemoryWriter raw; fmt::MemoryWriter formatted; size_t msg_id{0}; + // wrap this range with color codes + size_t color_range_start{0}; + size_t color_range_end{0}; }; } // namespace details } // namespace spdlog diff --git a/include/spdlog/details/os.h b/include/spdlog/details/os.h index 5a5dbde8..2eeeeb38 100644 --- a/include/spdlog/details/os.h +++ b/include/spdlog/details/os.h @@ -238,7 +238,7 @@ inline size_t filesize(FILE *f) int fd = fileno(f); // 64 bits(but not in osx or cygwin, where fstat64 is deprecated) #if !defined(__FreeBSD__) && !defined(__APPLE__) && (defined(__x86_64__) || defined(__ppc64__)) && !defined(__CYGWIN__) - struct stat64 st; + struct stat64 st; if (fstat64(fd, &st) == 0) { return static_cast(st.st_size); diff --git a/include/spdlog/details/pattern_formatter_impl.h b/include/spdlog/details/pattern_formatter_impl.h index 9aa634e7..d8b92f9b 100644 --- a/include/spdlog/details/pattern_formatter_impl.h +++ b/include/spdlog/details/pattern_formatter_impl.h @@ -421,7 +421,24 @@ private: std::string _str; }; +// set the color range. expect it to be in the form of "%^colored text%$" +class start_color_formatter SPDLOG_FINAL : public flag_formatter +{ + void format(details::log_msg &msg, const std::tm &) override + { + msg.color_range_start = msg.formatted.size(); + } +}; +class stop_color_formatter SPDLOG_FINAL : public flag_formatter +{ + void format(details::log_msg &msg, const std::tm &) override + { + msg.color_range_end = msg.formatted.size(); + } +}; + // Full info formatter + // pattern: [%Y-%m-%d %H:%M:%S.%e] [%n] [%l] %v class full_formatter SPDLOG_FINAL : public flag_formatter { @@ -462,8 +479,13 @@ class full_formatter SPDLOG_FINAL : public flag_formatter msg.formatted << '[' << *msg.logger_name << "] "; #endif - msg.formatted << '[' << level::to_str(msg.level) << "] "; + const char *level_name = level::to_str(msg.level); + size_t level_name_size = strlen(level_name); + msg.formatted << '[' << fmt::StringRef(level_name, level_name_size) << "] "; msg.formatted << fmt::StringRef(msg.raw.data(), msg.raw.size()); + // wrap the level with color + msg.color_range_start = 37; + msg.color_range_end = 37 + level_name_size; } }; @@ -491,6 +513,7 @@ inline void spdlog::pattern_formatter::compile_pattern(const std::string &patter { _formatters.push_back(std::move(user_chars)); } + // if( if (++it != end) { handle_flag(*it); @@ -644,6 +667,12 @@ inline void spdlog::pattern_formatter::handle_flag(char flag) case ('i'): _formatters.emplace_back(new details::i_formatter()); break; + case ('^'): + _formatters.emplace_back(new details::start_color_formatter()); + break; + case ('$'): + _formatters.emplace_back(new details::stop_color_formatter()); + break; default: // Unknown flag appears as is _formatters.emplace_back(new details::ch_formatter('%')); diff --git a/include/spdlog/sinks/ansicolor_sink.h b/include/spdlog/sinks/ansicolor_sink.h index 9e7f1a59..8f086c8e 100644 --- a/include/spdlog/sinks/ansicolor_sink.h +++ b/include/spdlog/sinks/ansicolor_sink.h @@ -28,9 +28,9 @@ public: : target_file_(file) { should_do_colors_ = details::os::in_terminal(file) && details::os::is_color_terminal(); - colors_[level::trace] = cyan; + colors_[level::trace] = magenta; colors_[level::debug] = cyan; - colors_[level::info] = reset; + colors_[level::info] = green; colors_[level::warn] = yellow + bold; colors_[level::err] = red + bold; colors_[level::critical] = bold + on_red; @@ -83,17 +83,20 @@ protected: { // Wrap the originally formatted message in color codes. // If color is not supported in the terminal, log as is instead. - if (should_do_colors_) + if (should_do_colors_ && msg.color_range_end > msg.color_range_start) { - const std::string &prefix = colors_[msg.level]; - fwrite(prefix.data(), sizeof(char), prefix.size(), target_file_); - fwrite(msg.formatted.data(), sizeof(char), msg.formatted.size(), target_file_); - fwrite(reset.data(), sizeof(char), reset.size(), target_file_); - fwrite(clear_line.data(), sizeof(char), clear_line.size(), target_file_); + // 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 { - fwrite(msg.formatted.data(), sizeof(char), msg.formatted.size(), target_file_); + _print_range(msg, 0, msg.formatted.size()); } _flush(); } @@ -103,6 +106,15 @@ protected: 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_; bool should_do_colors_; std::unordered_map colors_; From d040ab93ea4e372998048c8b270aaffd6e5ce663 Mon Sep 17 00:00:00 2001 From: gabime Date: Fri, 6 Apr 2018 03:04:18 +0300 Subject: [PATCH 02/26] wincolor color formatting support --- example/example.cpp | 4 ++-- include/spdlog/sinks/ansicolor_sink.h | 2 +- include/spdlog/sinks/wincolor_sink.h | 32 ++++++++++++++++++++++----- 3 files changed, 29 insertions(+), 9 deletions(-) diff --git a/example/example.cpp b/example/example.cpp index b1b2e32f..90abd916 100644 --- a/example/example.cpp +++ b/example/example.cpp @@ -58,8 +58,8 @@ int main(int, char *[]) daily_logger->info(123.44); // Customize msg format for all messages - spd::set_pattern("*** [%H:%M:%S %z] [thread %t] %v ***"); - rotating_logger->info("This is another message with custom format"); + spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); + console->info("This a message with custom format (and custom color range between the '%^' and '%$')"); // Runtime log levels spd::set_level(spd::level::info); // Set global log level to info diff --git a/include/spdlog/sinks/ansicolor_sink.h b/include/spdlog/sinks/ansicolor_sink.h index 8f086c8e..e74389c9 100644 --- a/include/spdlog/sinks/ansicolor_sink.h +++ b/include/spdlog/sinks/ansicolor_sink.h @@ -28,7 +28,7 @@ public: : target_file_(file) { should_do_colors_ = details::os::in_terminal(file) && details::os::is_color_terminal(); - colors_[level::trace] = magenta; + colors_[level::trace] = white; colors_[level::debug] = cyan; colors_[level::info] = green; colors_[level::warn] = yellow + bold; diff --git a/include/spdlog/sinks/wincolor_sink.h b/include/spdlog/sinks/wincolor_sink.h index 60f4286f..d21151db 100644 --- a/include/spdlog/sinks/wincolor_sink.h +++ b/include/spdlog/sinks/wincolor_sink.h @@ -25,6 +25,7 @@ class wincolor_sink : public base_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; @@ -32,9 +33,9 @@ public: wincolor_sink(HANDLE std_handle) : out_handle_(std_handle) { - colors_[level::trace] = CYAN; + colors_[level::trace] = WHITE; colors_[level::debug] = CYAN; - colors_[level::info] = WHITE | BOLD; + 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 @@ -59,10 +60,22 @@ public: protected: void _sink_it(const details::log_msg &msg) override { - auto color = colors_[msg.level]; - auto orig_attribs = set_console_attribs(color); - WriteConsoleA(out_handle_, msg.formatted.data(), static_cast(msg.formatted.size()), nullptr, nullptr); - SetConsoleTextAttribute(out_handle_, orig_attribs); // reset to orig colors + if (msg.color_range_end > msg.color_range_start) + { + // before color range + _print_range(msg, 0, msg.color_range_start); + + // 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()); + } } void _flush() override @@ -86,6 +99,13 @@ private: SetConsoleTextAttribute(out_handle_, attribs | back_color); return orig_buffer_info.wAttributes; // return orig attribs } + + // print a range of formatted message to console + void _print_range(const details::log_msg &msg, size_t start, size_t end) + { + DWORD size = static_cast(end - start); + WriteConsoleA(out_handle_, msg.formatted.data() + start, size, nullptr, nullptr); + } }; // From 2f7fdf266330f39b9f4556053573ed8236727005 Mon Sep 17 00:00:00 2001 From: gabime Date: Fri, 6 Apr 2018 03:06:41 +0300 Subject: [PATCH 03/26] wincolor color formatting support --- example/example.cpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/example/example.cpp b/example/example.cpp index 90abd916..ea6e5f06 100644 --- a/example/example.cpp +++ b/example/example.cpp @@ -59,8 +59,9 @@ int main(int, char *[]) // Customize msg format for all messages spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); - console->info("This a message with custom format (and custom color range between the '%^' and '%$')"); - + console->info("This an info message with custom format (and custom color range between the '%^' and '%$')"); + console->error("This an error message with custom format (and custom color range between the '%^' and '%$')"); + // Runtime log levels spd::set_level(spd::level::info); // Set global log level to info console->debug("This message should not be displayed!"); From 3452892f76a9794f1200d41d95b7c39b4bacc464 Mon Sep 17 00:00:00 2001 From: gabime Date: Fri, 6 Apr 2018 03:22:27 +0300 Subject: [PATCH 04/26] minor renaming --- include/spdlog/details/pattern_formatter_impl.h | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/include/spdlog/details/pattern_formatter_impl.h b/include/spdlog/details/pattern_formatter_impl.h index d8b92f9b..a7259e96 100644 --- a/include/spdlog/details/pattern_formatter_impl.h +++ b/include/spdlog/details/pattern_formatter_impl.h @@ -421,15 +421,15 @@ private: std::string _str; }; -// set the color range. expect it to be in the form of "%^colored text%$" -class start_color_formatter SPDLOG_FINAL : public flag_formatter +// mark the color range. expect it to be in the form of "%^colored text%$" +class color_start_formatter SPDLOG_FINAL : public flag_formatter { void format(details::log_msg &msg, const std::tm &) override { msg.color_range_start = msg.formatted.size(); } }; -class stop_color_formatter SPDLOG_FINAL : public flag_formatter +class color_stop_formatter SPDLOG_FINAL : public flag_formatter { void format(details::log_msg &msg, const std::tm &) override { @@ -438,7 +438,6 @@ class stop_color_formatter SPDLOG_FINAL : public flag_formatter }; // Full info formatter - // pattern: [%Y-%m-%d %H:%M:%S.%e] [%n] [%l] %v class full_formatter SPDLOG_FINAL : public flag_formatter { @@ -667,11 +666,13 @@ inline void spdlog::pattern_formatter::handle_flag(char flag) case ('i'): _formatters.emplace_back(new details::i_formatter()); break; + case ('^'): - _formatters.emplace_back(new details::start_color_formatter()); + _formatters.emplace_back(new details::color_start_formatter()); break; + case ('$'): - _formatters.emplace_back(new details::stop_color_formatter()); + _formatters.emplace_back(new details::color_stop_formatter()); break; default: // Unknown flag appears as is From 644c81b9fb845a940044bc4afeb9a3dd2e4be875 Mon Sep 17 00:00:00 2001 From: gabime Date: Fri, 6 Apr 2018 03:42:24 +0300 Subject: [PATCH 05/26] Added color ranges to formatter tests --- tests/test_pattern_formatter.cpp | 65 +++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 2 deletions(-) diff --git a/tests/test_pattern_formatter.cpp b/tests/test_pattern_formatter.cpp index 5c2be1f2..644cb80e 100644 --- a/tests/test_pattern_formatter.cpp +++ b/tests/test_pattern_formatter.cpp @@ -7,8 +7,10 @@ static std::string log_to_str(const std::string &msg, const std::shared_ptr(oss); spdlog::logger oss_logger("pattern_tester", oss_sink); oss_logger.set_level(spdlog::level::info); - if (formatter) - oss_logger.set_formatter(formatter); + if (formatter) + { + oss_logger.set_formatter(formatter); + } oss_logger.info(msg); return oss.str(); } @@ -61,3 +63,62 @@ TEST_CASE("date MM/DD/YY ", "[pattern_formatter]") << (now_tm.tm_year + 1900) % 1000 << " Some message\n"; REQUIRE(log_to_str("Some message", formatter) == oss.str()); } + +TEST_CASE("color range test1", "[pattern_formatter]") +{ + auto formatter = std::make_shared("%^%v%$", spdlog::pattern_time_type::local, "\n"); + spdlog::details::log_msg msg; + msg.raw << "Hello"; + formatter->format(msg); + REQUIRE(msg.color_range_start == 0); + REQUIRE(msg.color_range_end == 5); + REQUIRE(log_to_str("hello", formatter) == "hello\n"); +} + +TEST_CASE("color range test2", "[pattern_formatter]") +{ + auto formatter = std::make_shared("%^%$", spdlog::pattern_time_type::local, "\n"); + spdlog::details::log_msg msg; + formatter->format(msg); + REQUIRE(msg.color_range_start == 0); + REQUIRE(msg.color_range_end == 0); + REQUIRE(log_to_str("", formatter) == "\n"); +} + +TEST_CASE("color range test3", "[pattern_formatter]") +{ + auto formatter = std::make_shared("%^***%$"); + spdlog::details::log_msg msg; + formatter->format(msg); + REQUIRE(msg.color_range_start == 0); + REQUIRE(msg.color_range_end == 3); +} + +TEST_CASE("color range test4", "[pattern_formatter]") +{ + auto formatter = std::make_shared("XX%^YYY%$", spdlog::pattern_time_type::local, "\n"); + spdlog::details::log_msg msg; + msg.raw << "ignored"; + formatter->format(msg); + REQUIRE(msg.color_range_start == 2); + REQUIRE(msg.color_range_end == 5); + REQUIRE(log_to_str("ignored", formatter) == "XXYYY\n"); +} + +TEST_CASE("color range test5", "[pattern_formatter]") +{ + auto formatter = std::make_shared("**%^"); + spdlog::details::log_msg msg; + formatter->format(msg); + REQUIRE(msg.color_range_start == 2); + REQUIRE(msg.color_range_end == 0); +} + +TEST_CASE("color range test6", "[pattern_formatter]") +{ + auto formatter = std::make_shared("**%$"); + spdlog::details::log_msg msg; + formatter->format(msg); + REQUIRE(msg.color_range_start == 0); + REQUIRE(msg.color_range_end == 2); +} From 21d437fbf54e86a39570296643f64a227576b9e2 Mon Sep 17 00:00:00 2001 From: Gabi Melman Date: Fri, 6 Apr 2018 04:04:50 +0300 Subject: [PATCH 06/26] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 73347139..940b61ff 100644 --- a/README.md +++ b/README.md @@ -120,8 +120,9 @@ int main(int, char*[]) daily_logger->info(123.44); // Customize msg format for all messages - spd::set_pattern("*** [%H:%M:%S %z] [thread %t] %v ***"); - rotating_logger->info("This is another message with custom format"); + spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); + console->info("This an info message with custom format (and custom color range between the '%^' and '%$')"); + console->error("This an error message with custom format (and custom color range between the '%^' and '%$')"); // Runtime log levels From 4abe40354488bbd14bc677cce6393cb32de629d5 Mon Sep 17 00:00:00 2001 From: Gabi Melman Date: Fri, 6 Apr 2018 04:05:23 +0300 Subject: [PATCH 07/26] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 940b61ff..1146b176 100644 --- a/README.md +++ b/README.md @@ -120,11 +120,10 @@ int main(int, char*[]) daily_logger->info(123.44); // Customize msg format for all messages - spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); + spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); console->info("This an info message with custom format (and custom color range between the '%^' and '%$')"); console->error("This an error message with custom format (and custom color range between the '%^' and '%$')"); - // Runtime log levels spd::set_level(spd::level::info); //Set global log level to info console->debug("This message should not be displayed!"); From 1dea46e1abcaffa5ffc9f343af86a7c853b2a09c Mon Sep 17 00:00:00 2001 From: gabime Date: Fri, 6 Apr 2018 04:06:02 +0300 Subject: [PATCH 08/26] code formatting --- example/example.cpp | 4 +- include/spdlog/sinks/wincolor_sink.h | 46 ++++++++-------- tests/test_pattern_formatter.cpp | 80 ++++++++++++++-------------- 3 files changed, 65 insertions(+), 65 deletions(-) diff --git a/example/example.cpp b/example/example.cpp index ea6e5f06..0597ec75 100644 --- a/example/example.cpp +++ b/example/example.cpp @@ -60,8 +60,8 @@ int main(int, char *[]) // Customize msg format for all messages spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); console->info("This an info message with custom format (and custom color range between the '%^' and '%$')"); - console->error("This an error message with custom format (and custom color range between the '%^' and '%$')"); - + console->error("This an error message with custom format (and custom color range between the '%^' and '%$')"); + // Runtime log levels spd::set_level(spd::level::info); // Set global log level to info console->debug("This message should not be displayed!"); diff --git a/include/spdlog/sinks/wincolor_sink.h b/include/spdlog/sinks/wincolor_sink.h index d21151db..402fa121 100644 --- a/include/spdlog/sinks/wincolor_sink.h +++ b/include/spdlog/sinks/wincolor_sink.h @@ -25,7 +25,7 @@ class wincolor_sink : public base_sink public: const WORD BOLD = FOREGROUND_INTENSITY; const WORD RED = FOREGROUND_RED; - const WORD GREEN = FOREGROUND_GREEN; + 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; @@ -60,22 +60,22 @@ public: protected: void _sink_it(const details::log_msg &msg) override { - if (msg.color_range_end > msg.color_range_start) - { - // before color range - _print_range(msg, 0, msg.color_range_start); - - // 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); + + // 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()); + } } void _flush() override @@ -100,12 +100,12 @@ private: return orig_buffer_info.wAttributes; // return orig attribs } - // print a range of formatted message to console - void _print_range(const details::log_msg &msg, size_t start, size_t end) - { - DWORD size = static_cast(end - start); - WriteConsoleA(out_handle_, msg.formatted.data() + start, size, nullptr, nullptr); - } + // print a range of formatted message to console + void _print_range(const details::log_msg &msg, size_t start, size_t end) + { + DWORD size = static_cast(end - start); + WriteConsoleA(out_handle_, msg.formatted.data() + start, size, nullptr, nullptr); + } }; // diff --git a/tests/test_pattern_formatter.cpp b/tests/test_pattern_formatter.cpp index 644cb80e..c6700041 100644 --- a/tests/test_pattern_formatter.cpp +++ b/tests/test_pattern_formatter.cpp @@ -7,10 +7,10 @@ static std::string log_to_str(const std::string &msg, const std::shared_ptr(oss); spdlog::logger oss_logger("pattern_tester", oss_sink); oss_logger.set_level(spdlog::level::info); - if (formatter) - { - oss_logger.set_formatter(formatter); - } + if (formatter) + { + oss_logger.set_formatter(formatter); + } oss_logger.info(msg); return oss.str(); } @@ -65,60 +65,60 @@ TEST_CASE("date MM/DD/YY ", "[pattern_formatter]") } TEST_CASE("color range test1", "[pattern_formatter]") -{ - auto formatter = std::make_shared("%^%v%$", spdlog::pattern_time_type::local, "\n"); - spdlog::details::log_msg msg; - msg.raw << "Hello"; - formatter->format(msg); - REQUIRE(msg.color_range_start == 0); - REQUIRE(msg.color_range_end == 5); - REQUIRE(log_to_str("hello", formatter) == "hello\n"); +{ + auto formatter = std::make_shared("%^%v%$", spdlog::pattern_time_type::local, "\n"); + spdlog::details::log_msg msg; + msg.raw << "Hello"; + formatter->format(msg); + REQUIRE(msg.color_range_start == 0); + REQUIRE(msg.color_range_end == 5); + REQUIRE(log_to_str("hello", formatter) == "hello\n"); } TEST_CASE("color range test2", "[pattern_formatter]") { - auto formatter = std::make_shared("%^%$", spdlog::pattern_time_type::local, "\n"); - spdlog::details::log_msg msg; - formatter->format(msg); - REQUIRE(msg.color_range_start == 0); - REQUIRE(msg.color_range_end == 0); - REQUIRE(log_to_str("", formatter) == "\n"); + auto formatter = std::make_shared("%^%$", spdlog::pattern_time_type::local, "\n"); + spdlog::details::log_msg msg; + formatter->format(msg); + REQUIRE(msg.color_range_start == 0); + REQUIRE(msg.color_range_end == 0); + REQUIRE(log_to_str("", formatter) == "\n"); } TEST_CASE("color range test3", "[pattern_formatter]") { - auto formatter = std::make_shared("%^***%$"); - spdlog::details::log_msg msg; - formatter->format(msg); - REQUIRE(msg.color_range_start == 0); - REQUIRE(msg.color_range_end == 3); + auto formatter = std::make_shared("%^***%$"); + spdlog::details::log_msg msg; + formatter->format(msg); + REQUIRE(msg.color_range_start == 0); + REQUIRE(msg.color_range_end == 3); } TEST_CASE("color range test4", "[pattern_formatter]") { - auto formatter = std::make_shared("XX%^YYY%$", spdlog::pattern_time_type::local, "\n"); - spdlog::details::log_msg msg; - msg.raw << "ignored"; - formatter->format(msg); - REQUIRE(msg.color_range_start == 2); - REQUIRE(msg.color_range_end == 5); - REQUIRE(log_to_str("ignored", formatter) == "XXYYY\n"); + auto formatter = std::make_shared("XX%^YYY%$", spdlog::pattern_time_type::local, "\n"); + spdlog::details::log_msg msg; + msg.raw << "ignored"; + formatter->format(msg); + REQUIRE(msg.color_range_start == 2); + REQUIRE(msg.color_range_end == 5); + REQUIRE(log_to_str("ignored", formatter) == "XXYYY\n"); } TEST_CASE("color range test5", "[pattern_formatter]") { - auto formatter = std::make_shared("**%^"); - spdlog::details::log_msg msg; - formatter->format(msg); - REQUIRE(msg.color_range_start == 2); - REQUIRE(msg.color_range_end == 0); + auto formatter = std::make_shared("**%^"); + spdlog::details::log_msg msg; + formatter->format(msg); + REQUIRE(msg.color_range_start == 2); + REQUIRE(msg.color_range_end == 0); } TEST_CASE("color range test6", "[pattern_formatter]") { - auto formatter = std::make_shared("**%$"); - spdlog::details::log_msg msg; - formatter->format(msg); - REQUIRE(msg.color_range_start == 0); - REQUIRE(msg.color_range_end == 2); + auto formatter = std::make_shared("**%$"); + spdlog::details::log_msg msg; + formatter->format(msg); + REQUIRE(msg.color_range_start == 0); + REQUIRE(msg.color_range_end == 2); } From 309327187a397dae3db9c8766904fc02cc32c053 Mon Sep 17 00:00:00 2001 From: gabime Date: Fri, 6 Apr 2018 04:36:22 +0300 Subject: [PATCH 09/26] Fixed example makefile for clang --- example/Makefile | 58 +++++++++++++++++++------------------- example/Makefile.clang | 64 +++++++++++++++++++++--------------------- example/Makefile.mingw | 64 +++++++++++++++++++++--------------------- 3 files changed, 93 insertions(+), 93 deletions(-) diff --git a/example/Makefile b/example/Makefile index 6d169e41..8b17c7f2 100644 --- a/example/Makefile +++ b/example/Makefile @@ -1,29 +1,29 @@ -CXX ?= g++ -CXXFLAGS = -CXX_FLAGS = -Wall -Wshadow -Wextra -pedantic -std=c++11 -pthread -I../include -CXX_RELEASE_FLAGS = -O3 -march=native -CXX_DEBUG_FLAGS= -g - - -all: example bench -debug: example-debug bench-debug - -example: example.cpp - $(CXX) example.cpp -o example $(CXX_FLAGS) $(CXX_RELEASE_FLAGS) $(CXXFLAGS) - -bench: bench.cpp - $(CXX) bench.cpp -o bench $(CXX_FLAGS) $(CXX_RELEASE_FLAGS) $(CXXFLAGS) - - -example-debug: example.cpp - $(CXX) example.cpp -o example-debug $(CXX_FLAGS) $(CXX_DEBUG_FLAGS) $(CXXFLAGS) - -bench-debug: bench.cpp - $(CXX) bench.cpp -o bench-debug $(CXX_FLAGS) $(CXX_DEBUG_FLAGS) $(CXXFLAGS) - -clean: - rm -f *.o logs/*.txt example example-debug bench bench-debug - - -rebuild: clean all -rebuild-debug: clean debug +CXX ?= g++ +CXXFLAGS = +CXX_FLAGS = -Wall -Wshadow -Wextra -pedantic -std=c++11 -pthread -I../include +CXX_RELEASE_FLAGS = -O3 -march=native +CXX_DEBUG_FLAGS= -g + + +all: example bench +debug: example-debug bench-debug + +example: example.cpp + $(CXX) example.cpp -o example $(CXX_FLAGS) $(CXX_RELEASE_FLAGS) $(CXXFLAGS) + +bench: bench.cpp + $(CXX) bench.cpp -o bench $(CXX_FLAGS) $(CXX_RELEASE_FLAGS) $(CXXFLAGS) + + +example-debug: example.cpp + $(CXX) example.cpp -o example-debug $(CXX_FLAGS) $(CXX_DEBUG_FLAGS) $(CXXFLAGS) + +bench-debug: bench.cpp + $(CXX) bench.cpp -o bench-debug $(CXX_FLAGS) $(CXX_DEBUG_FLAGS) $(CXXFLAGS) + +clean: + rm -f *.o logs/*.txt example example-debug bench bench-debug + + +rebuild: clean all +rebuild-debug: clean debug diff --git a/example/Makefile.clang b/example/Makefile.clang index 0ed004d0..78488446 100644 --- a/example/Makefile.clang +++ b/example/Makefile.clang @@ -1,32 +1,32 @@ -CXX ?= clang++ -CXXFLAGS = -march=native -Wall -Wextra -Wshadow -pedantic -std=c++11 -pthread -I../include -CXX_RELEASE_FLAGS = -O2 -CXX_DEBUG_FLAGS= -g - - -all: example bench -debug: example-debug bench-debug - -example: example.cpp - $(CXX) example.cpp -o example-clang $(CXXFLAGS) $(CXX_RELEASE_FLAGS) - -bench: bench.cpp - $(CXX) bench.cpp -o bench-clang $(CXXFLAGS) $(CXX_RELEASE_FLAGS) - - -example-debug: example.cpp - $(CXX) example.cpp -o example-clang-debug $(CXXFLAGS) $(CXX_DEBUG_FLAGS) - -bench-debug: bench.cpp - $(CXX) bench.cpp -o bench-clang-debug $(CXXFLAGS) $(CXX_DEBUG_FLAGS) - - - -clean: - rm -f *.o logs/*.txt example-clang example-clang-debug bench-clang bench-clang-debug - - -rebuild: clean all -rebuild-debug: clean debug - - +CXX = clang++ +CXXFLAGS = -march=native -Wall -Wextra -Wshadow -pedantic -std=c++11 -pthread -I../include +CXX_RELEASE_FLAGS = -O2 +CXX_DEBUG_FLAGS= -g + + +all: example bench +debug: example-debug bench-debug + +example: example.cpp + $(CXX) example.cpp -o example-clang $(CXXFLAGS) $(CXX_RELEASE_FLAGS) + +bench: bench.cpp + $(CXX) bench.cpp -o bench-clang $(CXXFLAGS) $(CXX_RELEASE_FLAGS) + + +example-debug: example.cpp + $(CXX) example.cpp -o example-clang-debug $(CXXFLAGS) $(CXX_DEBUG_FLAGS) + +bench-debug: bench.cpp + $(CXX) bench.cpp -o bench-clang-debug $(CXXFLAGS) $(CXX_DEBUG_FLAGS) + + + +clean: + rm -f *.o logs/*.txt example-clang example-clang-debug bench-clang bench-clang-debug + + +rebuild: clean all +rebuild-debug: clean debug + + diff --git a/example/Makefile.mingw b/example/Makefile.mingw index 5ee5ab6f..302e0722 100644 --- a/example/Makefile.mingw +++ b/example/Makefile.mingw @@ -1,32 +1,32 @@ -CXX ?= g++ -CXXFLAGS = -D_WIN32_WINNT=0x600 -march=native -Wall -Wextra -Wshadow -pedantic -std=gnu++0x -pthread -Wl,--no-as-needed -I../include -CXX_RELEASE_FLAGS = -O3 -CXX_DEBUG_FLAGS= -g - - -all: example bench -debug: example-debug bench-debug - -example: example.cpp - $(CXX) example.cpp -o example $(CXXFLAGS) $(CXX_RELEASE_FLAGS) - -bench: bench.cpp - $(CXX) bench.cpp -o bench $(CXXFLAGS) $(CXX_RELEASE_FLAGS) - - -example-debug: example.cpp - $(CXX) example.cpp -o example-debug $(CXXFLAGS) $(CXX_DEBUG_FLAGS) - -bench-debug: bench.cpp - $(CXX) bench.cpp -o bench-debug $(CXXFLAGS) $(CXX_DEBUG_FLAGS) - - - -clean: - rm -f *.o logs/*.txt example example-debug bench bench-debug - - -rebuild: clean all -rebuild-debug: clean debug - - +CXX ?= g++ +CXXFLAGS = -D_WIN32_WINNT=0x600 -march=native -Wall -Wextra -Wshadow -pedantic -std=gnu++0x -pthread -Wl,--no-as-needed -I../include +CXX_RELEASE_FLAGS = -O3 +CXX_DEBUG_FLAGS= -g + + +all: example bench +debug: example-debug bench-debug + +example: example.cpp + $(CXX) example.cpp -o example $(CXXFLAGS) $(CXX_RELEASE_FLAGS) + +bench: bench.cpp + $(CXX) bench.cpp -o bench $(CXXFLAGS) $(CXX_RELEASE_FLAGS) + + +example-debug: example.cpp + $(CXX) example.cpp -o example-debug $(CXXFLAGS) $(CXX_DEBUG_FLAGS) + +bench-debug: bench.cpp + $(CXX) bench.cpp -o bench-debug $(CXXFLAGS) $(CXX_DEBUG_FLAGS) + + + +clean: + rm -f *.o logs/*.txt example example-debug bench bench-debug + + +rebuild: clean all +rebuild-debug: clean debug + + From 64c2fe180b5d2d7d217672bc1a700ccfc329706d Mon Sep 17 00:00:00 2001 From: gabime Date: Sun, 8 Apr 2018 18:27:18 +0300 Subject: [PATCH 10/26] Fixed bug in wrapping colors around level name in default pattern --- include/spdlog/details/pattern_formatter_impl.h | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/include/spdlog/details/pattern_formatter_impl.h b/include/spdlog/details/pattern_formatter_impl.h index a7259e96..f1de628b 100644 --- a/include/spdlog/details/pattern_formatter_impl.h +++ b/include/spdlog/details/pattern_formatter_impl.h @@ -478,13 +478,13 @@ class full_formatter SPDLOG_FINAL : public flag_formatter msg.formatted << '[' << *msg.logger_name << "] "; #endif - const char *level_name = level::to_str(msg.level); - size_t level_name_size = strlen(level_name); - msg.formatted << '[' << fmt::StringRef(level_name, level_name_size) << "] "; - msg.formatted << fmt::StringRef(msg.raw.data(), msg.raw.size()); - // wrap the level with color - msg.color_range_start = 37; - msg.color_range_end = 37 + level_name_size; + msg.formatted << '['; + // wrap the level name with color + msg.color_range_start = msg.formatted.size(); + msg.formatted << level::to_str(msg.level); + msg.color_range_end = msg.formatted.size(); + msg.formatted << "] " << fmt::StringRef(msg.raw.data(), msg.raw.size()); + } }; From b416685d6f601a12a9fd6428aa605a6f12330ef2 Mon Sep 17 00:00:00 2001 From: Gabi Melman Date: Mon, 9 Apr 2018 02:06:33 +0300 Subject: [PATCH 11/26] Fix gcc warning on stat (32 bits) --- include/spdlog/details/os.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/include/spdlog/details/os.h b/include/spdlog/details/os.h index 2eeeeb38..cd3e702b 100644 --- a/include/spdlog/details/os.h +++ b/include/spdlog/details/os.h @@ -244,9 +244,8 @@ inline size_t filesize(FILE *f) return static_cast(st.st_size); } #else // unix 32 bits or cygwin - struct stat st - { - }; + struct stat st; + if (fstat(fd, &st) == 0) { return static_cast(st.st_size); From cfb450c059ceaccaf6289ac6d2ce98db84ef69a3 Mon Sep 17 00:00:00 2001 From: gabime Date: Mon, 9 Apr 2018 14:14:52 +0300 Subject: [PATCH 12/26] Fixed eol write in pattern_formatter_impl --- example/example.cpp | 10 ++++++++++ include/spdlog/details/pattern_formatter_impl.h | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/example/example.cpp b/example/example.cpp index 0597ec75..a55a7db6 100644 --- a/example/example.cpp +++ b/example/example.cpp @@ -26,8 +26,17 @@ int main(int, char *[]) { try { + spdlog::set_async_mode(1024); // Console logger with color auto console = spd::stdout_color_mt("console"); + + for (int i = 0; i < 2000; i++) + { + console->info("{} Hello thread pool!", i); + } + + return 0; + console->info("Welcome to spdlog!"); console->error("Some error message with arg{}..", 1); @@ -39,6 +48,7 @@ int main(int, char *[]) console->info("{:<30}", "left aligned"); spd::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name) function"); + return 0; // Create basic file logger (not rotated) auto my_logger = spd::basic_logger_mt("basic_logger", "logs/basic-log.txt"); diff --git a/include/spdlog/details/pattern_formatter_impl.h b/include/spdlog/details/pattern_formatter_impl.h index f1de628b..b801221b 100644 --- a/include/spdlog/details/pattern_formatter_impl.h +++ b/include/spdlog/details/pattern_formatter_impl.h @@ -704,5 +704,5 @@ inline void spdlog::pattern_formatter::format(details::log_msg &msg) f->format(msg, tm_time); } // write eol - msg.formatted.write(_eol.data(), _eol.size()); + msg.formatted << _eol; } From d352aa0990493e66cc659cfc023f8e2f5e35968f Mon Sep 17 00:00:00 2001 From: gabime Date: Mon, 9 Apr 2018 15:11:42 +0300 Subject: [PATCH 13/26] Fixed example --- example/example.cpp | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/example/example.cpp b/example/example.cpp index a55a7db6..0597ec75 100644 --- a/example/example.cpp +++ b/example/example.cpp @@ -26,17 +26,8 @@ int main(int, char *[]) { try { - spdlog::set_async_mode(1024); // Console logger with color auto console = spd::stdout_color_mt("console"); - - for (int i = 0; i < 2000; i++) - { - console->info("{} Hello thread pool!", i); - } - - return 0; - console->info("Welcome to spdlog!"); console->error("Some error message with arg{}..", 1); @@ -48,7 +39,6 @@ int main(int, char *[]) console->info("{:<30}", "left aligned"); spd::get("console")->info("loggers can be retrieved from a global registry using the spdlog::get(logger_name) function"); - return 0; // Create basic file logger (not rotated) auto my_logger = spd::basic_logger_mt("basic_logger", "logs/basic-log.txt"); From e9bb008f157bb767381e4e47fb318a49386e3af2 Mon Sep 17 00:00:00 2001 From: gabime Date: Mon, 9 Apr 2018 15:12:51 +0300 Subject: [PATCH 14/26] Fixed example --- example/example.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/example/example.cpp b/example/example.cpp index 0597ec75..6144c065 100644 --- a/example/example.cpp +++ b/example/example.cpp @@ -59,8 +59,8 @@ int main(int, char *[]) // Customize msg format for all messages spd::set_pattern("[%^+++%$] [%H:%M:%S %z] [thread %t] %v"); - console->info("This an info message with custom format (and custom color range between the '%^' and '%$')"); - console->error("This an error message with custom format (and custom color range between the '%^' and '%$')"); + 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 From 3fdc7996db80019074b0753fee589de2260e5d76 Mon Sep 17 00:00:00 2001 From: gabime Date: Mon, 9 Apr 2018 15:14:13 +0300 Subject: [PATCH 15/26] code formatting --- include/spdlog/details/os.h | 2 +- include/spdlog/details/pattern_formatter_impl.h | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/include/spdlog/details/os.h b/include/spdlog/details/os.h index cd3e702b..e48f8272 100644 --- a/include/spdlog/details/os.h +++ b/include/spdlog/details/os.h @@ -245,7 +245,7 @@ inline size_t filesize(FILE *f) } #else // unix 32 bits or cygwin struct stat st; - + if (fstat(fd, &st) == 0) { return static_cast(st.st_size); diff --git a/include/spdlog/details/pattern_formatter_impl.h b/include/spdlog/details/pattern_formatter_impl.h index b801221b..e3d70878 100644 --- a/include/spdlog/details/pattern_formatter_impl.h +++ b/include/spdlog/details/pattern_formatter_impl.h @@ -480,11 +480,10 @@ class full_formatter SPDLOG_FINAL : public flag_formatter msg.formatted << '['; // wrap the level name with color - msg.color_range_start = msg.formatted.size(); - msg.formatted << level::to_str(msg.level); - msg.color_range_end = msg.formatted.size(); + msg.color_range_start = msg.formatted.size(); + msg.formatted << level::to_str(msg.level); + msg.color_range_end = msg.formatted.size(); msg.formatted << "] " << fmt::StringRef(msg.raw.data(), msg.raw.size()); - } }; From 31ce7ef3a56ff8b9535d767ae6e927c244923ec0 Mon Sep 17 00:00:00 2001 From: Puasonych Date: Tue, 10 Apr 2018 16:57:29 +0300 Subject: [PATCH 16/26] Update .gitignore --- .gitignore | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index b1a41919..be48891f 100644 --- a/.gitignore +++ b/.gitignore @@ -65,4 +65,5 @@ install_manifest.txt /tests/logs/* # idea -.idea/ \ No newline at end of file +.idea/ +.vscode/ \ No newline at end of file From 11c99892d7ae38966cde9115d9dcc0865fac65d8 Mon Sep 17 00:00:00 2001 From: Puasonych Date: Wed, 11 Apr 2018 11:40:34 +0300 Subject: [PATCH 17/26] Add new logger: step_logger --- include/spdlog/details/spdlog_impl.h | 13 ++++ include/spdlog/sinks/file_sinks.h | 92 ++++++++++++++++++++++++++++ include/spdlog/spdlog.h | 6 ++ tests/file_log.cpp | 65 ++++++++++++++++++++ 4 files changed, 176 insertions(+) diff --git a/include/spdlog/details/spdlog_impl.h b/include/spdlog/details/spdlog_impl.h index 4c363834..7d9195bc 100644 --- a/include/spdlog/details/spdlog_impl.h +++ b/include/spdlog/details/spdlog_impl.h @@ -83,6 +83,19 @@ inline std::shared_ptr spdlog::daily_logger_st( return create(logger_name, filename, hour, minute); } +// Create a file logger that creates new files with a specified increment +inline std::shared_ptr spdlog::step_logger_mt( + const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, size_t max_file_size) +{ + return create(logger_name, filename_fmt, seconds, max_file_size); +} + +inline std::shared_ptr spdlog::step_logger_st( + const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, size_t max_file_size) +{ + return create(logger_name, filename_fmt, seconds, max_file_size); +} + // // stdout/stderr loggers // diff --git a/include/spdlog/sinks/file_sinks.h b/include/spdlog/sinks/file_sinks.h index 109c493a..407c5b83 100644 --- a/include/spdlog/sinks/file_sinks.h +++ b/include/spdlog/sinks/file_sinks.h @@ -251,5 +251,97 @@ private: using daily_file_sink_mt = daily_file_sink; using daily_file_sink_st = daily_file_sink; +/* + * Default generator of step log file names. + */ +struct default_step_file_name_calculator +{ + // Create filename for the form filename_YYYY-MM-DD_hh-mm-ss.ext + static std::tuple 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}-{:02d}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, + tm.tm_hour, tm.tm_min, tm.tm_sec); + return std::make_tuple(w.str(), ext); + } +}; + +/* + * Rotating file sink based on size and a specified time step + */ +template +class step_file_sink SPDLOG_FINAL : public base_sink +{ +public: + step_file_sink(filename_t base_filename, unsigned step_seconds, std::size_t max_size) + : _base_filename(std::move(base_filename)) + , _step_seconds(step_seconds) + , _max_size(max_size) + { + _tp = _next_tp(); + std::tie(_current_filename, _ext) = FileNameCalc::calc_filename(_base_filename); + _file_helper.open(_current_filename); + _current_size = _file_helper.size(); // expensive. called only once + } + +protected: + void _sink_it(const details::log_msg &msg) override + { + _current_size += msg.formatted.size(); + if (std::chrono::system_clock::now() >= _tp || _current_size > _max_size) + { + close_current_file(); + + std::tie(_current_filename, std::ignore) = FileNameCalc::calc_filename(_base_filename); + _file_helper.open(_current_filename); + _tp = _next_tp(); + _current_size = msg.formatted.size(); + } + _file_helper.write(msg); + } + + void _flush() override + { + _file_helper.flush(); + close_current_file(); + } + +private: + std::chrono::system_clock::time_point _next_tp() + { + return std::chrono::system_clock::now() + _step_seconds; + } + + void close_current_file() + { + using details::os::filename_to_str; + + filename_t src =_current_filename; + filename_t target = _current_filename + _ext; + + if (details::file_helper::file_exists(src) && details::os::rename(src, target) != 0) + { + throw spdlog_ex("step_file_sink: failed renaming " + filename_to_str(src) + " to " + filename_to_str(target), errno); + } + } + + filename_t _base_filename; + std::chrono::seconds _step_seconds; + std::size_t _max_size; + + std::chrono::system_clock::time_point _tp; + filename_t _current_filename; + filename_t _ext; + std::size_t _current_size; + + details::file_helper _file_helper; +}; + +using step_file_sink_mt = step_file_sink; +using step_file_sink_st = step_file_sink; + } // namespace sinks } // namespace spdlog diff --git a/include/spdlog/spdlog.h b/include/spdlog/spdlog.h index 21f5951b..f65fe57e 100644 --- a/include/spdlog/spdlog.h +++ b/include/spdlog/spdlog.h @@ -91,6 +91,12 @@ std::shared_ptr rotating_logger_st( std::shared_ptr daily_logger_mt(const std::string &logger_name, const filename_t &filename, int hour = 0, int minute = 0); std::shared_ptr daily_logger_st(const std::string &logger_name, const filename_t &filename, int hour = 0, int minute = 0); +// +// Create a file logger which creates new files with a specified time step and fixed file size: +// +std::shared_ptr step_logger_mt(const std::string &logger_name, const filename_t &filename, unsigned seconds = 60, size_t max_file_size = std::numeric_limits::max()); +std::shared_ptr step_logger_st(const std::string &logger_name, const filename_t &filename, unsigned seconds = 60, size_t max_file_size = std::numeric_limits::max()); + // // Create and register stdout/stderr loggers // diff --git a/tests/file_log.cpp b/tests/file_log.cpp index e20071a3..afcac255 100644 --- a/tests/file_log.cpp +++ b/tests/file_log.cpp @@ -179,6 +179,71 @@ TEST_CASE("daily_logger with custom calculator", "[daily_logger_custom]]") REQUIRE(count_lines(filename) == 10); } +TEST_CASE("step_logger", "[step_logger]]") +{ + prepare_logdir(); + // calculate filename (time based) + std::string basename = "logs/step_log"; + std::tm tm = spdlog::details::os::localtime(); + fmt::MemoryWriter w; + w.write("{}_{:04d}-{:02d}-{:02d}_{:02d}-{:02d}-{:02d}", basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec); + + auto logger = spdlog::step_logger_mt("logger", basename, 60); + logger->flush_on(spdlog::level::info); + for (int i = 0; i < 10; ++i) + { +#if !defined(SPDLOG_FMT_PRINTF) + logger->info("Test message {}", i); +#else + logger->info("Test message %d", i); +#endif + } + + auto filename = w.str(); + REQUIRE(count_lines(filename) == 10); +} + +struct custom_step_file_name_calculator +{ + static std::tuple calc_filename(const spdlog::filename_t &filename) + { + std::tm tm = spdlog::details::os::localtime(); + spdlog::filename_t basename, ext; + std::tie(basename, ext) = spdlog::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}:{:02d}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, + tm.tm_hour, tm.tm_min, tm.tm_sec); + return std::make_tuple(w.str(), ext); + } +}; + +TEST_CASE("step_logger with custom calculator", "[step_logger_custom]]") +{ + using sink_type = spdlog::sinks::step_file_sink; + + prepare_logdir(); + + std::string basename = "logs/step_log_custom"; + std::tm tm = spdlog::details::os::localtime(); + fmt::MemoryWriter w; + w.write("{}.{:04d}:{:02d}:{:02d}.{:02d}:{:02d}:{:02d}", basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, + tm.tm_hour, tm.tm_min, tm.tm_sec); + + auto logger = spdlog::create("logger", basename, 60, std::numeric_limits::max()); + for (int i = 0; i < 10; ++i) + { +#if !defined(SPDLOG_FMT_PRINTF) + logger->info("Test message {}", i); +#else + logger->info("Test message %d", i); +#endif + } + + logger->flush(); + auto filename = w.str(); + REQUIRE(count_lines(filename) == 10); +} + /* * File name calculations */ From 6f12242a55238c19e12399d2a41f67ea6924f9c7 Mon Sep 17 00:00:00 2001 From: Puasonych Date: Wed, 11 Apr 2018 11:41:48 +0300 Subject: [PATCH 18/26] Update .gitignore --- .gitignore | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index be48891f..2b432ca5 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ # Auto generated files -build/* +build/* *.slo *.lo *.o @@ -65,5 +65,7 @@ install_manifest.txt /tests/logs/* # idea -.idea/ +.idea/ + +# vscode .vscode/ \ No newline at end of file From 06580c8333f81f0cd700bf95de1e7c41ede782c4 Mon Sep 17 00:00:00 2001 From: Erik Date: Wed, 11 Apr 2018 22:15:50 +0500 Subject: [PATCH 19/26] Update file_sinks.h --- include/spdlog/sinks/file_sinks.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/include/spdlog/sinks/file_sinks.h b/include/spdlog/sinks/file_sinks.h index 407c5b83..13282789 100644 --- a/include/spdlog/sinks/file_sinks.h +++ b/include/spdlog/sinks/file_sinks.h @@ -286,6 +286,11 @@ public: _file_helper.open(_current_filename); _current_size = _file_helper.size(); // expensive. called only once } + + ~step_file_sink() + { + close_current_file(); + } protected: void _sink_it(const details::log_msg &msg) override @@ -306,7 +311,6 @@ protected: void _flush() override { _file_helper.flush(); - close_current_file(); } private: From be685337b12ece5533df65d78a5bb8a6926c5745 Mon Sep 17 00:00:00 2001 From: Erik Date: Thu, 12 Apr 2018 10:01:02 +0500 Subject: [PATCH 20/26] Update file_sinks.h Removed possible throw of an exception from the destructor --- include/spdlog/sinks/file_sinks.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/include/spdlog/sinks/file_sinks.h b/include/spdlog/sinks/file_sinks.h index 13282789..73724d23 100644 --- a/include/spdlog/sinks/file_sinks.h +++ b/include/spdlog/sinks/file_sinks.h @@ -289,7 +289,12 @@ public: ~step_file_sink() { - close_current_file(); + using details::os::filename_to_str; + + filename_t src =_current_filename; + filename_t target = _current_filename + _ext; + + details::os::rename(src, target); } protected: From bce3b75c53f80c8b3c9fd33ee2b2542bed11a61b Mon Sep 17 00:00:00 2001 From: Gabi Melman Date: Fri, 13 Apr 2018 12:44:43 +0300 Subject: [PATCH 21/26] Created contrib directory --- include/spdlog/contrib/README.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 include/spdlog/contrib/README.md diff --git a/include/spdlog/contrib/README.md b/include/spdlog/contrib/README.md new file mode 100644 index 00000000..e3abc34d --- /dev/null +++ b/include/spdlog/contrib/README.md @@ -0,0 +1 @@ +Please put here your contribs. Popular contribs will be moved to main tree after stablization From 5e08950ed2d983f0f640c4aa85fb96e5fe23592b Mon Sep 17 00:00:00 2001 From: Gabi Melman Date: Fri, 13 Apr 2018 12:45:33 +0300 Subject: [PATCH 22/26] Created contrib/sinks directory --- include/spdlog/contrib/sinks/.gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 include/spdlog/contrib/sinks/.gitignore diff --git a/include/spdlog/contrib/sinks/.gitignore b/include/spdlog/contrib/sinks/.gitignore new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/include/spdlog/contrib/sinks/.gitignore @@ -0,0 +1 @@ + From 1b2f6815bf784ac67defb72966511316b0d6458b Mon Sep 17 00:00:00 2001 From: Jan Niklas Hasse Date: Mon, 16 Apr 2018 10:58:50 +0200 Subject: [PATCH 23/26] Silence warning "value stored to rv is never read" --- tests/utils.cpp | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/utils.cpp b/tests/utils.cpp index 2c50ce36..5afdb4cf 100644 --- a/tests/utils.cpp +++ b/tests/utils.cpp @@ -8,6 +8,7 @@ void prepare_logdir() system("del /F /Q logs\\*"); #else auto rv = system("mkdir -p logs"); + (void)rv; rv = system("rm -f logs/*"); (void)rv; #endif From 093edc2dc2385a6488cccd1ad8fa422353ed7991 Mon Sep 17 00:00:00 2001 From: Puasonych Date: Mon, 16 Apr 2018 12:56:45 +0300 Subject: [PATCH 24/26] Update step_logger Test release of a logger step_logger --- include/spdlog/contrib/sinks/step_file_sink.h | 161 ++++++++++++++++++ include/spdlog/details/spdlog_impl.h | 13 -- include/spdlog/sinks/file_sinks.h | 101 ----------- include/spdlog/spdlog.h | 6 - tests/file_log.cpp | 65 ------- 5 files changed, 161 insertions(+), 185 deletions(-) create mode 100644 include/spdlog/contrib/sinks/step_file_sink.h diff --git a/include/spdlog/contrib/sinks/step_file_sink.h b/include/spdlog/contrib/sinks/step_file_sink.h new file mode 100644 index 00000000..6be4d8ef --- /dev/null +++ b/include/spdlog/contrib/sinks/step_file_sink.h @@ -0,0 +1,161 @@ +#pragma once + +#include "../../details/file_helper.h" +#include "../../details/null_mutex.h" +#include "../../fmt/fmt.h" +#include "../../sinks/base_sink.h" + +#include +#include +#include +#include +#include +#include +#include + +// Example for spdlog.h +// +// Create a file logger which creates new files with a specified time step and fixed file size: +// +// std::shared_ptr step_logger_mt(const std::string &logger_name, const filename_t &filename, unsigned seconds = 60, const filename_t &tmp_ext = ".tmp", unsigned max_file_size = std::numeric_limits::max()); +// std::shared_ptr step_logger_st(const std::string &logger_name, const filename_t &filename, unsigned seconds = 60, const filename_t &tmp_ext = ".tmp", unsigned max_file_size = std::numeric_limits::max();; + +// Example for spdlog_impl.h +// Create a file logger that creates new files with a specified increment +// inline std::shared_ptr spdlog::step_logger_mt( +// const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, const filename_t &tmp_ext, unsigned max_file_size) +// { +// return create(logger_name, filename_fmt, seconds, tmp_ext, max_file_size); +// } + +// inline std::shared_ptr spdlog::step_logger_st( +// const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, const filename_t &tmp_ext, unsigned max_file_size) +// { +// return create(logger_name, filename_fmt, seconds, tmp_ext, max_file_size); +// } + +namespace spdlog { +namespace sinks { + +/* + * Default generator of step log file names. + */ +struct default_step_file_name_calculator +{ + // Create filename for the form filename_YYYY-MM-DD_hh-mm-ss.ext + static std::tuple calc_filename(const filename_t &filename, const filename_t &tmp_ext) + { + 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}-{:02d}{}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, + tm.tm_hour, tm.tm_min, tm.tm_sec, tmp_ext); + return std::make_tuple(w.str(), ext); + } +}; + +/* + * Rotating file sink based on size and a specified time step + */ +template +class step_file_sink SPDLOG_FINAL : public base_sink +{ +public: + step_file_sink(filename_t base_filename, unsigned step_seconds, filename_t tmp_ext, unsigned max_size) + : _base_filename(std::move(base_filename)) + , _tmp_ext(std::move(tmp_ext)) + , _step_seconds(step_seconds) + , _max_size(max_size) + { + if (step_seconds == 0) + { + throw spdlog_ex("step_file_sink: Invalid time step in ctor"); + } + if (max_size == 0) + { + throw spdlog_ex("step_file_sink: Invalid max log size in ctor"); + } + + _tp = _next_tp(); + std::tie(_current_filename, _ext) = FileNameCalc::calc_filename(_base_filename, _tmp_ext); + + if (_tmp_ext == _ext) + { + throw spdlog_ex("step_file_sink: The temporary extension matches the specified in ctor"); + } + + _file_helper.open(_current_filename); + _current_size = _file_helper.size(); // expensive. called only once + } + + ~step_file_sink() + { + using details::os::filename_to_str; + + filename_t src =_current_filename, target; + std::tie(target, std::ignore) = details::file_helper::split_by_extenstion(src); + target += _ext; + + details::os::rename(src, target); + } + +protected: + void _sink_it(const details::log_msg &msg) override + { + _current_size += msg.formatted.size(); + if (std::chrono::system_clock::now() >= _tp || _current_size > _max_size) + { + close_current_file(); + + std::tie(_current_filename, std::ignore) = FileNameCalc::calc_filename(_base_filename, _tmp_ext); + _file_helper.open(_current_filename); + _tp = _next_tp(); + _current_size = msg.formatted.size(); + } + _file_helper.write(msg); + } + + void _flush() override + { + _file_helper.flush(); + } + +private: + std::chrono::system_clock::time_point _next_tp() + { + return std::chrono::system_clock::now() + _step_seconds; + } + + void close_current_file() + { + using details::os::filename_to_str; + + filename_t src =_current_filename, target; + std::tie(target, std::ignore) = details::file_helper::split_by_extenstion(src); + target += _ext; + + if (details::file_helper::file_exists(src) && details::os::rename(src, target) != 0) + { + throw spdlog_ex("step_file_sink: failed renaming " + filename_to_str(src) + " to " + filename_to_str(target), errno); + } + } + + const filename_t _base_filename; + const filename_t _tmp_ext; + const std::chrono::seconds _step_seconds; + const unsigned _max_size; + + std::chrono::system_clock::time_point _tp; + filename_t _current_filename; + filename_t _ext; + unsigned _current_size; + + details::file_helper _file_helper; +}; + +using step_file_sink_mt = step_file_sink; +using step_file_sink_st = step_file_sink; + +} // namespace sinks +} // namespace spdlog diff --git a/include/spdlog/details/spdlog_impl.h b/include/spdlog/details/spdlog_impl.h index 7d9195bc..4c363834 100644 --- a/include/spdlog/details/spdlog_impl.h +++ b/include/spdlog/details/spdlog_impl.h @@ -83,19 +83,6 @@ inline std::shared_ptr spdlog::daily_logger_st( return create(logger_name, filename, hour, minute); } -// Create a file logger that creates new files with a specified increment -inline std::shared_ptr spdlog::step_logger_mt( - const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, size_t max_file_size) -{ - return create(logger_name, filename_fmt, seconds, max_file_size); -} - -inline std::shared_ptr spdlog::step_logger_st( - const std::string &logger_name, const filename_t &filename_fmt, unsigned seconds, size_t max_file_size) -{ - return create(logger_name, filename_fmt, seconds, max_file_size); -} - // // stdout/stderr loggers // diff --git a/include/spdlog/sinks/file_sinks.h b/include/spdlog/sinks/file_sinks.h index 73724d23..109c493a 100644 --- a/include/spdlog/sinks/file_sinks.h +++ b/include/spdlog/sinks/file_sinks.h @@ -251,106 +251,5 @@ private: using daily_file_sink_mt = daily_file_sink; using daily_file_sink_st = daily_file_sink; -/* - * Default generator of step log file names. - */ -struct default_step_file_name_calculator -{ - // Create filename for the form filename_YYYY-MM-DD_hh-mm-ss.ext - static std::tuple 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}-{:02d}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, - tm.tm_hour, tm.tm_min, tm.tm_sec); - return std::make_tuple(w.str(), ext); - } -}; - -/* - * Rotating file sink based on size and a specified time step - */ -template -class step_file_sink SPDLOG_FINAL : public base_sink -{ -public: - step_file_sink(filename_t base_filename, unsigned step_seconds, std::size_t max_size) - : _base_filename(std::move(base_filename)) - , _step_seconds(step_seconds) - , _max_size(max_size) - { - _tp = _next_tp(); - std::tie(_current_filename, _ext) = FileNameCalc::calc_filename(_base_filename); - _file_helper.open(_current_filename); - _current_size = _file_helper.size(); // expensive. called only once - } - - ~step_file_sink() - { - using details::os::filename_to_str; - - filename_t src =_current_filename; - filename_t target = _current_filename + _ext; - - details::os::rename(src, target); - } - -protected: - void _sink_it(const details::log_msg &msg) override - { - _current_size += msg.formatted.size(); - if (std::chrono::system_clock::now() >= _tp || _current_size > _max_size) - { - close_current_file(); - - std::tie(_current_filename, std::ignore) = FileNameCalc::calc_filename(_base_filename); - _file_helper.open(_current_filename); - _tp = _next_tp(); - _current_size = msg.formatted.size(); - } - _file_helper.write(msg); - } - - void _flush() override - { - _file_helper.flush(); - } - -private: - std::chrono::system_clock::time_point _next_tp() - { - return std::chrono::system_clock::now() + _step_seconds; - } - - void close_current_file() - { - using details::os::filename_to_str; - - filename_t src =_current_filename; - filename_t target = _current_filename + _ext; - - if (details::file_helper::file_exists(src) && details::os::rename(src, target) != 0) - { - throw spdlog_ex("step_file_sink: failed renaming " + filename_to_str(src) + " to " + filename_to_str(target), errno); - } - } - - filename_t _base_filename; - std::chrono::seconds _step_seconds; - std::size_t _max_size; - - std::chrono::system_clock::time_point _tp; - filename_t _current_filename; - filename_t _ext; - std::size_t _current_size; - - details::file_helper _file_helper; -}; - -using step_file_sink_mt = step_file_sink; -using step_file_sink_st = step_file_sink; - } // namespace sinks } // namespace spdlog diff --git a/include/spdlog/spdlog.h b/include/spdlog/spdlog.h index f65fe57e..21f5951b 100644 --- a/include/spdlog/spdlog.h +++ b/include/spdlog/spdlog.h @@ -91,12 +91,6 @@ std::shared_ptr rotating_logger_st( std::shared_ptr daily_logger_mt(const std::string &logger_name, const filename_t &filename, int hour = 0, int minute = 0); std::shared_ptr daily_logger_st(const std::string &logger_name, const filename_t &filename, int hour = 0, int minute = 0); -// -// Create a file logger which creates new files with a specified time step and fixed file size: -// -std::shared_ptr step_logger_mt(const std::string &logger_name, const filename_t &filename, unsigned seconds = 60, size_t max_file_size = std::numeric_limits::max()); -std::shared_ptr step_logger_st(const std::string &logger_name, const filename_t &filename, unsigned seconds = 60, size_t max_file_size = std::numeric_limits::max()); - // // Create and register stdout/stderr loggers // diff --git a/tests/file_log.cpp b/tests/file_log.cpp index afcac255..e20071a3 100644 --- a/tests/file_log.cpp +++ b/tests/file_log.cpp @@ -179,71 +179,6 @@ TEST_CASE("daily_logger with custom calculator", "[daily_logger_custom]]") REQUIRE(count_lines(filename) == 10); } -TEST_CASE("step_logger", "[step_logger]]") -{ - prepare_logdir(); - // calculate filename (time based) - std::string basename = "logs/step_log"; - std::tm tm = spdlog::details::os::localtime(); - fmt::MemoryWriter w; - w.write("{}_{:04d}-{:02d}-{:02d}_{:02d}-{:02d}-{:02d}", basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec); - - auto logger = spdlog::step_logger_mt("logger", basename, 60); - logger->flush_on(spdlog::level::info); - for (int i = 0; i < 10; ++i) - { -#if !defined(SPDLOG_FMT_PRINTF) - logger->info("Test message {}", i); -#else - logger->info("Test message %d", i); -#endif - } - - auto filename = w.str(); - REQUIRE(count_lines(filename) == 10); -} - -struct custom_step_file_name_calculator -{ - static std::tuple calc_filename(const spdlog::filename_t &filename) - { - std::tm tm = spdlog::details::os::localtime(); - spdlog::filename_t basename, ext; - std::tie(basename, ext) = spdlog::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}:{:02d}"), basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, - tm.tm_hour, tm.tm_min, tm.tm_sec); - return std::make_tuple(w.str(), ext); - } -}; - -TEST_CASE("step_logger with custom calculator", "[step_logger_custom]]") -{ - using sink_type = spdlog::sinks::step_file_sink; - - prepare_logdir(); - - std::string basename = "logs/step_log_custom"; - std::tm tm = spdlog::details::os::localtime(); - fmt::MemoryWriter w; - w.write("{}.{:04d}:{:02d}:{:02d}.{:02d}:{:02d}:{:02d}", basename, tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, - tm.tm_hour, tm.tm_min, tm.tm_sec); - - auto logger = spdlog::create("logger", basename, 60, std::numeric_limits::max()); - for (int i = 0; i < 10; ++i) - { -#if !defined(SPDLOG_FMT_PRINTF) - logger->info("Test message {}", i); -#else - logger->info("Test message %d", i); -#endif - } - - logger->flush(); - auto filename = w.str(); - REQUIRE(count_lines(filename) == 10); -} - /* * File name calculations */ From ce41991c51124b1cd3d626d606ed5d2d06ac8d8e Mon Sep 17 00:00:00 2001 From: Gabi Melman Date: Fri, 20 Apr 2018 12:59:51 +0300 Subject: [PATCH 25/26] Remove unneeded include --- include/spdlog/details/logger_impl.h | 1 - 1 file changed, 1 deletion(-) diff --git a/include/spdlog/details/logger_impl.h b/include/spdlog/details/logger_impl.h index d5487249..ddbcb875 100644 --- a/include/spdlog/details/logger_impl.h +++ b/include/spdlog/details/logger_impl.h @@ -6,7 +6,6 @@ #pragma once #include "../logger.h" -#include "../sinks/stdout_sinks.h" #include #include From 217ad75ebd607f60164a28c4d8e8d1d57194de35 Mon Sep 17 00:00:00 2001 From: gabime Date: Fri, 20 Apr 2018 13:02:21 +0300 Subject: [PATCH 26/26] Fixed deault error handler not to use sink but write directly to stderr --- include/spdlog/details/logger_impl.h | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/include/spdlog/details/logger_impl.h b/include/spdlog/details/logger_impl.h index ddbcb875..213fdeda 100644 --- a/include/spdlog/details/logger_impl.h +++ b/include/spdlog/details/logger_impl.h @@ -344,13 +344,11 @@ inline void spdlog::logger::_default_err_handler(const std::string &msg) { return; } + _last_err_time = now; auto tm_time = details::os::localtime(now); char date_buf[100]; std::strftime(date_buf, sizeof(date_buf), "%Y-%m-%d %H:%M:%S", &tm_time); - details::log_msg err_msg; - err_msg.formatted.write("[*** LOG ERROR ***] [{}] [{}] [{}]{}", name(), msg, date_buf, details::os::default_eol); - sinks::stderr_sink_mt::instance()->log(err_msg); - _last_err_time = now; + fmt::print(stderr, "[*** LOG ERROR ***] [{}] [{}] {}\n", date_buf, name(), msg); } inline bool spdlog::logger::_should_flush_on(const details::log_msg &msg)