# antonio-olvera-dev/edit architecture

> Architecture diagram of the GitHub repository antonio-olvera-dev/edit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/antonio-olvera-dev/edit
- Repository: https://github.com/antonio-olvera-dev/edit

## Overview

##### Project type and purpose
- From the file tree and README, this is “Edit,” a cross-platform, terminal-based text editor written in Rust.
- It’s primarily a single-binary CLI/TUI application that provides MS-DOS–style editing with modern controls.

##### File structure
- Top-level Cargo.toml/Cargo.lock: the Rust package manifest for library and binary.
- src/lib.rs + src/…: core library modules (buffer, arena, unicode, simd, fuzzy search, hashing, path, etc.).
- src/bin/edit: the executable entry point and UI components (draw_editor, draw_filepicker, draw_menubar, draw_statusbar), state management, localization.
- src/sys: platform-specific abstractions (unix.rs, windows.rs).
- src/tui.rs + src/framebuffer.rs + src/vt.rs: terminal rendering and virtual terminal support.
- tools/grapheme-table-gen: an auxiliary codegen tool for grapheme cluster tables.
- benches/: performance benchmarks on core lib.
- build.rs: build-time code generation hook.

##### Extract insights from the README
- Core functionality: simple text editing in terminal.
- Modern interface mixed with classic behavior.
- Rust nightly features for codegen (RUSTC_BOOTSTRAP, build.rs).

