Мне нужен класс для переноса вызовов на std::clog, чтобы:
- Каждому сообщению предшествовал заголовок, который включает время и имя объекта, который сгенерировал сообщение.
- Сообщения окрашиваются в соответствии с типами ошибок (например, отладка, предупреждение, ошибка).
- Способ его использования в точности эквивалентен
std::clog << "..." для всех его функций (т. Е. Способность иметь неявные базовыепреобразования типа "строка-строка", потоковые манипуляторы, очистка и т. д.)
Моя попытка была основана на многих примерах, найденных на этом форуме (*), но я думаю, что в некотором роде неправильнопотому что мой класс немного неисправен.По сути, я попытался расширить std::streambuf путем переопределения методов overflow и xputn таким образом, чтобы они в конечном итоге вызывали clog s operator<<.
NB: Мне было трудно держать мой вопрос завершенным (**), минимальным и поддающимся проверке одновременно, поэтому любые предложения / комментарии по этому вопросу будут высоко оценены.Но для меня важнее всего подход, который я выбрал, а не конкретные ошибки или недостатки реализации.
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]
В большинстве случаев все работает отлично, за исключением случаев, когда мне нужно напечатать целочисленные значения.Вместо числа я получаю дополнительный мусор, например:
[ ... ] Integer: 123�~c, Bool: true, Float: 3.1415
Примечания:
(*) Похожие вопросыкоторые вдохновили или непосредственно способствовали моему решению:
(**) Я вставил весь заголовок и исходные файлы, чтобы они были максимально полными, и в случае, если я пропускаю ошибку где-то еще: Log.hpp , Log.cpp .