# fardenghi/tp-tla architecture

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

- Interactive diagram: https://gitdiagram.com/fardenghi/tp-tla
- Repository: https://github.com/fardenghi/tp-tla

## Overview

##### Project type and purpose
- This is a compiler example built in C using Flex (lexical analysis) and Bison (syntactic analysis).
- It reads domain‐specific source programs (e.g. cellular‐automaton specifications), performs lexing, parsing, builds an AST, then applies code generation and domain‐specific logic (Calculator) to produce output.

##### File structure
- Top-level folders:
– src/main/c/frontend/lexical-analysis
– src/main/c/frontend/syntactic-analysis
– src/main/c/backend/code-generation
– src/main/c/backend/domain-specific
– src/main/c/shared (state, environment, logging, string utilities)
– src/test/c (accept/reject suites)
- Build and deployment:
– CMakeLists.txt, Dockerfile, .github/workflows/pipeline.yaml
– script/ubuntu, script/macos, script/windows for build, test, run

##### README for insights
- Environment variables control logging and ignored lexemes.
- CI/CD via GitHub Actions.
- Recommended VS Code extensions for C/C++ and CMake.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Main Entry
    EntryPoint["EntryPoint.c"]:::core

    %% Frontend Layer
    subgraph "Frontend" 
        direction TB
        FlexPatterns["FlexPatterns.l"]:::frontend
        FlexActions["FlexActions.c/h"]:::frontend
        LexCtx["LexicalAnalyzerContext.c/h"]:::frontend
        FlexExport["FlexExport.h"]:::frontend
        BisonGrammar["BisonGrammar.y"]:::frontend
        BisonActions["BisonActions.c/h"]:::frontend
        ASTFiles["AbstractSyntaxTree.c/h"]:::frontend
        SyntacticFiles["SyntacticAnalyzer.c/h"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend"
        direction TB
        CodeGen["Generator.c/h"]:::backend
        DomainEngine["Calculator.c/h"]:::backend
    end

    %% Shared Utilities
    subgraph "Shared Utilities"
        direction TB
        CompilerState["CompilerState.h"]:::shared
        Environment["Environment.c/h"]:::shared
        Logger["Logger.c/h"]:::shared
        StringUtil["String.c/h"]:::shared
        TypeDef["Type.h"]:::shared
    end

    %% Testing Harness
    subgraph "Testing Harness" 
        direction TB
        AcceptTests["Accept Tests"]:::test
        RejectTests["Reject Tests"]:::test
    end

    %% Build & Deployment
    subgraph "Build & Deployment"
        direction TB
        CMake["CMakeLists.txt"]:::build
        Docker["Dockerfile & .dockerignore"]:::build
        subgraph "Platform Scripts"
            direction TB
            UbuntuScripts["script/ubuntu"]:::build
            MacosScripts["script/macos"]:::build
            WindowsScripts["script/windows"]:::build
        end
    end

    %% CI/CD
    CICD["GitHub Actions Pipeline"]:::ci

    %% Data Flow
    AcceptTests -->|test input| EntryPoint
    RejectTests -->|test input| EntryPoint
    EntryPoint -->|reads source| FlexPatterns
    FlexPatterns -->|tokens| BisonGrammar
    BisonGrammar -->|parses tokens| ASTFiles
    ASTFiles -->|AST| CodeGen
    CodeGen -->|intermediate code| DomainEngine
    DomainEngine -->|final output| EntryPoint

    %% Shared Dependencies
    CompilerState -.-> EntryPoint
    CompilerState -.-> FlexPatterns
    CompilerState -.-> BisonGrammar
    CompilerState -.-> CodeGen
    CompilerState -.-> DomainEngine
    Environment -.-> EntryPoint
    Logger -.-> FlexPatterns
    Logger -.-> BisonGrammar
    Logger -.-> CodeGen
    Logger -.-> DomainEngine
    StringUtil -.-> CodeGen
    TypeDef -.-> ASTFiles

    %% Build & CI/CD Flow
    CMake --> Docker
    Docker --> UbuntuScripts
    Docker --> MacosScripts
    Docker --> WindowsScripts
    CICD --> CMake
    CICD -->|triggers tests| AcceptTests
    CICD -->|triggers tests| RejectTests

    %% Click Events
    click EntryPoint "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/EntryPoint.c"
    click FlexPatterns "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/frontend/lexical-analysis/FlexPatterns.l"
    click FlexActions "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/frontend/lexical-analysis/FlexActions.c"
    click LexCtx "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/frontend/lexical-analysis/LexicalAnalyzerContext.c"
    click FlexExport "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/frontend/lexical-analysis/FlexExport.h"
    click BisonGrammar "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/frontend/syntactic-analysis/BisonGrammar.y"
    click BisonActions "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/frontend/syntactic-analysis/BisonActions.c"
    click ASTFiles "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/frontend/syntactic-analysis/AbstractSyntaxTree.c"
    click SyntacticFiles "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/frontend/syntactic-analysis/SyntacticAnalyzer.c"
    click CodeGen "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/backend/code-generation/Generator.c"
    click DomainEngine "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/backend/domain-specific/Calculator.c"
    click CompilerState "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/shared/CompilerState.h"
    click Environment "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/shared/Environment.c"
    click Logger "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/shared/Logger.c"
    click StringUtil "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/shared/String.c"
    click TypeDef "https://github.com/fardenghi/tp-tla/blob/main/src/main/c/shared/Type.h"
    click AcceptTests "https://github.com/fardenghi/tp-tla/tree/main/src/test/c/accept/"
    click RejectTests "https://github.com/fardenghi/tp-tla/tree/main/src/test/c/reject/"
    click CMake "https://github.com/fardenghi/tp-tla/blob/main/CMakeLists.txt"
    click Docker "https://github.com/fardenghi/tp-tla/tree/main/Dockerfile"
    click UbuntuScripts "https://github.com/fardenghi/tp-tla/tree/main/script/ubuntu"
    click MacosScripts "https://github.com/fardenghi/tp-tla/tree/main/script/macos"
    click WindowsScripts "https://github.com/fardenghi/tp-tla/tree/main/script/windows"
    click CICD "https://github.com/fardenghi/tp-tla/blob/main/.github/workflows/pipeline.yaml"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#0288D1,color:#01579B
    classDef backend fill:#E8F5E9,stroke:#2E7D32,color:#1B5E20
    classDef shared fill:#ECEFF1,stroke:#90A4AE,color:#607D8B
    classDef build fill:#FFF3E0,stroke:#FB8C00,color:#E65100
    classDef test fill:#F3E5F5,stroke:#8E24AA,color:#4A148C
    classDef ci fill:#FFEBEE,stroke:#E53935,color:#B71C1C
    classDef core fill:#CFD8DC,stroke:#455A64,color:#263238
```
