anycc-org/anycc

any compiler compiler using C++

AnyCC Compiler Project Readme

The AnyCC Compiler is a project aimed at creating a compiler for a custom programming language. The compiler consists of various components, including a Lex, Parser, and Symbol Table. This README provides an overview of the entire project, including how to build and use the compiler.

Authors

• Ahmed ElSaeed
• Abdelrahman Mosly
• Muhammad Kotb
• Youssef Bazina

Documentation

• Lexical Analyzer Generator
• Parser Generator
• Symbol Table

Project Structure

The project is organized into the following main components

• The Lex Component is a component responsible for scanning the source code and generating tokens.

• The Parser Component is a component responsible for parsing the tokens and building the syntax tree.

• The Symbol Table Component is a component responsible for managing information about tokens encountered during lexical analysis.

• Tests Using Google Test

  • Unit Tests for public methods if it is not a simple getter/setter and not complex.
  • Integration Tests for public methods when needed.

Notes

• The project is not fully tested, but I tried to test as much as I can.
• Analyzer sometimes shifts the column number, but it is not a big problem and doesn't show up in important places.

Building and Running

Prerequisites

Ensure you have the necessary dependencies installed on your system

• C++ compiler (supporting C++17)
• CMake

Build Steps

1. Clone the repository

   git clone <repository_url>
   cd anycc

2. Create a build directory and navigate into it

   mkdir build
   cd build

3. Generate build files with CMake

   • On Linux

     cmake -G "Unix Makefiles" ..

   • On Windows

     cmake -G "MinGW Makefiles" ..

     or

     cmake -G "Visual Studio 17 2022" ..

4. Build the project

   cmake --build .

Running the Compiler

The AnyCC Compiler takes three command-line arguments: <rules_file_name>, <cfg_file_name>, and <program_file_name>. These arguments specify the files containing lexical rules, context-free grammar rules, and the program to be compiled, respectively.

anycc <rules_file_name> <cfg_file_name> <program_file_name>

Output

Upon successful execution, the compiler will generate an output folder containing various artifacts which includes

• Symbol Table in .md format.
• NFA Graph in .dot, csv, and md formats.
• DFA Graph in .dot, csv, and md formats.
• Minimized DFA Graph in .dot, csv, and md formats.
• tokens.txt file containing the tokens generated by the lexer if getAllTokensAndCreateOutputFile() is called.
• First and Follow sets in .md format.
• LL(1) Parsing Table in .md format.
• Left most derivation in .md format.
• Predictive Parsing Table in .md format.

Example

Here is an example of how to use the AnyCC Compiler

anycc ../input/rules.txt ../input/CFG.txt ../input/program.txt

This example assumes that lex_rules.txt contains lexical rules, cfg_rules.txt contains context-free grammar rules, and source_code.txt contains the program source code.

Enjoy using the AnyCC Compiler!

anycc's Issues

Repackaging

Symbol Table class needs to be moved from the Lex folder to another general folder as it is used in both lex and parser.

Variable Naming Convention

Like Phase 1, please write variable names using snake convention

Start Symbol

We should assume that the first non-terminal in the grammar is the start symbol is better than setting it as hard coded constant.

endstates vector in RegexToNFA Method

endstates are not added to the NFA endstates vector
so When creating an NFA using regexToNFA method, the returned NFA has empty endstates vector

Follow and First Computation Documentation

If there are any inline comments that can be put as C++ docs like nonTerminalHasEpsilon, iterateAndMergeFollowSets

Fix Parser Folder Name Typo

Parser folder name has typo and need to be fix