jfoley8/div-by-zero-checker

What is this repository

This repository contains a template for an abstract interpretation implementation assignment. You can find the full instructions for the assignment in INSTRUCTIONS.md in this directory, or on your course webpage.

The remainder of this README is the user-facing documentation for the analysis you will build.

What is the Divide By Zero Checker

A common problem when programming is division by zero. This results in a run-time exception.

The Divide By Zero Checker should guarantee, at compile time, that your code will not suffer that run-time exception.

How to run the checker

First, publish the checker to your local Maven repository by running ./gradlew publishToMavenLocal in this repository.

Then, if you use Gradle, add the following to the build.gradle file in the project you wish to type-check (using Maven is similar):

repositories {
    mavenLocal()
    mavenCentral()
}
dependencies {
    annotationProcessor 'org.checkerframework:dividebyzero-checker:0.1-SNAPSHOT'
}

Now, when you build your project, the Divide By Zero Checker will also run, informing you of any potential errors related to division by zero.

How to build the checker

Run these commands from the top-level directory.

./gradlew build: build the checker

./gradlew publishToMavenLocal: publish the checker to your local Maven repository. This is useful for testing before you publish it elsewhere, such as to Maven Central.

More information

The Divide By Zero Checker is built upon the Checker Framework. Please see the Checker Framework Manual for more information about using pluggable type-checkers, including this one.