CS 5363: Programming Languages and Compilers

Deliverables, Submission, and Packaging

When you have completed your assignment, you should create a tar archive file containing your source files, build apparatus, and your test cases. The tar file should unpack to a directory named "cs5363" plus a hyphen plus your login name (e.g, "cs5363-vonronne"). You may get assistance from your classmates in setting up your build apparatus, creating and documenting test cases, and preparing the your tar file for submission, but all of the source files should be your own independent work. The tar file should not contain any executable, object, or class files, but it may include graphviz dot files as part of the test case documentation.

This tar file should be attached to an email to cs5363@cs.utsa.edu as cs5363-<username>.tar. The subject of this email should containing the text "CS 5363 Submission <date>", and the main body of the email should contain a plain text "cover letter" describing your submission. Try not to include HTML alternatives to the cover letter or any other attachments besides the tar file.

If you choose to implement the compiler in Java:

• your top-level cs5363-<username> directory should contain "src", "classes", and "test-cases" directories, and a "README" file (which contains a copy of your cover letter).
• Your source files should be in a "src" arranged in a package-based directory structure,
• Please include an empty classes directory
• Place sample test case outputs (if any) under "test-cases/outputs".
• The main method should be in the "Compiler" class of the "tl07" package (i.e., tl07.Compiler). (In other words, the main method should be in src/tl07/Compiler.java. And this Compiler.java--and the other source files in the same directory--should have the declaration "package tl07;" near the top.
• the TL07 compiler should be able to be compiled using

  javac -d classes -sourcepath src src/tl07/Compiler.java
  

  and executed using:

  java -classpath classes tl07.Compiler test-cases/simple.tl07
  

  (Assuming there is a test-case called simple.tl07.) The output would be test-cases/simple.pt1.dot, etc.

If you choose to implement the compiler in C++, then:

• Your top-level cs5363-<username> directory should contain "src" and "test-cases" directories, a "Makefile", and a "README" (which is a copy of your cover letter).
• You should place your source files below the "src" directory.
• Place sample test case outputs (if any) under "test-cases/outputs".
• C++ source files should end in .cc.
• The Makefile should be able to be used to compile your source files into an executable. The Makefile should (to the extent possible) contain only dependencies and rely on the built-in implicit rules for turning C++ into object files. (c.f., GNU Make's catalog of rules.) You will, however, probably need an explicit rule to link all the object files into an executable using g++ (this executable should be called "tl07"); the rule to produce the executable should be the top most (i.e., default) rule, which gets invoked when one just runs "make" in the top-level cs5363-<username> directory.
• Your main procedure should accept the name of a tl07 file on the command-line (e.g., ./tl07 test-cases/test1.tl07).

If you are using ML, please place your source files under a src subdirectory directory (within the toplevel s5363-<username> directory) and include detailed instructions for running your compiler from the command line.

In all case, the executable should produce an appropriate output file, whose name is derived from the input filename passed on the command line, for each completed part of the compiler. (The Part #1 output of "test1.tl07" should be "test1.pt1.dot".)

Your cover letter must include:

1. Your name.
2. A statement that the attached source files are your own work.
3. A description of your current progress on the compiler.
4. A description of any known limitations of the implementation being turned in (e.g., broken/incomplete features, test cases that don't run)
5. A clear statement of which parts you currently wish to have graded/regraded. (e.g., "Please regrade part 1 and grade parts 2 and 3.") Also note any changes that you wish to be considered during regrading, and anything else you wish to be considered during grading.
6. An indication of what programming language you used to implement your program, the subdirectories in which your source files, test cases, and Makefile reside (as appropriate), and instructions for building and executing your compiler.
7. A statement of approximately how many hours it took to complete the assignment.

Please also include a copy of your cover letter in the tar file as cs5363-<username>/README.

Submissions missing a cover letter will not be graded. Submissions which are improperly prepared, or do not compile "out of the box" on the departmental linux machines (e.g., main201.cs.utsa.edu) may be penalized or not be graded.

Errata/Clarifications