Foreign.Hoppy.Generator.Spec.Callback

Interface for defining foreign language callbacks.

Data type

data Callback

A non-C++ function that can be invoked via a C++ functor or function pointer.

Use this data type's HasReqs instance to add extra requirements, however manually adding requirements for parameter and return types is not necessary.

Instances

Eq Callback

Defined in Foreign.Hoppy.Generator.Spec.Callback

Methods

(==) :: Callback -> Callback -> Bool

(/=) :: Callback -> Callback -> Bool

Show Callback

Defined in Foreign.Hoppy.Generator.Spec.Callback

Methods

showsPrec :: Int -> Callback -> ShowS

show :: Callback -> String

showList :: [Callback] -> ShowS

HasAddendum Callback

Defined in Foreign.Hoppy.Generator.Spec.Callback

Methods

getAddendum :: Callback -> Addendum

setAddendum :: Addendum -> Callback -> Callback

modifyAddendum :: (Addendum -> Addendum) -> Callback -> Callback

Exportable Callback

Defined in Foreign.Hoppy.Generator.Spec.Callback

Methods

toExport :: Callback -> Export

castExport :: (Typeable Callback, Exportable b, Typeable b) => Callback -> Maybe b

sayExportCpp :: SayExportMode -> Callback -> Generator ()

sayExportHaskell :: SayExportMode -> Callback -> Generator ()

getExportEnumInfo :: Callback -> Maybe EnumInfo

getExportExceptionClass :: Callback -> Maybe Class

HasExtNames Callback

Defined in Foreign.Hoppy.Generator.Spec.Callback

Methods

getPrimaryExtName :: Callback -> ExtName

getNestedExtNames :: Callback -> [ExtName]

HasReqs Callback

Defined in Foreign.Hoppy.Generator.Spec.Callback

Methods

getReqs :: Callback -> Reqs

setReqs :: Reqs -> Callback -> Callback

modifyReqs :: (Reqs -> Reqs) -> Callback -> Callback

callbackT :: Callback -> Type

Constructs a type value for a callback.

Construction

makeCallback

Arguments

:: IsParameter p

=> ExtName

-> [p]

Parameter types.

-> Type

Return type.

-> Callback

Creates a binding for constructing callbacks into foreign code.

Properties

callbackExtName :: Callback -> ExtName

The callback's external name.

callbackParams :: Callback -> [Parameter]

The callback's parameters.

callbackReturn :: Callback -> Type

The callback's return type.

callbackReqs :: Callback -> Reqs

Extra requirements for the callback.

callbackAddendum :: Callback -> Addendum

The callback's addendum.

Exceptions

callbackThrows :: Callback -> Maybe Bool

Whether the callback supports throwing C++ exceptions from Haskell into C++ during its execution. When absent, the value is inherited from moduleCallbacksThrow and interfaceCallbacksThrow.

callbackSetThrows :: Bool -> Callback -> Callback

Sets whether a callback supports handling thrown C++ exceptions and passing them into C++.

C++ generator

cppCallbackToTFn :: Callback -> Generator Type

Constructs the function type for a callback. A callback that throws has additional parameters.

Keep this in sync with hsCallbackToTFn.

Names

callbackClassName :: Callback -> String

Returns the name of the outer, copyable C++ class for a callback.

callbackImplClassName :: Callback -> String

Returns the name of the internal, non-copyable implementation C++ class for a callback.

callbackFnName :: Callback -> String

Returns the name of the C++ binding function that creates a C++ callback wrapper object from a function pointer to foreign code.

Haskell generator

hsCallbackToTFn :: HsTypeSide -> Callback -> Generator Type

Constructs the function type for a callback. For Haskell, the type depends on the side; the C++ side has additional parameters.

Keep this in sync with cppCallbackToTFn.

Names

toHsCallbackCtorName :: Callback -> Generator String

The name of the function that takes a Haskell function and wraps it in a callback object. This is internal to the binding; normal users can pass Haskell functions to be used as callbacks inplicitly.

toHsCallbackCtorName' :: Callback -> String

Pure version of toHsCallbackCtorName that doesn't create a qualified name.

toHsCallbackNewFunPtrFnName :: Callback -> Generator String

The name of the function that takes a Haskell function with Haskell-side types and wraps it in a FunPtr that does appropriate conversions to and from C-side types.

toHsCallbackNewFunPtrFnName' :: Callback -> String

Pure version of toHsCallbackNewFunPtrFnName that doesn't create a qualified name.