CompilerDisciplineAssignment

Projeto de uma implementação de um compilador feito com flex e yacc para uma disciplina de universidade de compiladores.

Compilador C - Projeto da Disciplina Compiladores 1

Visão Geral do Projeto

Este repositório contém o projeto de um compilador para uma sublinguagem de C, desenvolvido como parte da disciplina de Compiladores 1 da Universidade de Brasília - UnB. O objetivo principal é aplicar os conceitos teóricos e práticos de construção de compiladores, desde a análise léxica até a geração de código, utilizando a metodologia Problem Based Learning (PBL) e o framework Scrum para o gerenciamento do projeto.

• Professor: Sergio Antônio Andrade de Freitas
• Contato do Professor: sergiofreitas@unb.br
• GitHub do Professor: https://github.com/sergioaafreitas

Equipe

A nossa equipe é atualmente identificada pelo número 13, mediante divisão/organização realizada pelo professor da disciplina.

Tabela 1 – Membros da Equipe

Artur Ricardo

Fillipe Andrade

Luciano Machado

Vinícius Rufino

Yan Lucas

Objetivo do Compilador

Nosso compilador será capaz de traduzir código-fonte escrito em uma sublinguagem de C para [especificar a linguagem alvo, ex: código de máquina, assembly, ou código intermediário específico]. O foco será na implementação das fases essenciais de um compilador, garantindo a correção e a robustez do processo de tradução.

Estrutura do Repositório

.
├── CONTRIBUTING.md                # Guia para novos contribuidores e fluxo de trabalho.
├── docs                           # Documentação detalhada do projeto.
│   └── ansi-iso-9899-1990-1.pdf
├── LICENSE                        # Informações sobre a licença do projeto.
├── lucianos_workspace
│   ├── comp                       # Executável auxiliar ou artefatos de build local.
│   ├── comp.c                     # Fonte C para testes manuais do Luciano.
│   ├── comp.c.asm                 # Saída em assembly gerada a partir de comp.c.
│   ├── lex.l                      # Definições Flex usadas em protótipos iniciais.
│   ├── nasm
│   │   ├── abi.asm                # Rotinas em assembly relacionadas a convenções de chamada.
│   │   ├── abi.c
│   │   ├── main.asm               # Exemplo principal em NASM.
│   │   ├── nasmdoc.pdf            # Documentação da sintaxe NASM.
│   │   ├── out                    # Saídas geradas pela montagem.
│   │   └── run.sh                 # Script para compilar e executar em NASM.
│   ├── out                        # Diretório de saídas do workspace.
│   ├── run.sh                     # Script de execução rápido do workspace.
│   ├── syn.y                      # Protótipo de gramática inicial em Bison.
│   └── test.mcmm                  # Arquivo de teste específico do workspace.
├── README.md                      # Visão geral do projeto, equipe, objetivos e marcos.
├── src                            # Código-fonte do compilador.
│   ├── code_generator             # Backend: traduz IR para código alvo.
│   ├── ir_generator
│   │   ├── tac.c                  # Implementação da geração de TAC (Three Address Code).
│   │   └── tac.h                  # Definições e estruturas do TAC.
│   ├── lexer                      # Arquivos relacionados à análise léxica (Flex).
│   │   └── scanner.l
│   ├── main.c                     # Ponto de entrada do compilador.
│   ├── Makefile                   # Script de automação de build.
│   ├── parser                     # Definições da gramática e ações semânticas.
│   │   ├── parser.output          # Saída detalhada do Bison (debug de conflitos).
│   │   └── parser.y
│   └── semantic
│       ├── ast.c                  # Implementação da AST e funções auxiliares.
│       ├── ast.h                  # Estruturas da AST.
│       ├── symbol_table.c         # Implementação da tabela de símbolos.
│       └── symbol_table.h         # Definição da tabela de símbolos.
└── tests                          # Conjunto de testes do compilador.
    ├── examples                   # Exemplos de programas de entrada.
    │   ├── syntax_error.c
    │   └── valid_program.c
    ├── integration_tests          # Testes de integração de todo o compilador.
    └── unit_tests                 # Testes de unidade dos módulos específicos.

Fases do Compilador

O desenvolvimento do compilador seguirá as fases clássicas:

1. Análise Léxica: Identificação e classificação de tokens (palavras-chave, identificadores, operadores, etc.).
2. Análise Sintática: Verificação da estrutura gramatical do código-fonte e construção da Árvore Sintática Abstrata (AST).
3. Análise Semântica: Verificação de tipos, escopo de variáveis e outras regras de significado da linguagem.
4. Geração de Código Intermediário: Tradução da AST para uma representação mais próxima do código de máquina.
5. Otimização de Código (Opcional): Melhorias no código intermediário para aumentar a eficiência.
6. Geração de Código Final: Tradução do código intermediário para a linguagem alvo (ex: Assembly).

Como Rodar o Compilador

Para compilar e executar o compilador, siga os passos abaixo:

1. Pré-requisitos

Certifique-se de ter as seguintes ferramentas instaladas em seu sistema:

• GCC (GNU Compiler Collection): Para compilar o código C.
• Flex: Gerador de analisadores léxicos.
• Bison: Gerador de analisadores sintáticos.

Em sistemas baseados em Debian/Ubuntu, você pode instalá-los com:

sudo apt-get update
sudo apt-get install -y build-essential flex bison

2. Compilação do Projeto

Navegue até o diretório src/ do projeto e execute o comando make:

cd src/
make

Este comando irá:

1. Gerar parser.tab.c e parser.tab.h a partir de parser/parser.y (usando Bison).
2. Gerar lex.yy.c a partir de lexer/scanner.l (usando Flex).
3. Compilar todos os arquivos .c e linká-los para criar o executável compiler.

Se a compilação for bem-sucedida, você verá o executável compiler no diretório src/.

3. Execução do Compilador

Para testar o compilador com um arquivo de código-fonte, execute-o da seguinte forma:

./compiler <caminho_para_arquivo_fonte>

Por exemplo, para testar com o programa de exemplo valid_program.c:

./compiler ../tests/examples/valid_program.c

O compilador irá processar o arquivo e, no estado atual, imprimirá a Árvore Sintática Abstrata (AST) se a análise léxica e sintática for bem-sucedida. Caso contrário, reportará erros de sintaxe.

4. Limpeza do Projeto

Para remover os arquivos gerados pela compilação (executável, objetos, arquivos gerados por Flex/Bison), execute:

make clean

Marcos Importantes (Pontos de Controle)

• P1: Avaliação inicial do projeto, incluindo a definição da linguagem, planejamento das sprints e o progresso das fases léxica e sintática inicial.

• Período de Envio do Formulário: [Data a ser definida pelo professor]

• Apresentação: [Data a ser definida pelo professor]

• P2: Avaliação do progresso intermediário, com foco nas funcionalidades principais desenvolvidas, melhorias e ajustes no planejamento.

• Período de Envio do Formulário: [Data a ser definida pelo professor]

• Apresentação: [Data a ser definida pelo professor]

• Entrega Final e Entrevista: Entrega do compilador completo e entrevista presencial com a equipe para demonstração e justificativa das decisões técnicas.

• Entrega no GitHub: [Data a ser definida pelo professor]

• Entrevista: [Data a ser definida pelo professor]

Como Contribuir

Consulte o arquivo CONTRIBUTING.md para obter informações sobre como configurar o ambiente de desenvolvimento, submeter alterações e seguir as convenções de código.

Licença

Este projeto está licenciado sob a GNU General Public License v3.0. Consulte o arquivo LICENSE para mais detalhes.