Safe Haskell	None
Language	Haskell2010

GHC.Types.ForeignCall

Synopsis

newtype ForeignCall = CCall CCallSpec
isSafeForeignCall :: ForeignCall -> Bool
data Safety
- = PlaySafe
- | PlayInterruptible
- | PlayRisky
playSafe :: Safety -> Bool
playInterruptible :: Safety -> Bool
data CExportSpec = CExportStatic SourceText CLabelString CCallConv
type CLabelString = FastString
isCLabelString :: CLabelString -> Bool
pprCLabelString :: CLabelString -> SDoc
data CCallSpec = CCallSpec CCallTarget CCallConv Safety
data CCallTarget
- = StaticTarget SourceText CLabelString (Maybe Unit) Bool
- | DynamicTarget
isDynamicTarget :: CCallTarget -> Bool
data CCallConv
- = CCallConv
- | CApiConv
- | StdCallConv
- | PrimCallConv
- | JavaScriptCallConv
defaultCCallConv :: CCallConv
ccallConvToInt :: CCallConv -> Int
ccallConvAttribute :: CCallConv -> SDoc
data Header = Header SourceText FastString
data CType = CType SourceText (Maybe Header) (SourceText, FastString)

Documentation

newtype ForeignCall Source #

Constructors

CCall CCallSpec

Instances

Instances details

Eq ForeignCall #
Instance details Defined in GHC.Types.ForeignCall Methods (==) :: ForeignCall -> ForeignCall -> Bool # (/=) :: ForeignCall -> ForeignCall -> Bool #
Outputable ForeignCall #
Instance details Defined in GHC.Types.ForeignCall Methods ppr :: ForeignCall -> SDoc Source # pprPrec :: Rational -> ForeignCall -> SDoc Source #
Binary ForeignCall #
Instance details Defined in GHC.Types.ForeignCall Methods put_ :: BinHandle -> ForeignCall -> IO () Source # put :: BinHandle -> ForeignCall -> IO (Bin ForeignCall) Source # get :: BinHandle -> IO ForeignCall Source #

isSafeForeignCall :: ForeignCall -> Bool Source #

data Safety Source #

Constructors

PlaySafe

Might invoke Haskell GC, or do a call back, or switch threads, etc. So make sure things are tidy before the call. Additionally, in the threaded RTS we arrange for the external call to be executed by a separate OS thread, i.e., _concurrently_ to the execution of other Haskell threads.

PlayInterruptible

Like PlaySafe, but additionally the worker thread running this foreign call may be unceremoniously killed, so it must be scheduled on an unbound thread.

PlayRisky

None of the above can happen; the call will return without interacting with the runtime system at all. Specifically:

No GC
No call backs
No blocking
No precise exceptions

Instances

Instances details

Eq Safety #
Instance details Defined in GHC.Types.ForeignCall Methods (==) :: Safety -> Safety -> Bool # (/=) :: Safety -> Safety -> Bool #
Data Safety #
Instance details Defined in GHC.Types.ForeignCall Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Safety -> c Safety Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Safety Source # toConstr :: Safety -> Constr Source # dataTypeOf :: Safety -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Safety) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Safety) Source # gmapT :: (forall b. Data b => b -> b) -> Safety -> Safety Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Safety -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Safety -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Safety -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Safety -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Safety -> m Safety Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Safety -> m Safety Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Safety -> m Safety Source #
Show Safety #
Instance details Defined in GHC.Types.ForeignCall Methods showsPrec :: Int -> Safety -> ShowS Source # show :: Safety -> String Source # showList :: [Safety] -> ShowS Source #
Outputable Safety #
Instance details Defined in GHC.Types.ForeignCall Methods ppr :: Safety -> SDoc Source # pprPrec :: Rational -> Safety -> SDoc Source #
Binary Safety #
Instance details Defined in GHC.Types.ForeignCall Methods put_ :: BinHandle -> Safety -> IO () Source # put :: BinHandle -> Safety -> IO (Bin Safety) Source # get :: BinHandle -> IO Safety Source #

