Implement styled arguments

include/fmt/color.h

@@ -492,6 +492,14 @@ template <typename Char> inline void reset_color(buffer<Char>& buffer) {
   buffer.append(reset_color.begin(), reset_color.end());
 }
 
+template <typename Arg> struct styled_arg {
+  FMT_CONSTEXPR styled_arg(Arg const& format_argument, text_style format_style)
+      : argument(format_argument), style(format_style) {}
+
+  const Arg& argument;
+  text_style style;
+};
+
 template <typename Char>
 void vformat_to(buffer<Char>& buf, const text_style& ts,
                 basic_string_view<Char> format_str,
@@ -630,6 +638,91 @@ inline auto format_to(OutputIt out, const text_style& ts, const S& format_str,
                     fmt::make_format_args<buffer_context<char_t<S>>>(args...));
 }
 
+template <typename Arg, typename Char>
+struct formatter<detail::styled_arg<Arg>, Char> : formatter<Arg, Char> {
+  template <typename FormatContext>
+  auto format(detail::styled_arg<Arg> const& arg, FormatContext& ctx) const
+      -> decltype(ctx.out()) {
+    auto const& ts = arg.style;
+    auto const& value = arg.argument;
+    auto out = ctx.out();
+
+    using detail::get_buffer;
+    auto&& buf = get_buffer<Char>(out);
+
+    bool has_style = false;
+    if (ts.has_emphasis()) {
+      has_style = true;
+      auto emphasis = detail::make_emphasis<Char>(ts.get_emphasis());
+      buf.append(emphasis.begin(), emphasis.end());
+    }
+    if (ts.has_foreground()) {
+      has_style = true;
+      auto foreground =
+          detail::make_foreground_color<Char>(ts.get_foreground());
+      buf.append(foreground.begin(), foreground.end());
+    }
+    if (ts.has_background()) {
+      has_style = true;
+      auto background =
+          detail::make_background_color<Char>(ts.get_background());
+      buf.append(background.begin(), background.end());
+    }
+    out = formatter<Arg, Char>::format(value, ctx);
+    if (has_style) detail::reset_color<Char>(buf);
+    return out;
+  }
+};
+
+/**
+  \rst
+  Returns an argument that will be formatted using ANSI escape sequences,
+  to be used in a formatting function.
+
+  **Example**::
+
+    fmt::print("Elapsed time: {s:.2f} seconds",
+               fmt::styled(1.23, fmt::fg(fmt::colors::green) |
+  fmt::bg(fmt::color::blue))); \endrst
+ */
+template <typename Arg>
+FMT_CONSTEXPR auto styled(const Arg& arg, text_style ts = {})
+    -> detail::styled_arg<remove_cvref_t<Arg>> {
+  return detail::styled_arg<remove_cvref_t<Arg>>(arg, ts);
+}
+
+/**
+  \rst
+  Returns an argument surrounded by the ANSI escape sequences of the color,
+  to be used in a formatting function.
+
+  **Example**::
+
+    fmt::print("Elapsed time: {s:.2f} seconds", fmt::styled(1.23,
+  fmt::colors::green)); \endrst
+ */
+template <typename Arg>
+FMT_CONSTEXPR auto styled(const Arg& arg, detail::color_type color)
+    -> detail::styled_arg<remove_cvref_t<Arg>> {
+  return detail::styled_arg<remove_cvref_t<Arg>>(arg, fg(color));
+}
+
+/**
+  \rst
+  Returns an argument associated with an emphasis, to be used
+  in a formatting function.
+
+  **Example**::
+
+    fmt::print("Elapsed time: {s:.2f} seconds", fmt::styled(1.23,
+  fmt::emphasis::italic)); \endrst
+ */
+template <typename Arg>
+FMT_CONSTEXPR auto styled(const Arg& arg, emphasis em)
+    -> detail::styled_arg<remove_cvref_t<Arg>> {
+  return detail::styled_arg<remove_cvref_t<Arg>>(arg, text_style(em));
+}
+
 FMT_MODULE_EXPORT_END
 FMT_END_NAMESPACE
 

test/color-test.cc

@@ -50,6 +50,12 @@ TEST(color_test, format) {
             "\x1b[105mtbmagenta\x1b[0m");
   EXPECT_EQ(fmt::format(fg(fmt::terminal_color::red), "{}", "foo"),
             "\x1b[31mfoo\x1b[0m");
+  EXPECT_EQ(fmt::format("{}{}", fmt::styled("red", fmt::color::red),
+                        fmt::styled("bold", fmt::emphasis::bold)),
+            "\x1b[38;2;255;000;000mred\x1b[0m\x1b[1mbold\x1b[0m");
+  EXPECT_EQ(fmt::format("{}", fmt::styled("bar", fg(fmt::color::blue) |
+                                                     fmt::emphasis::underline)),
+            "\x1b[4m\x1b[38;2;000;000;255mbar\x1b[0m");
 }
 
 TEST(color_test, format_to) {