Files

ssdfasd dc850d7739 docs: 重构 API 文档结构并修正源码准确性

- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
  - math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
  - containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
  - core: 修复 types 链接错误
  - debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
  - memory: 修复头文件路径, malloc vs operator new, 新增方法文档
  - resources: 修复 Shader/Texture 链接错误
  - threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用

2026-03-19 00:22:30 +08:00

3.0 KiB

Raw Blame History

Logger

命名空间: XCEngine::Debug

类型: class (singleton)

头文件: XCEngine/Debug/Logger.h

描述: 全局日志记录器单例，提供多级别、多分类的日志输出。

概述

Logger 是 XCEngine 的核心日志系统单例。它支持多个日志输出目标（Sink）、日志级别过滤、分类开关，并提供宏方便使用。

单例访问

方法	描述
`static Logger& Get()`	获取单例实例

公共方法

生命周期

方法	描述
`void Initialize()`	初始化日志系统
`void Shutdown()`	关闭日志系统

Sink 管理

方法	描述
`void AddSink(std::unique_ptr<ILogSink> sink)`	添加日志输出目标
`void RemoveSink(ILogSink* sink)`	移除日志输出目标

日志记录

方法	描述
`void Log(...)`	通用日志记录
`void Verbose(...)`	Verbose 级别日志
`void Debug(...)`	Debug 级别日志
`void Info(...)`	Info 级别日志
`void Warning(...)`	Warning 级别日志
`void Error(...)`	Error 级别日志
`void Fatal(...)`	Fatal 级别日志

配置

方法	描述
`void SetMinimumLevel(...)`	设置最小日志级别
`void SetCategoryEnabled(...)`	开启/关闭指定分类

宏定义

XE_LOG

#define XE_LOG(category, level, message) \
    XCEngine::Debug::Logger::Get().Log(level, category, message, __FILE__, __LINE__, __FUNCTION__)

通用日志宏，自动填充文件名、行号和函数名。

XE_ASSERT

#define XE_ASSERT(condition, message) \
    if (!(condition)) { \
        XCEngine::Debug::Logger::Get().Fatal(XCEngine::Debug::LogCategory::General, message); \
    }

断言宏，条件失败时记录 Fatal 日志。

使用示例

#include <XCEngine/Debug/Logger.h>

// 初始化
Logger::Get().Initialize();
Logger::Get().AddSink(std::make_unique<ConsoleLogSink>());
Logger::Get().AddSink(std::make_unique<FileLogSink>("app.log"));

// 设置日志级别
Logger::Get().SetMinimumLevel(LogLevel::Debug);

// 使用便捷方法
Logger::Get().Info(LogCategory::Rendering, "Render started");
Logger::Get().Warning(LogCategory::Memory, "High memory usage");
Logger::Get().Error(LogCategory::FileSystem, "Failed to load file");

// 使用宏（自动带位置信息）
XE_LOG(LogCategory::General, LogLevel::Info, "Application initialized");

// 使用断言
XE_ASSERT(ptr != nullptr, "Pointer must not be null");

3.0 KiB Raw Blame History Unescape Escape