spdlog.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352
  1. // Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
  2. // Distributed under the MIT License (http://opensource.org/licenses/MIT)
  3. // spdlog main header file.
  4. // see example.cpp for usage example
  5. #ifndef SPDLOG_H
  6. #define SPDLOG_H
  7. #pragma once
  8. #include <spdlog/common.h>
  9. #include <spdlog/details/registry.h>
  10. #include <spdlog/details/synchronous_factory.h>
  11. #include <spdlog/logger.h>
  12. #include <spdlog/version.h>
  13. #include <chrono>
  14. #include <functional>
  15. #include <memory>
  16. #include <string>
  17. namespace spdlog {
  18. using default_factory = synchronous_factory;
  19. // Create and register a logger with a templated sink type
  20. // The logger's level, formatter and flush level will be set according the
  21. // global settings.
  22. //
  23. // Example:
  24. // spdlog::create<daily_file_sink_st>("logger_name", "dailylog_filename", 11, 59);
  25. template <typename Sink, typename... SinkArgs>
  26. inline std::shared_ptr<spdlog::logger> create(std::string logger_name, SinkArgs &&...sink_args) {
  27. return default_factory::create<Sink>(std::move(logger_name),
  28. std::forward<SinkArgs>(sink_args)...);
  29. }
  30. // Initialize and register a logger,
  31. // formatter and flush level will be set according the global settings.
  32. //
  33. // Useful for initializing manually created loggers with the global settings.
  34. //
  35. // Example:
  36. // auto mylogger = std::make_shared<spdlog::logger>("mylogger", ...);
  37. // spdlog::initialize_logger(mylogger);
  38. SPDLOG_API void initialize_logger(std::shared_ptr<logger> logger);
  39. // Return an existing logger or nullptr if a logger with such name doesn't
  40. // exist.
  41. // example: spdlog::get("my_logger")->info("hello {}", "world");
  42. SPDLOG_API std::shared_ptr<logger> get(const std::string &name);
  43. // Set global formatter. Each sink in each logger will get a clone of this object
  44. SPDLOG_API void set_formatter(std::unique_ptr<spdlog::formatter> formatter);
  45. // Set global format string.
  46. // example: spdlog::set_pattern("%Y-%m-%d %H:%M:%S.%e %l : %v");
  47. SPDLOG_API void set_pattern(std::string pattern,
  48. pattern_time_type time_type = pattern_time_type::local);
  49. // enable global backtrace support
  50. SPDLOG_API void enable_backtrace(size_t n_messages);
  51. // disable global backtrace support
  52. SPDLOG_API void disable_backtrace();
  53. // call dump backtrace on default logger
  54. SPDLOG_API void dump_backtrace();
  55. // Get global logging level
  56. SPDLOG_API level::level_enum get_level();
  57. // Set global logging level
  58. SPDLOG_API void set_level(level::level_enum log_level);
  59. // Determine whether the default logger should log messages with a certain level
  60. SPDLOG_API bool should_log(level::level_enum lvl);
  61. // Set global flush level
  62. SPDLOG_API void flush_on(level::level_enum log_level);
  63. // Start/Restart a periodic flusher thread
  64. // Warning: Use only if all your loggers are thread safe!
  65. template <typename Rep, typename Period>
  66. inline void flush_every(std::chrono::duration<Rep, Period> interval) {
  67. details::registry::instance().flush_every(interval);
  68. }
  69. // Set global error handler
  70. SPDLOG_API void set_error_handler(void (*handler)(const std::string &msg));
  71. // Register the given logger with the given name
  72. SPDLOG_API void register_logger(std::shared_ptr<logger> logger);
  73. // Apply a user defined function on all registered loggers
  74. // Example:
  75. // spdlog::apply_all([&](std::shared_ptr<spdlog::logger> l) {l->flush();});
  76. SPDLOG_API void apply_all(const std::function<void(std::shared_ptr<logger>)> &fun);
  77. // Drop the reference to the given logger
  78. SPDLOG_API void drop(const std::string &name);
  79. // Drop all references from the registry
  80. SPDLOG_API void drop_all();
  81. // stop any running threads started by spdlog and clean registry loggers
  82. SPDLOG_API void shutdown();
  83. // Automatic registration of loggers when using spdlog::create() or spdlog::create_async
  84. SPDLOG_API void set_automatic_registration(bool automatic_registration);
  85. // API for using default logger (stdout_color_mt),
  86. // e.g: spdlog::info("Message {}", 1);
  87. //
  88. // The default logger object can be accessed using the spdlog::default_logger():
  89. // For example, to add another sink to it:
  90. // spdlog::default_logger()->sinks().push_back(some_sink);
  91. //
  92. // The default logger can replaced using spdlog::set_default_logger(new_logger).
  93. // For example, to replace it with a file logger.
  94. //
  95. // IMPORTANT:
  96. // The default API is thread safe (for _mt loggers), but:
  97. // set_default_logger() *should not* be used concurrently with the default API.
  98. // e.g do not call set_default_logger() from one thread while calling spdlog::info() from another.
  99. SPDLOG_API std::shared_ptr<spdlog::logger> default_logger();
  100. SPDLOG_API spdlog::logger *default_logger_raw();
  101. SPDLOG_API void set_default_logger(std::shared_ptr<spdlog::logger> default_logger);
  102. // Initialize logger level based on environment configs.
  103. //
  104. // Useful for applying SPDLOG_LEVEL to manually created loggers.
  105. //
  106. // Example:
  107. // auto mylogger = std::make_shared<spdlog::logger>("mylogger", ...);
  108. // spdlog::apply_logger_env_levels(mylogger);
  109. SPDLOG_API void apply_logger_env_levels(std::shared_ptr<logger> logger);
  110. template <typename... Args>
  111. inline void log(source_loc source,
  112. level::level_enum lvl,
  113. format_string_t<Args...> fmt,
  114. Args &&...args) {
  115. default_logger_raw()->log(source, lvl, fmt, std::forward<Args>(args)...);
  116. }
  117. template <typename... Args>
  118. inline void log(level::level_enum lvl, format_string_t<Args...> fmt, Args &&...args) {
  119. default_logger_raw()->log(source_loc{}, lvl, fmt, std::forward<Args>(args)...);
  120. }
  121. template <typename... Args>
  122. inline void trace(format_string_t<Args...> fmt, Args &&...args) {
  123. default_logger_raw()->trace(fmt, std::forward<Args>(args)...);
  124. }
  125. template <typename... Args>
  126. inline void debug(format_string_t<Args...> fmt, Args &&...args) {
  127. default_logger_raw()->debug(fmt, std::forward<Args>(args)...);
  128. }
  129. template <typename... Args>
  130. inline void info(format_string_t<Args...> fmt, Args &&...args) {
  131. default_logger_raw()->info(fmt, std::forward<Args>(args)...);
  132. }
  133. template <typename... Args>
  134. inline void warn(format_string_t<Args...> fmt, Args &&...args) {
  135. default_logger_raw()->warn(fmt, std::forward<Args>(args)...);
  136. }
  137. template <typename... Args>
  138. inline void error(format_string_t<Args...> fmt, Args &&...args) {
  139. default_logger_raw()->error(fmt, std::forward<Args>(args)...);
  140. }
  141. template <typename... Args>
  142. inline void critical(format_string_t<Args...> fmt, Args &&...args) {
  143. default_logger_raw()->critical(fmt, std::forward<Args>(args)...);
  144. }
  145. template <typename T>
  146. inline void log(source_loc source, level::level_enum lvl, const T &msg) {
  147. default_logger_raw()->log(source, lvl, msg);
  148. }
  149. template <typename T>
  150. inline void log(level::level_enum lvl, const T &msg) {
  151. default_logger_raw()->log(lvl, msg);
  152. }
  153. #ifdef SPDLOG_WCHAR_TO_UTF8_SUPPORT
  154. template <typename... Args>
  155. inline void log(source_loc source,
  156. level::level_enum lvl,
  157. wformat_string_t<Args...> fmt,
  158. Args &&...args) {
  159. default_logger_raw()->log(source, lvl, fmt, std::forward<Args>(args)...);
  160. }
  161. template <typename... Args>
  162. inline void log(level::level_enum lvl, wformat_string_t<Args...> fmt, Args &&...args) {
  163. default_logger_raw()->log(source_loc{}, lvl, fmt, std::forward<Args>(args)...);
  164. }
  165. template <typename... Args>
  166. inline void trace(wformat_string_t<Args...> fmt, Args &&...args) {
  167. default_logger_raw()->trace(fmt, std::forward<Args>(args)...);
  168. }
  169. template <typename... Args>
  170. inline void debug(wformat_string_t<Args...> fmt, Args &&...args) {
  171. default_logger_raw()->debug(fmt, std::forward<Args>(args)...);
  172. }
  173. template <typename... Args>
  174. inline void info(wformat_string_t<Args...> fmt, Args &&...args) {
  175. default_logger_raw()->info(fmt, std::forward<Args>(args)...);
  176. }
  177. template <typename... Args>
  178. inline void warn(wformat_string_t<Args...> fmt, Args &&...args) {
  179. default_logger_raw()->warn(fmt, std::forward<Args>(args)...);
  180. }
  181. template <typename... Args>
  182. inline void error(wformat_string_t<Args...> fmt, Args &&...args) {
  183. default_logger_raw()->error(fmt, std::forward<Args>(args)...);
  184. }
  185. template <typename... Args>
  186. inline void critical(wformat_string_t<Args...> fmt, Args &&...args) {
  187. default_logger_raw()->critical(fmt, std::forward<Args>(args)...);
  188. }
  189. #endif
  190. template <typename T>
  191. inline void trace(const T &msg) {
  192. default_logger_raw()->trace(msg);
  193. }
  194. template <typename T>
  195. inline void debug(const T &msg) {
  196. default_logger_raw()->debug(msg);
  197. }
  198. template <typename T>
  199. inline void info(const T &msg) {
  200. default_logger_raw()->info(msg);
  201. }
  202. template <typename T>
  203. inline void warn(const T &msg) {
  204. default_logger_raw()->warn(msg);
  205. }
  206. template <typename T>
  207. inline void error(const T &msg) {
  208. default_logger_raw()->error(msg);
  209. }
  210. template <typename T>
  211. inline void critical(const T &msg) {
  212. default_logger_raw()->critical(msg);
  213. }
  214. } // namespace spdlog
  215. //
  216. // enable/disable log calls at compile time according to global level.
  217. //
  218. // define SPDLOG_ACTIVE_LEVEL to one of those (before including spdlog.h):
  219. // SPDLOG_LEVEL_TRACE,
  220. // SPDLOG_LEVEL_DEBUG,
  221. // SPDLOG_LEVEL_INFO,
  222. // SPDLOG_LEVEL_WARN,
  223. // SPDLOG_LEVEL_ERROR,
  224. // SPDLOG_LEVEL_CRITICAL,
  225. // SPDLOG_LEVEL_OFF
  226. //
  227. #ifndef SPDLOG_NO_SOURCE_LOC
  228. #define SPDLOG_LOGGER_CALL(logger, level, ...) \
  229. (logger)->log(spdlog::source_loc{__FILE__, __LINE__, SPDLOG_FUNCTION}, level, __VA_ARGS__)
  230. #else
  231. #define SPDLOG_LOGGER_CALL(logger, level, ...) \
  232. (logger)->log(spdlog::source_loc{}, level, __VA_ARGS__)
  233. #endif
  234. #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_TRACE
  235. #define SPDLOG_LOGGER_TRACE(logger, ...) \
  236. SPDLOG_LOGGER_CALL(logger, spdlog::level::trace, __VA_ARGS__)
  237. #define SPDLOG_TRACE(...) SPDLOG_LOGGER_TRACE(spdlog::default_logger_raw(), __VA_ARGS__)
  238. #else
  239. #define SPDLOG_LOGGER_TRACE(logger, ...) (void)0
  240. #define SPDLOG_TRACE(...) (void)0
  241. #endif
  242. #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_DEBUG
  243. #define SPDLOG_LOGGER_DEBUG(logger, ...) \
  244. SPDLOG_LOGGER_CALL(logger, spdlog::level::debug, __VA_ARGS__)
  245. #define SPDLOG_DEBUG(...) SPDLOG_LOGGER_DEBUG(spdlog::default_logger_raw(), __VA_ARGS__)
  246. #else
  247. #define SPDLOG_LOGGER_DEBUG(logger, ...) (void)0
  248. #define SPDLOG_DEBUG(...) (void)0
  249. #endif
  250. #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_INFO
  251. #define SPDLOG_LOGGER_INFO(logger, ...) \
  252. SPDLOG_LOGGER_CALL(logger, spdlog::level::info, __VA_ARGS__)
  253. #define SPDLOG_INFO(...) SPDLOG_LOGGER_INFO(spdlog::default_logger_raw(), __VA_ARGS__)
  254. #else
  255. #define SPDLOG_LOGGER_INFO(logger, ...) (void)0
  256. #define SPDLOG_INFO(...) (void)0
  257. #endif
  258. #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_WARN
  259. #define SPDLOG_LOGGER_WARN(logger, ...) \
  260. SPDLOG_LOGGER_CALL(logger, spdlog::level::warn, __VA_ARGS__)
  261. #define SPDLOG_WARN(...) SPDLOG_LOGGER_WARN(spdlog::default_logger_raw(), __VA_ARGS__)
  262. #else
  263. #define SPDLOG_LOGGER_WARN(logger, ...) (void)0
  264. #define SPDLOG_WARN(...) (void)0
  265. #endif
  266. #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_ERROR
  267. #define SPDLOG_LOGGER_ERROR(logger, ...) \
  268. SPDLOG_LOGGER_CALL(logger, spdlog::level::err, __VA_ARGS__)
  269. #define SPDLOG_ERROR(...) SPDLOG_LOGGER_ERROR(spdlog::default_logger_raw(), __VA_ARGS__)
  270. #else
  271. #define SPDLOG_LOGGER_ERROR(logger, ...) (void)0
  272. #define SPDLOG_ERROR(...) (void)0
  273. #endif
  274. #if SPDLOG_ACTIVE_LEVEL <= SPDLOG_LEVEL_CRITICAL
  275. #define SPDLOG_LOGGER_CRITICAL(logger, ...) \
  276. SPDLOG_LOGGER_CALL(logger, spdlog::level::critical, __VA_ARGS__)
  277. #define SPDLOG_CRITICAL(...) SPDLOG_LOGGER_CRITICAL(spdlog::default_logger_raw(), __VA_ARGS__)
  278. #else
  279. #define SPDLOG_LOGGER_CRITICAL(logger, ...) (void)0
  280. #define SPDLOG_CRITICAL(...) (void)0
  281. #endif
  282. #ifdef SPDLOG_HEADER_ONLY
  283. #include "spdlog-inl.h"
  284. #endif
  285. #endif // SPDLOG_H