Data.GI.CodeGen.Conversions

Documentation

convert :: Text -> BaseCodeGen e Converter -> BaseCodeGen e Text

genConversion :: Text -> Converter -> CodeGen Text

unpackCArray :: Text -> Type -> Transfer -> ExcCodeGen Converter

computeArrayLength :: Text -> Type -> ExcCodeGen Text

callableHasClosures :: Callable -> Bool

Whether the callable has closure arguments (i.e. "user_data" style arguments).

hToF :: Type -> Transfer -> ExcCodeGen Converter

fToH :: Type -> Transfer -> ExcCodeGen Converter

haskellType :: Type -> CodeGen TypeRep

isoHaskellType :: Type -> CodeGen TypeRep

Basically like haskellType, but for types which admit a "isomorphic" version of the Haskell type distinct from the usual Haskell type. Generally the Haskell type we expose is isomorphic to the foreign type, but in some cases, such as callbacks with closure arguments, this does not hold, as we omit the closure arguments. This function returns a type which is actually isomorphic.

foreignType :: Type -> CodeGen TypeRep

argumentType :: [Char] -> Type -> CodeGen ([Char], Text, [Text])

elementType :: Type -> Maybe Type

elementMap :: Type -> Text -> Maybe Text

elementTypeAndMap :: Type -> Text -> Maybe (Type, Text)

isManaged :: Type -> CodeGen Bool

Returns whether the given type corresponds to a ManagedPtr instance (a thin wrapper over a ForeignPtr).

typeIsNullable :: Type -> CodeGen Bool

Returns whether the given type should be represented by a Maybe type on the Haskell side. This applies to all properties which have a C representation in terms of pointers, except for G(S)Lists, for which NULL is a valid G(S)List, and raw pointers, which we just pass through to the Haskell side. Notice that introspection annotations can override this.

typeIsPtr :: Type -> CodeGen Bool

Returns whether the given type is represented by a pointer on the C side.

maybeNullConvert :: Type -> CodeGen (Maybe Text)

If the passed in type is nullable, return the conversion function between the FFI pointer type (may be a Ptr or a FunPtr) and the corresponding Maybe type.

nullPtrForType :: Type -> CodeGen (Maybe Text)

An appropriate NULL value for the given type, for types which are represented by pointers on the C side.

getIsScalar :: Type -> CodeGen Bool

typeAllocInfo :: Type -> CodeGen (Maybe TypeAllocInfo)

Information on how to allocate the given type, if known.

data TypeAllocInfo

Information on how to allocate a type.

Constructors

TypeAllocInfo

Fields

• typeAllocInfoIsBoxed :: Bool
• typeAllocInfoSize :: Int

  In bytes.

apply :: Constructor -> Converter

mapC :: Constructor -> Converter

literal :: Constructor -> Converter

data Constructor

Constructors

P Text

M Text

Id

Instances

Eq Constructor

Methods

(==) :: Constructor -> Constructor -> Bool

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

Show Constructor

Methods

showsPrec :: Int -> Constructor -> ShowS

show :: Constructor -> String

showList :: [Constructor] -> ShowS

IsString Constructor

Methods

fromString :: String -> Constructor