2026-03-18 17:49:22 +08:00
|
|
|
# Containers 容器模块概览
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::Containers`
|
|
|
|
|
|
|
|
|
|
**类型**: `module`
|
|
|
|
|
|
2026-03-26 01:58:16 +08:00
|
|
|
**头文件**: `XCEngine/Core/Containers/Containers.h`
|
2026-03-20 02:35:01 +08:00
|
|
|
|
2026-03-18 17:49:22 +08:00
|
|
|
**描述**: XCEngine 的容器模块,提供常用的数据结构实现。
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
|
|
|
Containers 模块提供了图形引擎常用的数据结构,包括动态数组、字符串和哈希表。这些容器都使用自定义内存分配器接口,支持内存跟踪和优化。
|
|
|
|
|
|
|
|
|
|
## 模块内容
|
|
|
|
|
|
|
|
|
|
### 容器类
|
|
|
|
|
|
|
|
|
|
| 组件 | 文件 | 描述 |
|
|
|
|
|
|------|------|------|
|
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
|
|
|
| [Array](array/array.md) | `Array.h` | 模板动态数组,支持自动扩容 |
|
|
|
|
|
| [String](string/string.md) | `String.h` | 动态字符串类 |
|
|
|
|
|
| [HashMap](hashmap/hashmap.md) | `HashMap.h` | 模板哈希表 |
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
## 设计特点
|
|
|
|
|
|
|
|
|
|
1. **自定义内存分配器支持** - 所有容器都支持通过 `IAllocator` 接口分配内存
|
|
|
|
|
2. **迭代器支持** - Array 和 HashMap 都提供 STL 风格的迭代器
|
|
|
|
|
3. **移动语义** - 完整支持 C++11 移动语义
|
|
|
|
|
4. **异常安全** - 内存分配失败时提供良好的错误处理
|
|
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
```cpp
|
2026-03-26 01:58:16 +08:00
|
|
|
#include <XCEngine/Core/Containers/Array.h>
|
|
|
|
|
#include <XCEngine/Core/Containers/String.h>
|
|
|
|
|
#include <XCEngine/Core/Containers/HashMap.h>
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
// 使用 Array
|
2026-03-19 00:49:08 +08:00
|
|
|
XCEngine::Containers::Array<int> arr;
|
2026-03-18 17:49:22 +08:00
|
|
|
arr.PushBack(1);
|
|
|
|
|
arr.PushBack(2);
|
|
|
|
|
arr.PushBack(3);
|
|
|
|
|
|
|
|
|
|
// 使用 String
|
2026-03-19 00:49:08 +08:00
|
|
|
XCEngine::Containers::String str;
|
2026-03-18 17:49:22 +08:00
|
|
|
str = "Hello, ";
|
|
|
|
|
str += "World!";
|
|
|
|
|
|
|
|
|
|
// 使用 HashMap
|
2026-03-19 00:49:08 +08:00
|
|
|
XCEngine::Containers::HashMap<XCEngine::Containers::String, int> map;
|
2026-03-18 17:49:22 +08:00
|
|
|
map.Insert("key1", 100);
|
|
|
|
|
map.Insert("key2", 200);
|
|
|
|
|
int* value = map.Find("key1");
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
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
|
|
|
- [Memory 模块](../memory/memory.md) - 内存分配器接口
|