基础设施与工具

KatanA Language Editor

处理文本、光标和选择范围的框架中立 Rust editor 接口。公开版本处于基础构建阶段。

开发 KatanA 编辑体验和语言功能的负责人

01

已实现功能

处理文本获取、设置和光标位置的共用接口

依据

以行、列表示的光标和选择范围数据类型

依据

表示正文、光标和选择范围变更事件的数据类型

依据

02

开始使用

  1. 获取代码仓库,通过 README 确认公开版本的开发状态和构成。
  2. 执行 just check 检查项目,并确认 LanguageEditor 与 TextContent 契约后集成到实现中。

请准备 Rust 和必要的开发工具,并在导入前通过链接的 README 确认环境要求。示例命令是功能入口,不保证在所有环境中运行。

依据
rust
use katana_language_editor::{LanguageEditor, TextContent};

pub fn set_markdown(editor: &mut impl LanguageEditor, markdown: &str) {
    editor.set_content(TextContent {
        text: markdown.to_owned(),
        language: Some("markdown".to_owned()),
    });
}

01 / KLE

使用场景

将编辑器实现与 UI 框架分开

中立 crate 提供 TextContent、CursorPosition、Selection、EditorEvent 和 LanguageEditor,让 KatanA 不直接依赖 egui 类型。即使替换输入 UI,也能保持宿主依赖的 trait 契约。

尝试使用 egui MVP 作为连接点

katana-language-editor-egui 接收 EditorConfig,绘制 egui TextEdit,并将内容更改发布到 ContentChanged 事件。公开版本是脚手架,Floem crate不是实现,而是依赖项和trait 实现的骨架。

02 / KLE

从输入到输出的流程

  1. 传递正文和设置

    宿主在 TextContent 中设置正文和 language,并通过 EditorConfig 配置字体大小、行号、自动换行和 tab 宽度。EguiLanguageEditor::set_content 替换当前正文。

  2. 将 UI 输入转换为事件

    当检测到 egui TextEdit response.changed() 时,实现会将当前 TextContent 作为 EditorEvent::ContentChanged 放入待处理队列中。中立的crate不会将 egui 的 Response 类型泄露给公开合约。

  3. 宿主收集事件

    宿主使用 LanguageEditor::poll_events() 检索事件并使用 content() 读取正文。由于public egui MVP中的cursor()返回默认的CursorPosition,因此实际的光标同步和选择协调不能被视为已完成的功能。

03 / KLE

主要 API 与 CLI

TextContent — 文本内容
TextContent 的 text 是正文,language 是任意语言标识符。它以 framework-neutral 数据保留 Markdown 等输入。
光标位置和选择
CursorPosition 有 line 和 column,Selection 有 start 和 end 范围。公开类型虽然存在,但 egui MVP 尚未实现返回真实 cursor。
EditorConfig — 编辑器配置
EditorConfig 指定 font_size、line_numbers、word_wrap、tab_size。在 egui 实现中它用于计算 visible rows,但不代表完整编辑功能。
语言编辑器和编辑器事件
LanguageEditor 的 content、set_content、cursor 和 poll_events 是与 host 的 trait 契约。EditorEvent 定义了 ContentChanged、CursorMoved 和 SelectionChanged。

04 / KLE

通过示例理解

将 Markdown 主体设置为 egui MVP

此代码示例在 EditorConfig 中创建显示设置,将 TextContent 设置为 EguiLanguageEditor,并读取文本。并入实屏的宿主每帧调用show(ui),并在输入后添加处理以poll_events()收集ContentChanged。

rust
use katana_language_editor::{EditorConfig, LanguageEditor, TextContent};
use katana_language_editor_egui::EguiLanguageEditor;

fn main() {
    let mut editor = EguiLanguageEditor::new(EditorConfig {
        font_size: Some(14.0),
        line_numbers: true,
        word_wrap: true,
        tab_size: 4,
    });
    editor.set_content(TextContent {
        text: "# KatanA\n".to_owned(),
        language: Some("markdown".to_owned()),
    });
    println!("{}", editor.content().text);
}

05 / KLE

集成条件与职责边界

先依赖中立 crate

KatanA 和其他宿主引用 katana-language-editor 的trait 和 DTO,并且特定于 UI 的包被分离为适配器。正如自述文件中所设计的,我们的政策是即使从 egui 转移到自定义输入界面时也保持对宿主端的中立依赖。

在脚手架范围内接受

公开的 README 清楚地说明了 Scaffolding 并解释了 Floem 在 v0.1.0 中仍将是一个可编译的框架。在引入时,我们将针对正文设置和ContentChanged连接,并将光标/选择和完成编辑操作视为未实现的风险。

依据

内容基于调查时点的公开代码仓库。可通过链接中的固定提交确认实现和使用方法。

代码仓库阅读指南be313bf428fc
依据 · KLE
全部产品