playSafe :: Safety -> Bool Source #

playInterruptible :: Safety -> Bool Source #

data CExportSpec Source #

Constructors

CExportStatic SourceText CLabelString CCallConv

Instances

Instances details

Data CExportSpec #
Instance details Defined in GHC.Types.ForeignCall Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CExportSpec -> c CExportSpec Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CExportSpec Source # toConstr :: CExportSpec -> Constr Source # dataTypeOf :: CExportSpec -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CExportSpec) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CExportSpec) Source # gmapT :: (forall b. Data b => b -> b) -> CExportSpec -> CExportSpec Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CExportSpec -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CExportSpec -> r Source # gmapQ :: (forall d. Data d => d -> u) -> CExportSpec -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> CExportSpec -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CExportSpec -> m CExportSpec Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CExportSpec -> m CExportSpec Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CExportSpec -> m CExportSpec Source #
Outputable CExportSpec #
Instance details Defined in GHC.Types.ForeignCall Methods ppr :: CExportSpec -> SDoc Source # pprPrec :: Rational -> CExportSpec -> SDoc Source #
Binary CExportSpec #
Instance details Defined in GHC.Types.ForeignCall Methods put_ :: BinHandle -> CExportSpec -> IO () Source # put :: BinHandle -> CExportSpec -> IO (Bin CExportSpec) Source # get :: BinHandle -> IO CExportSpec Source #

type CLabelString = FastString Source #

isCLabelString :: CLabelString -> Bool Source #

pprCLabelString :: CLabelString -> SDoc Source #

data CCallSpec Source #

Constructors

CCallSpec CCallTarget CCallConv Safety

Instances

Instances details

Eq CCallSpec #
Instance details Defined in GHC.Types.ForeignCall Methods (==) :: CCallSpec -> CCallSpec -> Bool # (/=) :: CCallSpec -> CCallSpec -> Bool #
Outputable CCallSpec #
Instance details Defined in GHC.Types.ForeignCall Methods ppr :: CCallSpec -> SDoc Source # pprPrec :: Rational -> CCallSpec -> SDoc Source #
Binary CCallSpec #
Instance details Defined in GHC.Types.ForeignCall Methods put_ :: BinHandle -> CCallSpec -> IO () Source # put :: BinHandle -> CCallSpec -> IO (Bin CCallSpec) Source # get :: BinHandle -> IO CCallSpec Source #

data CCallTarget Source #

How to call a particular function in C-land.

Constructors

StaticTarget SourceText CLabelString (Maybe Unit) Bool
DynamicTarget

Instances

Instances details

Eq CCallTarget #
Instance details Defined in GHC.Types.ForeignCall Methods (==) :: CCallTarget -> CCallTarget -> Bool # (/=) :: CCallTarget -> CCallTarget -> Bool #
Data CCallTarget #
Instance details Defined in GHC.Types.ForeignCall Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CCallTarget -> c CCallTarget Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CCallTarget Source # toConstr :: CCallTarget -> Constr Source # dataTypeOf :: CCallTarget -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CCallTarget) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CCallTarget) Source # gmapT :: (forall b. Data b => b -> b) -> CCallTarget -> CCallTarget Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CCallTarget -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CCallTarget -> r Source # gmapQ :: (forall d. Data d => d -> u) -> CCallTarget -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> CCallTarget -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CCallTarget -> m CCallTarget Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CCallTarget -> m CCallTarget Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CCallTarget -> m CCallTarget Source #
Binary CCallTarget #
Instance details Defined in GHC.Types.ForeignCall Methods put_ :: BinHandle -> CCallTarget -> IO () Source # put :: BinHandle -> CCallTarget -> IO (Bin CCallTarget) Source # get :: BinHandle -> IO CCallTarget Source #

isDynamicTarget :: CCallTarget -> Bool Source #

data CCallConv Source #

Constructors

