docs: explain application entry points and tooling workflows

This commit is contained in:
2026-11-12 19:31:28 +08:00
parent ca5bc863c1
commit 8a61d27938
8 changed files with 28 additions and 5 deletions
+3
View File
@@ -1,7 +1,10 @@
//! 语言桥接模块入口。集中导出 Endor 类型和宿主实现之间的适配层。
//! endor_host 建立会话时安装 ui_bridge 能力,源程序随后通过名义方法调用宿主;渲染线程不直接运行这些回调。
//!
// 目录确定模块归属;main 中的 crate 根别名保持内部调用路径稳定。
/// 注册托管类型/宿主方法,验证参数并连接业务对象、Mount、视觉协议与窗口/任务资源。
pub(crate) mod ui_bridge;
/// 注册图片、字体、文字流与避让形状能力,并把托管绘制参数解码为可跨线程使用的不可变资源。
/// ui_bridge 安装时调用注册入口,source_paint 解码 image 命令时复用图像检查。
pub(crate) mod graphics;
+6
View File
@@ -3,12 +3,14 @@
//!
//! Application composition root. Directory modules own implementation; these
//! crate-private aliases keep existing internal paths stable during reorganization.
// 以下目录模块只声明编译归属,真正启动服务和创建窗口发生在 main 的顺序调用中。
mod bridge;
mod model;
mod render;
mod runtime;
mod shell;
// crate 内旧路径通过私有重导出访问目录实现,不为 GUI 与 runtime 额外建立另一套对象或注册表。
pub(crate) use bridge::ui_bridge;
// 模型层负责从 VM 场景对象提取快照,渲染层 scene3d 负责原生计算;别名区分两者。
pub(crate) use model::scene3d as scene3d_model;
@@ -36,17 +38,21 @@ use document::NamespaceState;
use winit::event_loop::{ControlFlow, EventLoop};
/// 按顺序建立事件循环、共享文档、API/VM worker 和应用窗口;事件循环结束后返回原生退出清理结果。
// 操作系统启动可执行文件时进入;各阶段的 ? 将启动/循环错误返回进程入口,不把失败当作成功运行。
fn main() -> Result<()> {
// 原生窗口由事件循环所属线程驱动;Wait 让空闲时休眠,而不是持续重绘。
let event_loop = EventLoop::<AppEvent>::with_user_event().build()?;
// 后台发布通过 EventLoopProxy 唤醒等待,原生窗口请求 RedrawRequested 驱动实际绘制。
event_loop.set_control_flow(ControlFlow::Wait);
// 共享最近完整发布的文档。后台 worker 拥有 VM,GUI 不借用其托管堆。
let namespace = Arc::new(RwLock::new(NamespaceState::default()));
// worker 发布完整 NamespaceState,activity 供 Network 工具观察,control 用于原生窗口发运行时控制请求。
// start 先绑定本机 API 并启动后台设施;端口或线程启动错误会阻止后续应用状态构造。
let (activity, control) = api::start(namespace.clone(), event_loop.create_proxy())?;
// 两个 proxy 指向同一事件循环;后台线程通过纯数据通知唤醒 GUI,不直接操作原生窗口。
let mut app = TesseraApp::new(namespace, activity, event_loop.create_proxy(), control)?;
// run_app 接管线程直至退出;退出后仍需检查清理过程中记录的错误。
event_loop.run_app(&mut app)?;
// 仅 run_app 正常返回后汇总窗口/VM 清理错误;循环本身返回 Err 时上面的 ? 已直接传播。
app.exit_result()
}
+2
View File
@@ -1,4 +1,6 @@
//! 运行时模块入口。VM 生命周期、API、源程序组织、事件与异步任务在这里组合。
//! main 调用 api::start 建立服务;worker 通过 endor_host 操作所属 VM,events 客户端将原生输入排队交付。
//! 任务后台只完成纯数据 I/O,结果是否仍可交付以及如何回到源回调,由串行运行时检查和推进。
//!
// 目录确定模块归属;main 中的 crate 根别名保持内部调用路径稳定。
/// 提供 HTTP 路由、有界请求队列与串行 worker,协调候选 VM 和已发布 namespace。