Skip to content

Commit

Permalink
Add color format_to overloads
Browse files Browse the repository at this point in the history 
* Fix variable size basic_memory_buffer colorization
* Fix an unused arguments warning on GCC that blocks the CI otherwise
* Ref fmtlib#1842
* Ref fmtlib#1593
  • Loading branch information
@Naios
Naios committed Sep 1, 2020
1 parent e66ba16 commit 840b114
Show file tree
Hide file tree
Showing 3 changed files with 161 additions and 3 deletions.
49 changes: 47 additions & 2 deletions include/fmt/color.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -463,14 +463,14 @@ template <> inline void reset_color<wchar_t>(FILE* stream) FMT_NOEXCEPT {
}

template <typename Char>
inline void reset_color(basic_memory_buffer<Char>& buffer) FMT_NOEXCEPT {
inline void reset_color(buffer<Char>& buffer) FMT_NOEXCEPT {
const char* begin = data::reset_color;
const char* end = begin + sizeof(data::reset_color) - 1;
buffer.append(begin, end);
}

template <typename Char>
void vformat_to(basic_memory_buffer<Char>& buf, const text_style& ts,
void vformat_to(buffer<Char>& buf, const text_style& ts,
basic_string_view<Char> format_str,
basic_format_args<buffer_context<Char>> args) {
bool has_style = false;
Expand Down Expand Up @@ -563,6 +563,51 @@ inline std::basic_string<Char> format(const text_style& ts, const S& format_str,
fmt::make_args_checked<Args...>(format_str, args...));
}

/** Formats a string with the given text_style and writes the output to ``out``.
*/
template <typename OutputIt, typename S, typename Char = char_t<S>,
FMT_ENABLE_IF(detail::is_output_iterator<OutputIt>::value)>
OutputIt vformat_to(
OutputIt out, const text_style& ts, const S& format_str,
basic_format_args<buffer_context<type_identity_t<Char>>> args) {
decltype(detail::get_buffer<Char>(out)) buf(detail::get_buffer_init(out));
detail::vformat_to(buf, ts, to_string_view(format_str), args);
return detail::get_iterator(buf);
}

/**
\rst
Formats arguments with the given text_style, writes the result to the output
iterator ``out`` and returns the iterator past the end of the output range.
**Example**::
std::vector<char> out;
fmt::format_to(std::back_inserter(out),
fmt::emphasis::bold | fg(fmt::color::red), "{}", 42);
\endrst
*/
template <typename OutputIt, typename S, typename... Args,
FMT_ENABLE_IF(detail::is_output_iterator<OutputIt>::value&&
detail::is_string<S>::value)>
inline OutputIt format_to(OutputIt out, const text_style& ts, const S& format_str,
Args&&... args) {
basic_format_args<buffer_context<type_identity_t<char_t<S>>>> store =
fmt::make_args_checked<Args...>(format_str, args...);
return vformat_to(out, ts, to_string_view(format_str), store);
}

template <typename S, typename... Args, size_t SIZE = inline_buffer_size,
typename Char = enable_if_t<detail::is_string<S>::value, char_t<S>>>
inline typename buffer_context<Char>::iterator format_to(
basic_memory_buffer<Char, SIZE>& buf, const text_style& ts,
const S& format_str, Args&&... args) {
basic_format_args<buffer_context<type_identity_t<Char>>> store =
fmt::make_args_checked<Args...>(format_str, args...);
detail::vformat_to(buf, ts, to_string_view(format_str), store);
return detail::buffer_appender<Char>(buf);
}

FMT_END_NAMESPACE

#endif // FMT_COLOR_H_
107 changes: 107 additions & 0 deletions test/color-test.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@

#include "fmt/color.h"

#include <iterator>
#include <string>
#include <utility>

#include "gtest-extra.h"

TEST(ColorsTest, ColorsPrint) {
Expand Down Expand Up @@ -84,3 +88,106 @@ TEST(ColorsTest, Format) {
EXPECT_EQ(fmt::format(fg(fmt::terminal_color::red), "{}", "foo"),
"\x1b[31mfoo\x1b[0m");
}

template <
typename S, typename... Args,
typename String = std::basic_string<fmt::char_t<fmt::remove_cvref_t<S>>>>
String format_to_out_helper(const fmt::text_style& ts, S&& format_str,
Args&&... args) {
String out;
fmt::format_to(std::back_inserter(out), ts, std::forward<S>(format_str),
std::forward<Args>(args)...);

return out;
}

TEST(ColorsTest, FormatToOut) {
EXPECT_EQ(format_to_out_helper(fg(fmt::rgb(255, 20, 30)), "rgb(255,20,30)"),
"\x1b[38;2;255;020;030mrgb(255,20,30)\x1b[0m");
EXPECT_EQ(
format_to_out_helper(fg(fmt::rgb(255, 20, 30)), L"rgb(255,20,30) wide"),
L"\x1b[38;2;255;020;030mrgb(255,20,30) wide\x1b[0m");
EXPECT_EQ(format_to_out_helper(fg(fmt::color::blue), "blue"),
"\x1b[38;2;000;000;255mblue\x1b[0m");
EXPECT_EQ(format_to_out_helper(fg(fmt::color::blue) | bg(fmt::color::red),
"two color"),
"\x1b[38;2;000;000;255m\x1b[48;2;255;000;000mtwo color\x1b[0m");
EXPECT_EQ(format_to_out_helper(fmt::emphasis::bold, "bold"),
"\x1b[1mbold\x1b[0m");
EXPECT_EQ(format_to_out_helper(fmt::emphasis::italic, "italic"),
"\x1b[3mitalic\x1b[0m");
EXPECT_EQ(format_to_out_helper(fmt::emphasis::underline, "underline"),
"\x1b[4munderline\x1b[0m");
EXPECT_EQ(format_to_out_helper(fmt::emphasis::strikethrough, "strikethrough"),
"\x1b[9mstrikethrough\x1b[0m");
EXPECT_EQ(format_to_out_helper(fg(fmt::color::blue) | fmt::emphasis::bold,
"blue/bold"),
"\x1b[1m\x1b[38;2;000;000;255mblue/bold\x1b[0m");
EXPECT_EQ(format_to_out_helper(fmt::emphasis::bold, "bold error"),
"\x1b[1mbold error\x1b[0m");
EXPECT_EQ(format_to_out_helper(fg(fmt::color::blue), "blue log"),
"\x1b[38;2;000;000;255mblue log\x1b[0m");
EXPECT_EQ(format_to_out_helper(fmt::text_style(), "hi"), "hi");
EXPECT_EQ(format_to_out_helper(fg(fmt::terminal_color::red), "tred"),
"\x1b[31mtred\x1b[0m");
EXPECT_EQ(format_to_out_helper(bg(fmt::terminal_color::cyan), "tcyan"),
"\x1b[46mtcyan\x1b[0m");
EXPECT_EQ(
format_to_out_helper(fg(fmt::terminal_color::bright_green), "tbgreen"),
"\x1b[92mtbgreen\x1b[0m");
EXPECT_EQ(format_to_out_helper(bg(fmt::terminal_color::bright_magenta),
"tbmagenta"),
"\x1b[105mtbmagenta\x1b[0m");
EXPECT_EQ(format_to_out_helper(fg(fmt::terminal_color::red), "{}", "foo"),
"\x1b[31mfoo\x1b[0m");
}

template <
typename S, typename... Args,
typename String = std::basic_string<fmt::char_t<fmt::remove_cvref_t<S>>>>
String format_to_helper(const fmt::text_style& ts, S&& format_str,
Args&&... args) {
fmt::basic_memory_buffer<fmt::char_t<fmt::remove_cvref_t<S>>> out;
fmt::format_to(out, ts, std::forward<S>(format_str),
std::forward<Args>(args)...);
return String(out.data(), out.data() + out.size());
}

TEST(ColorsTest, FormatTo) {
EXPECT_EQ(format_to_helper(fg(fmt::rgb(255, 20, 30)), "rgb(255,20,30)"),
"\x1b[38;2;255;020;030mrgb(255,20,30)\x1b[0m");
EXPECT_EQ(format_to_helper(fg(fmt::rgb(255, 20, 30)), L"rgb(255,20,30) wide"),
L"\x1b[38;2;255;020;030mrgb(255,20,30) wide\x1b[0m");
EXPECT_EQ(format_to_helper(fg(fmt::color::blue), "blue"),
"\x1b[38;2;000;000;255mblue\x1b[0m");
EXPECT_EQ(
format_to_helper(fg(fmt::color::blue) | bg(fmt::color::red), "two color"),
"\x1b[38;2;000;000;255m\x1b[48;2;255;000;000mtwo color\x1b[0m");
EXPECT_EQ(format_to_helper(fmt::emphasis::bold, "bold"),
"\x1b[1mbold\x1b[0m");
EXPECT_EQ(format_to_helper(fmt::emphasis::italic, "italic"),
"\x1b[3mitalic\x1b[0m");
EXPECT_EQ(format_to_helper(fmt::emphasis::underline, "underline"),
"\x1b[4munderline\x1b[0m");
EXPECT_EQ(format_to_helper(fmt::emphasis::strikethrough, "strikethrough"),
"\x1b[9mstrikethrough\x1b[0m");
EXPECT_EQ(
format_to_helper(fg(fmt::color::blue) | fmt::emphasis::bold, "blue/bold"),
"\x1b[1m\x1b[38;2;000;000;255mblue/bold\x1b[0m");
EXPECT_EQ(format_to_helper(fmt::emphasis::bold, "bold error"),
"\x1b[1mbold error\x1b[0m");
EXPECT_EQ(format_to_helper(fg(fmt::color::blue), "blue log"),
"\x1b[38;2;000;000;255mblue log\x1b[0m");
EXPECT_EQ(format_to_helper(fmt::text_style(), "hi"), "hi");
EXPECT_EQ(format_to_helper(fg(fmt::terminal_color::red), "tred"),
"\x1b[31mtred\x1b[0m");
EXPECT_EQ(format_to_helper(bg(fmt::terminal_color::cyan), "tcyan"),
"\x1b[46mtcyan\x1b[0m");
EXPECT_EQ(format_to_helper(fg(fmt::terminal_color::bright_green), "tbgreen"),
"\x1b[92mtbgreen\x1b[0m");
EXPECT_EQ(
format_to_helper(bg(fmt::terminal_color::bright_magenta), "tbmagenta"),
"\x1b[105mtbmagenta\x1b[0m");
EXPECT_EQ(format_to_helper(fg(fmt::terminal_color::red), "{}", "foo"),
"\x1b[31mfoo\x1b[0m");
}
8 changes: 7 additions & 1 deletion test/gtest-extra.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,13 @@ std::string read(fmt::file& f, size_t count);
read(file, fmt::string_view(expected_content).size()))

#else
# define EXPECT_WRITE(file, statement, expected_output) SUCCEED()
# define EXPECT_WRITE(file, statement, expected_output) \
do { \
(void)(file); \
(void)(statement); \
(void)(expected_output); \
SUCCEED(); \
} while (false)
#endif // FMT_USE_FCNTL

template <typename Mock> struct ScopedMock : testing::StrictMock<Mock> {
Expand Down

0 comments on commit 840b114

Please sign in to comment.