BitsyLLVM (also "bitsyc") is a compiler for the Bitsy language implemented in C++ using the LLVM framework to handle the code generation step.
After cloning this repository, create a build
folder at the project root,
enter it
mkdir -p bitsy-llvm/build
cd bitsy-llvm/build
and run CMake like:
cmake \
-DCMAKE_C_COMPILER=clang \
-DCMAKE_CXX_COMPILER=clang++ \
-DLLVM_DIR=/path/to/llvm/installation \
..
Make sure that there is an installation of LLVM on your system. Although not
strictly necessary, it is recommended to use the Clang compiler bundled with the
LLVM installation to build bitsyc. The same compiler may be used at runtime if
bitsyc is asked to produce an executable of a given Bitsy program instead of
executing it just-in-time. CMake needs to find the LLVM configuration
(LLVM_DIR
). In case you do not use your system's default compiler, make sure
that the values of CMAKE_C_COMPILER
and CMAKE_CXX_COMPILER
can be found in
the PATH
or use absolute paths.
Finally, build bitsyc with the build tool (Make, Ninja, ...) CMake has chosen or
which you specified in the cmake
call above with the -G
argument. Depending
on the chosen build tool, the bitsyc executable is located somewhere in build
,
typically (for Make, Ninja, ...) it is build/bitsyc
.
The compiler bitsyc accepts some command line options. They can be displayed by
bitsyc --help
. By default the compiler executes the given Bitsy program
directly and prints its output to standard output. All intermediate files will
be put into a temporary directory on your system.
You may pass the path to bitsyc to the runspec
script in the
Bitsy repository to run all its
reference tests against it.