LibXR::Logger Class Reference

LibXR 日志管理器 / LibXR Logger Manager. More...

#include <logger.hpp>

Static Public Member Functions
static void	Init ()
	初始化日志主题 / Initialize the log topic
static void	Publish (LogLevel level, const char *file, uint32_t line, const char *fmt,...)
	发布一条日志 / Publish a log message

Static Private Member Functions
static void	PrintToTerminal (const LogData &data)
	打印日志到终端 / Print log to terminal
static const char *	GetColor (LogLevel level)
	根据日志级别获取显示颜色 / Get color code based on log level
static const char *	LevelToString (LogLevel level)
	将日志级别转换为字符串 / Convert log level to string

Static Private Attributes
static std::atomic< bool >	initialized_ = false

Detailed Description

LibXR 日志管理器 / LibXR Logger Manager.

Definition at line 44 of file logger.hpp.

Member Function Documentation

GetColor()

static const char * LibXR::Logger::GetColor ( LogLevel  level )

inlinestaticprivate

根据日志级别获取显示颜色 / Get color code based on log level

Parameters

level

日志级别 / Log level

Returns

颜色字符串 / Color string

Definition at line 84 of file logger.hpp.

  {
    using namespace LibXR;
    switch (level)
    {
      case LogLevel::XR_LOG_LEVEL_DEBUG:
        return LIBXR_FONT_STR[static_cast<uint8_t>(Font::MAGENTA)];
      case LogLevel::XR_LOG_LEVEL_INFO:
        return LIBXR_FONT_STR[static_cast<uint8_t>(Font::CYAN)];
      case LogLevel::XR_LOG_LEVEL_PASS:
        return LIBXR_FONT_STR[static_cast<uint8_t>(Font::GREEN)];
      case LogLevel::XR_LOG_LEVEL_WARN:
        return LIBXR_FONT_STR[static_cast<uint8_t>(Font::YELLOW)];
      case LogLevel::XR_LOG_LEVEL_ERROR:
        return LIBXR_FONT_STR[static_cast<uint8_t>(Font::RED)];
      default:
        return "";
    }
  }

Init()

void Logger::Init ( )

static

初始化日志主题 / Initialize the log topic

Definition at line 15 of file logger.cpp.

{
  log_topic = Topic::CreateTopic<LogData>("/xr/log", nullptr, false, true);
 
#if LIBXR_PRINTF_BUFFER_SIZE > 0
  void (*log_cb_fun)(bool in_isr, Topic, RawData &log_data) =
      [](bool, Topic tp, LibXR::RawData &log_data)
  {
    UNUSED(tp);
 
    auto log = reinterpret_cast<LogData *>(log_data.addr_);
 
    if (LIBXR_LOG_OUTPUT_LEVEL >= static_cast<uint8_t>(log->level) &&
        STDIO::write_->Writable())
    {
      PrintToTerminal(*log);
    }
  };
 
  auto log_cb = LibXR::Callback<LibXR::RawData &>::Create(log_cb_fun, log_topic);
  log_topic.RegisterCallback(log_cb);
#endif
 
  initialized_ = true;
}

LevelToString()

static const char * LibXR::Logger::LevelToString ( LogLevel  level )

inlinestaticprivate

将日志级别转换为字符串 / Convert log level to string

Parameters

level

日志级别 / Log level

Returns

日志级别字符串 / Log level string

Definition at line 109 of file logger.hpp.

  {
    switch (level)
    {
      case LogLevel::XR_LOG_LEVEL_DEBUG:
        return "DEBUG";
      case LogLevel::XR_LOG_LEVEL_INFO:
        return "INFO";
      case LogLevel::XR_LOG_LEVEL_PASS:
        return "PASS";
      case LogLevel::XR_LOG_LEVEL_WARN:
        return "WARN";
      case LogLevel::XR_LOG_LEVEL_ERROR:
        return "ERROR";
      default:
        return "UNKNOWN";
    }
  }

PrintToTerminal()

static void LibXR::Logger::PrintToTerminal ( const LogData &  data )

inlinestaticprivate

打印日志到终端 / Print log to terminal

Parameters

data	日志数据 / Log data

Definition at line 69 of file logger.hpp.

  {
    const char* color = GetColor(data.level);
 
    STDIO::Printf("%s[%u][%s](%s:%u) %s%s\r\n", color,
                  static_cast<uint32_t>(data.timestamp), LevelToString(data.level),
                  data.file, data.line, data.message,
                  LIBXR_FORMAT_STR[static_cast<uint8_t>(Format::RESET)]);
  }

Publish()

void Logger::Publish ( LogLevel  level, const char *  file, uint32_t  line, const char *  fmt,   ...  )

static

发布一条日志 / Publish a log message

Parameters

level	日志级别 / Log level
file	来源文件名 / Source file name
line	行号 / Line number
fmt	格式化字符串 / Format string
...	可变参数 / Variable arguments

Definition at line 42 of file logger.cpp.

{
  if (!initialized_)
  {
    Init();
  }
  LogData data;
  data.timestamp = TimestampMS(Thread::GetTime());
  data.level = level;
  data.file = file;
  data.line = line;
 
  va_list args;
  va_start(args, fmt);
  auto ans = vsnprintf(data.message, sizeof(data.message), fmt, args);
  UNUSED(ans);
  va_end(args);
 
  log_topic.Publish(data);
}

Field Documentation

initialized_

std::atomic<bool> LibXR::Logger::initialized_ = false

inlinestaticprivate

Definition at line 128 of file logger.hpp.

---

The documentation for this class was generated from the following files:

• src/middleware/logger.hpp
• src/middleware/logger.cpp