编辑器选择、文档生命周期与停靠布局
EditorManager 选择并调用编辑器,EditorDocumentService 为接入它的内容提供文档身份和保存/关闭协议,DockLayoutManager 管理停靠内容注册与布局。三者不是同一个持久化层:打开返回、文档保存成功、布局保存成功有各自的完成边界。
文本内容中的代码地图、字体、查找替换、折叠与快捷键见文本编辑器。文件 JSON 的打开保持原文,格式化由用户显式执行。
本主题不定义文件与工作区的打开分流、批量打开或工作区切换,见资源打开与单工作区切换。终端面板的进程、脚本及退出责任见终端契约;图像内容加载和保存见图像编辑器。
编辑器注册和默认选择
EditorManager 初始化时扫描发现视图中的程序集,并在 AssembliesChanged 后登记新出现的程序集;没有程序集服务的宿主退回监听 AppDomain.AssemblyLoad。发现输入是具体 IEditor 类型上的 EditorForExtensionAttribute、GenericEditorAttribute 和 FolderEditorAttribute;运行期也可直接 RegisterEditor(EditorDescriptor)。只存在一个类、不带发现属性且未显式注册,不会自动成为候选。
注册以 EditorDescriptor.Id 为键,不区分大小写;相同 ID 的新注册会替换旧注册,包括旧的文件夹、通用和各扩展名关联。扩展名去空白、补点并转小写;非通用文件编辑器必须声明扩展名,文件夹编辑器不使用扩展名。未指定稳定 ID 的属性注册回退到类型全名。注册验证不等于构造成功:没有 Factory 时仍需在打开时通过 Activator.CreateInstance 创建实例。
各候选组内按 IsDefault 降序、Priority 降序、ID 不区分大小写排序。文件默认选择顺序是:
- 当前扩展名的已配置 ID,或兼容旧配置中的类型全名;必须仍匹配专用或通用候选。
- 专用候选中的默认项,否则第一项。
- 通用候选中的默认项,否则第一项。
因此通用编辑器的高优先级不会越过已有专用编辑器,除非被显式配置为默认。文件夹用独立的 DefaultFolderEditor,依次选择已配置项、默认项、第一项。读取旧类型全名只是兼容查找,不会在读取时自动写回稳定 ID。
IsVisibleInOpenWith 只在 GetFileEditorDescriptors / GetFolderEditorDescriptors 的 visibleOnly:true 查询中过滤;默认解析和按 ID 打开不使用这个过滤。隐藏候选不等于禁止使用,也不等于清除已保存默认项。打开路由中的选择窗口和“始终使用”处理由 ResourceOpenService 负责。
TrySetDefaultEditor / TrySetDefaultFolderEditor 先修改 EditorManagerConfig。主应用使用 ConfigHandler.TrySave 确认落盘后才更新默认项缓存。保存失败时恢复配置字段并返回错误,已打开的资源保持打开。其他 IConfigService 继续按其 Save<T>() 契约保存。配置存储语义见配置持久化。管理器只首次加载配置到缓存,配置重载不会刷新此缓存。
选定描述符后,管理器只尝试这个编辑器。创建返回空、返回不符合声明类型的实例或 Open 抛错都会失败,不再尝试下一个候选。仅当 CreateEditor 已成功返回实例,且该实例实现 IDisposable 时,外层异常路径才会尝试释放;工厂返回错误类型在 CreateEditor 内即抛错,外层没有取得该实例,不会替它释放。IEditor.Open(path) 返回 void,管理器的成功只表示调用正常返回,不证明异步载入完成、产生了标签页或执行过保存。比如 SystemEditor 交给系统打开,不创建本服务管理的文档。
文档身份与内容接口
EditorDocumentService.Open 根据传入的 editorType,在当前资源种类与扩展名的候选中重新解析一个注册 ID,找不到则使用类型全名/类型名。它没有直接接收打开路由选中的描述符 ID;同一个类型注册多个 ID 时,不能据此保证每个 ID 都建立不同文档。
ContentId 是 editorId + 换行 + NormalizeResourcePath(path) 的 MD5。路径规范化只有 Path.GetFullPath 和移除末尾目录分隔符,不折叠大小写、不解析链接或比较文件系统对象。文档查找按 ContentId 精确匹配;这与打开路由中不区分大小写的批量路径去重不是相同身份规则。
同一 ContentId 已在当前布局树中时,只激活既有标签,不再调用内容工厂,也不重新加载磁盘。解析出的编辑器 ID 不同,可以为同一路径建立不同标签;路径文本的大小写差异也可能绕过此处去重。新标签加入 WorkspaceManager.LayoutDocumentPane,服务保存会话并挂接激活、Closing、Closed 事件。
普通 IEditor 不自动获得文档能力,必须由编辑器调用此服务。内容契约如下:
| 接入内容 | 服务提供的能力 | 内容自身仍负责的事情 |
|---|---|---|
任意内容,经 Open 建立会话 | 身份、激活和可选关闭回调 | 实际载入及资源所有权 |
IEditorDocumentContent | 读取 IsDirty / CanSave,响应 DocumentStateChanged,调用 Save() | 脏状态、保存内容与保存完成的定义 |
同时实现 IReloadableEditorDocumentContent | 文件存在时允许 Reload,并安排文件监视 | ReloadFromDisk() 如何替换内存状态 |
同时实现 IResourcePathAwareDocumentContent | 重命名时尝试保留内容并更新资源路径 | TryUpdateResourcePath() 接受新路径或返回失败 |
后两个扩展接口经会话的 IEditorDocumentContent 引用识别;只实现扩展接口而未实现基础内容接口,不会获得该能力。DocumentStateChanged 刷新标题中的 * 脏标记和命令可用性。文档激活发出的 WorkspaceManager.ContentIdSelected 实际参数是资源路径,不能把事件名当作“传递 MD5 ContentId”的承诺。
保存与重新加载
主窗口可配置的保存/另存为动作先沿当前焦点检查并执行 ApplicationCommands.Save / SaveAs,不是无条件保存后台文档。内容控件可以接管其命令(例如 Copilot 输入框处理草稿);只有继续路由到主窗口时才使用下述活动文档入口。另存为不增加内容接口能力:当前图像与3D查看器可导出渲染图/截图,文本编辑器没有因此新增通用另存协议。
主窗口 Save 命令由 CommandInitializer 接到活动文档:只有受管理内容同时 CanSave=true、IsDirty=true 时命令可用。直接调用 TrySaveActiveDocument 只检查 CanSave,并不额外要求脏状态;TrySaveDocument(content) 若找不到管理会话,则直接调用该内容的 Save(),也不会先检查 CanSave。
受管理保存调用内容的 Save();返回 false 或抛异常会返回失败并显示错误,返回 true 则刷新文件时间/长度快照和标题。服务不会自行清脏状态,不保证内容层的原子写入、备份、冲突检测或失败回滚。保存多个文档也不是统一事务。
Reload 要求受管理内容支持重载且 File.Exists(ResourcePath)。有未保存修改时询问是否放弃,拒绝则不调用 ReloadFromDisk();接受后由内容实现替换,false 或异常按失败处理。它不是合并外部修改,也不是先自动保存再读。服务层的 true 只沿用内容返回值,不能代替对特定编辑器加载/渲染完成的判断。
固定选项卡
文档标签的图钉和标签右键菜单都调用 DocumentTabPinManager.ToggleCommand。固定时,管理器把该 LayoutDocument 移到当前 LayoutDocumentPane 已固定前缀的末尾,并暂存原 CanMove 后设为 false;固定标签因此位于普通标签之前,不能拖出或浮动。取消固定时恢复原 CanMove,并将文档放在仍固定的标签之后。各文档窗格独立排序,不把标签移动到另一窗格。
固定不改变 CanClose,不替换 EditorDocumentService 会话,也不跳过 Closing、脏文档确认或 Closed 清理。标签上的实心图钉只表示当前 LayoutDocument 实例在进程内已固定;状态由弱关联对象持有,不写入内容模型、资源文件或布局 XML。关闭并重新创建动态文档,或重启后按布局恢复,均不会自动恢复该状态。
关闭、资源重命名与释放
主窗口用独立的 MenuClose.CloseDocumentCommand 关闭活动标签(默认 Ctrl+W / Ctrl+F4),CanClose=false 时不执行,也不回退到图像 ApplicationCommands.Close 的清空操作。独立窗口若没有声明这条文档命令,则通用关闭菜单按该窗口当前/记忆焦点保留原生 Close 路由;并非所有窗口都关闭标签。
单个文档 Closing 时,非脏内容直接通过;脏内容提供保存、不保存、取消三种选择。选择保存必须让 Save() 成功,取消或保存失败会阻止关闭;不保存只是批准关闭,不会主动把内存内容恢复成磁盘版本。
| 入口 | 实际行为 |
|---|---|
TryCloseAllDocuments() | 对仍挂在布局中的受管理会话逐项预审,不调用 Document.Close();主窗口 Closing 通过预审后调用 SaveLayout |
TryCloseDocumentsForResources(paths) | 选择路径本身及其后代资源的已挂接会话,全部预审通过后逐项关闭 |
TryPrepareResourceRename(path) | 只选择该路径/后代中不能响应路径更新的会话,预审后关闭;支持路径更新的内容保持打开 |
NotifyResourceRenamed(old,new) | 将相同/后代路径映射到新位置;路径感知内容接受后更新路径、ContentId、监视器和必要标题 |
这些批量动作不是全有或全无:前一项已保存后,后一项取消不会撤销保存;关闭阶段后续标签拒绝关闭,也不会重开之前已关闭标签。资源范围比较不区分大小写,并检查相对路径是否越过根目录,但不是解析真实文件身份的权限边界。资源操作应由调用方先准备、执行文件操作后再通知;这些文档 API 本身不执行重命名。
预审选择“不保存”的批准在本次调用内有效。主窗口与维护操作的预审结束时清除批准,若之后重新发起关闭,仍有未保存修改的文档会再次询问。资源删除或重命名需要立即关闭标签时,同一批次的 Closing 可使用预审批准。批次退出时也会清除剩余批准。
路径感知内容的 TryUpdateResourcePath 返回 false 时,该会话保持旧路径,NotifyResourceRenamed 没有聚合成功结果;异常也没有逐会话隔离。不能承诺“收到重命名通知就全部标签已迁移”。仅当原标题等于旧资源名时,服务才随路径更新标题,自定义标题保留。
对非路径感知内容,通知只修改会话路径、ContentId 和监视器。外部重命名的通知绕过 TryPrepareResourceRename,服务路径与内容内部路径可能分离。
资源树的剪切粘贴和拖放移动复用重命名前检查。移动成功后,路径感知文档及被移动文件夹中的文档跟随新路径,未保存内容继续保留。后续保存写入新位置。
只有文档触发 Closed 后,会话才解除事件、停止并释放监视器/定时器、移出会话字典,再调用传入的 closeContent。服务不会对任意内容自动调用 IDisposable.Dispose(),释放责任取决于编辑器是否提供回调;例如 TextEditor 提供 Dispose,图像编辑器提供 Clear 和 Dispose。不能把从布局树移除、隐藏面板或布局重建等同于执行了这套 Closed 清理。
外部文件变化不是冲突锁
支持重载的受管理内容在父目录存在时尝试建立文件名过滤的 FileSystemWatcher,处理更改、创建、删除、重命名。事件通过应用 Dispatcher 安排检查,并由 300 ms 定时器合并;不是每个文件事件都立即重新载入。监视器创建失败会被捕获并停用,不能据“打开了标签”证明正在监视。
文件监视比较存在标志、文件长度和 UTC 最后修改时间。没有应用 Dispatcher、丢失监视事件或时间和长度相同时可能漏报。文本编辑器在保存时独立校验文件字节指纹。
- 检测到现存文件变化,内容未脏则自动尝试 Reload;内容已脏则询问是否放弃本地修改。拒绝后保留内存内容,不进行合并。
- 检查时先更新已观察快照,再提示/重载;拒绝或重载失败不会对同一快照持续重试,后续需要新的可检测变化或主动 Reload。
- 文件不存在时保留文档并显示
[已删除],不关闭文档、不清空内存内容。获取文件信息遇到 I/O 或权限异常也会得到“不存在”快照,所以这个标签不是物理删除的充分证据。 - 重命名也在合并检查中处理。原路径已恢复且备份仍在时,沿用原路径并按文件替换处理,即使长度和修改时间相同。目标存在时,若原路径已消失或仅修改了文件名大小写,文档跟随目标。已观察到重命名且原路径暂时消失时,保存会提示稍后重试。监视范围为文件所在目录。
停靠注册、布局恢复和重置
主程序在 ColorVision/MainWindow.xaml 的 DockingManager 上开启 AllowMixedOrientation,允许文档窗格在左右分栏后继续分别上下拆分,组成 2×2 四视图或其它嵌套布局。拖动文档标签到目标窗格中央的上、下、左、右停靠箭头可拆分,到中央合并为标签页。该选项属于窗口宿主配置,不依赖布局文件,也不自动排列已有文档;各视图仍由原有文档宿主管理。
DockLayoutManager 的注册表按 ContentId 保存内容与元数据,独立于 EditorDocumentService 的动态文档会话。主窗口先注册自身面板和各 IDockPanelProvider,再加载布局;只有已经注册的内容才有恢复入口。
布局保存在 Environments.DirStateLayout/MainWindowDockLayout.xml,通常位于 DirAppData/State/Layout。文件记录停靠布局,工作区文件清单和标签固定状态由各自的模块管理。SaveLayout() 将 XML 写入同目录临时文件,关闭后原子替换正式文件。序列化或写入失败时保留上次已保存的布局,失败记入日志。
XML 序列化使用 AvalonDock 5.x 独立包中的 AvalonDock.Serializer.Xml.XmlLayoutSerializer。它可读取 AvalonDock 4.x 布局,包括旧版大写布尔值;新版保存的布局不保证能被 4.x 读取,回退至 4.x 宿主前应保留原布局副本。Spectrum 对无法绑定内容的工具面板显式使用 UnresolvedContentHandling.Hide,保留旧版隐藏面板的行为。
LoadLayout() 文件不存在或异常时返回 false。序列化回调按面板/文档注册 ContentId 或已登记视图的稳定身份绑定内容;其它项取消,包括未注册的动态编辑器标签,不会从 XML 中的路径重新调用编辑器。成功后刷新注册标题,替换 WorkspaceManager 的布局/文档窗格引用,必要时补建文档窗格,并清除旧 DockView 缓存。后续 ShowAllViews() 接管已经恢复的文档模型,不重新添加或移动这些文档;布局中没有的新视图才加入默认文档窗格。方法自身失败时不保证回滚反序列化的中间状态;主窗口调用方在 false 后执行 ResetLayout()。
设备结果页由 AddViewConfig 使用 IDisPlayControl.PersistenceKey 登记稳定身份,设备 Code 不变时,改显示名称或加载顺序不影响匹配;主工作流程页使用固定 Flow 身份。DockViewRegistration 可按此身份创建新的延迟视图壳,恢复左右/上下分栏、窗格尺寸比例、标签顺序及选中状态。恢复分栏不恢复图像、曲线或测量记录,也不触发采集。设备未加载或身份重复时不猜测替代视图;没有稳定身份的旧 DockView_序号 项仍无法可靠恢复,需要升级后重新排列一次并正常退出保存。设备页恢复及再次加载后沿用当前文档的关闭/释放责任,旧布局的关闭事件不能释放新布局中的内容。
ResetLayout() 删除旧布局文件并按默认位置重建面板和注册文档。EditorDocumentService 管理的已打开标签(包括浮动标签)移到主文档窗格,保留编辑器实例、未保存修改和固定状态,重置前活动的编辑标签重新选中。菜单与 Ctrl+Alt+Shift+R 先询问是否重置,默认选择“否”。启动布局恢复失败时直接重置。编辑内容仍由用户保存,布局文件在后续正常保存时写入。
面板的 Hide/Show 与文档关闭不同。TogglePanel 隐藏/显示已有面板;ShowPanel 还会激活面板。面板已从布局移除时,两者可从注册表重新加入;不代表创建全新内容实例或重启终端进程。IsPanelVisible 只检查是否找到面板且未隐藏,不保证该页签当前激活或内容已构造。
ShowTransientPanel 按 ContentId 打开或激活当前进程内的工具会话。用面板关闭按钮结束会话时调用所有者的释放回调。重置布局将仍打开的会话移回默认停靠区域,保留内容实例。此类会话从布局文件恢复时会被跳过。「终端」面板中的新增终端、脚本运行和项目命令使用这个入口。 终端与脚本运行
工厂注册用 Lazy<object> 复用内容,并由每个注册项懒建、持有唯一的 DeferredDockContent。自动恢复、Reset 和关闭后重新 Show/Toggle 都向布局交付同一个宿主;原始 UI 内容始终作为该宿主的子内容,不再直接挂到新 LayoutAnchorable.Content 或另一个延迟宿主上。由 AvalonDock 管理宿主随布局的挂接,不通过遍历任意 UI 父节点来强行解绑内容。已构造对象的非工厂注册仍直接使用原对象,不增加延迟宿主。
自动恢复保持惰性:宿主可见且已 Loaded 后才在 ApplicationIdle 尝试构造;显式 Show 和 Toggle 的显示分支则同步物化,再显示/激活,不额外等待空闲回调。每个稳定宿主只尝试物化一次,失败记录日志,不承诺再次 Show 会重试;空工厂结果在取值时拒绝。Reset 不重建内容注册表,也不使宿主或 Lazy 缓存失效;不能用布局重置推断面板实例或失败的工厂已重新创建。布局恢复返回 true 也不意味着所有延迟面板均已构造成功。
证据与验证缺口
复核宿主及子内容引用、逻辑父子关系和工厂调用次数,区分旧布局项的 Dispatcher 清理发生在重开之前还是之后。
外部文件事件与路径更新失败需单独验证。
不重建真实布局或写入用户布局文件,也不证明未保存文档已被自动保护。
主程序与 Spectrum 的停靠模板统一由 ColorVision.Solution.Themes.AvalonDockTheme 提供;模板只读取文档和面板状态,不创建工作区,不替代各窗口的内容注册或保存关闭逻辑。共享资源入口及兼容字典见停靠外观与主题边界。
在实际窗口验证鼠标拖动、视觉表现和布局写回。
后续改动应围绕受影响的选择、保存/取消、外部变更或布局恢复分支取得针对性证据;启动产品、写布局/配置、保存编辑内容及调用资源操作仍需要任务授权,不是只读查阅文档的必要步骤。
