LibXR::Logger Class Reference

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

#include <logger.hpp>

Static Public Member Functions
static void	Init ()
	初始化日志主题 / Initialize the log topic
template<Print::Text Source, typename... Args>
static void	Publish (LogLevel level, const char *file, uint32_t line, Args &&... args)
	发布一条字面量日志 / Publish one literal log message
template<Detail::LoggerLiteral::Frontend Forced, Print::Text Source, typename... Args>
static void	Publish (LogLevel level, const char *file, uint32_t line, Args &&... args)
	发布一条带显式前端标签的字面量日志 / Publish one literal log message with an explicit frontend tag

Static Private Member Functions
template<Detail::LoggerLiteral::Frontend FrontendMode, Print::Text Source, typename... Args>
static void	PublishSelected (LogLevel level, const char *file, uint32_t line, Args &&... args)
	按已确定前端发布一条日志 Publish one log entry under the already selected frontend
static void	PublishToTopic (LogData &data)
	把一条日志数据发布到内部日志 topic Publish one log record into the internal log topic

Static Private Attributes
static bool	initialized_ = false
	是否已经完成日志 topic 初始化 / Whether logger-topic initialization has completed.

Detailed Description

日志管理器 / LibXR Logger Manager

Definition at line 56 of file logger.hpp.

Member Function Documentation

Init()

void Logger::Init ( )

static

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

初始化 logger 的内部 topic 与终端订阅路径 Initialize the logger's internal topic and terminal subscriber path

Note

这里只做一次性初始化：创建 /xr/log topic，并注册一个把日志打印到 STDIO 的 callback。 This performs one-time initialization only: create the /xr/log topic and register one callback that prints logs to STDIO.

Definition at line 119 of file logger.cpp.

{
  log_topic = Topic::CreateTopic<LogData>("/xr/log", nullptr, true);
 
  auto log_cb = LibXR::Topic::Callback::Create(OnLogMessage, log_topic);
  log_topic.RegisterCallback(log_cb);
 
  initialized_ = true;
}

Publish() [1/2]

template<Print::Text Source, typename... Args>

static void LibXR::Logger::Publish ( LogLevel level, const char * file, uint32_t line, Args &&... args )

inlinestatic

发布一条字面量日志 / Publish one literal log message

Parameters

level	日志级别 / Log level
file	来源文件名 / Source file name
line	行号 / Line number
args	格式参数 / Format arguments

Definition at line 72 of file logger.hpp.

  {
    constexpr auto frontend =
        Detail::LoggerLiteral::SelectFrontend<Detail::LoggerLiteral::Frontend::Auto,
                                              Source, Args...>();
    PublishSelected<frontend, Source>(level, file, line, std::forward<Args>(args)...);
  }

Publish() [2/2]

template<Detail::LoggerLiteral::Frontend Forced, Print::Text Source, typename... Args>

static void LibXR::Logger::Publish ( LogLevel level, const char * file, uint32_t line, Args &&... args )

inlinestatic

发布一条带显式前端标签的字面量日志 / Publish one literal log message with an explicit frontend tag

Parameters

level	日志级别 / Log level
file	来源文件名 / Source file name
line	行号 / Line number
args	格式参数 / Format arguments

Definition at line 89 of file logger.hpp.

  {
    static_assert(Forced != Detail::LoggerLiteral::Frontend::Auto,
                  "LibXR::Logger: explicit literal tag must be XR_FMT(...) or XR_PRINTF(...)");
 
    constexpr auto frontend =
        Detail::LoggerLiteral::SelectFrontend<Forced, Source, Args...>();
    PublishSelected<frontend, Source>(level, file, line, std::forward<Args>(args)...);
  }

PublishSelected()

template<Detail::LoggerLiteral::Frontend FrontendMode, Print::Text Source, typename... Args>

static void LibXR::Logger::PublishSelected ( LogLevel level, const char * file, uint32_t line, Args &&... args )

inlinestaticprivate

按已确定前端发布一条日志 Publish one log entry under the already selected frontend

Template Parameters

FrontendMode	已选定的日志字面量前端 / Already selected literal frontend
Source	日志源串 / Log source literal
Args	格式参数类型 / Format argument types

Parameters

level	日志级别 / Log level
file	来源文件名 / Source file name
line	行号 / Line number
args	格式参数 / Format arguments

Note

这里负责惰性初始化日志主题，并把格式化后的文本写进固定 LogData 缓冲区； 真正的 topic 发布留给 PublishToTopic()。 This path performs lazy logger-topic initialization and formats the final text into the fixed LogData buffer; the actual topic publish is delegated to PublishToTopic().

Definition at line 119 of file logger.hpp.

  {
    if (!initialized_)
    {
      Init();
    }
 
    LogData data;
    data.level = level;
    data.file = file;
    data.line = line;
 
    if constexpr (FrontendMode == Detail::LoggerLiteral::Frontend::Format)
    {
      constexpr LibXR::Format<Source> format{};
      auto written = Print::FormatIntoBuffer(data.message, sizeof(data.message), format,
                                             std::forward<Args>(args)...);
      UNUSED(written);
    }
    else
    {
      constexpr auto format = Print::Printf::Build<Source>();
      auto written = Print::FormatIntoBuffer(data.message, sizeof(data.message), format,
                                             std::forward<Args>(args)...);
      UNUSED(written);
    }
 
    PublishToTopic(data);
  }

PublishToTopic()

void Logger::PublishToTopic ( LogData & data )

staticprivate

把一条日志数据发布到内部日志 topic Publish one log record into the internal log topic

把一条日志发布到内部日志 topic Publish one log record into the internal log topic

Parameters

data	待发布日志 / Log record to publish

Definition at line 134 of file logger.cpp.

{ log_topic.Publish(data); }

Field Documentation

initialized_

bool LibXR::Logger::initialized_ = false

inlinestaticprivate

是否已经完成日志 topic 初始化 / Whether logger-topic initialization has completed.

Definition at line 157 of file logger.hpp.

---

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

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