Basis / Tool
KatanA Language Editor
Eine framework-neutrale Rust-Editor-Schnittstelle für Text, Cursorpositionen und Auswahlen. Die öffentliche Version befindet sich noch im Aufbau der Grundlage.
Entwickler, die an KatanA-Bearbeitung und Sprachfunktionen arbeiten
01
Implementierte Fähigkeiten
02
Erste Schritte
- Holen Sie das Repository und prüfen Sie den öffentlichen Entwicklungsstand und die Struktur im README.
- Führen Sie just check aus und prüfen Sie anschließend die Verträge von LanguageEditor und TextContent vor der Integration.
Bereiten Sie Rust und die erforderlichen Entwicklungstools vor und prüfen Sie vor der Installation die Umgebungsanforderungen im verknüpften README. Beispiele zeigen einen Einstieg und garantieren keinen Betrieb in jeder Umgebung.
Belegeuse 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
Anwendungsfälle
Separate Editor-Implementierung vom UI-Framework
Das öffentliche framework-neutrale Crate stellt TextContent, CursorPosition, Selection, EditorEvent und LanguageEditor bereit und schafft eine Grenze, an der die KatanA-Seite keine egui-Typen direkt verwendet. Auch bei einem Austausch der Eingabeoberfläche bleibt die vom Host benötigte Trait-Schnittstelle erhalten.
Probieren Sie egui MVP als Verbindungspunkt aus
katana-language-editor-egui nimmt EditorConfig entgegen, zeichnet ein egui TextEdit und legt Inhaltsänderungen als ContentChanged-Ereignis ab. Die veröffentlichte Version ist Scaffolding; das Floem-Crate ist keine Implementierung, sondern ein Gerüst aus Abhängigkeiten und Trait-Implementierungen.
02 / KLE
Ablauf von Eingabe zu Ausgabe
Übergeben Sie den Körper und die Einstellungen
Der Host legt den Textkörper und die Sprache in TextContent fest und gibt in EditorConfig die Schriftgröße, Zeilennummern, den Zeilenumbruch und die Tabulatorgröße an. EguiLanguageEditor::set_content ersetzt den aktuellen Text.
Konvertieren Sie UI-Eingaben in Ereignisse
Wenn response.changed() von egui TextEdit erkannt wird, legt die Implementierung den aktuellen TextContent als EditorEvent::ContentChanged in die pending queue. Das framework-neutrale Crate gibt den egui-Response-Typ nicht in den öffentlichen Vertrag weiter.
Der Gastgeber sammelt Ereignisse
Der Host ruft Ereignisse mit LanguageEditor::poll_events() ab und liest den Text mit content(). Da cursor() im öffentlichen egui MVP eine Default-CursorPosition zurückgibt, dürfen tatsächliche Cursor-Synchronisierung und Selection-Verknüpfung nicht als fertiggestellt behandelt werden.
03 / KLE
Wichtige APIs und CLI
TextContent — Textinhalt- text ist der Textkörper und language ein beliebiger Sprachbezeichner. Eingaben wie Markdown werden als framework-neutrale Daten gehalten.
CursorPosition und Selection- CursorPosition enthält line und column, Selection enthält start und end. Die öffentlichen Typen existieren, aber das egui MVP liefert noch keinen echten Cursor.
EditorConfig — Editor-Einstellungen- Geben Sie font_size, line_numbers, word_wrap und tab_size an. Diese Werte werden in der egui-Implementierung zur Berechnung sichtbarer Zeilen verwendet, bilden aber nicht die vollständige Editierfunktion ab.
LanguageEditor und EditorEvent- content, set_content, cursor und poll_events bilden den Trait-Vertrag mit dem Host. ContentChanged, CursorMoved und SelectionChanged sind als Ereignistypen definiert.
04 / KLE
An einem Beispiel verstehen
Markdown-Body auf egui MVP setzen
Dieses Codebeispiel erstellt Anzeigeeinstellungen in EditorConfig, legt TextContent auf EguiLanguageEditor fest und liest den Text. Der Host, der in den realen Bildschirm integriert werden soll, ruft show(ui) für jeden Frame auf und fügt nach der Eingabe eine Verarbeitung zum Sammeln von ContentChanged mit poll_events() hinzu.
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
Integration und Grenzen
Zuerst das neutrale Crate verwenden
KatanA und andere Hosts beziehen sich auf die Traits und DTOs von katana-language-editor; UI-spezifische Crates bleiben als Adapter getrennt. Wie in der README beschrieben, bleibt die Abhängigkeit des Hosts neutral, auch wenn von egui zu einer benutzerdefinierten Eingabeoberfläche gewechselt wird.
Akzeptieren Sie im Rahmen des Gerüstbaus
Die öffentliche README bezeichnet den Umfang als Scaffolding und erklärt, dass Floem in v0.1.0 ein kompilierbares Skelett bleibt. Bei der Einführung konzentrieren wir uns auf das Setzen des Textes und die ContentChanged-Verbindung; Cursor-/Selection-Synchronisierung und vollständige Editierfunktionen gelten als nicht implementierte Risiken.
Belege
Diese Übersicht basiert auf den öffentlichen Repositories zum Zeitpunkt der Prüfung. Implementierung und Nutzung können in den verknüpften fixierten Commits geprüft werden.