chore: remove call sites from ARCHITECTURE.md

This commit is contained in:
Loric ANDRE 2026-09-05 18:50:32 +02:00
parent ade829872b
commit 106f9f883a
2 changed files with 0 additions and 60 deletions

View file

@ -34,7 +34,6 @@
- Changing the threading model or synchronization primitives
- Adding or removing public API surface (`SkimItem`, `SkimOptions`, `SkimOutput`, etc.)
- Changing the event/action system or key binding infrastructure
- Keep call-site line numbers in the cross-reference table up to date when the referenced functions move.
## Testing

View file

@ -1317,65 +1317,6 @@ The global allocator is `mimalloc` (v3), chosen for its low-latency multi-thread
---
## Important Call Sites (Cross-Reference)
| Call site | File | What it does |
| --- | --- | --- |
| `Skim::run_with` | `src/skim.rs:72` | Top-level library entry point |
| `Skim::run_items` | `src/skim.rs:114` | Convenience wrapper for iterator inputs |
| `Skim::init_tui` | `src/skim.rs:138` | Initialize default crossterm TUI backend |
| `Skim::init` | `src/skim.rs:159` | Constructs all subsystems from options |
| `Skim::start` | `src/skim.rs:203` | Starts reader + initial matcher pass |
| `Skim::handle_reload` | `src/skim.rs:235` | Kills reader, clears pool, restarts |
| `Skim::init_tui_with` | `src/skim.rs:307` | Install a caller-provided TUI backend |
| `Skim::enter` | `src/skim.rs:394` | Enter terminal, resolve image picker, start listener/event pump |
| `Skim::should_enter` | `src/skim.rs:438` | Filter/select-1/exit-0/sync gate |
| `Skim::output` | `src/skim.rs:563` | Collect & return SkimOutput |
| `Skim::tick` | `src/skim.rs:644` | Single async event loop iteration |
| `App::from_options` | `src/tui/app.rs:291` | Build all widgets from options |
| `App::run_preview` | `src/tui/app.rs:507` | Expand cmd, debounce, call Preview::spawn |
| `App::handle_event` | `src/tui/app.rs:632` | Dispatch all Event variants |
| `App::handle_action` | `src/tui/app.rs:837` | Apply action follow-up bindings |
| `App::dispatch_conditional` | `src/tui/app.rs:856` | Dispatch the selected conditional subaction chain without follow-up bindings |
| `App::dispatch_action` | `src/tui/app.rs:879` | Dispatch one Action variant without follow-up bindings |
| `Tui::run_execute` | `src/tui/backend.rs:363` | Suspend reader, run `execute` child with its own tty stdin, restart reader |
| `App::restart_matcher` | `src/tui/app.rs:1378` | Kill old match pass, start new one |
| `App::expand_cmd` | `src/tui/app.rs:1465` | Substitute `{}`, `{q}`, `{n}` etc. |
| `App::handle_mouse` | `src/tui/app.rs:1533` | Handle mouse behavior and emit `double-click` |
| `Widget::render (App)` | `src/tui/app.rs:152` | Root render; calls all sub-widgets |
| `Matcher::run` | `src/matcher.rs:294` | Parallel match dispatch |
| `merge_worker_results` | `src/matcher.rs:36` | Merge k sorted runs → ProcessedItems |
| `ItemPool::append` | `src/item.rs:469` | Add items, notify matcher |
| `ItemPool::take` | `src/item.rs:502` | Take un-matched items for matcher |
| `DefaultSkimItem::new` | `src/helper/item.rs:64` | ANSI strip, field transform, matching ranges (hidden ranges set later via `hidden_fields` builder) |
| `SkimItemReader::parallel_bufread` | `src/helper/item_reader.rs:284` | Unified parallel pipeline (all inputs) |
| `spawn_io_reader` | `src/helper/item_reader.rs:380` | I/O reader thread: chunk reads + line splitting |
| `spawn_reorder_thread` | `src/helper/item_reader.rs:485` | Reorder thread: ordered output + pipeline-done signal |
| `Preview::spawn` | `src/tui/preview.rs:371` | Start image, PTY, or plain preview worker |
| `Tui::new_with_height_and_backend` | `src/tui/backend.rs:81` | Terminal init + viewport sizing |
| `Tui::enter` | `src/tui/backend.rs:134` | Enable raw mode + terminal setup |
| `Tui::start` | `src/tui/backend.rs:235` | Spawn crossterm EventStream task (fresh cancellation token each call) |
| `Tui::stop_and_join` | `src/tui/backend.rs:221` | Cancel event pump and block until `EventStream` is dropped (before `execute`) |
| `Tui::force_full_redraw` | `src/tui/backend.rs:202` | Reset ratatui diff buffers for a full repaint with no cursor query (after `execute`) |
| `Tui::min_height` | `src/tui/backend.rs:400` | Grow an inline viewport and scroll the terminal when needed |
| `popup::run_with` | `src/popup/mod.rs:86` | Delegate to multiplexer popup + parse output |
| `popup::check_env` | `src/popup/mod.rs:72` | Guard: multiplexer present and not already in popup |
| `check_and_run_popup` | `src/bin/main.rs:131` | Check popup conditions, dispatch to popup::run_with |
| `sk_main` | `src/bin/main.rs:144` | CLI orchestration + output printing |
| `SkimEvent` | `src/binds.rs:25` | Bindable synthetic events, including `double-click`, routed through reserved `KeyEvent`s |
| `parse_key` | `src/binds.rs:226` | `"ctrl-a"``KeyEvent` |
| `parse_action_binds` | `src/binds.rs:335` | `"reload:first"`, `"act-up:suppress+down"` → action follow-up map |
| `parse_action_chain` | `src/binds.rs:383` | `"down+select"``Vec<Action>` |
| `Action::name` | `src/tui/actions.rs:254` | `Action` → canonical bind name (generated from the `define_action_catalog!` list that also defines the `Action` enum and `parse_action`) |
| `Matcher::create_engine_factory_with_builder` | `src/matcher.rs:189` | Build engine factory chain from options |
| `ExactOrFuzzyEngineFactory::create_engine_with_case` | `src/engine/factory.rs:93` | Parse query prefixes, build engine |
| `AndOrEngineFactory::parse_andor` | `src/engine/factory.rs:176` | Split query into AND/OR tree |
| `FuzzyEngine::match_item` | `src/engine/fuzzy.rs:175` | Fuzzy match a single item |
| `LayoutTemplate::from_options` | `src/tui/layout.rs:76` | Compute widget constraint tree |
| `LayoutTemplate::apply` | `src/tui/layout.rs:165` | Split Rect into AppLayout |
| `ItemRenderer::render_item` | `src/tui/item_renderer.rs:84` | Full per-item render pipeline |
| `ColorTheme::init_from_options` | `src/theme.rs:56` | Parse `--color` spec |
---
## Public Library API