FFI imports packaging utility

From HaskellWiki
Revision as of 04:10, 28 January 2006 by DimitryGolubovsky (talk | contribs)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Note: This page contains a progressing draft of the documentation for an extension to HSFFIG to create Haskell packages for FFI imports. Once this page is complete this note will be removed. Dimitry Golubovsky

The FFI Packaging Utility

Abstract

This document contains user manual for the FFI Packaging Utility (ffipkg) which is an extension to HSFFIG.

Why Package FFI Imports

Typically, when building a Haskell applications calling foreign functions from some library directly, certain things are taken into consideration such as location of the library header files and the library itself.

The hsffig tool automatically preprocesses library header files and generates FFI import statements for all foreign functions (with few exceptions like variadic functions and functions taking/returning structures) as well as function declarations to access members of C structures and unions.

As a result of such automatic FFI import generation, substantial amount of Haskell code is created which in turn results in subatantial time to compile it.

The Cabal tool assists in creation of packages.

Command Line Options

How It Works

Preprocessing Header Files

Generating FFI Imports

Splitting Haskell Sources

Building Package Libraries

Integration with Cabal

Working Examples

Hello World

Berkeley DB

X11 Transport Protocol

Conclusion