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.1 KiB

Raw Blame History

String

命名空间: XCEngine::Containers

类型: class

描述: 动态字符串类，提供 UTF-8 编码的字符串操作。

概述

String 是一个自定义动态字符串类，提供常见的字符串操作功能，支持拷贝构造、移动构造和多种字符串操作方法。

类型别名

别名	类型	描述
`SizeType`	`size_t`	大小类型

常量

常量	值	描述
`static constexpr SizeType npos`	`static_cast<SizeType>(-1)`	无效位置标识

公共方法

构造/析构

方法	描述
Constructor	构造字符串实例
Destructor	析构函数
operator=	赋值运算符

连接运算符

方法	描述
operator+=	追加字符串/字符
operator+	字符串连接

比较运算符

方法	描述
operator==	判断两个字符串是否相等
operator!=	判断两个字符串是否不相等

字符串操作

方法	描述
Substring	获取子串
Trim	去除首尾空白
ToLower/ToUpper	大小写转换
Find	查找子串位置
StartsWith	检查前缀
EndsWith	检查后缀

元素访问

方法	描述
CStr	获取 C 字符串指针
Length/Capacity/Empty	获取尺寸信息
operator[]	下标访问

容量管理

方法	描述
Clear	清空字符串
Reserve/Resize	预留/调整容量

std::hash 特化

namespace std {
    template<>
    struct hash<XCEngine::Containers::String> {
        size_t operator()(const XCEngine::Containers::String& str) const noexcept;
    };
}

提供了 std::hash<String> 特化，使 String 可以作为 unordered_map 或 unordered_set 的键使用。

实现算法： DJB hash (Daniel J. Bernstein hash)

算法细节：

初始值：5381
对每个字符：hash = hash * 33 + c（等价于 (hash << 5) + hash + c）

示例：

#include <XCEngine/Containers/String.h>
#include <unordered_map>

int main() {
    std::unordered_map<XCEngine::Containers::String, int> map;
    map["key1"] = 100;
    map["key2"] = 200;
    return 0;
}

使用示例

#include <XCEngine/Containers/String.h>

// 基本用法
Containers::String str = "Hello";
str += ", World!";

// 字符串操作
Containers::String sub = str.Substring(0, 5);  // "Hello"
bool hasPrefix = str.StartsWith("Hello");
bool hasSuffix = str.EndsWith("!");

// 查找
SizeType pos = str.Find("World");  // 返回 7

// 转换
Containers::String upper = str.ToUpper();
Containers::String lower = str.ToLower();

3.1 KiB Raw Blame History Unescape Escape