From 29f2eeea3190d27408ad7305bf643dfd30ae4903 Mon Sep 17 00:00:00 2001 From: gabime Date: Thu, 27 Jun 2019 23:56:37 +0300 Subject: [PATCH] Removed formatter_ member from the sink interface --- include/spdlog/sinks/ansicolor_sink-inl.h | 1 + include/spdlog/sinks/ansicolor_sink.h | 1 + include/spdlog/sinks/base_sink-inl.h | 12 ++++++++++++ include/spdlog/sinks/base_sink.h | 8 ++++++-- include/spdlog/sinks/basic_file_sink-inl.h | 2 +- include/spdlog/sinks/daily_file_sink.h | 2 +- include/spdlog/sinks/dup_filter_sink.h | 10 ++++------ include/spdlog/sinks/msvc_sink.h | 2 +- include/spdlog/sinks/ostream_sink.h | 2 +- include/spdlog/sinks/rotating_file_sink-inl.h | 2 +- include/spdlog/sinks/sink-inl.h | 10 +--------- include/spdlog/sinks/sink.h | 10 +--------- include/spdlog/sinks/stdout_sinks-inl.h | 1 + include/spdlog/sinks/stdout_sinks.h | 3 ++- include/spdlog/sinks/syslog_sink.h | 2 +- include/spdlog/sinks/wincolor_sink-inl.h | 5 ++++- include/spdlog/sinks/wincolor_sink.h | 3 ++- tests/test_dup_filter.cpp | 18 ++++++++---------- 18 files changed, 49 insertions(+), 45 deletions(-) diff --git a/include/spdlog/sinks/ansicolor_sink-inl.h b/include/spdlog/sinks/ansicolor_sink-inl.h index b5f6aff9..74b9c3ec 100644 --- a/include/spdlog/sinks/ansicolor_sink-inl.h +++ b/include/spdlog/sinks/ansicolor_sink-inl.h @@ -16,6 +16,7 @@ template SPDLOG_INLINE ansicolor_sink::ansicolor_sink(FILE *target_file, color_mode mode) : target_file_(target_file) , mutex_(ConsoleMutex::mutex()) + , formatter_(details::make_unique()) { set_color_mode(mode); diff --git a/include/spdlog/sinks/ansicolor_sink.h b/include/spdlog/sinks/ansicolor_sink.h index e1d5f7e4..f383b5a5 100644 --- a/include/spdlog/sinks/ansicolor_sink.h +++ b/include/spdlog/sinks/ansicolor_sink.h @@ -79,6 +79,7 @@ private: FILE *target_file_; mutex_t &mutex_; bool should_do_colors_; + std::unique_ptr formatter_; std::unordered_map colors_; void print_ccode_(const string_view_t &color_code); void print_range_(const fmt::memory_buffer &formatted, size_t start, size_t end); diff --git a/include/spdlog/sinks/base_sink-inl.h b/include/spdlog/sinks/base_sink-inl.h index 553f2515..565cdc17 100644 --- a/include/spdlog/sinks/base_sink-inl.h +++ b/include/spdlog/sinks/base_sink-inl.h @@ -10,6 +10,18 @@ #include "spdlog/common.h" #include "spdlog/details/pattern_formatter.h" +#include + +template +SPDLOG_INLINE spdlog::sinks::base_sink::base_sink() + : formatter_{details::make_unique()} +{} + +template +SPDLOG_INLINE spdlog::sinks::base_sink::base_sink(std::unique_ptr formatter) + : formatter_{std::move(formatter)} +{} + template void SPDLOG_INLINE spdlog::sinks::base_sink::log(const details::log_msg &msg) { diff --git a/include/spdlog/sinks/base_sink.h b/include/spdlog/sinks/base_sink.h index 63010afa..4ca51c75 100644 --- a/include/spdlog/sinks/base_sink.h +++ b/include/spdlog/sinks/base_sink.h @@ -19,7 +19,8 @@ template class base_sink : public sink { public: - base_sink() = default; + base_sink(); + explicit base_sink(std::unique_ptr formatter); base_sink(const base_sink &) = delete; base_sink &operator=(const base_sink &) = delete; void log(const details::log_msg &msg) final; @@ -28,11 +29,14 @@ public: void set_formatter(std::unique_ptr sink_formatter) final; protected: + // sink formatter + std::unique_ptr formatter_; + Mutex mutex_; + virtual void sink_it_(const details::log_msg &msg) = 0; virtual void flush_() = 0; virtual void set_pattern_(const std::string &pattern); virtual void set_formatter_(std::unique_ptr sink_formatter); - Mutex mutex_; }; } // namespace sinks } // namespace spdlog diff --git a/include/spdlog/sinks/basic_file_sink-inl.h b/include/spdlog/sinks/basic_file_sink-inl.h index 6683eeba..108b8ff7 100644 --- a/include/spdlog/sinks/basic_file_sink-inl.h +++ b/include/spdlog/sinks/basic_file_sink-inl.h @@ -29,7 +29,7 @@ template SPDLOG_INLINE void basic_file_sink::sink_it_(const details::log_msg &msg) { fmt::memory_buffer formatted; - sink::formatter_->format(msg, formatted); + base_sink::formatter_->format(msg, formatted); file_helper_.write(formatted); } diff --git a/include/spdlog/sinks/daily_file_sink.h b/include/spdlog/sinks/daily_file_sink.h index 8c907171..687da043 100644 --- a/include/spdlog/sinks/daily_file_sink.h +++ b/include/spdlog/sinks/daily_file_sink.h @@ -74,7 +74,7 @@ protected: rotation_tp_ = next_rotation_tp_(); } fmt::memory_buffer formatted; - sink::formatter_->format(msg, formatted); + base_sink::formatter_->format(msg, formatted); file_helper_.write(formatted); } diff --git a/include/spdlog/sinks/dup_filter_sink.h b/include/spdlog/sinks/dup_filter_sink.h index 67a171ef..a244b4e9 100644 --- a/include/spdlog/sinks/dup_filter_sink.h +++ b/include/spdlog/sinks/dup_filter_sink.h @@ -33,8 +33,6 @@ // [2019-06-25 17:50:56.512] [logger] [info] Skipped 3 duplicate messages.. // [2019-06-25 17:50:56.512] [logger] [info] Different Hello - - namespace spdlog { namespace sinks { template @@ -55,14 +53,14 @@ protected: void sink_it_(const details::log_msg &msg) override { bool filtered = filter_(msg); - if(!filtered) + if (!filtered) { skip_counter_ += 1; return; } // log the "skipped.." message - if(skip_counter_ > 0) + if (skip_counter_ > 0) { fmt::basic_memory_buffer buf; fmt::format_to(buf, "Skipped {} duplicate messages..", skip_counter_); @@ -72,7 +70,7 @@ protected: // log current message dist_sink::sink_it_(msg); - last_msg_time_= msg.time; + last_msg_time_ = msg.time; skip_counter_ = 0; last_msg_payload_.assign(msg.payload.data(), msg.payload.data() + msg.payload.size()); } @@ -81,7 +79,7 @@ protected: bool filter_(const details::log_msg &msg) { auto filter_duration = msg.time - last_msg_time_; - return (filter_duration > max_skip_duration_) || (msg.payload != last_msg_payload_); + return (filter_duration > max_skip_duration_) || (msg.payload != last_msg_payload_); } }; diff --git a/include/spdlog/sinks/msvc_sink.h b/include/spdlog/sinks/msvc_sink.h index e2c8fa34..08e029a0 100644 --- a/include/spdlog/sinks/msvc_sink.h +++ b/include/spdlog/sinks/msvc_sink.h @@ -29,7 +29,7 @@ protected: { fmt::memory_buffer formatted; - sink::formatter_->format(msg, formatted); + base_sink::formatter_->format(msg, formatted); OutputDebugStringA(fmt::to_string(formatted).c_str()); } diff --git a/include/spdlog/sinks/ostream_sink.h b/include/spdlog/sinks/ostream_sink.h index a2a5a3a3..6a728a3a 100644 --- a/include/spdlog/sinks/ostream_sink.h +++ b/include/spdlog/sinks/ostream_sink.h @@ -26,7 +26,7 @@ protected: void sink_it_(const details::log_msg &msg) override { fmt::memory_buffer formatted; - sink::formatter_->format(msg, formatted); + base_sink::formatter_->format(msg, formatted); ostream_.write(formatted.data(), static_cast(formatted.size())); if (force_flush_) { diff --git a/include/spdlog/sinks/rotating_file_sink-inl.h b/include/spdlog/sinks/rotating_file_sink-inl.h index 588619f8..c5d7c3a2 100644 --- a/include/spdlog/sinks/rotating_file_sink-inl.h +++ b/include/spdlog/sinks/rotating_file_sink-inl.h @@ -67,7 +67,7 @@ template SPDLOG_INLINE void rotating_file_sink::sink_it_(const details::log_msg &msg) { fmt::memory_buffer formatted; - sink::formatter_->format(msg, formatted); + base_sink::formatter_->format(msg, formatted); current_size_ += formatted.size(); if (current_size_ > max_size_) { diff --git a/include/spdlog/sinks/sink-inl.h b/include/spdlog/sinks/sink-inl.h index 11b77fc9..b5f43488 100644 --- a/include/spdlog/sinks/sink-inl.h +++ b/include/spdlog/sinks/sink-inl.h @@ -10,14 +10,6 @@ #include "spdlog/common.h" #include "spdlog/details/pattern_formatter.h" -SPDLOG_INLINE spdlog::sinks::sink::sink() - : formatter_{details::make_unique()} -{} - -SPDLOG_INLINE spdlog::sinks::sink::sink(std::unique_ptr formatter) - : formatter_{std::move(formatter)} -{} - SPDLOG_INLINE bool spdlog::sinks::sink::should_log(spdlog::level::level_enum msg_level) const { return msg_level >= level_.load(std::memory_order_relaxed); @@ -25,7 +17,7 @@ SPDLOG_INLINE bool spdlog::sinks::sink::should_log(spdlog::level::level_enum msg SPDLOG_INLINE void spdlog::sinks::sink::set_level(level::level_enum log_level) { - level_.store(log_level); + level_.store(log_level, std::memory_order_relaxed); } SPDLOG_INLINE spdlog::level::level_enum spdlog::sinks::sink::level() const diff --git a/include/spdlog/sinks/sink.h b/include/spdlog/sinks/sink.h index f9703fdf..6515f1f1 100644 --- a/include/spdlog/sinks/sink.h +++ b/include/spdlog/sinks/sink.h @@ -12,27 +12,19 @@ namespace sinks { class sink { public: - sink(); - - explicit sink(std::unique_ptr formatter); virtual ~sink() = default; virtual void log(const details::log_msg &msg) = 0; virtual void flush() = 0; virtual void set_pattern(const std::string &pattern) = 0; virtual void set_formatter(std::unique_ptr sink_formatter) = 0; - bool should_log(level::level_enum msg_level) const; - void set_level(level::level_enum log_level); - level::level_enum level() const; + bool should_log(level::level_enum msg_level) const; protected: // sink log level - default is all level_t level_{level::trace}; - - // sink formatter - std::unique_ptr formatter_; }; } // namespace sinks diff --git a/include/spdlog/sinks/stdout_sinks-inl.h b/include/spdlog/sinks/stdout_sinks-inl.h index 37a2f5f2..3c55ce66 100644 --- a/include/spdlog/sinks/stdout_sinks-inl.h +++ b/include/spdlog/sinks/stdout_sinks-inl.h @@ -18,6 +18,7 @@ template SPDLOG_INLINE stdout_sink_base::stdout_sink_base(FILE *file) : mutex_(ConsoleMutex::mutex()) , file_(file) + , formatter_(details::make_unique()) {} template diff --git a/include/spdlog/sinks/stdout_sinks.h b/include/spdlog/sinks/stdout_sinks.h index c0852383..04d2fa42 100644 --- a/include/spdlog/sinks/stdout_sinks.h +++ b/include/spdlog/sinks/stdout_sinks.h @@ -28,9 +28,10 @@ public: void set_formatter(std::unique_ptr sink_formatter) override; -private: +protected: mutex_t &mutex_; FILE *file_; + std::unique_ptr formatter_; }; template diff --git a/include/spdlog/sinks/syslog_sink.h b/include/spdlog/sinks/syslog_sink.h index 42dbda0f..f58da3e2 100644 --- a/include/spdlog/sinks/syslog_sink.h +++ b/include/spdlog/sinks/syslog_sink.h @@ -52,7 +52,7 @@ protected: if (enable_formatting_) { fmt::memory_buffer formatted; - sink::formatter_->format(msg, formatted); + base_sink::formatter_->format(msg, formatted); payload = string_view_t(formatted.data(), formatted.size()); } else diff --git a/include/spdlog/sinks/wincolor_sink-inl.h b/include/spdlog/sinks/wincolor_sink-inl.h index 12c772cc..ff99836d 100644 --- a/include/spdlog/sinks/wincolor_sink-inl.h +++ b/include/spdlog/sinks/wincolor_sink-inl.h @@ -8,14 +8,17 @@ #endif #include "spdlog/common.h" +#include "spdlog/details/pattern_formatter.h" namespace spdlog { namespace sinks { template SPDLOG_INLINE wincolor_sink::wincolor_sink(HANDLE out_handle, color_mode mode) - : out_handle_(out_handle) + : + , out_handle_(out_handle) , mutex_(ConsoleMutex::mutex()) + , formatter_(details::make_unique()) { set_color_mode(mode); colors_[level::trace] = WHITE; diff --git a/include/spdlog/sinks/wincolor_sink.h b/include/spdlog/sinks/wincolor_sink.h index 94a84912..5a969704 100644 --- a/include/spdlog/sinks/wincolor_sink.h +++ b/include/spdlog/sinks/wincolor_sink.h @@ -45,11 +45,12 @@ public: void set_formatter(std::unique_ptr sink_formatter) override final; void set_color_mode(color_mode mode); -private: +protected: using mutex_t = typename ConsoleMutex::mutex_t; HANDLE out_handle_; mutex_t &mutex_; bool should_do_colors_; + std::unique_ptr formatter_; std::unordered_map colors_; // set color and return the orig console attributes (for resetting later) diff --git a/tests/test_dup_filter.cpp b/tests/test_dup_filter.cpp index 4f5a53f3..f6b6c476 100644 --- a/tests/test_dup_filter.cpp +++ b/tests/test_dup_filter.cpp @@ -5,14 +5,13 @@ using namespace spdlog; using namespace spdlog::sinks; - TEST_CASE("dup_filter_test1", "[dup_filter_sink]") { - dup_filter_sink_st dup_sink {std::chrono::seconds{5}}; + dup_filter_sink_st dup_sink{std::chrono::seconds{5}}; auto test_sink = std::make_shared(); dup_sink.add_sink(test_sink); - for(int i = 0; i < 10; i++) + for (int i = 0; i < 10; i++) { dup_sink.log(spdlog::details::log_msg{"test", spdlog::level::info, "message1"}); } @@ -22,11 +21,11 @@ TEST_CASE("dup_filter_test1", "[dup_filter_sink]") TEST_CASE("dup_filter_test2", "[dup_filter_sink]") { - dup_filter_sink_st dup_sink {std::chrono::seconds{0}}; + dup_filter_sink_st dup_sink{std::chrono::seconds{0}}; auto test_sink = std::make_shared(); dup_sink.add_sink(test_sink); - for(int i = 0; i < 10; i++) + for (int i = 0; i < 10; i++) { dup_sink.log(spdlog::details::log_msg{"test", spdlog::level::info, "message1"}); } @@ -36,11 +35,11 @@ TEST_CASE("dup_filter_test2", "[dup_filter_sink]") TEST_CASE("dup_filter_test3", "[dup_filter_sink]") { - dup_filter_sink_st dup_sink {std::chrono::seconds{0}}; + dup_filter_sink_st dup_sink{std::chrono::seconds{0}}; auto test_sink = std::make_shared(); dup_sink.add_sink(test_sink); - for(int i = 0; i < 10; i++) + for (int i = 0; i < 10; i++) { dup_sink.log(spdlog::details::log_msg{"test", spdlog::level::info, "message1"}); dup_sink.log(spdlog::details::log_msg{"test", spdlog::level::info, "message2"}); @@ -51,7 +50,7 @@ TEST_CASE("dup_filter_test3", "[dup_filter_sink]") TEST_CASE("dup_filter_test4", "[dup_filter_sink]") { - dup_filter_sink_mt dup_sink {std::chrono::milliseconds{10}}; + dup_filter_sink_mt dup_sink{std::chrono::milliseconds{10}}; auto test_sink = std::make_shared(); dup_sink.add_sink(test_sink); @@ -63,7 +62,7 @@ TEST_CASE("dup_filter_test4", "[dup_filter_sink]") TEST_CASE("dup_filter_test5", "[dup_filter_sink]") { - dup_filter_sink_mt dup_sink {std::chrono::seconds{5}}; + dup_filter_sink_mt dup_sink{std::chrono::seconds{5}}; auto test_sink = std::make_shared(); dup_sink.add_sink(test_sink); @@ -74,4 +73,3 @@ TEST_CASE("dup_filter_test5", "[dup_filter_sink]") REQUIRE(test_sink->msg_counter() == 3); // skip 2 messages but log the "skipped.." message before message2 } -