ext-fmt/include/fmt/core.h

1260 lines
37 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_
#include <cassert>
#include <cstdio>
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.
#define FMT_VERSION 50000
#ifdef __has_feature
# define FMT_HAS_FEATURE(x) __has_feature(x)
#else
# define FMT_HAS_FEATURE(x) 0
#endif
2018-02-11 14:23:43 +00:00
#ifdef __has_include
# define FMT_HAS_INCLUDE(x) __has_include(x)
#else
# define FMT_HAS_INCLUDE(x) 0
#endif
2018-03-15 13:55:31 +00:00
#if defined(__GNUC__) && !defined(__clang__)
# define FMT_GCC_VERSION (__GNUC__ * 100 + __GNUC_MINOR__)
2018-02-03 03:16:13 +00:00
#else
# define FMT_GCC_VERSION 0
#endif
2018-02-11 14:23:43 +00:00
#if __cplusplus >= 201103L || defined(__GXX_EXPERIMENTAL_CXX0X__)
2018-02-03 03:16:13 +00:00
# define FMT_HAS_GXX_CXX11 FMT_GCC_VERSION
#else
# define FMT_HAS_GXX_CXX11 0
#endif
#ifdef _MSC_VER
# define FMT_MSC_VER _MSC_VER
#else
# define FMT_MSC_VER 0
#endif
2018-02-04 16:52:43 +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
# define FMT_USE_CONSTEXPR \
2018-03-16 16:02:19 +00:00
(FMT_HAS_FEATURE(cxx_relaxed_constexpr) || FMT_GCC_VERSION >= 600 || \
2018-02-04 16:52:43 +00:00
FMT_MSC_VER >= 1910)
#endif
#if FMT_USE_CONSTEXPR
# define FMT_CONSTEXPR constexpr
2018-02-04 16:58:21 +00:00
# define FMT_CONSTEXPR_DECL constexpr
2018-02-04 16:52:43 +00:00
#else
# define FMT_CONSTEXPR inline
2018-02-04 16:58:21 +00:00
# define FMT_CONSTEXPR_DECL
2018-02-03 14:14:10 +00:00
#endif
#ifndef FMT_OVERRIDE
# if FMT_HAS_FEATURE(cxx_override) || \
(FMT_GCC_VERSION >= 408 && FMT_HAS_GXX_CXX11) || \
FMT_MSC_VER >= 1900
# define FMT_OVERRIDE override
# else
# define FMT_OVERRIDE
# endif
#endif
2018-02-28 15:47:24 +00:00
#if FMT_HAS_FEATURE(cxx_explicit_conversions)
# define FMT_EXPLICIT explicit
#else
# define FMT_EXPLICIT
#endif
2018-01-21 02:37:57 +00:00
#ifndef FMT_NULL
# if FMT_HAS_FEATURE(cxx_nullptr) || \
(FMT_GCC_VERSION >= 408 && FMT_HAS_GXX_CXX11) || \
FMT_MSC_VER >= 1600
# define FMT_NULL nullptr
2018-02-28 15:47:24 +00:00
# define FMT_USE_NULLPTR 1
2018-01-21 02:37:57 +00:00
# else
# define FMT_NULL NULL
# endif
#endif
2018-02-28 15:47:24 +00:00
#ifndef FMT_USE_NULLPTR
# define FMT_USE_NULLPTR 0
#endif
// Check if exceptions are disabled.
#if defined(__GNUC__) && !defined(__EXCEPTIONS)
# define FMT_EXCEPTIONS 0
2017-12-30 15:42:56 +00:00
#elif FMT_MSC_VER && !_HAS_EXCEPTIONS
# define FMT_EXCEPTIONS 0
#endif
#ifndef FMT_EXCEPTIONS
# define FMT_EXCEPTIONS 1
#endif
// Define FMT_USE_NOEXCEPT to make fmt use noexcept (C++11 feature).
#ifndef FMT_USE_NOEXCEPT
# define FMT_USE_NOEXCEPT 0
#endif
2018-01-21 01:54:06 +00:00
#if FMT_USE_NOEXCEPT || FMT_HAS_FEATURE(cxx_noexcept) || \
(FMT_GCC_VERSION >= 408 && FMT_HAS_GXX_CXX11) || \
FMT_MSC_VER >= 1900
# define FMT_DETECTED_NOEXCEPT noexcept
#else
# define FMT_DETECTED_NOEXCEPT throw()
#endif
#ifndef FMT_NOEXCEPT
# if FMT_EXCEPTIONS
2018-01-21 01:54:06 +00:00
# define FMT_NOEXCEPT FMT_DETECTED_NOEXCEPT
# else
# define FMT_NOEXCEPT
# endif
#endif
2018-01-21 01:54:06 +00:00
// This is needed because GCC still uses throw() in its headers when exceptions
// are disabled.
#if FMT_GCC_VERSION
# define FMT_DTOR_NOEXCEPT FMT_DETECTED_NOEXCEPT
#else
# define FMT_DTOR_NOEXCEPT FMT_NOEXCEPT
#endif
#if !defined(FMT_HEADER_ONLY) && defined(_WIN32)
# ifdef FMT_EXPORT
# define FMT_API __declspec(dllexport)
# elif defined(FMT_SHARED)
# define FMT_API __declspec(dllimport)
# endif
#endif
#ifndef FMT_API
# define FMT_API
#endif
#ifndef FMT_ASSERT
# define FMT_ASSERT(condition, message) assert((condition) && message)
#endif
2018-01-06 17:09:50 +00:00
#define FMT_DELETED = delete
// A macro to disallow the copy construction and assignment.
2018-01-06 17:09:50 +00:00
#define FMT_DISALLOW_COPY_AND_ASSIGN(Type) \
Type(const Type &) FMT_DELETED; \
void operator=(const Type &) FMT_DELETED
2018-03-26 17:00:41 +00:00
// libc++ supports string_view in pre-c++17.
#if (FMT_HAS_INCLUDE(<string_view>) && \
(__cplusplus > 201402L || _LIBCPP_VERSION)) || \
(defined(_MSVC_LANG) && _MSVC_LANG > 201402L && _MSC_VER >= 1910)
# include <string_view>
# define FMT_USE_STD_STRING_VIEW
2018-02-10 13:16:16 +00:00
#elif (FMT_HAS_INCLUDE(<experimental/string_view>) && \
2018-02-10 15:17:29 +00:00
__cplusplus >= 201402L)
# include <experimental/string_view>
# define FMT_USE_EXPERIMENTAL_STRING_VIEW
#endif
2018-03-03 22:04:59 +00:00
// std::result_of is defined in <functional> in gcc 4.4.
#if FMT_GCC_VERSION && FMT_GCC_VERSION <= 404
# include <functional>
#endif
namespace fmt {
2018-02-28 15:47:24 +00:00
// An implementation of declval for pre-C++11 compilers such as gcc 4.
2018-03-01 11:45:25 +00:00
namespace internal {
2018-02-28 15:47:24 +00:00
template <typename T>
typename std::add_rvalue_reference<T>::type declval() FMT_NOEXCEPT;
2018-03-01 11:45:25 +00:00
}
2018-02-28 15:47:24 +00:00
/**
\rst
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).
\endrst
*/
template <typename Char>
class basic_string_view {
private:
const Char *data_;
size_t size_;
public:
typedef Char char_type;
typedef const Char *iterator;
// Standard basic_string_view type.
#if defined(FMT_USE_STD_STRING_VIEW)
typedef std::basic_string_view<Char> type;
#elif defined(FMT_USE_EXPERIMENTAL_STRING_VIEW)
typedef std::experimental::basic_string_view<Char> type;
#else
struct type {
const char *data() const { return FMT_NULL; }
size_t size() const { return 0; };
};
#endif
FMT_CONSTEXPR basic_string_view() FMT_NOEXCEPT : data_(FMT_NULL), size_(0) {}
/** Constructs a string reference object from a C string and a size. */
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR basic_string_view(const Char *s, size_t size) FMT_NOEXCEPT
: data_(s), size_(size) {}
/**
\rst
Constructs a string reference object from a C string computing
the size with ``std::char_traits<Char>::length``.
\endrst
*/
basic_string_view(const Char *s)
: data_(s), size_(std::char_traits<Char>::length(s)) {}
/**
\rst
Constructs a string reference from a ``std::basic_string`` object.
\endrst
*/
template <typename Alloc>
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR basic_string_view(
const std::basic_string<Char, Alloc> &s) FMT_NOEXCEPT
: data_(s.c_str()), size_(s.size()) {}
FMT_CONSTEXPR basic_string_view(type s) FMT_NOEXCEPT
: data_(s.data()), size_(s.size()) {}
/** Returns a pointer to the string data. */
const Char *data() const { return data_; }
/** Returns the string size. */
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR size_t size() const { return size_; }
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR iterator begin() const { return data_; }
FMT_CONSTEXPR iterator end() const { return data_ + size_; }
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.
int compare(basic_string_view other) const {
size_t size = size_ < other.size_ ? size_ : other.size_;
int result = std::char_traits<Char>::compare(data_, other.data_, size);
if (result == 0)
result = size_ == other.size_ ? 0 : (size_ < other.size_ ? -1 : 1);
return result;
}
friend bool operator==(basic_string_view lhs, basic_string_view rhs) {
return lhs.compare(rhs) == 0;
}
friend bool operator!=(basic_string_view lhs, basic_string_view rhs) {
return lhs.compare(rhs) != 0;
}
friend bool operator<(basic_string_view lhs, basic_string_view rhs) {
return lhs.compare(rhs) < 0;
}
friend bool operator<=(basic_string_view lhs, basic_string_view rhs) {
return lhs.compare(rhs) <= 0;
}
friend bool operator>(basic_string_view lhs, basic_string_view rhs) {
return lhs.compare(rhs) > 0;
}
friend bool operator>=(basic_string_view lhs, basic_string_view rhs) {
return lhs.compare(rhs) >= 0;
}
};
typedef basic_string_view<char> string_view;
typedef basic_string_view<wchar_t> wstring_view;
2018-01-14 20:25:03 +00:00
template <typename Context>
class basic_format_arg;
2018-01-14 20:25:03 +00:00
template <typename Context>
class basic_format_args;
// A formatter for objects of type T.
template <typename T, typename Char = char, typename Enable = void>
struct formatter;
namespace internal {
2018-01-06 17:09:50 +00:00
/** A contiguous memory buffer with an optional growing ability. */
template <typename T>
class basic_buffer {
private:
FMT_DISALLOW_COPY_AND_ASSIGN(basic_buffer);
T *ptr_;
std::size_t size_;
std::size_t capacity_;
protected:
2018-01-21 02:37:57 +00:00
basic_buffer(T *p = FMT_NULL, std::size_t size = 0, std::size_t capacity = 0)
2018-01-15 16:22:31 +00:00
FMT_NOEXCEPT: ptr_(p), size_(size), capacity_(capacity) {}
2018-01-06 17:09:50 +00:00
/** Sets the buffer data and capacity. */
void set(T *data, std::size_t capacity) FMT_NOEXCEPT {
ptr_ = data;
capacity_ = capacity;
}
/**
\rst
Increases the buffer capacity to hold at least *capacity* elements.
\endrst
*/
virtual void grow(std::size_t capacity) = 0;
public:
typedef T value_type;
2018-03-03 22:04:59 +00:00
typedef const T &const_reference;
2018-01-06 17:09:50 +00:00
virtual ~basic_buffer() {}
T *begin() FMT_NOEXCEPT { return ptr_; }
T *end() FMT_NOEXCEPT { return ptr_ + size_; }
/** Returns the size of this buffer. */
std::size_t size() const FMT_NOEXCEPT { return size_; }
/** Returns the capacity of this buffer. */
std::size_t capacity() const FMT_NOEXCEPT { return capacity_; }
/** Returns a pointer to the buffer data. */
T *data() FMT_NOEXCEPT { return ptr_; }
/** Returns a pointer to the buffer data. */
const T *data() const FMT_NOEXCEPT { return ptr_; }
/**
Resizes the buffer. If T is a POD type new elements may not be initialized.
*/
void resize(std::size_t new_size) {
reserve(new_size);
size_ = new_size;
}
/**
\rst
Reserves space to store at least *capacity* elements.
\endrst
*/
void reserve(std::size_t capacity) {
if (capacity > capacity_)
grow(capacity);
}
void push_back(const T &value) {
reserve(size_ + 1);
ptr_[size_++] = value;
}
/** Appends data to the end of the buffer. */
template <typename U>
void append(const U *begin, const U *end);
T &operator[](std::size_t index) { return ptr_[index]; }
const T &operator[](std::size_t index) const { return ptr_[index]; }
};
typedef basic_buffer<char> buffer;
typedef basic_buffer<wchar_t> wbuffer;
2018-01-14 22:15:59 +00:00
2018-01-15 16:22:31 +00:00
// A container-backed buffer.
2018-01-14 22:15:59 +00:00
template <typename Container>
2018-01-15 16:22:31 +00:00
class container_buffer : public basic_buffer<typename Container::value_type> {
2018-01-14 22:15:59 +00:00
private:
Container &container_;
protected:
2018-02-14 23:30:55 +00:00
void grow(std::size_t capacity) FMT_OVERRIDE {
2018-01-14 22:15:59 +00:00
container_.resize(capacity);
this->set(&container_[0], capacity);
}
public:
2018-01-15 16:22:31 +00:00
explicit container_buffer(Container &c)
: basic_buffer<typename Container::value_type>(&c[0], c.size(), c.size()),
container_(c) {}
2018-01-14 22:15:59 +00:00
};
struct error_handler {
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR error_handler() {}
FMT_CONSTEXPR error_handler(const error_handler &) {}
// This function is intentionally not constexpr to give a compile-time error.
FMT_API void on_error(const char *message);
};
// Formatting of wide characters and strings into a narrow output is disallowed:
// fmt::format("{}", L"test"); // error
// To fix this, use a wide format string:
// fmt::format(L"{}", L"test");
template <typename Char>
inline void require_wchar() {
static_assert(
std::is_same<wchar_t, Char>::value,
"formatting of wide characters into a narrow output is disallowed");
}
2018-01-06 17:09:50 +00:00
template <typename Char>
struct named_arg_base;
template <typename T, typename Char>
struct named_arg;
template <typename T>
struct is_named_arg : std::false_type {};
2018-01-06 17:09:50 +00:00
template <typename T, typename Char>
struct is_named_arg<named_arg<T, Char>> : std::true_type {};
enum type {
none_type, name_arg_type,
// Integer types should go first,
int_type, uint_type, long_long_type, ulong_long_type, bool_type, char_type,
last_integer_type = char_type,
// followed by floating-point types.
double_type, long_double_type, last_numeric_type = long_double_type,
cstring_type, string_type, pointer_type, custom_type
};
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR bool is_integral(type t) {
FMT_ASSERT(t != internal::name_arg_type, "invalid argument type");
return t > internal::none_type && t <= internal::last_integer_type;
}
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR bool is_arithmetic(type t) {
FMT_ASSERT(t != internal::name_arg_type, "invalid argument type");
return t > internal::none_type && t <= internal::last_numeric_type;
}
template <typename T, typename Char, bool ENABLE = true>
struct convert_to_int {
enum {
2018-03-04 23:14:02 +00:00
value = !std::is_arithmetic<T>::value && std::is_convertible<T, int>::value
};
};
template <typename Char>
struct string_value {
const Char *value;
std::size_t size;
};
template <typename Context>
struct custom_value {
const void *value;
2018-01-06 17:09:50 +00:00
void (*format)(const void *arg, Context &ctx);
};
// A formatting argument value.
template <typename Context>
class value {
public:
typedef typename Context::char_type char_type;
union {
int int_value;
unsigned uint_value;
long long long_long_value;
unsigned long long ulong_long_value;
double double_value;
long double long_double_value;
const void *pointer;
string_value<char_type> string;
string_value<signed char> sstring;
string_value<unsigned char> ustring;
custom_value<Context> custom;
};
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR value(int val = 0) : int_value(val) {}
value(unsigned val) { uint_value = val; }
value(long long val) { long_long_value = val; }
value(unsigned long long val) { ulong_long_value = val; }
value(double val) { double_value = val; }
value(long double val) { long_double_value = val; }
value(const char_type *val) { string.value = val; }
value(const signed char *val) {
static_assert(std::is_same<char, char_type>::value,
"incompatible string types");
sstring.value = val;
}
2018-02-03 14:14:10 +00:00
value(const unsigned char *val) {
static_assert(std::is_same<char, char_type>::value,
"incompatible string types");
ustring.value = val;
}
value(basic_string_view<char_type> val) {
string.value = val.data();
string.size = val.size();
}
value(const void *val) { pointer = val; }
template <typename T>
2018-02-03 14:14:10 +00:00
explicit value(const T &val) {
2018-01-14 15:19:23 +00:00
custom.value = &val;
custom.format = &format_custom_arg<T>;
}
2018-01-06 17:09:50 +00:00
const named_arg_base<char_type> &as_named_arg() {
return *static_cast<const named_arg_base<char_type>*>(pointer);
}
private:
// Formats an argument of a custom type, such as a user-defined class.
template <typename T>
2018-01-06 17:09:50 +00:00
static void format_custom_arg(const void *arg, Context &ctx) {
// Get the formatter type through the context to allow different contexts
// have different extension points, e.g. `formatter<T>` for `format` and
// `printf_formatter<T>` for `printf`.
typename Context::template formatter_type<T>::type f;
auto &&parse_ctx = ctx.parse_context();
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, type TYPE>
struct typed_value : value<Context> {
static const type type_tag = TYPE;
template <typename T>
FMT_CONSTEXPR typed_value(const T &val) : value<Context>(val) {}
};
template <typename Context, typename T>
FMT_CONSTEXPR basic_format_arg<Context> make_arg(const T &value);
2018-02-03 14:14:10 +00:00
#define FMT_MAKE_VALUE(TAG, ArgType, ValueType) \
template <typename C> \
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR typed_value<C, TAG> make_value(ArgType val) { \
return static_cast<ValueType>(val); \
}
FMT_MAKE_VALUE(bool_type, bool, int)
FMT_MAKE_VALUE(int_type, short, int)
FMT_MAKE_VALUE(uint_type, unsigned short, unsigned)
FMT_MAKE_VALUE(int_type, int, int)
FMT_MAKE_VALUE(uint_type, unsigned, unsigned)
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.
typedef std::conditional<sizeof(long) == sizeof(int), int, long long>::type
long_type;
FMT_MAKE_VALUE(
(sizeof(long) == sizeof(int) ? int_type : long_long_type), long, long_type)
typedef std::conditional<sizeof(unsigned long) == sizeof(unsigned),
unsigned, unsigned long long>::type ulong_type;
FMT_MAKE_VALUE(
(sizeof(unsigned long) == sizeof(unsigned) ? uint_type : ulong_long_type),
2018-02-03 14:14:10 +00:00
unsigned long, ulong_type)
FMT_MAKE_VALUE(long_long_type, long long, long long)
FMT_MAKE_VALUE(ulong_long_type, unsigned long long, unsigned long long)
FMT_MAKE_VALUE(int_type, signed char, int)
FMT_MAKE_VALUE(uint_type, unsigned char, unsigned)
FMT_MAKE_VALUE(char_type, char, int)
2018-02-03 14:14:10 +00:00
#if !defined(_MSC_VER) || defined(_NATIVE_WCHAR_T_DEFINED)
template <typename C>
inline typed_value<C, char_type> make_value(wchar_t val) {
2018-02-03 14:14:10 +00:00
require_wchar<typename C::char_type>();
return static_cast<int>(val);
}
#endif
FMT_MAKE_VALUE(double_type, float, double)
FMT_MAKE_VALUE(double_type, double, double)
FMT_MAKE_VALUE(long_double_type, long double, long double)
2018-02-03 14:14:10 +00:00
// Formatting of wide strings into a narrow buffer and multibyte strings
// into a wide buffer is disallowed (https://github.com/fmtlib/fmt/pull/606).
FMT_MAKE_VALUE(cstring_type, typename C::char_type*,
const typename C::char_type*)
FMT_MAKE_VALUE(cstring_type, const typename C::char_type*,
const typename C::char_type*)
FMT_MAKE_VALUE(cstring_type, signed char*, const signed char*)
FMT_MAKE_VALUE(cstring_type, const signed char*, const signed char*)
FMT_MAKE_VALUE(cstring_type, unsigned char*, const unsigned char*)
FMT_MAKE_VALUE(cstring_type, const unsigned char*, const unsigned char*)
FMT_MAKE_VALUE(string_type, basic_string_view<typename C::char_type>,
basic_string_view<typename C::char_type>)
FMT_MAKE_VALUE(string_type,
typename basic_string_view<typename C::char_type>::type,
basic_string_view<typename C::char_type>)
FMT_MAKE_VALUE(string_type, const std::basic_string<typename C::char_type>&,
basic_string_view<typename C::char_type>)
FMT_MAKE_VALUE(pointer_type, void*, const void*)
FMT_MAKE_VALUE(pointer_type, const void*, const void*)
2018-02-28 15:47:24 +00:00
#if FMT_USE_NULLPTR
FMT_MAKE_VALUE(pointer_type, std::nullptr_t, const void*)
2018-02-28 15:47:24 +00:00
#endif
2018-02-03 14:14:10 +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.
template <typename C, typename T>
typed_value<C, pointer_type> make_value(const T *) {
2018-02-03 14:14:10 +00:00
static_assert(!sizeof(T), "formatting of non-void pointers is disallowed");
}
template <typename C, typename T>
inline typename std::enable_if<
std::is_enum<T>::value && convert_to_int<T, typename C::char_type>::value,
typed_value<C, int_type>>::type
make_value(const T &val) { return static_cast<int>(val); }
template <typename C, typename T, typename Char = typename C::char_type>
inline typename std::enable_if<
!convert_to_int<T, Char>::value &&
!std::is_convertible<T, basic_string_view<Char>>::value &&
!std::is_convertible<T, std::basic_string<Char>>::value,
typed_value<C, custom_type>>::type
2018-02-03 14:14:10 +00:00
make_value(const T &val) { return val; }
template <typename C, typename T>
typed_value<C, name_arg_type>
2018-02-03 14:14:10 +00:00
make_value(const named_arg<T, typename C::char_type> &val) {
basic_format_arg<C> arg = make_arg<C>(val.value);
2018-02-03 14:14:10 +00:00
std::memcpy(val.data, &arg, sizeof(arg));
return static_cast<const void*>(&val);
}
// Maximum number of arguments with packed types.
2018-03-07 15:36:13 +00:00
enum { max_packed_args = 15 };
template <typename Context>
class arg_map;
2018-03-03 22:04:59 +00:00
template <typename>
struct result_of;
template <typename F, typename... Args>
struct result_of<F(Args...)> {
// A workaround for gcc 4.4 that doesn't allow F to be a reference.
typedef typename std::result_of<
typename std::remove_reference<F>::type(Args...)>::type type;
};
}
// A formatting argument. It is a trivially copyable/constructible type to
// allow storage in basic_memory_buffer.
template <typename Context>
class basic_format_arg {
private:
internal::value<Context> value_;
internal::type type_;
template <typename ContextType, typename T>
friend FMT_CONSTEXPR basic_format_arg<ContextType>
internal::make_arg(const T &value);
template <typename Visitor, typename Ctx>
2018-03-03 22:04:59 +00:00
friend FMT_CONSTEXPR typename internal::result_of<Visitor(int)>::type
visit(Visitor &&vis, basic_format_arg<Ctx> arg);
friend class basic_format_args<Context>;
friend class internal::arg_map<Context>;
typedef typename Context::char_type char_type;
public:
class handle {
public:
2017-12-30 15:42:56 +00:00
explicit handle(internal::custom_value<Context> custom): custom_(custom) {}
2017-12-30 15:42:56 +00:00
void format(Context &ctx) { custom_.format(custom_.value, ctx); }
private:
internal::custom_value<Context> custom_;
};
FMT_CONSTEXPR basic_format_arg() : type_(internal::none_type) {}
2018-02-28 15:47:24 +00:00
FMT_EXPLICIT operator bool() const FMT_NOEXCEPT {
return type_ != internal::none_type;
2018-01-06 17:09:50 +00:00
}
internal::type type() const { return type_; }
bool is_integral() const { return internal::is_integral(type_); }
2017-12-09 14:19:15 +00:00
bool is_arithmetic() const { return internal::is_arithmetic(type_); }
bool is_pointer() const { return type_ == internal::pointer_type; }
};
// Parsing context consisting of a format string range being parsed and an
// argument counter for automatic indexing.
template <typename Char, typename ErrorHandler = internal::error_handler>
class basic_parse_context : private ErrorHandler {
private:
basic_string_view<Char> format_str_;
int next_arg_id_;
public:
typedef Char char_type;
typedef typename basic_string_view<Char>::iterator iterator;
2018-02-03 14:14:10 +00:00
explicit FMT_CONSTEXPR basic_parse_context(
basic_string_view<Char> format_str, ErrorHandler eh = ErrorHandler())
: ErrorHandler(eh), format_str_(format_str), next_arg_id_(0) {}
// Returns an iterator to the beginning of the format string range being
// parsed.
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR iterator begin() const FMT_NOEXCEPT {
return format_str_.begin();
}
// Returns an iterator past the end of the format string range being parsed.
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR iterator end() const FMT_NOEXCEPT { return format_str_.end(); }
// Advances the begin iterator to ``it``.
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR void advance_to(iterator it) {
format_str_.remove_prefix(it - begin());
}
// Returns the next argument index.
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR unsigned next_arg_id();
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR bool check_arg_id(unsigned) {
if (next_arg_id_ > 0) {
on_error("cannot switch from automatic to manual argument indexing");
return false;
}
next_arg_id_ = -1;
return true;
}
void check_arg_id(basic_string_view<Char>) {}
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR void on_error(const char *message) {
ErrorHandler::on_error(message);
}
2018-02-03 14:14:10 +00:00
FMT_CONSTEXPR ErrorHandler error_handler() const { return *this; }
};
typedef basic_parse_context<char> parse_context;
typedef basic_parse_context<wchar_t> wparse_context;
namespace internal {
2018-01-14 19:00:27 +00:00
// A map from argument names to their values for named arguments.
template <typename Context>
class arg_map {
private:
FMT_DISALLOW_COPY_AND_ASSIGN(arg_map);
typedef typename Context::char_type char_type;
2018-01-06 17:09:50 +00:00
struct entry {
2017-12-30 15:42:56 +00:00
basic_string_view<char_type> name;
basic_format_arg<Context> arg;
};
2018-02-11 17:43:54 +00:00
entry *map_;
unsigned size_;
2018-01-06 17:09:50 +00:00
void push_back(value<Context> val) {
const internal::named_arg_base<char_type> &named = val.as_named_arg();
map_[size_] = entry{named.name, named.template deserialize<Context>()};
++size_;
}
public:
2018-02-11 17:43:54 +00:00
arg_map() : map_(FMT_NULL), size_(0) {}
void init(const basic_format_args<Context> &args);
~arg_map() { delete [] map_; }
basic_format_arg<Context> find(basic_string_view<char_type> name) const {
// The list is unsorted, so just return the first matching name.
for (auto it = map_, end = map_ + size_; it != end; ++it) {
if (it->name == name)
2018-01-06 17:09:50 +00:00
return it->arg;
}
return basic_format_arg<Context>();
}
};
2018-01-21 22:30:38 +00:00
template <typename OutputIt, typename Context, typename Char>
class context_base {
2018-01-14 19:00:27 +00:00
public:
typedef OutputIt iterator;
2018-01-14 19:00:27 +00:00
private:
2018-01-21 22:30:38 +00:00
basic_parse_context<Char> parse_context_;
2018-01-14 19:00:27 +00:00
iterator out_;
basic_format_args<Context> args_;
protected:
typedef Char char_type;
typedef basic_format_arg<Context> format_arg;
2018-01-21 22:30:38 +00:00
context_base(OutputIt out, basic_string_view<char_type> format_str,
basic_format_args<Context> args)
2018-01-21 22:30:38 +00:00
: parse_context_(format_str), out_(out), args_(args) {}
basic_format_args<Context> args() const { return args_; }
// Returns the argument with specified index.
format_arg do_get_arg(unsigned arg_id) {
format_arg arg = args_[arg_id];
if (!arg)
parse_context_.on_error("argument index out of range");
return arg;
}
// Checks if manual indexing is used and returns the argument with
// specified index.
format_arg get_arg(unsigned arg_id) {
return this->parse_context().check_arg_id(arg_id) ?
this->do_get_arg(arg_id) : format_arg();
}
public:
2018-01-21 22:30:38 +00:00
basic_parse_context<char_type> &parse_context() {
return parse_context_;
}
internal::error_handler error_handler() {
return parse_context_.error_handler();
}
void on_error(const char *message) { parse_context_.on_error(message); }
2018-01-14 19:00:27 +00:00
// Returns an iterator to the beginning of the output range.
2018-02-11 17:43:54 +00:00
iterator begin() { return out_; }
2018-01-14 19:00:27 +00:00
// Advances the begin iterator to ``it``.
void advance_to(iterator it) { out_ = it; }
2018-01-14 15:19:23 +00:00
};
2018-01-15 16:22:31 +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) {
2018-02-14 23:30:55 +00:00
typedef std::back_insert_iterator<Container> bi_iterator;
struct accessor: bi_iterator {
2018-03-16 20:26:11 +00:00
accessor(bi_iterator iter) : bi_iterator(iter) {}
2018-02-14 23:30:55 +00:00
using bi_iterator::container;
2018-01-15 16:22:31 +00:00
};
return *accessor(it).container;
}
} // namespace internal
2018-01-14 15:19:23 +00:00
// Formatting context.
2018-01-21 22:30:38 +00:00
template <typename OutputIt, typename Char>
2018-04-08 13:45:21 +00:00
class basic_format_context :
public internal::context_base<
OutputIt, basic_format_context<OutputIt, Char>, Char> {
public:
/** The character type for the output. */
typedef Char char_type;
// using formatter_type = formatter<T, char_type>;
template <typename T>
struct formatter_type { typedef formatter<T, char_type> type; };
private:
2018-04-08 13:45:21 +00:00
internal::arg_map<basic_format_context> map_;
2018-04-08 13:45:21 +00:00
FMT_DISALLOW_COPY_AND_ASSIGN(basic_format_context);
2018-04-08 13:45:21 +00:00
typedef internal::context_base<OutputIt, basic_format_context, Char> base;
typedef typename base::format_arg format_arg;
2018-01-06 17:09:50 +00:00
using base::get_arg;
public:
2018-01-14 19:00:27 +00:00
using typename base::iterator;
/**
\rst
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.
\endrst
*/
2018-04-08 13:45:21 +00:00
basic_format_context(OutputIt out, basic_string_view<char_type> format_str,
basic_format_args<basic_format_context> args)
2018-01-21 22:30:38 +00:00
: base(out, format_str, args) {}
format_arg next_arg() {
return this->do_get_arg(this->parse_context().next_arg_id());
}
format_arg get_arg(unsigned arg_id) { return this->do_get_arg(arg_id); }
2018-01-14 19:00:27 +00:00
// Checks if manual indexing is used and returns the argument with the
// specified name.
2018-01-06 17:09:50 +00:00
format_arg get_arg(basic_string_view<char_type> name);
};
2018-02-03 14:14:10 +00:00
template <typename Char>
struct buffer_context {
2018-04-08 13:45:21 +00:00
typedef basic_format_context<
std::back_insert_iterator<internal::basic_buffer<Char>>, Char> type;
};
2018-04-08 14:03:44 +00:00
typedef buffer_context<char>::type format_context;
typedef buffer_context<wchar_t>::type wformat_context;
2018-02-03 14:14:10 +00:00
namespace internal {
template <typename Context, typename T>
2018-03-07 15:36:13 +00:00
struct get_type {
2018-02-18 05:38:32 +00:00
typedef decltype(make_value<Context>(
2018-02-28 15:47:24 +00:00
declval<typename std::decay<T>::type&>())) value_type;
2018-02-04 16:52:43 +00:00
static const type value = value_type::type_tag;
};
2018-02-03 14:14:10 +00:00
template <typename Context>
FMT_CONSTEXPR uint64_t get_types() { return 0; }
template <typename Context, typename Arg, typename... Args>
FMT_CONSTEXPR uint64_t get_types() {
2018-02-04 16:52:43 +00:00
return get_type<Context, Arg>::value | (get_types<Context, Args...>() << 4);
2018-02-03 14:14:10 +00:00
}
template <typename Context, typename T>
FMT_CONSTEXPR basic_format_arg<Context> make_arg(const T &value) {
basic_format_arg<Context> arg;
2018-02-04 16:52:43 +00:00
arg.type_ = get_type<Context, T>::value;
2018-02-03 14:14:10 +00:00
arg.value_ = make_value<Context>(value);
return arg;
}
template <bool IS_PACKED, typename Context, typename T>
inline typename std::enable_if<IS_PACKED, value<Context>>::type
make_arg(const T &value) {
return make_value<Context>(value);
}
template <bool IS_PACKED, typename Context, typename T>
inline typename std::enable_if<!IS_PACKED, basic_format_arg<Context>>::type
2018-02-03 14:14:10 +00:00
make_arg(const T &value) {
return make_arg<Context>(value);
}
}
2018-01-06 17:09:50 +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 {
private:
static const size_t NUM_ARGS = sizeof...(Args);
// Packed is a macro on MinGW so use IS_PACKED instead.
2018-03-07 15:36:13 +00:00
static const bool IS_PACKED = NUM_ARGS < internal::max_packed_args;
typedef typename std::conditional<IS_PACKED,
internal::value<Context>, basic_format_arg<Context>>::type value_type;
// If the arguments are not packed, add one more element to mark the end.
2018-01-14 19:00:27 +00:00
value_type data_[NUM_ARGS + (IS_PACKED && NUM_ARGS != 0 ? 0 : 1)];
2018-03-20 02:47:14 +00:00
friend class basic_format_args<Context>;
public:
2018-02-03 14:14:10 +00:00
static const uint64_t TYPES;
2018-03-15 13:55:31 +00:00
#if FMT_GCC_VERSION && FMT_GCC_VERSION <= 405
2018-03-01 11:45:25 +00:00
// Workaround an array initialization bug in gcc 4.5 and earlier.
format_arg_store(const Args &... args) {
2018-03-01 11:45:25 +00:00
data_ = {internal::make_arg<IS_PACKED, Context>(args)...};
}
#else
format_arg_store(const Args &... args)
: data_{internal::make_arg<IS_PACKED, Context>(args)...} {}
2018-03-01 11:45:25 +00:00
#endif
2018-01-18 06:04:24 +00:00
basic_format_args<Context> operator*() const { return *this; }
};
2018-02-03 14:14:10 +00:00
template <typename Context, typename ...Args>
const uint64_t format_arg_store<Context, Args...>::TYPES = IS_PACKED ?
2018-02-03 14:14:10 +00:00
internal::get_types<Context, Args...>() :
-static_cast<int64_t>(NUM_ARGS);
2018-03-20 02:47:14 +00:00
/**
\rst
Constructs an `~fmt::format_arg_store` object that contains references to
arguments and can be implicitly converted to `~fmt::format_args`. `Context` can
be omitted in which case it defaults to `~fmt::context`.
2018-03-20 02:47:14 +00:00
\endrst
*/
template <typename Context, typename ...Args>
inline format_arg_store<Context, Args...> make_args(const Args & ... args) {
return format_arg_store<Context, Args...>(args...);
}
template <typename ...Args>
2018-04-08 14:03:44 +00:00
inline format_arg_store<format_context, Args...>
make_args(const Args & ... args) {
return format_arg_store<format_context, Args...>(args...);
}
/** Formatting arguments. */
template <typename Context>
class basic_format_args {
public:
typedef unsigned size_type;
typedef basic_format_arg<Context> format_arg;
private:
// To reduce compiled code size per formatting function call, types of first
2018-03-07 15:36:13 +00:00
// max_packed_args arguments are passed in the types_ field.
uint64_t types_;
union {
2018-03-07 15:36:13 +00:00
// If the number of arguments is less than max_packed_args, the argument
// values are stored in values_, otherwise they are stored in args_.
// This is done to reduce compiled code size as storing larger objects
// may require more code (at least on x86-64) even if the same amount of
// data is actually copied to stack. It saves ~10% on the bloat test.
const internal::value<Context> *values_;
const format_arg *args_;
};
typename internal::type type(unsigned index) const {
unsigned shift = index * 4;
uint64_t mask = 0xf;
return static_cast<typename internal::type>(
(types_ & (mask << shift)) >> shift);
}
friend class internal::arg_map<Context>;
void set_data(const internal::value<Context> *values) { values_ = values; }
void set_data(const format_arg *args) { args_ = args; }
format_arg get(size_type index) const {
int64_t signed_types = static_cast<int64_t>(types_);
if (signed_types < 0) {
uint64_t num_args = -signed_types;
return index < num_args ? args_[index] : format_arg();
}
format_arg arg;
2018-03-07 15:36:13 +00:00
if (index > internal::max_packed_args)
return arg;
arg.type_ = type(index);
if (arg.type_ == internal::none_type)
return arg;
internal::value<Context> &val = arg.value_;
val = values_[index];
return arg;
}
public:
basic_format_args() : types_(0) {}
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>
basic_format_args(const format_arg_store<Context, Args...> &store)
: types_(store.TYPES) {
2018-03-20 02:47:14 +00:00
set_data(store.data_);
}
/** Returns the argument at specified index. */
format_arg operator[](size_type index) const {
format_arg arg = get(index);
return arg.type_ == internal::name_arg_type ?
2018-01-06 17:09:50 +00:00
arg.value_.as_named_arg().template deserialize<Context>() : arg;
}
unsigned max_size() const {
int64_t signed_types = static_cast<int64_t>(types_);
2018-03-20 02:47:14 +00:00
return static_cast<unsigned>(
signed_types < 0 ?
-signed_types : static_cast<int64_t>(internal::max_packed_args));
}
};
2018-03-10 17:25:17 +00:00
/** An alias to ``basic_format_args<context>``. */
// It is a separate type rather than a typedef to make symbols readable.
2018-04-08 14:03:44 +00:00
struct format_args: basic_format_args<format_context> {
2018-03-04 22:46:24 +00:00
template <typename ...Args>
format_args(Args && ... arg)
2018-04-08 14:03:44 +00:00
: basic_format_args<format_context>(std::forward<Args>(arg)...) {}
2018-03-04 22:46:24 +00:00
};
2018-04-08 14:03:44 +00:00
typedef basic_format_args<wformat_context> wformat_args;
2018-01-06 17:09:50 +00:00
namespace internal {
template <typename Char>
struct named_arg_base {
basic_string_view<Char> name;
// Serialized value<context>.
2018-04-08 14:03:44 +00:00
mutable char data[sizeof(basic_format_arg<format_context>)];
2018-01-06 17:09:50 +00:00
2018-01-15 16:22:31 +00:00
named_arg_base(basic_string_view<Char> nm) : name(nm) {}
2018-01-14 19:00:27 +00:00
2018-01-06 17:09:50 +00:00
template <typename Context>
basic_format_arg<Context> deserialize() const {
basic_format_arg<Context> arg;
std::memcpy(&arg, data, sizeof(basic_format_arg<Context>));
2018-01-06 17:09:50 +00:00
return arg;
}
};
template <typename T, typename Char>
struct named_arg : named_arg_base<Char> {
const T &value;
named_arg(basic_string_view<Char> name, const T &val)
2018-01-14 19:00:27 +00:00
: named_arg_base<Char>(name), value(val) {}
2018-01-06 17:09:50 +00:00
};
}
/**
\rst
2018-03-04 17:55:17 +00:00
Returns a named argument to be used in a formatting function.
**Example**::
2018-03-04 17:55:17 +00:00
fmt::print("Elapsed time: {s:.2f} seconds", fmt::arg("s", 1.23));
\endrst
*/
template <typename T>
2018-01-06 17:09:50 +00:00
inline internal::named_arg<T, char> arg(string_view name, const T &arg) {
return internal::named_arg<T, char>(name, arg);
}
template <typename T>
2018-01-06 17:09:50 +00:00
inline internal::named_arg<T, wchar_t> arg(wstring_view name, const T &arg) {
return internal::named_arg<T, wchar_t>(name, arg);
}
2018-01-21 22:30:38 +00:00
// This function template is deleted intentionally to disable nested named
// arguments as in ``format("{}", arg("a", arg("b", 42)))``.
template <typename S, typename T, typename Char>
void arg(S, internal::named_arg<T, Char>) FMT_DELETED;
2018-03-07 15:36:13 +00:00
enum color { black, red, green, yellow, blue, magenta, cyan, white };
2018-03-04 19:25:40 +00:00
FMT_API void vprint_colored(color c, string_view format, format_args args);
/**
2017-12-30 15:42:56 +00:00
Formats a string and prints it to stdout using ANSI escape sequences to
specify color (experimental).
Example:
fmt::print_colored(fmt::RED, "Elapsed time: {0:.2f} seconds", 1.23);
*/
template <typename... Args>
2018-03-04 19:25:40 +00:00
inline void print_colored(color c, string_view format_str,
const Args & ... args) {
vprint_colored(c, format_str, make_args(args...));
}
2018-04-08 14:03:44 +00:00
format_context::iterator vformat_to(
internal::buffer &buf, string_view format_str, format_args args);
wformat_context::iterator vformat_to(
internal::wbuffer &buf, wstring_view format_str, wformat_args args);
2018-01-14 22:15:59 +00:00
template <typename Container>
2018-01-15 16:22:31 +00:00
struct is_contiguous : std::false_type {};
template <typename Char>
struct is_contiguous<std::basic_string<Char>> : std::true_type {};
template <typename Char>
struct is_contiguous<fmt::internal::basic_buffer<Char>> : std::true_type {};
/** Formats a string and writes the output to ``out``. */
template <typename Container>
typename std::enable_if<
is_contiguous<Container>::value, std::back_insert_iterator<Container>>::type
2018-01-15 16:22:31 +00:00
vformat_to(std::back_insert_iterator<Container> out,
string_view format_str, format_args args) {
auto& container = internal::get_container(out);
internal::container_buffer<Container> buf(container);
2018-01-14 22:15:59 +00:00
vformat_to(buf, format_str, args);
return std::back_inserter(container);
}
std::string vformat(string_view format_str, format_args args);
std::wstring vformat(wstring_view format_str, wformat_args 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
*/
template <typename... Args>
inline std::string format(string_view format_str, const Args & ... args) {
// This should be just
// return vformat(format_str, make_args(args...));
// but gcc has trouble optimizing the latter, so break it down.
2018-04-08 14:03:44 +00:00
format_arg_store<format_context, Args...> as(args...);
return vformat(format_str, as);
}
template <typename... Args>
inline std::wstring format(wstring_view format_str, const Args & ... args) {
2018-04-08 14:03:44 +00:00
format_arg_store<wformat_context, Args...> as(args...);
return vformat(format_str, as);
}
FMT_API void vprint(std::FILE *f, string_view format_str, format_args args);
/**
\rst
Prints formatted data to the file *f*.
**Example**::
fmt::print(stderr, "Don't {}!", "panic");
\endrst
*/
template <typename... Args>
inline void print(std::FILE *f, string_view format_str, const Args & ... args) {
2018-04-08 14:03:44 +00:00
format_arg_store<format_context, Args...> as(args...);
vprint(f, format_str, as);
}
FMT_API void vprint(string_view format_str, format_args args);
/**
\rst
Prints formatted data to ``stdout``.
**Example**::
fmt::print("Elapsed time: {0:.2f} seconds", 1.23);
\endrst
*/
template <typename... Args>
inline void print(string_view format_str, const Args & ... args) {
2018-04-08 14:03:44 +00:00
format_arg_store<format_context, Args...> as(args...);
vprint(format_str, as);
}
} // namespace fmt
#endif // FMT_CORE_H_