include/spdlog/spdlog.h

0001 // Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
0002 // Distributed under the MIT License (http://opensource.org/licenses/MIT)
0003
0004 // spdlog main header file.
0005 // see example.cpp for usage example
0006
0007 #ifndef SPDLOG_H
0008 #define SPDLOG_H
0009
0010 #pragma once
0011
0012 #include <spdlog/common.h>
0013 #include <spdlog/details/registry.h>
0014 #include <spdlog/details/synchronous_factory.h>
0015 #include <spdlog/logger.h>
0016 #include <spdlog/version.h>
0017
0018 #include <chrono>
0019 #include <functional>
0020 #include <memory>
0021 #include <string>
0022
0023 namespace spdlog {
0024
0025 using default_factory = synchronous_factory;
0026
0027 // Create and register a logger with a templated sink type
0028 // The logger's level, formatter and flush level will be set according the
0029 // global settings.
0030 //
0031 // Example:
0032 //   spdlog::create<daily_file_sink_st>("logger_name", "dailylog_filename", 11, 59);
0033 template <typename Sink, typename... SinkArgs>
0034 inline std::shared_ptr<spdlog::logger> create(std::string logger_name, SinkArgs &&...sink_args) {
0035     return default_factory::create<Sink>(std::move(logger_name),
0036                                          std::forward<SinkArgs>(sink_args)...);
0037 }
0038
0039 // Initialize and register a logger,
0040 // formatter and flush level will be set according the global settings.
0041 //
0042 // Useful for initializing manually created loggers with the global settings.
0043 //
0044 // Example:
0045 //   auto mylogger = std::make_shared<spdlog::logger>("mylogger", ...);
0046 //   spdlog::initialize_logger(mylogger);
0047 SPDLOG_API void initialize_logger(std::shared_ptr<logger> logger);
0048
0049 // Return an existing logger or nullptr if a logger with such name doesn't
0050 // exist.
0051 // example: spdlog::get("my_logger")->info("hello {}", "world");
0052 SPDLOG_API std::shared_ptr<logger> get(const std::string &name);
0053
0054 // Set global formatter. Each sink in each logger will get a clone of this object
0055 SPDLOG_API void set_formatter(std::unique_ptr<spdlog::formatter> formatter);
0056
0057 // Set global format string.
0058 // example: spdlog::set_pattern("%Y-%m-%d %H:%M:%S.%e %l : %v");
0059 SPDLOG_API void set_pattern(std::string pattern,
0060                             pattern_time_type time_type = pattern_time_type::local);
0061
0062 // enable global backtrace support
0063 SPDLOG_API void enable_backtrace(size_t n_messages);
0064
0065 // disable global backtrace support
0066 SPDLOG_API void disable_backtrace();
0067
0068 // call dump backtrace on default logger
0069 SPDLOG_API void dump_backtrace();
0070
0071 // Get global logging level
0072 SPDLOG_API level::level_enum get_level();
0073
0074 // Set global logging level
0075 SPDLOG_API void set_level(level::level_enum log_level);
0076
0077 // Determine whether the default logger should log messages with a certain level
0078 SPDLOG_API bool should_log(level::level_enum lvl);
0079
0080 // Set global flush level
0081 SPDLOG_API void flush_on(level::level_enum log_level);
0082
0083 // Start/Restart a periodic flusher thread
0084 // Warning: Use only if all your loggers are thread safe!
0085 template <typename Rep, typename Period>
0086 inline void flush_every(std::chrono::duration<Rep, Period> interval) {
0087     details::registry::instance().flush_every(interval);
0088 }
0089
0090 // Set global error handler
0091 SPDLOG_API void set_error_handler(void (*handler)(const std::string &msg));
0092
0093 // Register the given logger with the given name
0094 SPDLOG_API void register_logger(std::shared_ptr<logger> logger);
0095
0096 // Apply a user defined function on all registered loggers
0097 // Example:
0098 // spdlog::apply_all([&](std::shared_ptr<spdlog::logger> l) {l->flush();});
0099 SPDLOG_API void apply_all(const std::function<void(std::shared_ptr<logger>)> &fun);
0100
0101 // Drop the reference to the given logger
0102 SPDLOG_API void drop(const std::string &name);
0103
0104 // Drop all references from the registry
0105 SPDLOG_API void drop_all();
0106
0107 // stop any running threads started by spdlog and clean registry loggers
0108 SPDLOG_API void shutdown();
0109
0110 // Automatic registration of loggers when using spdlog::create() or spdlog::create_async
0111 SPDLOG_API void set_automatic_registration(bool automatic_registration);
0112
0113 // API for using default logger (stdout_color_mt),
0114 // e.g: spdlog::info("Message {}", 1);
0115 //
0116 // The default logger object can be accessed using the spdlog::default_logger():
0117 // For example, to add another sink to it:
0118 // spdlog::default_logger()->sinks().push_back(some_sink);
0119 //
0120 // The default logger can replaced using spdlog::set_default_logger(new_logger).
0121 // For example, to replace it with a file logger.
0122 //
0123 // IMPORTANT:
0124 // The default API is thread safe (for _mt loggers), but:
0125 // set_default_logger() *should not* be used concurrently with the default API.
0126 // e.g do not call set_default_logger() from one thread while calling spdlog::info() from another.
0127
0128 SPDLOG_API std::shared_ptr<spdlog::logger> default_logger();
0129
0130 SPDLOG_API spdlog::logger *default_logger_raw();
0131
0132 SPDLOG_API void set_default_logger(std::shared_ptr<spdlog::logger> default_logger);
0133
0134 // Initialize logger level based on environment configs.
0135 //
0136 // Useful for applying SPDLOG_LEVEL to manually created loggers.
0137 //
0138 // Example:
0139 //   auto mylogger = std::make_shared<spdlog::logger>("mylogger", ...);
0140 //   spdlog::apply_logger_env_levels(mylogger);
0141 SPDLOG_API void apply_logger_env_levels(std::shared_ptr<logger> logger);
0142
0143 template <typename... Args>
0144 inline void log(source_loc source,
0145                 level::level_enum lvl,
0146                 format_string_t<Args...> fmt,
0147                 Args &&...args) {
0148     default_logger_raw()->log(source, lvl, fmt, std::forward<Args>(args)...);
0149 }
0150
0151 template <typename... Args>
0152 inline void log(level::level_enum lvl, format_string_t<Args...> fmt, Args &&...args) {
0153     default_logger_raw()->log(source_loc{}, lvl, fmt, std::forward<Args>(args)...);
0154 }
0155
0156 template <typename... Args>
0157 inline void trace(format_string_t<Args...> fmt, Args &&...args) {
0158     default_logger_raw()->trace(fmt, std::forward<Args>(args)...);
0159 }
0160
0161 template <typename... Args>
0162 inline void debug(format_string_t<Args...> fmt, Args &&...args) {
0163     default_logger_raw()->debug(fmt, std::forward<Args>(args)...);
0164 }
0165
0166 template <typename... Args>
0167 inline void info(format_string_t<Args...> fmt, Args &&...args) {
0168     default_logger_raw()->info(fmt, std::forward<Args>(args)...);
0169 }
0170
0171 template <typename... Args>
0172 inline void warn(format_string_t<Args...> fmt, Args &&...args) {
0173     default_logger_raw()->warn(fmt, std::forward<Args>(args)...);
0174 }
0175
0176 template <typename... Args>
0177 inline void error(format_string_t<Args...> fmt, Args &&...args) {
0178     default_logger_raw()->error(fmt, std::forward<Args>(args)...);
0179 }
0180
0181 template <typename... Args>
0182 inline void critical(format_string_t<Args...> fmt, Args &&...args) {
0183     default_logger_raw()->critical(fmt, std::forward<Args>(args)...);
0184 }
0185
0186 template <typename T>
0187 inline void log(source_loc source, level::level_enum lvl, const T &msg) {
0188     default_logger_raw()->log(source, lvl, msg);
0189 }
0190
0191 template <typename T>
0192 inline void log(level::level_enum lvl, const T &msg) {
0193     default_logger_raw()->log(lvl, msg);
0194 }
0195
0196 #ifdef SPDLOG_WCHAR_TO_UTF8_SUPPORT
0197 template <typename... Args>
0198 inline void log(source_loc source,
0199                 level::level_enum lvl,
0200                 wformat_string_t<Args...> fmt,
0201                 Args &&...args) {
0202     default_logger_raw()->log(source, lvl, fmt, std::forward<Args>(args)...);
0203 }
0204
0205 template <typename... Args>
0206 inline void log(level::level_enum lvl, wformat_string_t<Args...> fmt, Args &&...args) {
0207     default_logger_raw()->log(source_loc{}, lvl, fmt, std::forward<Args>(args)...);
0208 }
0209
0210 template <typename... Args>
0211 inline void trace(wformat_string_t<Args...> fmt, Args &&...args) {
0212     default_logger_raw()->trace(fmt, std::forward<Args>(args)...);
0213 }
0214
0215 template <typename... Args>
0216 inline void debug(wformat_string_t<Args...> fmt, Args &&...args) {
0217     default_logger_raw()->debug(fmt, std::forward<Args>(args)...);
0218 }
0219
0220 template <typename... Args>
0221 inline void info(wformat_string_t<Args...> fmt, Args &&...args) {
0222     default_logger_raw()->info(fmt, std::forward<Args>(args)...);
0223 }
0224
0225 template <typename... Args>
0226 inline void warn(wformat_string_t<Args...> fmt, Args &&...args) {
0227     default_logger_raw()->warn(fmt, std::forward<Args>(args)...);
0228 }
0229
0230 template <typename... Args>
0231 inline void error(wformat_string_t<Args...> fmt, Args &&...args) {
0232     default_logger_raw()->error(fmt, std::forward<Args>(args)...);
0233 }
0234
0235 template <typename... Args>
0236 inline void critical(wformat_string_t<Args...> fmt, Args &&...args) {
0237     default_logger_raw()->critical(fmt, std::forward<Args>(args)...);
0238 }
0239 #endif
0240
0241 template <typename T>
0242 inline void trace(const T &msg) {
0243     default_logger_raw()->trace(msg);
0244 }
0245
0246 template <typename T>
0247 inline void debug(const T &msg) {
0248     default_logger_raw()->debug(msg);
0249 }
0250
0251 template <typename T>
0252 inline void info(const T &msg) {
0253     default_logger_raw()->info(msg);
0254 }
0255
0256 template <typename T>
0257 inline void warn(const T &msg) {
0258     default_logger_raw()->warn(msg);
0259 }
0260
0261 template <typename T>
0262 inline void error(const T &msg) {
0263     default_logger_raw()->error(msg);
0264 }
0265
0266 template <typename T>
0267 inline void critical(const T &msg) {
0268     default_logger_raw()->critical(msg);
0269 }
0270
0271 }  // namespace spdlog
0272
0273 //
0274 // enable/disable log calls at compile time according to global level.
0275 //
0276 // define SPDLOG_ACTIVE_LEVEL to one of those (before including spdlog.h):
0277 // SPDLOG_LEVEL_TRACE,
0278 // SPDLOG_LEVEL_DEBUG,
0279 // SPDLOG_LEVEL_INFO,
0280 // SPDLOG_LEVEL_WARN,
0281 // SPDLOG_LEVEL_ERROR,
0282 // SPDLOG_LEVEL_CRITICAL,
0283 // SPDLOG_LEVEL_OFF
0284 //
0285
0286 #ifndef SPDLOG_NO_SOURCE_LOC
0287     #define SPDLOG_LOGGER_CALL(logger, level, ...) \
0288         (logger)->log(spdlog::source_loc{__FILE__, __LINE__, SPDLOG_FUNCTION}, level, __VA_ARGS__)
0289 #else
0290     #define SPDLOG_LOGGER_CALL(logger, level, ...) \
0291         (logger)->log(spdlog::source_loc{}, level, __VA_ARGS__)
0292 #endif
0293
0294 #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_TRACE
0295     #define SPDLOG_LOGGER_TRACE(logger, ...) \
0296         SPDLOG_LOGGER_CALL(logger, spdlog::level::trace, __VA_ARGS__)
0297     #define SPDLOG_TRACE(...) SPDLOG_LOGGER_TRACE(spdlog::default_logger_raw(), __VA_ARGS__)
0298 #else
0299     #define SPDLOG_LOGGER_TRACE(logger, ...) (void)0
0300     #define SPDLOG_TRACE(...) (void)0
0301 #endif
0302
0303 #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_DEBUG
0304     #define SPDLOG_LOGGER_DEBUG(logger, ...) \
0305         SPDLOG_LOGGER_CALL(logger, spdlog::level::debug, __VA_ARGS__)
0306     #define SPDLOG_DEBUG(...) SPDLOG_LOGGER_DEBUG(spdlog::default_logger_raw(), __VA_ARGS__)
0307 #else
0308     #define SPDLOG_LOGGER_DEBUG(logger, ...) (void)0
0309     #define SPDLOG_DEBUG(...) (void)0
0310 #endif
0311
0312 #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_INFO
0313     #define SPDLOG_LOGGER_INFO(logger, ...) \
0314         SPDLOG_LOGGER_CALL(logger, spdlog::level::info, __VA_ARGS__)
0315     #define SPDLOG_INFO(...) SPDLOG_LOGGER_INFO(spdlog::default_logger_raw(), __VA_ARGS__)
0316 #else
0317     #define SPDLOG_LOGGER_INFO(logger, ...) (void)0
0318     #define SPDLOG_INFO(...) (void)0
0319 #endif
0320
0321 #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_WARN
0322     #define SPDLOG_LOGGER_WARN(logger, ...) \
0323         SPDLOG_LOGGER_CALL(logger, spdlog::level::warn, __VA_ARGS__)
0324     #define SPDLOG_WARN(...) SPDLOG_LOGGER_WARN(spdlog::default_logger_raw(), __VA_ARGS__)
0325 #else
0326     #define SPDLOG_LOGGER_WARN(logger, ...) (void)0
0327     #define SPDLOG_WARN(...) (void)0
0328 #endif
0329
0330 #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_ERROR
0331     #define SPDLOG_LOGGER_ERROR(logger, ...) \
0332         SPDLOG_LOGGER_CALL(logger, spdlog::level::err, __VA_ARGS__)
0333     #define SPDLOG_ERROR(...) SPDLOG_LOGGER_ERROR(spdlog::default_logger_raw(), __VA_ARGS__)
0334 #else
0335     #define SPDLOG_LOGGER_ERROR(logger, ...) (void)0
0336     #define SPDLOG_ERROR(...) (void)0
0337 #endif
0338
0339 #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_CRITICAL
0340     #define SPDLOG_LOGGER_CRITICAL(logger, ...) \
0341         SPDLOG_LOGGER_CALL(logger, spdlog::level::critical, __VA_ARGS__)
0342     #define SPDLOG_CRITICAL(...) SPDLOG_LOGGER_CRITICAL(spdlog::default_logger_raw(), __VA_ARGS__)
0343 #else
0344     #define SPDLOG_LOGGER_CRITICAL(logger, ...) (void)0
0345     #define SPDLOG_CRITICAL(...) (void)0
0346 #endif
0347
0348 #ifdef SPDLOG_HEADER_ONLY
0349     #include "spdlog-inl.h"
0350 #endif
0351
0352 #endif  // SPDLOG_H