CSE 40243 Fall 2022

Compilers and Language Design Course at the University of Notre Dame

View the Project on GitHub

Parser Assignment

Objectives

The objectives of this assignment are:

Overview

The second step in building a compiler is to construct a parser. You will build upon the code from the scanner assignment, using the Bison Parser Generator to create a parser for B-Minor. It is up to you to carefully read this document and decide what all of the relevant elements of B-Minor are. Make sure that you include declarations, definitions, statements, expressions, and any other program elements. If you think that the specification is not clear, be sure to ask for a clarification.

Requirements

Please review the general instructions for assignments. Your program must be written in plain C, use bison to generate the parser and flex to generate the scanner. You must have a Makefile such that when you type make, all the pieces are compiled and result in a binary program called bminor. make clean should also delete all temporary files, so that the program can be made again from scratch. Your code must work on the ND Linux student machines.

Use the scanner code from the prior assignment as your starting point, being sure to fix any outstanding problems.

If your program is invoked like this:

./bminor -parse sourcefile.bminor

Then it should behave as follows:

If your program is invoked like this:

./bminor -scan sourcefile.bminor

Then it should continue to operate as in the previous assignment; this will facilitate debugging. You may of course reorganize or move code around as long as the standalone scanner still works.

Fix Scanner if Needed

First if, you had any problems with your scanner from the first assignment, you should fix them before proceeding. Make sure that the action of each rule is to return a symbolic token type (e.g. TOKEN_INTEGER) so that yylex() has the proper return value to be used by yyparse().

Note a change in the handling of one token: modify your rule for integers, so that an integer token does not contain a leading positive or negative sign. In other words, the input -123 should scan as two tokens: TOKEN_MINUS and TOKEN_INTEGER.

You may find in the course of constructing the parser that your scanner had bugs that we didn’t see before. You can and should fix anything in your scanner needed to get the entire scanner-parser combination working correctly.

Approach

We recommend that you construct your grammar in stages and begin by testing it on small examples, then proceeding to larger structures. For example, start off by creating just arithmetic expressions, like this:

expr : expr TOKEN_ADD expr
     | expr TOKEN_SUB expr
     ...
     ;

Then, verify that your grammar has no shift-reduce or reduce-reduce conflicts. If it does, look at the detailed output of Bison and re-write your grammar rules to address them. Once you have basic expressions working, then start adding control-flow structures, and then declarations, until you have constructed the complete grammar.

Note that Bison will tell you if your grammar has errors. In particular, your grammar must not have any shift-reduce or reduce-reduce conflicts. To eliminate them, you may only re-write the production rules, you may not apply disambiguating rules, operator precedence specifiers, or apply other “tricks” found in Bison. (The purpose of this rule is to force you to fully understand the key ideas in LR parsing.)

It will take some time to think through the grammar problems. Plan to work on this project over the course of several days, so that you are able to work, then take a break to think, and then return to the code with fresh thoughts.

Testing

A compiler has many odd corner cases that you must carefully handle. You must test your program extensively by designing and testing a large number of test cases. To encourage you to test thoroughly, we will also require you to turn in twenty test cases. Ten should be named good[0-9].bminor and should contain valid B-minor programs. Ten should be named bad[0-9].bminor and should contain at least one parse error. Be thorough, and take the time to write a new set of tests, distinct from your scanning tests.

The starter code provides some example tests to give you the idea, but they are not comprehensive, so write your own thorough tests.

The exit status of bminor is very important because it indicates to the user whether the program succeeded or not. The Unix convention is that the result of main (or the call to exit) should be zero to indicate success and non-zero to indicate failure. We will use the program exit status to determine the correctness of your submissions and your test, using a script something like this:

#!/bin/sh

for testfile in good*.bminor
do
	if bminor -parse $testfile > $testfile.out
	then
		echo "$testfile success (as expected)"
	else
		echo "$testfile failure (INCORRECT)"
	fi
done

for testfile in bad*.bminor
do
	if bminor -parse $testfile > $testfile.out
	then
		echo "$testfile success (INCORRECT)"
	else
		echo "$testfile failure (as expected)"
	fi
done

Grading

Please review the general instructions for submission. Your submission will be tested on the ND student Linux machines, so make sure that your code works there. If you develop on your laptop or another computer, leave plenty of time before final submission to debug any differences between your computer and ours.

Tag your submission with parse in github to turn in.

For this assignment, your grade will be based upon the following:

This assignment is due on Tuesday, October 11th at 11:59PM. Late assignments are not accepted.

Frequently Asked Questions

See the bottom of the B-Minor Language Guide for some FAQs about parsing.