Files
XCEngine/docs/api/XCEngine/Editor/Utils/ProjectFileUtils/ProjectFileUtils.md

1.8 KiB
Raw Blame History

ProjectFileUtils

命名空间: XCEngine::Editor::ProjectFileUtils

类型: utility-header

源文件: editor/src/Utils/ProjectFileUtils.h

描述: 提供 Project.xcproject 的读写、项目名推导以及项目相对路径解析辅助。

概述

ProjectFileUtils 把当前 Editor 项目描述文件的最小协议封装成了一组 header-only helper。

这层处理的是很朴素但很常用的几件事:

  • 项目描述文件路径在哪里
  • 项目名默认取什么
  • Project.xcproject 如何保存和读取
  • 全路径和项目相对路径如何互转

当前公开内容

ProjectDescriptor

  • name
  • startupScene

主要 helper

  • GetProjectFilePath(...)
  • GetProjectName(...)
  • Trim(...)
  • SaveProjectDescriptor(...)
  • LoadProjectDescriptor(...)
  • MakeProjectRelativePath(...)
  • ResolveProjectPath(...)

当前文件格式

当前 Project.xcproject 仍然是简单的 key-value 文本:

  • version=1
  • name=...
  • startup_scene=...

它不是 JSON也不是事务式数据库。

当前使用位置

  • ProjectCommands.h 用它生成并保存项目描述。
  • SceneManager.cpp 用它读取 startup scene。
  • ProjectPanel.cppInspectorPanel.cppReferencePicker.h 用它把绝对路径折回项目相对路径。

当前实现边界

  • 当前协议字段很少,只够支撑项目名和启动场景。
  • 路径解析主要围绕当前本地文件系统工作流,不带更复杂的虚拟文件系统抽象。
  • LoadProjectDescriptor(...) 对未知字段会忽略,不做严格模式校验。

相关文档