External/fmt
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document color

Browse Source
This commit is contained in:
Victor Zverovich 2020-11-08 07:18:01 -08:00
parent 1ac50fcb5a
commit 10ebe6cb48
2 changed files with 18 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api.rst
View File

@ -461,6 +461,10 @@ Terminal color and text style
.. doxygenfunction:: print(const text_style&, const S&, const Args&...) .. doxygenfunction:: print(const text_style&, const S&, const Args&...)
.. doxygenfunction:: fg(detail::color_type)
.. doxygenfunction:: bg(detail::color_type)
.. _ostream-api: .. _ostream-api:
``std::ostream`` Support ``std::ostream`` Support

29
include/fmt/color.h
View File

@ -223,7 +223,7 @@ struct color_type {
}; };
} // namespace detail } // namespace detail
// Experimental text formatting support. /** A text style consisting of foreground and background colors and emphasis. */
class text_style { class text_style {
public: public:
FMT_CONSTEXPR text_style(emphasis em = emphasis()) FMT_NOEXCEPT FMT_CONSTEXPR text_style(emphasis em = emphasis()) FMT_NOEXCEPT
@ -260,7 +260,7 @@ class text_style {
return lhs |= rhs; return lhs |= rhs;
} }
FMT_CONSTEXPR text_style& operator&=(const text_style& rhs) { FMT_DEPRECATED FMT_CONSTEXPR text_style& operator&=(const text_style& rhs) {
if (!set_foreground_color) { if (!set_foreground_color) {
set_foreground_color = rhs.set_foreground_color; set_foreground_color = rhs.set_foreground_color;
foreground_color = rhs.foreground_color; foreground_color = rhs.foreground_color;
@ -284,8 +284,8 @@ class text_style {
return *this; return *this;
} }
friend FMT_CONSTEXPR text_style operator&(text_style lhs, FMT_DEPRECATED friend FMT_CONSTEXPR text_style
const text_style& rhs) { operator&(text_style lhs, const text_style& rhs) {
return lhs &= rhs; return lhs &= rhs;
} }
@ -326,10 +326,17 @@ class text_style {
} }
} }
/** Creates a text style from the foreground (text) color. */
friend FMT_CONSTEXPR_DECL text_style fg(detail::color_type foreground) friend FMT_CONSTEXPR_DECL text_style fg(detail::color_type foreground)
FMT_NOEXCEPT; FMT_NOEXCEPT {
return text_style(true, foreground);
}
/** Creates a text style from the background color. */
friend FMT_CONSTEXPR_DECL text_style bg(detail::color_type background) friend FMT_CONSTEXPR_DECL text_style bg(detail::color_type background)
FMT_NOEXCEPT; FMT_NOEXCEPT {
return text_style(false, background);
}
detail::color_type foreground_color; detail::color_type foreground_color;
detail::color_type background_color; detail::color_type background_color;
@ -338,14 +345,6 @@ class text_style {
emphasis ems; emphasis ems;
}; };
FMT_CONSTEXPR text_style fg(detail::color_type foreground) FMT_NOEXCEPT {
return text_style(/*is_foreground=*/true, foreground);
}
FMT_CONSTEXPR text_style bg(detail::color_type background) FMT_NOEXCEPT {
return text_style(/*is_foreground=*/false, background);
}
FMT_CONSTEXPR text_style operator|(emphasis lhs, emphasis rhs) FMT_NOEXCEPT { FMT_CONSTEXPR text_style operator|(emphasis lhs, emphasis rhs) FMT_NOEXCEPT {
return text_style(lhs) | rhs; return text_style(lhs) | rhs;
} }
@ -527,7 +526,7 @@ void print(std::FILE* f, const text_style& ts, const S& format_str,
Formats a string and prints it to stdout using ANSI escape sequences to Formats a string and prints it to stdout using ANSI escape sequences to
specify text formatting. specify text formatting.
**Example**: **Example**::
fmt::print(fmt::emphasis::bold | fg(fmt::color::red), fmt::print(fmt::emphasis::bold | fg(fmt::color::red),
"Elapsed time: {0:.2f} seconds", 1.23); "Elapsed time: {0:.2f} seconds", 1.23);