# pemistahl/grex architecture

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

- Interactive diagram: https://gitdiagram.com/pemistahl/grex
- Repository: https://github.com/pemistahl/grex

## Overview

grex is a Rust library and command-line utility that generates a Perl-compatible regular expression guaranteed to match its supplied test cases. The main workflow is to provide cases and options, build a configured regular expression, and render it; the README also documents Python and WebAssembly interfaces. The graph includes the documented CLI path, but its implementation wiring is not visible in the sampled main.rs references, so that connection is marked unverified. Internal algorithm links follow sampled imports; unsampled implementation details are not inferred.

Main entry points: [`src/lib.rs`](https://github.com/pemistahl/grex/blob/main/src/lib.rs) (Rust API), [`src/expression.rs`](https://github.com/pemistahl/grex/blob/main/src/expression.rs) (Regex expression), [`src/cluster.rs`](https://github.com/pemistahl/grex/blob/main/src/cluster.rs) (Grapheme clusters), [`src/format.rs`](https://github.com/pemistahl/grex/blob/main/src/format.rs) (Expression formatting)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_interfaces["User interfaces"]
  node_cli["CLI<br/>[main.rs]"]
  node_python["Python API<br/>[python.rs]"]
  node_wasm["WebAssembly API<br/>[wasm.rs]"]
  node_api["Rust API<br/>[lib.rs]"]
end

subgraph group_generation["Regex generation"]
  node_builder["Input builder<br/>[builder.rs]"]
  node_config["Generation options<br/>[config.rs]"]
  node_regexp["Regex generator<br/>[regexp.rs]"]
  node_dfa["DFA optimizer<br/>[dfa.rs]"]
  node_expression["Regex expression<br/>[expression.rs]"]
  node_substring["Substring rules<br/>[substring.rs]"]
end

subgraph group_unicode["Unicode processing"]
  node_cluster["Grapheme clusters<br/>[cluster.rs]"]
  node_grapheme["Grapheme units<br/>[grapheme.rs]"]
  node_char_range["Character ranges<br/>[char_range.rs]"]
  node_unicode_tables["Unicode classes"]
end

subgraph group_rendering["Regex rendering"]
  node_format["Expression formatting<br/>[format.rs]"]
  node_component["Regex components<br/>[component.rs]"]
  node_quantifier["Quantifiers<br/>[quantifier.rs]"]
end

node_user(("User"))

node_user -->|"provides cases"| node_cli
node_cli -.->|"submits cases"| node_builder
node_user -->|"uses library"| node_api
node_api -->|"exposes builder"| node_builder
node_python -->|"uses builder"| node_builder
node_wasm -->|"uses builder"| node_builder
node_builder -->|"configures"| node_config
node_builder -->|"builds expression"| node_regexp
node_regexp -->|"reads options"| node_config
node_regexp -->|"creates clusters"| node_cluster
node_regexp -->|"optimizes cases"| node_dfa
node_regexp -->|"builds AST"| node_expression
node_expression -->|"uses clusters"| node_cluster
node_expression -->|"reads options"| node_config
node_expression -->|"uses automaton"| node_dfa
node_expression -->|"uses graphemes"| node_grapheme
node_expression -->|"uses quantifiers"| node_quantifier
node_expression -->|"handles substrings"| node_substring
node_cluster -->|"checks ranges"| node_char_range
node_cluster -->|"reads options"| node_config
node_cluster -->|"groups graphemes"| node_grapheme
node_cluster -->|"uses character classes"| node_unicode_tables
node_grapheme -->|"renders components"| node_component
node_format -->|"uses ranges"| node_char_range
node_format -->|"formats clusters"| node_cluster
node_format -->|"formats components"| node_component
node_format -->|"formats expressions"| node_expression
node_format -->|"formats quantifiers"| node_quantifier
node_api -->|"exports options"| node_config
node_api -->|"exports generator"| node_regexp
node_api -->|"exports formatting"| node_format
node_api -->|"exports types"| node_cluster
node_api -->|"exports types"| node_component
node_api -->|"exports types"| node_dfa
node_api -->|"exports types"| node_expression
node_api -->|"exports types"| node_grapheme
node_api -->|"exports types"| node_quantifier
node_api -->|"exports types"| node_substring
node_unicode_tables -.->|"defines tables"| node_unicode_tables

click node_cli "https://github.com/pemistahl/grex/blob/main/src/main.rs"
click node_python "https://github.com/pemistahl/grex/blob/main/src/python.rs"
click node_wasm "https://github.com/pemistahl/grex/blob/main/src/wasm.rs"
click node_api "https://github.com/pemistahl/grex/blob/main/src/lib.rs"
click node_builder "https://github.com/pemistahl/grex/blob/main/src/builder.rs"
click node_config "https://github.com/pemistahl/grex/blob/main/src/config.rs"
click node_regexp "https://github.com/pemistahl/grex/blob/main/src/regexp.rs"
click node_dfa "https://github.com/pemistahl/grex/blob/main/src/dfa.rs"
click node_expression "https://github.com/pemistahl/grex/blob/main/src/expression.rs"
click node_substring "https://github.com/pemistahl/grex/blob/main/src/substring.rs"
click node_cluster "https://github.com/pemistahl/grex/blob/main/src/cluster.rs"
click node_grapheme "https://github.com/pemistahl/grex/blob/main/src/grapheme.rs"
click node_char_range "https://github.com/pemistahl/grex/blob/main/src/char_range.rs"
click node_unicode_tables "https://github.com/pemistahl/grex/tree/main/src/unicode_tables"
click node_format "https://github.com/pemistahl/grex/blob/main/src/format.rs"
click node_component "https://github.com/pemistahl/grex/blob/main/src/component.rs"
click node_quantifier "https://github.com/pemistahl/grex/blob/main/src/quantifier.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_python,node_wasm,node_api,node_user toneBlue
class node_builder,node_config,node_regexp,node_dfa,node_expression,node_substring toneAmber
class node_cluster,node_grapheme,node_char_range,node_unicode_tables toneMint
class node_format,node_component,node_quantifier toneRose
```

## Components

### User interfaces

- [CLI](https://github.com/pemistahl/grex/blob/main/src/main.rs): `src/main.rs`
- [Python API](https://github.com/pemistahl/grex/blob/main/src/python.rs): `src/python.rs`
- [WebAssembly API](https://github.com/pemistahl/grex/blob/main/src/wasm.rs): `src/wasm.rs`
- [Rust API](https://github.com/pemistahl/grex/blob/main/src/lib.rs): `src/lib.rs`

### Regex generation

- [Input builder](https://github.com/pemistahl/grex/blob/main/src/builder.rs): `src/builder.rs`
- [Generation options](https://github.com/pemistahl/grex/blob/main/src/config.rs): `src/config.rs`
- [Regex generator](https://github.com/pemistahl/grex/blob/main/src/regexp.rs): `src/regexp.rs`
- [DFA optimizer](https://github.com/pemistahl/grex/blob/main/src/dfa.rs): `src/dfa.rs`
- [Regex expression](https://github.com/pemistahl/grex/blob/main/src/expression.rs): `src/expression.rs`
- [Substring rules](https://github.com/pemistahl/grex/blob/main/src/substring.rs): `src/substring.rs`

### Unicode processing

- [Grapheme clusters](https://github.com/pemistahl/grex/blob/main/src/cluster.rs): `src/cluster.rs`
- [Grapheme units](https://github.com/pemistahl/grex/blob/main/src/grapheme.rs): `src/grapheme.rs`
- [Character ranges](https://github.com/pemistahl/grex/blob/main/src/char_range.rs): `src/char_range.rs`
- [Unicode classes](https://github.com/pemistahl/grex/tree/main/src/unicode_tables): `src/unicode_tables`

### Regex rendering

- [Expression formatting](https://github.com/pemistahl/grex/blob/main/src/format.rs): `src/format.rs`
- [Regex components](https://github.com/pemistahl/grex/blob/main/src/component.rs): `src/component.rs`
- [Quantifiers](https://github.com/pemistahl/grex/blob/main/src/quantifier.rs): `src/quantifier.rs`

### Other components

- **User**

## Connections

- User → CLI: provides cases (evidence: `README.md`)
- CLI → Input builder: submits cases
- User → Rust API: uses library (evidence: `README.md`)
- Rust API → Input builder: exposes builder (evidence: `src/lib.rs`)
- Python API → Input builder: uses builder (evidence: `src/python.rs`)
- WebAssembly API → Input builder: uses builder (evidence: `src/wasm.rs`)
- Input builder → Generation options: configures (evidence: `src/builder.rs`)
- Input builder → Regex generator: builds expression (evidence: `src/builder.rs`)
- Regex generator → Generation options: reads options (evidence: `src/regexp.rs`)
- Regex generator → Grapheme clusters: creates clusters (evidence: `src/regexp.rs`)
- Regex generator → DFA optimizer: optimizes cases (evidence: `src/regexp.rs`)
- Regex generator → Regex expression: builds AST (evidence: `src/regexp.rs`)
- Regex expression → Grapheme clusters: uses clusters (evidence: `src/expression.rs`)
- Regex expression → Generation options: reads options (evidence: `src/expression.rs`)
- Regex expression → DFA optimizer: uses automaton (evidence: `src/expression.rs`)
- Regex expression → Grapheme units: uses graphemes (evidence: `src/expression.rs`)
- Regex expression → Quantifiers: uses quantifiers (evidence: `src/expression.rs`)
- Regex expression → Substring rules: handles substrings (evidence: `src/expression.rs`)
- Grapheme clusters → Character ranges: checks ranges (evidence: `src/cluster.rs`)
- Grapheme clusters → Generation options: reads options (evidence: `src/cluster.rs`)
- Grapheme clusters → Grapheme units: groups graphemes (evidence: `src/cluster.rs`)
- Grapheme clusters → Unicode classes: uses character classes (evidence: `src/cluster.rs`)
- Grapheme units → Regex components: renders components (evidence: `src/grapheme.rs`)
- Expression formatting → Character ranges: uses ranges (evidence: `src/format.rs`)
- Expression formatting → Grapheme clusters: formats clusters (evidence: `src/format.rs`)
- Expression formatting → Regex components: formats components (evidence: `src/format.rs`)
- Expression formatting → Regex expression: formats expressions (evidence: `src/format.rs`)
- Expression formatting → Quantifiers: formats quantifiers (evidence: `src/format.rs`)
- Rust API → Generation options: exports options (evidence: `src/lib.rs`)
- Rust API → Regex generator: exports generator (evidence: `src/lib.rs`)
- Rust API → Expression formatting: exports formatting (evidence: `src/lib.rs`)
- Rust API → Grapheme clusters: exports types (evidence: `src/lib.rs`)
- Rust API → Regex components: exports types (evidence: `src/lib.rs`)
- Rust API → DFA optimizer: exports types (evidence: `src/lib.rs`)
- Rust API → Regex expression: exports types (evidence: `src/lib.rs`)
- Rust API → Grapheme units: exports types (evidence: `src/lib.rs`)
- Rust API → Quantifiers: exports types (evidence: `src/lib.rs`)
- Rust API → Substring rules: exports types (evidence: `src/lib.rs`)
- Unicode classes → Unicode classes: defines tables
