1
Fork 0
mirror of https://github.com/RGBCube/serenity synced 2025-07-26 08:37:45 +00:00

LogStream: Add a simple-ish mechanism for colorizing and styling output.

Meet TStyle. It allows you to write things like this:

    dbg() << TStyle(TStyle::Red, TStyle::Bold) << "Hello, friends!";

Any style used will be reset along with the newline emitted when the dbg()
temporary goes out of scope. :^)

This can definitely be improved, but I think it's a decent place to start.
This commit is contained in:
Andreas Kling 2019-07-15 20:22:30 +02:00
parent 82d9410226
commit 8075ba5064
2 changed files with 74 additions and 1 deletions

View file

@ -31,4 +31,22 @@ const LogStream& operator<<(const LogStream& stream, const void* value)
return stream << String::format("%p", value); return stream << String::format("%p", value);
} }
const LogStream& operator<<(const LogStream& stream, const TStyle& style)
{
stream << "\033[";
if (style.color() != TStyle::Color::NoColor)
stream << ((int)style.color() + 30) << (style.attributes() ? ";" : "");
else
stream << '0';
if (style.attributes() & TStyle::Attribute::Bold)
stream << '1';
stream << 'm';
stream.m_needs_style_reset = true;
return stream;
}
} }

View file

@ -7,12 +7,63 @@ namespace AK {
class String; class String;
class StringView; class StringView;
class TStyle {
public:
enum NoneTag { DummyValue };
static NoneTag None;
enum Color {
Black = 0,
Red,
Green,
Brown,
Blue,
Magenta,
Cyan,
LightGray,
DarkGray,
BrightRed,
BrightGreen,
Yellow,
BrightBlue,
BrightMagenta,
BrightCyan,
White,
NoColor = 255,
};
enum Attribute {
NoAttribute = 0,
Bold = 1,
};
TStyle() {}
TStyle(NoneTag) {}
TStyle(Color color, unsigned attributes = NoAttribute)
: m_color(color)
, m_attributes(attributes)
{
}
~TStyle() {}
Color color() const { return m_color; }
unsigned attributes() const { return m_attributes; }
private:
Color m_color { NoColor };
unsigned m_attributes { NoAttribute };
};
class LogStream { class LogStream {
public: public:
LogStream() {} LogStream() {}
virtual ~LogStream() {} virtual ~LogStream() {}
virtual void write(const char*, int) const = 0; virtual void write(const char*, int) const = 0;
protected:
friend const LogStream& operator<<(const LogStream&, const TStyle&);
mutable bool m_needs_style_reset { false };
}; };
class DebugLogStream final : public LogStream { class DebugLogStream final : public LogStream {
@ -20,6 +71,8 @@ public:
DebugLogStream() {} DebugLogStream() {}
virtual ~DebugLogStream() override virtual ~DebugLogStream() override
{ {
if (m_needs_style_reset)
write("\033[0m", 4);
char newline = '\n'; char newline = '\n';
write(&newline, 1); write(&newline, 1);
} }
@ -51,6 +104,7 @@ const LogStream& operator<<(const LogStream&, const StringView&);
const LogStream& operator<<(const LogStream&, int); const LogStream& operator<<(const LogStream&, int);
const LogStream& operator<<(const LogStream&, unsigned); const LogStream& operator<<(const LogStream&, unsigned);
const LogStream& operator<<(const LogStream&, const void*); const LogStream& operator<<(const LogStream&, const void*);
const LogStream& operator<<(const LogStream& stream, const TStyle&);
inline const LogStream& operator<<(const LogStream& stream, char value) inline const LogStream& operator<<(const LogStream& stream, char value)
{ {
@ -65,5 +119,6 @@ inline const LogStream& operator<<(const LogStream& stream, bool value)
} }
using AK::LogStream;
using AK::dbg; using AK::dbg;
using AK::LogStream;
using AK::TStyle;