/*************************************************************************/ /* spdlog - an extremely fast and easy to use c++11 logging library. */ /* Copyright (c) 2014 Gabi Melman. */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #pragma once #include #include #include #include #include #include "../formatter.h" #include "./log_msg.h" #include "./os.h" namespace spdlog { namespace details { class flag_formatter { public: virtual ~flag_formatter() {} virtual void format(details::log_msg& msg, const std::tm& tm_time) = 0; }; /////////////////////////////////////////////////////////////////////// // name & level pattern appenders /////////////////////////////////////////////////////////////////////// namespace { class name_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm&) override { msg.formatted << msg.logger_name; } }; } // log level appender class level_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm&) override { msg.formatted << level::to_str(msg.level); } }; // short log level appender class short_level_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm&) override { msg.formatted << level::to_short_str(msg.level); } }; /////////////////////////////////////////////////////////////////////// // Date time pattern appenders /////////////////////////////////////////////////////////////////////// static const char* ampm(const tm& t) { return t.tm_hour >= 12 ? "PM" : "AM"; } static int to12h(const tm& t) { return t.tm_hour > 12 ? t.tm_hour - 12 : t.tm_hour; } //Abbreviated weekday name static const std::string days[] { "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" }; class a_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << days[tm_time.tm_wday]; } }; //Full weekday name static const std::string full_days[] { "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" }; class A_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << full_days[tm_time.tm_wday]; } }; //Abbreviated month static const std::string months[] { "Jan", "Feb", "Mar", "Apr", "May", "June", "July", "Aug", "Sept", "Oct", "Nov", "Dec" }; class b_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted<< months[tm_time.tm_mon]; } }; //Full month name static const std::string full_months[] { "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" }; class B_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << full_months[tm_time.tm_mon]; } }; //write 2 ints seperated by sep with padding of 2 static fmt::MemoryWriter& pad_n_join(fmt::MemoryWriter& w, int v1, int v2, char sep) { w << fmt::pad(v1, 2, '0') << sep << fmt::pad(v2, 2, '0'); return w; } //write 3 ints seperated by sep with padding of 2 static fmt::MemoryWriter& pad_n_join(fmt::MemoryWriter& w, int v1, int v2, int v3, char sep) { w << fmt::pad(v1, 2, '0') << sep << fmt::pad(v2, 2, '0') << sep << fmt::pad(v3, 2, '0'); return w; } //Date and time representation (Thu Aug 23 15:35:46 2014) class c_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << days[tm_time.tm_wday] << ' ' << months[tm_time.tm_mon] << ' ' << tm_time.tm_mday << ' '; pad_n_join(msg.formatted, tm_time.tm_hour, tm_time.tm_min, tm_time.tm_sec, ':') << ' ' << tm_time.tm_year + 1900; } }; // year - 2 digit class C_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << fmt::pad(tm_time.tm_year % 100, 2, '0'); } }; // Short MM/DD/YY date, equivalent to %m/%d/%y 08/23/01 class D_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { pad_n_join(msg.formatted, tm_time.tm_mon + 1, tm_time.tm_mday, tm_time.tm_year % 100, '/'); } }; // year - 4 digit class Y_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << tm_time.tm_year + 1900; } }; // month 1-12 class m_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << fmt::pad(tm_time.tm_mon + 1, 2, '0'); } }; // day of month 1-31 class d_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << fmt::pad(tm_time.tm_mday, 2, '0'); } }; // hours in 24 format 0-23 class H_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << fmt::pad(tm_time.tm_hour, 2, '0'); } }; // hours in 12 format 1-12 class I_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << fmt::pad(to12h(tm_time), 2, '0'); } }; // ninutes 0-59 class M_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << fmt::pad(tm_time.tm_min, 2, '0'); } }; // seconds 0-59 class S_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << fmt::pad(tm_time.tm_sec, 2, '0'); } }; // milliseconds class e_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm&) override { auto duration = msg.time.time_since_epoch(); auto millis = std::chrono::duration_cast(duration).count() % 1000; msg.formatted << fmt::pad(static_cast(millis), 3, '0'); } }; // microseconds class f_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm&) override { auto duration = msg.time.time_since_epoch(); auto micros = std::chrono::duration_cast(duration).count() % 1000000; msg.formatted << fmt::pad(static_cast(micros), 6, '0'); } }; // AM/PM class p_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { msg.formatted << ampm(tm_time); } }; // 12 hour clock 02:55:02 pm class r_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { pad_n_join(msg.formatted, to12h(tm_time), tm_time.tm_min, tm_time.tm_sec, ':') << ' ' << ampm(tm_time); } }; // 24-hour HH:MM time, equivalent to %H:%M class R_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { pad_n_join(msg.formatted, tm_time.tm_hour, tm_time.tm_min, ':'); } }; // ISO 8601 time format (HH:MM:SS), equivalent to %H:%M:%S class T_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { pad_n_join(msg.formatted, tm_time.tm_hour, tm_time.tm_min, tm_time.tm_sec, ':'); } }; // ISO 8601 offset from UTC in timezone (+-HH:MM) class z_formatter :public flag_formatter { public: const std::chrono::seconds cache_refresh = std::chrono::seconds(5); z_formatter() :_last_update(std::chrono::seconds(0)) {} z_formatter(const z_formatter&) = delete; z_formatter& operator=(const z_formatter&) = delete; void format(details::log_msg& msg, const std::tm& tm_time) override { #ifdef _WIN32 int total_minutes = get_cached_offset(msg, tm_time); #else // No need to chache under gcc, // it is very fast (already stored in tm.tm_gmtoff) int total_minutes = os::utc_minutes_offset(tm_time); #endif int h = total_minutes / 60; int m = total_minutes % 60; char sign = h >= 0 ? '+' : '-'; msg.formatted << sign; pad_n_join(msg.formatted, h, m, ':'); } private: log_clock::time_point _last_update; int _offset_minutes; std::mutex _mutex; int get_cached_offset(const log_msg& msg, const std::tm& tm_time) { using namespace std::chrono; std::lock_guard l(_mutex); if (msg.time - _last_update >= cache_refresh) { _offset_minutes = os::utc_minutes_offset(tm_time); _last_update = msg.time; } return _offset_minutes; } }; //Thread id class t_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm&) override { msg.formatted << std::hash()(std::this_thread::get_id()); } }; class v_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm&) override { msg.formatted << fmt::StringRef(msg.raw.data(), msg.raw.size()); } }; class ch_formatter :public flag_formatter { public: explicit ch_formatter(char ch) : _ch(ch) {} void format(details::log_msg& msg, const std::tm&) override { msg.formatted << _ch; } private: char _ch; }; //aggregate user chars to display as is class aggregate_formatter :public flag_formatter { public: aggregate_formatter() {} void add_ch(char ch) { _str += ch; } void format(details::log_msg& msg, const std::tm&) override { msg.formatted << _str; } private: std::string _str; }; // Full info formatter // pattern: [%Y-%m-%d %H:%M:%S.%e] [%n] [%l] %v class full_formatter :public flag_formatter { void format(details::log_msg& msg, const std::tm& tm_time) override { auto duration = msg.time.time_since_epoch(); auto millis = std::chrono::duration_cast(duration).count() % 1000; /* Slower version(while still very fast - about 3.2 million lines/sec under 10 threads), msg.formatted.write("[{:d}-{:02d}-{:02d} {:02d}:{:02d}:{:02d}.{:03d}] [{}] [{}] {} ", tm_time.tm_year + 1900, tm_time.tm_mon + 1, tm_time.tm_mday, tm_time.tm_hour, tm_time.tm_min, tm_time.tm_sec, static_cast(millis), msg.logger_name, level::to_str(msg.level), msg.raw.str());*/ // Faster (albeit uglier) way to format the line (5.6 million lines/sec under 10 threads) msg.formatted << '[' << static_cast(tm_time.tm_year + 1900) << '-' << fmt::pad(static_cast(tm_time.tm_mon + 1), 2, '0') << '-' << fmt::pad(static_cast(tm_time.tm_mday), 2, '0') << ' ' << fmt::pad(static_cast(tm_time.tm_hour), 2, '0') << ':' << fmt::pad(static_cast(tm_time.tm_min), 2, '0') << ':' << fmt::pad(static_cast(tm_time.tm_sec), 2, '0') << '.' << fmt::pad(static_cast(millis), 3, '0') << "] "; msg.formatted << '[' << msg.logger_name << "] [" << level::to_str(msg.level) << "] "; msg.formatted << fmt::StringRef(msg.raw.data(), msg.raw.size()); } }; } } /////////////////////////////////////////////////////////////////////////////// // pattern_formatter inline impl /////////////////////////////////////////////////////////////////////////////// inline spdlog::pattern_formatter::pattern_formatter(const std::string& pattern) { compile_pattern(pattern); } inline void spdlog::pattern_formatter::compile_pattern(const std::string& pattern) { auto end = pattern.end(); std::unique_ptr user_chars; for (auto it = pattern.begin(); it != end; ++it) { if (*it == '%') { if (user_chars) //append user chars found so far _formatters.push_back(std::move(user_chars)); if (++it != end) handle_flag(*it); else break; } else // chars not following the % sign should be displayed as is { if (!user_chars) user_chars = std::unique_ptr(new details::aggregate_formatter()); user_chars->add_ch(*it); } } if (user_chars) //append raw chars found so far { _formatters.push_back(std::move(user_chars)); } } inline void spdlog::pattern_formatter::handle_flag(char flag) { switch (flag) { // logger name case 'n': _formatters.push_back(std::unique_ptr(new details::name_formatter())); break; case 'l': _formatters.push_back(std::unique_ptr(new details::level_formatter())); break; case 'L': _formatters.push_back(std::unique_ptr(new details::short_level_formatter())); break; case('t') : _formatters.push_back(std::unique_ptr(new details::t_formatter())); break; case('v') : _formatters.push_back(std::unique_ptr(new details::v_formatter())); break; case('a') : _formatters.push_back(std::unique_ptr(new details::a_formatter())); break; case('A') : _formatters.push_back(std::unique_ptr(new details::A_formatter())); break; case('b') : case('h') : _formatters.push_back(std::unique_ptr(new details::b_formatter())); break; case('B') : _formatters.push_back(std::unique_ptr(new details::B_formatter())); break; case('c') : _formatters.push_back(std::unique_ptr(new details::c_formatter())); break; case('C') : _formatters.push_back(std::unique_ptr(new details::C_formatter())); break; case('Y') : _formatters.push_back(std::unique_ptr(new details::Y_formatter())); break; case('D') : case('x') : _formatters.push_back(std::unique_ptr(new details::D_formatter())); break; case('m') : _formatters.push_back(std::unique_ptr(new details::m_formatter())); break; case('d') : _formatters.push_back(std::unique_ptr(new details::d_formatter())); break; case('H') : _formatters.push_back(std::unique_ptr(new details::H_formatter())); break; case('I') : _formatters.push_back(std::unique_ptr(new details::I_formatter())); break; case('M') : _formatters.push_back(std::unique_ptr(new details::M_formatter())); break; case('S') : _formatters.push_back(std::unique_ptr(new details::S_formatter())); break; case('e') : _formatters.push_back(std::unique_ptr(new details::e_formatter())); break; case('f') : _formatters.push_back(std::unique_ptr(new details::f_formatter())); break; case('p') : _formatters.push_back(std::unique_ptr(new details::p_formatter())); break; case('r') : _formatters.push_back(std::unique_ptr(new details::r_formatter())); break; case('R') : _formatters.push_back(std::unique_ptr(new details::R_formatter())); break; case('T') : case('X') : _formatters.push_back(std::unique_ptr(new details::T_formatter())); break; case('z') : _formatters.push_back(std::unique_ptr(new details::z_formatter())); break; case ('+'): _formatters.push_back(std::unique_ptr(new details::full_formatter())); break; default: //Unkown flag appears as is _formatters.push_back(std::unique_ptr(new details::ch_formatter('%'))); _formatters.push_back(std::unique_ptr(new details::ch_formatter(flag))); break; } } inline void spdlog::pattern_formatter::format(details::log_msg& msg) { try { auto tm_time = details::os::localtime(log_clock::to_time_t(msg.time)); for (auto &f : _formatters) { f->format(msg, tm_time); } //write eol msg.formatted << details::os::eol(); } catch(const details::fmt::FormatError& e) { throw spdlog_ex(details::fmt::format("formatting error while processing format string: {}", e.what())); } }