docs/parser/architecture.md
The Enso parser is designed in a highly modular fashion, with separate crates responsible for the component's various responsibilities. The overall architecture for the parser is described in this document.
<!-- MarkdownTOC levels="2,3" autolink="true" --> <!-- /MarkdownTOC -->The overall architecture of the parser subsystem can be visualised as follows.
┌───────────────┐
│ Source Code │
└───────────────┘
│
│
▽
┌─────────────────────────────────────────────────────────────────────────┐
│ ┌──────────────┐ Parser │
│ │ UTF-X Reader │ │
│ └──────────────┘ │
│ │ │
│ │ Character │
│ │ Stream │
│ ▽ │
│ ┌────────┐ │
│ │ Lexer │ │
│ │┌──────┐│ │
│ ││Flexer││ │
│ │└──────┘│ │
│ └────────┘ │
│ │ │
│ │ Structured │
│ │ Token Stream │
│ ▽ │
│ ┌────────────┐ ┌────────────┐ ┌────────────┐ │
│ │ │ │ │ │ │ │
│ │ Macro │ Rust AST │ Operator │ Rust AST │ Construct │ │
│ │ Resolution │─────────────▷│ Resolution │─────────────▷│ Resolution │ │
│ │ │ │ │ │ │ │
│ └────────────┘ └────────────┘ └────────────┘ │
│ │ │
│ Rust AST │ │
│ ▽ │
│ ┌────────────┐ │
│ │ AST Output │ │
│ └────────────┘ │
└─────────────────────────────────────────────────────────────────────────┘
│
┌───────────────┤ Rust AST
▽ │
┌────────────┐ │
│ │ │
│ JVM Object │ └─────────────────┐
│ Generator │ │
│ │ │
└────────────┘ │
│ │
JVM AST │ │
▽ ▽
┌────────────┐ ┌────────────┐
│ │ │ │
│ Use in JVM │ │ Direct Use │
│ Code │ │in Rust Code│
│ │ │ │
└────────────┘ └────────────┘