2018-01-06 17:09:50 +00:00
|
|
|
// Formatting library for C++ - std::ostream support
|
|
|
|
//
|
2018-11-14 17:39:37 +00:00
|
|
|
// Copyright (c) 2012 - present, Victor Zverovich
|
2018-01-06 17:09:50 +00:00
|
|
|
// All rights reserved.
|
|
|
|
//
|
|
|
|
// For the license information refer to format.h.
|
2016-05-06 14:37:20 +00:00
|
|
|
|
|
|
|
#ifndef FMT_OSTREAM_H_
|
|
|
|
#define FMT_OSTREAM_H_
|
|
|
|
|
|
|
|
#include <ostream>
|
2020-04-12 14:38:54 +00:00
|
|
|
|
2019-01-13 02:27:38 +00:00
|
|
|
#include "format.h"
|
2016-05-06 14:37:20 +00:00
|
|
|
|
2018-05-12 15:33:51 +00:00
|
|
|
FMT_BEGIN_NAMESPACE
|
2020-04-12 14:38:54 +00:00
|
|
|
|
|
|
|
template <typename OutputIt, typename Char> class basic_printf_context;
|
|
|
|
|
2020-05-10 14:25:42 +00:00
|
|
|
namespace detail {
|
2016-05-06 14:37:20 +00:00
|
|
|
|
2019-01-13 02:27:38 +00:00
|
|
|
template <class Char> class formatbuf : public std::basic_streambuf<Char> {
|
2016-05-06 14:37:20 +00:00
|
|
|
private:
|
2019-07-07 14:21:20 +00:00
|
|
|
using int_type = typename std::basic_streambuf<Char>::int_type;
|
|
|
|
using traits_type = typename std::basic_streambuf<Char>::traits_type;
|
2016-05-06 14:37:20 +00:00
|
|
|
|
2019-04-07 17:05:49 +00:00
|
|
|
buffer<Char>& buffer_;
|
2016-05-06 14:37:20 +00:00
|
|
|
|
|
|
|
public:
|
2021-09-03 19:47:33 +00:00
|
|
|
explicit formatbuf(buffer<Char>& buf) : buffer_(buf) {}
|
2018-01-29 04:08:51 +00:00
|
|
|
|
|
|
|
protected:
|
2021-09-03 16:33:24 +00:00
|
|
|
// The put area is always empty. This makes the implementation simpler and has
|
|
|
|
// the advantage that the streambuf and the buffer are always in sync and
|
|
|
|
// sputc never writes into uninitialized memory. A disadvantage is that each
|
|
|
|
// call to sputc always results in a (virtual) call to overflow. There is no
|
|
|
|
// disadvantage here for sputn since this always results in a call to xsputn.
|
|
|
|
|
2021-09-03 19:47:33 +00:00
|
|
|
auto overflow(int_type ch = traits_type::eof()) -> int_type override {
|
2018-01-29 04:08:51 +00:00
|
|
|
if (!traits_type::eq_int_type(ch, traits_type::eof()))
|
|
|
|
buffer_.push_back(static_cast<Char>(ch));
|
2016-05-06 14:37:20 +00:00
|
|
|
return ch;
|
|
|
|
}
|
|
|
|
|
2021-09-03 16:33:24 +00:00
|
|
|
auto xsputn(const Char* s, std::streamsize count)
|
|
|
|
-> std::streamsize override {
|
2018-01-29 04:08:51 +00:00
|
|
|
buffer_.append(s, s + count);
|
|
|
|
return count;
|
2016-05-06 14:37:20 +00:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2021-09-03 16:33:24 +00:00
|
|
|
// Checks if T has a user-defined operator<<.
|
|
|
|
template <typename T, typename Char, typename Enable = void>
|
|
|
|
class is_streamable {
|
2018-01-23 02:56:53 +00:00
|
|
|
private:
|
|
|
|
template <typename U>
|
2021-09-03 16:33:24 +00:00
|
|
|
static auto test(int)
|
|
|
|
-> bool_constant<sizeof(std::declval<std::basic_ostream<Char>&>()
|
|
|
|
<< std::declval<U>()) != 0>;
|
2018-01-22 02:53:38 +00:00
|
|
|
|
2021-09-03 16:33:24 +00:00
|
|
|
template <typename> static auto test(...) -> std::false_type;
|
2018-01-23 02:56:53 +00:00
|
|
|
|
2019-07-07 14:21:20 +00:00
|
|
|
using result = decltype(test<T>(0));
|
2018-02-28 13:09:24 +00:00
|
|
|
|
2018-01-23 02:56:53 +00:00
|
|
|
public:
|
2020-12-09 14:55:17 +00:00
|
|
|
is_streamable() = default;
|
|
|
|
|
2018-08-11 16:13:54 +00:00
|
|
|
static const bool value = result::value;
|
2018-05-22 03:21:06 +00:00
|
|
|
};
|
|
|
|
|
2021-09-03 16:33:24 +00:00
|
|
|
// Formatting of built-in types and arrays is intentionally disabled because
|
|
|
|
// it's handled by standard (non-ostream) formatters.
|
|
|
|
template <typename T, typename Char>
|
|
|
|
struct is_streamable<
|
|
|
|
T, Char,
|
|
|
|
enable_if_t<std::is_arithmetic<T>::value || std::is_array<T>::value ||
|
|
|
|
std::is_same<T, char8_type>::value ||
|
|
|
|
(std::is_convertible<T, int>::value &&
|
|
|
|
!std::is_enum<T>::value)>> : std::false_type {};
|
2021-09-03 15:35:13 +00:00
|
|
|
|
2017-02-14 21:29:47 +00:00
|
|
|
// Write the content of buf to os.
|
2021-09-03 19:47:33 +00:00
|
|
|
// It is a separate function rather than a part of vprint to simplify testing.
|
2017-12-17 17:33:12 +00:00
|
|
|
template <typename Char>
|
2020-06-08 14:23:18 +00:00
|
|
|
void write_buffer(std::basic_ostream<Char>& os, buffer<Char>& buf) {
|
2019-05-03 14:03:14 +00:00
|
|
|
const Char* buf_data = buf.data();
|
2019-07-07 14:21:20 +00:00
|
|
|
using unsigned_streamsize = std::make_unsigned<std::streamsize>::type;
|
|
|
|
unsigned_streamsize size = buf.size();
|
2019-09-08 16:04:09 +00:00
|
|
|
unsigned_streamsize max_size = to_unsigned(max_value<std::streamsize>());
|
2017-12-17 17:33:12 +00:00
|
|
|
do {
|
2019-07-07 14:21:20 +00:00
|
|
|
unsigned_streamsize n = size <= max_size ? size : max_size;
|
2019-05-03 14:03:14 +00:00
|
|
|
os.write(buf_data, static_cast<std::streamsize>(n));
|
|
|
|
buf_data += n;
|
2017-12-17 17:33:12 +00:00
|
|
|
size -= n;
|
|
|
|
} while (size != 0);
|
|
|
|
}
|
2016-10-21 13:46:21 +00:00
|
|
|
|
|
|
|
template <typename Char, typename T>
|
2019-11-13 12:08:47 +00:00
|
|
|
void format_value(buffer<Char>& buf, const T& value,
|
|
|
|
locale_ref loc = locale_ref()) {
|
2021-09-03 19:47:33 +00:00
|
|
|
auto&& format_buf = formatbuf<Char>(buf);
|
|
|
|
auto&& output = std::basic_ostream<Char>(&format_buf);
|
2020-04-12 14:38:54 +00:00
|
|
|
#if !defined(FMT_STATIC_THOUSANDS_SEPARATOR)
|
2019-11-13 12:08:47 +00:00
|
|
|
if (loc) output.imbue(loc.get<std::locale>());
|
2020-04-12 14:38:54 +00:00
|
|
|
#endif
|
2016-10-21 13:46:21 +00:00
|
|
|
output << value;
|
2020-05-07 00:15:46 +00:00
|
|
|
output.exceptions(std::ios_base::failbit | std::ios_base::badbit);
|
2020-07-10 14:50:37 +00:00
|
|
|
buf.try_resize(buf.size());
|
2016-10-21 13:46:21 +00:00
|
|
|
}
|
2018-08-22 14:40:06 +00:00
|
|
|
|
2017-08-13 20:09:02 +00:00
|
|
|
// Formats an object of type T that has an overloaded ostream operator<<.
|
|
|
|
template <typename T, typename Char>
|
2019-07-07 14:21:20 +00:00
|
|
|
struct fallback_formatter<T, Char, enable_if_t<is_streamable<T, Char>::value>>
|
2020-04-12 14:38:54 +00:00
|
|
|
: private formatter<basic_string_view<Char>, Char> {
|
2021-09-03 19:47:33 +00:00
|
|
|
using formatter<basic_string_view<Char>, Char>::parse;
|
2020-04-12 14:38:54 +00:00
|
|
|
|
|
|
|
template <typename OutputIt>
|
|
|
|
auto format(const T& value, basic_format_context<OutputIt, Char>& ctx)
|
|
|
|
-> OutputIt {
|
2021-09-03 19:47:33 +00:00
|
|
|
auto buffer = basic_memory_buffer<Char>();
|
2019-11-13 12:08:47 +00:00
|
|
|
format_value(buffer, value, ctx.locale());
|
2021-09-03 19:47:33 +00:00
|
|
|
return formatter<basic_string_view<Char>, Char>::format(
|
|
|
|
{buffer.data(), buffer.size()}, ctx);
|
2017-08-13 20:09:02 +00:00
|
|
|
}
|
2021-09-03 16:33:24 +00:00
|
|
|
|
|
|
|
// DEPRECATED!
|
2020-04-12 14:38:54 +00:00
|
|
|
template <typename OutputIt>
|
|
|
|
auto format(const T& value, basic_printf_context<OutputIt, Char>& ctx)
|
|
|
|
-> OutputIt {
|
2021-09-03 19:47:33 +00:00
|
|
|
auto buffer = basic_memory_buffer<Char>();
|
2020-04-12 14:38:54 +00:00
|
|
|
format_value(buffer, value, ctx.locale());
|
|
|
|
return std::copy(buffer.begin(), buffer.end(), ctx.out());
|
|
|
|
}
|
2017-08-13 20:09:02 +00:00
|
|
|
};
|
2020-05-10 14:25:42 +00:00
|
|
|
} // namespace detail
|
2019-01-21 15:11:49 +00:00
|
|
|
|
2021-04-16 18:04:55 +00:00
|
|
|
FMT_MODULE_EXPORT
|
2018-04-26 18:32:14 +00:00
|
|
|
template <typename Char>
|
2019-06-01 19:32:24 +00:00
|
|
|
void vprint(std::basic_ostream<Char>& os, basic_string_view<Char> format_str,
|
2020-01-15 19:42:59 +00:00
|
|
|
basic_format_args<buffer_context<type_identity_t<Char>>> args) {
|
2021-09-03 16:33:24 +00:00
|
|
|
auto buffer = basic_memory_buffer<Char>();
|
2020-05-10 14:25:42 +00:00
|
|
|
detail::vformat_to(buffer, format_str, args);
|
2020-06-08 14:23:18 +00:00
|
|
|
detail::write_buffer(os, buffer);
|
2017-12-17 17:33:12 +00:00
|
|
|
}
|
2019-06-01 19:32:24 +00:00
|
|
|
|
2016-05-06 14:37:20 +00:00
|
|
|
/**
|
|
|
|
\rst
|
|
|
|
Prints formatted data to the stream *os*.
|
|
|
|
|
|
|
|
**Example**::
|
|
|
|
|
2018-03-04 16:13:08 +00:00
|
|
|
fmt::print(cerr, "Don't {}!", "panic");
|
2016-05-06 14:37:20 +00:00
|
|
|
\endrst
|
|
|
|
*/
|
2021-04-16 18:04:55 +00:00
|
|
|
FMT_MODULE_EXPORT
|
2019-03-16 19:58:18 +00:00
|
|
|
template <typename S, typename... Args,
|
2020-05-10 14:25:42 +00:00
|
|
|
typename Char = enable_if_t<detail::is_string<S>::value, char_t<S>>>
|
2019-07-09 18:50:16 +00:00
|
|
|
void print(std::basic_ostream<Char>& os, const S& format_str, Args&&... args) {
|
2019-02-11 00:59:58 +00:00
|
|
|
vprint(os, to_string_view(format_str),
|
2020-07-19 17:21:15 +00:00
|
|
|
fmt::make_args_checked<Args...>(format_str, args...));
|
2018-04-26 18:32:14 +00:00
|
|
|
}
|
2018-05-12 15:33:51 +00:00
|
|
|
FMT_END_NAMESPACE
|
2016-05-06 14:37:20 +00:00
|
|
|
|
|
|
|
#endif // FMT_OSTREAM_H_
|