From c2fecb9b2ae6a0f75d50d481135d8ff7ec5800e4 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Sun, 14 Jan 2018 14:15:59 -0800 Subject: [PATCH] Clean API --- include/fmt/core.h | 56 ++++++++++++++++++++++++----------- include/fmt/format.cc | 6 ++-- include/fmt/format.h | 52 +++++++++++--------------------- include/fmt/printf.h | 19 +++++++----- include/fmt/time.h | 2 +- test/custom-formatter-test.cc | 5 ++-- test/format-test.cc | 32 ++++++-------------- test/ostream-test.cc | 12 ++++---- test/util-test.cc | 2 +- 9 files changed, 91 insertions(+), 95 deletions(-) diff --git a/include/fmt/core.h b/include/fmt/core.h index 350ce0fa..312de478 100644 --- a/include/fmt/core.h +++ b/include/fmt/core.h @@ -11,6 +11,7 @@ #include #include #include +#include #include #include @@ -265,6 +266,25 @@ class basic_buffer { const T &operator[](std::size_t index) const { return ptr_[index]; } }; +using buffer = internal::basic_buffer; +using wbuffer = internal::basic_buffer; + +template +class container_buffer + : public internal::basic_buffer { + private: + Container &container_; + + protected: + virtual void grow(std::size_t capacity) { + container_.resize(capacity); + this->set(&container_[0], capacity); + } + + public: + explicit container_buffer(Container &c) : container_(c) {} +}; + // A helper function to suppress bogus "conditional expression is constant" // warnings. template @@ -875,11 +895,8 @@ class basic_context : format_arg get_arg(basic_string_view name); }; -using buffer = internal::basic_buffer; -using wbuffer = internal::basic_buffer; - -using context = basic_context>; -using wcontext = basic_context>; +using context = basic_context>; +using wcontext = basic_context>; template class arg_store { @@ -1060,19 +1077,24 @@ inline void print_colored(Color c, string_view format_str, vprint_colored(c, format_str, make_args(args...)); } -void vformat_to(buffer &buf, string_view format_str, format_args args); -void vformat_to(wbuffer &buf, wstring_view format_str, wformat_args args); +void vformat_to(internal::buffer &buf, string_view format_str, + format_args args); +void vformat_to(internal::wbuffer &buf, wstring_view format_str, + wformat_args args); -template -inline void format_to(buffer &buf, string_view format_str, - const Args & ... args) { - vformat_to(buf, format_str, make_args(args...)); -} - -template -inline void format_to(wbuffer &buf, wstring_view format_str, - const Args & ... args) { - vformat_to(buf, format_str, make_args(args...)); +/** + Formats a string and writes the output to out. + */ +template +void vformat_to(std::back_insert_iterator out, + string_view format_str, format_args args) { + using iterator = std::back_insert_iterator; + struct container_accessor : iterator { + container_accessor(iterator it) : iterator(it) {} + using iterator::container; + } accessor(out); + internal::container_buffer buf(*accessor.container); + vformat_to(buf, format_str, args); } std::string vformat(string_view format_str, format_args args); diff --git a/include/fmt/format.cc b/include/fmt/format.cc index 1eb3a2a9..cc166d83 100644 --- a/include/fmt/format.cc +++ b/include/fmt/format.cc @@ -91,7 +91,7 @@ inline int fmt_snprintf(char *buffer, size_t size, const char *format, ...) { const char RESET_COLOR[] = "\x1b[0m"; -typedef void (*FormatFunc)(buffer &, int, string_view); +typedef void (*FormatFunc)(internal::buffer &, int, string_view); // Portable thread-safe version of strerror. // Sets buffer to point to a string describing the error code. @@ -161,7 +161,7 @@ int safe_strerror( return StrError(error_code, buffer, buffer_size).run(); } -void format_error_code(buffer &out, int error_code, +void format_error_code(internal::buffer &out, int error_code, string_view message) FMT_NOEXCEPT { // Report error code making sure that the output fits into // INLINE_BUFFER_SIZE to avoid dynamic memory allocation and potential @@ -358,7 +358,7 @@ FMT_FUNC void internal::format_windows_error( #endif // FMT_USE_WINDOWS_H FMT_FUNC void format_system_error( - buffer &out, int error_code, string_view message) FMT_NOEXCEPT { + internal::buffer &out, int error_code, string_view message) FMT_NOEXCEPT { FMT_TRY { memory_buffer buf; buf.resize(internal::INLINE_BUFFER_SIZE); diff --git a/include/fmt/format.h b/include/fmt/format.h index fe60d257..fc2d212a 100644 --- a/include/fmt/format.h +++ b/include/fmt/format.h @@ -31,7 +31,6 @@ #include #include #include -#include #include #include #include @@ -307,22 +306,6 @@ void basic_buffer::append(const U *begin, const U *end) { internal::make_ptr(ptr_, capacity_) + size_); size_ = new_size; } - -template -class container_buffer - : public internal::basic_buffer { - private: - Container &container_; - - protected: - virtual void grow(std::size_t capacity) { - container_.resize(capacity); - this->set(&container_[0], capacity); - } - - public: - explicit container_buffer(Container &c) : container_(c) {} -}; } // namespace internal // A wrapper around std::locale used to reduce compile times since @@ -2061,7 +2044,7 @@ class system_error : public std::runtime_error { may look like "Unknown error -1" and is platform-dependent. \endrst */ -FMT_API void format_system_error(fmt::buffer &out, int error_code, +FMT_API void format_system_error(fmt::internal::buffer &out, int error_code, fmt::string_view message) FMT_NOEXCEPT; /** @@ -2582,8 +2565,8 @@ void basic_writer::write_double(T value, const format_specs &spec) { }); } -using writer = basic_writer>; -using wwriter = basic_writer>; +using writer = basic_writer>; +using wwriter = basic_writer>; // Reports a system error without throwing an exception. // Can be used to report errors from destructors. @@ -3019,27 +3002,28 @@ std::basic_string to_string(const basic_memory_buffer &buffer) { return std::basic_string(buffer.data(), buffer.size()); } -inline void vformat_to(buffer &buf, string_view format_str, format_args args) { - using range = internal::dynamic_range; +inline void vformat_to(internal::buffer &buf, string_view format_str, + format_args args) { + using range = internal::dynamic_range; do_vformat_to>(buf, format_str, args); } -inline void vformat_to(wbuffer &buf, wstring_view format_str, +inline void vformat_to(internal::wbuffer &buf, wstring_view format_str, wformat_args args) { - using range = internal::dynamic_range; + using range = internal::dynamic_range; do_vformat_to>(buf, format_str, args); } -template -void vformat_to(std::back_insert_iterator out, - string_view format_str, format_args args) { - using iterator = std::back_insert_iterator; - struct container_extractor : iterator { - container_extractor(iterator it) : iterator(it) {} - using iterator::container; - } extractor(out); - internal::container_buffer buf(*extractor.container); - vformat_to(buf, format_str, args); +template +inline void format_to(memory_buffer &buf, string_view format_str, + const Args & ... args) { + vformat_to(buf, format_str, make_args(args...)); +} + +template +inline void format_to(wmemory_buffer &buf, wstring_view format_str, + const Args & ... args) { + vformat_to(buf, format_str, make_args(args...)); } template diff --git a/include/fmt/printf.h b/include/fmt/printf.h index f3dbaf3e..eefdb7bb 100644 --- a/include/fmt/printf.h +++ b/include/fmt/printf.h @@ -530,7 +530,7 @@ void printf(internal::basic_buffer &buf, basic_string_view format, template using printf_context = basic_printf_context>; -using printf_args = basic_format_args>; +using printf_args = basic_format_args>; inline std::string vsprintf(string_view format, printf_args args) { memory_buffer buffer; @@ -549,11 +549,13 @@ inline std::string vsprintf(string_view format, printf_args args) { */ template inline std::string sprintf(string_view format_str, const Args & ... args) { - return vsprintf(format_str, make_args>(args...)); + return vsprintf(format_str, + make_args>(args...)); } -inline std::wstring vsprintf(wstring_view format, - basic_format_args> args) { +inline std::wstring vsprintf( + wstring_view format, + basic_format_args> args) { wmemory_buffer buffer; printf(buffer, format, args); return to_string(buffer); @@ -561,7 +563,7 @@ inline std::wstring vsprintf(wstring_view format, template inline std::wstring sprintf(wstring_view format_str, const Args & ... args) { - auto vargs = make_args>(args...); + auto vargs = make_args>(args...); return vsprintf(format_str, vargs); } @@ -584,7 +586,7 @@ inline int vfprintf(std::FILE *f, string_view format, printf_args args) { */ template inline int fprintf(std::FILE *f, string_view format_str, const Args & ... args) { - auto vargs = make_args>(args...); + auto vargs = make_args>(args...); return vfprintf(f, format_str, vargs); } @@ -603,7 +605,8 @@ inline int vprintf(string_view format, printf_args args) { */ template inline int printf(string_view format_str, const Args & ... args) { - return vprintf(format_str, make_args>(args...)); + return vprintf(format_str, + make_args>(args...)); } inline int vfprintf(std::ostream &os, string_view format_str, @@ -626,7 +629,7 @@ inline int vfprintf(std::ostream &os, string_view format_str, template inline int fprintf(std::ostream &os, string_view format_str, const Args & ... args) { - auto vargs = make_args>(args...); + auto vargs = make_args>(args...); return vfprintf(os, format_str, vargs); } } // namespace fmt diff --git a/include/fmt/time.h b/include/fmt/time.h index 12d9bd3a..26de2666 100644 --- a/include/fmt/time.h +++ b/include/fmt/time.h @@ -31,7 +31,7 @@ struct formatter { } auto format(const std::tm &tm, context &ctx) -> decltype(ctx.begin()) { - buffer &buf = ctx.range().container(); + internal::buffer &buf = ctx.range().container(); std::size_t start = buf.size(); for (;;) { std::size_t size = buf.capacity() - start; diff --git a/test/custom-formatter-test.cc b/test/custom-formatter-test.cc index ef66b1af..25b7622c 100644 --- a/test/custom-formatter-test.cc +++ b/test/custom-formatter-test.cc @@ -15,9 +15,10 @@ using fmt::printf_arg_formatter; // A custom argument formatter that doesn't print `-` for floating-point values // rounded to 0. class CustomArgFormatter : - public fmt::arg_formatter> { + public fmt::arg_formatter< + fmt::internal::dynamic_range> { public: - using range = fmt::internal::dynamic_range; + using range = fmt::internal::dynamic_range; using base = fmt::arg_formatter; CustomArgFormatter(range r, fmt::basic_context &ctx, diff --git a/test/format-test.cc b/test/format-test.cc index 77d95029..e83c3af8 100644 --- a/test/format-test.cc +++ b/test/format-test.cc @@ -374,20 +374,17 @@ TEST(WriterTest, WWriter) { } TEST(FormatToTest, FormatWithoutArgs) { - fmt::memory_buffer buffer; - format_to(buffer, "test"); - EXPECT_EQ("test", std::string(buffer.data(), buffer.size())); + std::string s; + fmt::format_to(std::back_inserter(s), "test"); + EXPECT_EQ("test", s); } TEST(FormatToTest, Format) { - fmt::memory_buffer buffer; - format_to(buffer, "part{0}", 1); - EXPECT_EQ(strlen("part1"), buffer.size()); - EXPECT_EQ("part1", std::string(buffer.data(), buffer.size())); - format_to(buffer, "part{0}", 2); - EXPECT_EQ(strlen("part1part2"), buffer.size()); - EXPECT_EQ("part1part2", std::string(buffer.data(), buffer.size())); - EXPECT_EQ("part1part2", to_string(buffer)); + std::string s; + fmt::format_to(std::back_inserter(s), "part{0}", 1); + EXPECT_EQ("part1", s); + fmt::format_to(std::back_inserter(s), "part{0}", 2); + EXPECT_EQ("part1part2", s); } TEST(FormatterTest, Escape) { @@ -1484,7 +1481,7 @@ TEST(FormatTest, Enum) { EXPECT_EQ("0", fmt::format("{}", A)); } -using buffer_range = fmt::internal::dynamic_range; +using buffer_range = fmt::internal::dynamic_range; class mock_arg_formatter : public fmt::internal::arg_formatter_base { @@ -1908,17 +1905,6 @@ TEST(FormatTest, FormatStringErrors) { int, int); } -TEST(FormatTest, OutputIterator) { - - std::string s; - fmt::format_to(std::back_inserter(s), "{}", 42); - std::vector v; - fmt::format_to(std::back_inserter(v), "{}", 42); - - EXPECT_EQ("42", s); - EXPECT_EQ("42", std::string(v.begin(), v.end())); -} - TEST(StringTest, ToString) { EXPECT_EQ("42", fmt::to_string(42)); } diff --git a/test/ostream-test.cc b/test/ostream-test.cc index 3f93dbd4..5dca8109 100644 --- a/test/ostream-test.cc +++ b/test/ostream-test.cc @@ -58,10 +58,10 @@ TEST(OStreamTest, Enum) { EXPECT_EQ("0", fmt::format("{}", A)); } -struct TestArgFormatter - : fmt::arg_formatter> { - using base = fmt::arg_formatter>; - TestArgFormatter(fmt::buffer &buf, fmt::context &ctx, fmt::format_specs &s) +struct test_arg_formatter : fmt::arg_formatter { + using base = fmt::arg_formatter; + test_arg_formatter(fmt::internal::buffer &buf, fmt::context &ctx, + fmt::format_specs &s) : base(buf, ctx, s) {} }; @@ -69,7 +69,7 @@ TEST(OStreamTest, CustomArg) { fmt::memory_buffer buffer; fmt::context ctx(buffer, "", fmt::format_args()); fmt::format_specs spec; - TestArgFormatter af(buffer, ctx, spec); + test_arg_formatter af(buffer, ctx, spec); visit(af, fmt::internal::make_arg(TestEnum())); EXPECT_EQ("TestEnum", std::string(buffer.data(), buffer.size())); } @@ -136,7 +136,7 @@ TEST(OStreamTest, WriteToOStreamMaxSize) { if (max_size <= fmt::internal::to_unsigned(max_streamsize)) return; - struct test_buffer : fmt::buffer { + struct test_buffer : fmt::internal::buffer { explicit test_buffer(std::size_t size) { resize(size); } void grow(std::size_t) {} } buffer(max_size); diff --git a/test/util-test.cc b/test/util-test.cc index 42399e78..04f3916e 100644 --- a/test/util-test.cc +++ b/test/util-test.cc @@ -720,7 +720,7 @@ TEST(UtilTest, UTF16ToUTF8Convert) { #endif // _WIN32 typedef void (*FormatErrorMessage)( - fmt::buffer &out, int error_code, string_view message); + fmt::internal::buffer &out, int error_code, string_view message); template void check_throw_error(int error_code, FormatErrorMessage format) {