Using OCaml compilers for this course

The programming assignments in CSE505 will use the Caml dialect of ML. (Objective Caml, or OCaml for short, is the implementation of Caml.) You may use any remotely recent version of OCaml (nothing we do should depend on a particular version), but we recommend a research prototype called SEMINAL developed by Ben Lerner here at UW. SEMINAL differs from OCaml only in how it presents error messages from the type-checker; we believe it is better than the conventional approach, encourage you to use it, and would appreciate any feedback or suggestions.

Installation

Installing SEMINAL

SEMINAL is available on the department Linux machines in /uns/opt/seminal/bin/ocamlc. To use it by default, add /uns/opt/seminal/bin to the head of your $PATH, or alias ocamlc to /uns/opt/seminal/bin/ocamlc. For further information on /uns, see the FAQ at http://www2.cs.washington.edu/uns/faq/uns-user-faq.html#q3.1. Feel free to email Matt and Ben (blerner@cs) if you have any questions using SEMINAL. Information on installing SEMINAL on your own machine is forthcoming; contact one of us if you really want to do this right away.

See below for usage instructions for SEMINAL; in particular if you do not use the -seminal command-line flag, you will not see any difference over the standard OCaml error messages.

SEMINAL does not have a special version of the read/eval/print loop (i.e., ocaml instead of ocamlc). There is a /uns/opt/seminal/bin/ocaml, but you cannot give it the -seminal option and you will not get SEMINAL-style error messages from it. However, there is no problem using both ocaml and the SEMINAL ocamlc.

Installing Standard OCaml at UW

If you do not wish to use SEMINAL, you are free to use the standard OCaml compiler. Email me (Matt) or Dan if you have any problems or questions.

• On the department Linux machines: OCaml is installed in /usr/bin/ocaml.
• On Linux: If you run Debian just run 'apt-get install ocaml'. Otherwise, the Caml website (http://caml.inria.fr/ocaml/release-prev.en.html) has both source and binary downloads for Linux.
• On Windows: Caml can be downloaded from the Caml website (http://caml.inria.fr/ocaml/release-prev.en.html). The easiest way to install is to download the Windows binary and run the installer. It requires some Microsoft development tools or Cygwin (http://www.cygwin.com). If you need to install Cygwin, there is also an option for selecting Caml when installing Cygwin packages.
• On Macs: The Caml website (http://caml.inria.fr/ocaml/release-prev.en.html) has both source and binary downloads for OSX.

Running OCaml:

• ocamlc: The Caml byte code compiler (see esp. the -i and -c options)
• ocamlopt: The Caml native code compiler
• ocaml: The read/eval/print loop for Caml

In general, you can use ocaml to experiment on the fly, and ocamlc to compile an entire file at once. To exit ocaml's read-eval-print loop, either use Ctrl+D (only works on Linux boxes), or "exit 0;;" (which works anywhere).

For further information, see part III of the system manual: http://caml.inria.fr/pub/docs/manual-ocaml/index.html

Running SEMINAL:

• ocamlc foo.ml will give you exactly the same output as the unmodified ocamlc compiler.
  
• ocamlc -seminal foo.ml will present a change that will make your program type-check or will present a change that will make one part of your program type-check while indicating that other errors remain. Performing this "triage" (finding the other errors that are ignored for the moment) can be slow, so there is an option...
  
• ocamlc -seminal -no-triage foo.ml will present a change that will make your entire program type-check. This will be quick, but the suggestion can be less precise (such as suggesting you remove a large portion of your program).