# takashiidobe/nassau architecture

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

- Interactive diagram: https://gitdiagram.com/takashiidobe/nassau
- Repository: https://github.com/takashiidobe/nassau

## Overview

Nassau is a work-in-progress Standard ML implementation offering native Cranelift compilation, a portable interpreter, persistent REPLs, and a browser playground. The main workflow accepts SML through the CLI or REPL, lexes and parses it, performs static checks and type inference, lowers typed syntax to core IR, then executes it through the interpreter or compiles it to native code. Structures, signatures, and functors are handled during inference and lowering. Edges are limited to README statements and source-index references; unsampled implementation details are not asserted.

Main entry points: [`src/main.rs`](https://github.com/takashiidobe/nassau/blob/main/src/main.rs) (CLI), [`src/session.rs`](https://github.com/takashiidobe/nassau/blob/main/src/session.rs) (Session orchestration), [`src/parser.rs`](https://github.com/takashiidobe/nassau/blob/main/src/parser.rs) (SML parser), [`src/lower.rs`](https://github.com/takashiidobe/nassau/blob/main/src/lower.rs) (Core lowering)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interface["User interfaces"]
  node_cli["CLI<br/>[main.rs]"]
  node_repl["Persistent REPL<br/>[repl.rs]"]
  node_browser["Browser playground<br/>[worker.js]"]
  node_web["Web session adapter<br/>[web.rs]"]
  node_session["Session orchestration<br/>[session.rs]"]
end

subgraph group_language["Language front end"]
  node_lexer["Lexer<br/>[lexer.rs]"]
  node_parser["SML parser<br/>[parser.rs]"]
  node_syntax["Syntax utilities<br/>[constructors.rs]"]
end

subgraph group_semantics["Static semantics"]
  node_checks["Scope and match checks<br/>[matching.rs]"]
  node_inference["Type inference<br/>[infer.rs]"]
  node_modules["Module inference<br/>[modules.rs]"]
  node_lowering["Core lowering<br/>[lower.rs]"]
  node_decision["Pattern decision lowering<br/>[decision.rs]"]
end

subgraph group_execution["Execution backends"]
  node_core["Core IR<br/>[core.rs]"]
  node_codegen["Cranelift codegen<br/>[codegen.rs]"]
  node_interpreter["Portable interpreter<br/>[interpreter.rs]"]
  node_runtime["Native runtime<br/>[runtime.rs]"]
  node_values["Value representation<br/>[value.rs]"]
end

node_user(("SML user"))

node_user -->|"submits SML"| node_cli
node_user -->|"enters programs"| node_repl
node_user -->|"uses playground"| node_browser
node_cli -->|"parses input"| node_lexer
node_parser -->|"reads tokens"| node_lexer
node_cli -->|"parses input"| node_parser
node_parser -->|"builds syntax"| node_syntax
node_cli -->|"checks matches"| node_checks
node_cli -->|"checks types"| node_inference
node_inference -->|"consumes syntax"| node_parser
node_inference -->|"delegates modules"| node_modules
node_lowering -->|"uses inferred types"| node_inference
node_lowering -->|"lowers syntax"| node_parser
node_lowering -->|"delegates decisions"| node_decision
node_lowering -->|"produces IR"| node_core
node_cli -->|"compiles natively"| node_codegen
node_codegen -->|"compiles IR"| node_core
node_codegen -->|"uses runtime"| node_runtime
node_codegen -->|"uses representation"| node_values
node_cli -->|"runs portable backend"| node_interpreter
node_interpreter -->|"executes IR"| node_core
node_interpreter -->|"represents values"| node_values
node_repl -->|"uses native backend"| node_codegen
node_repl -->|"uses runtime"| node_runtime
node_repl -.->|"maintains session"| node_session
node_session -->|"parses chunks"| node_parser
node_session -->|"checks types"| node_inference
node_session -->|"lowers program"| node_lowering
node_session -->|"executes module"| node_core
node_session -->|"supports backend"| node_interpreter
node_web -->|"wraps session"| node_session
node_browser -.->|"connects playground"| node_web

click node_cli "https://github.com/takashiidobe/nassau/blob/main/src/main.rs"
click node_repl "https://github.com/takashiidobe/nassau/blob/main/src/repl.rs"
click node_browser "https://github.com/takashiidobe/nassau/blob/main/www/frontend/worker.js"
click node_web "https://github.com/takashiidobe/nassau/blob/main/src/web.rs"
click node_lexer "https://github.com/takashiidobe/nassau/blob/main/src/lexer.rs"
click node_parser "https://github.com/takashiidobe/nassau/blob/main/src/parser.rs"
click node_syntax "https://github.com/takashiidobe/nassau/blob/main/src/constructors.rs"
click node_checks "https://github.com/takashiidobe/nassau/blob/main/src/matching.rs"
click node_inference "https://github.com/takashiidobe/nassau/blob/main/src/infer.rs"
click node_modules "https://github.com/takashiidobe/nassau/blob/main/src/infer/modules.rs"
click node_lowering "https://github.com/takashiidobe/nassau/blob/main/src/lower.rs"
click node_decision "https://github.com/takashiidobe/nassau/blob/main/src/lower/decision.rs"
click node_core "https://github.com/takashiidobe/nassau/blob/main/src/core.rs"
click node_codegen "https://github.com/takashiidobe/nassau/blob/main/src/codegen.rs"
click node_interpreter "https://github.com/takashiidobe/nassau/blob/main/src/interpreter.rs"
click node_runtime "https://github.com/takashiidobe/nassau/blob/main/src/runtime.rs"
click node_values "https://github.com/takashiidobe/nassau/blob/main/src/value.rs"
click node_session "https://github.com/takashiidobe/nassau/blob/main/src/session.rs"

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_cli,node_repl,node_browser,node_web,node_session,node_user toneBlue
class node_lexer,node_parser,node_syntax toneAmber
class node_checks,node_inference,node_modules,node_lowering,node_decision toneMint
class node_core,node_codegen,node_interpreter,node_runtime,node_values toneRose
```

## Components

### User interfaces

- [CLI](https://github.com/takashiidobe/nassau/blob/main/src/main.rs): `src/main.rs`
- [Persistent REPL](https://github.com/takashiidobe/nassau/blob/main/src/repl.rs): `src/repl.rs`
- [Browser playground](https://github.com/takashiidobe/nassau/blob/main/www/frontend/worker.js): `www/frontend/worker.js`
- [Web session adapter](https://github.com/takashiidobe/nassau/blob/main/src/web.rs): `src/web.rs`
- [Session orchestration](https://github.com/takashiidobe/nassau/blob/main/src/session.rs): `src/session.rs`

### Language front end

- [Lexer](https://github.com/takashiidobe/nassau/blob/main/src/lexer.rs): `src/lexer.rs`
- [SML parser](https://github.com/takashiidobe/nassau/blob/main/src/parser.rs): `src/parser.rs`
- [Syntax utilities](https://github.com/takashiidobe/nassau/blob/main/src/constructors.rs): `src/constructors.rs`

### Static semantics

- [Scope and match checks](https://github.com/takashiidobe/nassau/blob/main/src/matching.rs): `src/matching.rs`
- [Type inference](https://github.com/takashiidobe/nassau/blob/main/src/infer.rs): `src/infer.rs`
- [Module inference](https://github.com/takashiidobe/nassau/blob/main/src/infer/modules.rs): `src/infer/modules.rs`
- [Core lowering](https://github.com/takashiidobe/nassau/blob/main/src/lower.rs): `src/lower.rs`
- [Pattern decision lowering](https://github.com/takashiidobe/nassau/blob/main/src/lower/decision.rs): `src/lower/decision.rs`

### Execution backends

- [Core IR](https://github.com/takashiidobe/nassau/blob/main/src/core.rs): `src/core.rs`
- [Cranelift codegen](https://github.com/takashiidobe/nassau/blob/main/src/codegen.rs): `src/codegen.rs`
- [Portable interpreter](https://github.com/takashiidobe/nassau/blob/main/src/interpreter.rs): `src/interpreter.rs`
- [Native runtime](https://github.com/takashiidobe/nassau/blob/main/src/runtime.rs): `src/runtime.rs`
- [Value representation](https://github.com/takashiidobe/nassau/blob/main/src/value.rs): `src/value.rs`

### Other components

- **SML user**

## Connections

- SML user → CLI: submits SML (evidence: `README.md`)
- SML user → Persistent REPL: enters programs (evidence: `README.md`)
- SML user → Browser playground: uses playground (evidence: `README.md`)
- CLI → Lexer: parses input (evidence: `src/main.rs`)
- SML parser → Lexer: reads tokens (evidence: `src/parser.rs`)
- CLI → SML parser: parses input (evidence: `src/main.rs`)
- SML parser → Syntax utilities: builds syntax (evidence: `src/constructors.rs`)
- CLI → Scope and match checks: checks matches (evidence: `src/main.rs`)
- CLI → Type inference: checks types (evidence: `src/main.rs`)
- Type inference → SML parser: consumes syntax (evidence: `src/infer.rs`)
- Type inference → Module inference: delegates modules (evidence: `src/infer/modules.rs`)
- Core lowering → Type inference: uses inferred types (evidence: `src/lower.rs`)
- Core lowering → SML parser: lowers syntax (evidence: `src/lower.rs`)
- Core lowering → Pattern decision lowering: delegates decisions (evidence: `src/lower.rs`)
- Core lowering → Core IR: produces IR (evidence: `src/lower.rs`)
- CLI → Cranelift codegen: compiles natively (evidence: `src/main.rs`)
- Cranelift codegen → Core IR: compiles IR (evidence: `src/codegen.rs`)
- Cranelift codegen → Native runtime: uses runtime (evidence: `src/codegen.rs`)
- Cranelift codegen → Value representation: uses representation (evidence: `src/codegen.rs`)
- CLI → Portable interpreter: runs portable backend (evidence: `README.md`)
- Portable interpreter → Core IR: executes IR (evidence: `src/interpreter.rs`)
- Portable interpreter → Value representation: represents values (evidence: `src/interpreter.rs`)
- Persistent REPL → Cranelift codegen: uses native backend (evidence: `src/repl.rs`)
- Persistent REPL → Native runtime: uses runtime (evidence: `src/repl.rs`)
- Persistent REPL → Session orchestration: maintains session
- Session orchestration → SML parser: parses chunks (evidence: `src/session.rs`)
- Session orchestration → Type inference: checks types (evidence: `src/session.rs`)
- Session orchestration → Core lowering: lowers program (evidence: `src/session.rs`)
- Session orchestration → Core IR: executes module (evidence: `src/session.rs`)
- Session orchestration → Portable interpreter: supports backend (evidence: `src/session.rs`)
- Web session adapter → Session orchestration: wraps session (evidence: `src/web.rs`)
- Browser playground → Web session adapter: connects playground
