fficxx - FFI to C++ in Haskell

fficxx (“eff fix”) is an automatic haskell Foreign Function Interface (FFI) generator to C++.

To use fficxx, you write a Haskell model of the C++ public interfaces and fficxx generates both a C wrapper and associated haskell functions and type classes which reflect specified model of the C++ interfaces. It is currently the user’s responsibility to specify a correct model of the C++ interfaces, because fficxx does not presently check for model correctness.

While haskell has a well-specified standard for C FFI, making haskell-C++ FFI is an arbitrary and painful process. Since Object-Oriented Programming (OOP) paradigm and Functional Programming (FP) paradigm are different, automatic translation of C++ libraries to haskell libraries is not a straightforward task. The goal of fficxx is to minimize this disparity and maximize user’s convenience by providing familiar interface to the original C++ library as a result.

One of the projects that successfully uses fficxx is HROOT which is a haskell binding to the ROOT library. A haskell script called HROOT-generate using fficxx generates HROOT packages. Once generated, each package can be directly installable as a cabal package. Currently, C++ interface is defined as a haskell data structure as one can see, for example, in the module HROOT.Data.Core.Class. At this moment, automatic generation from C++ code is not supported yet, but it is planned to be supported.

fficxx is separated into generator part and runtime part:

Haskell packages that are generated from fficxx will be dependent on fficxx-runtime.

Note: How to use fficxx will be explained one by one in here and my blog as it goes.

Getting Started

We provide a very simple sample case in the fficxx/sample directory. fficxx/sample/cxxlib is a sample C++ library. Build the C++ library by
 > sh ./build.sh

in the directory.

fficxx/sample/mysample-generator has a haskell code for generating haskell cabal package for binding to the C++ library. You can start code generation by compling MySampleGen.hs
> ghc MySampleGen.hs 
then run it
> ./MySampleGen

and then it generates a MySample package in the MySample directory which is installable with cabal install. Note that the generated MySample.cabal file has the absolute path for the cxxlib/include and cxxlib/lib. Later, one can change this to an appropriate path.

To test, we provide the code use_mysample.hs in fficxx/sample/mysample-generator. Note that one need to set LD_LIBRARY_PATH (or DYLD_LIBRARY_PATH on Mac OS X) in your environment. For example, if you run in fficxx/sample/mysample-generator, run the following command:
> LD_LIBRARY_PATH=../cxxlib/lib ./use_mysample 


You should see that the C++ library is successfully called as above.

OOP Model in fficxx

To be explained

Supported Feature

Google group mailing list : http://groups.google.com/group/fficxx

Site proudly generated by hakyll.