language-c-inline: Inline C & Objective-C code in Haskell for language interoperability

[ bsd3, foreign, language, library ] [ Propose Tags ]

This library provides inline C & Objective-C code using GHC's support for quasi-quotation. In particular, it enables the use of foreign libraries without a dedicated bridge or binding. Here is a tiny example:

nslog :: String -> IO ()
nslog msg = $(objc ['msg :> ''String] (void [cexp| NSLog(@"Here is a message from Haskell: %@", msg) |]))

For more information, see https://github.com/mchakravarty/language-c-inline/wiki.

Known bugs: https://github.com/mchakravarty/language-c-inline/issues

  • New in 0.7.10: Distinction between Class (NSObject pointers) and Struct (C pointers) in both hints and marhsallers.

  • New in 0.7.9: C wrapper names include the filename to disambiguate linker symbols.

  • New in 0.7.8: (1) Record marshalling; (2) foreign pointer-class marshalling; (3) custom type marshallers; (4) marshall raw pointer types. Generated _objc.m files now always include "HsFFI.h" (as the tool can generate type names declared in that header). Marshals Bool as BOOL. Marshal Int and Word to NSInteger and NSUInteger, respectively.

  • New in 0.6.0: Introduction of explicit marshalling hints (for more flexibility and support of GHC 7.8's untyped Template Haskell quotations)

  • New in 0.5.0: Marshalling of numeric types

  • New in 0.4.0: Maybe types are marshalled as pointers that may be nil & bug fixes.

  • New in 0.3.0: Boxed Haskell types without a dedicated type mapping are marshalled using stable pointers.

  • New in 0.2.0: Support for multiple free variables in one inline expression as well as for inline code returning void.

  • New in 0.1.0: We are just getting started! This is just a ROUGH AND HIGHLY EXPERIMENTAL PROTOTYPE.


[Skip to Readme]

Modules

[Index]

Flags

Automatic Flags
NameDescriptionDefault
manualtests

Enables tests that require manual intervention.

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.3.0.0, 0.3.0.1, 0.5.0.0, 0.6.0.0, 0.7.6.0, 0.7.6.1, 0.7.7.0, 0.7.8.0, 0.7.9.0, 0.7.9.1, 0.7.9.2, 0.7.10.0, 0.7.11.0 (info)
Dependencies array, base (>=4.0 && <5), containers (>=0.4), filepath (>=1.2), language-c-quote (>=0.12.1), mainland-pretty (>=0.6 && <0.7), template-haskell [details]
License BSD-3-Clause
Author Manuel M T Chakravarty
Maintainer Manuel M T Chakravarty <chak@justtesting.org>
Category Language, Foreign
Home page https://github.com/mchakravarty/language-c-inline/
Bug tracker https://github.com/mchakravarty/language-c-inline/issues
Source repo head: git clone git://github.com/mchakravarty/language-c-inline.git
Uploaded by ManuelChakravarty at 2017-07-30T12:01:10Z
Distributions NixOS:0.7.11.0
Downloads 9112 total (68 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-07-30 [all 1 reports]

Readme for language-c-inline-0.7.11.0

[back to package description]

Inline C & Objective-C in Haskell

This library uses Template Haskell and language-c-quote, a quasi-quotation library for C-like languages, to provide inline C and Objective-C in Haskell. It extracts the C/Objective-C code automatically, when compiling the Haskell program, and generates marshalling code for common types. The wiki on GitHub details the motivation for this approach.

For further motivation, have a look at the slides of my YOW! Lambda Jam 2014 talk Foreign Inline Code in Haskell.

Building

To build the library, just use cabal install as usual from the source code directory or by installing from Hackage.

You may like to have a look at a minimal example of its use, which you can build as follows:

  • Execute cd tests/objc/minimal; make.
  • Now run the demo executable with ./Minimal.

To build the proof of concept example, do the following:

  • Execute cd tests/objc/concept; make.
  • Now run the demo executable with ./InlineObjC.

To build an example class wrapping a Haskell record, do the following:

  • Execute cd tests/objc/record; make.
  • Now run the demo executable with ./Particle.

To build the more complex Haskell interpreter app:

  • Execute cd tests/objc/app; make.
  • Now open -a HSApp.app.

I tested it with Haskell Platform 2013.2.0.0 (which includes GHC 7.6.3) and it requires the latest version of language-c-quote, which is currently 0.7.7.

Status

The library is in beta and so far focuses on Objective-C. Automatic marshalling support is still somewhat limited. However, it is quite easy to add more types, and I do welcome pull request!