To install you can either build the source or download
fact.byte. We recommend to build from source if possible.
fact.byte is the executable used to compile FaCT programs. Execute
./fact.byte for a list of the command line options.
./fact.byte ex.fact to compile a FaCT program where
ex.fact is the name of your file.
Many debugging options and intermediate data structures are available. Run
./fact.byte -help for all options.
Set Up And Build On Local Machine
FaCT is developed using Ocaml and LLVM 3.8. Make sure both of these are installed. On OS X it can be done with brew.
brew install ocaml brew install llvm38
We also need dependency management for Ocaml.
brew install opam
Then we need the actual dependencies for Ocaml.
opam install llvm.3.8 core.v0.9.2 ounit.2.0.7 ctypes-foreign.0.4.0 utop.2.1.0 dolog.3.0 menhir.20171222 oasis.0.4.10 ppx_deriving.4.2.1 ANSITerminal.0.8 ocamlgraph.1.8.8 yojson.1.4.0 jbuilder.1.0+beta16
If you have not setup oasis, then you must do that first.
Then we must configure oasis.
If you're having trouble, try reconfiguring your opam env.
eval $(opam config env)
Finally we can build the compiler.
If you want to add a dependency, add it to
_oasis, then run the 3 previous commands again.
This will give us the
To install FaCT, run the command
This will add FaCT to your path so that you can compile const files with the command,
Link to a C library
FaCT is designed to be called from C code. In order to do so, write your FaCT functions and compile them. This will output an object file. This can then be linked to a C file. A full working example is in the
example directory. First, we must compile
main.c in the
cd example/ clang -c main.c
Then we compile
ex.fact using FaCT. This requires clang to use version ≥3.8:
Next, we link them together:
clang -o final main.o ex.o
Finally, we can run the executable: