ext-fmt/include/fmt/core.h

2992 lines
97 KiB
C
Raw Normal View History

2018-01-06 17:09:50 +00:00
// 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_
2021-05-06 13:49:46 +00:00
#include <climits> // INT_MAX
#include <cstdio> // std::FILE
2018-01-06 17:09:50 +00:00
#include <cstring>
2018-01-14 22:15:59 +00:00
#include <iterator>
#include <string>
#include <type_traits>
2018-01-22 00:36:22 +00:00
// The fmt library version in the form major * 10000 + minor * 100 + patch.
2021-04-23 23:05:03 +00:00
#define FMT_VERSION 70104
2018-01-22 00:36:22 +00:00
#ifdef __clang__
# define FMT_CLANG_VERSION (__clang_major__ * 100 + __clang_minor__)
#else
# define FMT_CLANG_VERSION 0
#endif
2018-03-15 13:55:31 +00:00
#if defined(__GNUC__) && !defined(__clang__)
2019-01-13 02:27:38 +00:00
# define FMT_GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__)
# define FMT_GCC_PRAGMA(arg) _Pragma(arg)
2018-02-03 03:16:13 +00:00
#else
2019-01-13 02:27:38 +00:00
# define FMT_GCC_VERSION 0
# define FMT_GCC_PRAGMA(arg)
2018-02-03 03:16:13 +00:00
#endif
2018-02-11 14:23:43 +00:00
#if __cplusplus >= 201103L || defined(__GXX_EXPERIMENTAL_CXX0X__)
2019-01-13 02:27:38 +00:00
# define FMT_HAS_GXX_CXX11 FMT_GCC_VERSION
2018-02-03 03:16:13 +00:00
#else
2019-01-13 02:27:38 +00:00
# define FMT_HAS_GXX_CXX11 0
#endif
2021-05-16 14:18:04 +00:00
#if defined(__INTEL_COMPILER)
# define FMT_ICC_VERSION __INTEL_COMPILER
#else
# define FMT_ICC_VERSION 0
#endif
2019-10-23 18:32:35 +00:00
#ifdef __NVCC__
# define FMT_NVCC __NVCC__
#else
# define FMT_NVCC 0
#endif
#ifdef _MSC_VER
2019-01-13 02:27:38 +00:00
# define FMT_MSC_VER _MSC_VER
2020-11-12 00:16:33 +00:00
# define FMT_MSC_WARNING(...) __pragma(warning(__VA_ARGS__))
#else
2019-01-13 02:27:38 +00:00
# define FMT_MSC_VER 0
2020-11-12 00:16:33 +00:00
# define FMT_MSC_WARNING(...)
#endif
2020-09-07 21:43:00 +00:00
#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__) && \
2020-09-07 21:43:00 +00:00
(!FMT_ICC_VERSION || FMT_ICC_VERSION >= 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
#define FMT_HAS_CPP14_ATTRIBUTE(attribute) \
(__cplusplus >= 201402L && FMT_HAS_CPP_ATTRIBUTE(attribute))
#define FMT_HAS_CPP17_ATTRIBUTE(attribute) \
(__cplusplus >= 201703L && FMT_HAS_CPP_ATTRIBUTE(attribute))
2018-07-18 16:14:10 +00:00
// Check if relaxed C++14 constexpr is supported.
2018-03-16 16:02:19 +00:00
// GCC doesn't allow throw in constexpr until version 6 (bug 67371).
2018-02-04 16:52:43 +00:00
#ifndef FMT_USE_CONSTEXPR
2019-01-13 02:27:38 +00:00
# define FMT_USE_CONSTEXPR \
(FMT_HAS_FEATURE(cxx_relaxed_constexpr) || FMT_MSC_VER >= 1910 || \
2019-10-23 18:32:35 +00:00
(FMT_GCC_VERSION >= 600 && __cplusplus >= 201402L)) && \
!FMT_NVCC && !FMT_ICC_VERSION
#endif
2018-02-04 16:52:43 +00:00
#if FMT_USE_CONSTEXPR
2019-01-13 02:27:38 +00:00
# define FMT_CONSTEXPR constexpr
# define FMT_CONSTEXPR_DECL constexpr
2018-02-04 16:52:43 +00:00
#else
# define FMT_CONSTEXPR
2019-01-13 02:27:38 +00:00
# define FMT_CONSTEXPR_DECL
2018-02-03 14:14:10 +00:00
#endif
2021-05-16 14:18:04 +00:00
// Check if constexpr std::char_traits<>::compare,length is supported.
#if defined(__GLIBCXX__)
# if __cplusplus >= 201703L && defined(_GLIBCXX_RELEASE) && \
_GLIBCXX_RELEASE >= 7 // GCC 7+ libstdc++ has _GLIBCXX_RELEASE.
# define FMT_CONSTEXPR_CHAR_TRAITS constexpr
# endif
#elif defined(_LIBCPP_VERSION) && __cplusplus >= 201703L && \
_LIBCPP_VERSION >= 4000
# define FMT_CONSTEXPR_CHAR_TRAITS constexpr
#elif FMT_MSC_VER >= 1914 && _MSVC_LANG >= 201703L
# define FMT_CONSTEXPR_CHAR_TRAITS constexpr
#endif
#ifndef FMT_CONSTEXPR_CHAR_TRAITS
# define FMT_CONSTEXPR_CHAR_TRAITS
#endif
#ifndef FMT_OVERRIDE
2020-08-23 18:01:46 +00:00
# if FMT_HAS_FEATURE(cxx_override_control) || \
2019-01-13 02:27:38 +00:00
(FMT_GCC_VERSION >= 408 && FMT_HAS_GXX_CXX11) || FMT_MSC_VER >= 1900
# define FMT_OVERRIDE override
# else
# define FMT_OVERRIDE
# endif
#endif
// Check if exceptions are disabled.
#ifndef FMT_EXCEPTIONS
2019-01-13 02:27:38 +00:00
# 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
2019-01-13 02:27:38 +00:00
# define FMT_USE_NOEXCEPT 0
#endif
2018-01-21 01:54:06 +00:00
#if FMT_USE_NOEXCEPT || FMT_HAS_FEATURE(cxx_noexcept) || \
2018-07-07 19:20:10 +00:00
(FMT_GCC_VERSION >= 408 && FMT_HAS_GXX_CXX11) || FMT_MSC_VER >= 1900
2019-01-13 02:27:38 +00:00
# define FMT_DETECTED_NOEXCEPT noexcept
# define FMT_HAS_CXX11_NOEXCEPT 1
2018-01-21 01:54:06 +00:00
#else
2019-01-13 02:27:38 +00:00
# define FMT_DETECTED_NOEXCEPT throw()
# define FMT_HAS_CXX11_NOEXCEPT 0
2018-01-21 01:54:06 +00:00
#endif
#ifndef FMT_NOEXCEPT
2019-01-13 02:27:38 +00:00
# if FMT_EXCEPTIONS || FMT_HAS_CXX11_NOEXCEPT
# define FMT_NOEXCEPT FMT_DETECTED_NOEXCEPT
# else
# define FMT_NOEXCEPT
# endif
#endif
// [[noreturn]] is disabled on MSVC and NVCC because of bogus unreachable code
// warnings.
#if FMT_EXCEPTIONS && FMT_HAS_CPP_ATTRIBUTE(noreturn) && !FMT_MSC_VER && \
!FMT_NVCC
2019-04-08 11:52:20 +00:00
# define FMT_NORETURN [[noreturn]]
#else
# define FMT_NORETURN
#endif
2021-05-06 14:37:40 +00:00
#ifndef FMT_MAYBE_UNUSED
# if FMT_HAS_CPP17_ATTRIBUTE(maybe_unused)
# define FMT_MAYBE_UNUSED [[maybe_unused]]
# else
# define FMT_MAYBE_UNUSED
# endif
#endif
2021-05-16 14:08:49 +00:00
#if __cplusplus == 201103L || __cplusplus == 201402L
# if defined(__INTEL_COMPILER) || defined(__PGI)
# define FMT_FALLTHROUGH
# elif defined(__clang__)
# define FMT_FALLTHROUGH [[clang::fallthrough]]
# elif FMT_GCC_VERSION >= 700 && \
(!defined(__EDG_VERSION__) || __EDG_VERSION__ >= 520)
# define FMT_FALLTHROUGH [[gnu::fallthrough]]
# else
# define FMT_FALLTHROUGH
# endif
#elif FMT_HAS_CPP17_ATTRIBUTE(fallthrough) || \
(defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)
# define FMT_FALLTHROUGH [[fallthrough]]
#else
# define FMT_FALLTHROUGH
#endif
#ifndef FMT_USE_FLOAT
# define FMT_USE_FLOAT 1
#endif
#ifndef FMT_USE_DOUBLE
# define FMT_USE_DOUBLE 1
#endif
#ifndef FMT_USE_LONG_DOUBLE
# define FMT_USE_LONG_DOUBLE 1
#endif
2020-04-19 14:41:55 +00:00
#ifndef FMT_INLINE
2020-05-31 00:57:57 +00:00
# if FMT_GCC_VERSION || FMT_CLANG_VERSION
2020-04-19 15:12:27 +00:00
# define FMT_INLINE inline __attribute__((always_inline))
2020-04-19 14:41:55 +00:00
# else
2020-05-22 21:14:57 +00:00
# define FMT_INLINE inline
2020-04-19 14:41:55 +00:00
# endif
#endif
#ifndef FMT_USE_INLINE_NAMESPACES
2019-01-13 02:27:38 +00:00
# if FMT_HAS_FEATURE(cxx_inline_namespaces) || FMT_GCC_VERSION >= 404 || \
(FMT_MSC_VER >= 1900 && (!defined(_MANAGED) || !_MANAGED))
# define FMT_USE_INLINE_NAMESPACES 1
# else
# define FMT_USE_INLINE_NAMESPACES 0
# endif
#endif
#ifndef FMT_BEGIN_NAMESPACE
# if FMT_USE_INLINE_NAMESPACES
2019-01-13 02:27:38 +00:00
# define FMT_INLINE_NAMESPACE inline namespace
# define FMT_END_NAMESPACE \
} \
}
# else
# define FMT_INLINE_NAMESPACE namespace
# define FMT_END_NAMESPACE \
} \
2020-07-06 16:47:27 +00:00
using namespace v7; \
2019-01-13 02:27:38 +00:00
}
# endif
# define FMT_BEGIN_NAMESPACE \
namespace fmt { \
2020-07-06 16:47:27 +00:00
FMT_INLINE_NAMESPACE v7 {
2018-05-12 15:33:51 +00:00
#endif
#ifndef FMT_MODULE_EXPORT
# define FMT_MODULE_EXPORT
# define FMT_MODULE_EXPORT_BEGIN
# define FMT_MODULE_EXPORT_END
2021-05-16 14:08:49 +00:00
# define FMT_BEGIN_DETAIL_NAMESPACE namespace detail {
# define FMT_END_DETAIL_NAMESPACE }
#endif
#if !defined(FMT_HEADER_ONLY) && defined(_WIN32)
2020-11-12 00:16:33 +00:00
# define FMT_CLASS_API FMT_MSC_WARNING(suppress : 4275)
2019-01-13 02:27:38 +00:00
# ifdef FMT_EXPORT
# define FMT_API __declspec(dllexport)
2019-01-13 02:27:38 +00:00
# elif defined(FMT_SHARED)
# define FMT_API __declspec(dllimport)
2019-01-13 02:27:38 +00:00
# endif
2020-04-11 13:17:31 +00:00
#else
# define FMT_CLASS_API
#endif
#ifndef FMT_API
2020-06-26 17:21:14 +00:00
# define FMT_API
#endif
2021-05-06 14:37:40 +00:00
#if FMT_GCC_VERSION
# define FMT_GCC_VISIBILITY_HIDDEN __attribute__((visibility("hidden")))
#else
# define FMT_GCC_VISIBILITY_HIDDEN
#endif
2018-03-26 17:00:41 +00:00
// libc++ supports string_view in pre-c++17.
2019-01-13 02:27:38 +00:00
#if (FMT_HAS_INCLUDE(<string_view>) && \
(__cplusplus > 201402L || defined(_LIBCPP_VERSION))) || \
(defined(_MSVC_LANG) && _MSVC_LANG > 201402L && _MSC_VER >= 1910)
2019-01-13 02:27:38 +00:00
# include <string_view>
2019-05-31 03:50:07 +00:00
# define FMT_USE_STRING_VIEW
2019-05-30 18:46:31 +00:00
#elif FMT_HAS_INCLUDE("experimental/string_view") && __cplusplus >= 201402L
2019-01-13 02:27:38 +00:00
# include <experimental/string_view>
2019-05-31 03:50:07 +00:00
# define FMT_USE_EXPERIMENTAL_STRING_VIEW
#endif
2019-12-22 16:58:00 +00:00
#ifndef FMT_UNICODE
2020-03-22 14:57:56 +00:00
# define FMT_UNICODE !FMT_MSC_VER
2019-12-22 16:58:00 +00:00
#endif
#ifndef FMT_COMPILE_TIME_CHECKS
# define FMT_COMPILE_TIME_CHECKS 0
#endif
#ifndef FMT_USE_NONTYPE_TEMPLATE_PARAMETERS
# if defined(__cpp_nontype_template_args) && \
((FMT_GCC_VERSION >= 903 && __cplusplus >= 201709L) || \
__cpp_nontype_template_args >= 201911L)
# define FMT_USE_NONTYPE_TEMPLATE_PARAMETERS 1
# else
# define FMT_USE_NONTYPE_TEMPLATE_PARAMETERS 0
# endif
#endif
// Enable minimal optimizations for more compact code in debug mode.
FMT_GCC_PRAGMA("GCC push_options")
#ifndef __OPTIMIZE__
FMT_GCC_PRAGMA("GCC optimize(\"Og\")")
#endif
2018-05-12 15:33:51 +00:00
FMT_BEGIN_NAMESPACE
2021-04-17 08:20:23 +00:00
FMT_MODULE_EXPORT_BEGIN
// Implementations of enable_if_t and other metafunctions for older systems.
template <bool B, class T = void>
using enable_if_t = typename std::enable_if<B, T>::type;
2019-06-05 01:50:30 +00:00
template <bool B, class T, class F>
using conditional_t = typename std::conditional<B, T, F>::type;
2019-06-05 13:46:40 +00:00
template <bool B> using bool_constant = std::integral_constant<bool, B>;
2019-06-12 03:28:05 +00:00
template <typename T>
using remove_reference_t = typename std::remove_reference<T>::type;
template <typename T>
using remove_const_t = typename std::remove_const<T>::type;
template <typename T>
using remove_cvref_t = typename std::remove_cv<remove_reference_t<T>>::type;
template <typename T> struct type_identity { using type = T; };
template <typename T> using type_identity_t = typename type_identity<T>::type;
2019-06-11 01:10:26 +00:00
struct monostate {};
// An enable_if helper to be used in template parameters which results in much
// shorter symbols: https://godbolt.org/z/sWw4vP. Extra parentheses are needed
// to workaround a bug in MSVC 2019 (see #1140 and #1186).
#ifdef FMT_DOC
# define FMT_ENABLE_IF(...)
#else
# define FMT_ENABLE_IF(...) enable_if_t<(__VA_ARGS__), int> = 0
#endif
FMT_BEGIN_DETAIL_NAMESPACE
2018-06-27 12:31:20 +00:00
2021-04-01 17:42:09 +00:00
constexpr FMT_INLINE bool is_constant_evaluated() FMT_NOEXCEPT {
#ifdef __cpp_lib_is_constant_evaluated
return std::is_constant_evaluated();
#else
return false;
#endif
}
2021-05-16 14:18:04 +00:00
// A function to suppress "conditional expression is constant" warnings.
2020-05-03 03:35:46 +00:00
template <typename T> constexpr T const_check(T value) { return value; }
FMT_NORETURN FMT_API void assert_fail(const char* file, int line,
const char* message);
2019-11-29 16:04:47 +00:00
#ifndef FMT_ASSERT
# ifdef NDEBUG
// FMT_ASSERT is not empty to avoid -Werror=empty-body.
# define FMT_ASSERT(condition, message) ((void)0)
2019-11-29 16:04:47 +00:00
# else
# define FMT_ASSERT(condition, message) \
((condition) /* void() fails with -Winvalid-constexpr on clang 4.0.1 */ \
? (void)0 \
2020-05-10 14:25:42 +00:00
: ::fmt::detail::assert_fail(__FILE__, __LINE__, (message)))
2019-11-29 16:04:47 +00:00
# endif
#endif
2019-05-31 03:50:07 +00:00
#if defined(FMT_USE_STRING_VIEW)
template <typename Char> using std_string_view = std::basic_string_view<Char>;
#elif defined(FMT_USE_EXPERIMENTAL_STRING_VIEW)
template <typename Char>
using std_string_view = std::experimental::basic_string_view<Char>;
#else
template <typename T> struct std_string_view {};
#endif
#ifdef FMT_USE_INT128
// Do nothing.
#elif defined(__SIZEOF_INT128__) && !FMT_NVCC && \
!(FMT_CLANG_VERSION && FMT_MSC_VER)
# define FMT_USE_INT128 1
using int128_t = __int128_t;
using uint128_t = __uint128_t;
#else
# define FMT_USE_INT128 0
#endif
#if !FMT_USE_INT128
2021-05-16 14:18:04 +00:00
enum class int128_t {};
enum class uint128_t {};
inline monostate operator+(int128_t) { return {}; }
inline monostate operator+(uint128_t) { return {}; }
#endif
2019-09-08 00:07:53 +00:00
// Casts a nonnegative integer to unsigned.
2018-06-27 12:31:20 +00:00
template <typename Int>
FMT_CONSTEXPR typename std::make_unsigned<Int>::type to_unsigned(Int value) {
FMT_ASSERT(value >= 0, "negative value");
return static_cast<typename std::make_unsigned<Int>::type>(value);
}
2020-03-14 17:32:34 +00:00
2020-11-12 00:16:33 +00:00
FMT_MSC_WARNING(suppress : 4566) constexpr unsigned char micro[] = "\u00B5";
2020-03-22 14:57:56 +00:00
2020-03-28 13:31:38 +00:00
template <typename Char> constexpr bool is_unicode() {
return FMT_UNICODE || sizeof(Char) != 1 ||
2020-03-22 14:57:56 +00:00
(sizeof(micro) == 3 && micro[0] == 0xC2 && micro[1] == 0xB5);
}
FMT_END_DETAIL_NAMESPACE
2020-05-10 14:25:42 +00:00
/**
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).
*/
2019-01-13 02:27:38 +00:00
template <typename Char> class basic_string_view {
private:
2019-01-13 02:27:38 +00:00
const Char* data_;
size_t size_;
public:
using value_type = Char;
using iterator = const Char*;
2020-05-03 03:35:46 +00:00
constexpr basic_string_view() FMT_NOEXCEPT : data_(nullptr), size_(0) {}
/** Constructs a string reference object from a C string and a size. */
2020-05-03 03:35:46 +00:00
constexpr basic_string_view(const Char* s, size_t count) FMT_NOEXCEPT
2019-01-13 02:27:38 +00:00
: data_(s),
size_(count) {}
/**
\rst
Constructs a string reference object from a C string computing
the size with ``std::char_traits<Char>::length``.
\endrst
*/
FMT_CONSTEXPR_CHAR_TRAITS
2021-04-23 13:52:10 +00:00
FMT_INLINE
basic_string_view(const Char* s) : data_(s) {
if (detail::const_check(std::is_same<Char, char>::value &&
!detail::is_constant_evaluated()))
size_ = std::strlen(reinterpret_cast<const char*>(s));
else
size_ = std::char_traits<Char>::length(s);
}
2018-05-16 15:19:26 +00:00
/** Constructs a string reference from a ``std::basic_string`` object. */
template <typename Traits, typename Alloc>
FMT_CONSTEXPR basic_string_view(
const std::basic_string<Char, Traits, Alloc>& s) FMT_NOEXCEPT
: data_(s.data()),
size_(s.size()) {}
2020-05-10 14:25:42 +00:00
template <typename S, FMT_ENABLE_IF(std::is_same<
S, detail::std_string_view<Char>>::value)>
2019-05-31 03:50:07 +00:00
FMT_CONSTEXPR basic_string_view(S s) FMT_NOEXCEPT : data_(s.data()),
size_(s.size()) {}
/** Returns a pointer to the string data. */
2020-05-03 03:35:46 +00:00
constexpr const Char* data() const { return data_; }
/** Returns the string size. */
2020-05-03 03:35:46 +00:00
constexpr size_t size() const { return size_; }
2020-05-03 03:35:46 +00:00
constexpr iterator begin() const { return data_; }
constexpr iterator end() const { return data_ + size_; }
2020-05-03 03:35:46 +00:00
constexpr const Char& operator[](size_t pos) const { return data_[pos]; }
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR void remove_prefix(size_t n) {
data_ += n;
size_ -= n;
}
// Lexicographically compare this string reference to other.
FMT_CONSTEXPR_CHAR_TRAITS int compare(basic_string_view other) const {
2018-06-10 20:58:10 +00:00
size_t str_size = size_ < other.size_ ? size_ : other.size_;
int result = std::char_traits<Char>::compare(data_, other.data_, str_size);
if (result == 0)
result = size_ == other.size_ ? 0 : (size_ < other.size_ ? -1 : 1);
return result;
}
FMT_CONSTEXPR_CHAR_TRAITS 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;
}
};
using string_view = basic_string_view<char>;
using wstring_view = basic_string_view<wchar_t>;
/** Specifies if ``T`` is a character type. Can be specialized by users. */
2019-06-05 00:08:58 +00:00
template <typename T> struct is_char : std::false_type {};
template <> struct is_char<char> : std::true_type {};
template <> struct is_char<wchar_t> : std::true_type {};
/**
\rst
Returns a string view of `s`. In order to add custom string type support to
{fmt} provide an overload of `to_string_view` for it in the same namespace as
the type for the argument-dependent lookup to work.
**Example**::
namespace my_ns {
inline string_view to_string_view(const my_string& s) {
2018-12-24 18:02:41 +00:00
return {s.data(), s.length()};
}
}
std::string message = fmt::format(my_string("The answer is {}"), 42);
\endrst
*/
template <typename Char, FMT_ENABLE_IF(is_char<Char>::value)>
FMT_INLINE basic_string_view<Char> to_string_view(const Char* s) {
return s;
}
template <typename Char, typename Traits, typename Alloc>
2019-01-13 02:27:38 +00:00
inline basic_string_view<Char> to_string_view(
const std::basic_string<Char, Traits, Alloc>& s) {
return s;
}
template <typename Char>
constexpr basic_string_view<Char> to_string_view(basic_string_view<Char> s) {
return s;
}
2019-05-31 03:50:07 +00:00
template <typename Char,
2020-05-10 14:25:42 +00:00
FMT_ENABLE_IF(!std::is_empty<detail::std_string_view<Char>>::value)>
inline basic_string_view<Char> to_string_view(detail::std_string_view<Char> s) {
2019-01-13 02:27:38 +00:00
return s;
}
// 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_STRING("{}"), 42).
struct compile_string {};
template <typename S>
struct is_compile_string : std::is_base_of<compile_string, S> {};
2019-03-16 19:58:18 +00:00
template <typename S, FMT_ENABLE_IF(is_compile_string<S>::value)>
2019-06-08 00:30:18 +00:00
constexpr basic_string_view<typename S::char_type> to_string_view(const S& s) {
2019-01-13 02:27:38 +00:00
return s;
}
FMT_BEGIN_DETAIL_NAMESPACE
2019-06-05 15:41:00 +00:00
void to_string_view(...);
2020-07-06 16:47:27 +00:00
using fmt::v7::to_string_view;
2019-06-05 13:46:40 +00:00
// Specifies whether S is a string type convertible to fmt::basic_string_view.
// It should be a constexpr function but MSVC 2017 fails to compile it in
2019-06-05 15:41:00 +00:00
// enable_if and MSVC 2015 fails to compile it as an alias template.
2019-06-05 13:46:40 +00:00
template <typename S>
2019-06-05 15:41:00 +00:00
struct is_string : std::is_class<decltype(to_string_view(std::declval<S>()))> {
2019-06-05 13:46:40 +00:00
};
2019-06-05 15:53:23 +00:00
template <typename S, typename = void> struct char_t_impl {};
template <typename S> struct char_t_impl<S, enable_if_t<is_string<S>::value>> {
using result = decltype(to_string_view(std::declval<S>()));
using type = typename result::value_type;
2019-06-05 15:53:23 +00:00
};
// Reports a compile-time error if S is not a valid format string.
template <typename..., typename S, FMT_ENABLE_IF(!is_compile_string<S>::value)>
FMT_INLINE void check_format_string(const S&) {
#ifdef FMT_ENFORCE_COMPILE_STRING
static_assert(is_compile_string<S>::value,
"FMT_ENFORCE_COMPILE_STRING requires all format strings to use "
"FMT_STRING.");
#endif
}
template <typename..., typename S, FMT_ENABLE_IF(is_compile_string<S>::value)>
void check_format_string(S);
2019-06-05 13:46:40 +00:00
struct error_handler {
2020-05-03 03:35:46 +00:00
constexpr error_handler() = default;
constexpr error_handler(const error_handler&) = default;
2019-06-05 13:46:40 +00:00
// This function is intentionally not constexpr to give a compile-time error.
FMT_NORETURN FMT_API void on_error(const char* message);
2019-06-05 13:46:40 +00:00
};
FMT_END_DETAIL_NAMESPACE
2019-06-05 13:46:40 +00:00
2019-06-05 15:53:23 +00:00
/** String's character type. */
2020-05-10 14:25:42 +00:00
template <typename S> using char_t = typename detail::char_t_impl<S>::type;
2019-06-05 15:53:23 +00:00
/**
2019-11-06 15:16:02 +00:00
\rst
Parsing context consisting of a format string range being parsed and an
argument counter for automatic indexing.
You can use one of the following type aliases for common character types:
+-----------------------+-------------------------------------+
| Type | Definition |
+=======================+=====================================+
| format_parse_context | basic_format_parse_context<char> |
+-----------------------+-------------------------------------+
| wformat_parse_context | basic_format_parse_context<wchar_t> |
+-----------------------+-------------------------------------+
2019-11-06 15:16:02 +00:00
\endrst
*/
2020-05-10 14:25:42 +00:00
template <typename Char, typename ErrorHandler = detail::error_handler>
class basic_format_parse_context : private ErrorHandler {
private:
basic_string_view<Char> format_str_;
int next_arg_id_;
public:
using char_type = Char;
using iterator = typename basic_string_view<Char>::iterator;
2020-05-03 03:35:46 +00:00
explicit constexpr basic_format_parse_context(
basic_string_view<Char> format_str, ErrorHandler eh = {},
int next_arg_id = 0)
: ErrorHandler(eh), format_str_(format_str), next_arg_id_(next_arg_id) {}
/**
Returns an iterator to the beginning of the format string range being
parsed.
*/
2020-05-03 03:35:46 +00:00
constexpr iterator begin() const FMT_NOEXCEPT { return format_str_.begin(); }
/**
Returns an iterator past the end of the format string range being parsed.
*/
2020-05-03 03:35:46 +00:00
constexpr iterator end() const FMT_NOEXCEPT { return format_str_.end(); }
/** Advances the begin iterator to ``it``. */
FMT_CONSTEXPR void advance_to(iterator it) {
2020-05-10 14:25:42 +00:00
format_str_.remove_prefix(detail::to_unsigned(it - begin()));
}
/**
Reports an error if using the manual argument indexing; otherwise returns
the next argument index and switches to the automatic indexing.
*/
2019-07-17 19:07:05 +00:00
FMT_CONSTEXPR int next_arg_id() {
2020-04-25 17:02:00 +00:00
// Don't check if the argument id is valid to avoid overhead and because it
// will be checked during formatting anyway.
if (next_arg_id_ >= 0) return next_arg_id_++;
2019-06-07 20:58:11 +00:00
on_error("cannot switch from manual to automatic argument indexing");
return 0;
}
/**
Reports an error if using the automatic argument indexing; otherwise
switches to the manual indexing.
*/
FMT_CONSTEXPR void check_arg_id(int) {
if (next_arg_id_ > 0)
on_error("cannot switch from automatic to manual argument indexing");
else
next_arg_id_ = -1;
}
FMT_CONSTEXPR void check_arg_id(basic_string_view<Char>) {}
FMT_CONSTEXPR void on_error(const char* message) {
ErrorHandler::on_error(message);
}
2020-05-03 03:35:46 +00:00
constexpr ErrorHandler error_handler() const { return *this; }
};
using format_parse_context = basic_format_parse_context<char>;
using wformat_parse_context = basic_format_parse_context<wchar_t>;
2019-01-13 02:27:38 +00:00
template <typename Context> class basic_format_arg;
template <typename Context> class basic_format_args;
template <typename Context> class dynamic_format_arg_store;
2018-01-14 20:25:03 +00:00
// A formatter for objects of type T.
template <typename T, typename Char = char, typename Enable = void>
struct formatter {
2019-06-07 14:08:04 +00:00
// A deleted default constructor indicates a disabled formatter.
formatter() = delete;
};
2018-01-14 20:25:03 +00:00
2021-04-24 00:11:01 +00:00
// DEPRECATED!
2019-06-07 14:08:04 +00:00
// Specifies if T has an enabled formatter specialization. A type can be
// formattable even if it doesn't have a formatter e.g. via a conversion.
2019-06-07 13:51:21 +00:00
template <typename T, typename Context>
using has_formatter =
std::is_constructible<typename Context::template formatter_type<T>>;
2020-07-18 13:44:44 +00:00
// Checks whether T is a container with contiguous storage.
template <typename T> struct is_contiguous : std::false_type {};
template <typename Char>
struct is_contiguous<std::basic_string<Char>> : std::true_type {};
FMT_BEGIN_DETAIL_NAMESPACE
2020-07-18 13:44:44 +00:00
// Extracts a reference to the container from back_insert_iterator.
template <typename Container>
inline Container& get_container(std::back_insert_iterator<Container> it) {
using bi_iterator = std::back_insert_iterator<Container>;
struct accessor : bi_iterator {
accessor(bi_iterator iter) : bi_iterator(iter) {}
using bi_iterator::container;
};
return *accessor(it).container;
}
/**
\rst
A contiguous memory buffer with an optional growing ability. It is an internal
class and shouldn't be used directly, only via `~fmt::basic_memory_buffer`.
\endrst
*/
2019-06-05 13:46:40 +00:00
template <typename T> class buffer {
private:
T* ptr_;
2020-05-07 22:59:46 +00:00
size_t size_;
size_t capacity_;
2019-06-05 13:46:40 +00:00
protected:
// Don't initialize ptr_ since it is not accessed to save a few cycles.
2020-11-12 00:16:33 +00:00
FMT_MSC_WARNING(suppress : 26495)
2020-07-10 14:50:37 +00:00
buffer(size_t sz) FMT_NOEXCEPT : size_(sz), capacity_(sz) {}
2019-06-05 13:46:40 +00:00
2020-07-10 14:50:37 +00:00
buffer(T* p = nullptr, size_t sz = 0, size_t cap = 0) FMT_NOEXCEPT
: ptr_(p),
size_(sz),
capacity_(cap) {}
~buffer() = default;
2019-06-05 13:46:40 +00:00
/** Sets the buffer data and capacity. */
2020-05-07 22:59:46 +00:00
void set(T* buf_data, size_t buf_capacity) FMT_NOEXCEPT {
2019-06-05 13:46:40 +00:00
ptr_ = buf_data;
capacity_ = buf_capacity;
}
/** Increases the buffer capacity to hold at least *capacity* elements. */
2020-05-07 22:59:46 +00:00
virtual void grow(size_t capacity) = 0;
2019-06-05 13:46:40 +00:00
public:
using value_type = T;
using const_reference = const T&;
buffer(const buffer&) = delete;
void operator=(const buffer&) = delete;
2019-06-05 13:46:40 +00:00
T* begin() FMT_NOEXCEPT { return ptr_; }
T* end() FMT_NOEXCEPT { return ptr_ + size_; }
const T* begin() const FMT_NOEXCEPT { return ptr_; }
const T* end() const FMT_NOEXCEPT { return ptr_ + size_; }
2019-06-05 13:46:40 +00:00
/** Returns the size of this buffer. */
2020-05-07 22:59:46 +00:00
size_t size() const FMT_NOEXCEPT { return size_; }
2019-06-05 13:46:40 +00:00
/** Returns the capacity of this buffer. */
2020-05-07 22:59:46 +00:00
size_t capacity() const FMT_NOEXCEPT { return capacity_; }
2019-06-05 13:46:40 +00:00
/** 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_; }
/** Clears this buffer. */
void clear() { size_ = 0; }
2020-07-10 14:50:37 +00:00
// Tries resizing the buffer to contain *count* elements. If T is a POD type
// the new elements may not be initialized.
void try_resize(size_t count) {
try_reserve(count);
size_ = count <= capacity_ ? count : capacity_;
}
// Tries increasing the buffer capacity to *new_capacity*. It can increase the
// capacity by a smaller amount than requested but guarantees there is space
// for at least one additional element either by increasing the capacity or by
// flushing the buffer if it is full.
void try_reserve(size_t new_capacity) {
2019-06-05 13:46:40 +00:00
if (new_capacity > capacity_) grow(new_capacity);
}
void push_back(const T& value) {
2020-07-10 14:50:37 +00:00
try_reserve(size_ + 1);
2019-06-05 13:46:40 +00:00
ptr_[size_++] = value;
}
/** Appends data to the end of the buffer. */
template <typename U> void append(const U* begin, const U* end);
2020-03-25 14:08:14 +00:00
template <typename I> T& operator[](I index) { return ptr_[index]; }
template <typename I> const T& operator[](I index) const {
return ptr_[index];
}
2019-06-05 13:46:40 +00:00
};
2020-07-24 15:28:23 +00:00
struct buffer_traits {
explicit buffer_traits(size_t) {}
size_t count() const { return 0; }
size_t limit(size_t size) { return size; }
};
class fixed_buffer_traits {
2020-07-17 18:21:11 +00:00
private:
2020-07-24 15:28:23 +00:00
size_t count_ = 0;
size_t limit_;
public:
explicit fixed_buffer_traits(size_t limit) : limit_(limit) {}
size_t count() const { return count_; }
size_t limit(size_t size) {
2020-11-18 14:43:47 +00:00
size_t n = limit_ > count_ ? limit_ - count_ : 0;
2020-07-24 15:28:23 +00:00
count_ += size;
return size < n ? size : n;
}
};
2020-07-17 18:21:11 +00:00
2020-07-24 15:28:23 +00:00
// A buffer that writes to an output iterator when flushed.
template <typename OutputIt, typename T, typename Traits = buffer_traits>
class iterator_buffer final : public Traits, public buffer<T> {
2020-07-24 15:28:23 +00:00
private:
2020-07-17 18:21:11 +00:00
OutputIt out_;
2020-07-24 15:28:23 +00:00
enum { buffer_size = 256 };
2020-07-17 18:21:11 +00:00
T data_[buffer_size];
protected:
2020-08-08 14:23:11 +00:00
void grow(size_t) final FMT_OVERRIDE {
2020-07-17 18:21:11 +00:00
if (this->size() == buffer_size) flush();
}
2020-07-18 13:44:44 +00:00
void flush();
2020-07-17 18:21:11 +00:00
public:
explicit iterator_buffer(OutputIt out, size_t n = buffer_size)
2020-11-11 16:31:34 +00:00
: Traits(n), buffer<T>(data_, 0, buffer_size), out_(out) {}
2020-07-17 18:21:11 +00:00
~iterator_buffer() { flush(); }
2020-07-18 13:44:44 +00:00
OutputIt out() {
flush();
return out_;
}
2020-07-24 15:28:23 +00:00
size_t count() const { return Traits::count() + this->size(); }
2020-07-17 18:21:11 +00:00
};
template <typename T> class iterator_buffer<T*, T> final : public buffer<T> {
2020-07-17 18:21:11 +00:00
protected:
2020-08-08 14:23:11 +00:00
void grow(size_t) final FMT_OVERRIDE {}
2020-07-17 18:21:11 +00:00
public:
2020-07-24 15:28:23 +00:00
explicit iterator_buffer(T* out, size_t = 0) : buffer<T>(out, 0, ~size_t()) {}
2020-07-17 18:21:11 +00:00
T* out() { return &*this->end(); }
};
2020-07-18 13:44:44 +00:00
// A buffer that writes to a container with the contiguous storage.
template <typename Container>
class iterator_buffer<std::back_insert_iterator<Container>,
enable_if_t<is_contiguous<Container>::value,
2020-10-20 20:35:31 +00:00
typename Container::value_type>>
final : public buffer<typename Container::value_type> {
2020-07-18 13:44:44 +00:00
private:
Container& container_;
protected:
2020-08-08 14:23:11 +00:00
void grow(size_t capacity) final FMT_OVERRIDE {
2020-07-18 13:44:44 +00:00
container_.resize(capacity);
this->set(&container_[0], capacity);
}
public:
explicit iterator_buffer(Container& c)
: buffer<typename Container::value_type>(c.size()), container_(c) {}
2020-07-24 15:28:23 +00:00
explicit iterator_buffer(std::back_insert_iterator<Container> out, size_t = 0)
2020-07-18 13:44:44 +00:00
: iterator_buffer(get_container(out)) {}
std::back_insert_iterator<Container> out() {
return std::back_inserter(container_);
}
};
// A buffer that counts the number of code units written discarding the output.
template <typename T = char> class counting_buffer final : public buffer<T> {
private:
enum { buffer_size = 256 };
T data_[buffer_size];
size_t count_ = 0;
protected:
2020-08-08 14:23:11 +00:00
void grow(size_t) final FMT_OVERRIDE {
if (this->size() != buffer_size) return;
count_ += this->size();
this->clear();
}
public:
counting_buffer() : buffer<T>(data_, 0, buffer_size) {}
size_t count() { return count_ + this->size(); }
};
2020-07-18 13:44:44 +00:00
// An output iterator that appends to the buffer.
// It is used to reduce symbol sizes for the common case.
template <typename T>
class buffer_appender : public std::back_insert_iterator<buffer<T>> {
using base = std::back_insert_iterator<buffer<T>>;
2020-09-07 21:43:00 +00:00
public:
using std::back_insert_iterator<buffer<T>>::back_insert_iterator;
2020-09-07 21:43:00 +00:00
buffer_appender(base it) : base(it) {}
2021-04-27 18:47:47 +00:00
using _Unchecked_type = buffer_appender; // Mark iterator as checked.
buffer_appender& operator++() {
base::operator++();
return *this;
}
buffer_appender operator++(int) {
buffer_appender tmp = *this;
++*this;
return tmp;
}
};
2020-07-18 13:44:44 +00:00
// Maps an output iterator into a buffer.
template <typename T, typename OutputIt>
iterator_buffer<OutputIt, T> get_buffer(OutputIt);
template <typename T> buffer<T>& get_buffer(buffer_appender<T>);
template <typename OutputIt> OutputIt get_buffer_init(OutputIt out) {
return out;
}
template <typename T> buffer<T>& get_buffer_init(buffer_appender<T> out) {
return get_container(out);
}
template <typename Buffer>
auto get_iterator(Buffer& buf) -> decltype(buf.out()) {
return buf.out();
}
template <typename T> buffer_appender<T> get_iterator(buffer<T>& buf) {
return buffer_appender<T>(buf);
2019-06-05 13:46:40 +00:00
}
template <typename T, typename Char = char, typename Enable = void>
struct fallback_formatter {
2019-06-07 14:08:04 +00:00
fallback_formatter() = delete;
};
2019-06-07 14:08:04 +00:00
// Specifies if T has an enabled fallback_formatter specialization.
2021-05-05 13:29:51 +00:00
template <typename T, typename Char>
2019-06-07 14:08:04 +00:00
using has_fallback_formatter =
2021-05-05 13:29:51 +00:00
std::is_constructible<fallback_formatter<T, Char>>;
2019-06-07 14:08:04 +00:00
2020-05-09 23:38:37 +00:00
struct view {};
2020-05-10 14:25:42 +00:00
template <typename Char, typename T> struct named_arg : view {
2020-05-09 23:38:37 +00:00
const Char* name;
const T& value;
named_arg(const Char* n, const T& v) : name(n), value(v) {}
};
2020-04-11 16:55:21 +00:00
template <typename Char> struct named_arg_info {
const Char* name;
2020-04-14 13:48:55 +00:00
int id;
2020-04-11 16:55:21 +00:00
};
template <typename T, typename Char, size_t NUM_ARGS, size_t NUM_NAMED_ARGS>
struct arg_data {
2020-04-15 13:28:41 +00:00
// args_[0].named_args points to named_args_ to avoid bloating format_args.
// +1 to workaround a bug in gcc 7.5 that causes duplicated-branches warning.
T args_[1 + (NUM_ARGS != 0 ? NUM_ARGS : +1)];
2020-04-14 13:48:55 +00:00
named_arg_info<Char> named_args_[NUM_NAMED_ARGS];
template <typename... U>
arg_data(const U&... init) : args_{T(named_args_, NUM_NAMED_ARGS), init...} {}
arg_data(const arg_data& other) = delete;
const T* args() const { return args_ + 1; }
named_arg_info<Char>* named_args() { return named_args_; }
2020-04-11 16:55:21 +00:00
};
template <typename T, typename Char, size_t NUM_ARGS>
struct arg_data<T, Char, NUM_ARGS, 0> {
// +1 to workaround a bug in gcc 7.5 that causes duplicated-branches warning.
T args_[NUM_ARGS != 0 ? NUM_ARGS : +1];
2020-04-11 16:55:21 +00:00
2020-04-19 15:12:27 +00:00
template <typename... U>
FMT_CONSTEXPR FMT_INLINE arg_data(const U&... init) : args_{init...} {}
FMT_CONSTEXPR FMT_INLINE const T* args() const { return args_; }
FMT_CONSTEXPR FMT_INLINE std::nullptr_t named_args() { return nullptr; }
2020-04-14 13:48:55 +00:00
};
2020-04-11 16:55:21 +00:00
template <typename Char>
inline void init_named_args(named_arg_info<Char>*, int, int) {}
template <typename T> struct is_named_arg : std::false_type {};
template <typename T> struct is_statically_named_arg : std::false_type {};
template <typename T, typename Char>
struct is_named_arg<named_arg<Char, T>> : std::true_type {};
template <typename Char, typename T, typename... Tail,
FMT_ENABLE_IF(!is_named_arg<T>::value)>
2020-04-11 16:55:21 +00:00
void init_named_args(named_arg_info<Char>* named_args, int arg_count,
int named_arg_count, const T&, const Tail&... args) {
init_named_args(named_args, arg_count + 1, named_arg_count, args...);
}
template <typename Char, typename T, typename... Tail,
FMT_ENABLE_IF(is_named_arg<T>::value)>
2020-04-11 16:55:21 +00:00
void init_named_args(named_arg_info<Char>* named_args, int arg_count,
int named_arg_count, const T& arg, const Tail&... args) {
named_args[named_arg_count++] = {arg.name, arg_count};
2020-04-11 16:55:21 +00:00
init_named_args(named_args, arg_count + 1, named_arg_count, args...);
}
template <typename... Args>
FMT_CONSTEXPR FMT_INLINE void init_named_args(std::nullptr_t, int, int,
const Args&...) {}
2020-04-11 16:55:21 +00:00
template <bool B = false> constexpr size_t count() { return B ? 1 : 0; }
template <bool B1, bool B2, bool... Tail> constexpr size_t count() {
return (B1 ? 1 : 0) + count<B2, Tail...>();
}
template <typename... Args> constexpr size_t count_named_args() {
return count<is_named_arg<Args>::value...>();
}
2019-12-21 17:31:14 +00:00
enum class type {
2019-01-13 02:27:38 +00:00
none_type,
// Integer types should go first,
2019-01-13 02:27:38 +00:00
int_type,
uint_type,
long_long_type,
ulong_long_type,
int128_type,
uint128_type,
2019-01-13 02:27:38 +00:00
bool_type,
char_type,
last_integer_type = char_type,
// followed by floating-point types.
2019-10-12 02:47:59 +00:00
float_type,
2019-01-13 02:27:38 +00:00
double_type,
long_double_type,
last_numeric_type = long_double_type,
cstring_type,
string_type,
pointer_type,
custom_type
};
// Maps core type T to the corresponding type enum constant.
template <typename T, typename Char>
2019-12-21 17:31:14 +00:00
struct type_constant : std::integral_constant<type, type::custom_type> {};
#define FMT_TYPE_CONSTANT(Type, constant) \
template <typename Char> \
2019-12-21 21:10:45 +00:00
struct type_constant<Type, Char> \
: std::integral_constant<type, type::constant> {}
FMT_TYPE_CONSTANT(int, int_type);
FMT_TYPE_CONSTANT(unsigned, uint_type);
FMT_TYPE_CONSTANT(long long, long_long_type);
FMT_TYPE_CONSTANT(unsigned long long, ulong_long_type);
FMT_TYPE_CONSTANT(int128_t, int128_type);
FMT_TYPE_CONSTANT(uint128_t, uint128_type);
FMT_TYPE_CONSTANT(bool, bool_type);
FMT_TYPE_CONSTANT(Char, char_type);
2019-10-12 02:47:59 +00:00
FMT_TYPE_CONSTANT(float, float_type);
FMT_TYPE_CONSTANT(double, double_type);
FMT_TYPE_CONSTANT(long double, long_double_type);
FMT_TYPE_CONSTANT(const Char*, cstring_type);
FMT_TYPE_CONSTANT(basic_string_view<Char>, string_type);
FMT_TYPE_CONSTANT(const void*, pointer_type);
2020-05-03 03:35:46 +00:00
constexpr bool is_integral_type(type t) {
2019-12-21 17:31:14 +00:00
return t > type::none_type && t <= type::last_integer_type;
}
2020-05-03 03:35:46 +00:00
constexpr bool is_arithmetic_type(type t) {
2019-12-21 17:31:14 +00:00
return t > type::none_type && t <= type::last_numeric_type;
}
2019-01-13 02:27:38 +00:00
template <typename Char> struct string_value {
2019-06-10 14:58:00 +00:00
const Char* data;
2020-05-07 22:59:46 +00:00
size_t size;
};
2020-04-14 13:48:55 +00:00
template <typename Char> struct named_arg_value {
const named_arg_info<Char>* data;
2020-05-07 22:59:46 +00:00
size_t size;
2020-04-14 13:48:55 +00:00
};
2019-01-13 02:27:38 +00:00
template <typename Context> struct custom_value {
2020-05-06 03:00:31 +00:00
using parse_context = typename Context::parse_context_type;
2019-01-13 02:27:38 +00:00
const void* value;
2020-05-06 03:00:31 +00:00
void (*format)(const void* arg, parse_context& parse_ctx, Context& ctx);
};
// A formatting argument value.
2019-01-13 02:27:38 +00:00
template <typename Context> class value {
public:
using char_type = typename Context::char_type;
union {
int int_value;
unsigned uint_value;
long long long_long_value;
unsigned long long ulong_long_value;
int128_t int128_value;
uint128_t uint128_value;
2019-06-10 14:58:00 +00:00
bool bool_value;
char_type char_value;
2019-10-12 02:47:59 +00:00
float float_value;
double double_value;
long double long_double_value;
2019-01-13 02:27:38 +00:00
const void* pointer;
string_value<char_type> string;
custom_value<Context> custom;
2020-04-14 13:48:55 +00:00
named_arg_value<char_type> named_args;
};
2020-05-03 03:35:46 +00:00
constexpr FMT_INLINE value(int val = 0) : int_value(val) {}
constexpr FMT_INLINE value(unsigned val) : uint_value(val) {}
constexpr FMT_INLINE value(long long val) : long_long_value(val) {}
constexpr FMT_INLINE value(unsigned long long val) : ulong_long_value(val) {}
2020-04-19 14:41:55 +00:00
FMT_INLINE value(int128_t val) : int128_value(val) {}
FMT_INLINE value(uint128_t val) : uint128_value(val) {}
FMT_INLINE value(float val) : float_value(val) {}
FMT_INLINE value(double val) : double_value(val) {}
FMT_INLINE value(long double val) : long_double_value(val) {}
constexpr FMT_INLINE value(bool val) : bool_value(val) {}
constexpr FMT_INLINE value(char_type val) : char_value(val) {}
FMT_CONSTEXPR FMT_INLINE value(const char_type* val) {
string.data = val;
if (is_constant_evaluated()) string.size = {};
}
FMT_CONSTEXPR FMT_INLINE value(basic_string_view<char_type> val) {
2019-06-10 14:58:00 +00:00
string.data = val.data();
2018-02-03 14:14:10 +00:00
string.size = val.size();
}
2020-04-19 14:41:55 +00:00
FMT_INLINE value(const void* val) : pointer(val) {}
FMT_INLINE value(const named_arg_info<char_type>* args, size_t size)
2020-04-14 13:48:55 +00:00
: named_args{args, size} {}
2020-04-19 14:41:55 +00:00
template <typename T> FMT_INLINE value(const T& val) {
2018-01-14 15:19:23 +00:00
custom.value = &val;
// Get the formatter type through the context to allow different contexts
// have different extension points, e.g. `formatter<T>` for `format` and
// `printf_formatter<T>` for `printf`.
2019-06-08 16:42:11 +00:00
custom.format = format_custom_arg<
2019-06-07 13:51:21 +00:00
T, conditional_t<has_formatter<T, Context>::value,
2019-06-05 01:50:30 +00:00
typename Context::template formatter_type<T>,
2019-06-12 03:36:39 +00:00
fallback_formatter<T, char_type>>>;
}
private:
// Formats an argument of a custom type, such as a user-defined class.
template <typename T, typename Formatter>
2020-04-12 14:38:54 +00:00
static void format_custom_arg(const void* arg,
typename Context::parse_context_type& parse_ctx,
Context& ctx) {
Formatter f;
parse_ctx.advance_to(f.parse(parse_ctx));
2018-01-21 22:30:38 +00:00
ctx.advance_to(f.format(*static_cast<const T*>(arg), ctx));
}
};
2018-02-03 14:14:10 +00:00
template <typename Context, typename T>
2019-01-13 02:27:38 +00:00
FMT_CONSTEXPR basic_format_arg<Context> make_arg(const T& value);
2018-02-03 14:14:10 +00:00
// 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.
2019-06-10 04:10:09 +00:00
enum { long_short = sizeof(long) == sizeof(int) };
using long_type = conditional_t<long_short, int, long long>;
using ulong_type = conditional_t<long_short, unsigned, unsigned long long>;
2018-02-03 14:14:10 +00:00
struct unformattable {};
2019-06-10 04:10:09 +00:00
// Maps formatting arguments to core types.
template <typename Context> struct arg_mapper {
using char_type = typename Context::char_type;
2019-06-06 15:29:16 +00:00
FMT_CONSTEXPR FMT_INLINE int map(signed char val) { return val; }
FMT_CONSTEXPR FMT_INLINE unsigned map(unsigned char val) { return val; }
FMT_CONSTEXPR FMT_INLINE int map(short val) { return val; }
FMT_CONSTEXPR FMT_INLINE unsigned map(unsigned short val) { return val; }
FMT_CONSTEXPR FMT_INLINE int map(int val) { return val; }
FMT_CONSTEXPR FMT_INLINE unsigned map(unsigned val) { return val; }
FMT_CONSTEXPR FMT_INLINE long_type map(long val) { return val; }
FMT_CONSTEXPR FMT_INLINE ulong_type map(unsigned long val) { return val; }
FMT_CONSTEXPR FMT_INLINE long long map(long long val) { return val; }
FMT_CONSTEXPR FMT_INLINE unsigned long long map(unsigned long long val) {
return val;
}
FMT_CONSTEXPR FMT_INLINE int128_t map(int128_t val) { return val; }
FMT_CONSTEXPR FMT_INLINE uint128_t map(uint128_t val) { return val; }
FMT_CONSTEXPR FMT_INLINE bool map(bool val) { return val; }
2019-06-10 04:10:09 +00:00
template <typename T, FMT_ENABLE_IF(is_char<T>::value)>
FMT_CONSTEXPR FMT_INLINE char_type map(T val) {
2019-06-10 04:10:09 +00:00
static_assert(
std::is_same<T, char>::value || std::is_same<T, char_type>::value,
"mixing character types is disallowed");
return val;
}
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR FMT_INLINE float map(float val) { return val; }
FMT_CONSTEXPR FMT_INLINE double map(double val) { return val; }
FMT_CONSTEXPR FMT_INLINE long double map(long double val) { return val; }
2019-06-10 04:10:09 +00:00
FMT_CONSTEXPR FMT_INLINE const char_type* map(char_type* val) { return val; }
FMT_CONSTEXPR FMT_INLINE const char_type* map(const char_type* val) {
return val;
}
2019-06-10 04:10:09 +00:00
template <typename T, FMT_ENABLE_IF(is_string<T>::value)>
FMT_CONSTEXPR FMT_INLINE basic_string_view<char_type> map(const T& val) {
2019-06-10 04:10:09 +00:00
static_assert(std::is_same<char_type, char_t<T>>::value,
"mixing character types is disallowed");
return to_string_view(val);
}
template <typename T,
FMT_ENABLE_IF(
std::is_constructible<basic_string_view<char_type>, T>::value &&
!is_string<T>::value && !has_formatter<T, Context>::value &&
2021-05-05 13:29:51 +00:00
!has_fallback_formatter<T, char_type>::value)>
FMT_CONSTEXPR FMT_INLINE basic_string_view<char_type> map(const T& val) {
2019-06-10 13:54:09 +00:00
return basic_string_view<char_type>(val);
2019-06-10 04:10:09 +00:00
}
2019-10-14 01:31:09 +00:00
template <
typename T,
FMT_ENABLE_IF(
std::is_constructible<std_string_view<char_type>, T>::value &&
!std::is_constructible<basic_string_view<char_type>, T>::value &&
!is_string<T>::value && !has_formatter<T, Context>::value &&
2021-05-05 13:29:51 +00:00
!has_fallback_formatter<T, char_type>::value)>
FMT_CONSTEXPR FMT_INLINE basic_string_view<char_type> map(const T& val) {
return std_string_view<char_type>(val);
}
FMT_CONSTEXPR FMT_INLINE const char* map(const signed char* val) {
2019-06-10 04:10:09 +00:00
static_assert(std::is_same<char_type, char>::value, "invalid string type");
return reinterpret_cast<const char*>(val);
}
FMT_CONSTEXPR FMT_INLINE const char* map(const unsigned char* val) {
2019-06-10 04:10:09 +00:00
static_assert(std::is_same<char_type, char>::value, "invalid string type");
return reinterpret_cast<const char*>(val);
}
FMT_CONSTEXPR FMT_INLINE const char* map(signed char* val) {
const auto* const_val = val;
return map(const_val);
}
FMT_CONSTEXPR FMT_INLINE const char* map(unsigned char* val) {
const auto* const_val = val;
return map(const_val);
}
FMT_CONSTEXPR FMT_INLINE const void* map(void* val) { return val; }
FMT_CONSTEXPR FMT_INLINE const void* map(const void* val) { return val; }
FMT_CONSTEXPR FMT_INLINE const void* map(std::nullptr_t val) { return val; }
2020-10-24 09:25:29 +00:00
// We use SFINAE instead of a const T* parameter to avoid conflicting with
// the C array overload.
template <typename T>
FMT_CONSTEXPR auto map(T) -> enable_if_t<std::is_pointer<T>::value, int> {
2019-06-10 04:10:09 +00:00
// 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.
static_assert(!sizeof(T), "formatting of non-void pointers is disallowed");
return 0;
}
2018-02-03 14:14:10 +00:00
2020-10-24 09:25:29 +00:00
template <typename T, std::size_t N>
FMT_CONSTEXPR FMT_INLINE auto map(const T (&values)[N]) -> const T (&)[N] {
2020-10-24 09:25:29 +00:00
return values;
}
2019-06-10 04:10:09 +00:00
template <typename T,
FMT_ENABLE_IF(std::is_enum<T>::value &&
!has_formatter<T, Context>::value &&
2021-05-05 13:29:51 +00:00
!has_fallback_formatter<T, char_type>::value)>
FMT_CONSTEXPR FMT_INLINE auto map(const T& val)
-> decltype(std::declval<arg_mapper>().map(
static_cast<typename std::underlying_type<T>::type>(val))) {
return map(static_cast<typename std::underlying_type<T>::type>(val));
2019-06-10 04:10:09 +00:00
}
template <typename T,
FMT_ENABLE_IF(!is_string<T>::value && !is_char<T>::value &&
(has_formatter<T, Context>::value ||
2021-05-05 13:29:51 +00:00
has_fallback_formatter<T, char_type>::value))>
FMT_CONSTEXPR FMT_INLINE const T& map(const T& val) {
2019-06-10 04:10:09 +00:00
return val;
}
template <typename T, FMT_ENABLE_IF(is_named_arg<T>::value)>
FMT_CONSTEXPR FMT_INLINE auto map(const T& named_arg)
-> decltype(std::declval<arg_mapper>().map(named_arg.value)) {
return map(named_arg.value);
2019-06-10 04:10:09 +00:00
}
2019-12-13 19:28:09 +00:00
unformattable map(...) { return {}; }
2019-06-10 04:10:09 +00:00
};
2018-02-03 14:14:10 +00:00
2019-06-11 04:21:45 +00:00
// A type constant after applying arg_mapper<Context>.
template <typename T, typename Context>
using mapped_type_constant =
type_constant<decltype(arg_mapper<Context>().map(std::declval<const T&>())),
2019-06-11 04:21:45 +00:00
typename Context::char_type>;
2020-05-09 19:56:35 +00:00
enum { packed_arg_bits = 4 };
// Maximum number of arguments with packed types.
2020-04-14 13:48:55 +00:00
enum { max_packed_args = 62 / packed_arg_bits };
enum : unsigned long long { is_unpacked_bit = 1ULL << 63 };
2020-04-14 13:48:55 +00:00
enum : unsigned long long { has_named_args_bit = 1ULL << 62 };
FMT_END_DETAIL_NAMESPACE
// A formatting argument. It is a trivially copyable/constructible type to
// allow storage in basic_memory_buffer.
2019-01-13 02:27:38 +00:00
template <typename Context> class basic_format_arg {
private:
2020-05-10 14:25:42 +00:00
detail::value<Context> value_;
detail::type type_;
template <typename ContextType, typename T>
2020-05-10 14:25:42 +00:00
friend FMT_CONSTEXPR basic_format_arg<ContextType> detail::make_arg(
2019-01-13 02:27:38 +00:00
const T& value);
template <typename Visitor, typename Ctx>
2019-06-11 01:10:26 +00:00
friend FMT_CONSTEXPR auto visit_format_arg(Visitor&& vis,
const basic_format_arg<Ctx>& arg)
-> decltype(vis(0));
friend class basic_format_args<Context>;
friend class dynamic_format_arg_store<Context>;
using char_type = typename Context::char_type;
2020-04-14 13:48:55 +00:00
template <typename T, typename Char, size_t NUM_ARGS, size_t NUM_NAMED_ARGS>
2020-05-10 14:25:42 +00:00
friend struct detail::arg_data;
2020-04-14 13:48:55 +00:00
2020-05-10 14:25:42 +00:00
basic_format_arg(const detail::named_arg_info<char_type>* args, size_t size)
2020-04-14 13:48:55 +00:00
: value_(args, size) {}
public:
class handle {
public:
2020-05-10 14:25:42 +00:00
explicit handle(detail::custom_value<Context> custom) : custom_(custom) {}
2020-04-12 14:38:54 +00:00
void format(typename Context::parse_context_type& parse_ctx,
Context& ctx) const {
custom_.format(custom_.value, parse_ctx, ctx);
}
private:
2020-05-10 14:25:42 +00:00
detail::custom_value<Context> custom_;
};
2020-05-10 14:25:42 +00:00
constexpr basic_format_arg() : type_(detail::type::none_type) {}
2020-05-03 03:35:46 +00:00
constexpr explicit operator bool() const FMT_NOEXCEPT {
2020-05-10 14:25:42 +00:00
return type_ != detail::type::none_type;
2018-01-06 17:09:50 +00:00
}
2020-05-10 14:25:42 +00:00
detail::type type() const { return type_; }
2020-05-10 14:25:42 +00:00
bool is_integral() const { return detail::is_integral_type(type_); }
bool is_arithmetic() const { return detail::is_arithmetic_type(type_); }
};
/**
\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 <typename Visitor, typename Context>
2021-05-16 14:18:04 +00:00
FMT_CONSTEXPR FMT_INLINE auto visit_format_arg(
2020-06-06 16:02:32 +00:00
Visitor&& vis, const basic_format_arg<Context>& arg) -> decltype(vis(0)) {
switch (arg.type_) {
2020-05-10 14:25:42 +00:00
case detail::type::none_type:
break;
2020-05-10 14:25:42 +00:00
case detail::type::int_type:
return vis(arg.value_.int_value);
2020-05-10 14:25:42 +00:00
case detail::type::uint_type:
return vis(arg.value_.uint_value);
2020-05-10 14:25:42 +00:00
case detail::type::long_long_type:
return vis(arg.value_.long_long_value);
2020-05-10 14:25:42 +00:00
case detail::type::ulong_long_type:
return vis(arg.value_.ulong_long_value);
2020-05-10 14:25:42 +00:00
case detail::type::int128_type:
2021-05-16 14:18:04 +00:00
// + converts fallback to monostate to reduce template instantations.
return vis(+arg.value_.int128_value);
2020-05-10 14:25:42 +00:00
case detail::type::uint128_type:
2021-05-16 14:18:04 +00:00
return vis(+arg.value_.uint128_value);
2020-05-10 14:25:42 +00:00
case detail::type::bool_type:
2019-06-10 14:58:00 +00:00
return vis(arg.value_.bool_value);
2020-05-10 14:25:42 +00:00
case detail::type::char_type:
2019-06-10 14:58:00 +00:00
return vis(arg.value_.char_value);
2020-05-10 14:25:42 +00:00
case detail::type::float_type:
2019-10-12 02:47:59 +00:00
return vis(arg.value_.float_value);
2020-05-10 14:25:42 +00:00
case detail::type::double_type:
return vis(arg.value_.double_value);
2020-05-10 14:25:42 +00:00
case detail::type::long_double_type:
return vis(arg.value_.long_double_value);
2020-05-10 14:25:42 +00:00
case detail::type::cstring_type:
2019-06-10 14:58:00 +00:00
return vis(arg.value_.string.data);
2020-05-10 14:25:42 +00:00
case detail::type::string_type:
2021-05-16 14:18:04 +00:00
using sv = basic_string_view<typename Context::char_type>;
return vis(sv(arg.value_.string.data, arg.value_.string.size));
2020-05-10 14:25:42 +00:00
case detail::type::pointer_type:
return vis(arg.value_.pointer);
2020-05-10 14:25:42 +00:00
case detail::type::custom_type:
return vis(typename basic_format_arg<Context>::handle(arg.value_.custom));
}
return vis(monostate());
}
FMT_BEGIN_DETAIL_NAMESPACE
#if FMT_GCC_VERSION && FMT_GCC_VERSION < 500
2020-07-18 13:44:44 +00:00
// A workaround for gcc 4.8 to make void_t work in a SFINAE context.
template <typename... Ts> struct void_t_impl { using type = void; };
template <typename... Ts>
using void_t = typename detail::void_t_impl<Ts...>::type;
#else
template <typename...> using void_t = void;
#endif
2020-07-18 13:44:44 +00:00
2020-10-20 20:35:31 +00:00
template <typename It, typename T, typename Enable = void>
struct is_output_iterator : std::false_type {};
2020-07-18 13:44:44 +00:00
2020-10-20 20:35:31 +00:00
template <typename It, typename T>
struct is_output_iterator<
It, T,
2020-10-20 23:44:49 +00:00
void_t<typename std::iterator_traits<It>::iterator_category,
2020-10-20 20:35:31 +00:00
decltype(*std::declval<It>() = std::declval<T>())>>
: std::true_type {};
2020-07-18 13:44:44 +00:00
template <typename OutputIt>
struct is_back_insert_iterator : std::false_type {};
template <typename Container>
struct is_back_insert_iterator<std::back_insert_iterator<Container>>
: std::true_type {};
template <typename OutputIt>
struct is_contiguous_back_insert_iterator : std::false_type {};
template <typename Container>
struct is_contiguous_back_insert_iterator<std::back_insert_iterator<Container>>
: is_contiguous<Container> {};
2020-07-17 18:21:11 +00:00
template <typename Char>
struct is_contiguous_back_insert_iterator<buffer_appender<Char>>
: std::true_type {};
2018-11-14 17:39:37 +00:00
// A type-erased reference to an std::locale to avoid heavy <locale> include.
class locale_ref {
private:
2019-01-13 02:27:38 +00:00
const void* locale_; // A type-erased pointer to std::locale.
2018-11-14 17:39:37 +00:00
public:
constexpr locale_ref() : locale_(nullptr) {}
2019-01-13 02:27:38 +00:00
template <typename Locale> explicit locale_ref(const Locale& loc);
2018-11-14 17:39:37 +00:00
2019-11-13 12:08:47 +00:00
explicit operator bool() const FMT_NOEXCEPT { return locale_ != nullptr; }
2019-01-13 02:27:38 +00:00
template <typename Locale> Locale get() const;
2018-11-14 17:39:37 +00:00
};
2019-06-12 01:50:14 +00:00
template <typename> constexpr unsigned long long encode_types() { return 0; }
template <typename Context, typename Arg, typename... Args>
2019-06-12 01:50:14 +00:00
constexpr unsigned long long encode_types() {
2019-12-21 17:31:14 +00:00
return static_cast<unsigned>(mapped_type_constant<Arg, Context>::value) |
(encode_types<Context, Args...>() << packed_arg_bits);
}
template <typename Context, typename T>
2019-01-13 02:27:38 +00:00
FMT_CONSTEXPR basic_format_arg<Context> make_arg(const T& value) {
basic_format_arg<Context> arg;
2019-06-11 04:21:45 +00:00
arg.type_ = mapped_type_constant<T, Context>::value;
2019-06-10 04:10:09 +00:00
arg.value_ = arg_mapper<Context>().map(value);
return arg;
}
// The type template parameter is there to avoid an ODR violation when using
// a fallback formatter in one translation unit and an implicit conversion in
// another (not recommended).
template <bool IS_PACKED, typename Context, type, typename T,
2019-03-16 19:58:18 +00:00
FMT_ENABLE_IF(IS_PACKED)>
FMT_CONSTEXPR FMT_INLINE value<Context> make_arg(const T& val) {
2021-03-28 01:57:18 +00:00
const auto& arg = arg_mapper<Context>().map(val);
static_assert(
!std::is_same<decltype(arg), const unformattable&>::value,
"Cannot format an argument. To make type T formattable provide a "
"formatter<T> specialization: https://fmt.dev/latest/api.html#udt");
return arg;
}
template <bool IS_PACKED, typename Context, type, typename T,
2019-03-16 19:58:18 +00:00
FMT_ENABLE_IF(!IS_PACKED)>
inline basic_format_arg<Context> make_arg(const T& value) {
return make_arg<Context>(value);
2018-01-15 16:22:31 +00:00
}
FMT_END_DETAIL_NAMESPACE
2018-01-15 16:22:31 +00:00
2018-01-14 15:19:23 +00:00
// Formatting context.
2019-02-10 03:34:42 +00:00
template <typename OutputIt, typename Char> class basic_format_context {
public:
/** The character type for the output. */
using char_type = Char;
private:
2019-02-10 03:34:42 +00:00
OutputIt out_;
basic_format_args<basic_format_context> args_;
2020-05-10 14:25:42 +00:00
detail::locale_ref loc_;
public:
using iterator = OutputIt;
2019-06-03 00:13:50 +00:00
using format_arg = basic_format_arg<basic_format_context>;
2020-04-12 14:38:54 +00:00
using parse_context_type = basic_format_parse_context<Char>;
template <typename T> using formatter_type = formatter<T, char_type>;
2018-01-14 19:00:27 +00:00
2021-04-24 00:11:01 +00:00
basic_format_context(basic_format_context&&) = default;
basic_format_context(const basic_format_context&) = delete;
void operator=(const basic_format_context&) = delete;
/**
2018-04-08 13:45:21 +00:00
Constructs a ``basic_format_context`` object. References to the arguments are
stored in the object so make sure they have appropriate lifetimes.
*/
constexpr basic_format_context(
OutputIt out, basic_format_args<basic_format_context> ctx_args,
detail::locale_ref loc = detail::locale_ref())
2019-02-10 03:34:42 +00:00
: out_(out), args_(ctx_args), loc_(loc) {}
constexpr format_arg arg(int id) const { return args_.get(id); }
FMT_CONSTEXPR format_arg arg(basic_string_view<char_type> name) {
return args_.get(name);
}
2020-06-06 13:54:24 +00:00
int arg_id(basic_string_view<char_type> name) { return args_.get_id(name); }
2020-06-09 14:17:55 +00:00
const basic_format_args<basic_format_context>& args() const { return args_; }
2019-01-19 17:10:57 +00:00
FMT_CONSTEXPR detail::error_handler error_handler() { return {}; }
2019-02-10 03:34:42 +00:00
void on_error(const char* message) { error_handler().on_error(message); }
// Returns an iterator to the beginning of the output range.
FMT_CONSTEXPR iterator out() { return out_; }
2019-02-10 03:34:42 +00:00
// Advances the begin iterator to ``it``.
void advance_to(iterator it) {
if (!detail::is_back_insert_iterator<iterator>()) out_ = it;
}
2019-02-10 03:34:42 +00:00
FMT_CONSTEXPR detail::locale_ref locale() { return loc_; }
};
2019-06-03 00:13:50 +00:00
template <typename Char>
using buffer_context =
basic_format_context<detail::buffer_appender<Char>, Char>;
2019-06-03 00:13:50 +00:00
using format_context = buffer_context<char>;
using wformat_context = buffer_context<wchar_t>;
2018-02-03 14:14:10 +00:00
// Workaround an alias issue: https://stackoverflow.com/q/62767544/471164.
2020-07-07 13:06:50 +00:00
#define FMT_BUFFER_CONTEXT(Char) \
basic_format_context<detail::buffer_appender<Char>, Char>
2020-07-07 13:06:50 +00:00
2021-02-28 23:25:33 +00:00
template <typename T, typename Char = char>
2021-05-05 13:29:51 +00:00
using is_formattable = bool_constant<
!std::is_same<decltype(detail::arg_mapper<buffer_context<Char>>().map(
std::declval<T>())),
detail::unformattable>::value &&
!detail::has_fallback_formatter<T, Char>::value>;
2021-02-28 23:25:33 +00:00
2018-03-20 02:47:14 +00:00
/**
\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 <typename Context, typename... Args>
class format_arg_store
2020-04-04 18:23:36 +00:00
#if FMT_GCC_VERSION && FMT_GCC_VERSION < 409
// Workaround a GCC template argument substitution bug.
: public basic_format_args<Context>
#endif
{
private:
2019-06-07 20:58:11 +00:00
static const size_t num_args = sizeof...(Args);
2020-05-10 14:25:42 +00:00
static const size_t num_named_args = detail::count_named_args<Args...>();
static const bool is_packed = num_args <= detail::max_packed_args;
2020-05-10 14:25:42 +00:00
using value_type = conditional_t<is_packed, detail::value<Context>,
2019-06-05 01:50:30 +00:00
basic_format_arg<Context>>;
2020-05-10 14:25:42 +00:00
detail::arg_data<value_type, typename Context::char_type, num_args,
num_named_args>
2020-04-11 16:55:21 +00:00
data_;
2018-03-20 02:47:14 +00:00
friend class basic_format_args<Context>;
2020-04-11 16:55:21 +00:00
static constexpr unsigned long long desc =
2020-05-10 14:25:42 +00:00
(is_packed ? detail::encode_types<Context, Args...>()
: detail::is_unpacked_bit | num_args) |
2020-04-14 13:48:55 +00:00
(num_named_args != 0
2020-05-10 14:25:42 +00:00
? static_cast<unsigned long long>(detail::has_named_args_bit)
2020-04-14 13:48:55 +00:00
: 0);
2020-04-11 16:55:21 +00:00
public:
FMT_CONSTEXPR FMT_INLINE format_arg_store(const Args&... args)
:
2020-04-04 18:23:36 +00:00
#if FMT_GCC_VERSION && FMT_GCC_VERSION < 409
basic_format_args<Context>(*this),
#endif
2020-05-10 14:25:42 +00:00
data_{detail::make_arg<
is_packed, Context,
2020-05-10 14:25:42 +00:00
detail::mapped_type_constant<Args, Context>::value>(args)...} {
detail::init_named_args(data_.named_args(), 0, 0, args...);
}
};
2018-03-20 02:47:14 +00:00
/**
\rst
2020-07-20 17:38:14 +00:00
Constructs a `~fmt::format_arg_store` object that contains references to
2018-07-21 16:13:21 +00:00
arguments and can be implicitly converted to `~fmt::format_args`. `Context`
can be omitted in which case it defaults to `~fmt::context`.
See `~fmt::arg` for lifetime considerations.
2018-03-20 02:47:14 +00:00
\endrst
*/
2019-01-13 02:27:38 +00:00
template <typename Context = format_context, typename... Args>
constexpr format_arg_store<Context, Args...> make_format_args(
2019-01-13 02:27:38 +00:00
const Args&... args) {
return {args...};
}
2020-07-20 14:56:20 +00:00
/**
\rst
2020-07-20 17:38:14 +00:00
Constructs a `~fmt::format_arg_store` object that contains references
2020-07-20 14:56:20 +00:00
to arguments and can be implicitly converted to `~fmt::format_args`.
If ``format_str`` is a compile-time string then `make_args_checked` checks
its validity at compile time.
\endrst
*/
template <typename... Args, typename S, typename Char = char_t<S>>
FMT_INLINE auto make_args_checked(const S& format_str,
const remove_reference_t<Args>&... args)
2020-07-20 14:56:20 +00:00
-> format_arg_store<buffer_context<Char>, remove_reference_t<Args>...> {
static_assert(
detail::count<(
std::is_base_of<detail::view, remove_reference_t<Args>>::value &&
std::is_reference<Args>::value)...>() == 0,
"passing views as lvalues is disallowed");
detail::check_format_string<Args...>(format_str);
return {args...};
}
/**
\rst
Returns a named argument to be used in a formatting function.
It should only be used in a call to a formatting function or
`dynamic_format_arg_store::push_back`.
**Example**::
fmt::print("Elapsed time: {s:.2f} seconds", fmt::arg("s", 1.23));
\endrst
*/
template <typename Char, typename T>
2020-05-10 14:25:42 +00:00
inline detail::named_arg<Char, T> arg(const Char* name, const T& arg) {
static_assert(!detail::is_named_arg<T>(), "nested named arguments");
return {name, arg};
}
2019-12-30 18:51:47 +00:00
/**
\rst
A view of a collection of formatting arguments. To avoid lifetime issues it
should only be used as a parameter type in type-erased functions such as
``vformat``::
2020-01-02 17:31:45 +00:00
void vlog(string_view format_str, format_args args); // OK
format_args args = make_format_args(42); // Error: dangling reference
2019-12-30 18:51:47 +00:00
\endrst
*/
2019-01-13 02:27:38 +00:00
template <typename Context> class basic_format_args {
public:
2019-07-17 19:07:05 +00:00
using size_type = int;
using format_arg = basic_format_arg<Context>;
private:
2020-04-11 15:22:53 +00:00
// A descriptor that contains information about formatting arguments.
// If the number of arguments is less or equal to max_packed_args then
// argument types are passed in the descriptor. This reduces binary code size
// per formatting function call.
unsigned long long desc_;
union {
2020-04-11 15:22:53 +00:00
// If is_packed() returns true then argument values are stored in values_;
// otherwise they are stored in args_. This is done to improve cache
// locality and reduce compiled code size since 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.
2020-05-10 14:25:42 +00:00
const detail::value<Context>* values_;
2019-01-13 02:27:38 +00:00
const format_arg* args_;
};
constexpr bool is_packed() const {
return (desc_ & detail::is_unpacked_bit) == 0;
}
2020-04-14 13:48:55 +00:00
bool has_named_args() const {
2020-05-10 14:25:42 +00:00
return (desc_ & detail::has_named_args_bit) != 0;
2020-04-14 13:48:55 +00:00
}
FMT_CONSTEXPR detail::type type(int index) const {
2020-05-10 14:25:42 +00:00
int shift = index * detail::packed_arg_bits;
unsigned int mask = (1 << detail::packed_arg_bits) - 1;
return static_cast<detail::type>((desc_ >> shift) & mask);
}
2021-03-28 14:32:17 +00:00
constexpr FMT_INLINE basic_format_args(unsigned long long desc,
const detail::value<Context>* values)
2020-04-21 00:24:43 +00:00
: desc_(desc), values_(values) {}
constexpr basic_format_args(unsigned long long desc, const format_arg* args)
2020-04-21 00:24:43 +00:00
: desc_(desc), args_(args) {}
public:
constexpr basic_format_args() : desc_(0), args_(nullptr) {}
2018-03-20 02:47:14 +00:00
/**
\rst
Constructs a `basic_format_args` object from `~fmt::format_arg_store`.
2018-03-20 02:47:14 +00:00
\endrst
*/
template <typename... Args>
constexpr FMT_INLINE basic_format_args(
const format_arg_store<Context, Args...>& store)
: basic_format_args(format_arg_store<Context, Args...>::desc,
store.data_.args()) {}
/**
\rst
Constructs a `basic_format_args` object from
`~fmt::dynamic_format_arg_store`.
\endrst
*/
constexpr FMT_INLINE basic_format_args(
const dynamic_format_arg_store<Context>& store)
: basic_format_args(store.get_types(), store.data()) {}
/**
\rst
Constructs a `basic_format_args` object from a dynamic set of arguments.
\endrst
*/
constexpr basic_format_args(const format_arg* args, int count)
2020-05-10 14:25:42 +00:00
: basic_format_args(detail::is_unpacked_bit | detail::to_unsigned(count),
args) {}
2020-04-14 13:48:55 +00:00
/** Returns the argument with the specified id. */
FMT_CONSTEXPR format_arg get(int id) const {
2020-05-09 19:56:35 +00:00
format_arg arg;
if (!is_packed()) {
if (id < max_size()) arg = args_[id];
return arg;
}
2020-05-10 14:25:42 +00:00
if (id >= detail::max_packed_args) return arg;
2020-05-09 19:56:35 +00:00
arg.type_ = type(id);
2020-05-10 14:25:42 +00:00
if (arg.type_ == detail::type::none_type) return arg;
2020-05-09 19:56:35 +00:00
arg.value_ = values_[id];
2018-07-14 22:28:55 +00:00
return arg;
}
2020-04-14 13:48:55 +00:00
template <typename Char> format_arg get(basic_string_view<Char> name) const {
2020-06-06 13:54:24 +00:00
int id = get_id(name);
return id >= 0 ? get(id) : format_arg();
}
template <typename Char> int get_id(basic_string_view<Char> name) const {
if (!has_named_args()) return -1;
2020-04-14 13:48:55 +00:00
const auto& named_args =
(is_packed() ? values_[-1] : args_[-1].value_).named_args;
for (size_t i = 0; i < named_args.size; ++i) {
2020-06-06 13:54:24 +00:00
if (named_args.data[i].name == name) return named_args.data[i].id;
2020-04-14 13:48:55 +00:00
}
2020-06-06 13:54:24 +00:00
return -1;
2020-04-14 13:48:55 +00:00
}
2019-07-17 19:07:05 +00:00
int max_size() const {
2020-05-10 14:25:42 +00:00
unsigned long long max_packed = detail::max_packed_args;
2019-07-18 04:28:53 +00:00
return static_cast<int>(is_packed() ? max_packed
2020-05-10 14:25:42 +00:00
: desc_ & ~detail::is_unpacked_bit);
}
};
/** An alias to ``basic_format_args<format_context>``. */
// Separate types would result in shorter symbols but break ABI compatibility
// between clang and gcc on ARM (#1919).
using format_args = basic_format_args<format_context>;
using wformat_args = basic_format_args<wformat_context>;
2021-05-06 13:49:46 +00:00
// We cannot use enum classes as bit fields because of a gcc bug
// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=61414.
namespace align {
enum type { none, left, right, center, numeric };
}
using align_t = align::type;
2021-05-14 01:28:19 +00:00
namespace sign {
enum type { none, minus, plus, space };
}
using sign_t = sign::type;
FMT_BEGIN_DETAIL_NAMESPACE
2021-05-14 01:28:19 +00:00
void throw_format_error(const char* message);
// Workaround an array initialization issue in gcc 4.8.
template <typename Char> struct fill_t {
private:
enum { max_size = 4 };
Char data_[max_size] = {Char(' '), Char(0), Char(0), Char(0)};
unsigned char size_ = 1;
public:
FMT_CONSTEXPR void operator=(basic_string_view<Char> s) {
auto size = s.size();
if (size > max_size) return throw_format_error("invalid fill");
for (size_t i = 0; i < size; ++i) data_[i] = s[i];
size_ = static_cast<unsigned char>(size);
}
constexpr size_t size() const { return size_; }
constexpr const Char* data() const { return data_; }
FMT_CONSTEXPR Char& operator[](size_t index) { return data_[index]; }
FMT_CONSTEXPR const Char& operator[](size_t index) const {
return data_[index];
}
};
FMT_END_DETAIL_NAMESPACE
2021-05-14 01:28:19 +00:00
// Format specifiers for built-in and string types.
template <typename Char> struct basic_format_specs {
int width;
int precision;
char type;
align_t align : 4;
sign_t sign : 3;
bool alt : 1; // Alternate form ('#').
bool localized : 1;
detail::fill_t<Char> fill;
constexpr basic_format_specs()
: width(0),
precision(-1),
type(0),
align(align::none),
sign(sign::none),
alt(false),
localized(false) {}
};
using format_specs = basic_format_specs<char>;
2021-05-06 13:49:46 +00:00
FMT_BEGIN_DETAIL_NAMESPACE
2021-05-14 02:01:21 +00:00
enum class arg_id_kind { none, index, name };
// An argument reference.
template <typename Char> struct arg_ref {
FMT_CONSTEXPR arg_ref() : kind(arg_id_kind::none), val() {}
FMT_CONSTEXPR explicit arg_ref(int index)
: kind(arg_id_kind::index), val(index) {}
FMT_CONSTEXPR explicit arg_ref(basic_string_view<Char> name)
: kind(arg_id_kind::name), val(name) {}
FMT_CONSTEXPR arg_ref& operator=(int idx) {
kind = arg_id_kind::index;
val.index = idx;
return *this;
}
arg_id_kind kind;
union value {
FMT_CONSTEXPR value(int id = 0) : index{id} {}
FMT_CONSTEXPR value(basic_string_view<Char> n) : name(n) {}
int index;
basic_string_view<Char> name;
} val;
};
// Format specifiers with width and precision resolved at formatting rather
// than parsing time to allow re-using the same parsed specifiers with
// different sets of arguments (precompilation of format strings).
template <typename Char>
struct dynamic_format_specs : basic_format_specs<Char> {
arg_ref<Char> width_ref;
arg_ref<Char> precision_ref;
};
2021-05-14 02:33:09 +00:00
struct auto_id {};
// A format specifier handler that sets fields in basic_format_specs.
template <typename Char> class specs_setter {
2021-05-16 14:18:04 +00:00
protected:
basic_format_specs<Char>& specs_;
2021-05-14 02:33:09 +00:00
public:
explicit FMT_CONSTEXPR specs_setter(basic_format_specs<Char>& specs)
: specs_(specs) {}
FMT_CONSTEXPR specs_setter(const specs_setter& other)
: specs_(other.specs_) {}
FMT_CONSTEXPR void on_align(align_t align) { specs_.align = align; }
FMT_CONSTEXPR void on_fill(basic_string_view<Char> fill) {
specs_.fill = fill;
}
2021-05-16 14:18:04 +00:00
FMT_CONSTEXPR void on_sign(sign_t s) { specs_.sign = s; }
2021-05-14 02:33:09 +00:00
FMT_CONSTEXPR void on_hash() { specs_.alt = true; }
FMT_CONSTEXPR void on_localized() { specs_.localized = true; }
FMT_CONSTEXPR void on_zero() {
specs_.align = align::numeric;
specs_.fill[0] = Char('0');
}
FMT_CONSTEXPR void on_width(int width) { specs_.width = width; }
FMT_CONSTEXPR void on_precision(int precision) {
specs_.precision = precision;
}
FMT_CONSTEXPR void end_precision() {}
FMT_CONSTEXPR void on_type(Char type) {
specs_.type = static_cast<char>(type);
}
};
// Format spec handler that saves references to arguments representing dynamic
// width and precision to be resolved at formatting time.
template <typename ParseContext>
class dynamic_specs_handler
: public specs_setter<typename ParseContext::char_type> {
public:
using char_type = typename ParseContext::char_type;
FMT_CONSTEXPR dynamic_specs_handler(dynamic_format_specs<char_type>& specs,
ParseContext& ctx)
: specs_setter<char_type>(specs), specs_(specs), context_(ctx) {}
FMT_CONSTEXPR dynamic_specs_handler(const dynamic_specs_handler& other)
: specs_setter<char_type>(other),
specs_(other.specs_),
context_(other.context_) {}
template <typename Id> FMT_CONSTEXPR void on_dynamic_width(Id arg_id) {
specs_.width_ref = make_arg_ref(arg_id);
}
template <typename Id> FMT_CONSTEXPR void on_dynamic_precision(Id arg_id) {
specs_.precision_ref = make_arg_ref(arg_id);
}
FMT_CONSTEXPR void on_error(const char* message) {
context_.on_error(message);
}
private:
using arg_ref_type = arg_ref<char_type>;
FMT_CONSTEXPR arg_ref_type make_arg_ref(int arg_id) {
context_.check_arg_id(arg_id);
return arg_ref_type(arg_id);
}
FMT_CONSTEXPR arg_ref_type make_arg_ref(auto_id) {
return arg_ref_type(context_.next_arg_id());
}
FMT_CONSTEXPR arg_ref_type make_arg_ref(basic_string_view<char_type> arg_id) {
context_.check_arg_id(arg_id);
basic_string_view<char_type> format_str(
context_.begin(), to_unsigned(context_.end() - context_.begin()));
return arg_ref_type(arg_id);
}
dynamic_format_specs<char_type>& specs_;
ParseContext& context_;
};
2021-05-06 13:49:46 +00:00
template <typename Char> constexpr bool is_ascii_letter(Char c) {
return (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z');
}
// Converts a character to ASCII. Returns a number > 127 on conversion failure.
template <typename Char, FMT_ENABLE_IF(std::is_integral<Char>::value)>
constexpr Char to_ascii(Char value) {
return value;
}
template <typename Char, FMT_ENABLE_IF(std::is_enum<Char>::value)>
constexpr typename std::underlying_type<Char>::type to_ascii(Char value) {
return value;
}
template <typename Char>
FMT_CONSTEXPR int code_point_length(const Char* begin) {
if (const_check(sizeof(Char) != 1)) return 1;
constexpr char lengths[] = {1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
0, 0, 0, 0, 0, 0, 0, 0, 2, 2, 2, 2, 3, 3, 4, 0};
int len = lengths[static_cast<unsigned char>(*begin) >> 3];
// Compute the pointer to the next character early so that the next
// iteration can start working on the next character. Neither Clang
// nor GCC figure out this reordering on their own.
return len + !len;
}
2021-05-16 14:18:04 +00:00
// Return the result via the out param to workaround gcc bug 77539.
template <bool IS_CONSTEXPR, typename T, typename Ptr = const T*>
FMT_CONSTEXPR bool find(Ptr first, Ptr last, T value, Ptr& out) {
for (out = first; out != last; ++out) {
if (*out == value) return true;
}
return false;
}
template <>
inline bool find<false, char>(const char* first, const char* last, char value,
const char*& out) {
out = static_cast<const char*>(
std::memchr(first, value, to_unsigned(last - first)));
return out != nullptr;
}
2021-05-06 13:49:46 +00:00
// Parses the range [begin, end) as an unsigned integer. This function assumes
// that the range is non-empty and the first character is a digit.
template <typename Char, typename ErrorHandler>
FMT_CONSTEXPR int parse_nonnegative_int(const Char*& begin, const Char* end,
ErrorHandler&& eh) {
FMT_ASSERT(begin != end && '0' <= *begin && *begin <= '9', "");
unsigned value = 0;
// Convert to unsigned to prevent a warning.
const unsigned max_int = to_unsigned(INT_MAX);
unsigned big = max_int / 10;
do {
// Check for overflow.
if (value > big) {
value = max_int + 1;
break;
}
value = value * 10 + unsigned(*begin - '0');
++begin;
} while (begin != end && '0' <= *begin && *begin <= '9');
if (value > max_int) eh.on_error("number is too big");
return static_cast<int>(value);
}
// Parses fill and alignment.
template <typename Char, typename Handler>
FMT_CONSTEXPR const Char* parse_align(const Char* begin, const Char* end,
Handler&& handler) {
FMT_ASSERT(begin != end, "");
auto align = align::none;
auto p = begin + code_point_length(begin);
if (p >= end) p = begin;
for (;;) {
switch (to_ascii(*p)) {
case '<':
align = align::left;
break;
case '>':
align = align::right;
break;
case '^':
align = align::center;
break;
default:
break;
}
if (align != align::none) {
if (p != begin) {
auto c = *begin;
if (c == '{')
return handler.on_error("invalid fill character '{'"), begin;
handler.on_fill(basic_string_view<Char>(begin, to_unsigned(p - begin)));
begin = p + 1;
} else
++begin;
handler.on_align(align);
break;
} else if (p == begin) {
break;
}
p = begin;
}
return begin;
}
2021-05-06 15:12:24 +00:00
template <typename Char> FMT_CONSTEXPR bool is_name_start(Char c) {
return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') || '_' == c;
}
2021-05-06 14:37:40 +00:00
template <typename Char, typename IDHandler>
FMT_CONSTEXPR const Char* do_parse_arg_id(const Char* begin, const Char* end,
IDHandler&& handler) {
FMT_ASSERT(begin != end, "");
Char c = *begin;
if (c >= '0' && c <= '9') {
int index = 0;
if (c != '0')
index = parse_nonnegative_int(begin, end, handler);
else
++begin;
if (begin == end || (*begin != '}' && *begin != ':'))
handler.on_error("invalid format string");
else
handler(index);
return begin;
}
if (!is_name_start(c)) {
handler.on_error("invalid format string");
return begin;
}
auto it = begin;
do {
++it;
} while (it != end && (is_name_start(c = *it) || ('0' <= c && c <= '9')));
handler(basic_string_view<Char>(begin, to_unsigned(it - begin)));
return it;
}
template <typename Char, typename IDHandler>
FMT_CONSTEXPR_DECL FMT_INLINE const Char* parse_arg_id(const Char* begin,
const Char* end,
IDHandler&& handler) {
Char c = *begin;
if (c != '}' && c != ':') return do_parse_arg_id(begin, end, handler);
handler();
return begin;
}
2021-05-06 13:49:46 +00:00
// Adapts SpecHandler to IDHandler API for dynamic width.
template <typename SpecHandler, typename Char> struct width_adapter {
explicit FMT_CONSTEXPR width_adapter(SpecHandler& h) : handler(h) {}
FMT_CONSTEXPR void operator()() { handler.on_dynamic_width(auto_id()); }
FMT_CONSTEXPR void operator()(int id) { handler.on_dynamic_width(id); }
FMT_CONSTEXPR void operator()(basic_string_view<Char> id) {
handler.on_dynamic_width(id);
}
FMT_CONSTEXPR void on_error(const char* message) {
handler.on_error(message);
}
SpecHandler& handler;
};
template <typename Char, typename Handler>
FMT_CONSTEXPR const Char* parse_width(const Char* begin, const Char* end,
Handler&& handler) {
FMT_ASSERT(begin != end, "");
if ('0' <= *begin && *begin <= '9') {
handler.on_width(parse_nonnegative_int(begin, end, handler));
} else if (*begin == '{') {
++begin;
if (begin != end)
begin = parse_arg_id(begin, end, width_adapter<Handler, Char>(handler));
if (begin == end || *begin != '}')
return handler.on_error("invalid format string"), begin;
++begin;
}
return begin;
}
// Adapts SpecHandler to IDHandler API for dynamic precision.
template <typename SpecHandler, typename Char> struct precision_adapter {
explicit FMT_CONSTEXPR precision_adapter(SpecHandler& h) : handler(h) {}
FMT_CONSTEXPR void operator()() { handler.on_dynamic_precision(auto_id()); }
FMT_CONSTEXPR void operator()(int id) { handler.on_dynamic_precision(id); }
FMT_CONSTEXPR void operator()(basic_string_view<Char> id) {
handler.on_dynamic_precision(id);
}
FMT_CONSTEXPR void on_error(const char* message) {
handler.on_error(message);
}
SpecHandler& handler;
};
template <typename Char, typename Handler>
FMT_CONSTEXPR const Char* parse_precision(const Char* begin, const Char* end,
Handler&& handler) {
++begin;
auto c = begin != end ? *begin : Char();
if ('0' <= c && c <= '9') {
handler.on_precision(parse_nonnegative_int(begin, end, handler));
} else if (c == '{') {
++begin;
if (begin != end) {
begin =
parse_arg_id(begin, end, precision_adapter<Handler, Char>(handler));
}
if (begin == end || *begin++ != '}')
return handler.on_error("invalid format string"), begin;
} else {
return handler.on_error("missing precision specifier"), begin;
}
handler.end_precision();
return begin;
}
// Parses standard format specifiers and sends notifications about parsed
// components to handler.
template <typename Char, typename SpecHandler>
FMT_CONSTEXPR_DECL FMT_INLINE const Char* parse_format_specs(
const Char* begin, const Char* end, SpecHandler&& handler) {
if (begin + 1 < end && begin[1] == '}' && is_ascii_letter(*begin) &&
*begin != 'L') {
handler.on_type(*begin++);
return begin;
}
if (begin == end) return begin;
begin = parse_align(begin, end, handler);
if (begin == end) return begin;
// Parse sign.
switch (to_ascii(*begin)) {
case '+':
2021-05-16 14:18:04 +00:00
handler.on_sign(sign::plus);
2021-05-06 13:49:46 +00:00
++begin;
break;
case '-':
2021-05-16 14:18:04 +00:00
handler.on_sign(sign::minus);
2021-05-06 13:49:46 +00:00
++begin;
break;
case ' ':
2021-05-16 14:18:04 +00:00
handler.on_sign(sign::space);
2021-05-06 13:49:46 +00:00
++begin;
break;
default:
break;
}
if (begin == end) return begin;
if (*begin == '#') {
handler.on_hash();
if (++begin == end) return begin;
}
// Parse zero flag.
if (*begin == '0') {
handler.on_zero();
if (++begin == end) return begin;
}
begin = parse_width(begin, end, handler);
if (begin == end) return begin;
// Parse precision.
if (*begin == '.') {
begin = parse_precision(begin, end, handler);
if (begin == end) return begin;
}
if (*begin == 'L') {
handler.on_localized();
++begin;
}
// Parse type.
if (begin != end && *begin != '}') handler.on_type(*begin++);
return begin;
}
template <typename Handler, typename Char> struct id_adapter {
Handler& handler;
int arg_id;
FMT_CONSTEXPR void operator()() { arg_id = handler.on_arg_id(); }
FMT_CONSTEXPR void operator()(int id) { arg_id = handler.on_arg_id(id); }
FMT_CONSTEXPR void operator()(basic_string_view<Char> id) {
arg_id = handler.on_arg_id(id);
}
FMT_CONSTEXPR void on_error(const char* message) {
handler.on_error(message);
}
};
template <typename Char, typename Handler>
FMT_CONSTEXPR const Char* parse_replacement_field(const Char* begin,
const Char* end,
Handler&& handler) {
++begin;
if (begin == end) return handler.on_error("invalid format string"), end;
if (*begin == '}') {
handler.on_replacement_field(handler.on_arg_id(), begin);
} else if (*begin == '{') {
handler.on_text(begin, begin + 1);
} else {
auto adapter = id_adapter<Handler, Char>{handler, 0};
begin = parse_arg_id(begin, end, adapter);
Char c = begin != end ? *begin : Char();
if (c == '}') {
handler.on_replacement_field(adapter.arg_id, begin);
} else if (c == ':') {
begin = handler.on_format_specs(adapter.arg_id, begin + 1, end);
if (begin == end || *begin != '}')
return handler.on_error("unknown format specifier"), end;
} else {
return handler.on_error("missing '}' in format string"), end;
}
}
return begin + 1;
}
template <bool IS_CONSTEXPR, typename Char, typename Handler>
FMT_CONSTEXPR_DECL FMT_INLINE void parse_format_string(
basic_string_view<Char> format_str, Handler&& handler) {
// this is most likely a name-lookup defect in msvc's modules implementation
using detail::find;
auto begin = format_str.data();
auto end = begin + format_str.size();
if (end - begin < 32) {
// Use a simple loop instead of memchr for small strings.
const Char* p = begin;
while (p != end) {
auto c = *p++;
if (c == '{') {
handler.on_text(begin, p - 1);
begin = p = parse_replacement_field(p - 1, end, handler);
} else if (c == '}') {
if (p == end || *p != '}')
return handler.on_error("unmatched '}' in format string");
handler.on_text(begin, p);
begin = ++p;
}
}
handler.on_text(begin, end);
return;
}
struct writer {
FMT_CONSTEXPR void operator()(const Char* pbegin, const Char* pend) {
if (pbegin == pend) return;
for (;;) {
const Char* p = nullptr;
if (!find<IS_CONSTEXPR>(pbegin, pend, '}', p))
return handler_.on_text(pbegin, pend);
++p;
if (p == pend || *p != '}')
return handler_.on_error("unmatched '}' in format string");
handler_.on_text(pbegin, p);
pbegin = p + 1;
}
}
Handler& handler_;
} write{handler};
while (begin != end) {
// Doing two passes with memchr (one for '{' and another for '}') is up to
// 2.5x faster than the naive one-pass implementation on big format strings.
const Char* p = begin;
if (*begin != '{' && !find<IS_CONSTEXPR>(begin + 1, end, '{', p))
return write(begin, end);
write(begin, p);
begin = parse_replacement_field(p, end, handler);
}
}
template <typename T, typename ParseContext>
FMT_CONSTEXPR const typename ParseContext::char_type* parse_format_specs(
ParseContext& ctx) {
using char_type = typename ParseContext::char_type;
using context = buffer_context<char_type>;
using mapped_type = conditional_t<
mapped_type_constant<T, context>::value != type::custom_type,
decltype(arg_mapper<context>().map(std::declval<const T&>())), T>;
auto f = conditional_t<has_formatter<mapped_type, context>::value,
formatter<mapped_type, char_type>,
fallback_formatter<T, char_type>>();
return f.parse(ctx);
}
// A parse context with extra argument id checks. It is only used at compile
// time because adding checks at runtime would introduce substantial overhead
// and would be redundant since argument ids are checked when arguments are
// retrieved anyway.
template <typename Char, typename ErrorHandler = error_handler>
class compile_parse_context
: public basic_format_parse_context<Char, ErrorHandler> {
private:
int num_args_;
using base = basic_format_parse_context<Char, ErrorHandler>;
public:
explicit FMT_CONSTEXPR compile_parse_context(
basic_string_view<Char> format_str, int num_args = INT_MAX,
ErrorHandler eh = {})
: base(format_str, eh), num_args_(num_args) {}
FMT_CONSTEXPR int next_arg_id() {
int id = base::next_arg_id();
if (id >= num_args_) this->on_error("argument not found");
return id;
}
FMT_CONSTEXPR void check_arg_id(int id) {
base::check_arg_id(id);
if (id >= num_args_) this->on_error("argument not found");
}
using base::check_arg_id;
};
2021-05-16 14:08:49 +00:00
template <typename ErrorHandler>
FMT_CONSTEXPR void check_int_type_spec(char spec, ErrorHandler&& eh) {
switch (spec) {
case 0:
case 'd':
case 'x':
case 'X':
case 'b':
case 'B':
case 'o':
case 'c':
break;
default:
eh.on_error("invalid type specifier");
break;
}
}
template <typename ErrorHandler>
class char_specs_checker : public ErrorHandler {
private:
char type_;
public:
FMT_CONSTEXPR char_specs_checker(char type, ErrorHandler eh)
: ErrorHandler(eh), type_(type) {}
FMT_CONSTEXPR void on_int() { check_int_type_spec(type_, *this); }
FMT_CONSTEXPR void on_char() {}
};
template <typename Char, typename Handler>
FMT_CONSTEXPR void handle_char_specs(const basic_format_specs<Char>& specs,
Handler&& handler) {
if (specs.type && specs.type != 'c') return handler.on_int();
if (specs.align == align::numeric || specs.sign != sign::none || specs.alt)
handler.on_error("invalid format specifier for char");
handler.on_char();
}
// A floating-point presentation format.
enum class float_format : unsigned char {
general, // General: exponent notation or fixed point based on magnitude.
exp, // Exponent notation with the default precision of 6, e.g. 1.2e-3.
fixed, // Fixed point with the default precision of 6, e.g. 0.0012.
hex
};
struct float_specs {
int precision;
float_format format : 8;
sign_t sign : 8;
bool upper : 1;
bool locale : 1;
bool binary32 : 1;
bool use_grisu : 1;
bool showpoint : 1;
};
template <typename ErrorHandler = error_handler, typename Char>
FMT_CONSTEXPR float_specs parse_float_type_spec(
const basic_format_specs<Char>& specs, ErrorHandler&& eh = {}) {
auto result = float_specs();
result.showpoint = specs.alt;
result.locale = specs.localized;
switch (specs.type) {
case 0:
result.format = float_format::general;
break;
case 'G':
result.upper = true;
FMT_FALLTHROUGH;
case 'g':
result.format = float_format::general;
break;
case 'E':
result.upper = true;
FMT_FALLTHROUGH;
case 'e':
result.format = float_format::exp;
result.showpoint |= specs.precision != 0;
break;
case 'F':
result.upper = true;
FMT_FALLTHROUGH;
case 'f':
result.format = float_format::fixed;
result.showpoint |= specs.precision != 0;
break;
case 'A':
result.upper = true;
FMT_FALLTHROUGH;
case 'a':
result.format = float_format::hex;
break;
default:
eh.on_error("invalid type specifier");
break;
}
return result;
}
template <typename ErrorHandler>
class cstring_type_checker : public ErrorHandler {
public:
FMT_CONSTEXPR explicit cstring_type_checker(ErrorHandler eh)
: ErrorHandler(eh) {}
FMT_CONSTEXPR void on_string() {}
FMT_CONSTEXPR void on_pointer() {}
};
template <typename Char, typename Handler>
FMT_CONSTEXPR void handle_cstring_type_spec(Char spec, Handler&& handler) {
if (spec == 0 || spec == 's')
handler.on_string();
else if (spec == 'p')
handler.on_pointer();
else
handler.on_error("invalid type specifier");
}
template <typename Char, typename ErrorHandler>
FMT_CONSTEXPR void check_string_type_spec(Char spec, ErrorHandler&& eh) {
if (spec != 0 && spec != 's') eh.on_error("invalid type specifier");
}
template <typename Char, typename ErrorHandler>
FMT_CONSTEXPR void check_pointer_type_spec(Char spec, ErrorHandler&& eh) {
if (spec != 0 && spec != 'p') eh.on_error("invalid type specifier");
}
// A format specifier handler that checks if specifiers are consistent with the
// argument type.
template <typename Handler> class specs_checker : public Handler {
private:
2021-05-16 14:18:04 +00:00
detail::type arg_type_;
2021-05-16 14:08:49 +00:00
2021-05-16 14:18:04 +00:00
FMT_CONSTEXPR void require_numeric_argument() {
if (!is_arithmetic_type(arg_type_))
this->on_error("format specifier requires numeric argument");
}
2021-05-16 14:08:49 +00:00
public:
FMT_CONSTEXPR specs_checker(const Handler& handler, detail::type arg_type)
2021-05-16 14:18:04 +00:00
: Handler(handler), arg_type_(arg_type) {}
2021-05-16 14:08:49 +00:00
FMT_CONSTEXPR void on_align(align_t align) {
2021-05-16 14:18:04 +00:00
if (align == align::numeric) require_numeric_argument();
2021-05-16 14:08:49 +00:00
Handler::on_align(align);
}
2021-05-16 14:18:04 +00:00
FMT_CONSTEXPR void on_sign(sign_t s) {
require_numeric_argument();
if (is_integral_type(arg_type_) && arg_type_ != type::int_type &&
arg_type_ != type::long_long_type && arg_type_ != type::char_type) {
this->on_error("format specifier requires signed argument");
}
Handler::on_sign(s);
2021-05-16 14:08:49 +00:00
}
FMT_CONSTEXPR void on_hash() {
2021-05-16 14:18:04 +00:00
require_numeric_argument();
2021-05-16 14:08:49 +00:00
Handler::on_hash();
}
FMT_CONSTEXPR void on_localized() {
2021-05-16 14:18:04 +00:00
require_numeric_argument();
2021-05-16 14:08:49 +00:00
Handler::on_localized();
}
FMT_CONSTEXPR void on_zero() {
2021-05-16 14:18:04 +00:00
require_numeric_argument();
2021-05-16 14:08:49 +00:00
Handler::on_zero();
}
2021-05-16 14:18:04 +00:00
FMT_CONSTEXPR void end_precision() {
if (is_integral_type(arg_type_) || arg_type_ == type::pointer_type)
this->on_error("precision not allowed for this argument type");
}
2021-05-16 14:08:49 +00:00
};
constexpr int invalid_arg_index = -1;
#if FMT_USE_NONTYPE_TEMPLATE_PARAMETERS
template <int N, typename T, typename... Args, typename Char>
constexpr int get_arg_index_by_name(basic_string_view<Char> name) {
if constexpr (detail::is_statically_named_arg<T>()) {
if (name == T::name) return N;
}
2021-05-15 13:28:20 +00:00
if constexpr (sizeof...(Args) > 0)
return get_arg_index_by_name<N + 1, Args...>(name);
2021-05-16 14:08:49 +00:00
(void)name; // Workaround an MSVC bug about "unused" parameter.
2021-05-15 13:28:20 +00:00
return invalid_arg_index;
}
2021-05-15 13:28:20 +00:00
#endif
template <typename... Args, typename Char>
2021-05-15 13:28:20 +00:00
FMT_CONSTEXPR int get_arg_index_by_name(basic_string_view<Char> name) {
#if FMT_USE_NONTYPE_TEMPLATE_PARAMETERS
if constexpr (sizeof...(Args) > 0)
return get_arg_index_by_name<0, Args...>(name);
2021-05-15 13:28:20 +00:00
#endif
(void)name;
return invalid_arg_index;
}
2021-05-06 13:49:46 +00:00
template <typename Char, typename ErrorHandler, typename... Args>
class format_string_checker {
2021-05-16 14:18:04 +00:00
private:
using parse_context_type = compile_parse_context<Char, ErrorHandler>;
enum { num_args = sizeof...(Args) };
// Format specifier parsing function.
using parse_func = const Char* (*)(parse_context_type&);
parse_context_type context_;
parse_func parse_funcs_[num_args > 0 ? num_args : 1];
2021-05-06 13:49:46 +00:00
public:
explicit FMT_CONSTEXPR format_string_checker(
basic_string_view<Char> format_str, ErrorHandler eh)
: context_(format_str, num_args, eh),
parse_funcs_{&parse_format_specs<Args, parse_context_type>...} {}
FMT_CONSTEXPR void on_text(const Char*, const Char*) {}
FMT_CONSTEXPR int on_arg_id() { return context_.next_arg_id(); }
FMT_CONSTEXPR int on_arg_id(int id) { return context_.check_arg_id(id), id; }
FMT_CONSTEXPR int on_arg_id(basic_string_view<Char> id) {
#if FMT_USE_NONTYPE_TEMPLATE_PARAMETERS
auto index = get_arg_index_by_name<Args...>(id);
if (index == invalid_arg_index) on_error("named argument is not found");
return context_.check_arg_id(index), index;
#else
(void)id;
on_error("compile-time checks for named arguments require C++20 support");
2021-05-06 13:49:46 +00:00
return 0;
#endif
2021-05-06 13:49:46 +00:00
}
FMT_CONSTEXPR void on_replacement_field(int, const Char*) {}
FMT_CONSTEXPR const Char* on_format_specs(int id, const Char* begin,
const Char*) {
2021-05-16 14:08:49 +00:00
context_.advance_to(context_.begin() + (begin - &*context_.begin()));
2021-05-06 13:49:46 +00:00
// id >= 0 check is a workaround for gcc 10 bug (#2065).
return id >= 0 && id < num_args ? parse_funcs_[id](context_) : begin;
}
FMT_CONSTEXPR void on_error(const char* message) {
context_.on_error(message);
}
};
template <typename... Args, typename S,
enable_if_t<(is_compile_string<S>::value), int>>
void check_format_string(S format_str) {
FMT_CONSTEXPR_DECL auto s = to_string_view(format_str);
using checker = format_string_checker<typename S::char_type, error_handler,
remove_cvref_t<Args>...>;
FMT_CONSTEXPR_DECL bool invalid_format =
(parse_format_string<true>(s, checker(s, {})), true);
(void)invalid_format;
}
2021-05-16 14:18:04 +00:00
// Converts a compile-time string to basic_string_view.
2021-05-06 14:19:41 +00:00
template <typename Char, size_t N>
2021-05-16 14:18:04 +00:00
constexpr auto compile_string_to_view(const Char (&s)[N])
-> basic_string_view<Char> {
// Remove trailing NUL character if needed. Won't be present if this is used
// with a raw character array (i.e. not defined as a string).
return {s, N - (std::char_traits<Char>::to_int_type(s[N - 1]) == 0 ? 1 : 0)};
2021-05-06 14:19:41 +00:00
}
template <typename Char>
2021-05-16 14:18:04 +00:00
constexpr auto compile_string_to_view(std_string_view<Char> s)
-> basic_string_view<Char> {
2021-05-06 14:19:41 +00:00
return {s.data(), s.size()};
}
#define FMT_STRING_IMPL(s, base) \
[] { \
/* Use the hidden visibility as a workaround for a GCC bug (#1973). */ \
/* Use a macro-like name to avoid shadowing warnings. */ \
struct FMT_GCC_VISIBILITY_HIDDEN FMT_COMPILE_STRING : base { \
using char_type = fmt::remove_cvref_t<decltype(s[0])>; \
FMT_MAYBE_UNUSED FMT_CONSTEXPR \
operator fmt::basic_string_view<char_type>() const { \
return fmt::detail::compile_string_to_view<char_type>(s); \
} \
}; \
return FMT_COMPILE_STRING(); \
}()
/**
\rst
Constructs a compile-time format string from a string literal *s*.
**Example**::
// A compile-time error because 'd' is an invalid specifier for strings.
std::string s = fmt::format(FMT_STRING("{:d}"), "foo");
\endrst
*/
#define FMT_STRING(s) FMT_STRING_IMPL(s, fmt::compile_string)
2020-06-07 14:49:11 +00:00
template <typename Char, FMT_ENABLE_IF(!std::is_same<Char, char>::value)>
2020-01-15 19:42:59 +00:00
std::basic_string<Char> vformat(
basic_string_view<Char> format_str,
basic_format_args<buffer_context<type_identity_t<Char>>> args);
2018-10-25 01:42:42 +00:00
2020-07-07 12:17:45 +00:00
FMT_API std::string vformat(string_view format_str, format_args args);
2020-06-07 14:49:11 +00:00
2018-10-25 01:42:42 +00:00
template <typename Char>
2020-10-21 13:53:19 +00:00
void vformat_to(
2019-06-12 03:36:39 +00:00
buffer<Char>& buf, basic_string_view<Char> format_str,
2020-10-21 00:39:50 +00:00
basic_format_args<FMT_BUFFER_CONTEXT(type_identity_t<Char>)> args,
detail::locale_ref loc = {});
2020-03-28 13:31:38 +00:00
template <typename Char, typename Args,
FMT_ENABLE_IF(!std::is_same<Char, char>::value)>
inline void vprint_mojibake(std::FILE*, basic_string_view<Char>, const Args&) {}
2020-03-22 14:57:56 +00:00
2020-03-28 13:31:38 +00:00
FMT_API void vprint_mojibake(std::FILE*, string_view, format_args);
2020-03-22 14:57:56 +00:00
#ifndef _WIN32
inline void vprint_mojibake(std::FILE*, string_view, format_args) {}
#endif
FMT_END_DETAIL_NAMESPACE
2021-05-16 14:08:49 +00:00
// A formatter specialization for the core types corresponding to detail::type
// constants.
template <typename T, typename Char>
struct formatter<T, Char,
enable_if_t<detail::type_constant<T, Char>::value !=
detail::type::custom_type>> {
2021-05-16 14:18:04 +00:00
private:
detail::dynamic_format_specs<Char> specs_;
public:
2021-05-16 14:08:49 +00:00
FMT_CONSTEXPR formatter() = default;
// Parses format specifiers stopping either at the end of the range or at the
// terminating '}'.
template <typename ParseContext>
FMT_CONSTEXPR auto parse(ParseContext& ctx) -> decltype(ctx.begin()) {
auto begin = ctx.begin(), end = ctx.end();
if (begin == end) return begin;
using handler_type = detail::dynamic_specs_handler<ParseContext>;
auto type = detail::type_constant<T, Char>::value;
detail::specs_checker<handler_type> handler(handler_type(specs_, ctx),
type);
auto it = detail::parse_format_specs(begin, end, handler);
auto eh = ctx.error_handler();
switch (type) {
case detail::type::none_type:
FMT_ASSERT(false, "invalid argument type");
break;
case detail::type::bool_type:
if (!specs_.type || specs_.type == 's') break;
FMT_FALLTHROUGH;
case detail::type::int_type:
case detail::type::uint_type:
case detail::type::long_long_type:
case detail::type::ulong_long_type:
case detail::type::int128_type:
case detail::type::uint128_type:
detail::check_int_type_spec(specs_.type, eh);
break;
case detail::type::char_type:
detail::handle_char_specs(
specs_, detail::char_specs_checker<decltype(eh)>(specs_.type, eh));
break;
case detail::type::float_type:
if (detail::const_check(FMT_USE_FLOAT))
detail::parse_float_type_spec(specs_, eh);
else
FMT_ASSERT(false, "float support disabled");
break;
case detail::type::double_type:
if (detail::const_check(FMT_USE_DOUBLE))
detail::parse_float_type_spec(specs_, eh);
else
FMT_ASSERT(false, "double support disabled");
break;
case detail::type::long_double_type:
if (detail::const_check(FMT_USE_LONG_DOUBLE))
detail::parse_float_type_spec(specs_, eh);
else
FMT_ASSERT(false, "long double support disabled");
break;
case detail::type::cstring_type:
detail::handle_cstring_type_spec(
specs_.type, detail::cstring_type_checker<decltype(eh)>(eh));
break;
case detail::type::string_type:
detail::check_string_type_spec(specs_.type, eh);
break;
case detail::type::pointer_type:
detail::check_pointer_type_spec(specs_.type, eh);
break;
case detail::type::custom_type:
// Custom format specifiers should be checked in parse functions of
// formatter specializations.
break;
}
return it;
}
template <typename FormatContext>
2021-05-16 14:18:04 +00:00
FMT_CONSTEXPR auto format(const T& val, FormatContext& ctx) const
2021-05-16 14:08:49 +00:00
-> decltype(ctx.out());
};
2018-01-15 16:22:31 +00:00
/** Formats a string and writes the output to ``out``. */
2019-06-04 15:47:25 +00:00
// GCC 8 and earlier cannot handle std::back_insert_iterator<Container> with
// vformat_to<ArgFormatter>(...) overload, so SFINAE on iterator type instead.
2020-07-18 13:44:44 +00:00
template <typename OutputIt, typename S, typename Char = char_t<S>,
2020-10-27 08:55:26 +00:00
bool enable = detail::is_output_iterator<OutputIt, Char>::value>
auto vformat_to(OutputIt out, const S& format_str,
basic_format_args<buffer_context<type_identity_t<Char>>> args)
-> typename std::enable_if<enable, OutputIt>::type {
2020-07-18 13:44:44 +00:00
decltype(detail::get_buffer<Char>(out)) buf(detail::get_buffer_init(out));
2020-05-10 14:25:42 +00:00
detail::vformat_to(buf, to_string_view(format_str), args);
2020-07-18 13:44:44 +00:00
return detail::get_iterator(buf);
}
2020-07-18 13:44:44 +00:00
/**
\rst
Formats arguments, writes the result to the output iterator ``out`` and returns
the iterator past the end of the output range.
**Example**::
std::vector<char> out;
fmt::format_to(std::back_inserter(out), "{}", 42);
\endrst
*/
2020-10-22 14:14:54 +00:00
// We cannot use FMT_ENABLE_IF because of a bug in gcc 8.3.
2020-07-18 13:44:44 +00:00
template <typename OutputIt, typename S, typename... Args,
2020-10-22 14:14:54 +00:00
bool enable = detail::is_output_iterator<OutputIt, char_t<S>>::value>
inline auto format_to(OutputIt out, const S& format_str, Args&&... args) ->
typename std::enable_if<enable, OutputIt>::type {
const auto& vargs = fmt::make_args_checked<Args...>(format_str, args...);
2020-07-18 13:44:44 +00:00
return vformat_to(out, to_string_view(format_str), vargs);
}
2020-07-24 15:28:23 +00:00
template <typename OutputIt> struct format_to_n_result {
/** Iterator past the end of the output range. */
OutputIt out;
/** Total (not truncated) output size. */
size_t size;
};
template <typename OutputIt, typename Char, typename... Args,
2020-10-20 20:35:31 +00:00
FMT_ENABLE_IF(detail::is_output_iterator<OutputIt, Char>::value)>
2020-07-24 15:28:23 +00:00
inline format_to_n_result<OutputIt> vformat_to_n(
OutputIt out, size_t n, basic_string_view<Char> format_str,
basic_format_args<buffer_context<type_identity_t<Char>>> args) {
detail::iterator_buffer<OutputIt, Char, detail::fixed_buffer_traits> buf(out,
n);
detail::vformat_to(buf, format_str, args);
return {buf.out(), buf.count()};
}
/**
\rst
Formats arguments, writes up to ``n`` characters of the result to the output
iterator ``out`` and returns the total output size and the iterator past the
end of the output range.
\endrst
*/
template <typename OutputIt, typename S, typename... Args,
2020-10-27 08:55:26 +00:00
bool enable = detail::is_output_iterator<OutputIt, char_t<S>>::value>
inline auto format_to_n(OutputIt out, size_t n, const S& format_str,
const Args&... args) ->
2020-10-27 08:55:26 +00:00
typename std::enable_if<enable, format_to_n_result<OutputIt>>::type {
2020-07-24 15:28:23 +00:00
const auto& vargs = fmt::make_args_checked<Args...>(format_str, args...);
return vformat_to_n(out, n, to_string_view(format_str), vargs);
}
/**
Returns the number of characters in the output of
``format(format_str, args...)``.
*/
template <typename S, typename... Args, typename Char = char_t<S>>
inline size_t formatted_size(const S& format_str, Args&&... args) {
const auto& vargs = fmt::make_args_checked<Args...>(format_str, args...);
detail::counting_buffer<> buf;
detail::vformat_to(buf, to_string_view(format_str), vargs);
return buf.count();
}
2019-06-05 15:53:23 +00:00
template <typename S, typename Char = char_t<S>>
FMT_INLINE std::basic_string<Char> vformat(
2020-01-15 19:42:59 +00:00
const S& format_str,
basic_format_args<buffer_context<type_identity_t<Char>>> args) {
2020-05-10 14:25:42 +00:00
return detail::vformat(to_string_view(format_str), args);
}
/**
\rst
Formats arguments and returns the result as a string.
**Example**::
2018-03-10 17:25:17 +00:00
#include <fmt/core.h>
std::string message = fmt::format("The answer is {}", 42);
\endrst
*/
2019-06-01 19:32:24 +00:00
// Pass char_t as a default template parameter instead of using
// std::basic_string<char_t<S>> to reduce the symbol size.
template <typename S, typename... Args, typename Char = char_t<S>,
FMT_ENABLE_IF(!FMT_COMPILE_TIME_CHECKS ||
!std::is_same<Char, char>::value)>
FMT_INLINE std::basic_string<Char> format(const S& format_str, Args&&... args) {
const auto& vargs = fmt::make_args_checked<Args...>(format_str, args...);
2020-05-10 14:25:42 +00:00
return detail::vformat(to_string_view(format_str), vargs);
}
2019-12-24 16:20:54 +00:00
FMT_API void vprint(string_view, format_args);
FMT_API void vprint(std::FILE*, string_view, format_args);
/**
\rst
2019-12-24 20:08:37 +00:00
Formats ``args`` according to specifications in ``format_str`` and writes the
output to the file ``f``. Strings are assumed to be Unicode-encoded unless the
``FMT_UNICODE`` macro is set to 0.
**Example**::
fmt::print(stderr, "Don't {}!", "panic");
\endrst
*/
2020-03-28 13:31:38 +00:00
template <typename S, typename... Args, typename Char = char_t<S>>
2019-07-09 18:50:16 +00:00
inline void print(std::FILE* f, const S& format_str, Args&&... args) {
const auto& vargs = fmt::make_args_checked<Args...>(format_str, args...);
2020-05-10 14:25:42 +00:00
return detail::is_unicode<Char>()
2020-04-15 15:16:02 +00:00
? vprint(f, to_string_view(format_str), vargs)
2020-05-10 14:25:42 +00:00
: detail::vprint_mojibake(f, to_string_view(format_str), vargs);
}
/**
\rst
2019-12-24 18:11:47 +00:00
Formats ``args`` according to specifications in ``format_str`` and writes
the output to ``stdout``. Strings are assumed to be Unicode-encoded unless
the ``FMT_UNICODE`` macro is set to 0.
**Example**::
fmt::print("Elapsed time: {0:.2f} seconds", 1.23);
\endrst
*/
2020-03-28 13:31:38 +00:00
template <typename S, typename... Args, typename Char = char_t<S>>
2019-07-09 18:50:16 +00:00
inline void print(const S& format_str, Args&&... args) {
const auto& vargs = fmt::make_args_checked<Args...>(format_str, args...);
2020-05-10 14:25:42 +00:00
return detail::is_unicode<Char>()
2020-04-15 15:16:02 +00:00
? vprint(to_string_view(format_str), vargs)
2020-05-10 14:25:42 +00:00
: detail::vprint_mojibake(stdout, to_string_view(format_str),
vargs);
}
FMT_MODULE_EXPORT_END
FMT_GCC_PRAGMA("GCC pop_options")
2018-05-12 15:33:51 +00:00
FMT_END_NAMESPACE
#ifdef FMT_HEADER_ONLY
2021-04-23 13:52:10 +00:00
# include "format.h"
#endif
#endif // FMT_CORE_H_