# zhaom0/litecc architecture

> Architecture diagram of the GitHub repository zhaom0/litecc, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/zhaom0/litecc
- Repository: https://github.com/zhaom0/litecc

## Overview

Key Components to Include:

##### Compiler Pipeline Stages
The main components are clearly visible from the source files:
- Tokenizer (tokenize.c)
- Parser (parse.c)
- Type System (type.c)
- Code Generator (codegen.c)

##### Component Breakdown

a. Source Code Input (Initial State)
- As a document symbol

b. Tokenizer Stage
- To source code input
- Output as token stream
- Reference tokenize.c

c. Parser Stage
- To tokenizer output
- Abstract Syntax Tree (AST) generation
- Reference parse.c

d. Type Checking/Analysis Stage
- To parser output
- Type verification process
- Reference type.c

e. Code Generation Stage
- To type checker output
- Assembly code generation
- Reference codegen.c

f. Final Output
- As assembly code or executable

##### Additional Elements
- A header showing "litecc Compiler Pipeline"
- Version control integration (reference to .github/workflows)
- Build system connection (Makefile)

##### Specific Details
- How litecc.h header file connects to all components
- Test integration (test.sh)
- Build process flow via Makefile

##### Relationships
- How the header file (litecc.h) is included by other components

Design Guidelines:
##### Error handling paths if applicable

Level of Detail:
- Compiler stages and their interactions
- Enough detail to understand the compilation process
- Avoid getting too deep into individual function calls
- Sequential nature of compilation

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        L1[Process Stage]
        L2[(Header File)]
        L3[/Input/Output/]
        L4{{Build & Test}}
    end

    subgraph Pipeline["Compiler Pipeline"]
        Input[/"C Source Code"/]:::input
        
        subgraph CompStages["Compilation Stages"]
            direction TB
            Tokenizer["Tokenizer<br/>(Token Stream Generation)"]:::stage
            Parser["Parser<br/>(AST Generation)"]:::stage
            TypeCheck["Type Checker<br/>(Type Analysis)"]:::stage
            CodeGen["Code Generator<br/>(Assembly Generation)"]:::stage
        end
        
        Output[/"Assembly Output"/]:::output
    end

    subgraph Support["Support Systems"]
        Header[(Common Definitions<br/>Header)]:::header
        Main["Main Pipeline<br/>Controller"]:::controller
        Build{{Build System}}:::build
        CICD{{CI/CD Pipeline}}:::cicd
        Test{{Test Framework}}:::test
    end

    %% Main Flow
    Input --> Tokenizer
    Tokenizer --> Parser
    Parser --> TypeCheck
    TypeCheck --> CodeGen
    CodeGen --> Output

    %% Support System Connections
    Header -.-> Tokenizer
    Header -.-> Parser
    Header -.-> TypeCheck
    Header -.-> CodeGen
    Header -.-> Main
    
    Main --> Input
    Build --> Main
    Test --> Main
    CICD --> Build

    %% Click Events
    click Tokenizer "https://github.com/zhaoM0/litecc/blob/main/tokenize.c"
    click Parser "https://github.com/zhaoM0/litecc/blob/main/parse.c"
    click TypeCheck "https://github.com/zhaoM0/litecc/blob/main/type.c"
    click CodeGen "https://github.com/zhaoM0/litecc/blob/main/codegen.c"
    click Header "https://github.com/zhaoM0/litecc/blob/main/litecc.h"
    click Main "https://github.com/zhaoM0/litecc/blob/main/main.c"
    click Build "https://github.com/zhaoM0/litecc/tree/main/Makefile"
    click CICD "https://github.com/zhaoM0/litecc/blob/main/.github/workflows/litecc.yml"
    click Test "https://github.com/zhaoM0/litecc/blob/main/test.sh"

    %% Styles
    classDef input fill:#a8d1ff,stroke:#333
    classDef output fill:#a8d1ff,stroke:#333
    classDef stage fill:#90EE90,stroke:#333
    classDef header fill:#FFB366,stroke:#333
    classDef controller fill:#FFB366,stroke:#333
    classDef build fill:#FF9999,stroke:#333
    classDef cicd fill:#FF9999,stroke:#333
    classDef test fill:#FF9999,stroke:#333
```
