fmtlegacy/include/fmt/format.h

3331 lines
97 KiB
C
Raw Normal View History

/*
Formatting library for C++
2016-05-04 13:27:03 +00:00
Copyright (c) 2012 - 2016, Victor Zverovich
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef FMT_FORMAT_H_
#define FMT_FORMAT_H_
2018-01-15 19:30:53 +00:00
#include <algorithm>
#include <cassert>
#include <cmath>
#include <cstring>
#include <limits>
#include <memory>
#include <stdexcept>
2017-08-26 16:09:43 +00:00
#include <stdint.h>
2018-01-20 18:28:10 +00:00
#include "core.h"
#ifdef _SECURE_SCL
# define FMT_SECURE_SCL _SECURE_SCL
#else
# define FMT_SECURE_SCL 0
#endif
#if FMT_SECURE_SCL
# include <iterator>
#endif
2017-12-09 16:56:44 +00:00
#ifdef __has_builtin
# define FMT_HAS_BUILTIN(x) __has_builtin(x)
#else
# define FMT_HAS_BUILTIN(x) 0
#endif
#ifdef __GNUC__
# if FMT_GCC_VERSION >= 406
# pragma GCC diagnostic push
// Disable the warning about declaration shadowing because it affects too
// many valid cases.
# pragma GCC diagnostic ignored "-Wshadow"
// Disable the warning about implicit conversions that may change the sign of
// an integer; silencing it otherwise would require many explicit casts.
# pragma GCC diagnostic ignored "-Wsign-conversion"
# endif
#endif
2017-11-04 15:23:24 +00:00
#ifdef __clang__
# define FMT_CLANG_VERSION (__clang_major__ * 100 + __clang_minor__)
#endif
#if defined(__INTEL_COMPILER)
# define FMT_ICC_VERSION __INTEL_COMPILER
#elif defined(__ICL)
# define FMT_ICC_VERSION __ICL
#endif
#if defined(__clang__) && !defined(FMT_ICC_VERSION)
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wdocumentation-unknown-command"
2017-11-04 15:23:24 +00:00
# pragma clang diagnostic ignored "-Wgnu-string-literal-operator-template"
2016-06-15 05:17:34 +00:00
# pragma clang diagnostic ignored "-Wpadded"
#endif
#ifdef __GNUC_LIBSTD__
# define FMT_GNUC_LIBSTD_VERSION (__GNUC_LIBSTD__ * 100 + __GNUC_LIBSTD_MINOR__)
#endif
#ifdef __has_cpp_attribute
# define FMT_HAS_CPP_ATTRIBUTE(x) __has_cpp_attribute(x)
#else
# define FMT_HAS_CPP_ATTRIBUTE(x) 0
#endif
#ifndef FMT_THROW
# if FMT_EXCEPTIONS
# define FMT_THROW(x) throw x
# else
# define FMT_THROW(x) assert(false)
# endif
#endif
// Use the compiler's attribute noreturn.
#if defined(__MINGW32__) || defined(__MINGW64__)
# define FMT_NORETURN __attribute__((noreturn))
#elif FMT_HAS_CPP_ATTRIBUTE(noreturn)
# define FMT_NORETURN [[noreturn]]
#else
# define FMT_NORETURN
#endif
#ifndef FMT_USE_USER_DEFINED_LITERALS
// For Intel's compiler both it and the system gcc/msc must support UDLs.
2017-09-04 20:52:29 +00:00
# if (FMT_HAS_FEATURE(cxx_user_literals) || \
FMT_GCC_VERSION >= 407 || FMT_MSC_VER >= 1900) && \
(!defined(FMT_ICC_VERSION) || FMT_ICC_VERSION >= 1500)
2017-08-27 13:45:59 +00:00
# define FMT_USE_USER_DEFINED_LITERALS 1
# else
# define FMT_USE_USER_DEFINED_LITERALS 0
# endif
#endif
2017-11-04 15:23:24 +00:00
#if FMT_USE_USER_DEFINED_LITERALS && \
(FMT_GCC_VERSION >= 600 || FMT_CLANG_VERSION >= 304)
# define FMT_UDL_TEMPLATE 1
#else
# define FMT_UDL_TEMPLATE 0
#endif
#ifndef FMT_USE_EXTERN_TEMPLATES
# ifndef FMT_HEADER_ONLY
# define FMT_USE_EXTERN_TEMPLATES \
(FMT_CLANG_VERSION >= 209 || (FMT_GCC_VERSION >= 303 && FMT_HAS_GXX_CXX11))
# else
# define FMT_USE_EXTERN_TEMPLATES 0
# endif
#endif
#if FMT_GCC_VERSION >= 400 || FMT_HAS_BUILTIN(__builtin_clz)
# define FMT_BUILTIN_CLZ(n) __builtin_clz(n)
#endif
#if FMT_GCC_VERSION >= 400 || FMT_HAS_BUILTIN(__builtin_clzll)
# define FMT_BUILTIN_CLZLL(n) __builtin_clzll(n)
#endif
// Some compilers masquerade as both MSVC and GCC-likes or otherwise support
// __builtin_clz and __builtin_clzll, so only define FMT_BUILTIN_CLZ using the
// MSVC intrinsics if the clz and clzll builtins are not available.
#if FMT_MSC_VER && !defined(FMT_BUILTIN_CLZLL) && !defined(_MANAGED)
# include <intrin.h> // _BitScanReverse, _BitScanReverse64
namespace fmt {
namespace internal {
# pragma intrinsic(_BitScanReverse)
inline uint32_t clz(uint32_t x) {
unsigned long r = 0;
_BitScanReverse(&r, x);
assert(x != 0);
// Static analysis complains about using uninitialized data
// "r", but the only way that can happen is if "x" is 0,
// which the callers guarantee to not happen.
# pragma warning(suppress: 6102)
return 31 - r;
}
# define FMT_BUILTIN_CLZ(n) fmt::internal::clz(n)
# ifdef _WIN64
# pragma intrinsic(_BitScanReverse64)
# endif
inline uint32_t clzll(uint64_t x) {
unsigned long r = 0;
# ifdef _WIN64
_BitScanReverse64(&r, x);
# else
// Scan the high 32 bits.
if (_BitScanReverse(&r, static_cast<uint32_t>(x >> 32)))
return 63 - (r + 32);
// Scan the low 32 bits.
_BitScanReverse(&r, static_cast<uint32_t>(x));
# endif
assert(x != 0);
// Static analysis complains about using uninitialized data
// "r", but the only way that can happen is if "x" is 0,
// which the callers guarantee to not happen.
# pragma warning(suppress: 6102)
return 63 - r;
}
# define FMT_BUILTIN_CLZLL(n) fmt::internal::clzll(n)
}
}
#endif
namespace fmt {
namespace internal {
2016-12-30 21:12:27 +00:00
struct dummy_int {
int data[2];
operator int() const { return 0; }
};
2016-12-30 21:12:27 +00:00
typedef std::numeric_limits<fmt::internal::dummy_int> fputil;
// Dummy implementations of system functions such as signbit and ecvt called
// if the latter are not available.
2016-12-30 21:12:27 +00:00
inline dummy_int signbit(...) { return dummy_int(); }
inline dummy_int _ecvt_s(...) { return dummy_int(); }
inline dummy_int isinf(...) { return dummy_int(); }
inline dummy_int _finite(...) { return dummy_int(); }
inline dummy_int isnan(...) { return dummy_int(); }
inline dummy_int _isnan(...) { return dummy_int(); }
}
} // namespace fmt
namespace std {
// Standard permits specialization of std::numeric_limits. This specialization
// is used to resolve ambiguity between isinf and std::isinf in glibc:
// https://gcc.gnu.org/bugzilla/show_bug.cgi?id=48891
// and the same for isnan and signbit.
template <>
2016-12-30 21:12:27 +00:00
class numeric_limits<fmt::internal::dummy_int> :
public std::numeric_limits<int> {
public:
// Portable version of isinf.
template <typename T>
static bool isinfinity(T x) {
using namespace fmt::internal;
// The resolution "priority" is:
// isinf macro > std::isinf > ::isinf > fmt::internal::isinf
if (const_check(sizeof(isinf(x)) == sizeof(bool) ||
sizeof(isinf(x)) == sizeof(int))) {
return isinf(x) != 0;
}
return !_finite(static_cast<double>(x));
}
// Portable version of isnan.
template <typename T>
static bool isnotanumber(T x) {
using namespace fmt::internal;
if (const_check(sizeof(isnan(x)) == sizeof(bool) ||
sizeof(isnan(x)) == sizeof(int))) {
return isnan(x) != 0;
}
return _isnan(static_cast<double>(x)) != 0;
}
// Portable version of signbit.
static bool isnegative(double x) {
using namespace fmt::internal;
2018-01-22 00:41:55 +00:00
if (const_check(sizeof(signbit(x)) == sizeof(bool) ||
sizeof(signbit(x)) == sizeof(int))) {
return signbit(x) != 0;
2018-01-22 00:41:55 +00:00
}
if (x < 0) return true;
if (!isnotanumber(x)) return false;
int dec = 0, sign = 0;
char buffer[2]; // The buffer size must be >= 2 or _ecvt_s will fail.
_ecvt_s(buffer, sizeof(buffer), x, 0, &dec, &sign);
return sign != 0;
}
};
} // namespace std
namespace fmt {
2018-01-06 17:09:50 +00:00
template <typename Range>
class basic_writer;
2016-06-14 15:11:33 +00:00
/** A formatting error such as invalid format string. */
2016-08-25 15:38:07 +00:00
class format_error : public std::runtime_error {
public:
explicit format_error(const char *message)
: std::runtime_error(message) {}
explicit format_error(const std::string &message)
: std::runtime_error(message) {}
FMT_API ~format_error() throw();
};
namespace internal {
// Casts nonnegative integer to unsigned.
template <typename Int>
2017-11-19 14:35:23 +00:00
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);
}
2017-02-19 16:41:38 +00:00
// The number of characters to store in the basic_memory_buffer object itself
// to avoid dynamic memory allocation.
enum { INLINE_BUFFER_SIZE = 500 };
#if FMT_SECURE_SCL
// Use checked iterator to avoid warnings on MSVC.
template <typename T>
inline stdext::checked_array_iterator<T*> make_ptr(T *ptr, std::size_t size) {
return stdext::checked_array_iterator<T*>(ptr, size);
}
#else
template <typename T>
inline T *make_ptr(T *ptr, std::size_t) { return ptr; }
#endif
template <typename T>
template <typename U>
2017-02-14 17:08:37 +00:00
void basic_buffer<T>::append(const U *begin, const U *end) {
std::size_t new_size = size_ + internal::to_unsigned(end - begin);
reserve(new_size);
std::uninitialized_copy(begin, end,
internal::make_ptr(ptr_, capacity_) + size_);
size_ = new_size;
}
2018-01-14 20:25:03 +00:00
} // namespace internal
// A wrapper around std::locale used to reduce compile times since <locale>
// is very heavy.
class locale;
class locale_provider {
public:
virtual ~locale_provider() {}
virtual fmt::locale locale();
};
/**
\rst
A dynamically growing memory buffer for trivially copyable/constructible types
with the first SIZE elements stored in the object itself.
You can use one of the following typedefs for common character types:
+----------------+------------------------------+
| Type | Definition |
+================+==============================+
| memory_buffer | basic_memory_buffer<char> |
+----------------+------------------------------+
| wmemory_buffer | basic_memory_buffer<wchar_t> |
+----------------+------------------------------+
**Example**::
memory_buffer out;
format_to(out, "The answer is {}.", 42);
This will write the following output to the ``out`` object:
.. code-block:: none
The answer is 42.
The output can be converted to an ``std::string`` with ``to_string(out)``.
\endrst
*/
template <typename T, std::size_t SIZE = internal::INLINE_BUFFER_SIZE,
typename Allocator = std::allocator<T> >
2018-01-14 20:25:03 +00:00
class basic_memory_buffer: private Allocator, public internal::basic_buffer<T> {
private:
T store_[SIZE];
// Deallocate memory allocated by the buffer.
void deallocate() {
2017-03-12 14:30:20 +00:00
T* data = this->data();
if (data != store_) Allocator::deallocate(data, this->capacity());
}
protected:
void grow(std::size_t size);
public:
explicit basic_memory_buffer(const Allocator &alloc = Allocator())
2017-03-12 14:30:20 +00:00
: Allocator(alloc) {
this->set(store_, SIZE);
}
~basic_memory_buffer() { deallocate(); }
private:
// Move data from other to this buffer.
void move(basic_memory_buffer &other) {
Allocator &this_alloc = *this, &other_alloc = other;
this_alloc = std::move(other_alloc);
2017-03-12 14:30:20 +00:00
T* data = other.data();
std::size_t size = other.size(), capacity = other.capacity();
if (data == other.store_) {
this->set(store_, capacity);
std::uninitialized_copy(other.store_, other.store_ + size,
internal::make_ptr(store_, capacity));
} else {
2017-03-12 14:30:20 +00:00
this->set(data, capacity);
// Set pointer to the inline array so that delete is not called
// when deallocating.
2017-03-12 14:30:20 +00:00
other.set(other.store_, 0);
}
2017-03-12 14:30:20 +00:00
this->resize(size);
}
public:
/**
\rst
Constructs a :class:`fmt::basic_memory_buffer` object moving the content
of the other object to it.
\endrst
*/
basic_memory_buffer(basic_memory_buffer &&other) {
move(other);
}
/**
\rst
Moves the content of the other ``basic_memory_buffer`` object to this one.
\endrst
*/
basic_memory_buffer &operator=(basic_memory_buffer &&other) {
assert(this != &other);
deallocate();
move(other);
return *this;
}
// Returns a copy of the allocator associated with this buffer.
Allocator get_allocator() const { return *this; }
};
template <typename T, std::size_t SIZE, typename Allocator>
void basic_memory_buffer<T, SIZE, Allocator>::grow(std::size_t size) {
2017-03-12 14:30:20 +00:00
std::size_t old_capacity = this->capacity();
std::size_t new_capacity = old_capacity + old_capacity / 2;
if (size > new_capacity)
new_capacity = size;
2017-03-12 14:30:20 +00:00
T *old_data = this->data();
T *new_data = this->allocate(new_capacity);
// The following code doesn't throw, so the raw pointer above doesn't leak.
2017-03-12 14:30:20 +00:00
std::uninitialized_copy(old_data, old_data + this->size(),
internal::make_ptr(new_data, new_capacity));
this->set(new_data, new_capacity);
// deallocate must not throw according to the standard, but even if it does,
// the buffer already uses the new storage and will deallocate it in
// destructor.
if (old_data != store_)
Allocator::deallocate(old_data, old_capacity);
}
typedef basic_memory_buffer<char> memory_buffer;
typedef basic_memory_buffer<wchar_t> wmemory_buffer;
/**
\rst
A fixed-size memory buffer. For a dynamically growing buffer use
:class:`fmt::basic_memory_buffer`.
Trying to increase the buffer size past the initial capacity will throw
``std::runtime_error``.
\endrst
*/
template <typename Char>
2018-01-14 20:25:03 +00:00
class basic_fixed_buffer : public internal::basic_buffer<Char> {
public:
/**
\rst
2017-02-19 14:46:51 +00:00
Constructs a :class:`fmt::basic_fixed_buffer` object for *array* of the
given size.
\endrst
*/
2017-03-12 14:30:20 +00:00
basic_fixed_buffer(Char *array, std::size_t size) {
this->set(array, size);
}
/**
\rst
2017-02-19 14:46:51 +00:00
Constructs a :class:`fmt::basic_fixed_buffer` object for *array* of the
size known at compile time.
\endrst
*/
template <std::size_t SIZE>
2017-03-12 14:30:20 +00:00
explicit basic_fixed_buffer(Char (&array)[SIZE]) {
this->set(array, SIZE);
}
protected:
FMT_API void grow(std::size_t size);
};
namespace internal {
template <typename Char>
2017-02-19 14:46:51 +00:00
class basic_char_traits {
public:
static Char cast(int value) { return static_cast<Char>(value); }
};
template <typename Char>
2017-02-19 14:46:51 +00:00
class char_traits;
template <>
2017-02-19 14:46:51 +00:00
class char_traits<char> : public basic_char_traits<char> {
private:
// Conversion from wchar_t to char is not allowed.
static char convert(wchar_t);
public:
static char convert(char value) { return value; }
// Formats a floating-point number.
template <typename T>
FMT_API static int format_float(char *buffer, std::size_t size,
const char *format, unsigned width, int precision, T value);
};
template <>
2017-02-19 14:46:51 +00:00
class char_traits<wchar_t> : public basic_char_traits<wchar_t> {
public:
static wchar_t convert(char value) { return value; }
static wchar_t convert(wchar_t value) { return value; }
template <typename T>
FMT_API static int format_float(wchar_t *buffer, std::size_t size,
const wchar_t *format, unsigned width, int precision, T value);
};
#if FMT_USE_EXTERN_TEMPLATES
extern template int char_traits<char>::format_float<double>(
char *buffer, std::size_t size, const char* format, unsigned width,
int precision, double value);
extern template int char_traits<char>::format_float<long double>(
char *buffer, std::size_t size, const char* format, unsigned width,
int precision, long double value);
extern template int char_traits<wchar_t>::format_float<double>(
wchar_t *buffer, std::size_t size, const wchar_t* format, unsigned width,
int precision, double value);
extern template int char_traits<wchar_t>::format_float<long double>(
wchar_t *buffer, std::size_t size, const wchar_t* format, unsigned width,
int precision, long double value);
#endif
2018-01-15 16:22:31 +00:00
template <typename Container>
2018-01-15 19:30:53 +00:00
inline typename std::enable_if<
is_contiguous<Container>::value, typename Container::value_type*>::type
reserve(std::back_insert_iterator<Container> &it, std::size_t n) {
2018-01-15 16:22:31 +00:00
Container &c = internal::get_container(it);
std::size_t size = c.size();
c.resize(size + n);
return &c[size];
}
template <typename Iterator>
inline Iterator &reserve(Iterator &it, std::size_t) { return it; }
2017-08-13 20:09:02 +00:00
template <typename Char>
class null_terminating_iterator;
template <typename Char>
2017-10-15 23:54:47 +00:00
constexpr const Char *pointer_from(null_terminating_iterator<Char> it);
2017-08-13 20:09:02 +00:00
// An iterator that produces a null terminator on *end. This simplifies parsing
// and allows comparing the performance of processing a null-terminated string
// vs string_view.
template <typename Char>
class null_terminating_iterator {
public:
using difference_type = std::ptrdiff_t;
using value_type = Char;
using pointer = const Char*;
using reference = const Char&;
using iterator_category = std::random_access_iterator_tag;
2017-08-13 20:09:02 +00:00
null_terminating_iterator() : ptr_(0), end_(0) {}
constexpr null_terminating_iterator(const Char *ptr, const Char *end)
2017-08-13 20:09:02 +00:00
: ptr_(ptr), end_(end) {}
2017-09-17 15:32:57 +00:00
template <typename Range>
constexpr explicit null_terminating_iterator(const Range &r)
2017-09-17 15:32:57 +00:00
: ptr_(r.begin()), end_(r.end()) {}
2017-08-13 20:09:02 +00:00
null_terminating_iterator &operator=(const Char *ptr) {
assert(ptr <= end_);
ptr_ = ptr;
return *this;
}
constexpr Char operator*() const {
2017-08-13 20:09:02 +00:00
return ptr_ != end_ ? *ptr_ : 0;
}
constexpr null_terminating_iterator operator++() {
2017-08-13 20:09:02 +00:00
++ptr_;
return *this;
}
constexpr null_terminating_iterator operator++(int) {
2017-08-13 20:09:02 +00:00
null_terminating_iterator result(*this);
++ptr_;
return result;
}
constexpr null_terminating_iterator operator--() {
2017-08-13 20:09:02 +00:00
--ptr_;
return *this;
}
constexpr null_terminating_iterator operator+(difference_type n) {
2017-08-13 20:09:02 +00:00
return null_terminating_iterator(ptr_ + n, end_);
}
constexpr null_terminating_iterator operator-(difference_type n) {
2017-10-27 14:25:29 +00:00
return null_terminating_iterator(ptr_ - n, end_);
}
constexpr null_terminating_iterator operator+=(difference_type n) {
2017-08-13 20:09:02 +00:00
ptr_ += n;
return *this;
}
constexpr difference_type operator-(null_terminating_iterator other) const {
2017-08-13 20:09:02 +00:00
return ptr_ - other.ptr_;
}
constexpr bool operator!=(null_terminating_iterator other) const {
2017-08-13 20:09:02 +00:00
return ptr_ != other.ptr_;
}
bool operator>=(null_terminating_iterator other) const {
return ptr_ >= other.ptr_;
}
2017-10-18 13:36:08 +00:00
friend constexpr const Char *pointer_from<Char>(null_terminating_iterator it);
2017-08-13 20:09:02 +00:00
private:
const Char *ptr_;
const Char *end_;
};
template <typename T>
2017-10-15 23:54:47 +00:00
constexpr const T *pointer_from(const T *p) { return p; }
2017-08-13 20:09:02 +00:00
template <typename Char>
2017-10-15 23:54:47 +00:00
constexpr const Char *pointer_from(null_terminating_iterator<Char> it) {
2017-08-13 20:09:02 +00:00
return it.ptr_;
}
2018-01-18 06:04:24 +00:00
// An output iterator that counts the number of objects written to it and
// discards them.
template <typename T>
class counting_iterator {
private:
std::size_t& count_;
mutable T blackhole_;
public:
2018-01-20 14:40:42 +00:00
using iterator_category = std::output_iterator_tag;
using value_type = T;
using difference_type = std::ptrdiff_t;
using pointer = T*;
using reference = T&;
2018-01-18 06:04:24 +00:00
explicit counting_iterator(std::size_t &count): count_(count) {}
counting_iterator(const counting_iterator &other): count_(other.count_) {}
counting_iterator& operator=(const counting_iterator &other) {
count_ = other.count_;
return *this;
}
counting_iterator& operator++() {
++count_;
return *this;
}
counting_iterator operator++(int) { return ++*this; }
T &operator*() const { return blackhole_; }
};
// Returns true if value is negative, false otherwise.
// Same as (value < 0) but doesn't produce warnings if T is an unsigned type.
template <typename T>
constexpr typename std::enable_if<
std::numeric_limits<T>::is_signed, bool>::type is_negative(T value) {
2017-02-19 14:46:51 +00:00
return value < 0;
}
template <typename T>
constexpr typename std::enable_if<
!std::numeric_limits<T>::is_signed, bool>::type is_negative(T) {
2017-02-19 14:46:51 +00:00
return false;
}
template <typename T>
2017-02-19 14:46:51 +00:00
struct int_traits {
// Smallest of uint32_t and uint64_t that is large enough to represent
// all values of T.
2017-09-04 20:56:14 +00:00
typedef typename std::conditional<
2017-02-19 14:46:51 +00:00
std::numeric_limits<T>::digits <= 32, uint32_t, uint64_t>::type main_type;
};
// Static data is placed in this class template to allow header-only
// configuration.
template <typename T = void>
2017-02-19 14:46:51 +00:00
struct FMT_API basic_data {
static const uint32_t POWERS_OF_10_32[];
static const uint64_t POWERS_OF_10_64[];
static const char DIGITS[];
};
#if FMT_USE_EXTERN_TEMPLATES
2017-02-19 14:46:51 +00:00
extern template struct basic_data<void>;
#endif
2017-02-19 14:46:51 +00:00
typedef basic_data<> data;
#ifdef FMT_BUILTIN_CLZLL
// Returns the number of decimal digits in n. Leading zeros are not counted
// except for n == 0 in which case count_digits returns 1.
inline unsigned count_digits(uint64_t n) {
// Based on http://graphics.stanford.edu/~seander/bithacks.html#IntegerLog10
// and the benchmark https://github.com/localvoid/cxx-benchmark-count-digits.
int t = (64 - FMT_BUILTIN_CLZLL(n | 1)) * 1233 >> 12;
2017-02-19 14:46:51 +00:00
return to_unsigned(t) - (n < data::POWERS_OF_10_64[t]) + 1;
}
#else
// Fallback version of count_digits used when __builtin_clz is not available.
inline unsigned count_digits(uint64_t n) {
unsigned count = 1;
for (;;) {
// Integer division is slow so do it for a group of four digits instead
// of for every digit. The idea comes from the talk by Alexandrescu
// "Three Optimization Tips for C++". See speed-test for a comparison.
if (n < 10) return count;
if (n < 100) return count + 1;
if (n < 1000) return count + 2;
if (n < 10000) return count + 3;
n /= 10000u;
count += 4;
}
}
#endif
#if FMT_HAS_CPP_ATTRIBUTE(always_inline)
# define FMT_ALWAYS_INLINE __attribute__((always_inline))
#else
# define FMT_ALWAYS_INLINE
#endif
template <typename Handler>
inline char *lg(uint32_t n, Handler h) FMT_ALWAYS_INLINE;
// Computes g = floor(log10(n)) and calls h.on<g>(n);
template <typename Handler>
inline char *lg(uint32_t n, Handler h) {
return n < 100 ? n < 10 ? h.template on<0>(n) : h.template on<1>(n)
: n < 1000000
? n < 10000 ? n < 1000 ? h.template on<2>(n)
: h.template on<3>(n)
: n < 100000 ? h.template on<4>(n)
: h.template on<5>(n)
: n < 100000000 ? n < 10000000 ? h.template on<6>(n)
: h.template on<7>(n)
: n < 1000000000 ? h.template on<8>(n)
: h.template on<9>(n);
}
// An lg handler that formats a decimal number.
// Usage: lg(n, decimal_formatter(buffer));
class decimal_formatter {
private:
char *buffer_;
void write_pair(unsigned N, uint32_t index) {
std::memcpy(buffer_ + N, data::DIGITS + index * 2, 2);
}
public:
explicit decimal_formatter(char *buf) : buffer_(buf) {}
template <unsigned N> char *on(uint32_t u) {
if (N == 0) {
*buffer_ = static_cast<char>(u) + '0';
} else if (N == 1) {
write_pair(0, u);
} else {
2017-12-11 00:09:35 +00:00
// The idea of using 4.32 fixed-point numbers is based on
// https://github.com/jeaiii/itoa
unsigned n = N - 1;
unsigned a = n / 5 * n * 53 / 16;
uint64_t t = ((1ULL << (32 + a)) / data::POWERS_OF_10_32[n] + 1 - n / 9);
t = ((t * u) >> a) + n / 5 * 4;
write_pair(0, t >> 32);
for (int i = 2; i < N; i += 2) {
t = 100ULL * static_cast<uint32_t>(t);
write_pair(i, t >> 32);
}
if (N % 2 == 0) {
buffer_[N] = static_cast<char>(
(10ULL * static_cast<uint32_t>(t)) >> 32) + '0';
}
}
return buffer_ += N + 1;
}
};
// An lg handler that formats a decimal number with a terminating null.
class decimal_formatter_null : public decimal_formatter {
public:
explicit decimal_formatter_null(char *buf) : decimal_formatter(buf) {}
template <unsigned N> char *on(uint32_t u) {
char *buf = decimal_formatter::on<N>(u);
*buf = '\0';
return buf;
}
};
#ifdef FMT_BUILTIN_CLZ
// Optional version of count_digits for better performance on 32-bit platforms.
inline unsigned count_digits(uint32_t n) {
int t = (32 - FMT_BUILTIN_CLZ(n | 1)) * 1233 >> 12;
2017-02-19 14:46:51 +00:00
return to_unsigned(t) - (n < data::POWERS_OF_10_32[t]) + 1;
}
#endif
// A functor that doesn't add a thousands separator.
2017-02-19 14:46:51 +00:00
struct no_thousands_sep {
template <typename Char>
void operator()(Char *) {}
};
// A functor that adds a thousands separator.
2017-03-25 15:20:06 +00:00
template <typename Char>
2017-02-19 14:46:51 +00:00
class add_thousands_sep {
private:
2017-09-04 20:12:52 +00:00
basic_string_view<Char> sep_;
// Index of a decimal digit with the least significant digit having index 0.
unsigned digit_index_;
public:
2017-09-04 20:12:52 +00:00
explicit add_thousands_sep(basic_string_view<Char> sep)
2017-02-19 14:46:51 +00:00
: sep_(sep), digit_index_(0) {}
void operator()(Char *&buffer) {
if (++digit_index_ % 3 != 0)
return;
buffer -= sep_.size();
2016-05-07 14:10:40 +00:00
std::uninitialized_copy(sep_.data(), sep_.data() + sep_.size(),
internal::make_ptr(buffer, sep_.size()));
}
};
template <typename Char>
2017-12-27 01:22:07 +00:00
Char thousands_sep(locale_provider *lp);
// Formats a decimal unsigned integer value writing into buffer.
// thousands_sep is a functor that is called after writing each char to
// add a thousands separator if necessary.
template <typename UInt, typename Char, typename ThousandsSep>
2018-01-15 19:30:53 +00:00
inline Char *format_decimal(Char *buffer, UInt value, unsigned num_digits,
ThousandsSep thousands_sep) {
buffer += num_digits;
2018-01-15 19:30:53 +00:00
Char *end = buffer;
while (value >= 100) {
// Integer division is slow so do it for a group of two digits instead
// of for every digit. The idea comes from the talk by Alexandrescu
// "Three Optimization Tips for C++". See speed-test for a comparison.
unsigned index = static_cast<unsigned>((value % 100) * 2);
value /= 100;
2017-02-19 14:46:51 +00:00
*--buffer = data::DIGITS[index + 1];
thousands_sep(buffer);
2017-02-19 14:46:51 +00:00
*--buffer = data::DIGITS[index];
thousands_sep(buffer);
}
if (value < 10) {
*--buffer = static_cast<char>('0' + value);
2018-01-15 19:30:53 +00:00
return end;
}
unsigned index = static_cast<unsigned>(value * 2);
2017-02-19 14:46:51 +00:00
*--buffer = data::DIGITS[index + 1];
thousands_sep(buffer);
2017-02-19 14:46:51 +00:00
*--buffer = data::DIGITS[index];
2018-01-15 19:30:53 +00:00
return end;
}
2018-01-15 19:30:53 +00:00
template <typename UInt, typename Iterator, typename ThousandsSep>
inline Iterator format_decimal(
Iterator out, UInt value, unsigned num_digits, ThousandsSep thousands_sep) {
// Buffer should be large enough to hold all digits (digits10 + 1) and null.
char buffer[std::numeric_limits<UInt>::digits10 + 2];
2018-01-15 16:22:31 +00:00
format_decimal(buffer, value, num_digits, no_thousands_sep());
2018-01-15 19:30:53 +00:00
return std::copy_n(buffer, num_digits, out);
}
template <typename It, typename UInt>
inline It format_decimal(It out, UInt value, unsigned num_digits) {
return format_decimal(out, value, num_digits, no_thousands_sep());
}
template <unsigned BASE_BITS, typename Char, typename UInt>
inline Char *format_uint(Char *buffer, UInt value, unsigned num_digits,
bool upper = false) {
buffer += num_digits;
Char *end = buffer;
do {
const char *digits = upper ? "0123456789ABCDEF" : "0123456789abcdef";
unsigned digit = (value & ((1 << BASE_BITS) - 1));
*--buffer = BASE_BITS < 4 ? static_cast<char>('0' + digit) : digits[digit];
} while ((value >>= BASE_BITS) != 0);
return end;
}
template <unsigned BASE_BITS, typename It, typename UInt>
inline It format_uint(It out, UInt value, unsigned num_digits,
bool upper = false) {
// Buffer should be large enough to hold all digits (digits / BASE_BITS + 1)
// and null.
char buffer[std::numeric_limits<UInt>::digits / BASE_BITS + 2];
format_uint<BASE_BITS>(buffer, value, num_digits, upper);
return std::copy_n(buffer, num_digits, out);
}
#ifndef _WIN32
# define FMT_USE_WINDOWS_H 0
#elif !defined(FMT_USE_WINDOWS_H)
# define FMT_USE_WINDOWS_H 1
#endif
// Define FMT_USE_WINDOWS_H to 0 to disable use of windows.h.
// All the functionality that relies on it will be disabled too.
#if FMT_USE_WINDOWS_H
// A converter from UTF-8 to UTF-16.
// It is only provided for Windows since other systems support UTF-8 natively.
2017-02-19 14:46:51 +00:00
class utf8_to_utf16 {
private:
2017-02-19 14:46:51 +00:00
wmemory_buffer buffer_;
public:
2017-02-19 14:46:51 +00:00
FMT_API explicit utf8_to_utf16(string_view s);
operator wstring_view() const { return wstring_view(&buffer_[0], size()); }
size_t size() const { return buffer_.size() - 1; }
const wchar_t *c_str() const { return &buffer_[0]; }
std::wstring str() const { return std::wstring(&buffer_[0], size()); }
};
// A converter from UTF-16 to UTF-8.
// It is only provided for Windows since other systems support UTF-8 natively.
2017-02-19 16:41:38 +00:00
class utf16_to_utf8 {
private:
2017-02-19 14:46:51 +00:00
memory_buffer buffer_;
public:
2017-02-19 16:41:38 +00:00
utf16_to_utf8() {}
FMT_API explicit utf16_to_utf8(wstring_view s);
operator string_view() const { return string_view(&buffer_[0], size()); }
size_t size() const { return buffer_.size() - 1; }
const char *c_str() const { return &buffer_[0]; }
std::string str() const { return std::string(&buffer_[0], size()); }
// Performs conversion returning a system error code instead of
// throwing exception on conversion error. This method may still throw
// in case of memory allocation error.
FMT_API int convert(wstring_view s);
};
2018-01-15 16:22:31 +00:00
FMT_API void format_windows_error(fmt::internal::buffer &out, int error_code,
fmt::string_view message) FMT_NOEXCEPT;
#endif
template <typename T = void>
2017-02-19 16:41:38 +00:00
struct null {};
} // namespace internal
2016-12-27 15:43:25 +00:00
struct monostate {};
/**
\rst
Visits an argument dispatching to the appropriate visit method based on
the argument type. For example, if the argument type is ``double`` then
``vis(value)`` will be called with the value of type ``double``.
\endrst
*/
template <typename Visitor, typename Context>
constexpr typename std::result_of<Visitor(int)>::type
visit(Visitor &&vis, basic_arg<Context> arg) {
2017-12-02 17:44:48 +00:00
using char_type = typename Context::char_type;
switch (arg.type_) {
case internal::NONE:
2016-12-27 15:43:25 +00:00
return vis(monostate());
case internal::NAMED_ARG:
FMT_ASSERT(false, "invalid argument type");
break;
case internal::INT:
return vis(arg.value_.int_value);
case internal::UINT:
return vis(arg.value_.uint_value);
case internal::LONG_LONG:
return vis(arg.value_.long_long_value);
case internal::ULONG_LONG:
return vis(arg.value_.ulong_long_value);
case internal::BOOL:
return vis(arg.value_.int_value != 0);
case internal::CHAR:
2017-12-02 17:44:48 +00:00
return vis(static_cast<char_type>(arg.value_.int_value));
case internal::DOUBLE:
return vis(arg.value_.double_value);
case internal::LONG_DOUBLE:
return vis(arg.value_.long_double_value);
case internal::CSTRING:
return vis(arg.value_.string.value);
case internal::STRING:
2017-12-02 17:44:48 +00:00
return vis(basic_string_view<char_type>(
arg.value_.string.value, arg.value_.string.size));
case internal::POINTER:
return vis(arg.value_.pointer);
case internal::CUSTOM:
2017-12-02 17:44:48 +00:00
return vis(typename basic_arg<Context>::handle(arg.value_.custom));
}
return typename std::result_of<Visitor(int)>::type();
}
2017-02-19 16:41:38 +00:00
enum alignment {
ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTER, ALIGN_NUMERIC
};
// Flags.
2017-11-24 15:54:22 +00:00
enum {SIGN_FLAG = 1, PLUS_FLAG = 2, MINUS_FLAG = 4, HASH_FLAG = 8};
enum format_spec_tag {fill_tag, align_tag, width_tag, type_tag};
// Format specifier.
template <typename T, format_spec_tag>
class format_spec {
private:
T value_;
public:
typedef T value_type;
explicit format_spec(T value) : value_(value) {}
T value() const { return value_; }
};
// template <typename Char>
// using fill_spec = format_spec<Char, fill_tag>;
template <typename Char>
class fill_spec : public format_spec<Char, fill_tag> {
public:
explicit fill_spec(Char value) : format_spec<Char, fill_tag>(value) {}
};
typedef format_spec<unsigned, width_tag> width_spec;
typedef format_spec<char, type_tag> type_spec;
// An empty format specifier.
2017-02-19 16:41:38 +00:00
struct empty_spec {};
2017-02-19 16:41:38 +00:00
// An alignment specifier.
struct align_spec : empty_spec {
unsigned width_;
// Fill is always wchar_t and cast to char if necessary to avoid having
// two specialization of AlignSpec and its subclasses.
wchar_t fill_;
2017-02-19 16:41:38 +00:00
alignment align_;
constexpr align_spec(
unsigned width, wchar_t fill, alignment align = ALIGN_DEFAULT)
2017-02-19 16:41:38 +00:00
: width_(width), fill_(fill), align_(align) {}
constexpr unsigned width() const { return width_; }
constexpr wchar_t fill() const { return fill_; }
constexpr alignment align() const { return align_; }
int precision() const { return -1; }
};
2017-01-28 12:51:35 +00:00
// Format specifiers.
template <typename Char>
class basic_format_specs : public align_spec {
private:
template <typename FillChar>
typename std::enable_if<std::is_same<FillChar, Char>::value ||
std::is_same<FillChar, char>::value, void>::type
set(fill_spec<FillChar> fill) {
fill_ = fill.value();
}
void set(width_spec width) {
width_ = width.value();
}
void set(type_spec type) {
type_ = type.value();
}
template <typename Spec, typename... Specs>
void set(Spec spec, Specs... tail) {
set(spec);
set(tail...);
}
public:
unsigned flags_;
int precision_;
2017-09-03 15:28:30 +00:00
Char type_;
constexpr basic_format_specs(
unsigned width = 0, char type = 0, wchar_t fill = ' ')
: align_spec(width, fill), flags_(0), precision_(-1), type_(type) {}
template <typename... FormatSpecs>
explicit basic_format_specs(FormatSpecs... specs)
2017-11-24 17:54:28 +00:00
: align_spec(0, ' '), flags_(0), precision_(-1), type_(0) {
set(specs...);
}
constexpr bool flag(unsigned f) const { return (flags_ & f) != 0; }
constexpr int precision() const { return precision_; }
constexpr Char type() const { return type_; }
};
typedef basic_format_specs<char> format_specs;
template <typename Char, typename ErrorHandler>
constexpr unsigned basic_parse_context<Char, ErrorHandler>::next_arg_id() {
if (next_arg_id_ >= 0)
return internal::to_unsigned(next_arg_id_++);
on_error("cannot switch from manual to automatic argument indexing");
return 0;
}
namespace internal {
2017-11-08 13:56:52 +00:00
template <typename Handler>
2017-11-23 17:14:37 +00:00
constexpr void handle_int_type_spec(char spec, Handler &&handler) {
switch (spec) {
2017-11-08 13:56:52 +00:00
case 0: case 'd':
handler.on_dec();
break;
case 'x': case 'X':
handler.on_hex();
break;
case 'b': case 'B':
handler.on_bin();
break;
case 'o':
handler.on_oct();
break;
case 'n':
handler.on_num();
break;
default:
handler.on_error();
}
}
2017-11-23 17:14:37 +00:00
template <typename Handler>
constexpr void handle_float_type_spec(char spec, Handler &&handler) {
switch (spec) {
case 0: case 'g': case 'G':
handler.on_general();
break;
case 'e': case 'E':
handler.on_exp();
break;
case 'f': case 'F':
handler.on_fixed();
break;
case 'a': case 'A':
handler.on_hex();
break;
default:
handler.on_error();
break;
}
}
2017-11-24 15:54:22 +00:00
template <typename Char, typename Handler>
constexpr void handle_char_specs(
const basic_format_specs<Char> &specs, Handler &&handler) {
if (specs.type() && specs.type() != 'c') {
handler.on_int();
return;
}
if (specs.align() == ALIGN_NUMERIC || specs.flag(~0u) != 0)
handler.on_error("invalid format specifier for char");
handler.on_char();
}
2017-11-24 17:54:28 +00:00
template <typename Handler>
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");
}
2018-01-14 15:19:23 +00:00
template <typename Char, typename ErrorHandler>
constexpr void check_string_type_spec(Char spec, ErrorHandler &&eh) {
2017-11-24 17:54:28 +00:00
if (spec != 0 && spec != 's')
eh.on_error("invalid type specifier");
}
template <typename ErrorHandler>
constexpr void check_pointer_type_spec(char spec, ErrorHandler &&eh) {
if (spec != 0 && spec != 'p')
eh.on_error("invalid type specifier");
}
2017-11-16 14:55:49 +00:00
template <typename ErrorHandler>
2017-11-18 14:58:14 +00:00
class int_type_checker : private ErrorHandler {
2017-11-16 14:55:49 +00:00
public:
2017-11-24 15:54:22 +00:00
constexpr explicit int_type_checker(ErrorHandler eh) : ErrorHandler(eh) {}
2017-11-16 14:55:49 +00:00
constexpr void on_dec() {}
constexpr void on_hex() {}
constexpr void on_bin() {}
constexpr void on_oct() {}
constexpr void on_num() {}
constexpr void on_error() {
2017-11-18 14:58:14 +00:00
ErrorHandler::on_error("invalid type specifier");
}
};
2017-11-23 17:14:37 +00:00
template <typename ErrorHandler>
class float_type_checker : private ErrorHandler {
public:
2017-11-24 15:54:22 +00:00
constexpr explicit float_type_checker(ErrorHandler eh) : ErrorHandler(eh) {}
2017-11-23 17:14:37 +00:00
constexpr void on_general() {}
constexpr void on_exp() {}
constexpr void on_fixed() {}
constexpr void on_hex() {}
constexpr void on_error() {
ErrorHandler::on_error("invalid type specifier");
}
};
2017-11-24 15:54:22 +00:00
template <typename ErrorHandler>
class char_specs_checker : public ErrorHandler {
private:
char type_;
public:
constexpr char_specs_checker(char type, ErrorHandler eh)
: ErrorHandler(eh), type_(type) {}
constexpr void on_int() {
handle_int_type_spec(type_, int_type_checker<ErrorHandler>(*this));
}
constexpr void on_char() {}
};
2017-11-24 17:54:28 +00:00
template <typename ErrorHandler>
class cstring_type_checker : public ErrorHandler {
public:
constexpr explicit cstring_type_checker(ErrorHandler eh) : ErrorHandler(eh) {}
constexpr void on_string() {}
constexpr void on_pointer() {}
};
template <typename Context>
2017-12-03 15:32:04 +00:00
void arg_map<Context>::init(const basic_format_args<Context> &args) {
if (map_)
return;
2018-01-06 17:09:50 +00:00
map_ = new entry[args.max_size()];
bool use_values = args.type(MAX_PACKED_ARGS - 1) == internal::NONE;
if (use_values) {
for (unsigned i = 0;/*nothing*/; ++i) {
2017-09-06 14:12:07 +00:00
internal::type arg_type = args.type(i);
switch (arg_type) {
2016-12-15 15:51:40 +00:00
case internal::NONE:
return;
2016-12-15 15:51:40 +00:00
case internal::NAMED_ARG:
2018-01-06 17:09:50 +00:00
push_back(args.values_[i]);
break;
default:
2017-11-24 15:54:22 +00:00
break; // Do nothing.
}
}
return;
}
for (unsigned i = 0; i != MAX_PACKED_ARGS; ++i) {
2018-01-06 17:09:50 +00:00
if (args.type(i) == internal::NAMED_ARG)
push_back(args.args_[i].value_);
}
for (unsigned i = MAX_PACKED_ARGS; ; ++i) {
switch (args.args_[i].type_) {
2016-12-15 15:51:40 +00:00
case internal::NONE:
return;
2016-12-15 15:51:40 +00:00
case internal::NAMED_ARG:
2018-01-06 17:09:50 +00:00
push_back(args.args_[i].value_);
break;
default:
2017-11-24 15:54:22 +00:00
break; // Do nothing.
}
}
}
template <typename Range>
2017-02-19 16:41:38 +00:00
class arg_formatter_base {
public:
using char_type = typename Range::value_type;
using format_specs = basic_format_specs<char_type>;
private:
using writer_type = basic_writer<Range>;
writer_type writer_;
2017-11-24 15:54:22 +00:00
format_specs &specs_;
2017-02-19 16:41:38 +00:00
FMT_DISALLOW_COPY_AND_ASSIGN(arg_formatter_base);
void write_char(char_type value) {
2018-01-15 16:22:31 +00:00
writer_.write_padded(1, specs_, [value](auto &&it) {
*it++ = internal::char_traits<char_type>::cast(value);
2017-12-30 15:42:56 +00:00
});
2017-11-24 15:54:22 +00:00
}
void write_pointer(const void *p) {
2017-11-24 15:54:22 +00:00
specs_.flags_ = HASH_FLAG;
specs_.type_ = 'x';
writer_.write_int(reinterpret_cast<uintptr_t>(p), specs_);
}
protected:
writer_type &writer() { return writer_; }
2017-11-24 15:54:22 +00:00
format_specs &spec() { return specs_; }
void write(bool value) {
2017-11-24 15:54:22 +00:00
writer_.write_str(string_view(value ? "true" : "false"), specs_);
}
void write(const char_type *value) {
auto length = value != 0 ? std::char_traits<char_type>::length(value) : 0;
writer_.write_str(basic_string_view<char_type>(value, length), specs_);
}
public:
2018-01-14 15:19:23 +00:00
arg_formatter_base(Range r, format_specs &s): writer_(r), specs_(s) {}
2016-12-27 15:43:25 +00:00
void operator()(monostate) {
FMT_ASSERT(false, "invalid argument type");
}
template <typename T>
2016-11-20 16:47:24 +00:00
typename std::enable_if<std::is_integral<T>::value>::type
2017-11-24 15:54:22 +00:00
operator()(T value) { writer_.write_int(value, specs_); }
template <typename T>
2016-11-20 16:47:24 +00:00
typename std::enable_if<std::is_floating_point<T>::value>::type
2017-11-24 15:54:22 +00:00
operator()(T value) { writer_.write_double(value, specs_); }
2016-11-19 15:39:07 +00:00
void operator()(bool value) {
2017-11-24 15:54:22 +00:00
if (specs_.type_)
2016-11-20 16:47:24 +00:00
return (*this)(value ? 1 : 0);
write(value);
}
void operator()(char_type value) {
2017-11-24 17:54:28 +00:00
struct spec_handler : internal::error_handler {
2017-11-24 15:54:22 +00:00
arg_formatter_base &formatter;
char_type value;
2017-11-24 15:54:22 +00:00
spec_handler(arg_formatter_base& f, char_type val)
: formatter(f), value(val) {}
2017-11-24 15:54:22 +00:00
void on_int() { formatter.writer_.write_int(value, formatter.specs_); }
2017-11-24 17:54:28 +00:00
void on_char() { formatter.write_char(value); }
2017-11-24 15:54:22 +00:00
};
internal::handle_char_specs(specs_, spec_handler(*this, value));
}
void operator()(const char_type *value) {
2017-11-24 17:54:28 +00:00
struct spec_handler : internal::error_handler {
arg_formatter_base &formatter;
const char_type *value;
2017-11-24 17:54:28 +00:00
spec_handler(arg_formatter_base &f, const char_type *val)
2017-11-24 17:54:28 +00:00
: formatter(f), value(val) {}
void on_string() { formatter.write(value); }
void on_pointer() { formatter.write_pointer(value); }
};
internal::handle_cstring_type_spec(
specs_.type_, spec_handler(*this, value));
}
void operator()(basic_string_view<char_type> value) {
2017-11-24 17:54:28 +00:00
internal::check_string_type_spec(specs_.type_, internal::error_handler());
2017-11-24 15:54:22 +00:00
writer_.write_str(value, specs_);
}
2016-11-19 15:39:07 +00:00
void operator()(const void *value) {
2017-11-24 15:54:22 +00:00
check_pointer_type_spec(specs_.type_, internal::error_handler());
write_pointer(value);
}
};
struct format_string {};
template <typename Char>
constexpr bool is_name_start(Char c) {
return ('a' <= c && c <= 'z') || ('A' <= c && c <= 'Z') || '_' == c;
}
// Parses the input as an unsigned integer. This function assumes that the
// first character is a digit and presence of a non-digit character at the end.
// it: an iterator pointing to the beginning of the input range.
template <typename Iterator, typename ErrorHandler>
2017-11-12 14:58:11 +00:00
constexpr unsigned parse_nonnegative_int(Iterator &it, ErrorHandler &&eh) {
assert('0' <= *it && *it <= '9');
unsigned value = 0;
2017-11-12 14:58:11 +00:00
// Convert to unsigned to prevent a warning.
unsigned max_int = (std::numeric_limits<int>::max)();
unsigned big = max_int / 10;
do {
2017-11-12 14:58:11 +00:00
// Check for overflow.
if (value > big) {
value = max_int + 1;
break;
}
value = value * 10 + (*it - '0');
// Workaround for MSVC "setup_exception stack overflow" error:
auto next = it;
++next;
it = next;
} while ('0' <= *it && *it <= '9');
if (value > max_int)
2017-11-12 14:58:11 +00:00
eh.on_error("number is too big");
return value;
}
template <typename Char, typename Context>
class custom_formatter {
private:
Context &ctx_;
public:
2018-01-06 17:09:50 +00:00
explicit custom_formatter(Context &ctx): ctx_(ctx) {}
2017-12-02 17:44:48 +00:00
bool operator()(typename basic_arg<Context>::handle h) {
2018-01-06 17:09:50 +00:00
h.format(ctx_);
return true;
}
template <typename T>
bool operator()(T) { return false; }
};
2016-11-20 16:47:24 +00:00
template <typename T>
struct is_integer {
enum {
value = std::is_integral<T>::value && !std::is_same<T, bool>::value &&
!std::is_same<T, char>::value && !std::is_same<T, wchar_t>::value
};
};
template <typename ErrorHandler>
class width_checker {
public:
explicit constexpr width_checker(ErrorHandler &eh) : handler_(eh) {}
2017-08-13 20:09:02 +00:00
template <typename T>
constexpr typename std::enable_if<
is_integer<T>::value, unsigned long long>::type operator()(T value) {
if (is_negative(value))
handler_.on_error("negative width");
return value;
}
2016-11-07 00:11:24 +00:00
template <typename T>
constexpr typename std::enable_if<
!is_integer<T>::value, unsigned long long>::type operator()(T) {
handler_.on_error("width is not integer");
return 0;
}
private:
ErrorHandler &handler_;
};
template <typename ErrorHandler>
class precision_checker {
public:
explicit constexpr precision_checker(ErrorHandler &eh) : handler_(eh) {}
template <typename T>
constexpr typename std::enable_if<
is_integer<T>::value, unsigned long long>::type operator()(T value) {
if (is_negative(value))
handler_.on_error("negative precision");
return value;
}
template <typename T>
constexpr typename std::enable_if<
!is_integer<T>::value, unsigned long long>::type operator()(T) {
handler_.on_error("precision is not integer");
return 0;
}
private:
ErrorHandler &handler_;
};
// A format specifier handler that sets fields in basic_format_specs.
template <typename Char>
2017-11-13 03:14:35 +00:00
class specs_setter {
public:
explicit constexpr specs_setter(basic_format_specs<Char> &specs):
specs_(specs) {}
2017-11-12 14:58:11 +00:00
constexpr specs_setter(const specs_setter &other) : specs_(other.specs_) {}
constexpr void on_align(alignment align) { specs_.align_ = align; }
constexpr void on_fill(Char fill) { specs_.fill_ = fill; }
constexpr void on_plus() { specs_.flags_ |= SIGN_FLAG | PLUS_FLAG; }
constexpr void on_minus() { specs_.flags_ |= MINUS_FLAG; }
constexpr void on_space() { specs_.flags_ |= SIGN_FLAG; }
constexpr void on_hash() { specs_.flags_ |= HASH_FLAG; }
constexpr void on_zero() {
specs_.align_ = ALIGN_NUMERIC;
specs_.fill_ = '0';
}
constexpr void on_width(unsigned width) { specs_.width_ = width; }
constexpr void on_precision(unsigned precision) {
specs_.precision_ = precision;
}
constexpr void end_precision() {}
2016-06-14 15:11:33 +00:00
constexpr void on_type(Char type) { specs_.type_ = type; }
protected:
basic_format_specs<Char> &specs_;
};
// A format specifier handler that checks if specifiers are consistent with the
// argument type.
template <typename Handler>
class specs_checker : public Handler {
public:
constexpr specs_checker(const Handler& handler, internal::type arg_type)
: Handler(handler), arg_type_(arg_type) {}
2017-11-12 14:58:11 +00:00
constexpr specs_checker(const specs_checker &other)
: Handler(other), arg_type_(other.arg_type_) {}
constexpr void on_align(alignment align) {
if (align == ALIGN_NUMERIC)
2017-11-18 15:42:54 +00:00
require_numeric_argument();
Handler::on_align(align);
}
constexpr void on_plus() {
2017-11-18 15:42:54 +00:00
check_sign();
Handler::on_plus();
}
constexpr void on_minus() {
2017-11-18 15:42:54 +00:00
check_sign();
Handler::on_minus();
}
constexpr void on_space() {
2017-11-18 15:42:54 +00:00
check_sign();
Handler::on_space();
}
constexpr void on_hash() {
2017-11-18 15:42:54 +00:00
require_numeric_argument();
Handler::on_hash();
}
constexpr void on_zero() {
2017-11-18 15:42:54 +00:00
require_numeric_argument();
Handler::on_zero();
}
constexpr void end_precision() {
2017-11-16 14:55:49 +00:00
if (is_integral(arg_type_) || arg_type_ == POINTER)
this->on_error("precision not allowed for this argument type");
}
private:
2017-11-18 15:42:54 +00:00
constexpr void require_numeric_argument() {
2017-12-09 14:19:15 +00:00
if (!is_arithmetic(arg_type_))
2017-11-18 15:42:54 +00:00
this->on_error("format specifier requires numeric argument");
}
2017-11-18 15:42:54 +00:00
constexpr void check_sign() {
require_numeric_argument();
if (is_integral(arg_type_) && arg_type_ != INT && arg_type_ != LONG_LONG &&
arg_type_ != CHAR) {
2017-11-18 15:42:54 +00:00
this->on_error("format specifier requires signed argument");
}
}
internal::type arg_type_;
};
2017-11-18 17:16:35 +00:00
template <template <typename> class Handler, typename T,
typename Context, typename ErrorHandler>
constexpr void set_dynamic_spec(
T &value, basic_arg<Context> arg, ErrorHandler eh) {
unsigned long long big_value = visit(Handler<ErrorHandler>(eh), arg);
if (big_value > (std::numeric_limits<int>::max)())
eh.on_error("number is too big");
value = static_cast<int>(big_value);
}
struct auto_id {};
// The standard format specifier handler with checking.
template <typename Context>
class specs_handler: public specs_setter<typename Context::char_type> {
public:
typedef typename Context::char_type char_type;
constexpr specs_handler(basic_format_specs<char_type> &specs, Context &ctx)
: specs_setter<char_type>(specs), context_(ctx) {}
template <typename Id>
constexpr void on_dynamic_width(Id arg_id) {
2017-11-18 17:16:35 +00:00
set_dynamic_spec<width_checker>(
this->specs_.width_, get_arg(arg_id), context_.error_handler());
}
template <typename Id>
constexpr void on_dynamic_precision(Id arg_id) {
set_dynamic_spec<precision_checker>(
2017-11-18 17:16:35 +00:00
this->specs_.precision_, get_arg(arg_id), context_.error_handler());
}
2017-11-13 03:14:35 +00:00
void on_error(const char *message) {
context_.on_error(message);
}
private:
constexpr basic_arg<Context> get_arg(auto_id) {
return context_.next_arg();
}
template <typename Id>
constexpr basic_arg<Context> get_arg(Id arg_id) {
context_.parse_context().check_arg_id(arg_id);
return context_.get_arg(arg_id);
}
Context &context_;
};
// An argument reference.
template <typename Char>
struct arg_ref {
enum Kind { NONE, INDEX, NAME };
constexpr arg_ref() : kind(NONE), index(0) {}
constexpr explicit arg_ref(unsigned index) : kind(INDEX), index(index) {}
explicit arg_ref(basic_string_view<Char> name) : kind(NAME), name(name) {}
constexpr arg_ref &operator=(unsigned index) {
kind = INDEX;
this->index = index;
return *this;
}
Kind kind;
union {
unsigned index;
basic_string_view<Char> name;
};
};
// Format specifiers with width and precision resolved at formatting rather
// than parsing time to allow re-using the same parsed specifiers with
// differents 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;
};
// 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;
constexpr dynamic_specs_handler(
dynamic_format_specs<char_type> &specs, ParseContext &ctx)
: specs_setter<char_type>(specs), specs_(specs), context_(ctx) {}
2017-11-12 14:58:11 +00:00
constexpr dynamic_specs_handler(const dynamic_specs_handler &other)
2017-11-12 17:42:26 +00:00
: specs_setter<char_type>(other),
specs_(other.specs_), context_(other.context_) {}
2017-11-12 14:58:11 +00:00
template <typename Id>
constexpr void on_dynamic_width(Id arg_id) {
specs_.width_ref = make_arg_ref(arg_id);
}
template <typename Id>
constexpr void on_dynamic_precision(Id arg_id) {
specs_.precision_ref = make_arg_ref(arg_id);
}
2017-11-13 03:14:35 +00:00
constexpr void on_error(const char *message) {
context_.on_error(message);
}
private:
using arg_ref_type = arg_ref<char_type>;
template <typename Id>
constexpr arg_ref_type make_arg_ref(Id arg_id) {
context_.check_arg_id(arg_id);
return arg_ref_type(arg_id);
}
constexpr arg_ref_type make_arg_ref(auto_id) {
2017-11-26 17:29:55 +00:00
return arg_ref_type(context_.next_arg_id());
}
dynamic_format_specs<char_type> &specs_;
ParseContext &context_;
};
template <typename Iterator, typename IDHandler>
constexpr Iterator parse_arg_id(Iterator it, IDHandler &&handler) {
using char_type = typename std::iterator_traits<Iterator>::value_type;
char_type c = *it;
if (c == '}' || c == ':') {
handler();
return it;
}
if (c >= '0' && c <= '9') {
unsigned index = parse_nonnegative_int(it, handler);
if (*it != '}' && *it != ':') {
handler.on_error("invalid format string");
return it;
}
handler(index);
return it;
}
if (!is_name_start(c)) {
handler.on_error("invalid format string");
return it;
}
auto start = it;
do {
c = *++it;
} while (is_name_start(c) || ('0' <= c && c <= '9'));
handler(basic_string_view<char_type>(pointer_from(start), it - start));
return it;
}
// Adapts SpecHandler to IDHandler API for dynamic width.
template <typename SpecHandler, typename Char>
struct width_adapter {
explicit constexpr width_adapter(SpecHandler &h) : handler(h) {}
constexpr void operator()() { handler.on_dynamic_width(auto_id()); }
constexpr void operator()(unsigned id) { handler.on_dynamic_width(id); }
constexpr void operator()(basic_string_view<Char> id) {
handler.on_dynamic_width(id);
}
constexpr void on_error(const char *message) { handler.on_error(message); }
SpecHandler &handler;
};
// Adapts SpecHandler to IDHandler API for dynamic precision.
template <typename SpecHandler, typename Char>
struct precision_adapter {
explicit constexpr precision_adapter(SpecHandler &h) : handler(h) {}
constexpr void operator()() { handler.on_dynamic_precision(auto_id()); }
constexpr void operator()(unsigned id) { handler.on_dynamic_precision(id); }
constexpr void operator()(basic_string_view<Char> id) {
handler.on_dynamic_precision(id);
2017-01-23 03:11:47 +00:00
}
constexpr void on_error(const char *message) { handler.on_error(message); }
2016-04-25 15:07:27 +00:00
SpecHandler &handler;
};
// Parses standard format specifiers and sends notifications about parsed
// components to handler.
// it: an iterator pointing to the beginning of a null-terminated range of
// characters, possibly emulated via null_terminating_iterator, representing
// format specifiers.
template <typename Iterator, typename SpecHandler>
constexpr Iterator parse_format_specs(Iterator it, SpecHandler &&handler) {
using char_type = typename std::iterator_traits<Iterator>::value_type;
// Parse fill and alignment.
if (char_type c = *it) {
alignment align = ALIGN_DEFAULT;
int i = 1;
do {
auto p = it + i;
switch (*p) {
case '<':
align = ALIGN_LEFT;
break;
case '>':
align = ALIGN_RIGHT;
break;
case '=':
align = ALIGN_NUMERIC;
break;
case '^':
align = ALIGN_CENTER;
break;
}
if (align != ALIGN_DEFAULT) {
handler.on_align(align);
if (p != it) {
if (c == '}') break;
if (c == '{') {
handler.on_error("invalid fill character '{'");
return it;
}
it += 2;
handler.on_fill(c);
} else ++it;
break;
}
} while (--i >= 0);
}
// Parse sign.
switch (*it) {
case '+':
handler.on_plus();
++it;
break;
case '-':
handler.on_minus();
++it;
break;
case ' ':
handler.on_space();
++it;
break;
}
if (*it == '#') {
handler.on_hash();
++it;
}
// Parse zero flag.
if (*it == '0') {
handler.on_zero();
++it;
}
// Parse width.
if ('0' <= *it && *it <= '9') {
handler.on_width(parse_nonnegative_int(it, handler));
} else if (*it == '{') {
it = parse_arg_id(it + 1, width_adapter<SpecHandler, char_type>(handler));
if (*it++ != '}') {
handler.on_error("invalid format string");
return it;
}
}
// Parse precision.
if (*it == '.') {
++it;
if ('0' <= *it && *it <= '9') {
handler.on_precision(parse_nonnegative_int(it, handler));
} else if (*it == '{') {
it = parse_arg_id(
it + 1, precision_adapter<SpecHandler, char_type>(handler));
if (*it++ != '}') {
handler.on_error("invalid format string");
return it;
}
} else {
handler.on_error("missing precision specifier");
return it;
}
handler.end_precision();
}
// Parse type.
if (*it != '}' && *it)
handler.on_type(*it++);
return it;
}
template <typename Handler, typename Char>
struct id_adapter {
constexpr explicit id_adapter(Handler &h): handler(h) {}
constexpr void operator()() { handler.on_arg_id(); }
constexpr void operator()(unsigned id) { handler.on_arg_id(id); }
constexpr void operator()(basic_string_view<Char> id) {
handler.on_arg_id(id);
}
constexpr void on_error(const char *message) {
handler.on_error(message);
}
Handler &handler;
};
template <typename Iterator, typename Handler>
constexpr void parse_format_string(Iterator it, Handler &&handler) {
using char_type = typename std::iterator_traits<Iterator>::value_type;
auto start = it;
while (*it) {
char_type ch = *it++;
if (ch != '{' && ch != '}') continue;
if (*it == ch) {
handler.on_text(start, it);
start = ++it;
continue;
}
if (ch == '}') {
handler.on_error("unmatched '}' in format string");
return;
}
handler.on_text(start, it - 1);
it = parse_arg_id(it, id_adapter<Handler, char_type>(handler));
if (*it == '}') {
handler.on_replacement_field(it);
} else if (*it == ':') {
++it;
it = handler.on_format_specs(it);
if (*it != '}') {
handler.on_error("unknown format specifier");
return;
}
} else {
handler.on_error("missing '}' in format string");
return;
}
start = ++it;
}
handler.on_text(start, it);
}
2017-11-13 03:14:35 +00:00
template <typename T, typename ParseContext>
constexpr const typename ParseContext::char_type *
parse_format_specs(ParseContext &ctx) {
formatter<T, typename ParseContext::char_type> f;
return f.parse(ctx);
}
2017-11-08 13:56:52 +00:00
2017-11-11 18:28:05 +00:00
template <typename Char, typename ErrorHandler, typename... Args>
2017-11-19 14:35:23 +00:00
class format_string_checker {
public:
2017-11-19 14:35:23 +00:00
explicit constexpr format_string_checker(
basic_string_view<Char> format_str, ErrorHandler eh)
: context_(format_str, eh) {}
2017-11-08 13:56:52 +00:00
constexpr void on_text(const Char *, const Char *) {}
2017-11-08 13:56:52 +00:00
constexpr void on_arg_id() {
2017-11-26 17:29:55 +00:00
arg_id_ = context_.next_arg_id();
check_arg_id();
}
2017-11-26 17:29:55 +00:00
constexpr void on_arg_id(unsigned id) {
arg_id_ = id;
context_.check_arg_id(id);
check_arg_id();
}
constexpr void on_arg_id(basic_string_view<Char>) {}
2017-11-08 13:56:52 +00:00
constexpr void on_replacement_field(const Char *) {}
2017-11-08 13:56:52 +00:00
constexpr const Char *on_format_specs(const Char *s) {
2017-11-19 14:35:23 +00:00
context_.advance_to(s);
2017-11-26 17:29:55 +00:00
return to_unsigned(arg_id_) < NUM_ARGS ?
parse_funcs_[arg_id_](context_) : s;
2017-11-19 14:35:23 +00:00
}
constexpr void on_error(const char *message) {
context_.on_error(message);
}
2017-11-08 13:56:52 +00:00
private:
using parse_context_type = basic_parse_context<Char, ErrorHandler>;
constexpr static size_t NUM_ARGS = sizeof...(Args);
2017-11-26 17:29:55 +00:00
constexpr void check_arg_id() {
if (internal::to_unsigned(arg_id_) >= NUM_ARGS)
2017-11-19 14:35:23 +00:00
context_.on_error("argument index out of range");
}
// Format specifier parsing function.
2017-11-13 03:14:35 +00:00
using parse_func = const Char *(*)(parse_context_type &);
2017-11-26 17:29:55 +00:00
int arg_id_ = -1;
2017-11-19 14:35:23 +00:00
parse_context_type context_;
parse_func parse_funcs_[NUM_ARGS > 0 ? NUM_ARGS : 1] = {
2017-11-13 03:14:35 +00:00
&parse_format_specs<Args, parse_context_type>...
2017-11-08 13:56:52 +00:00
};
};
2017-11-11 18:28:05 +00:00
template <typename Char, typename ErrorHandler, typename... Args>
constexpr bool check_format_string(
basic_string_view<Char> s, ErrorHandler eh = ErrorHandler()) {
2017-11-19 14:35:23 +00:00
format_string_checker<Char, ErrorHandler, Args...> checker(s, eh);
2017-11-11 18:28:05 +00:00
parse_format_string(s.begin(), checker);
return true;
}
// Specifies whether to format T using the standard formatter.
// It is not possible to use get_type in formatter specialization directly
// because of a bug in MSVC.
template <typename T>
struct format_type : std::integral_constant<bool, get_type<T>() != CUSTOM> {};
// Specifies whether to format enums.
template <typename T, typename Enable = void>
struct format_enum : std::integral_constant<bool, std::is_enum<T>::value> {};
2018-01-06 17:09:50 +00:00
template <template <typename> class Handler, typename Spec, typename Context>
void handle_dynamic_spec(
2018-01-06 17:09:50 +00:00
Spec &value, arg_ref<typename Context::char_type> ref, Context &ctx) {
using char_type = typename Context::char_type;
switch (ref.kind) {
2018-01-06 17:09:50 +00:00
case arg_ref<char_type>::NONE:
break;
2018-01-06 17:09:50 +00:00
case arg_ref<char_type>::INDEX:
2017-11-18 17:16:35 +00:00
internal::set_dynamic_spec<Handler>(
value, ctx.get_arg(ref.index), ctx.error_handler());
break;
2018-01-06 17:09:50 +00:00
case arg_ref<char_type>::NAME:
2017-11-18 17:16:35 +00:00
internal::set_dynamic_spec<Handler>(
value, ctx.get_arg(ref.name), ctx.error_handler());
break;
}
}
} // namespace internal
/** The default argument formatter. */
2018-01-06 17:09:50 +00:00
template <typename Range>
class arg_formatter: public internal::arg_formatter_base<Range> {
private:
2018-01-06 17:09:50 +00:00
using char_type = typename Range::value_type;
2018-01-21 22:30:38 +00:00
using iterator = decltype(std::declval<Range>().begin());
using base = internal::arg_formatter_base<Range>;
2018-01-21 22:30:38 +00:00
using context_type = basic_context<iterator, char_type>;
context_type &ctx_;
public:
2018-01-13 20:57:27 +00:00
using range = Range;
using format_specs = typename base::format_specs;
/**
\rst
Constructs an argument formatter object.
2018-01-15 16:22:31 +00:00
*ctx* is a reference to the formatting context,
2018-01-14 15:19:23 +00:00
*spec* contains format specifier information for standard argument types.
\endrst
*/
2018-01-21 22:30:38 +00:00
arg_formatter(context_type &ctx, format_specs &spec)
: base(Range(ctx.begin()), spec), ctx_(ctx) {}
using base::operator();
/** Formats an argument of a custom (user-defined) type. */
2018-01-21 22:30:38 +00:00
void operator()(typename basic_arg<context_type>::handle handle) {
2018-01-06 17:09:50 +00:00
handle.format(ctx_);
}
};
/**
An error returned by an operating system or a language runtime,
for example a file opening error.
*/
class system_error : public std::runtime_error {
private:
FMT_API void init(int err_code, string_view format_str, format_args args);
protected:
int error_code_;
system_error() : std::runtime_error("") {}
public:
/**
\rst
Constructs a :class:`fmt::system_error` object with a description
formatted with `fmt::format_system_error`. *message* and additional
arguments passed into the constructor are formatted similarly to
`fmt::format`.
**Example**::
// This throws a system_error with the description
// cannot open file 'madeup': No such file or directory
// or similar (system message may vary).
const char *filename = "madeup";
std::FILE *file = std::fopen(filename, "r");
if (!file)
throw fmt::system_error(errno, "cannot open file '{}'", filename);
\endrst
*/
2016-08-27 15:23:44 +00:00
template <typename... Args>
system_error(int error_code, string_view message, const Args & ... args)
: std::runtime_error("") {
2017-02-05 14:41:39 +00:00
init(error_code, message, make_args(args...));
}
FMT_API ~system_error() FMT_DTOR_NOEXCEPT;
int error_code() const { return error_code_; }
};
/**
\rst
Formats an error returned by an operating system or a language runtime,
for example a file opening error, and writes it to *out* in the following
form:
.. parsed-literal::
*<message>*: *<system-message>*
where *<message>* is the passed message and *<system-message>* is
the system message corresponding to the error code.
*error_code* is a system error code as given by ``errno``.
If *error_code* is not a valid error code such as -1, the system message
may look like "Unknown error -1" and is platform-dependent.
\endrst
*/
2018-01-14 22:15:59 +00:00
FMT_API void format_system_error(fmt::internal::buffer &out, int error_code,
fmt::string_view message) FMT_NOEXCEPT;
2016-08-27 00:23:13 +00:00
/**
This template provides operations for formatting and writing data into a
2017-12-30 15:42:56 +00:00
character range.
*/
2017-12-30 15:42:56 +00:00
template <typename Range>
class basic_writer {
public:
2017-12-30 15:42:56 +00:00
using char_type = typename Range::value_type;
using format_specs = basic_format_specs<char_type>;
2016-08-27 00:23:13 +00:00
private:
2018-01-15 16:22:31 +00:00
// Output iterator.
2017-12-30 15:42:56 +00:00
using iterator = decltype(std::declval<Range>().begin());
2018-01-06 17:09:50 +00:00
iterator out_;
2017-12-30 15:42:56 +00:00
2017-12-27 01:22:07 +00:00
std::unique_ptr<locale_provider> locale_;
FMT_DISALLOW_COPY_AND_ASSIGN(basic_writer);
#if FMT_SECURE_SCL
2017-12-30 15:42:56 +00:00
using pointer_type = stdext::checked_array_iterator<char_type*>;
// Returns pointer value.
static char_type *get(pointer_type p) { return p.base(); }
#else
2017-12-30 15:42:56 +00:00
using pointer_type = char_type*;
static char_type *get(char_type *p) { return p; }
#endif
2018-01-15 16:22:31 +00:00
// Attempts to reserve space for n extra characters in the output range.
// Returns a pointer to the reserved range or a reference to out_.
auto reserve(std::size_t n) -> decltype(internal::reserve(out_, n)) {
return internal::reserve(out_, n);
2017-12-30 15:42:56 +00:00
}
// Writes a value in the format
// <left-padding><value><right-padding>
// where <value> is written by f(it).
template <typename F>
void write_padded(std::size_t size, const align_spec &spec, F f);
// Writes an integer in the format
// <left-padding><prefix><numeric-padding><digits><right-padding>
// where <digits> are written by f(it).
template <typename Spec, typename F>
void write_int(unsigned num_digits, string_view prefix,
const Spec &spec, F f) {
unsigned size = prefix.size() + num_digits;
auto fill = spec.fill();
unsigned padding = 0;
if (spec.align() == ALIGN_NUMERIC) {
if (spec.width() > size) {
padding = spec.width() - size;
size = spec.width();
}
2018-01-06 17:09:50 +00:00
} else if (spec.precision() > static_cast<int>(num_digits)) {
2017-12-30 15:42:56 +00:00
size = prefix.size() + spec.precision();
padding = spec.precision() - num_digits;
fill = '0';
}
2018-01-06 17:09:50 +00:00
align_spec as = spec;
if (spec.align() == ALIGN_DEFAULT)
as.align_ = ALIGN_RIGHT;
2018-01-15 16:22:31 +00:00
write_padded(size, as, [prefix, fill, padding, f](auto &&it) {
2017-12-30 15:42:56 +00:00
if (prefix.size() != 0)
2018-01-15 19:30:53 +00:00
it = std::copy_n(prefix.data(), prefix.size(), it);
it = std::fill_n(it, padding, fill);
2017-12-30 15:42:56 +00:00
f(it);
});
}
// Writes a decimal integer.
template <typename Int>
void write_decimal(Int value) {
2017-12-30 15:42:56 +00:00
using main_type = typename internal::int_traits<Int>::main_type;
main_type abs_value = static_cast<main_type>(value);
2017-12-30 15:42:56 +00:00
bool is_negative = internal::is_negative(value);
if (is_negative)
abs_value = 0 - abs_value;
2017-12-30 15:42:56 +00:00
unsigned num_digits = internal::count_digits(abs_value);
2018-01-15 16:22:31 +00:00
auto &&it = reserve((is_negative ? 1 : 0) + num_digits);
2017-12-30 15:42:56 +00:00
if (is_negative)
2018-01-15 16:22:31 +00:00
*it++ = '-';
internal::format_decimal(it, abs_value, num_digits);
}
2017-12-30 15:42:56 +00:00
// The handle_int_type_spec handler that writes an integer.
template <typename Int, typename Spec>
struct int_writer {
using unsigned_type = typename internal::int_traits<Int>::main_type;
basic_writer<Range> &writer;
const Spec &spec;
unsigned_type abs_value;
char prefix[4];
unsigned prefix_size = 0;
string_view get_prefix() const { return string_view(prefix, prefix_size); }
// Counts the number of digits in abs_value. BITS = log2(radix).
template <unsigned BITS>
unsigned count_digits() const {
unsigned_type n = abs_value;
unsigned num_digits = 0;
do {
++num_digits;
} while ((n >>= BITS) != 0);
return num_digits;
}
int_writer(basic_writer<Range> &w, Int value, const Spec &s)
: writer(w), spec(s), abs_value(static_cast<unsigned_type>(value)) {
if (internal::is_negative(value)) {
prefix[0] = '-';
++prefix_size;
abs_value = 0 - abs_value;
} else if (spec.flag(SIGN_FLAG)) {
prefix[0] = spec.flag(PLUS_FLAG) ? '+' : ' ';
++prefix_size;
}
}
void on_dec() {
unsigned num_digits = internal::count_digits(abs_value);
writer.write_int(num_digits, get_prefix(), spec,
2018-01-15 16:22:31 +00:00
[this, num_digits](auto &&it) {
2018-01-15 19:30:53 +00:00
it = internal::format_decimal(it, abs_value, num_digits);
2017-12-30 15:42:56 +00:00
});
}
2017-12-30 15:42:56 +00:00
void on_hex() {
if (spec.flag(HASH_FLAG)) {
prefix[prefix_size++] = '0';
prefix[prefix_size++] = spec.type();
}
2018-01-06 17:09:50 +00:00
unsigned num_digits = count_digits<4>();
writer.write_int(num_digits, get_prefix(), spec,
2018-01-15 16:22:31 +00:00
[this, num_digits](auto &&it) {
2018-01-15 19:30:53 +00:00
it = internal::format_uint<4>(it, abs_value, num_digits,
spec.type() != 'x');
2017-12-30 15:42:56 +00:00
});
}
void on_bin() {
if (spec.flag(HASH_FLAG)) {
prefix[prefix_size++] = '0';
prefix[prefix_size++] = spec.type();
}
2018-01-06 17:09:50 +00:00
unsigned num_digits = count_digits<1>();
writer.write_int(num_digits, get_prefix(), spec,
2018-01-15 16:22:31 +00:00
[this, num_digits](auto &&it) {
2018-01-15 19:30:53 +00:00
it = internal::format_uint<1>(it, abs_value, num_digits);
2017-12-30 15:42:56 +00:00
});
}
void on_oct() {
2018-01-06 17:09:50 +00:00
unsigned num_digits = count_digits<3>();
if (spec.flag(HASH_FLAG) &&
spec.precision() <= static_cast<int>(num_digits)) {
// Octal prefix '0' is counted as a digit, so only add it if precision
// is not greater than the number of digits.
2017-12-30 15:42:56 +00:00
prefix[prefix_size++] = '0';
2018-01-06 17:09:50 +00:00
}
writer.write_int(num_digits, get_prefix(), spec,
2018-01-15 16:22:31 +00:00
[this, num_digits](auto &&it) {
2018-01-15 19:30:53 +00:00
it = internal::format_uint<3>(it, abs_value, num_digits);
2017-12-30 15:42:56 +00:00
});
}
void on_num() {
unsigned num_digits = internal::count_digits(abs_value);
2018-01-06 17:09:50 +00:00
char_type sep = internal::thousands_sep<char_type>(writer.locale_.get());
static constexpr unsigned SEP_SIZE = 1;
unsigned size = num_digits + SEP_SIZE * ((num_digits - 1) / 3);
2018-01-15 16:22:31 +00:00
writer.write_int(size, get_prefix(), spec, [this, size, sep](auto &&it) {
2018-01-06 17:09:50 +00:00
basic_string_view<char_type> s(&sep, SEP_SIZE);
2018-01-15 19:30:53 +00:00
it = format_decimal(it, abs_value, size,
internal::add_thousands_sep<char_type>(s));
2017-12-30 15:42:56 +00:00
});
}
void on_error() {
FMT_THROW(format_error("invalid type specifier"));
}
};
// Writes a formatted integer.
template <typename T, typename Spec>
2017-12-30 15:42:56 +00:00
void write_int(T value, const Spec &spec) {
internal::handle_int_type_spec(spec.type(),
int_writer<T, Spec>(*this, value, spec));
}
// Formats a floating-point number (double or long double).
template <typename T>
void write_double(T value, const format_specs &spec);
// Writes a formatted string.
template <typename Char>
2017-12-30 15:42:56 +00:00
void write_str(const Char *s, std::size_t size, const align_spec &spec) {
2018-01-15 16:22:31 +00:00
write_padded(size, spec, [s, size](auto &&it) {
2018-01-15 19:30:53 +00:00
it = std::copy_n(s, size, it);
2017-12-30 15:42:56 +00:00
});
}
template <typename Char>
void write_str(basic_string_view<Char> str, const format_specs &spec);
// Appends floating-point length specifier to the format string.
// The second argument is only used for overload resolution.
void append_float_length(char_type *&format_ptr, long double) {
*format_ptr++ = 'L';
}
template<typename T>
void append_float_length(char_type *&, T) {}
template <typename Char>
friend class internal::arg_formatter_base;
public:
2017-12-30 15:42:56 +00:00
/** Constructs a ``basic_writer`` object. */
2018-01-15 16:22:31 +00:00
explicit basic_writer(Range out): out_(out.begin()) {}
2018-01-27 15:03:26 +00:00
void write(int value) { write_decimal(value); }
void write(long value) { write_decimal(value); }
void write(long long value) { write_decimal(value); }
void write(unsigned value) { write_decimal(value); }
void write(unsigned long value) { write_decimal(value); }
void write(unsigned long long value) { write_decimal(value); }
/**
\rst
Formats *value* and writes it to the buffer.
\endrst
*/
template <typename T, typename... FormatSpecs>
typename std::enable_if<std::is_integral<T>::value, void>::type
write(T value, FormatSpecs... specs) {
2018-01-06 17:09:50 +00:00
format_specs s(specs...);
s.align_ = ALIGN_RIGHT;
write_int(value, s);
}
void write(double value) {
write_double(value, format_specs());
}
/**
\rst
Formats *value* using the general format for floating-point numbers
(``'g'``) and writes it to the buffer.
\endrst
*/
void write(long double value) {
write_double(value, format_specs());
}
2017-12-30 15:42:56 +00:00
/** Writes a character to the buffer. */
void write(char value) {
2018-01-15 16:22:31 +00:00
*reserve(1) = value;
}
void write(wchar_t value) {
internal::require_wchar<char_type>();
2018-01-15 16:22:31 +00:00
*reserve(1) = value;
}
/**
\rst
Writes *value* to the buffer.
\endrst
*/
void write(string_view value) {
2018-01-15 16:22:31 +00:00
auto &&it = reserve(value.size());
2018-01-15 19:30:53 +00:00
it = std::copy(value.begin(), value.end(), it);
}
2017-12-30 15:42:56 +00:00
void write(wstring_view value) {
internal::require_wchar<char_type>();
2018-01-15 16:22:31 +00:00
auto &&it = reserve(value.size());
it = std::uninitialized_copy(value.begin(), value.end(), it);
}
template <typename... FormatSpecs>
void write(basic_string_view<char_type> str, FormatSpecs... specs) {
write_str(str, format_specs(specs...));
}
};
2017-12-30 15:42:56 +00:00
template <typename Range>
template <typename F>
void basic_writer<Range>::write_padded(
std::size_t size, const align_spec &spec, F f) {
unsigned width = spec.width();
2018-01-15 16:22:31 +00:00
if (width <= size)
return f(reserve(size));
auto &&it = reserve(width);
2017-12-30 15:42:56 +00:00
char_type fill = internal::char_traits<char_type>::cast(spec.fill());
std::size_t padding = width - size;
if (spec.align() == ALIGN_RIGHT) {
2018-01-15 19:30:53 +00:00
it = std::fill_n(it, padding, fill);
2018-01-15 16:22:31 +00:00
f(it);
2017-12-30 15:42:56 +00:00
} else if (spec.align() == ALIGN_CENTER) {
std::size_t left_padding = padding / 2;
2018-01-15 19:30:53 +00:00
it = std::fill_n(it, left_padding, fill);
2018-01-15 16:22:31 +00:00
f(it);
2018-01-15 19:30:53 +00:00
it = std::fill_n(it, padding - left_padding, fill);
} else {
2018-01-15 16:22:31 +00:00
f(it);
2018-01-15 19:30:53 +00:00
it = std::fill_n(it, padding, fill);
}
}
2017-10-24 04:02:54 +00:00
2017-12-30 15:42:56 +00:00
template <typename Range>
template <typename Char>
2017-12-30 15:42:56 +00:00
void basic_writer<Range>::write_str(
basic_string_view<Char> s, const format_specs &spec) {
// Check if Char is convertible to char_type.
internal::char_traits<char_type>::convert(Char());
2017-12-30 15:42:56 +00:00
const Char *data = s.data();
std::size_t size = s.size();
if (size == 0 && !data)
FMT_THROW(format_error("string pointer is null"));
std::size_t precision = static_cast<std::size_t>(spec.precision_);
2017-12-30 15:42:56 +00:00
if (spec.precision_ >= 0 && precision < size)
size = precision;
write_str(data, size, spec);
}
2017-12-30 15:42:56 +00:00
template <typename Range>
template <typename T>
2017-12-30 15:42:56 +00:00
void basic_writer<Range>::write_double(T value, const format_specs &spec) {
// Check type.
2017-11-23 17:14:37 +00:00
struct spec_handler {
2018-01-14 15:19:23 +00:00
char_type type;
2017-11-23 17:14:37 +00:00
bool upper = false;
2018-01-14 15:19:23 +00:00
explicit spec_handler(char_type t) : type(t) {}
2017-11-23 17:14:37 +00:00
void on_general() {
if (type == 'G')
upper = true;
else
type = 'g';
}
void on_exp() {
if (type == 'E')
upper = true;
}
void on_fixed() {
if (type == 'F') {
upper = true;
#if FMT_MSC_VER
2017-11-23 17:14:37 +00:00
// MSVC's printf doesn't support 'F'.
type = 'f';
#endif
2017-11-23 17:14:37 +00:00
}
}
void on_hex() {
if (type == 'A')
upper = true;
}
void on_error() {
FMT_THROW(format_error("invalid type specifier"));
2017-11-23 17:14:37 +00:00
}
};
spec_handler handler(spec.type());
internal::handle_float_type_spec(spec.type(), handler);
2017-09-03 15:28:30 +00:00
char sign = 0;
// Use isnegative instead of value < 0 because the latter is always
// false for NaN.
if (internal::fputil::isnegative(static_cast<double>(value))) {
sign = '-';
value = -value;
} else if (spec.flag(SIGN_FLAG)) {
sign = spec.flag(PLUS_FLAG) ? '+' : ' ';
2017-09-03 15:28:30 +00:00
}
2018-01-06 17:09:50 +00:00
auto write_inf_or_nan = [this, &spec, sign](const char *str) {
enum {SIZE = 3}; // This is an enum to workaround a bug in MSVC.
2018-01-15 16:22:31 +00:00
write_padded(SIZE + (sign ? 1 : 0), spec, [sign, str](auto &&it) {
2018-01-06 17:09:50 +00:00
if (sign)
*it++ = sign;
2018-01-15 19:30:53 +00:00
it = std::copy_n(str, static_cast<std::size_t>(SIZE), it);
2018-01-06 17:09:50 +00:00
});
};
2017-09-03 15:28:30 +00:00
2018-01-06 17:09:50 +00:00
// Format NaN and ininity ourselves because sprintf's output is not consistent
// across platforms.
if (internal::fputil::isnotanumber(value))
return write_inf_or_nan(handler.upper ? "NAN" : "nan");
if (internal::fputil::isinfinity(value))
return write_inf_or_nan(handler.upper ? "INF" : "inf");
2017-09-03 15:28:30 +00:00
2017-12-30 15:42:56 +00:00
basic_memory_buffer<char_type> buffer;
unsigned width = spec.width();
if (sign) {
2017-12-30 15:42:56 +00:00
buffer.reserve(width > 1u ? width : 1u);
if (width > 0)
--width;
2017-09-03 15:28:30 +00:00
}
// Build format string.
enum { MAX_FORMAT_SIZE = 10}; // longest format: %#-*.*Lg
char_type format[MAX_FORMAT_SIZE];
char_type *format_ptr = format;
*format_ptr++ = '%';
unsigned width_for_sprintf = width;
if (spec.flag(HASH_FLAG))
*format_ptr++ = '#';
2018-01-06 17:09:50 +00:00
width_for_sprintf = 0;
if (spec.precision() >= 0) {
*format_ptr++ = '.';
*format_ptr++ = '*';
2017-09-03 15:28:30 +00:00
}
append_float_length(format_ptr, value);
2017-11-23 17:14:37 +00:00
*format_ptr++ = handler.type;
*format_ptr = '\0';
2017-09-03 15:28:30 +00:00
// Format using snprintf.
unsigned n = 0;
2018-01-21 02:37:57 +00:00
char_type *start = FMT_NULL;
for (;;) {
2018-01-06 17:09:50 +00:00
std::size_t buffer_size = buffer.capacity();
#if FMT_MSC_VER
// MSVC's vsnprintf_s doesn't work with zero size, so reserve
// space for at least one extra character to make the size non-zero.
2017-12-30 15:42:56 +00:00
// Note that the buffer's capacity may increase by more than 1.
if (buffer_size == 0) {
2018-01-06 17:09:50 +00:00
buffer.reserve(1);
buffer_size = buffer.capacity();
}
#endif
2018-01-06 17:09:50 +00:00
start = &buffer[0];
int result = internal::char_traits<char_type>::format_float(
start, buffer_size, format, width_for_sprintf, spec.precision(), value);
if (result >= 0) {
n = internal::to_unsigned(result);
2018-01-06 17:09:50 +00:00
if (n < buffer.capacity())
break; // The buffer is large enough - continue with formatting.
2018-01-06 17:09:50 +00:00
buffer.reserve(n + 1);
} else {
// If result is negative we ask to increase the capacity by at least 1,
// but as std::vector, the buffer grows exponentially.
2017-12-30 15:42:56 +00:00
buffer.reserve(buffer.capacity() + 1);
2017-09-03 15:28:30 +00:00
}
}
2018-01-06 17:09:50 +00:00
align_spec as = spec;
if (spec.align() == ALIGN_NUMERIC) {
if (sign) {
2018-01-15 16:22:31 +00:00
*reserve(1) = sign;
2018-01-06 17:09:50 +00:00
sign = 0;
--as.width_;
}
as.align_ = ALIGN_RIGHT;
} else {
if (spec.align() == ALIGN_DEFAULT)
as.align_ = ALIGN_RIGHT;
if (sign)
++n;
}
2018-01-15 16:22:31 +00:00
write_padded(n, as, [n, sign, &buffer](auto &&it) mutable {
2017-12-30 15:42:56 +00:00
if (sign) {
*it++ = sign;
--n;
}
2018-01-15 19:30:53 +00:00
it = std::copy_n(buffer.begin(), n, it);
2017-12-30 15:42:56 +00:00
});
}
2017-09-03 15:28:30 +00:00
2018-01-28 02:56:50 +00:00
// A range where begin() returns back_insert_iterator.
template <typename Container>
class back_insert_range:
public output_range<std::back_insert_iterator<Container>> {
using base = output_range<std::back_insert_iterator<Container>>;
public:
using value_type = typename Container::value_type;
using base::base;
back_insert_range(Container &c): base(std::back_inserter(c)) {}
};
2018-01-15 16:22:31 +00:00
using writer = basic_writer<back_insert_range<internal::buffer>>;
using wwriter = basic_writer<back_insert_range<internal::wbuffer>>;
2018-01-14 15:19:23 +00:00
// Reports a system error without throwing an exception.
// Can be used to report errors from destructors.
FMT_API void report_system_error(int error_code,
string_view message) FMT_NOEXCEPT;
2017-09-03 15:28:30 +00:00
#if FMT_USE_WINDOWS_H
2017-08-13 20:09:02 +00:00
/** A Windows error. */
class windows_error : public system_error {
private:
2017-12-03 15:32:04 +00:00
FMT_API void init(int error_code, string_view format_str, format_args args);
2017-09-03 15:28:30 +00:00
2017-08-13 20:09:02 +00:00
public:
/**
\rst
Constructs a :class:`fmt::windows_error` object with the description
of the form
.. parsed-literal::
*<message>*: *<system-message>*
where *<message>* is the formatted message and *<system-message>* is the
system message corresponding to the error code.
*error_code* is a Windows error code as given by ``GetLastError``.
If *error_code* is not a valid error code such as -1, the system message
will look like "error -1".
**Example**::
// This throws a windows_error with the description
// cannot open file 'madeup': The system cannot find the file specified.
// or similar (system message may vary).
const char *filename = "madeup";
LPOFSTRUCT of = LPOFSTRUCT();
HFILE file = OpenFile(filename, &of, OF_READ);
if (file == HFILE_ERROR) {
throw fmt::windows_error(GetLastError(),
"cannot open file '{}'", filename);
}
\endrst
*/
template <typename... Args>
windows_error(int error_code, string_view message, const Args & ... args) {
init(error_code, message, make_args(args...));
}
2017-08-13 20:09:02 +00:00
};
// Reports a Windows error without throwing an exception.
// Can be used to report errors from destructors.
FMT_API void report_windows_error(int error_code,
string_view message) FMT_NOEXCEPT;
2017-08-13 20:09:02 +00:00
#endif
2017-08-13 20:09:02 +00:00
2018-01-15 19:30:53 +00:00
/** Fast integer formatter. */
class FormatInt {
private:
// Buffer should be large enough to hold all digits (digits10 + 1),
// a sign and a null character.
enum {BUFFER_SIZE = std::numeric_limits<unsigned long long>::digits10 + 3};
mutable char buffer_[BUFFER_SIZE];
char *str_;
// Formats value in reverse and returns a pointer to the beginning.
char *format_decimal(unsigned long long value) {
char *ptr = buffer_ + BUFFER_SIZE - 1;
while (value >= 100) {
// Integer division is slow so do it for a group of two digits instead
// of for every digit. The idea comes from the talk by Alexandrescu
// "Three Optimization Tips for C++". See speed-test for a comparison.
unsigned index = static_cast<unsigned>((value % 100) * 2);
value /= 100;
*--ptr = internal::data::DIGITS[index + 1];
*--ptr = internal::data::DIGITS[index];
}
if (value < 10) {
*--ptr = static_cast<char>('0' + value);
return ptr;
}
unsigned index = static_cast<unsigned>(value * 2);
*--ptr = internal::data::DIGITS[index + 1];
*--ptr = internal::data::DIGITS[index];
return ptr;
}
void format_signed(long long value) {
unsigned long long abs_value = static_cast<unsigned long long>(value);
bool negative = value < 0;
if (negative)
abs_value = 0 - abs_value;
str_ = format_decimal(abs_value);
if (negative)
*--str_ = '-';
}
public:
explicit FormatInt(int value) { format_signed(value); }
explicit FormatInt(long value) { format_signed(value); }
explicit FormatInt(long long value) { format_signed(value); }
explicit FormatInt(unsigned value) : str_(format_decimal(value)) {}
explicit FormatInt(unsigned long value) : str_(format_decimal(value)) {}
explicit FormatInt(unsigned long long value) : str_(format_decimal(value)) {}
2017-10-29 15:19:55 +00:00
/** Returns the number of characters written to the output buffer. */
std::size_t size() const {
return internal::to_unsigned(buffer_ - str_ + BUFFER_SIZE - 1);
2017-10-29 15:19:55 +00:00
}
/**
Returns a pointer to the output buffer content. No terminating null
character is appended.
*/
const char *data() const { return str_; }
/**
Returns a pointer to the output buffer content with terminating null
character appended.
*/
const char *c_str() const {
buffer_[BUFFER_SIZE - 1] = '\0';
return str_;
2017-10-29 15:19:55 +00:00
}
/**
\rst
Returns the content of the output buffer as an ``std::string``.
\endrst
*/
std::string str() const { return std::string(str_, size()); }
2017-10-29 15:19:55 +00:00
};
// Formats a decimal integer value writing into buffer and returns
// a pointer to the end of the formatted string. This function doesn't
// write a terminating null character.
template <typename T>
inline void format_decimal(char *&buffer, T value) {
2018-01-06 17:09:50 +00:00
using main_type = typename internal::int_traits<T>::main_type;
main_type abs_value = static_cast<main_type>(value);
if (internal::is_negative(value)) {
*buffer++ = '-';
abs_value = 0 - abs_value;
}
if (abs_value < 100) {
if (abs_value < 10) {
*buffer++ = static_cast<char>('0' + abs_value);
2017-10-29 14:32:14 +00:00
return;
}
unsigned index = static_cast<unsigned>(abs_value * 2);
*buffer++ = internal::data::DIGITS[index];
*buffer++ = internal::data::DIGITS[index + 1];
return;
2017-10-27 14:25:29 +00:00
}
unsigned num_digits = internal::count_digits(abs_value);
internal::format_decimal(buffer, abs_value, num_digits);
buffer += num_digits;
}
2017-08-13 20:09:02 +00:00
// Formatter of objects of type T.
template <typename T, typename Char>
2017-08-26 17:41:58 +00:00
struct formatter<
T, Char, typename std::enable_if<internal::format_type<T>::value>::type> {
2017-08-13 20:09:02 +00:00
// Parses format specifiers stopping either at the end of the range or at the
// terminating '}'.
template <typename ParseContext>
constexpr typename ParseContext::iterator parse(ParseContext &ctx) {
auto it = internal::null_terminating_iterator<Char>(ctx);
using handler_type = internal::dynamic_specs_handler<ParseContext>;
2017-11-23 17:14:37 +00:00
auto type = internal::get_type<T>();
2017-09-03 15:28:30 +00:00
internal::specs_checker<handler_type>
2017-11-23 17:14:37 +00:00
handler(handler_type(specs_, ctx), type);
2017-09-03 15:28:30 +00:00
it = parse_format_specs(it, handler);
2017-11-24 17:54:28 +00:00
auto type_spec = specs_.type();
2017-11-23 17:14:37 +00:00
auto eh = ctx.error_handler();
switch (type) {
case internal::NONE:
case internal::NAMED_ARG:
FMT_ASSERT(false, "invalid argument type");
break;
case internal::INT:
case internal::UINT:
case internal::LONG_LONG:
case internal::ULONG_LONG:
case internal::BOOL:
handle_int_type_spec(
2017-11-24 17:54:28 +00:00
type_spec, internal::int_type_checker<decltype(eh)>(eh));
2017-11-23 17:14:37 +00:00
break;
case internal::CHAR:
2017-11-24 15:54:22 +00:00
handle_char_specs(specs_, internal::char_specs_checker<decltype(eh)>(
2017-11-24 17:54:28 +00:00
type_spec, eh));
2017-11-23 17:14:37 +00:00
break;
case internal::DOUBLE:
case internal::LONG_DOUBLE:
handle_float_type_spec(
2017-11-24 17:54:28 +00:00
type_spec, internal::float_type_checker<decltype(eh)>(eh));
2017-11-23 17:14:37 +00:00
break;
case internal::CSTRING:
2017-11-24 17:54:28 +00:00
internal::handle_cstring_type_spec(
type_spec, internal::cstring_type_checker<decltype(eh)>(eh));
break;
2017-11-23 17:14:37 +00:00
case internal::STRING:
2017-11-24 17:54:28 +00:00
internal::check_string_type_spec(type_spec, eh);
2017-11-23 17:14:37 +00:00
break;
case internal::POINTER:
2017-11-24 17:54:28 +00:00
internal::check_pointer_type_spec(type_spec, eh);
2017-11-23 17:14:37 +00:00
break;
case internal::CUSTOM:
// Custom format specifiers should be checked in parse functions of
// formatter specializations.
break;
2017-11-16 14:55:49 +00:00
}
2017-08-13 20:09:02 +00:00
return pointer_from(it);
}
2018-01-14 19:00:27 +00:00
template <typename FormatContext>
2018-01-14 20:25:03 +00:00
auto format(const T &val, FormatContext &ctx) -> decltype(ctx.begin()) {
2017-10-21 14:13:20 +00:00
internal::handle_dynamic_spec<internal::width_checker>(
2017-08-13 20:09:02 +00:00
specs_.width_, specs_.width_ref, ctx);
2017-10-21 14:13:20 +00:00
internal::handle_dynamic_spec<internal::precision_checker>(
2017-08-13 20:09:02 +00:00
specs_.precision_, specs_.precision_ref, ctx);
2018-01-21 22:30:38 +00:00
using range = output_range<
typename FormatContext::iterator, typename FormatContext::char_type>;
2018-01-15 16:22:31 +00:00
visit(arg_formatter<range>(ctx, specs_),
2018-01-14 19:00:27 +00:00
internal::make_arg<FormatContext>(val));
return ctx.begin();
}
private:
2017-08-13 20:09:02 +00:00
internal::dynamic_format_specs<Char> specs_;
};
template <typename T, typename Char>
struct formatter<T, Char,
typename std::enable_if<internal::format_enum<T>::value>::type>
: public formatter<int, Char> {
template <typename ParseContext>
auto parse(ParseContext &ctx) -> decltype(ctx.begin()) {
return ctx.begin();
2017-08-13 20:09:02 +00:00
}
};
2017-09-03 15:28:30 +00:00
// A formatter for types known only at run time such as variant alternatives.
//
// Usage:
// using variant = std::variant<int, std::string>;
// template <>
// struct formatter<variant>: dynamic_formatter<> {
// void format(buffer &buf, const variant &v, context &ctx) {
// visit([&](const auto &val) { format(buf, val, ctx); }, v);
// }
// };
template <typename Char = char>
struct dynamic_formatter {
template <typename ParseContext>
auto parse(ParseContext &ctx) -> decltype(ctx.begin()) {
auto it = internal::null_terminating_iterator<Char>(ctx);
2017-09-03 15:28:30 +00:00
// Checks are deferred to formatting time when the argument type is known.
internal::dynamic_specs_handler<ParseContext> handler(specs_, ctx);
2017-09-03 15:28:30 +00:00
it = parse_format_specs(it, handler);
return pointer_from(it);
}
2018-01-14 19:00:27 +00:00
template <typename T, typename FormatContext>
auto format(const T &val, FormatContext &ctx) -> decltype(ctx.begin()) {
2017-09-03 15:28:30 +00:00
handle_specs(ctx);
2017-10-24 04:02:54 +00:00
struct null_handler : internal::error_handler {
2017-09-03 15:28:30 +00:00
void on_align(alignment) {}
void on_plus() {}
void on_minus() {}
void on_space() {}
void on_hash() {}
};
internal::specs_checker<null_handler>
2017-09-06 14:00:21 +00:00
checker(null_handler(), internal::get_type<T>());
2017-09-03 15:28:30 +00:00
checker.on_align(specs_.align());
if (specs_.flags_ == 0) {
// Do nothing.
} else if (specs_.flag(SIGN_FLAG)) {
if (specs_.flag(PLUS_FLAG))
checker.on_plus();
else
checker.on_space();
} else if (specs_.flag(MINUS_FLAG)) {
checker.on_minus();
} else if (specs_.flag(HASH_FLAG)) {
checker.on_hash();
}
if (specs_.precision_ != -1)
checker.end_precision();
2018-01-21 22:30:38 +00:00
using range = output_range<
typename FormatContext::iterator, typename FormatContext::char_type>;
visit(arg_formatter<range>(ctx, specs_),
2018-01-14 19:00:27 +00:00
internal::make_arg<FormatContext>(val));
return ctx.begin();
2017-09-03 15:28:30 +00:00
}
private:
2018-01-06 17:09:50 +00:00
template <typename Context>
void handle_specs(Context &ctx) {
2017-10-21 14:13:20 +00:00
internal::handle_dynamic_spec<internal::width_checker>(
2017-09-03 15:28:30 +00:00
specs_.width_, specs_.width_ref, ctx);
2017-10-21 14:13:20 +00:00
internal::handle_dynamic_spec<internal::precision_checker>(
2017-09-03 15:28:30 +00:00
specs_.precision_, specs_.precision_ref, ctx);
}
internal::dynamic_format_specs<Char> specs_;
};
2018-01-21 22:30:38 +00:00
template <typename Range, typename Char>
typename basic_context<Range, Char>::format_arg
basic_context<Range, Char>::get_arg(basic_string_view<char_type> name) {
map_.init(this->args());
2018-01-06 17:09:50 +00:00
format_arg arg = map_.find(name);
if (arg.type() == internal::NONE)
this->on_error("argument not found");
return arg;
}
/** Formats arguments and writes the output to the buffer. */
2016-11-07 00:11:24 +00:00
template <typename ArgFormatter, typename Char, typename Context>
2018-01-27 15:03:26 +00:00
typename Context::iterator do_vformat_to(typename ArgFormatter::range out,
basic_string_view<Char> format_str,
basic_format_args<Context> args) {
2017-10-27 14:25:29 +00:00
using iterator = internal::null_terminating_iterator<Char>;
2018-01-13 20:57:27 +00:00
using range = typename ArgFormatter::range;
2017-10-27 14:25:29 +00:00
struct handler : internal::error_handler {
2018-01-14 15:19:23 +00:00
handler(range r, basic_string_view<Char> str,
2017-12-03 15:32:04 +00:00
basic_format_args<Context> format_args)
2018-01-21 22:30:38 +00:00
: context(r.begin(), str, format_args) {}
2017-10-27 14:25:29 +00:00
void on_text(iterator begin, iterator end) {
2018-01-14 15:19:23 +00:00
size_t size = end - begin;
2018-01-15 19:30:53 +00:00
auto out = context.begin();
2018-01-15 16:22:31 +00:00
auto &&it = internal::reserve(out, size);
2018-01-15 19:30:53 +00:00
it = std::copy_n(begin, size, it);
2018-01-15 16:22:31 +00:00
context.advance_to(out);
}
2017-10-27 14:25:29 +00:00
void on_arg_id() { arg = context.next_arg(); }
void on_arg_id(unsigned id) {
context.parse_context().check_arg_id(id);
2017-10-27 14:25:29 +00:00
arg = context.get_arg(id);
}
void on_arg_id(basic_string_view<Char> id) {
arg = context.get_arg(id);
}
2017-10-27 14:25:29 +00:00
void on_replacement_field(iterator it) {
context.parse_context().advance_to(pointer_from(it));
2017-10-27 14:25:29 +00:00
using internal::custom_formatter;
2018-01-06 17:09:50 +00:00
if (visit(custom_formatter<Char, Context>(context), arg))
2017-10-27 14:25:29 +00:00
return;
basic_format_specs<Char> specs;
2018-01-15 16:22:31 +00:00
visit(ArgFormatter(context, specs), arg);
2017-10-27 14:25:29 +00:00
}
2017-10-27 14:25:29 +00:00
iterator on_format_specs(iterator it) {
auto& parse_ctx = context.parse_context();
parse_ctx.advance_to(pointer_from(it));
2017-10-27 14:25:29 +00:00
using internal::custom_formatter;
2018-01-06 17:09:50 +00:00
if (visit(custom_formatter<Char, Context>(context), arg))
return iterator(parse_ctx);
2017-10-27 14:25:29 +00:00
basic_format_specs<Char> specs;
using internal::specs_handler;
internal::specs_checker<specs_handler<Context>>
handler(specs_handler<Context>(specs, context), arg.type());
it = parse_format_specs(it, handler);
if (*it != '}')
on_error("missing '}' in format string");
parse_ctx.advance_to(pointer_from(it));
2018-01-15 16:22:31 +00:00
visit(ArgFormatter(context, specs), arg);
2017-10-27 14:25:29 +00:00
return it;
}
2018-01-06 17:09:50 +00:00
Context context;
2017-10-27 14:25:29 +00:00
basic_arg<Context> arg;
2018-01-27 15:03:26 +00:00
} h(out, format_str, args);
parse_format_string(iterator(format_str.begin(), format_str.end()), h);
return h.context.begin();
2016-11-07 00:11:24 +00:00
}
// Casts ``p`` to ``const void*`` for pointer formatting.
// Example:
// auto s = format("{}", ptr(p));
template <typename T>
inline const void *ptr(const T *p) { return p; }
class fill_spec_factory {
public:
constexpr fill_spec_factory() {}
template <typename Char>
fill_spec<Char> operator=(Char value) const {
return fill_spec<Char>(value);
}
};
template <typename FormatSpec>
class format_spec_factory {
public:
constexpr format_spec_factory() {}
FormatSpec operator=(typename FormatSpec::value_type value) const {
return FormatSpec(value);
}
};
constexpr fill_spec_factory fill;
constexpr format_spec_factory<width_spec> width;
constexpr format_spec_factory<type_spec> type;
2018-01-28 00:04:45 +00:00
template <typename It, typename Char>
struct arg_join {
It begin;
It end;
basic_string_view<Char> sep;
arg_join(It begin, It end, basic_string_view<Char> sep)
: begin(begin), end(end), sep(sep) {}
};
template <typename It, typename Char>
struct formatter<arg_join<It, Char>, Char>:
formatter<typename std::iterator_traits<It>::value_type, Char> {
template <typename FormatContext>
auto format(const arg_join<It, Char> &value, FormatContext &ctx) {
using base = formatter<typename std::iterator_traits<It>::value_type, Char>;
auto it = value.begin;
auto out = ctx.begin();
if (it != value.end) {
out = base::format(*it++, ctx);
while (it != value.end) {
out = std::copy(value.sep.begin(), value.sep.end(), out);
ctx.advance_to(out);
out = base::format(*it++, ctx);
}
}
return out;
}
};
template <typename It>
arg_join<It, char> join(It begin, It end, string_view sep) {
return arg_join<It, char>(begin, end, sep);
}
template <typename It>
arg_join<It, wchar_t> join(It begin, It end, wstring_view sep) {
return arg_join<It, wchar_t>(begin, end, sep);
}
#if FMT_HAS_GXX_CXX11
template <typename Range>
auto join(const Range &range, string_view sep)
-> arg_join<decltype(std::begin(range)), char> {
return join(std::begin(range), std::end(range), sep);
}
template <typename Range>
auto join(const Range &range, wstring_view sep)
-> arg_join<decltype(std::begin(range)), wchar_t> {
return join(std::begin(range), std::end(range), sep);
}
#endif
2018-01-14 20:25:03 +00:00
/**
\rst
Converts *value* to ``std::string`` using the default format for type *T*.
**Example**::
#include "fmt/string.h"
std::string answer = fmt::to_string(42);
\endrst
*/
template <typename T>
std::string to_string(const T &value) {
std::string str;
internal::container_buffer<std::string> buf(str);
writer(buf).write(value);
return str;
2018-01-14 15:19:23 +00:00
}
2018-01-14 20:25:03 +00:00
template <typename Char>
std::basic_string<Char> to_string(const basic_memory_buffer<Char> &buffer) {
return std::basic_string<Char>(buffer.data(), buffer.size());
2018-01-14 15:19:23 +00:00
}
2018-01-14 22:15:59 +00:00
inline void vformat_to(internal::buffer &buf, string_view format_str,
format_args args) {
2018-01-15 16:22:31 +00:00
using range = back_insert_range<internal::buffer>;
2018-01-14 20:25:03 +00:00
do_vformat_to<arg_formatter<range>>(buf, format_str, args);
}
2018-01-14 22:15:59 +00:00
inline void vformat_to(internal::wbuffer &buf, wstring_view format_str,
wformat_args args) {
2018-01-15 16:22:31 +00:00
using range = back_insert_range<internal::wbuffer>;
2018-01-14 20:25:03 +00:00
do_vformat_to<arg_formatter<range>>(buf, format_str, args);
}
2018-01-14 22:15:59 +00:00
template <typename... Args>
inline void format_to(memory_buffer &buf, string_view format_str,
const Args & ... args) {
vformat_to(buf, format_str, make_args(args...));
}
template <typename... Args>
inline void format_to(wmemory_buffer &buf, wstring_view format_str,
const Args & ... args) {
vformat_to(buf, format_str, make_args<wcontext>(args...));
2018-01-14 20:25:03 +00:00
}
2018-01-18 06:04:24 +00:00
template <typename OutputIt, typename Char = char>
2018-01-21 22:30:38 +00:00
using context_t = basic_context<OutputIt, Char>;
2018-01-18 06:04:24 +00:00
2018-01-21 22:30:38 +00:00
template <typename OutputIt, typename Char = char>
using format_args_t = basic_format_args<context_t<OutputIt, Char>>;
2018-01-18 06:04:24 +00:00
template <typename OutputIt, typename... Args>
2018-01-27 15:03:26 +00:00
inline OutputIt vformat_to(OutputIt out, string_view format_str,
format_args_t<OutputIt> args) {
2018-01-18 06:04:24 +00:00
using range = output_range<OutputIt, char>;
2018-01-27 15:03:26 +00:00
return do_vformat_to<arg_formatter<range>>(range(out), format_str, args);
2018-01-18 06:04:24 +00:00
}
template <typename OutputIt, typename... Args>
2018-01-27 15:03:26 +00:00
inline OutputIt format_to(OutputIt out, string_view format_str,
const Args & ... args) {
return vformat_to(out, format_str, *make_args<context_t<OutputIt>>(args...));
}
2018-01-14 20:25:03 +00:00
template <typename Container, typename... Args>
2018-01-15 19:30:53 +00:00
inline typename std::enable_if<is_contiguous<Container>::value>::type
format_to(std::back_insert_iterator<Container> out,
string_view format_str, const Args & ... args) {
2018-01-14 20:25:03 +00:00
vformat_to(out, format_str, make_args(args...));
}
inline std::string vformat(string_view format_str, format_args args) {
memory_buffer buffer;
vformat_to(buffer, format_str, args);
2018-01-14 20:25:03 +00:00
return fmt::to_string(buffer);
}
inline std::wstring vformat(wstring_view format_str, wformat_args args) {
wmemory_buffer buffer;
vformat_to(buffer, format_str, args);
return to_string(buffer);
}
template <typename String, typename... Args>
inline typename std::enable_if<
std::is_base_of<internal::format_string, String>::value, std::string>::type
format(String format_str, const Args & ... args) {
constexpr bool invalid_format =
internal::check_format_string<char, internal::error_handler, Args...>(
string_view(format_str.value(), format_str.size()));
(void)invalid_format;
return vformat(format_str.value(), make_args(args...));
}
2018-01-18 06:04:24 +00:00
// Counts the number of characters in the output of format(format_str, args...).
template <typename... Args>
inline std::size_t count(string_view format_str, const Args & ... args) {
std::size_t size = 0;
internal::counting_iterator<char> it(size);
format_to(it, format_str, args...);
return size;
}
} // namespace fmt
#if FMT_USE_USER_DEFINED_LITERALS
namespace fmt {
namespace internal {
2017-11-04 16:02:47 +00:00
# if FMT_UDL_TEMPLATE
template <typename Char, Char... CHARS>
class udl_formatter {
public:
2017-11-04 16:02:47 +00:00
template <typename... Args>
std::basic_string<Char> operator()(const Args &... args) const {
constexpr Char s[] = {CHARS..., '\0'};
2017-11-11 18:28:05 +00:00
constexpr bool invalid_format =
check_format_string<Char, error_handler, Args...>(
basic_string_view<Char>(s, sizeof...(CHARS)));
2017-11-16 14:55:49 +00:00
(void)invalid_format;
2017-11-04 16:02:47 +00:00
return format(s, args...);
}
};
# else
template <typename Char>
struct udl_formatter {
const Char *str;
template <typename... Args>
auto operator()(Args && ... args) const
-> decltype(format(str, std::forward<Args>(args)...)) {
return format(str, std::forward<Args>(args)...);
}
};
2017-11-04 16:02:47 +00:00
# endif // FMT_UDL_TEMPLATE
template <typename Char>
2017-11-19 16:02:07 +00:00
struct udl_arg {
const Char *str;
template <typename T>
2018-01-06 17:09:50 +00:00
named_arg<T, Char> operator=(T &&value) const {
return {str, std::forward<T>(value)};
}
};
} // namespace internal
inline namespace literals {
2017-11-04 16:02:47 +00:00
# if FMT_UDL_TEMPLATE
template <typename Char, Char... CHARS>
constexpr internal::udl_formatter<Char, CHARS...> operator""_format() {
return {};
}
# else
/**
\rst
C++11 literal equivalent of :func:`fmt::format`.
**Example**::
using namespace fmt::literals;
std::string message = "The answer is {}"_format(42);
\endrst
*/
2017-11-04 16:02:47 +00:00
inline internal::udl_formatter<char>
operator"" _format(const char *s, std::size_t) { return {s}; }
2017-11-04 16:02:47 +00:00
inline internal::udl_formatter<wchar_t>
operator"" _format(const wchar_t *s, std::size_t) { return {s}; }
2017-11-04 16:02:47 +00:00
# endif // FMT_UDL_TEMPLATE
/**
\rst
C++11 literal equivalent of :func:`fmt::arg`.
**Example**::
using namespace fmt::literals;
print("Elapsed time: {s:.2f} seconds", "s"_a=1.23);
\endrst
*/
2017-11-19 16:02:07 +00:00
inline internal::udl_arg<char>
operator"" _a(const char *s, std::size_t) { return {s}; }
2017-11-19 16:02:07 +00:00
inline internal::udl_arg<wchar_t>
operator"" _a(const wchar_t *s, std::size_t) { return {s}; }
} // inline namespace literals
} // namespace fmt
#endif // FMT_USE_USER_DEFINED_LITERALS
#define FMT_STRING(s) [] { \
struct S : fmt::internal::format_string { \
static constexpr auto value() { return s; } \
static constexpr size_t size() { return sizeof(s); } \
}; \
return S{}; \
}()
2017-11-04 15:23:24 +00:00
2017-08-21 13:50:57 +00:00
#ifdef FMT_HEADER_ONLY
# define FMT_FUNC inline
# include "format.cc"
#else
# define FMT_FUNC
#endif
// Restore warnings.
#if FMT_GCC_VERSION >= 406
# pragma GCC diagnostic pop
#endif
#if defined(__clang__) && !defined(FMT_ICC_VERSION)
# pragma clang diagnostic pop
#endif
#endif // FMT_FORMAT_H_