自己写的编辑器卡在哪:输入法、导出与每帧性能
用 Rust + egui 重写一个 MarkText 风格的 Markdown 编辑器,功能本身不难——难的是三件事:输入法要能用中文、导出要能看、大文件要能不卡。
这三件事有个共同点:写完不报错,用起来才发现不行。输入法不接就是打不出字,导出不处理就是一堆方块,每帧哈希就是滚动条抖。这篇把这三个方向上的具体坑记下来,顺带记两处桌面集成的连带问题。
一、先定「能用」的基线
动手改之前先明确验收标准,否则「看起来能用」会一直骗你:
- 界面:按 MarkText 的样子对齐(标题栏、标签栏、行距),而不是自己发挥;
- 交互:IME 要能在真实 fcitx5 下正常出候选、能提交、能取消;
- 导出:PDF/HTML 里的中文、表格、代码块、公式、Mermaid 都要能看;
- 性能:15MB 大文件滚动不卡;
- 构建:所有构建与测试只走 CI,不在本地跑(本地
cargo clean一次性删掉过 10.1 GiB)。
基线定下来之后,每个坑都能归到某一条上,不容易跑偏。
二、输入法要打通三层
中文输入在自绘 GUI 里失败,通常不是一层的问题,而是三层里任意一层没打通。我这次是四层都踩了一遍:
第一层:环境变量把 XIM 关了。 应用启动时 XMODIFIERS=@im=none,XIM 直接被禁用。按键能进窗口,但永远不进入输入法。
第二层:没告诉 winit 允许 IME。 自绘编辑器只上报了候选窗位置,却从没调用「允许 IME」的接口——结果 shi 被当成普通文本逐字插入。对照官方 TextEdit 实现补上允许调用即可。
第三层:输入法本身停在英文模式。 fcitx5 的 status=1 表示英文模式,此时字母不会组合。用 fcitx5-remote 确认返回 2(拼音)再测。
第四层:egui 的帧顺序。 这一层最容易被误判成产品 bug:
IME 事件是在绘制之后处理的,预编辑文本要到下一帧才画出来。
所以端到端测试如果按「同一帧就能断言到预编辑」写,会一直失败。正确做法是改成按下一帧语义断言,而不是去改产品代码迁就测试。
另外,在 X11 下做按键注入时 XTEST 会被合成器拦截(XWayland 尤其明显),注入的键根本不生效。要测真实输入得改用 uinput 虚拟键盘。
三、PDF 导出:字体、断行与绘制状态
导出的问题是一串一串出现的,每修一个就露出下一个。
中文全是方块。 导出字体只嵌了 Inter 和 JetBrains Mono,没有中文字体 → 嵌入思源黑体。
中文长段落不换行、溢出页面。 缺少 CJK 断行逻辑——西文按空格断,中文要按字符断,还得处理行首标点禁则。
全角标点导致行宽溢出、断行错位。 U+FF0C(,)这类全角标点不在 CJK 统一表意文字区间里,宽度被按半角算,于是每行都算短了。
表格正文行全是深色底。 这是绘图库的填充状态泄漏到描边矩形——每个绘制函数都必须显式重置 fill/stroke,不能假设状态干净。
行内公式撑破行高、块级公式压住上一行。 $$...$$ 被 Markdown 解析器包进了 Paragraph,于是按行内公式绘制、行高也没扩容。修法是行高按公式高度扩展,并把 $$...$$ 改成独立居中块。
链接变成黑色。 链接色被父级颜色覆盖 → 链接色优先级要高于父级,并加下划线。
任务列表的勾选框缺字。 思源黑体里没有 ☑/☐,换成它确实包含的 √/□。
这几条连起来看,规律很清楚:导出不是「把 Markdown 画出来」,而是一次小型排版引擎的实现——字体覆盖、断行规则、盒模型状态、公式尺寸,缺一样就出一样的问题。
四、每帧全文哈希:大文件为什么卡
大文件卡顿的根因不是渲染,是每个渲染路径都在每帧做全文工作:
- Raw 模式每帧调
prepare_undo_snapshot_hashed(),对全文做 blake3; - Rendered 模式每帧走
get_or_parse,同样对全文哈希。
15MB 的文件,每帧算一次全文哈希,滚动当然抖。
修法是把所有缓存与快照改成按内容版本号(content_version)失效:滚动、移动光标这类不改内容的操作完全不触发哈希,只有内容真的变了才递增版本号、重建缓存。
顺带做了几处同类整改:
- 外部重载只赋值
content是不够的——编码、BOM、原始哈希、磁盘锚点都得一起更新,否则等长的外部修改会被旧缓冲覆盖、非 UTF-8 文件重载会损坏。抽成replace_from_disk单一入口。 - AST 缓存加 64MB 上限,否则越开越占。
- 代码执行加 2MB 输出上限,并杀进程树、临时文件 0600。
五、启动恢复的两条路径
启动时「上次的标签页没了」「已经有标签却被清空」,根因是两个恢复函数先后执行:
1 | restore_session_tabs() // 不先清空 |
后者一执行,前者的结果就被抹掉;而且恢复失败时也照清不误。
修法是只保留一条恢复路径:先构建恢复计划,再原子替换;失败就保留现有标签,什么都不做。
这类问题的共性:同一个状态有两条写入路径时,顺序就是 bug 的温床。要么合并成一条,要么明确谁先谁后。
六、右键菜单:框架没给,得自己挂
自绘编辑器里最容易被忘掉的是右键菜单——键盘 Ctrl+C/X/V/A 一直能用,所以”复制粘贴是好的”这个结论看起来没问题,直到有人右键点了一下。
两个原因叠加:
- egui 0.34 的
TextEdit本身没有内置右键菜单,只处理Event::Copy/Paste这类键盘事件; - 项目也没给文本控件挂
response.context_menu(...)—— 此前只有文件树、终端、JSON 树视图挂过。
修法是给 Raw 编辑器和 Rendered 预览里每一个 TextEdit 的响应显式挂上菜单:复制 / 剪切 / 粘贴 / 全选(支持多光标)。
非编辑块要单独处理。 预览里的绘制块连”选中”状态都不存在,右键只会被当成一次点击——所以给这类块单独提供「复制本段」,作用于当前块。
菜单分支里别提前取走状态。 第一版在菜单分支里先取走了编辑状态、后面还要用,直接造成所有权冲突;改成统一在菜单处理全部结束之后保存。这类 bug 编译器帮不了你,只能靠测试。
七、一个架构性的判断:跨块选择不是 bug
用户提了个需求:预览模式能不能跨段落选中文字。
查下来这不是缺陷,是架构的结果。预览是「按块渲染 + 每块独立编辑」:
- 非编辑块用绘制好的 galley 显示,只挂
Sense::click()用于点击进入编辑,本身没有文本选择能力; - 进入编辑后,每块是独立的
TextEdit,焦点与选区按块保存,一次只有一个块处于编辑态。
所以「跨块的文档级选区」这个状态在现有架构里根本不存在。要支持它,得引入文档级选区(块索引 + 块内字符区间)、跨块绘制选区矩形、复制时拼接块文本——会同时动到渲染、点击命中、复制和光标映射。
结论是:这次不改造架构,改用「复制全部 / 复制为 Markdown」覆盖”整篇复制”这个真实需求;真正的跨块拖选记进路线图,作为架构级改动。
判断「是 bug 还是架构代价」很关键:前者修一天,后者动全身。判断标准是「这个功能在现有架构里有没有对应的状态」——没有,就不是修 bug。
八、打包与 CI 的四个坑
Cargo.lock 没提交,CI 直接失败。 功能提交只带了 Cargo.toml 和源码,CI 用 cargo check --locked,报 the lock file needs to be updated but --locked was passed。锁文件是仓库产物,必须一起提交;提交前本地先跑一次 --locked 验证自洽。
NSIS 的相对路径基准是「脚本所在目录」。 不是仓库根。File/OutFile 写成 target/release/mdoxide.exe 会找不到,要写成 ..\..\target\release\mdoxide.exe。
Windows runner 没有 makensis。 release workflow 里要先装(Chocolatey),否则 Windows 包永远出不来。
Dependabot 会把「工具链版本的 ref」当成 action 版本升级。 dtolnay/rust-toolchain@1.92.0 指的是 Rust 版本(由 rust-toolchain.toml 固定),Dependabot 却把它当 action 版本提到 1.120.0,必然失败 → 加 ignore 规则。
另外一条经验:版本号从 tag 里取时别混入 v 前缀;本地残留的旧 tag 要先删再重新指向当前发布提交,否则 release workflow 一直是「没有新 tag」。
九、附:桌面集成的另外两处
同一个月的两个桌面问题,性质类似,一起记。
Wayland 下窗口能力是空的。 想让小工具固定在角落、置顶、不在任务栏出现——在 winit 的 Wayland 后端里,set_visible、set_outer_position、set_window_level 全是空实现(源码注释直接写 “Not possible on Wayland.”),set_minimized(true) 也无法取消。要做全功能得自己写 layer-shell 后端(估 800–1500 行新代码,且 GNOME 不实现该协议),实际选择是继续走 XWayland。
X11 下任务栏也不会自己让开。 KWin 不会因为窗口是 Utility 就跳过任务栏,而 winit 的 X11 后端又没有 skip_taskbar 接口(只有 Windows 有)。只能自己发 EWMH 消息:
1 | _NET_WM_STATE_SKIP_TASKBAR |
要注意窗口还没被窗口管理器接管时,这两条消息会被丢弃——发送后要回读 _NET_WM_STATE 确认,失败就重试(实践里最多重试 10 次、约 5 秒)。
KDE 维护两套 MIME 关联文件。 系统设置里改默认应用,一切换页面就回滚、双击文件还是老程序打开。原因是:KCM 和右键菜单只写 ~/.config/mimeapps.list,而运行时优先读 ~/.config/kde-mimeapps.list,系统级 /usr/share/applications/kde-mimeapps.list 又提供了默认值。三份文件叠在一起,只改 GUI 那份永远不生效。
定位方法很实用:把默认指向一个无界面的测试应用,看谁被真正拉起——由此确定运行时到底读的是哪份配置。
还有一层:「直接关联」优先于「父 MIME 继承」。一个 desktop 同时声明 text/plain;text/markdown;text/x-markdown 时,去重后目标 MIME 只剩继承关系,强度低于另一个直接声明它的应用——表现就是「设了默认却打不开」。
十、从「能用」到「耐用」:0.5 到 0.6 补的几道关
前九个方向解决的是「能不能用」,后面几个版本补的是「用久了会不会坏」。
重载入口只能有一个。 文件被外部修改时,编辑器有磁盘监听、窗口聚焦、手动刷新三个触发点。多个入口各自读盘,会互相覆盖未保存内容。做法是收敛成 replace_from_disk 单一入口,并用 revision 门控缓存:内容版本没变就不重建 AST。
启动恢复要收敛,写入要增量。 恢复流程原来会重建整份文档再比较,大文件下启动明显变慢;改成只回放差异,并给 AST 设 64 MB 上限,超限就退化为纯文本视图,避免恢复时把内存打满。
持久化要「耐久」而不是「写了」。 直接从内存写文件,进程在写一半时崩溃就是半个 JSON。做法是 tmp + rename 原子写、配置保留 .bak、RecoveryWriter 后台串行写;索引更新加 400 ms debounce 且只跑一个 worker,否则每次按键都触发一次索引重建。
正文所有权要收敛到 Document。 早期 Tab 直接持有 content,渲染、保存、恢复各自拿 &mut,借用冲突只能靠拆字段绕。0.6.5 把正文收进 Document,state.rs 按职责拆分,Tab 只留 id 与元数据。
安全边界要显式写出来。 代码执行、HTML 预览、终端嵌入都是「能跑任意内容」的入口,默认关闭,开启时给出明确提示;AST 大小上限同时防住恶意深层嵌套。
主题要跟系统走,但不能每次启动都覆盖用户选择。 从本机 Zed 主题文件读出 duskfox-blurred 的色号,窗口 with_transparent(true) + 全透明 clear_color,再由 KWin 的模糊窗口规则补上背景模糊,观感接近 Zed。配置里加 language_explicit:旧配置没有该字段时每次启动跟随系统区域设置,用户手动选过语言后才固定。
几个只在重构时才会遇到的坑:
- egui 的
allocate_rect在 RTL 布局里会反向推进父布局游标:右上角的模式切换分段各自调用它,父游标反向移动 52px,和字数统计重叠、还点不到。改用interact,只命中不占位。 - 结构体尾部悬空的文档注释会触发 E0585,并「传染」整片类型推断:一个孤立的
///让 rustc 把结构体恢复成错误类型,随后大量字段被推断成Option<Path>/Option<str>、出现 unsized 报错。删掉悬空注释、补齐初始化字段即可。 Deref之后&mut tab.content会借用整个tab:渲染编辑器构造处改成用已保存的tab_id回查,避免整结构借用。- TextEdit 的状态会在右键菜单动作前被 move:菜单编辑后状态丢失。统一在菜单处理结束后再保存状态。
- 改了行高/主题,测试还写死旧值:断言行高 20px、主题循环没包含 Duskfox,CI 直接红。测试要引用
FIXED_LINE_HEIGHT常量,主题循环跟着枚举走。
构建策略也要认账:release 二进制 51 MB、xz 压到 18.3 MB,刚好达 ≤20 MB;15 MB / 36 万行文档后台加载不阻塞 UI、峰值 RSS 约 564 MB。cargo clean 一次清掉 16121 个文件 / 10.1 GiB 之后,规则改成「不在本机构建或跑测试,全部走 GitHub Actions」——本地只做 cargo check 与格式化。
总结
三个方向,一句话各一条:
- 输入法是分层问题,环境变量、应用允许、输入法状态、框架帧序,缺一层就全废;测试要按框架的真实时序写,别去改产品迁就测试。
- 导出是一次小型排版:字体覆盖、CJK 断行、全角宽度、绘制状态,一条条补,补完才算能用。
- 性能先找「每帧做了什么全文工作」,再用内容版本号把它们挡住。
再补一条通用的:「设置没生效」先怀疑「要改的文件不止一处」。桌面环境尤其如此——GUI 写一份、运行时读另一份、系统级再给默认值,三份叠着,只改看得见的那份永远不会生效。