// Formatting library for C++ - the core API // // Copyright (c) 2012 - present, Victor Zverovich // All rights reserved. // // For the license information refer to format.h. #ifndef FMT_CORE_H_ #define FMT_CORE_H_ #include #include // std::FILE #include #include #include #include // The fmt library version in the form major * 10000 + minor * 100 + patch. #define FMT_VERSION 50300 #ifdef __has_feature # define FMT_HAS_FEATURE(x) __has_feature(x) #else # define FMT_HAS_FEATURE(x) 0 #endif #if defined(__has_include) && !defined(__INTELLISENSE__) && \ !(defined(__INTEL_COMPILER) && __INTEL_COMPILER < 1600) # define FMT_HAS_INCLUDE(x) __has_include(x) #else # define FMT_HAS_INCLUDE(x) 0 #endif #ifdef __has_cpp_attribute # define FMT_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x) #else # define FMT_HAS_CPP_ATTRIBUTE(x) 0 #endif #if defined(__GNUC__) && !defined(__clang__) # define FMT_GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__) #else # define FMT_GCC_VERSION 0 #endif #if __cplusplus >= 201103L || defined(__GXX_EXPERIMENTAL_CXX0X__) # define FMT_HAS_GXX_CXX11 FMT_GCC_VERSION #else # define FMT_HAS_GXX_CXX11 0 #endif #ifdef _MSC_VER # define FMT_MSC_VER _MSC_VER #else # define FMT_MSC_VER 0 #endif // Check if relaxed C++14 constexpr is supported. // GCC doesn't allow throw in constexpr until version 6 (bug 67371). #ifndef FMT_USE_CONSTEXPR # define FMT_USE_CONSTEXPR \ (FMT_HAS_FEATURE(cxx_relaxed_constexpr) || FMT_MSC_VER >= 1910 || \ (FMT_GCC_VERSION >= 600 && __cplusplus >= 201402L)) #endif #if FMT_USE_CONSTEXPR # define FMT_CONSTEXPR constexpr # define FMT_CONSTEXPR_DECL constexpr #else # define FMT_CONSTEXPR inline # define FMT_CONSTEXPR_DECL #endif #ifndef FMT_USE_CONSTEXPR11 # define FMT_USE_CONSTEXPR11 \ (FMT_USE_CONSTEXPR || FMT_GCC_VERSION >= 406 || FMT_MSC_VER >= 1900) #endif #if FMT_USE_CONSTEXPR11 # define FMT_CONSTEXPR11 constexpr #else # define FMT_CONSTEXPR11 #endif #ifndef FMT_OVERRIDE # if FMT_HAS_FEATURE(cxx_override) || \ (FMT_GCC_VERSION >= 408 && FMT_HAS_GXX_CXX11) || FMT_MSC_VER >= 1900 # define FMT_OVERRIDE override # else # define FMT_OVERRIDE # endif #endif #if FMT_HAS_FEATURE(cxx_explicit_conversions) || \ FMT_GCC_VERSION >= 405 || FMT_MSC_VER >= 1800 # define FMT_USE_EXPLICIT 1 # define FMT_EXPLICIT explicit #else # define FMT_USE_EXPLICIT 0 # define FMT_EXPLICIT #endif #ifndef FMT_NULL # if FMT_HAS_FEATURE(cxx_nullptr) || \ (FMT_GCC_VERSION >= 408 && FMT_HAS_GXX_CXX11) || FMT_MSC_VER >= 1600 # define FMT_NULL nullptr # define FMT_USE_NULLPTR 1 # else # define FMT_NULL NULL # endif #endif #ifndef FMT_USE_NULLPTR # define FMT_USE_NULLPTR 0 #endif // Check if exceptions are disabled. #ifndef FMT_EXCEPTIONS # if (defined(__GNUC__) && !defined(__EXCEPTIONS)) || \ FMT_MSC_VER && !_HAS_EXCEPTIONS # define FMT_EXCEPTIONS 0 # else # define FMT_EXCEPTIONS 1 # endif #endif // Define FMT_USE_NOEXCEPT to make fmt use noexcept (C++11 feature). #ifndef FMT_USE_NOEXCEPT # define FMT_USE_NOEXCEPT 0 #endif #if FMT_USE_NOEXCEPT || FMT_HAS_FEATURE(cxx_noexcept) || \ (FMT_GCC_VERSION >= 408 && FMT_HAS_GXX_CXX11) || FMT_MSC_VER >= 1900 # define FMT_DETECTED_NOEXCEPT noexcept # define FMT_HAS_CXX11_NOEXCEPT 1 #else # define FMT_DETECTED_NOEXCEPT throw() # define FMT_HAS_CXX11_NOEXCEPT 0 #endif #ifndef FMT_NOEXCEPT # if FMT_EXCEPTIONS || FMT_HAS_CXX11_NOEXCEPT # define FMT_NOEXCEPT FMT_DETECTED_NOEXCEPT # else # define FMT_NOEXCEPT # endif #endif #ifndef FMT_BEGIN_NAMESPACE # if FMT_HAS_FEATURE(cxx_inline_namespaces) || FMT_GCC_VERSION >= 404 || \ FMT_MSC_VER >= 1900 # define FMT_INLINE_NAMESPACE inline namespace # define FMT_END_NAMESPACE }} # else # define FMT_INLINE_NAMESPACE namespace # define FMT_END_NAMESPACE } using namespace v5; } # endif # define FMT_BEGIN_NAMESPACE namespace fmt { FMT_INLINE_NAMESPACE v5 { #endif #if !defined(FMT_HEADER_ONLY) && defined(_WIN32) # ifdef FMT_EXPORT # define FMT_API __declspec(dllexport) # elif defined(FMT_SHARED) # define FMT_API __declspec(dllimport) # endif #endif #ifndef FMT_API # define FMT_API #endif #ifndef FMT_ASSERT # define FMT_ASSERT(condition, message) assert((condition) && message) #endif // libc++ supports string_view in pre-c++17. #if (FMT_HAS_INCLUDE() && \ (__cplusplus > 201402L || defined(_LIBCPP_VERSION))) || \ (defined(_MSVC_LANG) && _MSVC_LANG > 201402L && _MSC_VER >= 1910) # include # define FMT_STRING_VIEW std::basic_string_view #elif FMT_HAS_INCLUDE() && __cplusplus >= 201402L # include # define FMT_STRING_VIEW std::experimental::basic_string_view #endif // std::result_of is defined in in gcc 4.4. #if FMT_GCC_VERSION && FMT_GCC_VERSION <= 404 # include #endif FMT_BEGIN_NAMESPACE namespace internal { // An implementation of declval for pre-C++11 compilers such as gcc 4. template typename std::add_rvalue_reference::type declval() FMT_NOEXCEPT; template struct result_of; template struct result_of { // A workaround for gcc 4.4 that doesn't allow F to be a reference. typedef typename std::result_of< typename std::remove_reference::type(Args...)>::type type; }; // Casts nonnegative integer to unsigned. template FMT_CONSTEXPR typename std::make_unsigned::type to_unsigned(Int value) { FMT_ASSERT(value >= 0, "negative value"); return static_cast::type>(value); } /** A contiguous memory buffer with an optional growing ability. */ template class basic_buffer { private: basic_buffer(const basic_buffer &) = delete; void operator=(const basic_buffer &) = delete; T *ptr_; std::size_t size_; std::size_t capacity_; protected: // Don't initialize ptr_ since it is not accessed to save a few cycles. basic_buffer(std::size_t sz) FMT_NOEXCEPT: size_(sz), capacity_(sz) {} basic_buffer(T *p = FMT_NULL, std::size_t sz = 0, std::size_t cap = 0) FMT_NOEXCEPT: ptr_(p), size_(sz), capacity_(cap) {} /** Sets the buffer data and capacity. */ void set(T *buf_data, std::size_t buf_capacity) FMT_NOEXCEPT { ptr_ = buf_data; capacity_ = buf_capacity; } /** Increases the buffer capacity to hold at least *capacity* elements. */ virtual void grow(std::size_t capacity) = 0; public: typedef T value_type; typedef const T &const_reference; virtual ~basic_buffer() {} T *begin() FMT_NOEXCEPT { return ptr_; } T *end() FMT_NOEXCEPT { return ptr_ + size_; } /** Returns the size of this buffer. */ std::size_t size() const FMT_NOEXCEPT { return size_; } /** Returns the capacity of this buffer. */ std::size_t capacity() const FMT_NOEXCEPT { return capacity_; } /** Returns a pointer to the buffer data. */ T *data() FMT_NOEXCEPT { return ptr_; } /** Returns a pointer to the buffer data. */ const T *data() const FMT_NOEXCEPT { return ptr_; } /** Resizes the buffer. If T is a POD type new elements may not be initialized. */ void resize(std::size_t new_size) { reserve(new_size); size_ = new_size; } /** Clears this buffer. */ void clear() { size_ = 0; } /** Reserves space to store at least *capacity* elements. */ void reserve(std::size_t new_capacity) { if (new_capacity > capacity_) grow(new_capacity); } void push_back(const T &value) { reserve(size_ + 1); ptr_[size_++] = value; } /** Appends data to the end of the buffer. */ template void append(const U *begin, const U *end); T &operator[](std::size_t index) { return ptr_[index]; } const T &operator[](std::size_t index) const { return ptr_[index]; } }; typedef basic_buffer buffer; typedef basic_buffer wbuffer; // A container-backed buffer. template class container_buffer : public basic_buffer { private: Container &container_; protected: void grow(std::size_t capacity) FMT_OVERRIDE { container_.resize(capacity); this->set(&container_[0], capacity); } public: explicit container_buffer(Container &c) : basic_buffer(c.size()), container_(c) {} }; // Extracts a reference to the container from back_insert_iterator. template inline Container &get_container(std::back_insert_iterator it) { typedef std::back_insert_iterator bi_iterator; struct accessor: bi_iterator { accessor(bi_iterator iter) : bi_iterator(iter) {} using bi_iterator::container; }; return *accessor(it).container; } struct error_handler { FMT_CONSTEXPR error_handler() {} FMT_CONSTEXPR error_handler(const error_handler &) {} // This function is intentionally not constexpr to give a compile-time error. FMT_API void on_error(const char *message); }; template struct no_formatter_error : std::false_type {}; } // namespace internal #if FMT_GCC_VERSION && FMT_GCC_VERSION < 405 template struct is_constructible: std::false_type {}; #else template struct is_constructible : std::is_constructible {}; #endif /** An implementation of ``std::basic_string_view`` for pre-C++17. It provides a subset of the API. ``fmt::basic_string_view`` is used for format strings even if ``std::string_view`` is available to prevent issues when a library is compiled with a different ``-std`` option than the client code (which is not recommended). */ template class basic_string_view { private: const Char *data_; size_t size_; public: typedef Char char_type; typedef const Char *iterator; FMT_CONSTEXPR basic_string_view() FMT_NOEXCEPT : data_(FMT_NULL), size_(0) {} /** Constructs a string reference object from a C string and a size. */ FMT_CONSTEXPR basic_string_view(const Char *s, size_t count) FMT_NOEXCEPT : data_(s), size_(count) {} /** \rst Constructs a string reference object from a C string computing the size with ``std::char_traits::length``. \endrst */ basic_string_view(const Char *s) : data_(s), size_(std::char_traits::length(s)) {} /** Constructs a string reference from a ``std::basic_string`` object. */ template FMT_CONSTEXPR basic_string_view( const std::basic_string &s) FMT_NOEXCEPT : data_(s.data()), size_(s.size()) {} #ifdef FMT_STRING_VIEW FMT_CONSTEXPR basic_string_view(FMT_STRING_VIEW s) FMT_NOEXCEPT : data_(s.data()), size_(s.size()) {} #endif /** Returns a pointer to the string data. */ FMT_CONSTEXPR const Char *data() const { return data_; } /** Returns the string size. */ FMT_CONSTEXPR size_t size() const { return size_; } FMT_CONSTEXPR iterator begin() const { return data_; } FMT_CONSTEXPR iterator end() const { return data_ + size_; } FMT_CONSTEXPR void remove_prefix(size_t n) { data_ += n; size_ -= n; } // Lexicographically compare this string reference to other. int compare(basic_string_view other) const { size_t str_size = size_ < other.size_ ? size_ : other.size_; int result = std::char_traits::compare(data_, other.data_, str_size); if (result == 0) result = size_ == other.size_ ? 0 : (size_ < other.size_ ? -1 : 1); return result; } friend bool operator==(basic_string_view lhs, basic_string_view rhs) { return lhs.compare(rhs) == 0; } friend bool operator!=(basic_string_view lhs, basic_string_view rhs) { return lhs.compare(rhs) != 0; } friend bool operator<(basic_string_view lhs, basic_string_view rhs) { return lhs.compare(rhs) < 0; } friend bool operator<=(basic_string_view lhs, basic_string_view rhs) { return lhs.compare(rhs) <= 0; } friend bool operator>(basic_string_view lhs, basic_string_view rhs) { return lhs.compare(rhs) > 0; } friend bool operator>=(basic_string_view lhs, basic_string_view rhs) { return lhs.compare(rhs) >= 0; } }; typedef basic_string_view string_view; typedef basic_string_view wstring_view; /** \rst The function ``to_string_view`` adapts non-intrusively any kind of string or string-like type if the user provides a (possibly templated) overload of ``to_string_view`` which takes an instance of the string class ``StringType`` and returns a ``fmt::basic_string_view``. The conversion function must live in the very same namespace as ``StringType`` to be picked up by ADL. Non-templated string types like f.e. QString must return a ``basic_string_view`` with a fixed matching char type. **Example**:: namespace my_ns { inline string_view to_string_view(const my_string &s) { return {s.data(), s.length()}; } } std::string message = fmt::format(my_string("The answer is {}"), 42); \endrst */ template inline basic_string_view to_string_view(basic_string_view s) { return s; } template inline basic_string_view to_string_view(const std::basic_string &s) { return s; } template inline basic_string_view to_string_view(const Char *s) { return s; } #ifdef FMT_STRING_VIEW template inline basic_string_view to_string_view(FMT_STRING_VIEW s) { return s; } #endif // A base class for compile-time strings. It is defined in the fmt namespace to // make formatting functions visible via ADL, e.g. format(fmt("{}"), 42). struct compile_string {}; template struct is_compile_string : std::is_base_of {}; template < typename S, typename Enable = typename std::enable_if::value>::type> FMT_CONSTEXPR basic_string_view to_string_view(const S &s) { return s; } template class basic_format_arg; template class basic_format_args; // A formatter for objects of type T. template struct formatter { static_assert(internal::no_formatter_error::value, "don't know how to format the type, include fmt/ostream.h if it provides " "an operator<< that should be used"); // The following functions are not defined intentionally. template typename ParseContext::iterator parse(ParseContext &); template auto format(const T &val, FormatContext &ctx) -> decltype(ctx.out()); }; template struct convert_to_int: std::integral_constant< bool, !std::is_arithmetic::value && std::is_convertible::value> {}; namespace internal { struct dummy_string_view { typedef void char_type; }; dummy_string_view to_string_view(...); using fmt::v5::to_string_view; // Specifies whether S is a string type convertible to fmt::basic_string_view. template struct is_string : std::integral_constant()))>::value> {}; template struct char_t { typedef decltype(to_string_view(declval())) result; typedef typename result::char_type type; }; template struct named_arg_base; template struct named_arg; enum type { none_type, named_arg_type, // Integer types should go first, int_type, uint_type, long_long_type, ulong_long_type, bool_type, char_type, last_integer_type = char_type, // followed by floating-point types. double_type, long_double_type, last_numeric_type = long_double_type, cstring_type, string_type, pointer_type, custom_type }; FMT_CONSTEXPR bool is_integral(type t) { FMT_ASSERT(t != internal::named_arg_type, "invalid argument type"); return t > internal::none_type && t <= internal::last_integer_type; } FMT_CONSTEXPR bool is_arithmetic(type t) { FMT_ASSERT(t != internal::named_arg_type, "invalid argument type"); return t > internal::none_type && t <= internal::last_numeric_type; } template struct string_value { const Char *value; std::size_t size; }; template struct custom_value { const void *value; void (*format)(const void *arg, Context &ctx); }; // A formatting argument value. template class value { public: typedef typename Context::char_type char_type; union { int int_value; unsigned uint_value; long long long_long_value; unsigned long long ulong_long_value; double double_value; long double long_double_value; const void *pointer; string_value string; string_value sstring; string_value ustring; custom_value custom; }; FMT_CONSTEXPR value(int val = 0) : int_value(val) {} value(unsigned val) { uint_value = val; } value(long long val) { long_long_value = val; } value(unsigned long long val) { ulong_long_value = val; } value(double val) { double_value = val; } value(long double val) { long_double_value = val; } value(const char_type *val) { string.value = val; } value(const signed char *val) { static_assert(std::is_same::value, "incompatible string types"); sstring.value = val; } value(const unsigned char *val) { static_assert(std::is_same::value, "incompatible string types"); ustring.value = val; } value(basic_string_view val) { string.value = val.data(); string.size = val.size(); } value(const void *val) { pointer = val; } template explicit value(const T &val) { custom.value = &val; custom.format = &format_custom_arg; } const named_arg_base &as_named_arg() { return *static_cast*>(pointer); } private: // Formats an argument of a custom type, such as a user-defined class. template static void format_custom_arg(const void *arg, Context &ctx) { // Get the formatter type through the context to allow different contexts // have different extension points, e.g. `formatter` for `format` and // `printf_formatter` for `printf`. typename Context::template formatter_type::type f; auto &&parse_ctx = ctx.parse_context(); parse_ctx.advance_to(f.parse(parse_ctx)); ctx.advance_to(f.format(*static_cast(arg), ctx)); } }; // Value initializer used to delay conversion to value and reduce memory churn. template struct init { T val; static const type type_tag = TYPE; FMT_CONSTEXPR init(const T &v) : val(v) {} FMT_CONSTEXPR operator value() const { return value(val); } }; template FMT_CONSTEXPR basic_format_arg make_arg(const T &value); #define FMT_MAKE_VALUE(TAG, ArgType, ValueType) \ template \ FMT_CONSTEXPR init make_value(ArgType val) { \ return static_cast(val); \ } #define FMT_MAKE_VALUE_SAME(TAG, Type) \ template \ FMT_CONSTEXPR init make_value(Type val) { return val; } FMT_MAKE_VALUE(bool_type, bool, int) FMT_MAKE_VALUE(int_type, short, int) FMT_MAKE_VALUE(uint_type, unsigned short, unsigned) FMT_MAKE_VALUE_SAME(int_type, int) FMT_MAKE_VALUE_SAME(uint_type, unsigned) // To minimize the number of types we need to deal with, long is translated // either to int or to long long depending on its size. typedef std::conditional::type long_type; FMT_MAKE_VALUE( (sizeof(long) == sizeof(int) ? int_type : long_long_type), long, long_type) typedef std::conditional::type ulong_type; FMT_MAKE_VALUE( (sizeof(unsigned long) == sizeof(unsigned) ? uint_type : ulong_long_type), unsigned long, ulong_type) FMT_MAKE_VALUE_SAME(long_long_type, long long) FMT_MAKE_VALUE_SAME(ulong_long_type, unsigned long long) FMT_MAKE_VALUE(int_type, signed char, int) FMT_MAKE_VALUE(uint_type, unsigned char, unsigned) // This doesn't use FMT_MAKE_VALUE because of ambiguity in gcc 4.4. template FMT_CONSTEXPR typename std::enable_if< std::is_same::value, init>::type make_value(Char val) { return val; } template FMT_CONSTEXPR typename std::enable_if< !std::is_same::value, init>::type make_value(char val) { return val; } FMT_MAKE_VALUE(double_type, float, double) FMT_MAKE_VALUE_SAME(double_type, double) FMT_MAKE_VALUE_SAME(long_double_type, long double) // Formatting of wide strings into a narrow buffer and multibyte strings // into a wide buffer is disallowed (https://github.com/fmtlib/fmt/pull/606). FMT_MAKE_VALUE(cstring_type, typename C::char_type*, const typename C::char_type*) FMT_MAKE_VALUE(cstring_type, const typename C::char_type*, const typename C::char_type*) FMT_MAKE_VALUE(cstring_type, signed char*, const signed char*) FMT_MAKE_VALUE_SAME(cstring_type, const signed char*) FMT_MAKE_VALUE(cstring_type, unsigned char*, const unsigned char*) FMT_MAKE_VALUE_SAME(cstring_type, const unsigned char*) FMT_MAKE_VALUE_SAME(string_type, basic_string_view) FMT_MAKE_VALUE(string_type, typename basic_string_view::type, basic_string_view) FMT_MAKE_VALUE(string_type, const std::basic_string&, basic_string_view) FMT_MAKE_VALUE(pointer_type, void*, const void*) FMT_MAKE_VALUE_SAME(pointer_type, const void*) #if FMT_USE_NULLPTR FMT_MAKE_VALUE(pointer_type, std::nullptr_t, const void*) #endif // Formatting of arbitrary pointers is disallowed. If you want to output a // pointer cast it to "void *" or "const void *". In particular, this forbids // formatting of "[const] volatile char *" which is printed as bool by // iostreams. template typename std::enable_if::value>::type make_value(const T *) { static_assert(!sizeof(T), "formatting of non-void pointers is disallowed"); } template inline typename std::enable_if< std::is_enum::value && convert_to_int::value, init>::type make_value(const T &val) { return static_cast(val); } template inline typename std::enable_if< is_constructible, T>::value && !internal::is_string::value, init, string_type>>::type make_value(const T &val) { return basic_string_view(val); } template inline typename std::enable_if< !convert_to_int::value && !std::is_same::value && !std::is_convertible>::value && !is_constructible, T>::value && !internal::is_string::value, // Implicit conversion to std::string is not handled here because it's // unsafe: https://github.com/fmtlib/fmt/issues/729 init>::type make_value(const T &val) { return val; } template init make_value(const named_arg &val) { basic_format_arg arg = make_arg(val.value); std::memcpy(val.data, &arg, sizeof(arg)); return static_cast(&val); } template FMT_CONSTEXPR11 typename std::enable_if< internal::is_string::value, init, string_type>>::type make_value(const S &val) { // Handle adapted strings. static_assert(std::is_same< typename C::char_type, typename internal::char_t::type>::value, "mismatch between char-types of context and argument"); return to_string_view(val); } // Maximum number of arguments with packed types. enum { max_packed_args = 15 }; enum : unsigned long long { is_unpacked_bit = 1ull << 63 }; template class arg_map; } // namespace internal // A formatting argument. It is a trivially copyable/constructible type to // allow storage in basic_memory_buffer. template class basic_format_arg { private: internal::value value_; internal::type type_; template friend FMT_CONSTEXPR basic_format_arg internal::make_arg(const T &value); template friend FMT_CONSTEXPR typename internal::result_of::type visit_format_arg(Visitor &&vis, const basic_format_arg &arg); friend class basic_format_args; friend class internal::arg_map; typedef typename Context::char_type char_type; public: class handle { public: explicit handle(internal::custom_value custom): custom_(custom) {} void format(Context &ctx) const { custom_.format(custom_.value, ctx); } private: internal::custom_value custom_; }; FMT_CONSTEXPR basic_format_arg() : type_(internal::none_type) {} FMT_EXPLICIT operator bool() const FMT_NOEXCEPT { return type_ != internal::none_type; } internal::type type() const { return type_; } bool is_integral() const { return internal::is_integral(type_); } bool is_arithmetic() const { return internal::is_arithmetic(type_); } }; struct monostate {}; /** \rst Visits an argument dispatching to the appropriate visit method based on the argument type. For example, if the argument type is ``double`` then ``vis(value)`` will be called with the value of type ``double``. \endrst */ template FMT_CONSTEXPR typename internal::result_of::type visit_format_arg(Visitor &&vis, const basic_format_arg &arg) { typedef typename Context::char_type char_type; switch (arg.type_) { case internal::none_type: break; case internal::named_arg_type: FMT_ASSERT(false, "invalid argument type"); break; case internal::int_type: return vis(arg.value_.int_value); case internal::uint_type: return vis(arg.value_.uint_value); case internal::long_long_type: return vis(arg.value_.long_long_value); case internal::ulong_long_type: return vis(arg.value_.ulong_long_value); case internal::bool_type: return vis(arg.value_.int_value != 0); case internal::char_type: return vis(static_cast(arg.value_.int_value)); case internal::double_type: return vis(arg.value_.double_value); case internal::long_double_type: return vis(arg.value_.long_double_value); case internal::cstring_type: return vis(arg.value_.string.value); case internal::string_type: return vis(basic_string_view( arg.value_.string.value, arg.value_.string.size)); case internal::pointer_type: return vis(arg.value_.pointer); case internal::custom_type: return vis(typename basic_format_arg::handle(arg.value_.custom)); } return vis(monostate()); } // DEPRECATED! template FMT_CONSTEXPR typename internal::result_of::type visit(Visitor &&vis, const basic_format_arg &arg) { return visit_format_arg(std::forward(vis), arg); } // Parsing context consisting of a format string range being parsed and an // argument counter for automatic indexing. template class basic_parse_context : private ErrorHandler { private: basic_string_view format_str_; int next_arg_id_; public: typedef Char char_type; typedef typename basic_string_view::iterator iterator; explicit FMT_CONSTEXPR basic_parse_context( basic_string_view format_str, ErrorHandler eh = ErrorHandler()) : ErrorHandler(eh), format_str_(format_str), next_arg_id_(0) {} // Returns an iterator to the beginning of the format string range being // parsed. FMT_CONSTEXPR iterator begin() const FMT_NOEXCEPT { return format_str_.begin(); } // Returns an iterator past the end of the format string range being parsed. FMT_CONSTEXPR iterator end() const FMT_NOEXCEPT { return format_str_.end(); } // Advances the begin iterator to ``it``. FMT_CONSTEXPR void advance_to(iterator it) { format_str_.remove_prefix(internal::to_unsigned(it - begin())); } // Returns the next argument index. FMT_CONSTEXPR unsigned next_arg_id(); FMT_CONSTEXPR bool check_arg_id(unsigned) { if (next_arg_id_ > 0) { on_error("cannot switch from automatic to manual argument indexing"); return false; } next_arg_id_ = -1; return true; } void check_arg_id(basic_string_view) {} FMT_CONSTEXPR void on_error(const char *message) { ErrorHandler::on_error(message); } FMT_CONSTEXPR ErrorHandler error_handler() const { return *this; } }; typedef basic_parse_context format_parse_context; typedef basic_parse_context wformat_parse_context; // DEPRECATED! typedef basic_parse_context parse_context; typedef basic_parse_context wparse_context; namespace internal { // A map from argument names to their values for named arguments. template class arg_map { private: arg_map(const arg_map &) = delete; void operator=(const arg_map &) = delete; typedef typename Context::char_type char_type; struct entry { basic_string_view name; basic_format_arg arg; }; entry *map_; unsigned size_; void push_back(value val) { const internal::named_arg_base &named = val.as_named_arg(); map_[size_] = entry{named.name, named.template deserialize()}; ++size_; } public: arg_map() : map_(FMT_NULL), size_(0) {} void init(const basic_format_args &args); ~arg_map() { delete [] map_; } basic_format_arg find(basic_string_view name) const { // The list is unsorted, so just return the first matching name. for (entry *it = map_, *end = map_ + size_; it != end; ++it) { if (it->name == name) return it->arg; } return {}; } }; // A type-erased reference to an std::locale to avoid heavy include. class locale_ref { private: const void *locale_; // A type-erased pointer to std::locale. friend class locale; public: locale_ref() : locale_(FMT_NULL) {} template explicit locale_ref(const Locale &loc); template Locale get() const; }; template class context_base { public: typedef OutputIt iterator; private: basic_parse_context parse_context_; iterator out_; basic_format_args args_; locale_ref loc_; protected: typedef Char char_type; typedef basic_format_arg format_arg; context_base(OutputIt out, basic_string_view format_str, basic_format_args ctx_args, locale_ref loc = locale_ref()) : parse_context_(format_str), out_(out), args_(ctx_args), loc_(loc) {} // Returns the argument with specified index. format_arg do_get_arg(unsigned arg_id) { format_arg arg = args_.get(arg_id); if (!arg) parse_context_.on_error("argument index out of range"); return arg; } // Checks if manual indexing is used and returns the argument with // specified index. format_arg get_arg(unsigned arg_id) { return this->parse_context().check_arg_id(arg_id) ? this->do_get_arg(arg_id) : format_arg(); } public: basic_parse_context &parse_context() { return parse_context_; } basic_format_args args() const { return args_; } // DEPRECATED! basic_format_arg arg(unsigned id) const { return args_.get(id); } internal::error_handler error_handler() { return parse_context_.error_handler(); } void on_error(const char *message) { parse_context_.on_error(message); } // Returns an iterator to the beginning of the output range. iterator out() { return out_; } iterator begin() { return out_; } // deprecated // Advances the begin iterator to ``it``. void advance_to(iterator it) { out_ = it; } locale_ref locale() { return loc_; } }; template struct get_type { typedef decltype(make_value( declval::type&>())) value_type; static const type value = value_type::type_tag; }; template FMT_CONSTEXPR11 unsigned long long get_types() { return 0; } template FMT_CONSTEXPR11 unsigned long long get_types() { return get_type::value | (get_types() << 4); } template FMT_CONSTEXPR basic_format_arg make_arg(const T &value) { basic_format_arg arg; arg.type_ = get_type::value; arg.value_ = make_value(value); return arg; } template inline typename std::enable_if>::type make_arg(const T &value) { return make_value(value); } template inline typename std::enable_if>::type make_arg(const T &value) { return make_arg(value); } } // namespace internal // Formatting context. template class basic_format_context : public internal::context_base< OutputIt, basic_format_context, Char> { public: /** The character type for the output. */ typedef Char char_type; // using formatter_type = formatter; template struct formatter_type { typedef formatter type; }; private: internal::arg_map map_; basic_format_context(const basic_format_context &) = delete; void operator=(const basic_format_context &) = delete; typedef internal::context_base base; typedef typename base::format_arg format_arg; using base::get_arg; public: using typename base::iterator; /** Constructs a ``basic_format_context`` object. References to the arguments are stored in the object so make sure they have appropriate lifetimes. */ basic_format_context(OutputIt out, basic_string_view format_str, basic_format_args ctx_args, internal::locale_ref loc = internal::locale_ref()) : base(out, format_str, ctx_args, loc) {} format_arg next_arg() { return this->do_get_arg(this->parse_context().next_arg_id()); } format_arg get_arg(unsigned arg_id) { return this->do_get_arg(arg_id); } // Checks if manual indexing is used and returns the argument with the // specified name. format_arg get_arg(basic_string_view name); }; template struct buffer_context { typedef basic_format_context< std::back_insert_iterator>, Char> type; }; typedef buffer_context::type format_context; typedef buffer_context::type wformat_context; /** \rst An array of references to arguments. It can be implicitly converted into `~fmt::basic_format_args` for passing into type-erased formatting functions such as `~fmt::vformat`. \endrst */ template class format_arg_store { private: static const size_t NUM_ARGS = sizeof...(Args); // Packed is a macro on MinGW so use IS_PACKED instead. static const bool IS_PACKED = NUM_ARGS < internal::max_packed_args; typedef typename std::conditional, basic_format_arg>::type value_type; // If the arguments are not packed, add one more element to mark the end. static const size_t DATA_SIZE = NUM_ARGS + (IS_PACKED && NUM_ARGS != 0 ? 0 : 1); value_type data_[DATA_SIZE]; friend class basic_format_args; static FMT_CONSTEXPR11 unsigned long long get_types() { return IS_PACKED ? internal::get_types() : internal::is_unpacked_bit | NUM_ARGS; } public: #if FMT_USE_CONSTEXPR11 static FMT_CONSTEXPR11 unsigned long long TYPES = get_types(); #else static const unsigned long long TYPES; #endif #if (FMT_GCC_VERSION && FMT_GCC_VERSION <= 405) || \ (FMT_MSC_VER && FMT_MSC_VER <= 1800) // Workaround array initialization issues in gcc <= 4.5 and MSVC <= 2013. format_arg_store(const Args &... args) { value_type init[DATA_SIZE] = {internal::make_arg(args)...}; std::memcpy(data_, init, sizeof(init)); } #else format_arg_store(const Args &... args) : data_{internal::make_arg(args)...} {} #endif }; #if !FMT_USE_CONSTEXPR11 template const unsigned long long format_arg_store::TYPES = get_types(); #endif /** \rst Constructs an `~fmt::format_arg_store` object that contains references to arguments and can be implicitly converted to `~fmt::format_args`. `Context` can be omitted in which case it defaults to `~fmt::context`. \endrst */ template inline format_arg_store make_format_args(const Args &... args) { return {args...}; } /** Formatting arguments. */ template class basic_format_args { public: typedef unsigned size_type; typedef basic_format_arg format_arg; private: // To reduce compiled code size per formatting function call, types of first // max_packed_args arguments are passed in the types_ field. unsigned long long types_; union { // If the number of arguments is less than max_packed_args, the argument // values are stored in values_, otherwise they are stored in args_. // This is done to reduce compiled code size as storing larger objects // may require more code (at least on x86-64) even if the same amount of // data is actually copied to stack. It saves ~10% on the bloat test. const internal::value *values_; const format_arg *args_; }; bool is_packed() const { return (types_ & internal::is_unpacked_bit) == 0; } typename internal::type type(unsigned index) const { unsigned shift = index * 4; return static_cast( (types_ & (0xfull << shift)) >> shift); } friend class internal::arg_map; void set_data(const internal::value *values) { values_ = values; } void set_data(const format_arg *args) { args_ = args; } format_arg do_get(size_type index) const { format_arg arg; if (!is_packed()) { auto num_args = max_size(); if (index < num_args) arg = args_[index]; return arg; } if (index > internal::max_packed_args) return arg; arg.type_ = type(index); if (arg.type_ == internal::none_type) return arg; internal::value &val = arg.value_; val = values_[index]; return arg; } public: basic_format_args() : types_(0) {} /** \rst Constructs a `basic_format_args` object from `~fmt::format_arg_store`. \endrst */ template basic_format_args(const format_arg_store &store) : types_(static_cast(store.TYPES)) { set_data(store.data_); } /** \rst Constructs a `basic_format_args` object from a dynamic set of arguments. \endrst */ basic_format_args(const format_arg *args, size_type count) : types_(internal::is_unpacked_bit | count) { set_data(args); } /** Returns the argument at specified index. */ format_arg get(size_type index) const { format_arg arg = do_get(index); if (arg.type_ == internal::named_arg_type) arg = arg.value_.as_named_arg().template deserialize(); return arg; } size_type max_size() const { unsigned long long max_packed = internal::max_packed_args; return static_cast( is_packed() ? max_packed : types_ & ~internal::is_unpacked_bit); } }; /** An alias to ``basic_format_args``. */ // It is a separate type rather than a typedef to make symbols readable. struct format_args : basic_format_args { template format_args(Args &&... arg) : basic_format_args(std::forward(arg)...) {} }; struct wformat_args : basic_format_args { template wformat_args(Args &&... arg) : basic_format_args(std::forward(arg)...) {} }; #define FMT_ENABLE_IF_T(B, T) typename std::enable_if::type #ifndef FMT_USE_ALIAS_TEMPLATES # define FMT_USE_ALIAS_TEMPLATES FMT_HAS_FEATURE(cxx_alias_templates) #endif #if FMT_USE_ALIAS_TEMPLATES /** String's character type. */ template using char_t = FMT_ENABLE_IF_T( internal::is_string::value, typename internal::char_t::type); #define FMT_CHAR(S) fmt::char_t #else template struct char_t : std::enable_if< internal::is_string::value, typename internal::char_t::type> {}; #define FMT_CHAR(S) typename char_t::type #endif namespace internal { template struct named_arg_base { basic_string_view name; // Serialized value. mutable char data[ sizeof(basic_format_arg::type>)]; named_arg_base(basic_string_view nm) : name(nm) {} template basic_format_arg deserialize() const { basic_format_arg arg; std::memcpy(&arg, data, sizeof(basic_format_arg)); return arg; } }; template struct named_arg : named_arg_base { const T &value; named_arg(basic_string_view name, const T &val) : named_arg_base(name), value(val) {} }; template inline typename std::enable_if::value>::type check_format_string(const S &) {} template typename std::enable_if::value>::type check_format_string(S); template struct checked_args : format_arg_store< typename buffer_context::type, Args...> { typedef typename buffer_context::type context; checked_args(const S &format_str, const Args &... args): format_arg_store(args...) { internal::check_format_string(format_str); } basic_format_args operator*() const { return *this; } }; template std::basic_string vformat( basic_string_view format_str, basic_format_args::type> args); template typename buffer_context::type::iterator vformat_to( internal::basic_buffer &buf, basic_string_view format_str, basic_format_args::type> args); } /** \rst Returns a named argument to be used in a formatting function. **Example**:: fmt::print("Elapsed time: {s:.2f} seconds", fmt::arg("s", 1.23)); \endrst */ template inline internal::named_arg arg(string_view name, const T &arg) { return {name, arg}; } template inline internal::named_arg arg(wstring_view name, const T &arg) { return {name, arg}; } // Disable nested named arguments, e.g. ``arg("a", arg("b", 42))``. template void arg(S, internal::named_arg) = delete; template struct is_contiguous: std::false_type {}; template struct is_contiguous >: std::true_type {}; template struct is_contiguous >: std::true_type {}; /** Formats a string and writes the output to ``out``. */ template typename std::enable_if< is_contiguous::value, std::back_insert_iterator>::type vformat_to( std::back_insert_iterator out, const S &format_str, basic_format_args::type> args) { internal::container_buffer buf(internal::get_container(out)); internal::vformat_to(buf, to_string_view(format_str), args); return out; } template inline typename std::enable_if< is_contiguous::value && internal::is_string::value, std::back_insert_iterator>::type format_to(std::back_insert_iterator out, const S &format_str, const Args &... args) { internal::checked_args ca(format_str, args...); return vformat_to(out, to_string_view(format_str), *ca); } template inline std::basic_string vformat( const S &format_str, basic_format_args::type> args) { return internal::vformat(to_string_view(format_str), args); } /** \rst Formats arguments and returns the result as a string. **Example**:: #include std::string message = fmt::format("The answer is {}", 42); \endrst */ template inline std::basic_string format( const S &format_str, const Args &... args) { return internal::vformat( to_string_view(format_str), *internal::checked_args(format_str, args...)); } FMT_API void vprint(std::FILE *f, string_view format_str, format_args args); FMT_API void vprint(std::FILE *f, wstring_view format_str, wformat_args args); /** \rst Prints formatted data to the file *f*. For wide format strings, *f* should be in wide-oriented mode set via ``fwide(f, 1)`` or ``_setmode(_fileno(f), _O_U8TEXT)`` on Windows. **Example**:: fmt::print(stderr, "Don't {}!", "panic"); \endrst */ template inline FMT_ENABLE_IF_T(internal::is_string::value, void) print(std::FILE *f, const S &format_str, const Args &... args) { vprint(f, to_string_view(format_str), internal::checked_args(format_str, args...)); } FMT_API void vprint(string_view format_str, format_args args); FMT_API void vprint(wstring_view format_str, wformat_args args); /** \rst Prints formatted data to ``stdout``. **Example**:: fmt::print("Elapsed time: {0:.2f} seconds", 1.23); \endrst */ template inline FMT_ENABLE_IF_T(internal::is_string::value, void) print(const S &format_str, const Args &... args) { vprint(to_string_view(format_str), internal::checked_args(format_str, args...)); } FMT_END_NAMESPACE #endif // FMT_CORE_H_