2016-09-02 10:06:00 -04:00
|
|
|
//
|
2018-04-13 20:34:57 -04:00
|
|
|
// Copyright(c) 2015-2108 Gabi Melman.
|
2016-09-02 10:06:00 -04:00
|
|
|
// Distributed under the MIT License (http://opensource.org/licenses/MIT)
|
|
|
|
//
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2018-07-21 16:48:07 -04:00
|
|
|
// Thread safe logger (except for set_pattern(..), set_formatter(..) and
|
|
|
|
// set_error_handler())
|
2016-09-02 10:06:00 -04:00
|
|
|
// Has name, log level, vector of std::shared sink pointers and formatter
|
|
|
|
// Upon each log write the logger:
|
2018-06-23 18:32:39 -04:00
|
|
|
// 1. Checks if its log level is enough to log the message and if yes:
|
|
|
|
// 2. Call the underlying sinks to do the job.
|
2018-07-21 16:48:07 -04:00
|
|
|
// 3. Each sink use its own private copy of a formatter to format the message
|
|
|
|
// and send to its destination.
|
2018-06-23 18:32:39 -04:00
|
|
|
//
|
2018-07-21 16:48:07 -04:00
|
|
|
// The use of private formatter per sink provides the opportunity to cache some
|
|
|
|
// formatted data,
|
2018-06-23 18:32:39 -04:00
|
|
|
// and support customize format per each sink.
|
2016-09-02 10:06:00 -04:00
|
|
|
|
2018-04-28 18:31:09 -04:00
|
|
|
#include "spdlog/common.h"
|
|
|
|
#include "spdlog/formatter.h"
|
|
|
|
#include "spdlog/sinks/sink.h"
|
2016-09-02 10:06:00 -04:00
|
|
|
|
|
|
|
#include <memory>
|
|
|
|
#include <string>
|
2018-03-09 08:26:33 -05:00
|
|
|
#include <vector>
|
2016-09-02 10:06:00 -04:00
|
|
|
|
2018-03-09 08:26:33 -05:00
|
|
|
namespace spdlog {
|
2016-09-02 10:06:00 -04:00
|
|
|
|
|
|
|
class logger
|
|
|
|
{
|
|
|
|
public:
|
2018-07-19 07:54:26 -04:00
|
|
|
logger(std::string name, sink_ptr single_sink);
|
|
|
|
logger(std::string name, sinks_init_list sinks);
|
2018-02-25 06:39:37 -05:00
|
|
|
|
2018-07-14 09:21:53 -04:00
|
|
|
template<typename It>
|
2018-03-16 11:35:56 -04:00
|
|
|
logger(std::string name, const It &begin, const It &end);
|
2016-09-02 10:06:00 -04:00
|
|
|
|
|
|
|
virtual ~logger();
|
2018-02-24 19:58:09 -05:00
|
|
|
|
2018-03-09 08:26:33 -05:00
|
|
|
logger(const logger &) = delete;
|
|
|
|
logger &operator=(const logger &) = delete;
|
2016-09-02 10:06:00 -04:00
|
|
|
|
2018-03-16 11:35:56 -04:00
|
|
|
template<typename... Args>
|
|
|
|
void log(level::level_enum lvl, const char *fmt, const Args &... args);
|
|
|
|
|
|
|
|
template<typename... Args>
|
|
|
|
void log(level::level_enum lvl, const char *msg);
|
|
|
|
|
2018-07-07 09:40:29 -04:00
|
|
|
template<typename... Args>
|
2018-07-07 09:29:05 -04:00
|
|
|
void trace(const char *fmt, const Args &... args);
|
2018-03-16 11:35:56 -04:00
|
|
|
|
2018-07-07 09:40:29 -04:00
|
|
|
template<typename... Args>
|
2018-07-07 09:29:05 -04:00
|
|
|
void debug(const char *fmt, const Args &... args);
|
2018-03-16 11:35:56 -04:00
|
|
|
|
2018-07-07 09:40:29 -04:00
|
|
|
template<typename... Args>
|
2018-07-07 09:29:05 -04:00
|
|
|
void info(const char *fmt, const Args &... args);
|
2018-03-16 11:35:56 -04:00
|
|
|
|
2018-07-07 09:40:29 -04:00
|
|
|
template<typename... Args>
|
2018-07-07 09:29:05 -04:00
|
|
|
void warn(const char *fmt, const Args &... args);
|
2018-03-16 11:35:56 -04:00
|
|
|
|
2018-07-07 09:40:29 -04:00
|
|
|
template<typename... Args>
|
2018-07-07 09:29:05 -04:00
|
|
|
void error(const char *fmt, const Args &... args);
|
2018-03-16 11:35:56 -04:00
|
|
|
|
2018-07-07 09:40:29 -04:00
|
|
|
template<typename... Args>
|
2018-07-07 09:29:05 -04:00
|
|
|
void critical(const char *fmt, const Args &... args);
|
2017-06-29 03:51:44 -04:00
|
|
|
|
2018-07-10 16:53:00 -04:00
|
|
|
#ifdef SPDLOG_WCHAR_TO_UTF8_SUPPORT
|
2018-03-16 11:35:56 -04:00
|
|
|
template<typename... Args>
|
|
|
|
void log(level::level_enum lvl, const wchar_t *fmt, const Args &... args);
|
|
|
|
|
|
|
|
template<typename... Args>
|
|
|
|
void trace(const wchar_t *fmt, const Args &... args);
|
|
|
|
|
|
|
|
template<typename... Args>
|
|
|
|
void debug(const wchar_t *fmt, const Args &... args);
|
|
|
|
|
|
|
|
template<typename... Args>
|
|
|
|
void info(const wchar_t *fmt, const Args &... args);
|
|
|
|
|
|
|
|
template<typename... Args>
|
|
|
|
void warn(const wchar_t *fmt, const Args &... args);
|
|
|
|
|
|
|
|
template<typename... Args>
|
|
|
|
void error(const wchar_t *fmt, const Args &... args);
|
|
|
|
|
|
|
|
template<typename... Args>
|
|
|
|
void critical(const wchar_t *fmt, const Args &... args);
|
2017-04-01 11:37:16 -04:00
|
|
|
#endif // SPDLOG_WCHAR_TO_UTF8_SUPPORT
|
2018-03-17 06:49:45 -04:00
|
|
|
|
2018-03-16 11:35:56 -04:00
|
|
|
template<typename T>
|
|
|
|
void log(level::level_enum lvl, const T &);
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
void trace(const T &msg);
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
void debug(const T &msg);
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
void info(const T &msg);
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
void warn(const T &msg);
|
|
|
|
|
|
|
|
template<typename T>
|
|
|
|
void error(const T &msg);
|
2016-09-02 10:06:00 -04:00
|
|
|
|
2018-03-16 11:35:56 -04:00
|
|
|
template<typename T>
|
|
|
|
void critical(const T &msg);
|
2018-02-25 06:39:37 -05:00
|
|
|
|
|
|
|
bool should_log(level::level_enum msg_level) const;
|
|
|
|
void set_level(level::level_enum log_level);
|
2016-09-02 10:06:00 -04:00
|
|
|
level::level_enum level() const;
|
2018-03-09 08:26:33 -05:00
|
|
|
const std::string &name() const;
|
2018-07-22 14:52:46 -04:00
|
|
|
|
|
|
|
// 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<formatter> formatter);
|
|
|
|
void set_pattern(std::string pattern, pattern_time_type time_type = pattern_time_type::local);
|
|
|
|
|
2018-04-13 20:34:57 -04:00
|
|
|
void flush();
|
2016-09-02 10:06:00 -04:00
|
|
|
void flush_on(level::level_enum log_level);
|
|
|
|
|
2018-03-09 08:26:33 -05:00
|
|
|
const std::vector<sink_ptr> &sinks() const;
|
2016-09-24 15:14:05 -04:00
|
|
|
|
2018-07-21 16:48:07 -04:00
|
|
|
std::vector<sink_ptr> &sinks();
|
2018-07-22 14:52:46 -04:00
|
|
|
|
2018-04-13 20:34:57 -04:00
|
|
|
void set_error_handler(log_err_handler err_handler);
|
|
|
|
log_err_handler error_handler();
|
2017-03-27 18:54:33 -04:00
|
|
|
|
2016-09-02 10:06:00 -04:00
|
|
|
protected:
|
2018-06-10 15:59:17 -04:00
|
|
|
virtual void sink_it_(details::log_msg &msg);
|
|
|
|
virtual void flush_();
|
2016-09-02 10:06:00 -04:00
|
|
|
|
2018-06-10 15:59:17 -04:00
|
|
|
bool should_flush_(const details::log_msg &msg);
|
2016-09-02 10:06:00 -04:00
|
|
|
|
2018-07-21 16:48:07 -04:00
|
|
|
// default error handler: print the error to stderr with the max rate of 1
|
|
|
|
// message/minute
|
2018-06-10 15:59:17 -04:00
|
|
|
void default_err_handler_(const std::string &msg);
|
2016-09-02 10:06:00 -04:00
|
|
|
|
2018-07-21 16:48:07 -04:00
|
|
|
// increment the message count (only if
|
|
|
|
// defined(SPDLOG_ENABLE_MESSAGE_COUNTER))
|
2018-06-10 15:59:17 -04:00
|
|
|
void incr_msg_counter_(details::log_msg &msg);
|
|
|
|
|
|
|
|
const std::string name_;
|
|
|
|
std::vector<sink_ptr> sinks_;
|
|
|
|
spdlog::level_t level_;
|
|
|
|
spdlog::level_t flush_level_;
|
|
|
|
log_err_handler err_handler_;
|
|
|
|
std::atomic<time_t> last_err_time_;
|
|
|
|
std::atomic<size_t> msg_counter_;
|
2018-07-10 10:01:49 -04:00
|
|
|
|
|
|
|
#ifdef SPDLOG_WCHAR_TO_UTF8_SUPPORT
|
2018-07-10 16:53:00 -04:00
|
|
|
std::wstring_convert<std::codecvt_utf8<wchar_t>> wstring_converter_;
|
|
|
|
std::mutex wstring_converter_mutex_;
|
2018-07-10 10:01:49 -04:00
|
|
|
#endif
|
2016-09-02 10:06:00 -04:00
|
|
|
};
|
2018-03-09 08:26:33 -05:00
|
|
|
} // namespace spdlog
|
2016-09-02 10:06:00 -04:00
|
|
|
|
2017-11-11 07:44:27 -05:00
|
|
|
#include "details/logger_impl.h"
|