# skakim/compiladores architecture

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

- Interactive diagram: https://gitdiagram.com/skakim/compiladores
- Repository: https://github.com/skakim/compiladores

## Overview

##### Identificação do tipo e propósito do projeto
- Este é um compilador escrito em C que, a partir de um código-fonte de entrada (*.s ou *.c customizado), realiza as fases clássicas de compilação: análise léxica, análise sintática, construção de AST, checagem semântica, geração de código intermediário (TAC), possivelmente otimização/rastreamento, e finalmente emissão de código assembly.

##### Análise da estrutura de arquivos
- scanner.l           → definição do analisador léxico (Flex)
- parser.y            → definição da gramática e do parser (Bison)
- astree.c/.h, ast_defines.h           → representação e manipulação da árvore de sintaxe abstrata (AST)
- hash.c/.h, symbol_defines.h          → implementação da tabela de símbolos (hash)
- semantics.c/.h                       → verificação semântica (tipagem, escopo)
- tac.c/.h, tac_defines.h              → genêracao de código intermediário (Three-Address Code)
- tracker.c/.s                         → módulo de otimização ou rastreamento de TAC
- asm.c/.h, asmFile.s                  → genêracao de código assembly de destino
- main.c                               → ponto de entrada, orquestra as fases
- makefile                             → scrip­t de compilação e link
- textos de exemp­lo (*.txt, *.s)      → casos de teste / amostras de entrada e saída

##### Padrão arquitetural
- Pipeline de compilação em camadas (Front-End, Middle-End, Back-End)
- Cada fase lê a saída da anterior e produz artefatos para a próxima

##### Componentes principais e suas interações
a. Front-End
1. Scanner (scanner.l → scanner.o)
2. Parser (parser.y → parser.o)
3. AST (astree)
b. Middle-End
1. Checagem Semântica e Tabela de Símbolos (semantics, hash)
2. Geração de TAC (tac)
3. Otimizações/Rastreamento (tracker)
c. Back-End
1. Geração de Assembly (asm)
d. I/O
- Arquivo de entrada (texto.txt ou .s customizado)
- Arquivos intermediários (TAC, AST serializada)
- Arquivo de saída (assembly gerado, texto_asm.txt)

##### Diretrizes para criar o diagrama de sistema
- Estruture em três camadas horizontais:
1. Front-End (Scanner → Parser → AST)
2. Middle-End (Semântica/Tabela de Símbolos → Geração de TAC → Otimizações)
3. Back-End (Gerador de Assembly)
- Use setas direcionais para mostrar o fluxo de dados de uma fase à seguinte.
- Aponte inputs e outputs em cada etapa (ex.: fonte → tokens; tokens → AST; AST → TAC; TAC → assembly).
- Indique arquivos de entrada/saída nas extremidades do pipeline.

##### Padrões e tecnologias a destacar
- Flex/Bison para análise léxica e sintática
- Estrutura de dados hash para tabela de símbolos
- Representação em Three-Address Code (TAC)
- Código C puro, organizado em módulos .c/.h

##### Elementos obrigatórios no diagrama final
- Rótulos descritivos para cada componente (Scanner, Parser, etc.)
- Setas unidirecionais mostrando o fluxo de compilação
- Código-fonte e artefatos intermediários explicitados
- Nota de rodapé ou legenda explicando cores e símbolos

Seguindo esses passos você obterá um diagrama detalhado e preciso, refletindo fielmente a arquitetura do seu compilador em C.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% I/O Input
    IOInput["texto.txt / texto_errado.txt"]:::io
    click IOInput "https://github.com/skakim/compiladores/blob/master/texto.txt"
    click IOInput "https://github.com/skakim/compiladores/blob/master/texto_errado.txt"

    %% Orquestrador
    Main["main.c\n(Orquestrador)"]:::core
    click Main "https://github.com/skakim/compiladores/blob/master/main.c"

    IOInput --> Main

    subgraph "Camada de Front-End"
        Scanner["Scanner\n(tokens)"]:::frontend
        Parser["Parser\n(AST)"]:::frontend
        AST["AST"]:::frontend
    end

    Main --> Scanner
    Scanner -->|"tokens"| Parser
    Parser -->|"AST"| AST

    click Scanner "https://github.com/skakim/compiladores/blob/master/scanner.l"
    click Parser "https://github.com/skakim/compiladores/blob/master/parser.y"
    click AST "https://github.com/skakim/compiladores/blob/master/astree.c"

    subgraph "Camada de Middle-End"
        SymbolTable["Tabela de Símbolos\n(hash)"]:::middle
        Semantic["Análise Semântica"]:::middle
        TACGen["Geração de TAC"]:::middle
        Tracker["Otimização / Rastreamento"]:::middle
    end

    AST --> SymbolTable
    SymbolTable --> Semantic
    Semantic -->|"TAC"| TACGen
    TACGen -->|"TAC otimizado"| Tracker

    click SymbolTable "https://github.com/skakim/compiladores/blob/master/hash.c"
    click Semantic "https://github.com/skakim/compiladores/blob/master/semantics.c"
    click TACGen "https://github.com/skakim/compiladores/blob/master/tac.c"
    click Tracker "https://github.com/skakim/compiladores/blob/master/tracker.c"

    subgraph "Camada de Back-End"
        ASMGen["Geração de Assembly"]:::backend
    end

    Tracker -->|"assembly (.s)"| ASMGen
    click ASMGen "https://github.com/skakim/compiladores/blob/master/asm.c"

    ASMGen --> OutputIO

    %% I/O Output
    OutputIO["texto_asm.txt"]:::io
    click OutputIO "https://github.com/skakim/compiladores/blob/master/texto_asm.txt"

    %% Build Script
    Makefile["makefile"]:::core
    click Makefile "https://github.com/skakim/compiladores/tree/master/makefile"
    Makefile -.-> Main

    %% Styles
    classDef frontend fill:#ADD8E6,stroke:#333,stroke-width:1px;
    classDef middle fill:#90EE90,stroke:#333,stroke-width:1px;
    classDef backend fill:#FFA500,stroke:#333,stroke-width:1px;
    classDef io fill:#F0E68C,stroke:#333,stroke-width:1px, stroke-dasharray: 5 5;
    classDef core fill:#D3D3D3,stroke:#333,stroke-width:1px;
```
