• Ticc
• API

Ticc Toplevel

When Ticc is compiled, it generates an Ocaml toplevel containing commands to parse, compose, and analyze interfaces. These commands are detailed in the file src/ticc/ticc.mli.

An HTML version of this documentation is also included in the source distribution, as ticc/doc/api/Ticc.html.

You can re-create this HTML version of the documentation at any time by running make apidoc from the top-level of your Ticc source tree.

The Ocaml toplevel enables you to write scripts as inputs to Ticc. You can find many examples of such scripts in the examples directory. As a convention, we name files as follows:

• .si are the files containing interface models. The "si" stands for Sociable Interfaces, the model presented in FROCOS 2005.

• .in are the script files that are fed as input to Ticc. You can run the example test.in in Ticc by typing:

   ticc test.in 

  assuming, of course, that the executable ticc is in your path.

Note: The Ticc executable, src/ticc/ticc, must be left in its directory: you cannot copy it to /usr/local/bin or any other directory. In fact, in Ocaml, a toplevel must "live" in the same place where it was created, or else, it does not know where to load the necessary modules for its execution. There might be a way around this, but we are unaware of it (suggestions are most welcome). However, you can certainly place a symbolic link to src/ticc/ticc in /usr/local/bin.