fmt/test/ostream-test.cc

337 lines
10 KiB
C++
Raw Normal View History

2018-03-04 17:16:51 +00:00
// Formatting library for C++ - std::ostream support tests
//
// Copyright (c) 2012 - present, Victor Zverovich
// All rights reserved.
//
// For the license information refer to format.h.
2016-05-06 14:37:20 +00:00
2019-04-20 00:02:31 +00:00
#include "fmt/format.h"
struct test {};
// Test that there is no issues with specializations when fmt/ostream.h is
// included after fmt/format.h.
namespace fmt {
template <> struct formatter<test> : formatter<int> {
template <typename FormatContext>
typename FormatContext::iterator format(const test&, FormatContext& ctx) {
return formatter<int>::format(42, ctx);
}
};
} // namespace fmt
2016-05-06 14:37:20 +00:00
#include <sstream>
2020-05-07 00:15:46 +00:00
#include "fmt/ostream.h"
#include "fmt/ranges.h"
#include "gmock.h"
2016-05-06 14:37:20 +00:00
#include "gtest-extra.h"
#include "util.h"
using fmt::format;
2016-08-25 15:38:07 +00:00
using fmt::format_error;
2016-05-06 14:37:20 +00:00
2019-01-13 02:27:38 +00:00
static std::ostream& operator<<(std::ostream& os, const Date& d) {
2016-05-06 14:37:20 +00:00
os << d.year() << '-' << d.month() << '-' << d.day();
return os;
}
2019-01-13 02:27:38 +00:00
static std::wostream& operator<<(std::wostream& os, const Date& d) {
2016-05-06 14:37:20 +00:00
os << d.year() << L'-' << d.month() << L'-' << d.day();
return os;
}
// Make sure that overloaded comma operators do no harm to is_streamable.
struct type_with_comma_op {};
template <typename T> void operator,(type_with_comma_op, const T&);
template <typename T> type_with_comma_op operator<<(T&, const Date&);
2019-06-07 14:08:04 +00:00
enum streamable_enum {};
static std::ostream& operator<<(std::ostream& os, streamable_enum) {
return os << "streamable_enum";
2016-05-06 14:37:20 +00:00
}
2019-06-07 14:08:04 +00:00
static std::wostream& operator<<(std::wostream& os, streamable_enum) {
return os << L"streamable_enum";
}
2019-06-07 14:08:04 +00:00
enum unstreamable_enum {};
2016-05-06 14:37:20 +00:00
TEST(OStreamTest, Enum) {
2019-06-07 14:08:04 +00:00
EXPECT_EQ("streamable_enum", fmt::format("{}", streamable_enum()));
EXPECT_EQ("0", fmt::format("{}", unstreamable_enum()));
EXPECT_EQ(L"streamable_enum", fmt::format(L"{}", streamable_enum()));
EXPECT_EQ(L"0", fmt::format(L"{}", unstreamable_enum()));
2016-05-06 14:37:20 +00:00
}
2020-05-29 23:51:45 +00:00
struct test_arg_formatter
2020-07-04 13:41:24 +00:00
: fmt::detail::arg_formatter<fmt::format_context::iterator, char> {
2019-02-10 03:34:42 +00:00
fmt::format_parse_context parse_ctx;
2019-01-13 02:27:38 +00:00
test_arg_formatter(fmt::format_context& ctx, fmt::format_specs& s)
2020-07-04 13:41:24 +00:00
: fmt::detail::arg_formatter<fmt::format_context::iterator, char>(
2020-05-29 23:51:45 +00:00
ctx, &parse_ctx, &s),
parse_ctx("") {}
2016-05-06 14:37:20 +00:00
};
TEST(OStreamTest, CustomArg) {
fmt::memory_buffer buffer;
2020-07-09 16:04:46 +00:00
fmt::format_context ctx(fmt::detail::buffer_appender<char>{buffer},
fmt::format_args());
2017-01-28 12:51:35 +00:00
fmt::format_specs spec;
2018-01-15 16:22:31 +00:00
test_arg_formatter af(ctx, spec);
fmt::visit_format_arg(
2020-05-10 14:25:42 +00:00
af, fmt::detail::make_arg<fmt::format_context>(streamable_enum()));
2019-06-07 14:08:04 +00:00
EXPECT_EQ("streamable_enum", std::string(buffer.data(), buffer.size()));
2016-05-06 14:37:20 +00:00
}
TEST(OStreamTest, Format) {
EXPECT_EQ("a string", format("{0}", TestString("a string")));
std::string s = format("The date is {0}", Date(2012, 12, 9));
EXPECT_EQ("The date is 2012-12-9", s);
Date date(2012, 12, 9);
EXPECT_EQ(L"The date is 2012-12-9",
format(L"The date is {0}", Date(2012, 12, 9)));
}
TEST(OStreamTest, FormatSpecs) {
EXPECT_EQ("def ", format("{0:<5}", TestString("def")));
EXPECT_EQ(" def", format("{0:>5}", TestString("def")));
#if FMT_DEPRECATED_NUMERIC_ALIGN
EXPECT_THROW_MSG(format(+"{0:=5}", TestString("def")), format_error,
2019-01-13 02:27:38 +00:00
"format specifier requires numeric argument");
2019-09-06 14:12:35 +00:00
#endif
2016-05-06 14:37:20 +00:00
EXPECT_EQ(" def ", format("{0:^5}", TestString("def")));
EXPECT_EQ("def**", format("{0:*<5}", TestString("def")));
EXPECT_THROW_MSG(format(+"{0:+}", TestString()), format_error,
2019-01-13 02:27:38 +00:00
"format specifier requires numeric argument");
EXPECT_THROW_MSG(format(+"{0:-}", TestString()), format_error,
2019-01-13 02:27:38 +00:00
"format specifier requires numeric argument");
EXPECT_THROW_MSG(format(+"{0: }", TestString()), format_error,
2019-01-13 02:27:38 +00:00
"format specifier requires numeric argument");
EXPECT_THROW_MSG(format(+"{0:#}", TestString()), format_error,
2019-01-13 02:27:38 +00:00
"format specifier requires numeric argument");
EXPECT_THROW_MSG(format(+"{0:05}", TestString()), format_error,
2019-01-13 02:27:38 +00:00
"format specifier requires numeric argument");
2016-05-06 14:37:20 +00:00
EXPECT_EQ("test ", format("{0:13}", TestString("test")));
EXPECT_EQ("test ", format("{0:{1}}", TestString("test"), 13));
EXPECT_EQ("te", format("{0:.2}", TestString("test")));
EXPECT_EQ("te", format("{0:.{1}}", TestString("test"), 2));
}
struct EmptyTest {};
2019-01-13 02:27:38 +00:00
static std::ostream& operator<<(std::ostream& os, EmptyTest) {
2016-05-06 14:37:20 +00:00
return os << "";
}
TEST(OStreamTest, EmptyCustomOutput) {
EXPECT_EQ("", fmt::format("{}", EmptyTest()));
}
TEST(OStreamTest, Print) {
std::ostringstream os;
fmt::print(os, "Don't {}!", "panic");
EXPECT_EQ("Don't panic!", os.str());
std::wostringstream wos;
fmt::print(wos, L"Don't {}!", L"panic");
EXPECT_EQ(L"Don't panic!", wos.str());
2016-05-06 14:37:20 +00:00
}
TEST(OStreamTest, WriteToOStream) {
std::ostringstream os;
fmt::memory_buffer buffer;
2019-01-13 02:27:38 +00:00
const char* foo = "foo";
buffer.append(foo, foo + std::strlen(foo));
2020-06-08 14:23:18 +00:00
fmt::detail::write_buffer(os, buffer);
2016-05-06 14:37:20 +00:00
EXPECT_EQ("foo", os.str());
}
TEST(OStreamTest, WriteToOStreamMaxSize) {
2020-05-10 14:25:42 +00:00
size_t max_size = fmt::detail::max_value<size_t>();
std::streamsize max_streamsize = fmt::detail::max_value<std::streamsize>();
if (max_size <= fmt::detail::to_unsigned(max_streamsize)) return;
2016-05-06 14:37:20 +00:00
struct test_buffer final : fmt::detail::buffer<char> {
2020-07-10 14:50:37 +00:00
explicit test_buffer(size_t size)
: fmt::detail::buffer<char>(nullptr, size, size) {}
2020-05-07 22:59:46 +00:00
void grow(size_t) {}
} buffer(max_size);
2016-05-06 14:37:20 +00:00
2018-01-14 20:25:03 +00:00
struct mock_streambuf : std::streambuf {
2019-01-13 02:27:38 +00:00
MOCK_METHOD2(xsputn, std::streamsize(const void* s, std::streamsize n));
std::streamsize xsputn(const char* s, std::streamsize n) {
const void* v = s;
2016-05-06 14:37:20 +00:00
return xsputn(v, n);
}
} streambuf;
2016-05-06 14:37:20 +00:00
2018-01-14 20:25:03 +00:00
struct test_ostream : std::ostream {
explicit test_ostream(mock_streambuf& output_buffer)
: std::ostream(&output_buffer) {}
} os(streambuf);
2016-05-06 14:37:20 +00:00
testing::InSequence sequence;
const char* data = nullptr;
2018-12-05 15:11:06 +00:00
typedef std::make_unsigned<std::streamsize>::type ustreamsize;
ustreamsize size = max_size;
2016-05-06 14:37:20 +00:00
do {
2020-05-10 14:25:42 +00:00
auto n = std::min(size, fmt::detail::to_unsigned(max_streamsize));
EXPECT_CALL(streambuf, xsputn(data, static_cast<std::streamsize>(n)))
2016-05-06 14:37:20 +00:00
.WillOnce(testing::Return(max_streamsize));
data += n;
2019-02-03 01:24:07 +00:00
size -= n;
2016-05-06 14:37:20 +00:00
} while (size != 0);
2020-06-08 14:23:18 +00:00
fmt::detail::write_buffer(os, buffer);
2016-05-06 14:37:20 +00:00
}
TEST(OStreamTest, Join) {
int v[3] = {1, 2, 3};
EXPECT_EQ("1, 2, 3", fmt::format("{}", fmt::join(v, v + 3, ", ")));
}
TEST(OStreamTest, JoinFallbackFormatter) {
auto strs = std::vector<TestString>{TestString("foo"), TestString("bar")};
EXPECT_EQ("foo, bar", fmt::format("{}", fmt::join(strs, ", ")));
}
2018-07-04 20:17:03 +00:00
#if FMT_USE_CONSTEXPR
TEST(OStreamTest, ConstexprString) {
2019-11-19 18:20:31 +00:00
EXPECT_EQ("42", format(FMT_STRING("{}"), std::string("42")));
EXPECT_EQ("a string", format(FMT_STRING("{0}"), TestString("a string")));
}
2018-07-04 20:17:03 +00:00
#endif
namespace fmt_test {
struct ABC {};
2019-01-13 02:27:38 +00:00
template <typename Output> Output& operator<<(Output& out, ABC) {
out << "ABC";
return out;
}
2019-01-13 02:27:38 +00:00
} // namespace fmt_test
template <typename T> struct TestTemplate {};
template <typename T>
std::ostream& operator<<(std::ostream& os, TestTemplate<T>) {
return os << 1;
}
namespace fmt {
template <typename T> struct formatter<TestTemplate<T>> : formatter<int> {
template <typename FormatContext>
typename FormatContext::iterator format(TestTemplate<T>, FormatContext& ctx) {
return formatter<int>::format(2, ctx);
}
};
} // namespace fmt
#if !FMT_GCC_VERSION || FMT_GCC_VERSION >= 407
TEST(OStreamTest, Template) {
EXPECT_EQ("2", fmt::format("{}", TestTemplate<int>()));
}
TEST(FormatTest, FormatToN) {
char buffer[4];
buffer[3] = 'x';
auto result = fmt::format_to_n(buffer, 3, "{}", fmt_test::ABC());
EXPECT_EQ(3u, result.size);
EXPECT_EQ(buffer + 3, result.out);
EXPECT_EQ("ABCx", fmt::string_view(buffer, 4));
result = fmt::format_to_n(buffer, 3, "x{}y", fmt_test::ABC());
EXPECT_EQ(5u, result.size);
EXPECT_EQ(buffer + 3, result.out);
EXPECT_EQ("xABx", fmt::string_view(buffer, 4));
}
#endif
#if FMT_USE_USER_DEFINED_LITERALS
TEST(FormatTest, UDL) {
using namespace fmt::literals;
EXPECT_EQ("{}"_format("test"), "test");
}
#endif
template <typename T> struct convertible {
T value;
explicit convertible(const T& val) : value(val) {}
operator T() const { return value; }
};
2019-09-24 03:34:08 +00:00
TEST(OStreamTest, DisableBuiltinOStreamOperators) {
EXPECT_EQ("42", fmt::format("{:d}", convertible<unsigned short>(42)));
EXPECT_EQ(L"42", fmt::format(L"{:d}", convertible<unsigned short>(42)));
EXPECT_EQ("foo", fmt::format("{}", convertible<const char*>("foo")));
}
struct explicitly_convertible_to_string_like {
template <typename String,
typename = typename std::enable_if<std::is_constructible<
2020-05-07 22:59:46 +00:00
String, const char*, size_t>::value>::type>
explicit operator String() const {
return String("foo", 3u);
}
};
std::ostream& operator<<(std::ostream& os,
explicitly_convertible_to_string_like) {
return os << "bar";
}
2020-05-07 00:15:46 +00:00
TEST(OStreamTest, FormatExplicitlyConvertibleToStringLike) {
EXPECT_EQ("bar", fmt::format("{}", explicitly_convertible_to_string_like()));
2019-11-27 19:06:40 +00:00
}
#ifdef FMT_USE_STRING_VIEW
struct explicitly_convertible_to_std_string_view {
2020-05-10 14:25:42 +00:00
explicit operator fmt::detail::std_string_view<char>() const {
return {"foo", 3u};
}
};
std::ostream& operator<<(std::ostream& os,
explicitly_convertible_to_std_string_view) {
return os << "bar";
}
2020-05-07 00:15:46 +00:00
TEST(OStreamTest, FormatExplicitlyConvertibleToStdStringView) {
EXPECT_EQ("bar", fmt::format("{}", explicitly_convertible_to_string_like()));
}
#endif // FMT_USE_STRING_VIEW
2020-05-07 00:15:46 +00:00
struct streamable_and_convertible_to_bool {
operator bool() const { return true; }
};
std::ostream& operator<<(std::ostream& os, streamable_and_convertible_to_bool) {
return os << "foo";
}
TEST(OStreamTest, FormatConvertibleToBool) {
EXPECT_EQ("foo", fmt::format("{}", streamable_and_convertible_to_bool()));
}
2020-05-07 00:15:46 +00:00
struct copyfmt_test {};
std::ostream& operator<<(std::ostream& os, copyfmt_test) {
std::ios ios(nullptr);
ios.copyfmt(os);
return os << "foo";
}
TEST(OStreamTest, CopyFmt) {
EXPECT_EQ("foo", fmt::format("{}", copyfmt_test()));
}
TEST(OStreamTest, CompileTimeString) {
EXPECT_EQ("42", fmt::format(FMT_STRING("{}"), 42));
}
TEST(OStreamTest, ToString) {
EXPECT_EQ("ABC", fmt::to_string(fmt_test::ABC()));
}
TEST(OStreamTest, Range) {
auto strs = std::vector<TestString>{TestString("foo"), TestString("bar")};
EXPECT_EQ("{foo, bar}", format("{}", strs));
2020-11-22 00:52:40 +00:00
}