GHC.Types.ForeignStubs

Foreign export stubs

Documentation

data ForeignStubs

Foreign export stubs

Constructors

NoStubs

We don't have any stubs

ForeignStubs CHeader CStub

There are some stubs. Parameters:

1) Header file prototypes for "foreign exported" functions

2) C stubs to use when calling "foreign exported" functions

newtype CHeader

Constructors

CHeader

Fields

• getCHeader :: SDoc

Instances

Semigroup CHeader

Defined in GHC.Types.ForeignStubs

Methods

(<>) :: CHeader -> CHeader -> CHeader

sconcat :: NonEmpty CHeader -> CHeader

stimes :: Integral b => b -> CHeader -> CHeader

Monoid CHeader

Defined in GHC.Types.ForeignStubs

Methods

mempty :: CHeader

mappend :: CHeader -> CHeader -> CHeader

mconcat :: [CHeader] -> CHeader

data CStub

Constructors

CStub

Fields

• getCStub :: SDoc
• getInitializers :: [CLabel]

  Initializers to be run at startup See Note [Initializers and finalizers in Cmm] in GHC.Cmm.InitFini.

• getFinalizers :: [CLabel]

  Finalizers to be run at shutdown

Instances

Semigroup CStub

Defined in GHC.Types.ForeignStubs

Methods

(<>) :: CStub -> CStub -> CStub

sconcat :: NonEmpty CStub -> CStub

stimes :: Integral b => b -> CStub -> CStub

Monoid CStub

Defined in GHC.Types.ForeignStubs

Methods

mempty :: CStub

mappend :: CStub -> CStub -> CStub

mconcat :: [CStub] -> CStub

initializerCStub :: Platform -> CLabel -> SDoc -> SDoc -> CStub

initializerCStub fn_nm decls body is a CStub containing C initializer function (e.g. an entry of the .init_array section) named fn_nm with the given body and the given set of declarations.

finalizerCStub :: Platform -> CLabel -> SDoc -> SDoc -> CStub

finalizerCStub fn_nm decls body is a CStub containing C finalizer function (e.g. an entry of the .fini_array section) named fn_nm with the given body and the given set of declarations.

appendStubC :: ForeignStubs -> CStub -> ForeignStubs