Base y herramientas

KatanA Language Editor

Interfaz de editor Rust independiente del framework para texto, cursor y selección. La versión pública está en fase de construcción de la base.

Responsables de desarrollar la experiencia de edición y las funciones de lenguaje de KatanA

01

Funciones implementadas

Interfaz común para obtener y establecer texto y gestionar la posición del cursor

Fuentes

Tipos de datos para el cursor y la selección expresados mediante fila y columna

Fuentes

Tipos de datos para eventos de cambio del texto, el cursor y la selección

Fuentes

02

Primeros pasos

  1. Obtenga el repositorio y consulte el README para conocer el estado de desarrollo y la estructura de la versión pública.
  2. Ejecute just check para inspeccionar el proyecto, compruebe los contratos de LanguageEditor y TextContent e intégrelos en su implementación.

Prepare Rust y las herramientas de desarrollo necesarias y consulte el README enlazado para conocer los requisitos antes de integrar. Los ejemplos son puntos de entrada y no garantizan el funcionamiento en todos los entornos.

Fuentes
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 el editor del framework UI

El crate neutral publica TextContent, CursorPosition, Selection, EditorEvent y LanguageEditor, creando un límite donde KatanA no depende directamente de tipos egui. El host conserva la superficie trait aunque cambie la UI de entrada.

Probar egui MVP como punto de conexión

katana-language-editor-egui recibe EditorConfig, dibuja egui TextEdit y convierte response.changed() en ContentChanged. La versión pública es scaffolding; Floem solo aporta la estructura de dependencia y trait, no una implementación terminada.

02 / KLE

Flujo de entrada a salida

  1. Pasar contenido y configuración

    El host configura texto y language en TextContent, y font size, line numbers, word wrap y tab size en EditorConfig. EguiLanguageEditor::set_content sustituye el texto actual.

  2. Convertir input UI en eventos

    Cuando egui TextEdit informa response.changed(), la implementación coloca el TextContent actual en la pending queue como EditorEvent::ContentChanged. El crate neutral no expone egui Response en el contrato público.

  3. Recoger eventos desde el host

    El host extrae eventos con LanguageEditor::poll_events() y lee el texto con content(). El cursor() del MVP egui devuelve CursorPosition default, por lo que cursor real y selection sync todavía no son funciones terminadas.

03 / KLE

APIs y CLI principales

TextContent — Contenido del texto
text contiene el cuerpo y language un identificador opcional de lenguaje. Conserva entradas como Markdown en datos framework-neutral.
CursorPosition y Selection
CursorPosition tiene line y column; Selection tiene los rangos start y end. Los tipos públicos existen, pero el egui MVP aún no devuelve el cursor real.
EditorConfig — Configuración del editor
Especifica font_size, line_numbers, word_wrap y tab_size. La implementación egui los usa para calcular visible rows, pero no representan todo un editor terminado.
LanguageEditor y EditorEvent
content, set_content, cursor y poll_events forman el contrato trait con el host. Los eventos definidos son ContentChanged, CursorMoved y SelectionChanged.

04 / KLE

Entender con un ejemplo

Establecer contenido Markdown en el MVP de egui

Cree EditorConfig, establezca TextContent en EguiLanguageEditor y lea el contenido. Un host real debe llamar a show(ui) en cada frame y a poll_events() después de la entrada para recoger ContentChanged; el fragmento solo configura y lee el contenido.

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

Integración y límites

Depender primero del crate neutral

KatanA y otros host deben referenciar los trait y DTO de katana-language-editor, dejando el crate específico de UI como adapter. Al pasar de egui a una superficie de input propia, conserve la dependencia neutral del host.

Aceptar el alcance de scaffolding

El README público indica Scaffolding y describe Floem en v0.1.0 como skeleton compilable. Integre texto y ContentChanged, y trate cursor/selection y la edición completa como riesgos aún no implementados.

Fuentes

Presentación basada en los repositorios públicos disponibles en el momento de la investigación. La implementación y los pasos se pueden comprobar en el commit fijado del enlace.

RepositorioLéamebe313bf428fc
Fuentes · KLE
Todos los productos