Skip to content

Latest commit

 

History

History
43 lines (37 loc) · 2.03 KB

README.md

File metadata and controls

43 lines (37 loc) · 2.03 KB
Raw

Project: CSC-312-Compiler

A compiler written in OCaml for Grinnell College's CSC 312 course with Peter-Michael Osera.

Contributor(s):

Halle Remash | halle@remash.com

Setup

  • Download this repository into your directory
  • Navigate to the src directory in this project in your terminal
  • Build the file using the make command

Dependencies

  • Install OCaml
  • Ensure that you have installed merlin
    • If you used the OPAM package manager, type opam search merlin
    • Else see the merlin's README to install
  • Ensure that you have installed menhir
    • If you used the OPAM package manager, type opam install menhir
  • Install utop (about)
    • If you used the OPAM package manager, type opam install utop

Makefile Commands

The Makefile for this project is located in the ./src directory. Navigate there in order to run Makefile commands.

  • make : build project using ocamlbuild
  • make clean : runs ocamlbuild's clean
  • make cleanup: removes automatically generated files
  • make test : runs test.sh, the project test suite
  • make top : runs utop (type #quit;; to exit)

Excecution Instructions

make currently produces the file compiler.byte which can be run in the terminal. Note that this project compiles byte-code instead of native code. Also note that ./compiler.byte can be excecuted with -help and -parse flags in addition to the .src file that it "compiles". When you wish to recompile the project (on Windows using Cygwin) type make cleanup before typing make.

Current Language Syntax

e ::= n | (e) | e1 + e1 | e1 - e2 | e1 * e2 | e1 / e2
        | true | false | e1 <= e2 | if e1 then e2 else e3
        | x | let x = e1 in e2 | fun x -> e | e1 e2 | fix f x -> e