Generate code to call C++ libraries from other languages
Python CMake C++ Java C# Swift Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.vscode
cmake
demos
docs
externals Add minimal tests for Java bindings (#345) Feb 24, 2018
ffig
scripts
tests
.appveyor.yml
.clang-format
.dockerignore
.gitignore
.gitmodules
.travis.yml
.ycm_extra_conf.py
CMakeLists.txt
CODE_OF_CONDUCT.md
Dockerfile
LICENSE
README.md
requirements.txt Autopep8 requirements, missing Ninja check, install docs fix. Apr 5, 2018

README.md

Build status (on Travis-CI): Build Status

Build status (on AppVeyor): Build Status

FFIG - a Foreign Function Interface Generator.

This project uses libclang to read existing C++ class definitions and create equivalent classes in other languages (primarily Python for now) and binds them to the C++ implementation.

A Comparison of FFIG with SWIG

While similar to SWIG, http://www.swig.org, FFIG does not need an interface generation language to be used nor do the bindings it generates depend on any binary details of an interpreter. FFIG Python bindings will run on PyPy, Python2 and Python3 without requiring changes.

FFIG is in early development. We welcome feedback from users but would encourage anyone looking to generate language bindings to look at SWIG.

Setup (Linux)

You will need Python (2 or 3), ninja-build, cmake, and gcc (or clang).

You will need libclang >=5.0.

libclang can be installed from here: http://llvm.org/releases/

If you use a package manager to install libclang you may need to set up a symlink so that the name libclang.so exists.

Set LD_LIBRARY_PATH so that libclang can be found.

Setup (macOS)

Install Ninja build.

Install Xcode 9.3 or later. FFIG will use the version of libclang distributed with Xcode.

Setup (Windows)

Work in progress, minor issues expected.

Setup (Generic)

The following steps will need to be performed for all build platforms.

Submodules

Tests use the 'catch' test framework: https://github.com/philsquared/Catch.git

To get the submodule run:

git submodule update --init

Package Dependencies

Python package dependencies can be installed with

pip[3] install -r requirements.txt

Ruby dependencies can be installed with

gem install ffi

Building

The build uses cmake driven by a simple Python script. To build and run tests, run the following from the console:

./scripts/build.py -t [--python-path=$(which python3)]

Issues

Please raise github issues if code cannot be generated where expected or if generated code does not behave as expected.

Contributing

Contributions are very welcome, please look at unassigned github issues or raise issues for suggested improvements.

Git Hooks

We have a Git pre-push hook, scripts/pre-push.py, which runs the code formatting checks (scripts/codechecks.py) and prevents a push happening if the code checks failed. This avoids a CI test cycle for simple formatting errors.

To install this git hook, you can run scripts/install-git-hooks.py, which will link the script into your .git/hooks directory.

Attribution

We've made considerable use of the following in putting this together:

Design of the python bindings is taken from clang's cindex.

Mistakes are our own.