Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support character range formatting #3863

Merged
merged 9 commits into from
Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 58 additions & 6 deletions include/fmt/ranges.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
#include <tuple>
#include <type_traits>

#include "base.h"
#include "format.h"

FMT_BEGIN_NAMESPACE

Expand Down Expand Up @@ -388,6 +388,8 @@ struct range_formatter<
detail::string_literal<Char, '['>{};
basic_string_view<Char> closing_bracket_ =
detail::string_literal<Char, ']'>{};
bool is_string_format = false;
bool is_debug = false;

public:
FMT_CONSTEXPR range_formatter() {}
Expand All @@ -414,29 +416,79 @@ struct range_formatter<
if (it != end && *it == 'n') {
js324 marked this conversation as resolved.
Show resolved Hide resolved
set_brackets({}, {});
++it;
} else {
vitaut marked this conversation as resolved.
Show resolved Hide resolved
bool check_for_s = false;
if (it != end && *it == '?') {
++it;
detail::maybe_set_debug_format(underlying_, true);
set_brackets({}, {});
check_for_s = true;
is_debug = true;
}
if (it != end && *it == 's') {
if (!std::is_same<T, Char>::value) {
report_error("invalid format specifier");
}
if (!is_debug) {
set_brackets(detail::string_literal<Char, '"'>{},
detail::string_literal<Char, '"'>{});
}
check_for_s = false;
is_string_format = true;
++it;
}
if (check_for_s) {
report_error("invalid format specifier");
}
vitaut marked this conversation as resolved.
Show resolved Hide resolved
}

if (it != end && *it != '}') {
if (*it != ':') report_error("invalid format specifier");
if (is_string_format || *it != ':')
js324 marked this conversation as resolved.
Show resolved Hide resolved
report_error("invalid format specifier");
++it;
} else {
detail::maybe_set_debug_format(underlying_, true);
if (!is_string_format) detail::maybe_set_debug_format(underlying_, true);
js324 marked this conversation as resolved.
Show resolved Hide resolved
}

ctx.advance_to(it);
return underlying_.parse(ctx);
}

template <typename Output, typename Iter, typename IterEnd, typename U = T,
enable_if_t<std::is_same<U, Char>::value, bool> = true>
auto write_debug_string(Output& out, Iter& it, IterEnd& end) const -> Output {
auto buf = basic_memory_buffer<Char>();
for (; it != end; ++it) {
auto&& item = *it;
buf.push_back(item);
js324 marked this conversation as resolved.
Show resolved Hide resolved
}
format_specs spec_str{};
js324 marked this conversation as resolved.
Show resolved Hide resolved
spec_str.type = presentation_type::debug;
return detail::write<Char>(
out, basic_string_view<Char>(buf.data(), buf.size()), spec_str);
}
template <typename Output, typename Iter, typename IterEnd, typename U = T,
enable_if_t<!(std::is_same<U, Char>::value), bool> = true>
js324 marked this conversation as resolved.
Show resolved Hide resolved
auto write_debug_string(Output& out, Iter& it, IterEnd& end) const -> Output {
detail::ignore_unused(it);
detail::ignore_unused(end);
js324 marked this conversation as resolved.
Show resolved Hide resolved
return out;
}

template <typename R, typename FormatContext>
auto format(R&& range, FormatContext& ctx) const -> decltype(ctx.out()) {
detail::range_mapper<buffered_context<Char>> mapper;
auto out = ctx.out();
out = detail::copy<Char>(opening_bracket_, out);
int i = 0;
auto it = detail::range_begin(range);
auto end = detail::range_end(range);
if (is_string_format && is_debug) {
js324 marked this conversation as resolved.
Show resolved Hide resolved
return write_debug_string(out, it, end);
}

out = detail::copy<Char>(opening_bracket_, out);
int i = 0;
for (; it != end; ++it) {
if (i > 0) out = detail::copy<Char>(separator_, out);
if (i > 0 && !is_string_format) out = detail::copy<Char>(separator_, out);
js324 marked this conversation as resolved.
Show resolved Hide resolved
ctx.advance_to(out);
auto&& item = *it;
out = underlying_.format(mapper.map(item), ctx);
Expand Down
5 changes: 5 additions & 0 deletions test/ranges-test.cc
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,13 @@ TEST(ranges_test, format_vector) {
EXPECT_EQ(fmt::format("{:n:#x}", v), "0x1, 0x2, 0x3, 0x5, 0x7, 0xb");

auto vc = std::vector<char>{'a', 'b', 'c'};
auto vec = std::vector<char>{'a', '\n', '\t'};
auto vvc = std::vector<std::vector<char>>{vc, vc};
EXPECT_EQ(fmt::format("{}", vc), "['a', 'b', 'c']");
EXPECT_EQ(fmt::format("{:s}", vc), "\"abc\"");
EXPECT_EQ(fmt::format("{:?s}", vec), "\"a\\n\\t\"");
EXPECT_EQ(fmt::format("{:s}", vec), "\"a\n\t\"");
EXPECT_EQ(fmt::format("{::s}", vvc), "[\"abc\", \"abc\"]");
EXPECT_EQ(fmt::format("{}", vvc), "[['a', 'b', 'c'], ['a', 'b', 'c']]");
EXPECT_EQ(fmt::format("{:n}", vvc), "['a', 'b', 'c'], ['a', 'b', 'c']");
EXPECT_EQ(fmt::format("{:n:n}", vvc), "'a', 'b', 'c', 'a', 'b', 'c'");
Expand Down
Loading