Foreign.Hoppy.Generator.Types

Concrete C++ types. It is possible to represent invalid C++ types with these functions, but we try to catch these and fail cleanly as much as possible.

Primitive types

voidT :: Type

C++ void, Haskell ().

boolT :: Type

C++ bool, Haskell Bool.

charT :: Type

C++ char, Haskell CChar.

ucharT :: Type

C++ unsigned char, Haskell CUChar.

shortT :: Type

C++ short int, Haskell CShort.

ushortT :: Type

C++ unsigned short int, Haskell CUShort.

intT :: Type

C++ int, Haskell CInt.

uintT :: Type

C++ unsigned int, Haskell CUInt.

longT :: Type

C++ long int, Haskell CLong.

ulongT :: Type

C++ unsigned long int, Haskell CULong.

llongT :: Type

C++ long long int, Haskell CLLong.

ullongT :: Type

C++ unsigned long long int, Haskell CULLong.

floatT :: Type

C++ float, Haskell CFloat.

doubleT :: Type

C++ double, Haskell CDouble.

int8T :: Type

C++ int8_t, Haskell Int8.

int16T :: Type

C++ int16_t, Haskell Int16.

int32T :: Type

C++ int32_t, Haskell Int32.

int64T :: Type

C++ int64_t, Haskell Int64.

word8T :: Type

C++ uint8_t, Haskell Word8.

word16T :: Type

C++ uint16_t, Haskell Word16.

word32T :: Type

C++ uint32_t, Haskell Word32.

word64T :: Type

C++ uint64_t, Haskell Word64.

ptrdiffT :: Type

C++ ptrdiff_t, Haskell CPtrdiff.

sizeT :: Type

C++ size_t, Haskell CSize.

ssizeT :: Type

C++ ssize_t, Haskell CSsize.

Complex types

enumT :: CppEnum -> Type

A C++ enum value.

bitspaceT :: Bitspace -> Type

A C++ bitspace value.

ptrT :: Type -> Type

A pointer to another type.

refT :: Type -> Type

A reference to another type.

fnT :: [Type] -> Type -> Type

A function taking parameters and returning a value (or voidT). Function pointers must wrap a fnT in a ptrT.

callbackT :: Callback -> Type

A handle for calling foreign code from C++.

objT :: Class -> Type

An instance of a class. When used in a parameter or return type and not wrapped in a ptrT or refT, this is a by-value object.

objToHeapT :: Class -> Type

A special case of objT that is only allowed when passing objects from C++ to a foreign language. Rather than looking at the object's ClassConversion, the object will be copied to the heap, and a pointer to the heap object will be passed. The object must be copy-constructable.

The foreign language owns the pointer, even for callback arguments.

toGcT :: Type -> Type

This type transfers ownership of the object to the foreign language's garbage collector, and results in a managed pointer in the foreign language. This may only be used in one of the forms below, when passing data from C++ to a foreign language (i.e. in a C++ function return type or in a callback argument). In the first case, the temporary object is copied to the heap, and the result is a managed pointer to the heap object instead of the temporary.

• toGcT (objT cls)

• toGcT (refT (constT (objT cls)))

• toGcT (refT (objT cls))

• toGcT (ptrT (constT (objT cls)))

• toGcT (ptrT (objT cls))

constT :: Type -> Type

A const version of another type.