Base e ferramentas

KatanA Language Editor

Interface de editor Rust independente de framework para texto, cursor e seleção. A versão pública está na fase de construção da base.

Responsáveis por desenvolver a experiência de edição e as funções de linguagem do KatanA

01

Funções implementadas

Interface comum para obter e definir texto e gerenciar a posição do cursor

Fontes

Tipos de dados para cursor e seleção expressos por linha e coluna

Fontes

Tipos de dados para eventos de alteração do texto, cursor e seleção

Fontes

02

Primeiros passos

  1. Obtenha o repositório e consulte o README para conhecer o estado de desenvolvimento e a estrutura da versão pública.
  2. Execute just check para inspecionar o projeto, confira os contratos de LanguageEditor e TextContent e integre-os à implementação.

Prepare Rust e as ferramentas de desenvolvimento necessárias e consulte o README indicado para os requisitos antes da integração. Os exemplos são pontos de entrada e não garantem funcionamento em todos os ambientes.

Fontes
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

Casos de uso

Separar o editor do UI framework

O crate neutral oferece TextContent, CursorPosition, Selection, EditorEvent e LanguageEditor sem depender de framework, criando uma fronteira sem tipos egui no host KatanA. A UI pode mudar sem quebrar o trait usado pelo host.

Experimentar o egui MVP como adaptador

katana-language-editor-egui recebe EditorConfig, desenha egui TextEdit e acumula alterações como ContentChanged. A versão pública é scaffolding; Floem é apenas esqueleto de dependência e trait, não uma implementação concluída.

02 / KLE

Fluxo da entrada à saída

  1. Passar texto e configuração

    Configure text e language em TextContent e font size, line numbers, word wrap e tab size em EditorConfig. EguiLanguageEditor::set_content substitui o texto atual.

  2. Transformar input da UI em evento

    Quando egui TextEdit indicar response.changed(), a implementação coloca o TextContent atual como EditorEvent::ContentChanged na pending queue. O crate neutral não vaza o tipo egui Response para o contrato público.

  3. O host coleta os eventos

    O host chama LanguageEditor::poll_events() para retirar eventos e content() para ler o texto. No MVP egui público, cursor() retorna CursorPosition default; não trate sincronização real de cursor ou selection como recurso concluído.

03 / KLE

APIs e CLI principais

TextContent — Conteúdo do texto
text é o corpo e language é um identificador opcional. Markdown e outros conteúdos ficam como dados framework-neutral.
CursorPosition e Selection
CursorPosition tem line e column; Selection tem os intervalos start e end. Os tipos públicos existem, mas o MVP egui ainda não devolve o cursor real.
EditorConfig — Configuração do editor
Define font_size, line_numbers, word_wrap e tab_size. A implementação egui usa-os para calcular visible rows; não representam todo o conjunto de recursos de edição.
LanguageEditor e EditorEvent
content, set_content, cursor e poll_events formam o trait com o host. ContentChanged, CursorMoved e SelectionChanged são os tipos de evento definidos.

04 / KLE

Entenda com um exemplo

Configurar o egui MVP com Markdown

O exemplo cria EditorConfig, instancia EguiLanguageEditor, define TextContent Markdown e lê o texto atual. O host de uma tela real precisa chamar show(ui) a cada frame e coletar ContentChanged com 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

Integração e limites

Manter o crate neutral como dependência

KatanA ou outro host referencia os traits e DTOs de katana-language-editor; o crate específico da UI fica separado como adapter. Mesmo trocando egui por custom input surface, preserve a dependência neutral no host.

Aceitar o escopo de scaffolding

O README público marca o projeto como Scaffolding e explica que Floem fica em skeleton compilável no v0.1.0. Integre texto e ContentChanged; trate cursor/selection e edição completa como riscos ainda não implementados.

Fontes

Apresentação baseada nos repositórios públicos disponíveis no momento da pesquisa. A implementação e os passos podem ser conferidos no commit fixado do link.

RepositórioLeia-mebe313bf428fc
Fontes · KLE
Todos os produtos