Question

我需要一个类来包装对std::clog的调用，以便：

每条消息都有一个标头作为前缀，该标头包括时间和生成消息的实体的名称。
消息根据错误类型（例如调试，警告，错误）着色。
使用它的方式与std::clog << "..."的所有功能完全等效（即具有隐式基本的类型到字符串转换，流操纵器，刷新等功能）

我的尝试是基于在此论坛（*）中找到的许多示例，但是我猜想是一种错误的方式，因为我的课程有点错误。本质上，我试图通过覆盖std::streambuf和overflow方法来扩展xputn，以使其最终调用clog的{{1}}。

注意：：我发现很难同时回答我的问题complete(**), minimal and verifiable，因此，对此提出的任何建议/意见将不胜感激。不过，对我来说最重要的是我所采用的方法，而不是具体的错误或实现缺陷。

operator<<

我的重写函数的实现方式如下：

class LogStream : public std::streambuf
{
public:
    enum class Color { RED_BRIGHT, RED_DARK, /* ...others */ NO_COLOR };

    LogStream(void);
    LogStream(std::basic_ostream<char>& out, std::string cname, char c, Color icon_color, Color text_color = Color::NO_COLOR);

    /* Non-copiable. */
    LogStream(const LogStream&) = delete;
    LogStream& operator=(const LogStream&) = delete;

    static void setNameLength(int l);

protected:
    int_type overflow(int_type c = traits_type::eof());
    std::streamsize xsputn(const char* s, std::streamsize n);

private:
    /* Important stuff: */
    std::basic_ostream<char>& m_out;
    bool m_new_line;

    void conditionalPrintHeader(void);
    void endLine(void);

    /* For message decoration purposes: */
    Color m_color_icon;
    Color m_color_text;
    char m_icon;
    std::string m_cname;
    static std::map<Color, const std::string> m_color_lut;
};

/* A macro to create static instances of a logger later in each CPP file. */
#define CREATE_LOGGER(klass)                        \
    namespace Log {                                 \
        static std::ostream dbg(new LogStream(      \
            std::clog,                              \
            #klass,                                 \
            '>',                                    \
            LogStream::Color::RED_BRIGHT,           \
            LogStream::Color::NO_COLOR));           \
        static std::ostream err(new LogStream(      \
            std::clog,                              \
            #klass,                                 \
            'e',                                    \
            LogStream::Color::RED_BRIGHT,           \
            LogStream::Color::RED_DARK));           \
    }

函数std::streamsize LogStream::xsputn(const char* s, std::streamsize n) { conditionalPrintHeader(); if(s[n - 1] == '\n') { m_new_line = true; endLine(); } m_out << s; return n; } LogStream::int_type LogStream::overflow(int_type c) { if(c == traits_type::eof()) { return traits_type::eof(); } else { char_type ch = traits_type::to_char_type(c); return xsputn(&ch, 1) == 1 ? c : traits_type::eof(); } } void LogStream::conditionalPrintHeader(void) { if(m_new_line) { m_out << "... header and color escape codes ..."; m_new_line = false; } } void LogStream::endLine(void) { m_out << "color escape code for no color."; }和conditionalPrintHeader本质上试图实现这种基本结构：

endLine

所以当我这样做时：

[header string] [ANSI color code] [<the log message>] [end color code]

终端输出：

Log::warn << "Integer: " << 123 << ", Bool: " << std::boolalpha << true << ", Float: " << 3.1415f << "\n";

大多数时候，除了我需要打印整数值外，其他所有东西都很好。而不是数字，我得到了额外的垃圾，就像这样：

HEADER + [START COLOR] Integer: 123, Bool: true, Float: 3.1415 [END COLOR]

注释：

（*）启发或直接有助于我解决方案的类似问题：

https://stackoverflow.com/a/10921803/1876268 –我将大部分实现概念都放在这里。
Add time stamp with std::cout
Correct way to declare/define custom cout-like object
https://codereview.stackexchange.com/a/187373/176115
Correct implementation of std::streambuf::overflow

（**）我粘贴了整个标头和源文件，以使其尽可能完整，以防万一我在其他地方丢失错误：Log.hpp，Log.cpp。

Answer 1

目前，我认为问题出在xsputn的字符串参数中（我认为该参数不是以空字符结尾的）。我用如下整数解决了我的问题，但是我仍然不清楚这种方法是否好。

std::streamsize LogStream::xsputn(const char* s, std::streamsize n)
{
    conditionalPrintHeader();
    if(s[n - 1] == '\n') {
        m_new_line = true;
        endLine();
    }
    std::string str;
    for(int c = 0; c < n; c++) {
        str += s[c];
    }
    m_out << str;
    return n;
}

具有颜色和标头的std :: clog包装器无法正确打印整数

1 个答案: