// Copyright(c) 2015-present, Gabi Melman & spdlog contributors. // Distributed under the MIT License (http://opensource.org/licenses/MIT) #pragma once // Thread-safe logger, with exceptions for these non-thread-safe methods: // set_pattern() - Modifies the log pattern. // set_formatter() - Sets a new formatter. // set_error_handler() - Assigns a new error handler. // sinks() (non-const) - Accesses and potentially modifies the sinks directly. // By default, the logger does not throw exceptions during logging. // To enable exception throwing for logging errors, set a custom error handler. #include #include #include #include "common.h" #include "details/err_helper.h" #include "details/log_msg.h" #include "sinks/sink.h" namespace spdlog { class SPDLOG_API logger { public: // Empty logger explicit logger(std::string name) : name_(std::move(name)) {} // Logger with range on sinks template logger(std::string name, It begin, It end) : name_(std::move(name)), sinks_(begin, end) {} // Logger with single sink logger(std::string name, sink_ptr single_sink) : logger(std::move(name), {std::move(single_sink)}) {} // Logger with sinks init list logger(std::string name, sinks_init_list sinks) : logger(std::move(name), sinks.begin(), sinks.end()) {} logger(const logger &other); logger(logger &&other) noexcept; ~logger() = default; template void log(const source_loc &loc, level lvl, format_string_t fmt, Args &&...args) noexcept { if (should_log(lvl)) { log_with_format_(loc, lvl, fmt, std::forward(args)...); } } template void log(level lvl, format_string_t fmt, Args &&...args) noexcept { if (should_log(lvl)) { log_with_format_(source_loc{}, lvl, fmt, std::forward(args)...); } } // log with no format string, just string message void log(const source_loc &loc, level lvl, string_view_t msg) noexcept { if (should_log(lvl)) { sink_it_(details::log_msg(loc, name_, lvl, msg)); } } void log(level lvl, string_view_t msg) noexcept { if (should_log(lvl)) { sink_it_(details::log_msg(source_loc{}, name_, lvl, msg)); } } // support for custom time void log(log_clock::time_point log_time, const source_loc &loc, level lvl, string_view_t msg) noexcept { if (should_log(lvl)) { sink_it_(details::log_msg(log_time, loc, name_, lvl, msg)); } } template void trace(format_string_t fmt, Args &&...args) noexcept { log(level::trace, fmt, std::forward(args)...); } template void debug(format_string_t fmt, Args &&...args) noexcept { log(level::debug, fmt, std::forward(args)...); } template void info(format_string_t fmt, Args &&...args) noexcept { log(level::info, fmt, std::forward(args)...); } template void warn(format_string_t fmt, Args &&...args) noexcept { log(level::warn, fmt, std::forward(args)...); } template void error(format_string_t fmt, Args &&...args) noexcept { log(level::err, fmt, std::forward(args)...); } template void critical(format_string_t fmt, Args &&...args) noexcept { log(level::critical, fmt, std::forward(args)...); } // log functions with no format string, just string void trace(string_view_t msg) noexcept { log(level::trace, msg); } void debug(string_view_t msg) noexcept { log(level::debug, msg); } void info(string_view_t msg) noexcept { log(level::info, msg); } void warn(string_view_t msg) noexcept { log(level::warn, msg); } void error(string_view_t msg) noexcept { log(level::err, msg); } void critical(string_view_t msg) noexcept { log(level::critical, msg); } // return true if logging is enabled for the given level. [[nodiscard]] bool should_log(level msg_level) const noexcept { return msg_level >= level_.load(std::memory_order_relaxed); } // return true if the given message should be flushed [[nodiscard]] bool should_flush(const details::log_msg &msg) const noexcept { return (msg.log_level >= flush_level_.load(std::memory_order_relaxed)) && (msg.log_level != level::off); } // set the level of logging void set_level(level level); // return the active log level [[nodiscard]] level log_level() const noexcept; // return the name of the logger [[nodiscard]] const std::string &name() const noexcept; // set formatting for the sinks in this logger. // each sink will get a separate instance of the formatter object. void set_formatter(std::unique_ptr f); // set formatting for the sinks in this logger. // equivalent to // set_formatter(make_unique(pattern, time_type)) // Note: each sink will get a new instance of a formatter object, replacing the old one. void set_pattern(std::string pattern, pattern_time_type time_type = pattern_time_type::local); // flush functions void flush() noexcept; void flush_on(level level) noexcept; [[nodiscard]] level flush_level() const noexcept; // sinks [[nodiscard]] const std::vector &sinks() const noexcept; [[nodiscard]] std::vector &sinks() noexcept; // error handler. default is err_handler that prints the error to stderr. void set_error_handler(err_handler); // create new logger with same sinks and configuration. std::shared_ptr clone(std::string logger_name); private: std::string name_; std::vector sinks_; atomic_level_t level_{level::info}; atomic_level_t flush_level_{level::off}; details::err_helper err_helper_; // common implementation for after templated public api has been resolved to format string and // args template void log_with_format_(const source_loc &loc, const level lvl, const format_string_t &format_string, Args &&...args) noexcept { assert(should_log(lvl)); try { memory_buf_t buf; fmt::vformat_to(std::back_inserter(buf), format_string, fmt::make_format_args(args...)); sink_it_(details::log_msg(loc, name_, lvl, string_view_t(buf.data(), buf.size()))); } catch (const std::exception &ex) { err_helper_.handle_ex(name_, loc, ex); } catch (...) { err_helper_.handle_unknown_ex(name_, loc); } } // log the given message (if the given log level is high enough) void sink_it_(const details::log_msg &msg) noexcept { assert(should_log(msg.log_level)); for (auto &sink : sinks_) { if (sink->should_log(msg.log_level)) { try { sink->log(msg); } catch (const std::exception &ex) { err_helper_.handle_ex(name_, msg.source, ex); } catch (...) { err_helper_.handle_unknown_ex(name_, msg.source); } } } if (should_flush(msg)) { flush_(); } } void flush_() noexcept; }; } // namespace spdlog