Base / outil

KatanA Language Editor

Une interface d'éditeur Rust neutre vis-à-vis du framework pour le texte, les positions du curseur et les sélections. La version publique est encore au stade de fondation.

Développeurs qui travaillent sur l'édition et les fonctions linguistiques de KatanA

01

Capacités implémentées

Interface commune pour lire et définir le texte et gérer les positions du curseur

Références

Types de données pour les positions de curseur et les sélections exprimées en ligne et colonne

Références

Types de données représentant les événements de modification du contenu, du curseur et de la sélection

Références

02

Premiers pas

  1. Récupérez le dépôt et vérifiez son état de développement public et sa structure dans le README.
  2. Lancez just check, puis examinez les contrats de LanguageEditor et TextContent avant l'intégration.

Préparez Rust et les outils de développement nécessaires, puis consultez le README lié pour les prérequis avant l'installation. Les exemples indiquent un point de départ et ne garantissent pas le fonctionnement dans tous les environnements.

Références
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

Cas d'utilisation

Séparer les contrats d'éditeur du framework UI

Le crate neutral fournit TextContent, CursorPosition, Selection, EditorEvent et LanguageEditor. KatanA n'expose ainsi pas directement les types egui ; le host peut changer de surface d'entrée en conservant le trait dont il dépend.

Essayer la connexion MVP egui

katana-language-editor-egui reçoit EditorConfig, dessine un egui TextEdit et met en queue ContentChanged quand la réponse change. La version publique est un scaffolding ; Floem reste un squelette de dépendance et d'implémentation de traits.

02 / KLE

Flux entrée-sortie

  1. Définir contenu et configuration

    Définissez le texte et language dans TextContent, puis font size, line numbers, word wrap et tab size dans EditorConfig. EguiLanguageEditor::set_content remplace le contenu courant.

  2. Transformer l'entrée UI en événements

    Quand egui TextEdit signale response.changed(), l'implémentation met le TextContent courant en queue comme EditorEvent::ContentChanged. Le crate neutral n'expose pas egui Response dans son contrat.

  3. Récupérer les événements dans le host

    Le host appelle LanguageEditor::poll_events() et lit le texte avec content(). Le MVP egui renvoie un CursorPosition par défaut avec cursor() ; la synchronisation réelle du curseur et la sélection ne sont pas achevées.

03 / KLE

API et CLI principales

TextContent — Contenu textuel
Stocke text et l'identifiant de language facultatif comme données d'éditeur framework-neutral, notamment pour Markdown.
CursorPosition et Selection
CursorPosition porte line et column ; Selection porte start et end. Ces types publics existent, mais le MVP egui renvoie encore un curseur par défaut et pas une position réelle.
EditorConfig — Réglages de l’éditeur
Configure font_size, line_numbers, word_wrap et tab_size pour egui. Cela règle les lignes visibles et TextEdit, sans constituer toute la configuration d'édition.
LanguageEditor et EditorEvent
Le contrat host comprend content, set_content, cursor et poll_events ; EditorEvent définit ContentChanged, CursorMoved et SelectionChanged, sans promettre que le MVP émet chacun d'eux.

04 / KLE

Comprendre par un exemple

Configurer un éditeur egui MVP avec du Markdown

Le code construit EditorConfig, crée EguiLanguageEditor, lui affecte un TextContent Markdown et lit le texte courant. Il ne montre pas une saisie complète : le host doit appeler show(ui) à chaque frame et récupérer ContentChanged avec poll_events().

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

Intégration et limites

Dépendre d'abord du crate neutral

KatanA ou un autre host dépend des traits et DTO de katana-language-editor et garde les crates UI derrière des adapters. Un changement d'egui vers une surface custom remplace l'adapter, pas la dépendance neutre.

Accepter la frontière scaffolding

Le README public indique Scaffolding et décrit Floem comme skeleton compilable en v0.1.0. Intégrez d'abord le texte et ContentChanged ; traitez curseur, sélection et édition complète comme risques non implémentés.

Références

Cette présentation repose sur les dépôts publics au moment de l'examen. Vérifiez l'implémentation et l'utilisation dans les commits figés liés.

DépôtFichier READMEbe313bf428fc
Références · KLE
Tous les produits