Base e strumenti

KatanA Language Editor

Interfaccia editor Rust indipendente dal framework per testo, cursore e selezione. La versione pubblica è nella fase di costruzione della base.

Responsabili dello sviluppo dell'esperienza di modifica e delle funzioni linguistiche di KatanA

01

Funzioni implementate

Interfaccia comune per ottenere e impostare il testo e gestire la posizione del cursore

Fonti

Tipi di dati per cursore e selezione espressi tramite riga e colonna

Fonti

Tipi di dati per gli eventi di modifica del testo, del cursore e della selezione

Fonti

02

Per iniziare

  1. Ottieni il repository e consulta il README per conoscere lo stato di sviluppo e la struttura della versione pubblica.
  2. Esegui just check per ispezionare il progetto, verifica i contratti di LanguageEditor e TextContent e integrali nell'implementazione.

Prepara Rust e gli strumenti di sviluppo necessari e consulta il README collegato per i requisiti prima dell'integrazione. Gli esempi sono punti di partenza e non garantiscono il funzionamento in ogni ambiente.

Fonti
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

Casi d'uso

Separare l’editor dal framework UI

Il crate neutral pubblico offre TextContent, CursorPosition, Selection, EditorEvent e LanguageEditor e crea un confine in cui KatanA non conserva direttamente tipi egui. Anche sostituendo la UI input, il trait surface usato dall’host resta invariato.

Provare egui come punto di connessione MVP

katana-language-editor-egui riceve EditorConfig, disegna egui TextEdit e accoda le modifiche come evento ContentChanged. La versione pubblica è scaffolding; il crate Floem è una struttura di dipendenze e trait, non un’implementazione completa.

02 / KLE

Flusso da input a output

  1. Passare contenuto e configurazione

    L’host imposta testo e language in TextContent e specifica font size, line numbers, word wrap e tab size in EditorConfig. EguiLanguageEditor::set_content sostituisce il contenuto corrente.

  2. Convertire l’input UI in eventi

    Quando viene rilevato egui TextEdit response.changed(), l’implementazione accoda il TextContent corrente come EditorEvent::ContentChanged nella pending queue. Il crate neutral non espone il tipo egui Response nel contratto pubblico.

  3. Recuperare gli eventi nell’host

    L’host preleva gli eventi con LanguageEditor::poll_events() e legge il testo con content(). cursor() dell’MVP egui pubblico restituisce un CursorPosition default; non presentarlo come sincronizzazione reale del cursore o della selection.

03 / KLE

API e CLI principali

TextContent — Contenuto del testo
text è il contenuto e language è un identificatore di linguaggio opzionale. Conserva input come Markdown in dati framework-neutral.
CursorPosition e Selection
CursorPosition possiede line e column; Selection possiede gli intervalli start e end. I tipi pubblici esistono, ma l’MVP egui non implementa la restituzione del cursore reale.
EditorConfig — Impostazioni dell’editor
Specifica font_size, line_numbers, word_wrap e tab_size. Nell’implementazione egui serve al calcolo delle visible rows, ma non rappresenta l’intera funzionalità di editing completata.
LanguageEditor e EditorEvent
content, set_content, cursor e poll_events sono il trait contract con l’host. Gli event type definiti sono ContentChanged, CursorMoved e SelectionChanged.

04 / KLE

Capire con un esempio

Impostare contenuto Markdown nell’MVP egui

L’esempio crea EditorConfig, imposta TextContent su EguiLanguageEditor e legge il contenuto. L’host che lo integra in una schermata deve chiamare show(ui) a ogni frame e recuperare ContentChanged con poll_events() dopo l’input.

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

Integrazione e limiti

Dipendere prima dal crate neutral

KatanA o un altro host deve riferirsi a trait e DTO di katana-language-editor e separare il crate UI-specifico come adapter. Come nel design del README, passando da egui a una custom input surface si mantiene la dipendenza neutral sul lato host.

Accettare l’ambito scaffolding

Il README pubblico dichiara Scaffolding e spiega che Floem in v0.1.0 resta uno skeleton compilabile. Integrazione iniziale: contenuto e ContentChanged; cursor/selection e operazioni di editing complete restano rischi non implementati.

Fonti

Presentazione basata sui repository pubblici disponibili al momento della ricerca. Implementazione e procedure sono verificabili nel commit fissato del link.

Archivio del codiceLeggimibe313bf428fc
Fonti · KLE
Tutti i prodotti