Skip to content

Latest commit

 

History

History
85 lines (48 loc) · 3.19 KB

readme.md

File metadata and controls

85 lines (48 loc) · 3.19 KB
Raw

Toy Compiler

Prerequisites

  • An installation of Java (8+)
  • A Unix environment

Building files & running tests

This project is built using Gradle, however it contains a Makefile wrapper for convenience.

Commands

Any of the following commands will build the project and run the tests:

make

make build

./gradlew build

Cleaning up

If there are conflicts between new files and output artifacts from a previous build, the project can be cleaned using any of the following commands:

make clean

./gradlew clean

Using the Makefile will always perform a clean operation before a new build, so this is not likely to be an issue in practice.

Troubleshooting

Gradle handles its own installation and dependencies when the ./gradlew script is called (it is executed from the Makefile too). Providing a Java 8 installation is present on the host system, this should work, however there may be some edge-cases that require resolution. If the Makefile is not working, try the ./gradlew commands directly. If this still doesn't work, then it may be necessary to perform the compilation manually.

Here are the locations for the relevant source files:

ANTLR grammar: src/main/antlr

Java source: src/main/java/ca/frankcom/csc435/compiler/

Java test source: src/test/java/ca/frankcom/csc435/compiler/

Java test resources: src/test/resources/

There may or may not be a conflict if an ANTLR jar file is present in the host CLASSPATH environment variable, as Gradle pulls its own ANTLR dependency from the web. If this is an issue, removing the jar from the CLASSPATH variable should resolve the problem.

I have experienced issues with Gradle when working behind a corporate proxy before, so if you are in a similarly constrained environment you may have to add your corporations certificates to the Java keystore.

Compiling files

There is a compile script in the root directory of this project, which acts as a convenience proxy to execute the produced jar file. The jar file provides several flags that can be used to customize the behavior and output of the compiler.

By default, the compiler will not output any files, it will simply perform parsing and semantic checking. It will not output anything to stdout, but a return code of 0 indicates success.

This script will perform the build process on your behalf if it has not already been executed. If changes are made between executions then it may be necessary to manually trigger a build using make, or delete the old jar file so that this script can detect the missing file and trigger a build.

Usage

The compile script provides the following help output:

usage: compile [OPTIONS] <FILE>
 -h,--help          Print help for command line arguments.
 -i,--ir <arg>      Output path of IR generation.
 -p,--print <arg>   Output path of pretty-print file.

To check if an input program will compile (pass/fail), use the following command:

./compile <input-file-path>

To pretty-print an input program, use the following command:

./compile -p <output-file-path> <input-file-path>

To generate intermediate representation for a program, use the following command:

./compile -i <output-file-path> <input-file-path>