// Copyright(c) 2015-present, Gabi Melman & spdlog contributors. // Distributed under the MIT License (http://opensource.org/licenses/MIT) #pragma once #include #include #include #include #include #include #include #include #include #include #include #include "details/null_mutex.h" #include "source_loc.h" #include "tweakme.h" #if __has_include() #include #endif #ifdef SPDLOG_USE_STD_FORMAT #include #endif #if defined(SPDLOG_SHARED_LIB) #if defined(_WIN32) #ifdef spdlog_EXPORTS #define SPDLOG_API __declspec(dllexport) #else // !spdlog_EXPORTS #define SPDLOG_API __declspec(dllimport) #endif #else // !defined(_WIN32) #define SPDLOG_API __attribute__((visibility("default"))) #endif #else // !defined(SPDLOG_SHARED_LIB) #define SPDLOG_API #endif #include "fmt/fmt.h" #if defined(SPDLOG_WCHAR_FILENAMES) && !defined(SPDLOG_USE_STD_FORMAT) #include "fmt/xchar.h" #endif #ifndef SPDLOG_FUNCTION #define SPDLOG_FUNCTION static_cast(__FUNCTION__) #endif #ifdef SPDLOG_NO_EXCEPTIONS #define SPDLOG_TRY #define SPDLOG_THROW(ex) \ do { \ printf("spdlog fatal error: %s\n", ex.what()); \ std::abort(); \ } while (0) #define SPDLOG_CATCH_STD #else #define SPDLOG_TRY try #define SPDLOG_THROW(ex) throw(ex) #define SPDLOG_CATCH_STD \ catch (const std::exception &) { \ } #endif namespace spdlog { class formatter; namespace sinks { class sink; } #if defined(_WIN32) && defined(SPDLOG_WCHAR_FILENAMES) using filename_t = std::wstring; // allow macro expansion to occur in SPDLOG_FILENAME_T #define SPDLOG_FILENAME_T_INNER(s) L##s #define SPDLOG_FILENAME_T(s) SPDLOG_FILENAME_T_INNER(s) #else using filename_t = std::string; #define SPDLOG_FILENAME_T(s) s #endif using log_clock = std::chrono::system_clock; using sink_ptr = std::shared_ptr; using sinks_init_list = std::initializer_list; using err_handler = std::function; #ifdef SPDLOG_USE_STD_FORMAT namespace fmt_lib = std; using string_view_t = std::string_view; using memory_buf_t = std::string; using wstring_view_t = std::wstring_view; using wmemory_buf_t = std::wstring; template #if __cpp_lib_format >= 202207L using format_string_t = std::format_string; #else using format_string_t = std::string_view; #endif #define SPDLOG_BUF_TO_STRING(x) x #else // use fmt lib instead of std::format namespace fmt_lib = fmt; using string_view_t = fmt::basic_string_view; using memory_buf_t = fmt::basic_memory_buffer; template using format_string_t = fmt::format_string; using wstring_view_t = fmt::basic_string_view; using wmemory_buf_t = fmt::basic_memory_buffer; #define SPDLOG_BUF_TO_STRING(x) fmt::to_string(x) #endif // SPDLOG_USE_STD_FORMAT #define SPDLOG_LEVEL_TRACE 0 #define SPDLOG_LEVEL_DEBUG 1 #define SPDLOG_LEVEL_INFO 2 #define SPDLOG_LEVEL_WARN 3 #define SPDLOG_LEVEL_ERROR 4 #define SPDLOG_LEVEL_CRITICAL 5 #define SPDLOG_LEVEL_OFF 6 #if !defined(SPDLOG_ACTIVE_LEVEL) #define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_INFO #endif // Is convertable to string_view_t ? template using is_convertible_to_sv = std::enable_if_t>; // Log level enum enum class level { trace = SPDLOG_LEVEL_TRACE, debug = SPDLOG_LEVEL_DEBUG, info = SPDLOG_LEVEL_INFO, warn = SPDLOG_LEVEL_WARN, err = SPDLOG_LEVEL_ERROR, critical = SPDLOG_LEVEL_CRITICAL, off = SPDLOG_LEVEL_OFF, n_levels }; #if defined(SPDLOG_NO_ATOMIC_LEVELS) using atomic_level_t = details::null_atomic; #else using atomic_level_t = std::atomic; #endif #if !defined(SPDLOG_LEVEL_NAMES) #define SPDLOG_LEVEL_NAMES \ { "trace", "debug", "info", "warning", "error", "critical", "off" } #endif #if !defined(SPDLOG_SHORT_LEVEL_NAMES) #define SPDLOG_SHORT_LEVEL_NAMES \ { "T", "D", "I", "W", "E", "C", "O" } #endif [[nodiscard]] constexpr size_t level_to_number(level lvl) noexcept { return static_cast(lvl); } constexpr auto levels_count = level_to_number(level::n_levels); constexpr std::array level_string_views SPDLOG_LEVEL_NAMES; constexpr std::array short_level_names SPDLOG_SHORT_LEVEL_NAMES; [[nodiscard]] constexpr string_view_t to_string_view(spdlog::level lvl) noexcept { return level_string_views.at(level_to_number(lvl)); } [[nodiscard]] constexpr const string_view_t to_short_string_view(spdlog::level lvl) noexcept { return short_level_names.at(level_to_number(lvl)); } [[nodiscard]] SPDLOG_API spdlog::level level_from_str(const std::string &name) noexcept; // // Color mode used by sinks with color support. // enum class color_mode { always, automatic, never }; // // Pattern time - specific time getting to use for pattern_formatter. // local time by default // enum class pattern_time_type { local, // log localtime utc // log utc }; // // Log exception // class SPDLOG_API spdlog_ex : public std::exception { public: explicit spdlog_ex(std::string msg); spdlog_ex(const std::string &msg, int last_errno); [[nodiscard]] const char *what() const noexcept override; private: std::string msg_; }; [[noreturn]] SPDLOG_API void throw_spdlog_ex(const std::string &msg, int last_errno); [[noreturn]] SPDLOG_API void throw_spdlog_ex(std::string msg); // trick to capture format string and caller's source location with variadic template. // see logger::info() etc. to understand how it's used. struct loc_with_fmt { source_loc loc; string_view_t fmt_string; template > constexpr loc_with_fmt(S fmt_str, source_loc loc = source_loc::current()) noexcept : loc(loc), fmt_string(fmt_str) {} #ifndef SPDLOG_USE_STD_FORMAT constexpr loc_with_fmt(fmt::runtime_format_string fmt_str, source_loc loc = source_loc::current()) noexcept : loc(loc), fmt_string(fmt_str.str) {} #endif }; struct file_event_handlers { file_event_handlers() : before_open(nullptr), after_open(nullptr), before_close(nullptr), after_close(nullptr) {} std::function before_open; std::function after_open; std::function before_close; std::function after_close; }; namespace details { // to_string_view [[nodiscard]] constexpr spdlog::string_view_t to_string_view(const memory_buf_t &buf) noexcept { return spdlog::string_view_t{buf.data(), buf.size()}; } [[nodiscard]] constexpr spdlog::string_view_t to_string_view(spdlog::string_view_t str) noexcept { return str; } #if defined(SPDLOG_WCHAR_FILENAMES) [[nodiscard]] constexpr spdlog::wstring_view_t to_string_view(const wmemory_buf_t &buf) noexcept { return spdlog::wstring_view_t{buf.data(), buf.size()}; } [[nodiscard]] constexpr spdlog::wstring_view_t to_string_view(spdlog::wstring_view_t str) noexcept { return str; } #endif // convert format_string<...> to string_view depending on format lib versions #if defined(SPDLOG_USE_STD_FORMAT) #if __cpp_lib_format >= 202207L // std::format and __cpp_lib_format >= 202207L template [[nodiscard]] constexpr std::basic_string_view to_string_view( std::basic_format_string fmt) noexcept { return fmt.get(); } #else // std::format and __cpp_lib_format < 202207L template [[nodiscard]] constexpr std::basic_string_view to_string_view( std::basic_format_string fmt) noexcept { return fmt; } #endif #else // {fmt} version template [[nodiscard]] constexpr fmt::basic_string_view to_string_view( fmt::basic_format_string fmt) noexcept { return fmt; } #endif } // namespace details } // namespace spdlog