How securitytrip/birchpad works
Birchpad is a cross-platform desktop text editor. The principal workflow begins with a user launching the app or passing files on the command line; the app creates and manages a workspace, where users open and edit documents, search, and save. The documented runtime also includes configurable settings and keymaps, encoding support, visual layout, single-instance hand-off, and update checks. Source excerpts clarify some app-level dispatch and rendering relationships; other package connections below rely on the README’s package descriptions or are left unasserted where wiring was not shown.
Main entry points: main.rs App entry · workspace.rs Workspace · buffer.rs Document buffer · mod.rs Editor view
Components 21
Desktop application
- App entry
crates/app/src/main.rs - Workspace
crates/app/src/workspace.rs - Find and replace
crates/app/src/find.rs - File operations
crates/app/src/file_ops.rs - Encoding controls
crates/app/src/encoding_ui.rs
Document and view
- Document buffer
crates/app/src/buffer.rs - Editor view
crates/app/src/editor/mod.rs - Text document
crates/core/src/document.rs - Display layout
crates/view/src/display_map.rs - Character cells
crates/view/src/cells.rs - Word wrap
crates/view/src/wrap.rs
Configuration and I/O
- File I/O
crates/io/src/file.rs - Decode and detect
crates/io/src/decode.rs - Encoding catalog
crates/io/src/encoding.rs - Settings layers
crates/config/src/layers.rs
Commands and launch
- Command registry
crates/app/src/commands.rs - Command catalog
crates/commands/src/catalog.rs - CLI arguments
crates/cli/src/args.rs - Instance hand-off
crates/cli/src/instance.rs
Updates
- Update checks
crates/update/src/lib.rs
Other components
- User
Connections 20
- User → App entry: launches
README.md - App entry → CLI arguments: parses arguments
crates/app/src/main.rs - App entry → Instance hand-off: starts instance
crates/app/src/main.rs - App entry → Settings layers: loads settings
crates/app/src/main.rs - App entry → Workspace: opens workspace
crates/app/src/main.rs - Workspace → File operations: routes file actions
crates/app/src/workspace.rs - Workspace → Document buffer: manages buffers
crates/app/src/workspace.rs - Workspace → Editor view: manages views
crates/app/src/workspace.rs - Workspace → Command registry: dispatches commands
crates/app/src/workspace.rs - Command registry → Command catalog: uses command data
crates/app/src/commands.rs - Editor view → Display layout: uses layout
crates/app/src/editor/mod.rs - Editor view → Document buffer: shows buffer
crates/app/src/editor/mod.rs - Find and replace → Text document: searches document
crates/app/src/find.rs - Display layout → Character cells: uses cell metrics
crates/view/src/display_map.rs - Display layout → Word wrap: uses wrapping
crates/view/src/display_map.rs - File operations → Document buffer: operates on buffers
crates/app/src/file_ops.rs - Encoding controls → Document buffer: reloads buffer
crates/app/src/encoding_ui.rs - File I/O → Decode and detect: reads through
crates/io/src/file.rs - Decode and detect → Encoding catalog: uses encoding rules
crates/io/src/decode.rs - App entry → Update checks: installs update checks
crates/app/src/main.rs