Static Program Analyzer

About

Static Program Analyzer (SPA) built for the custom SIMPLE language. Language details can be found here.

We have many components, and through this project I have learnt about programming languages, devops and a bit of C++.

Target Environment

Item	Version
OS	Windows 10
Toolchain	Microsoft Visual Studio Enterprise 2019 Version 16.11.0
C++ Standard	C++17

Additional Build Instructions

1. To run the system tests, do check out the readme under the Team06/Tests06/systemtests/ directory on the instructions to run the relevant files based on your operating system. Alternatively, click here.
2. To run your own custom test cases, please enter the directory where your AutoTester.exe resides in. Then, run the command .\AutoTester.exe ..\Tests\Sample_source.txt ..\Tests\Sample_queries.txt ..\Tests\out.xml to check that it is compiling where an out.xml will be produced. To have your own custom input, please feel free to edit the Sample_queries.txt and Sample_source.txt
3. To view your results of the out.xml, run python -m http.server {PORT} where PORT can be any port number of your liking, such as 8000. Go to your localhost:{PORT} in your browser, navigate and open the out.xml file.

Running Checkstyle

To run checkstyle, first install the clang-format package using npm.

npm i

Ensure that your style.sh and styleall.sh script has executable permissions, then run it to automatically style your code.

style.sh automatically targets modified files based on Git, and is the formatter of choice used in Husky pre-commit checks.

styleall.sh targets every single file, hence it will take a file to run.

Feel free to use whichever suits your use case.

chmod u+x style.sh
./style.sh

# alternatively
bash style.sh

The checkstyle runs on all directories, and targets .cpp and .h files.

To configure how the checkstyle looks, change the properties in .clang-format.

Continuous Integration

As we support cross platform development, we have set up workflows for both Mac and Windows. These .yml files can be found in the .github folder.

We have a formatter which check for code styling according to our clang-format.

Each Mac and Windows workflow checks for compilation, and runs the respective unit and systemtests to check for correctness.

Each workflow file depends on the respective ci.bat/sh file found in the systemtests. To configure them, it is recommened to view systemtest's README first.

The workflow runs on pull request to master and pushes to our respective branches.

Team Members

Name	Development OS/Toolchain
Hoon Darren	MacOS/CLion
Muhammad Faruq Bin Jahangeer	MacOS/CLion
Ryan Cheung Jing Feng	Windows 10/Visual Studio 2019
Calvin Tan Wei Jie	Windows 10/Visual Studio 2022
Ong Xing Wei	Windows 10/Visual Studio 2022
Cui Langyuan	Windows 11/Visual Studio 2019