auto-FFI

auto-FFI is licensed under the GNU Affero General Public License v3.0.

Overview

A tool to generate Haskell FFI binding for C/C++ API.

It reads the configuration from the <file>s and writes the result to the specified output files.

Build

auto-FFI is developed and tested with LLVM/Clang 9 and libfmt 6.2.

LLVM 10 changed signature for clang::tooling::FrontendActionFactory::create, so auto-FFI is currently not compatible with LLVM 10. (Transition to LLVM 10 is planned, though not prioritised.) Other versions of LLVM/Clang/libfmt are not tested.

Build from Source

• Install LLVM, Clang, libfmt, spdlog, and Inja.

  • LLVM/Clang: Use the pre-built binaries or compile from source.
    • e.g. In the Travis CI build script, I install from LLVM's official apt repo (Ubuntu/Debian only).
    • Note that the pre-built binary packages for Windows do not have C++ headers with them, and thus are not usable.
  • libfmt: Follow the instructions on the official website
    • e.g. In the Travis CI build script, I clone the GitHub repo, check out tag 6.2.0, and use CMake to build the package.
  • spdlog: Follow the instructions here
    • e.g. In the Travis CI build script, I clone the GitHub repo, check out tag v1.5.0, and use CMake to build the package.
  • Inja: Follow the instructions here
    • e.g. In the Travis CI build script, I clone the GitHub repo, check out tag v2.2.0, and use CMake to build the package.

• Use CMake to build from source:

  • e.g. on UNIX-like systems (or MSYS2 on Windows):

  git clone git://github.com/Krantz-XRF/auto-FFI
  cd auto-FFI
  mkdir build && cd build
  cmake ..
  cmake --build .

  • e.g. on Windows: Visual Studio 2019 has CMake support.

Troubleshooting

If you have multiple version of LLVM/Clang installed, or if CMake fails to find your installation, you may want to define CMAKE_PREFIX_PATH (or LLVM_DIR and Clang_DIR) when invoking CMake.

Usage

auto-FFI [options] [<file> ...]

Options

• Generic Options:

  Option	Description
  --help	Display available options (--help-hidden for more)
  --help-list	Display list of available options (--help-list-hidden for more)
  --version	Display the version of this program

• auto-FFI Options:

  Option	Description
  --dump-config	Dump configuration options to stdout and exit.
  --verbose	Print verbose output message.
  --yaml	Dump YAML for entities.

Configuration File

The configuration file of auto-FFI use the YAML format. To begin, run auto-FFI --dump-config > config.yaml to get an example configuration file. The option names should be self-explanatory.

Code Generation Template

The code generation template of auto-FFI can be found in the source tree. Also, run auto-FFI --dump-template > template.hs will provide you the default template. For template grammar, refer to documentation of Inja.

Read More

Please refer to the Releases page for my presentation slides and reports.