// Copyright(c) 2015-present Gabi Melman & spdlog contributors. // Distributed under the MIT License (http://opensource.org/licenses/MIT) #pragma once // Thread safe logger (except for set_pattern(..), set_formatter(..) and // set_error_handler()) // Has name, log level, vector of std::shared sink pointers and formatter // Upon each log write the logger: // 1. Checks if its log level is enough to log the message and if yes: // 2. Call the underlying sinks to do the job. // 3. Each sink use its own private copy of a formatter to format the message // and send to its destination. // // The use of private formatter per sink provides the opportunity to cache some // formatted data, and support for different format per sink. #include "spdlog/common.h" #include "spdlog/details/log_msg.h" #ifdef SPDLOG_WCHAR_TO_UTF8_SUPPORT #include "spdlog/details/os.h" #endif #include #include #include #include namespace spdlog { class logger { public: template logger(std::string name, It begin, It end) : name_(std::move(name)) , sinks_(begin, end) {} logger(std::string name, sink_ptr single_sink) : logger(std::move(name), {std::move(single_sink)}) {} logger(std::string name, sinks_init_list sinks) : logger(std::move(name), sinks.begin(), sinks.end()) {} virtual ~logger() = default; logger(const logger &) = delete; logger &operator=(const logger &) = delete; template void log(source_loc loc, level::level_enum lvl, const char *fmt, const Args &... args) { if (!should_log(lvl)) { return; } try { fmt::memory_buffer buf; fmt::format_to(buf, fmt, args...); details::log_msg log_msg(loc, &name_, lvl, string_view_t(buf.data(), buf.size())); sink_it_(log_msg); } catch (const std::exception &ex) { err_handler_(ex.what()); } catch (...) { err_handler_("Unknown exception in logger"); } } template void log(level::level_enum lvl, const char *fmt, const Args &... args) { log(source_loc{}, lvl, fmt, args...); } void log(source_loc loc, level::level_enum lvl, const char *msg); void log(level::level_enum lvl, const char *msg); template void trace(const char *fmt, const Args &... args) { log(level::trace, fmt, args...); } template void debug(const char *fmt, const Args &... args) { log(level::debug, fmt, args...); } template void info(const char *fmt, const Args &... args) { log(level::info, fmt, args...); } template void warn(const char *fmt, const Args &... args) { log(level::warn, fmt, args...); } template void error(const char *fmt, const Args &... args) { log(level::err, fmt, args...); } template void critical(const char *fmt, const Args &... args) { log(level::critical, fmt, args...); } template void log(level::level_enum lvl, const T &msg) { log(source_loc{}, lvl, msg); } // T can be statically converted to string_view template::value, T>::type * = nullptr> void log(source_loc loc, level::level_enum lvl, const T &msg) { if (!should_log(lvl)) { return; } try { details::log_msg log_msg(loc, &name_, lvl, msg); sink_it_(log_msg); } catch (const std::exception &ex) { err_handler_(ex.what()); } catch (...) { err_handler_("Unknown exception in logger"); } } // T cannot be statically converted to string_view template::value, T>::type * = nullptr> void log(source_loc loc, level::level_enum lvl, const T &msg) { if (!should_log(lvl)) { return; } try { fmt::memory_buffer buf; fmt::format_to(buf, "{}", msg); details::log_msg log_msg(loc, &name_, lvl, string_view_t(buf.data(), buf.size())); sink_it_(log_msg); } catch (const std::exception &ex) { err_handler_(ex.what()); } catch (...) { err_handler_("Unknown exception in logger"); } } template void trace(const T &msg) { log(level::trace, msg); } template void debug(const T &msg) { log(level::debug, msg); } template void info(const T &msg) { log(level::info, msg); } template void warn(const T &msg) { log(level::warn, msg); } template void error(const T &msg) { log(level::err, msg); } template void critical(const T &msg) { log(level::critical, msg); } #ifdef SPDLOG_WCHAR_TO_UTF8_SUPPORT #ifndef _WIN32 #error SPDLOG_WCHAR_TO_UTF8_SUPPORT only supported on windows #else template void log(source_loc source, level::level_enum lvl, const wchar_t *fmt, const Args &... args) { if (!should_log(lvl)) { return; } try { // format to wmemory_buffer and convert to utf8 fmt::wmemory_buffer wbuf; fmt::format_to(wbuf, fmt, args...); fmt::memory_buffer buf; details::os::wbuf_to_utf8buf(wbuf, buf); details::log_msg log_msg(source, &name_, lvl, string_view_t(buf.data(), buf.size())); sink_it_(log_msg); } catch (const std::exception &ex) { err_handler_(ex.what()); } catch (...) { err_handler_("Unknown exception in logger"); } } template void log(level::level_enum lvl, const wchar_t *fmt, const Args &... args) { log(source_loc{}, lvl, fmt, args...); } template void trace(const wchar_t *fmt, const Args &... args) { log(level::trace, fmt, args...); } template void debug(const wchar_t *fmt, const Args &... args) { log(level::debug, fmt, args...); } template void info(const wchar_t *fmt, const Args &... args) { log(level::info, fmt, args...); } template void warn(const wchar_t *fmt, const Args &... args) { log(level::warn, fmt, args...); } template void error(const wchar_t *fmt, const Args &... args) { log(level::err, fmt, args...); } template void critical(const wchar_t *fmt, const Args &... args) { log(level::critical, fmt, args...); } #endif // _WIN32 #endif // SPDLOG_WCHAR_TO_UTF8_SUPPORT bool should_log(level::level_enum msg_level) const; void set_level(level::level_enum log_level); static level::level_enum default_level(); level::level_enum level() const; const std::string &name() const; // set formatting for the sinks in this logger. // each sink will get a seperate instance of the formatter object. void set_formatter(std::unique_ptr f); void set_pattern(std::string pattern, pattern_time_type time_type = pattern_time_type::local); // flush functions void flush(); void flush_on(level::level_enum log_level); level::level_enum flush_level() const; // sinks const std::vector &sinks() const; std::vector &sinks(); // error handler void set_error_handler(err_handler); // create new logger with same sinks and configuration. virtual std::shared_ptr clone(std::string logger_name); protected: virtual void sink_it_(details::log_msg &msg); virtual void flush_(); bool should_flush_(const details::log_msg &msg); // default error handler. // print the error to stderr with the max rate of 1 message/minute. void err_handler_(const std::string &msg); const std::string name_; std::vector sinks_; spdlog::level_t level_{spdlog::logger::default_level()}; spdlog::level_t flush_level_{level::off}; err_handler custom_err_handler_{nullptr}; }; } // namespace spdlog #ifdef SPDLOG_HEADER_ONLY #include "logger-inl.h" #endif