4

I'm trying to bind to a C function that returns a struct (by value). I know I can wrap it manually using the FFI, but can't figure out how to coax c2hs into generating the correct code. It seems to think my function is returning a pointer.

Here's a simple example:

module Point where

#c
struct point {
  int x;
  int y;
};

struct point get_zero(void);
#endc

data Point = Point { x :: Int, y :: Int }

instance Storable Point where
    sizeOf _ = {#sizeof point#}
    alignment _ = {#alignof point#}
    peek p = point <$> liftA fromIntegral ({#get point.x #} p)
                   <*> liftA fromIntegral ({#get point.y #} p)
    poke p s = do {#set point.x #} p (fromIntegral $ x s)
                  {#set point.y #} p (fromIntegral $ y s)

{#pointer *point as PointPtr -> Point#}

-- Causes error:
{#fun get_zero as ^ { } -> `Point'#}

The error:

c2hs: Errors during expansion of binding hooks:

Point.chs:25: (column 28) [ERROR]  >>> Missing "out" marshaller!
  There is no default marshaller for this combination of Haskell and C type:
  Haskell type: Point
  C type      : (Ptr ())
sinelaw
  • 16,205
  • 3
  • 49
  • 80

1 Answers1

4

It is not possible currently. You can make a wrapper that returns the result by pointer:

void get_zero_wrapper(struct point* p) {
  *p = get_zero();
}

Note that you have to allocate space for the structure, e.g. using alloca.

There is a proposal to support passing and returning C structures by value in FFI. But it is unlikely to be implemented in near future because it didn't get enough attention from the community. The proposal needs more careful design, e.g. it is not clear how it will work with other language features.

Yuras
  • 13,856
  • 1
  • 45
  • 58
  • Thanks! I was also trying to see if c2hs can generate this kind of wrapping automatically, I guess the answer is "no". – sinelaw May 16 '15 at 18:09
  • Looked at your proposal - is there any work being done on this? With "modern" C (C99) returning small structs is often a nice way to reduce pointer cruft in APIs, would really be nice to have support for this... – sinelaw May 17 '15 at 10:07