##### Main components & interactions
a. Components
- “edit” executable (src/bin/edit)
- Core library (src/* modules)
- Platform layer (src/sys)
- Terminal rendering (src/tui, framebuffer, vt)
- Input handling (src/input)
- Buffer & text model (src/buffer, src/arena, src/document)
- Unicode & grapheme support (src/unicode, tools/grapheme-table-gen)
- Codegen & build (build.rs, tools/)
b. Relationships & data flows
- User keystroke → Input module → State machine (state.rs) → Buffer/Document → Renderer → Terminal
- Core business logic (buffer edits, navigation) is fully in the core library.
- Platform abstraction resolves file I/O, clipboard, terminal capabilities.
- build.rs ↔ tools/grapheme-table-gen generates unicode tables at compile time.
- Benchmarks import the core library directly.
c. Architectural patterns & principles
- Clear separation of concerns: library vs. executable vs. platform vs. tools.
- Modular design: each subsystem in its own folder.
- Compile-time codegen for performance (simd optimizations, unicode tables).
- Single-process monolithic TUI architecture.
d. Key technologies & libraries
- Rust (stable + nightly features)
- Custom TUI/VT implementation (no third-party TUI crate)
- SIMD modules for performance
- Cargo build scripts and codegen

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Executable Layer
    subgraph "Executable: edit" 
        direction TB
        Main["main.rs"]:::ui
        DrawEditor["draw_editor.rs"]:::ui
        DrawFilepicker["draw_filepicker.rs"]:::ui
        DrawMenubar["draw_menubar.rs"]:::ui
        DrawStatusbar["draw_statusbar.rs"]:::ui
        State["state.rs"]:::ui
        Documents["documents.rs"]:::ui
        Localization["localization.rs"]:::ui
    end

    %% Core Library Layer
    subgraph "Core Library" 
        direction TB
        BufferDocument["Buffer & Document\n(buffer, arena, document)"]:::coreLib
        UtilityModules["Utility Modules\n(helpers, hash, base64, icu, oklab, path, fuzzy, cell)"]:::coreLib
    end

    %% Platform Abstraction Layer
    subgraph "Platform Layer" 
        direction TB
        SysMod["mod.rs"]:::platform
        Unix["unix.rs"]:::platform
        Windows["windows.rs"]:::platform
    end

    %% Rendering Layer
    subgraph "Rendering & VT" 
        direction TB
        TUI["tui.rs"]:::ui
        Framebuffer["framebuffer.rs"]:::ui
        VT["vt.rs"]:::ui
    end

    %% Input Handling
    Input["input.rs"]:::ui

    %% Unicode & Grapheme Support
    subgraph "Unicode & Grapheme" 
        direction TB
        UnicodeMod["mod.rs"]:::coreLib
        Measurement["measurement.rs"]:::coreLib
        UTF8["utf8.rs"]:::coreLib
        Tables["tables.rs"]:::coreLib
    end

    %% SIMD Optimizations
    subgraph "SIMD Optimizations" 
        direction TB
        SIMDMod["mod.rs"]:::coreLib
        LinesBwd["lines_bwd.rs"]:::coreLib
        LinesFwd["lines_fwd.rs"]:::coreLib
        Memchr2["memchr2.rs"]:::coreLib
        Memset["memset.rs"]:::coreLib
    end

    %% Build-time Code Generation
    subgraph "Build & Codegen Tools" 
        direction TB
        BuildRS["build.rs"]:::build
        GraphemeTool["tools/grapheme-table-gen"]:::build
    end

    %% Assets
    Assets["assets/"]:::build

    %% Benchmarks
    Benchmarks["benches/lib.rs"]:::build

    %% Runtime Flow
    Input -->|keystroke| State
    State -->|update model| BufferDocument
    BufferDocument -->|render data| TUI
    TUI --> Framebuffer
    Framebuffer --> VT
    VT -->|Terminal I/O| Terminal[/"Terminal"/]:::ui

    %% Platform Flow
    BufferDocument --> SysMod
    VT --> SysMod
    SysMod --> Unix
    SysMod --> Windows

    %% Codegen Flow
    GraphemeTool -.->|generate rules| BuildRS
    BuildRS -.->|produce tables.rs| Tables

    %% Benchmark Flow
    Benchmarks --> BufferDocument

    %% Click Events
    click Main "https://github.com/antonio-olvera-dev/edit/blob/main/src/bin/edit/main.rs"
    click DrawEditor "https://github.com/antonio-olvera-dev/edit/blob/main/src/bin/edit/draw_editor.rs"
    click DrawFilepicker "https://github.com/antonio-olvera-dev/edit/blob/main/src/bin/edit/draw_filepicker.rs"
    click DrawMenubar "https://github.com/antonio-olvera-dev/edit/blob/main/src/bin/edit/draw_menubar.rs"
    click DrawStatusbar "https://github.com/antonio-olvera-dev/edit/blob/main/src/bin/edit/draw_statusbar.rs"
    click State "https://github.com/antonio-olvera-dev/edit/blob/main/src/bin/edit/state.rs"
    click Documents "https://github.com/antonio-olvera-dev/edit/blob/main/src/bin/edit/documents.rs"
    click Localization "https://github.com/antonio-olvera-dev/edit/blob/main/src/bin/edit/localization.rs"
    click BufferDocument "https://github.com/antonio-olvera-dev/edit/blob/main/src/buffer/mod.rs"
    click UtilityModules "https://github.com/antonio-olvera-dev/edit/blob/main/src/helpers.rs"
    click SysMod "https://github.com/antonio-olvera-dev/edit/blob/main/src/sys/mod.rs"
    click Unix "https://github.com/antonio-olvera-dev/edit/blob/main/src/sys/unix.rs"
    click Windows "https://github.com/antonio-olvera-dev/edit/blob/main/src/sys/windows.rs"
    click TUI "https://github.com/antonio-olvera-dev/edit/blob/main/src/tui.rs"
    click Framebuffer "https://github.com/antonio-olvera-dev/edit/blob/main/src/framebuffer.rs"
    click VT "https://github.com/antonio-olvera-dev/edit/blob/main/src/vt.rs"
    click Input "https://github.com/antonio-olvera-dev/edit/blob/main/src/input.rs"
    click UnicodeMod "https://github.com/antonio-olvera-dev/edit/blob/main/src/unicode/mod.rs"
    click Measurement "https://github.com/antonio-olvera-dev/edit/blob/main/src/unicode/measurement.rs"
    click UTF8 "https://github.com/antonio-olvera-dev/edit/blob/main/src/unicode/utf8.rs"
    click Tables "https://github.com/antonio-olvera-dev/edit/blob/main/src/unicode/tables.rs"
    click GraphemeTool "https://github.com/antonio-olvera-dev/edit/tree/main/tools/grapheme-table-gen/"
    click BuildRS "https://github.com/antonio-olvera-dev/edit/blob/main/build.rs"
    click SIMDMod "https://github.com/antonio-olvera-dev/edit/blob/main/src/simd/mod.rs"
    click LinesBwd "https://github.com/antonio-olvera-dev/edit/blob/main/src/simd/lines_bwd.rs"
    click LinesFwd "https://github.com/antonio-olvera-dev/edit/blob/main/src/simd/lines_fwd.rs"
    click Memchr2 "https://github.com/antonio-olvera-dev/edit/blob/main/src/simd/memchr2.rs"
    click Memset "https://github.com/antonio-olvera-dev/edit/blob/main/src/simd/memset.rs"
    click Assets "https://github.com/antonio-olvera-dev/edit/tree/main/assets/"
    click Benchmarks "https://github.com/antonio-olvera-dev/edit/blob/main/benches/lib.rs"

    %% Styles
    classDef coreLib fill:#D0E8FF,stroke:#0366D6,color:#0366D6;
    classDef ui fill:#E6F4EA,stroke:#22863A,color:#22863A;
    classDef platform fill:#FFF5B1,stroke:#DBAB09,color:#735C0F;
    classDef build fill:#F0F0F0,stroke:#6A737D,color:#6A737D;
```