CCallConv
CApiConv
StdCallConv
PrimCallConv
JavaScriptCallConv

Instances

Instances details

Eq CCallConv #
Instance details Defined in GHC.Types.ForeignCall Methods (==) :: CCallConv -> CCallConv -> Bool # (/=) :: CCallConv -> CCallConv -> Bool #
Data CCallConv #
Instance details Defined in GHC.Types.ForeignCall Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CCallConv -> c CCallConv Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CCallConv Source # toConstr :: CCallConv -> Constr Source # dataTypeOf :: CCallConv -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CCallConv) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CCallConv) Source # gmapT :: (forall b. Data b => b -> b) -> CCallConv -> CCallConv Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CCallConv -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CCallConv -> r Source # gmapQ :: (forall d. Data d => d -> u) -> CCallConv -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> CCallConv -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CCallConv -> m CCallConv Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CCallConv -> m CCallConv Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CCallConv -> m CCallConv Source #
Outputable CCallConv #
Instance details Defined in GHC.Types.ForeignCall Methods ppr :: CCallConv -> SDoc Source # pprPrec :: Rational -> CCallConv -> SDoc Source #
Binary CCallConv #
Instance details Defined in GHC.Types.ForeignCall Methods put_ :: BinHandle -> CCallConv -> IO () Source # put :: BinHandle -> CCallConv -> IO (Bin CCallConv) Source # get :: BinHandle -> IO CCallConv Source #

defaultCCallConv :: CCallConv Source #

ccallConvToInt :: CCallConv -> Int Source #

ccallConvAttribute :: CCallConv -> SDoc Source #

data Header Source #

Constructors

SourceText FastString

Instances

Instances details

Eq Header #
Instance details Defined in GHC.Types.ForeignCall Methods (==) :: Header -> Header -> Bool # (/=) :: Header -> Header -> Bool #
Data Header #
Instance details Defined in GHC.Types.ForeignCall Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Header -> c Header Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Header Source # toConstr :: Header -> Constr Source # dataTypeOf :: Header -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Header) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Header) Source # gmapT :: (forall b. Data b => b -> b) -> Header -> Header Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Header -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Header -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Header -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Header -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Header -> m Header Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Header -> m Header Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Header -> m Header Source #
Outputable Header #
Instance details Defined in GHC.Types.ForeignCall Methods ppr :: Header -> SDoc Source # pprPrec :: Rational -> Header -> SDoc Source #
Binary Header #
Instance details Defined in GHC.Types.ForeignCall Methods put_ :: BinHandle -> Header -> IO () Source # put :: BinHandle -> Header -> IO (Bin Header) Source # get :: BinHandle -> IO Header Source #

data CType Source #

A C type, used in CAPI FFI calls

AnnKeywordId : AnnOpen '{-# CTYPE', AnnHeader,AnnVal, AnnClose '#-}',

Constructors

CType SourceText (Maybe Header) (SourceText, FastString)

Instances

Instances details

Eq CType #
Instance details Defined in GHC.Types.ForeignCall Methods (==) :: CType -> CType -> Bool # (/=) :: CType -> CType -> Bool #
Data CType #
Instance details Defined in GHC.Types.ForeignCall Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CType -> c CType Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CType Source # toConstr :: CType -> Constr Source # dataTypeOf :: CType -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CType) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CType) Source # gmapT :: (forall b. Data b => b -> b) -> CType -> CType Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CType -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CType -> r Source # gmapQ :: (forall d. Data d => d -> u) -> CType -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> CType -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CType -> m CType Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CType -> m CType Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CType -> m CType Source #
Outputable CType #
Instance details Defined in GHC.Types.ForeignCall Methods ppr :: CType -> SDoc Source # pprPrec :: Rational -> CType -> SDoc Source #
Binary CType #
Instance details Defined in GHC.Types.ForeignCall Methods put_ :: BinHandle -> CType -> IO () Source # put :: BinHandle -> CType -> IO (Bin CType) Source # get :: BinHandle -> IO CType Source #