# lramseyer/vaporview architecture

> Architecture diagram of the GitHub repository lramseyer/vaporview, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lramseyer/vaporview
- Repository: https://github.com/lramseyer/vaporview

## Overview

Vaporview is a VS Code waveform-viewer extension. Its main workflow opens a waveform, parses its netlist and values, presents signals in a navigable tree, and renders selected signals in an interactive timeline. Users can search, customize signals, navigate with markers, and integrate through terminal links, the public API, WCP, or remote viewing. The graph includes documented format and integration branches; edges supported only by README-level descriptions are cited there, and unsampled implementation details are not inferred.

Main entry points: [`src/webview/vaporview.ts`](https://github.com/lramseyer/vaporview/blob/main/src/webview/vaporview.ts) (Viewer Application), [`src/extension_core/viewer_provider.ts`](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/viewer_provider.ts) (Viewer Provider), [`src/extension_core/document.ts`](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/document.ts) (Waveform Document), [`src/webview/row_handler.ts`](https://github.com/lramseyer/vaporview/blob/main/src/webview/row_handler.ts) (Signal Rows)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_extension["VS Code Extension"]
  node_activation["Extension Activation<br/>[extension.ts]"]
  node_commands["Commands<br/>[commands.ts]"]
  node_provider["Viewer Provider<br/>[viewer_provider.ts]"]
  node_document["Waveform Document<br/>[document.ts]"]
  node_tree["Netlist Tree<br/>[tree_view.ts]"]
end

subgraph group_parsing["Waveform Parsing"]
  node_wellen["Native Formats<br/>[lib.rs]"]
  node_fsdb["FSDB Handler<br/>[fsdb_handler.ts]"]
  node_fsdbworker["FSDB Worker<br/>[fsdb_worker.ts]"]
  node_fsdbnative["FSDB Reader<br/>[fsdb_reader.cpp]"]
  node_remote["Remote Viewer<br/>[surfer_handler.ts]"]
end

subgraph group_viewer["Waveform Viewer"]
  node_webapp["Viewer Application<br/>[vaporview.ts]"]
  node_events["Interaction Events<br/>[event_handler.ts]"]
  node_rows["Signal Rows<br/>[row_handler.ts]"]
  node_signals["Signal Models<br/>[signal_item.ts]"]
  node_data["Waveform Data<br/>[data_manager.ts]"]
  node_viewport["Timeline Viewport<br/>[viewport.ts]"]
  node_renderer["Waveform Renderer<br/>[renderer.ts]"]
  node_labels["Signal Labels<br/>[labels.ts]"]
  node_controls["Viewer Controls<br/>[control_bar.ts]"]
  node_format["Value Formatting<br/>[value_format.ts]"]
end

subgraph group_integration["Integrations"]
  node_terminal["Terminal Links<br/>[terminal_links.ts]"]
  node_api["Extension API<br/>[index.ts]"]
  node_wcp["Waveform Control Protocol<br/>[wcp_server.ts]"]
end

node_user(("VS Code User"))
node_otherext(("Other Extensions"))
node_surferserver["Surfer Server"]

node_user -->|"opens extension"| node_activation
node_activation -->|"registers commands"| node_commands
node_commands -->|"opens viewer"| node_provider
node_provider -->|"creates document"| node_document
node_document -.->|"parses supported dumps"| node_wellen
node_document -->|"handles FSDB"| node_fsdb
node_fsdb -->|"dispatches tasks"| node_fsdbworker
node_fsdbworker -.->|"uses native reader"| node_fsdbnative
node_document -->|"provides netlist"| node_tree
node_provider -.->|"hosts webview"| node_webapp
node_webapp -->|"uses interactions"| node_events
node_webapp -->|"uses row manager"| node_rows
node_rows -->|"creates signal items"| node_signals
node_rows -->|"reads waveform data"| node_data
node_webapp -->|"initializes manager"| node_data
node_webapp -->|"uses viewport"| node_viewport
node_webapp -->|"creates labels"| node_labels
node_webapp -->|"creates controls"| node_controls
node_viewport -->|"uses renderer"| node_renderer
node_signals -->|"formats values"| node_format
node_user -->|"follows terminal links"| node_terminal
node_terminal -->|"controls viewer"| node_provider
node_otherext -->|"uses commands and events"| node_api
node_otherext -->|"controls waveform"| node_wcp
node_provider -.->|"supports protocol control"| node_wcp
node_user -->|"opens remote waveform"| node_remote
node_remote -->|"connects remotely"| node_surferserver

click node_activation "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/extension.ts"
click node_commands "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/commands.ts"
click node_provider "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/viewer_provider.ts"
click node_document "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/document.ts"
click node_tree "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/tree_view.ts"
click node_terminal "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/terminal_links.ts"
click node_wellen "https://github.com/lramseyer/vaporview/blob/main/src/wellen_parser/lib.rs"
click node_fsdb "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/fsdb_handler.ts"
click node_fsdbworker "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/fsdb_worker.ts"
click node_fsdbnative "https://github.com/lramseyer/vaporview/blob/main/src/fsdb_reader.cpp"
click node_remote "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/surfer_handler.ts"
click node_webapp "https://github.com/lramseyer/vaporview/blob/main/src/webview/vaporview.ts"
click node_events "https://github.com/lramseyer/vaporview/blob/main/src/webview/event_handler.ts"
click node_rows "https://github.com/lramseyer/vaporview/blob/main/src/webview/row_handler.ts"
click node_signals "https://github.com/lramseyer/vaporview/blob/main/src/webview/signal_item.ts"
click node_data "https://github.com/lramseyer/vaporview/blob/main/src/webview/data_manager.ts"
click node_viewport "https://github.com/lramseyer/vaporview/blob/main/src/webview/viewport.ts"
click node_renderer "https://github.com/lramseyer/vaporview/blob/main/src/webview/renderer.ts"
click node_labels "https://github.com/lramseyer/vaporview/blob/main/src/webview/labels.ts"
click node_controls "https://github.com/lramseyer/vaporview/blob/main/src/webview/control_bar.ts"
click node_format "https://github.com/lramseyer/vaporview/blob/main/src/webview/value_format.ts"
click node_api "https://github.com/lramseyer/vaporview/blob/main/packages/vaporview-api/index.ts"
click node_wcp "https://github.com/lramseyer/vaporview/blob/main/src/extension_core/wcp_server.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_activation,node_commands,node_provider,node_document,node_tree,node_user toneBlue
class node_wellen,node_fsdb,node_fsdbworker,node_fsdbnative,node_remote toneAmber
class node_webapp,node_events,node_rows,node_signals,node_data,node_viewport,node_renderer,node_labels,node_controls,node_format,node_surferserver toneMint
class node_terminal,node_api,node_wcp toneRose
class node_otherext toneIndigo
```

## Components

### VS Code Extension

- [Extension Activation](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/extension.ts): `src/extension_core/extension.ts`
- [Commands](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/commands.ts): `src/extension_core/commands.ts`
- [Viewer Provider](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/viewer_provider.ts): `src/extension_core/viewer_provider.ts`
- [Waveform Document](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/document.ts): `src/extension_core/document.ts`
- [Netlist Tree](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/tree_view.ts): `src/extension_core/tree_view.ts`

### Waveform Parsing

- [Native Formats](https://github.com/lramseyer/vaporview/blob/main/src/wellen_parser/lib.rs): `src/wellen_parser/lib.rs`
- [FSDB Handler](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/fsdb_handler.ts): `src/extension_core/fsdb_handler.ts`
- [FSDB Worker](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/fsdb_worker.ts): `src/extension_core/fsdb_worker.ts`
- [FSDB Reader](https://github.com/lramseyer/vaporview/blob/main/src/fsdb_reader.cpp): `src/fsdb_reader.cpp`
- [Remote Viewer](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/surfer_handler.ts): `src/extension_core/surfer_handler.ts`

### Waveform Viewer

- [Viewer Application](https://github.com/lramseyer/vaporview/blob/main/src/webview/vaporview.ts): `src/webview/vaporview.ts`
- [Interaction Events](https://github.com/lramseyer/vaporview/blob/main/src/webview/event_handler.ts): `src/webview/event_handler.ts`
- [Signal Rows](https://github.com/lramseyer/vaporview/blob/main/src/webview/row_handler.ts): `src/webview/row_handler.ts`
- [Signal Models](https://github.com/lramseyer/vaporview/blob/main/src/webview/signal_item.ts): `src/webview/signal_item.ts`
- [Waveform Data](https://github.com/lramseyer/vaporview/blob/main/src/webview/data_manager.ts): `src/webview/data_manager.ts`
- [Timeline Viewport](https://github.com/lramseyer/vaporview/blob/main/src/webview/viewport.ts): `src/webview/viewport.ts`
- [Waveform Renderer](https://github.com/lramseyer/vaporview/blob/main/src/webview/renderer.ts): `src/webview/renderer.ts`
- [Signal Labels](https://github.com/lramseyer/vaporview/blob/main/src/webview/labels.ts): `src/webview/labels.ts`
- [Viewer Controls](https://github.com/lramseyer/vaporview/blob/main/src/webview/control_bar.ts): `src/webview/control_bar.ts`
- [Value Formatting](https://github.com/lramseyer/vaporview/blob/main/src/webview/value_format.ts): `src/webview/value_format.ts`

### Integrations

- [Terminal Links](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/terminal_links.ts): `src/extension_core/terminal_links.ts`
- [Extension API](https://github.com/lramseyer/vaporview/blob/main/packages/vaporview-api/index.ts): `packages/vaporview-api/index.ts`
- [Waveform Control Protocol](https://github.com/lramseyer/vaporview/blob/main/src/extension_core/wcp_server.ts): `src/extension_core/wcp_server.ts`

### Other components

- **VS Code User**
- **Other Extensions**
- **Surfer Server**

## Connections

- VS Code User → Extension Activation: opens extension (evidence: `README.md`)
- Extension Activation → Commands: registers commands (evidence: `src/extension_core/extension.ts`)
- Commands → Viewer Provider: opens viewer (evidence: `src/extension_core/commands.ts`)
- Viewer Provider → Waveform Document: creates document (evidence: `src/extension_core/viewer_provider.ts`)
- Waveform Document → Native Formats: parses supported dumps (evidence: `README.md`)
- Waveform Document → FSDB Handler: handles FSDB (evidence: `src/extension_core/document.ts`)
- FSDB Handler → FSDB Worker: dispatches tasks (evidence: `src/extension_core/fsdb_handler.ts`)
- FSDB Worker → FSDB Reader: uses native reader
- Waveform Document → Netlist Tree: provides netlist (evidence: `src/extension_core/document.ts`)
- Viewer Provider → Viewer Application: hosts webview (evidence: `README.md`)
- Viewer Application → Interaction Events: uses interactions (evidence: `src/webview/vaporview.ts`)
- Viewer Application → Signal Rows: uses row manager (evidence: `src/webview/vaporview.ts`)
- Signal Rows → Signal Models: creates signal items (evidence: `src/webview/row_handler.ts`)
- Signal Rows → Waveform Data: reads waveform data (evidence: `src/webview/row_handler.ts`)
- Viewer Application → Waveform Data: initializes manager (evidence: `src/webview/vaporview.ts`)
- Viewer Application → Timeline Viewport: uses viewport (evidence: `src/webview/vaporview.ts`)
- Viewer Application → Signal Labels: creates labels (evidence: `src/webview/vaporview.ts`)
- Viewer Application → Viewer Controls: creates controls (evidence: `src/webview/vaporview.ts`)
- Timeline Viewport → Waveform Renderer: uses renderer (evidence: `src/webview/viewport.ts`)
- Signal Models → Value Formatting: formats values (evidence: `src/webview/signal_item.ts`)
- VS Code User → Terminal Links: follows terminal links (evidence: `README.md`)
- Terminal Links → Viewer Provider: controls viewer (evidence: `src/extension_core/terminal_links.ts`)
- Other Extensions → Extension API: uses commands and events (evidence: `README.md`)
- Other Extensions → Waveform Control Protocol: controls waveform (evidence: `README.md`)
- Viewer Provider → Waveform Control Protocol: supports protocol control (evidence: `README.md`)
- VS Code User → Remote Viewer: opens remote waveform (evidence: `README.md`)
- Remote Viewer → Surfer Server: connects remotely (evidence: `README.md`)
