基盤・ツール

KatanA Language Editor

テキスト・カーソル・選択範囲を扱う、フレームワーク中立のRustエディタインターフェースです。公開版は基盤の構築段階です。

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 frameworkから分離する

公開neutral crateはTextContent、CursorPosition、Selection、EditorEvent、LanguageEditorを提供し、KatanA側がegui型を直接持たない境界を作ります。入力UIを差し替えても、ホストが依存するtrait面を維持できます。

egui MVPを接続点として試す

katana-language-editor-eguiはEditorConfigを受け取り、egui TextEditを描画して内容変更をContentChangedイベントへ積みます。公開版はscaffoldingであり、Floem crateは実装ではなく依存関係とtrait実装の骨組みです。

02 / KLE

入力から出力までの流れ

  1. 本文と設定を渡す

    ホストはTextContentに本文とlanguageを設定し、EditorConfigでfont size、line numbers、word wrap、tab sizeを指定します。EguiLanguageEditor::set_contentが現在の本文を置き換えます。

  2. UI入力をイベントへ変換する

    egui TextEditのresponse.changed()を検出すると、実装は現在のTextContentをEditorEvent::ContentChangedとしてpending queueへ積みます。neutral crateはeguiのResponse型を公開契約へ漏らしません。

  3. ホストがイベントを回収する

    ホストはLanguageEditor::poll_events()でイベントを取り出し、content()で本文を読みます。公開egui MVPのcursor()はdefault CursorPositionを返すため、実際のcursor同期やselection連携を完成機能として扱えません。

03 / KLE

主要API・CLIの使い分け

TextContent
textが本文、languageが任意の言語識別子です。Markdownなどの入力をframework-neutralなデータとして保持します。
CursorPositionとSelection
CursorPositionはlineとcolumn、Selectionはstartとendの範囲を持ちます。公開型は存在しますが、egui MVPが実cursorを返すことまでは実装されていません。
EditorConfig
font_size、line_numbers、word_wrap、tab_sizeを指定します。egui実装ではvisible rowsの計算に使われますが、完成した編集機能全体を表す設定ではありません。
LanguageEditorとEditorEvent
content、set_content、cursor、poll_eventsがhostとのtrait契約です。ContentChanged、CursorMoved、SelectionChangedがイベント型として定義されています。

04 / KLE

具体例で理解する

egui MVPへMarkdown本文を設定する

このコード例が実行するのはEditorConfigで表示設定を作り、EguiLanguageEditorへTextContentを設定して本文を読むところまでです。実画面へ組み込むhostは毎フレーム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

組み込み条件と責務の境界

neutral crateを先に依存する

KatanAや別hostはkatana-language-editorのtraitとDTOを参照し、UI固有crateはadapterとして分離します。READMEが示す設計どおり、eguiからcustom input surfaceへ移る場合もhost側の中立依存を維持する方針です。

scaffoldingの範囲で受け入れる

公開READMEはScaffoldingと明記し、Floemはv0.1.0ではcompile可能なskeletonに留まると説明しています。導入時は本文設定とContentChangedの接続を対象にし、cursor/selectionや完全な編集操作は未実装リスクとして扱います。

根拠

調査時点の公開リポジトリに基づく紹介です。リンク先の固定コミットで実装と手順を確認できます。

リポジトリREADMEbe313bf428fc
根拠 · KLE
すべての製品