# pablosambuco/compilador-lenguajes-2008 architecture

> Architecture diagram of the GitHub repository pablosambuco/compilador-lenguajes-2008, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pablosambuco/compilador-lenguajes-2008
- Repository: https://github.com/pablosambuco/compilador-lenguajes-2008

## Overview

##### Project type and purpose
- This is a compiler for a custom programming language, built as an academic exercise for a Lenguajes y Compiladores course (UNLaM 2008).
- It consumes source files (programa1.txt, programa2.txt) and produces diagnostics or intermediate output.

##### File structure
- Top-level directories:
- BYACC-J: contains the parser generator executable (yacc.exe, yacc.lnx), an input grammar (input.y) and helper scripts (generar.bat).
- lib: junit-3.8.1.jar for unit tests.
- src/java: main compiler code, divided into subpackages:
– analizadorLexicografico (Automata.java for lexical analysis)
– parser (Parser.java, ParserVal.java generated by BYACC-J)
– semantica (many IRutinaSemantica implementations for semantic actions)
– beans (symbol table entries, reserved words)
– util (ArchivoReader.java)
- src/test: JUnit test harness for compiler validation.
- Build and run scripts (make.bat, clean.bat, compilar.sh, run1.bat/ run2.bat) orchestrate compilation and tests.

##### README
- Confirms the tool’s nature (a custom-language compiler) and academic context.

a. Main components
- Source Code Input (text files)
- Lexical Analyzer (Automata in analizadorLexicografico)
- Syntax Analyzer / Parser (BYACC-J + Parser.java)
- Semantic Analyzer (semantica package)
- Symbol Table (beans package)
- Utility Component (ArchivoReader)
- Test Harness (JUnit in src/test)
- External Tools (BYACC-J executable)
b. Relationships and interactions
- Source Code → ArchivoReader → Lexical Analyzer
- Lexical Analyzer → stream of Tokens → Parser
- Parser → calls semantic routines (IRutinaSemantica implementations)
- Semantic routines ↔ Symbol Table (insert / lookup entries)
- Parser / Semantic Analyzer → produces output (errors, logs)
- Build scripts invoke BYACC-J to regenerate parser classes, compile Java code, run JUnit tests.
c. Architectural patterns / design principles
- Pipeline (lex → parse → semantic)
- Separation of concerns by package
- Use of a parser generator (BYACC-J) to decouple grammar from code
- Strategy pattern for semantic routines (IRutinaSemantica interface with many implementations)
d. Key technologies
- Java 1.5+
- BYACC-J for syntax analysis
- JUnit 3.8.1 for testing
- Batch / shell scripts for build automation

##### Essential architectural elements
- Don’t just list every class; group them by function (all semantic routines under “Semantic Analyzer”).
- External dependencies (BYACC-J, JUnit) and their role in the workflow.
- Both build-time (parser generation, compilation) and run-time (analysis pipeline) phases.
- Symbol Table is prominently shown as a shared resource.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Build-time Tools" 
        inputy["Grammar: input.y"]:::build
        yaccExe["yacc.exe"]:::build
        yaccLnx["yacc.lnx"]:::build
        genBat["generar.bat"]:::build
        makeBat["make.bat"]:::build
        cleanBat["clean.bat"]:::build
        compilarSh["compilar.sh"]:::build
        run1["run1.bat"]:::build
        run2["run2.bat"]:::build
    end

    subgraph "Runtime Pipeline"
        src["Source Code Input"]:::runtime
        util["ArchivoReader"]:::support
        lex["Lexical Analyzer"]:::runtime
        parser["Parser"]:::runtime
        semantic["Semantic Analyzer"]:::runtime
        symtab["Symbol Table"]:::support
        output["Diagnostics / Intermediate Output"]:::runtime
    end

    subgraph "Testing Harness"
        junitJar["junit-3.8.1.jar"]:::test
        mainTest["Main.java"]:::test
        testComp["TestCompilador.java"]:::test
        testProg["programa.txt"]:::test
    end

    %% Build-time to Runtime
    inputy -->|"generates"| parser
    yaccExe --> parser
    yaccLnx --> parser
    genBat --> parser
    makeBat --> src
    cleanBat --> src
    compilarSh --> src
    run1 --> src
    run2 --> src

    %% Runtime flow
    src -->|"reads"| util
    util -->|"provides characters"| lex
    lex -->|"produces tokens"| parser
    parser -->|"invokes semantic routines"| semantic
    semantic -->|"reads/writes"| symtab
    parser -->|"reads/writes"| symtab
    semantic -->|"outputs"| output

    %% Testing flow
    testProg --> mainTest
    junitJar --> mainTest
    mainTest --> testComp
    testComp --> src

    %% Click Events
    click inputy "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/BYACC-J/input.y"
    click yaccExe "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/BYACC-J/yacc.exe"
    click yaccLnx "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/BYACC-J/yacc.lnx"
    click genBat "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/BYACC-J/generar.bat"
    click makeBat "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/make.bat"
    click cleanBat "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/clean.bat"
    click compilarSh "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilar.sh"
    click run1 "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/run1.bat"
    click run2 "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/run2.bat"
    click src "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/programa1.txt"
    click src "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/programa2.txt"
    click testProg "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/test/pruebas/programa.txt"
    click util "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/util/ArchivoReader.java"
    click lex "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/analizadorLexicografico/Automata.java"
    click parser "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/parser/Parser.java"
    click parser "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/parser/ParserVal.java"
    click semantic "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/semantica/IRutinaSemantica.java"
    click semantic "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/semantica/And.java"
    click semantic "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/semantica/Error.java"
    click semantic "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/semantica/OperadorAsignacion.java"
    click symtab "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/beans/TablaDeSimbolos.java"
    click symtab "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/beans/EntradaTS.java"
    click symtab "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/beans/PalabraReservada.java"
    click symtab "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/java/compilador/beans/PalabrasReservadas.java"
    click junitJar "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/lib/junit-3.8.1.jar"
    click mainTest "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/test/pruebas/Main.java"
    click testComp "https://github.com/pablosambuco/compilador-lenguajes-2008/blob/master/src/test/pruebas/TestCompilador.java"

    %% Styles
    classDef runtime fill:#e0f7e9,stroke:#2e8b57,stroke-width:1px
    classDef build fill:#cce5ff,stroke:#337ab7,stroke-width:1px
    classDef support fill:#fff3cd,stroke:#ffecb5,stroke-width:1px
    classDef test fill:#ffe5b4,stroke:#ff8c00,stroke-width:1px
```
