# karlll/krisp architecture

> Architecture diagram of the GitHub repository karlll/krisp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/karlll/krisp
- Repository: https://github.com/karlll/krisp

## Overview

##### Main Components

a) REPL Layer (Top Level)
- REPL module (from repl/src/.../Repl.kt)
- This is the user interface component

b) Core Interpreter Layer (Middle Layer)
Following key components:
- TokenReader (Lexical Analysis)
- Evaluator (Evaluation Engine)
- Environment (Scope Management)
- Printer (Output Formatting)
- Types System
- Namespace Management

c) Runtime Layer (Bottom Layer)
- JVM Runtime
- Standard Library Functions

##### Component Relationships

- User Input → REPL
- REPL → TokenReader
- TokenReader → Evaluator
- Evaluator ↔ Environment
- Evaluator → Printer
- Printer → REPL Output

b) Dependency Relationships:
- How the Environment interacts with Namespaces
- How the Types system is used across components
- Macro expansion flow in the evaluation process

##### Specific Implementation Details

Architectural elements:
- Separation between the core interpreter (core/) and the REPL interface (repl/)
- Macro system's integration
- Where special forms are handled
- Relationship with the testing framework

- REPL      |

- ↓

- Token Reader  |
- Evaluator    |
- Environment   |
- Printer     |

- ↓

- JVM Runtime   |

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and classes
    classDef repl fill:#90EE90,stroke:#333,stroke-width:2px
    classDef core fill:#ADD8E6,stroke:#333,stroke-width:2px
    classDef runtime fill:#FFE4B5,stroke:#333,stroke-width:2px
    classDef test fill:#D3D3D3,stroke:#333,stroke-width:2px
    classDef util fill:#DDA0DD,stroke:#333,stroke-width:2px

    %% REPL Layer
    subgraph REPL
        ReplInterface["REPL Interface"]:::repl
    end

    %% Core Interpreter Layer
    subgraph CoreInterpreter
        TokenReader["Token Reader"]:::core
        Evaluator["Evaluator"]:::core
        Environment["Environment"]:::core
        Printer["Printer"]:::core
        Types["Types System"]:::core
        Namespace["Namespace Management"]:::core
    end

    %% Supporting Utilities Layer
    subgraph Utilities
        Input["Input Handler"]:::util
        Output["Output Handler"]:::util
        Symbols["Symbol Management"]:::util
        StringUtils["String Utilities"]:::util
        Compare["Comparison Operations"]:::util
    end

    %% Testing Layer
    subgraph Testing
        TestSuite["Test Suite"]:::test
        MALTests["MAL Tests"]:::test
        TestRunner["Test Runner"]:::test
    end

    %% Runtime Layer
    subgraph Runtime
        JVM["JVM Runtime"]:::runtime
        StdLib["Standard Library"]:::runtime
    end

    %% Relationships
    ReplInterface --> TokenReader
    TokenReader --> Evaluator
    Evaluator <--> Environment
    Evaluator --> Printer
    Printer --> ReplInterface
    Environment <--> Namespace
    Evaluator <--> Types
    
    Input --> TokenReader
    Output --> Printer
    Symbols --> Environment
    StringUtils --> TokenReader
    Compare --> Evaluator
    
    TestRunner --> Evaluator
    TestSuite --> TestRunner
    MALTests --> TestRunner
    
    Environment --> JVM
    StdLib --> Environment

    %% Click events for component mapping
    click ReplInterface "https://github.com/karlll/krisp/blob/main/repl/src/main/kotlin/com/ninjacontrol/krisp/Repl.kt"
    click TokenReader "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/TokenReader.kt"
    click Evaluator "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Evaluate.kt"
    click Environment "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Environment.kt"
    click Printer "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Printer.kt"
    click Types "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Types.kt"
    click Namespace "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Namespace.kt"
    click Input "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Input.kt"
    click Output "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Output.kt"
    click Symbols "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Symbols.kt"
    click StringUtils "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/String.kt"
    click Compare "https://github.com/karlll/krisp/blob/main/core/src/main/kotlin/com/ninjacontrol/krisp/Compare.kt"
    click TestSuite "https://github.com/karlll/krisp/blob/main/core/src/test/kotlin/com/ninjacontrol/krisp/TestSuite.kt"
    click MALTests "https://github.com/karlll/krisp/tree/main/core/src/test/mal/"
    click TestRunner "https://github.com/karlll/krisp/blob/main/core/src/test/kotlin/com/ninjacontrol/krisp/TestRunner.kt"
```
