fmt/include/fmt/ostream.h

142 lines
4.5 KiB
C
Raw Normal View History

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>
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
2016-05-06 14:37:20 +00:00
namespace internal {
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
buffer<Char>& buffer_;
2016-05-06 14:37:20 +00:00
public:
formatbuf(buffer<Char>& buf) : buffer_(buf) {}
2018-01-29 04:08:51 +00:00
protected:
// The put-area is actually 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. The obvious
// 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.
2016-05-06 14:37:20 +00:00
int_type overflow(int_type ch = traits_type::eof()) FMT_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;
}
2019-01-13 02:27:38 +00:00
std::streamsize xsputn(const Char* s, std::streamsize count) FMT_OVERRIDE {
2018-01-29 04:08:51 +00:00
buffer_.append(s, s + count);
return count;
2016-05-06 14:37:20 +00:00
}
};
2019-01-13 02:27:38 +00:00
template <typename Char> struct test_stream : std::basic_ostream<Char> {
private:
// Hide all operator<< from std::basic_ostream<Char>.
void_t<> operator<<(null<>);
void_t<> operator<<(const Char*);
2019-09-24 03:34:08 +00:00
template <typename T, FMT_ENABLE_IF(std::is_convertible<T, int>::value &&
!std::is_enum<T>::value)>
void_t<> operator<<(T);
};
2019-01-13 02:27:38 +00:00
// Checks if T has a user-defined operator<< (e.g. not a member of
// std::ostream).
template <typename T, typename Char> class is_streamable {
private:
template <typename U>
static bool_constant<!std::is_same<decltype(std::declval<test_stream<Char>&>()
<< std::declval<U>()),
void_t<>>::value>
2019-01-13 02:27:38 +00:00
test(int);
2019-01-13 02:27:38 +00:00
template <typename> static std::false_type test(...);
2019-07-07 14:21:20 +00:00
using result = decltype(test<T>(0));
2018-02-28 13:09:24 +00:00
public:
static const bool value = result::value;
};
// Write the content of buf to os.
2017-12-17 17:33:12 +00:00
template <typename Char>
void write(std::basic_ostream<Char>& os, buffer<Char>& buf) {
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;
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);
}
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()) {
2019-07-07 14:21:20 +00:00
formatbuf<Char> format_buf(buf);
std::basic_ostream<Char> output(&format_buf);
2019-11-13 12:08:47 +00:00
if (loc) output.imbue(loc.get<std::locale>());
2018-02-07 15:36:15 +00:00
output.exceptions(std::ios_base::failbit | std::ios_base::badbit);
output << value;
buf.resize(buf.size());
}
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>>
2017-08-13 20:09:02 +00:00
: formatter<basic_string_view<Char>, Char> {
2018-01-06 17:09:50 +00:00
template <typename Context>
2019-01-13 02:27:38 +00:00
auto format(const T& value, Context& ctx) -> decltype(ctx.out()) {
2017-08-13 20:09:02 +00:00
basic_memory_buffer<Char> buffer;
2019-11-13 12:08:47 +00:00
format_value(buffer, value, ctx.locale());
2017-08-13 20:09:02 +00:00
basic_string_view<Char> str(buffer.data(), buffer.size());
return formatter<basic_string_view<Char>, Char>::format(str, ctx);
2017-08-13 20:09:02 +00:00
}
};
} // namespace internal
template <typename Char>
2019-06-01 19:32:24 +00:00
void vprint(std::basic_ostream<Char>& os, basic_string_view<Char> format_str,
2019-06-03 00:13:50 +00:00
basic_format_args<buffer_context<Char>> args) {
basic_memory_buffer<Char> buffer;
internal::vformat_to(buffer, format_str, args);
2017-12-17 17:33:12 +00:00
internal::write(os, buffer);
}
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**::
fmt::print(cerr, "Don't {}!", "panic");
2016-05-06 14:37:20 +00:00
\endrst
*/
2019-03-16 19:58:18 +00:00
template <typename S, typename... Args,
2019-06-01 19:32:24 +00:00
typename Char = enable_if_t<internal::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),
2019-07-09 18:50:16 +00:00
{internal::make_args_checked<Args...>(format_str, args...)});
}
2018-05-12 15:33:51 +00:00
FMT_END_NAMESPACE
2016-05-06 14:37:20 +00:00
#endif // FMT_OSTREAM_H_