Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Methods
- argInfoGetClosure
- argInfoGetDestroy
- argInfoGetDirection
- argInfoGetOwnershipTransfer
- argInfoGetScope
- argInfoGetType
- argInfoIsCallerAllocates
- argInfoIsOptional
- argInfoIsReturnValue
- argInfoIsSkip
- argInfoLoadType
- argInfoMayBeNull
- callableInfoCanThrowGerror
- callableInfoGetArg
- callableInfoGetCallerOwns
- callableInfoGetInstanceOwnershipTransfer
- callableInfoGetNArgs
- callableInfoGetReturnAttribute
- callableInfoGetReturnType
- callableInfoInvoke
- callableInfoIsMethod
- callableInfoIterateReturnAttributes
- callableInfoLoadArg
- callableInfoLoadReturnType
- callableInfoMayReturnNull
- callableInfoSkipReturn
- cclosureMarshalGeneric
- constantInfoGetType
- enumInfoGetErrorDomain
- enumInfoGetMethod
- enumInfoGetNMethods
- enumInfoGetNValues
- enumInfoGetStorageType
- enumInfoGetValue
- fieldInfoGetFlags
- fieldInfoGetOffset
- fieldInfoGetSize
- fieldInfoGetType
- functionInfoGetFlags
- functionInfoGetProperty
- functionInfoGetSymbol
- functionInfoGetVfunc
- getMajorVersion
- getMicroVersion
- getMinorVersion
- infoNew
- infoTypeToString
- interfaceInfoFindMethod
- interfaceInfoFindSignal
- interfaceInfoFindVfunc
- interfaceInfoGetConstant
- interfaceInfoGetIfaceStruct
- interfaceInfoGetMethod
- interfaceInfoGetNConstants
- interfaceInfoGetNMethods
- interfaceInfoGetNPrerequisites
- interfaceInfoGetNProperties
- interfaceInfoGetNSignals
- interfaceInfoGetNVfuncs
- interfaceInfoGetPrerequisite
- interfaceInfoGetProperty
- interfaceInfoGetSignal
- interfaceInfoGetVfunc
- invokeErrorQuark
- objectInfoFindMethod
- objectInfoFindMethodUsingInterfaces
- objectInfoFindSignal
- objectInfoFindVfunc
- objectInfoFindVfuncUsingInterfaces
- objectInfoGetAbstract
- objectInfoGetClassStruct
- objectInfoGetConstant
- objectInfoGetField
- objectInfoGetFinal
- objectInfoGetFundamental
- objectInfoGetGetValueFunction
- objectInfoGetInterface
- objectInfoGetMethod
- objectInfoGetNConstants
- objectInfoGetNFields
- objectInfoGetNInterfaces
- objectInfoGetNMethods
- objectInfoGetNProperties
- objectInfoGetNSignals
- objectInfoGetNVfuncs
- objectInfoGetParent
- objectInfoGetProperty
- objectInfoGetRefFunction
- objectInfoGetSetValueFunction
- objectInfoGetSignal
- objectInfoGetTypeInit
- objectInfoGetTypeName
- objectInfoGetUnrefFunction
- objectInfoGetVfunc
- propertyInfoGetFlags
- propertyInfoGetGetter
- propertyInfoGetOwnershipTransfer
- propertyInfoGetSetter
- propertyInfoGetType
- registeredTypeInfoGetGType
- registeredTypeInfoGetTypeInit
- registeredTypeInfoGetTypeName
- signalInfoGetClassClosure
- signalInfoGetFlags
- signalInfoTrueStopsEmit
- structInfoFindField
- structInfoFindMethod
- structInfoGetAlignment
- structInfoGetCopyFunction
- structInfoGetField
- structInfoGetFreeFunction
- structInfoGetMethod
- structInfoGetNFields
- structInfoGetNMethods
- structInfoGetSize
- structInfoIsForeign
- structInfoIsGtypeStruct
- typeInfoArgumentFromHashPointer
- typeInfoGetArrayFixedSize
- typeInfoGetArrayLength
- typeInfoGetArrayType
- typeInfoGetInterface
- typeInfoGetParamType
- typeInfoGetStorageType
- typeInfoGetTag
- typeInfoHashPointerFromArgument
- typeInfoIsPointer
- typeInfoIsZeroTerminated
- typeTagArgumentFromHashPointer
- typeTagHashPointerFromArgument
- typeTagToString
- unionInfoFindMethod
- unionInfoGetAlignment
- unionInfoGetCopyFunction
- unionInfoGetDiscriminator
- unionInfoGetDiscriminatorOffset
- unionInfoGetDiscriminatorType
- unionInfoGetField
- unionInfoGetFreeFunction
- unionInfoGetMethod
- unionInfoGetNFields
- unionInfoGetNMethods
- unionInfoGetSize
- unionInfoIsDiscriminated
- valueInfoGetValue
- vfuncInfoGetAddress
- vfuncInfoGetFlags
- vfuncInfoGetInvoker
- vfuncInfoGetOffset
- vfuncInfoGetSignal
Synopsis
- argInfoGetClosure :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- argInfoGetDestroy :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- argInfoGetDirection :: (HasCallStack, MonadIO m) => BaseInfo -> m Direction
- argInfoGetOwnershipTransfer :: (HasCallStack, MonadIO m) => BaseInfo -> m Transfer
- argInfoGetScope :: (HasCallStack, MonadIO m) => BaseInfo -> m ScopeType
- argInfoGetType :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- argInfoIsCallerAllocates :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- argInfoIsOptional :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- argInfoIsReturnValue :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- argInfoIsSkip :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- argInfoLoadType :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- argInfoMayBeNull :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- callableInfoCanThrowGerror :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- callableInfoGetArg :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- callableInfoGetCallerOwns :: (HasCallStack, MonadIO m) => BaseInfo -> m Transfer
- callableInfoGetInstanceOwnershipTransfer :: (HasCallStack, MonadIO m) => BaseInfo -> m Transfer
- callableInfoGetNArgs :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- callableInfoGetReturnAttribute :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m Text
- callableInfoGetReturnType :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- callableInfoInvoke :: (HasCallStack, MonadIO m) => BaseInfo -> Ptr () -> [Argument] -> [Argument] -> Argument -> Bool -> Bool -> m ()
- callableInfoIsMethod :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- callableInfoIterateReturnAttributes :: (HasCallStack, MonadIO m) => BaseInfo -> AttributeIter -> m (Bool, Text, Text)
- callableInfoLoadArg :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- callableInfoLoadReturnType :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- callableInfoMayReturnNull :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- callableInfoSkipReturn :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- cclosureMarshalGeneric :: (HasCallStack, MonadIO m) => GClosure a -> GValue -> Word32 -> GValue -> Ptr () -> Ptr () -> m ()
- constantInfoGetType :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- enumInfoGetErrorDomain :: (HasCallStack, MonadIO m) => BaseInfo -> m Text
- enumInfoGetMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- enumInfoGetNMethods :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- enumInfoGetNValues :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- enumInfoGetStorageType :: (HasCallStack, MonadIO m) => BaseInfo -> m TypeTag
- enumInfoGetValue :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- fieldInfoGetFlags :: (HasCallStack, MonadIO m) => BaseInfo -> m [FieldInfoFlags]
- fieldInfoGetOffset :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- fieldInfoGetSize :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- fieldInfoGetType :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- functionInfoGetFlags :: (HasCallStack, MonadIO m) => BaseInfo -> m [FunctionInfoFlags]
- functionInfoGetProperty :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- functionInfoGetSymbol :: (HasCallStack, MonadIO m) => BaseInfo -> m Text
- functionInfoGetVfunc :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- getMajorVersion :: (HasCallStack, MonadIO m) => m Word32
- getMicroVersion :: (HasCallStack, MonadIO m) => m Word32
- getMinorVersion :: (HasCallStack, MonadIO m) => m Word32
- infoNew :: (HasCallStack, MonadIO m) => InfoType -> BaseInfo -> Typelib -> Word32 -> m BaseInfo
- infoTypeToString :: (HasCallStack, MonadIO m) => InfoType -> m Text
- interfaceInfoFindMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m BaseInfo
- interfaceInfoFindSignal :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m BaseInfo
- interfaceInfoFindVfunc :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m BaseInfo
- interfaceInfoGetConstant :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- interfaceInfoGetIfaceStruct :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- interfaceInfoGetMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- interfaceInfoGetNConstants :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- interfaceInfoGetNMethods :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- interfaceInfoGetNPrerequisites :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- interfaceInfoGetNProperties :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- interfaceInfoGetNSignals :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- interfaceInfoGetNVfuncs :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- interfaceInfoGetPrerequisite :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- interfaceInfoGetProperty :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- interfaceInfoGetSignal :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- interfaceInfoGetVfunc :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- invokeErrorQuark :: (HasCallStack, MonadIO m) => m Word32
- objectInfoFindMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m (Maybe BaseInfo)
- objectInfoFindMethodUsingInterfaces :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m (Maybe BaseInfo, BaseInfo)
- objectInfoFindSignal :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m (Maybe BaseInfo)
- objectInfoFindVfunc :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m (Maybe BaseInfo)
- objectInfoFindVfuncUsingInterfaces :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m (Maybe BaseInfo, BaseInfo)
- objectInfoGetAbstract :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- objectInfoGetClassStruct :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe BaseInfo)
- objectInfoGetConstant :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- objectInfoGetField :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- objectInfoGetFinal :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- objectInfoGetFundamental :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- objectInfoGetGetValueFunction :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe Text)
- objectInfoGetInterface :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- objectInfoGetMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- objectInfoGetNConstants :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- objectInfoGetNFields :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- objectInfoGetNInterfaces :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- objectInfoGetNMethods :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- objectInfoGetNProperties :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- objectInfoGetNSignals :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- objectInfoGetNVfuncs :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- objectInfoGetParent :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe BaseInfo)
- objectInfoGetProperty :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- objectInfoGetRefFunction :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe Text)
- objectInfoGetSetValueFunction :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe Text)
- objectInfoGetSignal :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- objectInfoGetTypeInit :: (HasCallStack, MonadIO m) => BaseInfo -> m Text
- objectInfoGetTypeName :: (HasCallStack, MonadIO m) => BaseInfo -> m Text
- objectInfoGetUnrefFunction :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe Text)
- objectInfoGetVfunc :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- propertyInfoGetFlags :: (HasCallStack, MonadIO m) => BaseInfo -> m [ParamFlags]
- propertyInfoGetGetter :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe BaseInfo)
- propertyInfoGetOwnershipTransfer :: (HasCallStack, MonadIO m) => BaseInfo -> m Transfer
- propertyInfoGetSetter :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe BaseInfo)
- propertyInfoGetType :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- registeredTypeInfoGetGType :: (HasCallStack, MonadIO m) => BaseInfo -> m GType
- registeredTypeInfoGetTypeInit :: (HasCallStack, MonadIO m) => BaseInfo -> m Text
- registeredTypeInfoGetTypeName :: (HasCallStack, MonadIO m) => BaseInfo -> m Text
- signalInfoGetClassClosure :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- signalInfoGetFlags :: (HasCallStack, MonadIO m) => BaseInfo -> m [SignalFlags]
- signalInfoTrueStopsEmit :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- structInfoFindField :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m BaseInfo
- structInfoFindMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m BaseInfo
- structInfoGetAlignment :: (HasCallStack, MonadIO m) => BaseInfo -> m Word64
- structInfoGetCopyFunction :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe Text)
- structInfoGetField :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- structInfoGetFreeFunction :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe Text)
- structInfoGetMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- structInfoGetNFields :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- structInfoGetNMethods :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- structInfoGetSize :: (HasCallStack, MonadIO m) => BaseInfo -> m Word64
- structInfoIsForeign :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- structInfoIsGtypeStruct :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- typeInfoArgumentFromHashPointer :: (HasCallStack, MonadIO m) => BaseInfo -> Ptr () -> Argument -> m ()
- typeInfoGetArrayFixedSize :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- typeInfoGetArrayLength :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- typeInfoGetArrayType :: (HasCallStack, MonadIO m) => BaseInfo -> m ArrayType
- typeInfoGetInterface :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- typeInfoGetParamType :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- typeInfoGetStorageType :: (HasCallStack, MonadIO m) => BaseInfo -> m TypeTag
- typeInfoGetTag :: (HasCallStack, MonadIO m) => BaseInfo -> m TypeTag
- typeInfoHashPointerFromArgument :: (HasCallStack, MonadIO m) => BaseInfo -> Argument -> m (Ptr ())
- typeInfoIsPointer :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- typeInfoIsZeroTerminated :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- typeTagArgumentFromHashPointer :: (HasCallStack, MonadIO m) => TypeTag -> Ptr () -> Argument -> m ()
- typeTagHashPointerFromArgument :: (HasCallStack, MonadIO m) => TypeTag -> Argument -> m (Ptr ())
- typeTagToString :: (HasCallStack, MonadIO m) => TypeTag -> m Text
- unionInfoFindMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Text -> m BaseInfo
- unionInfoGetAlignment :: (HasCallStack, MonadIO m) => BaseInfo -> m Word64
- unionInfoGetCopyFunction :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe Text)
- unionInfoGetDiscriminator :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- unionInfoGetDiscriminatorOffset :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- unionInfoGetDiscriminatorType :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- unionInfoGetField :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- unionInfoGetFreeFunction :: (HasCallStack, MonadIO m) => BaseInfo -> m (Maybe Text)
- unionInfoGetMethod :: (HasCallStack, MonadIO m) => BaseInfo -> Int32 -> m BaseInfo
- unionInfoGetNFields :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- unionInfoGetNMethods :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- unionInfoGetSize :: (HasCallStack, MonadIO m) => BaseInfo -> m Word64
- unionInfoIsDiscriminated :: (HasCallStack, MonadIO m) => BaseInfo -> m Bool
- valueInfoGetValue :: (HasCallStack, MonadIO m) => BaseInfo -> m Int64
- vfuncInfoGetAddress :: (HasCallStack, MonadIO m) => BaseInfo -> GType -> m (Ptr ())
- vfuncInfoGetFlags :: (HasCallStack, MonadIO m) => BaseInfo -> m [VFuncInfoFlags]
- vfuncInfoGetInvoker :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
- vfuncInfoGetOffset :: (HasCallStack, MonadIO m) => BaseInfo -> m Int32
- vfuncInfoGetSignal :: (HasCallStack, MonadIO m) => BaseInfo -> m BaseInfo
Methods
argInfoGetClosure
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: index of the user data argument or -1 if there is none |
Obtain the index of the user data argument. This is only valid for arguments which are callbacks.
argInfoGetDestroy
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: index of the |
Obtains the index of the DestroyNotify
argument. This is only valid
for arguments which are callbacks.
argInfoGetDirection
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Direction | Returns: the direction |
Obtain the direction of the argument. Check Direction
for possible
direction values.
argInfoGetOwnershipTransfer
argInfoGetOwnershipTransfer Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Transfer | Returns: the transfer |
Obtain the ownership transfer for this argument.
Transfer
contains a list of possible values.
argInfoGetScope
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m ScopeType | Returns: the scope type |
Obtain the scope type for this argument. The scope type explains
how a callback is going to be invoked, most importantly when
the resources required to invoke it can be freed.
ScopeType
contains a list of possible values.
argInfoGetType
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
Obtain the type information for info
.
argInfoIsCallerAllocates
argInfoIsCallerAllocates Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Obtain if the argument is a pointer to a struct or object that will
receive an output of a function. The default assumption for
DirectionOut
arguments which have allocation is that the
callee allocates; if this is True
, then the caller must allocate.
argInfoIsOptional
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Obtain if the argument is optional. For 'out' arguments this means
that you can pass Nothing
in order to ignore the result.
argInfoIsReturnValue
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Obtain if the argument is a return value. It can either be a parameter or a return value.
argInfoIsSkip
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Obtain if an argument is only useful in C.
Since: 1.30
argInfoLoadType
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo |
Obtain information about a the type of given argument info
; this
function is a variant of argInfoGetType
designed for stack
allocation.
The initialized type
must not be referenced after info
is deallocated.
argInfoMayBeNull
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool |
Obtain if the type of the argument includes the possibility of Nothing
.
For 'in' values this means that Nothing
is a valid value. For 'out'
values, this means that Nothing
may be returned.
See also argInfoIsOptional
.
callableInfoCanThrowGerror
callableInfoCanThrowGerror Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
TODO
Since: 1.34
callableInfoGetArg
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain information about a particular argument of this callable.
callableInfoGetCallerOwns
callableInfoGetCallerOwns Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Transfer | Returns: the transfer mode for the return value of the callable |
See whether the caller owns the return value of this callable.
Transfer
contains a list of possible transfer values.
callableInfoGetInstanceOwnershipTransfer
callableInfoGetInstanceOwnershipTransfer Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Transfer | Returns: the transfer mode of the instance argument |
Obtains the ownership transfer for the instance argument.
Transfer
contains a list of possible transfer values.
Since: 1.42
callableInfoGetNArgs
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: The number of arguments this callable expects. |
Obtain the number of arguments (both IN and OUT) for this callable.
callableInfoGetReturnAttribute
callableInfoGetReturnAttribute Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m Text | Returns: The value of the attribute, or |
Retrieve an arbitrary attribute associated with the return value.
callableInfoGetReturnType
callableInfoGetReturnType Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
Obtain the return type of a callable item as a GITypeInfo
.
callableInfoInvoke
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Ptr () |
|
-> [Argument] |
|
-> [Argument] |
|
-> Argument |
|
-> Bool |
|
-> Bool |
|
-> m () | (Can throw |
TODO
callableInfoIsMethod
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool |
Determines if the callable info is a method. For GIVFuncInfo
s,
GICallbackInfo
s, and GISignalInfo
s,
this is always true. Otherwise, this looks at the FunctionInfoFlagsIsMethod
flag on the GIFunctionInfo
.
Concretely, this function returns whether callableInfoGetNArgs
matches the number of arguments in the raw C method. For methods, there
is one more C argument than is exposed by introspection: the "self"
or "this" object.
Since: 1.34
callableInfoIterateReturnAttributes
callableInfoIterateReturnAttributes Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> AttributeIter |
|
-> m (Bool, Text, Text) | Returns: |
Iterate over all attributes associated with the return value. The
iterator structure is typically stack allocated, and must have its
first member initialized to Nothing
.
Both the name
and value
should be treated as constants
and must not be freed.
See baseInfoIterateAttributes
for an example of how to use a
similar API.
callableInfoLoadArg
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo |
Obtain information about a particular argument of this callable; this
function is a variant of callableInfoGetArg
designed for stack
allocation.
The initialized arg
must not be referenced after info
is deallocated.
callableInfoLoadReturnType
callableInfoLoadReturnType Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo |
Obtain information about a return value of callable; this
function is a variant of callableInfoGetReturnType
designed for stack
allocation.
The initialized type
must not be referenced after info
is deallocated.
callableInfoMayReturnNull
callableInfoMayReturnNull Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool |
See if a callable could return Nothing
.
callableInfoSkipReturn
callableInfoSkipReturn Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
See if a callable's return value is only useful in C.
cclosureMarshalGeneric
cclosureMarshalGeneric :: (HasCallStack, MonadIO m) => GClosure a -> GValue -> Word32 -> GValue -> Ptr () -> Ptr () -> m () Source #
No description available in the introspection data.
constantInfoGetType
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
Obtain the type of the constant as a GITypeInfo
.
enumInfoGetErrorDomain
enumInfoGetErrorDomain Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Text | Returns: the string form of the error domain associated
with this enum, or |
Obtain the string form of the quark for the error domain associated with this enum, if any.
Since: 1.30
enumInfoGetMethod
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an enum type method at index n
.
Since: 1.30
enumInfoGetNMethods
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of methods |
Obtain the number of methods that this enum type has.
Since: 1.30
enumInfoGetNValues
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: the number of enumeration values |
Obtain the number of values this enumeration contains.
enumInfoGetStorageType
enumInfoGetStorageType Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m TypeTag | Returns: the storage type for the enumeration |
Obtain the tag of the type used for the enum in the C ABI. This will will be a signed or unsigned integral type.
Note that in the current implementation the width of the type is computed correctly, but the signed or unsigned nature of the type may not match the sign of the type used by the C compiler.
enumInfoGetValue
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the enumeration value or |
Obtain a value for this enumeration.
fieldInfoGetFlags
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m [FieldInfoFlags] | Returns: the flags |
Obtain the flags for this GIFieldInfo
. See FieldInfoFlags
for possible
flag values.
fieldInfoGetOffset
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: the field offset |
Obtain the offset in bytes of the field member, this is relative to the beginning of the struct or union.
fieldInfoGetSize
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: the field size |
Obtain the size in bits of the field member, this is how much space you need to allocate to store the field.
fieldInfoGetType
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
Obtain the type of a field as a GITypeInfo
.
functionInfoGetFlags
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m [FunctionInfoFlags] | Returns: the flags |
Obtain the FunctionInfoFlags
for the info
.
functionInfoGetProperty
functionInfoGetProperty Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the property or |
Obtain the property associated with this GIFunctionInfo
.
Only GIFunctionInfo
with the flag FunctionInfoFlagsIsGetter
or
FunctionInfoFlagsIsSetter
have a property set. For other cases,
Nothing
will be returned.
functionInfoGetSymbol
functionInfoGetSymbol Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Text | Returns: the symbol |
Obtain the symbol of the function. The symbol is the name of the
exported function, suitable to be used as an argument to
g_module_symbol()
.
functionInfoGetVfunc
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the virtual function or |
Obtain the virtual function associated with this GIFunctionInfo
.
Only GIFunctionInfo
with the flag FunctionInfoFlagsWrapsVfunc
has
a virtual function set. For other cases, Nothing
will be returned.
getMajorVersion
:: (HasCallStack, MonadIO m) | |
=> m Word32 | Returns: the major version number of the girepository library |
Returns the major version number of the girepository library. (e.g. in version 1.58.2 this is 1.)
Since: 1.60
getMicroVersion
:: (HasCallStack, MonadIO m) | |
=> m Word32 | Returns: the micro version number of the girepository library |
Returns the micro version number of the girepository library. (e.g. in version 1.58.2 this is 2.)
Since: 1.60
getMinorVersion
:: (HasCallStack, MonadIO m) | |
=> m Word32 | Returns: the minor version number of the girepository library |
Returns the minor version number of the girepository library. (e.g. in version 1.58.2 this is 58.)
Since: 1.60
infoNew
:: (HasCallStack, MonadIO m) | |
=> InfoType |
|
-> BaseInfo |
|
-> Typelib |
|
-> Word32 |
|
-> m BaseInfo | Returns: TODO |
TODO
infoTypeToString
:: (HasCallStack, MonadIO m) | |
=> InfoType |
|
-> m Text | Returns: the string |
Obtain a string representation of type
interfaceInfoFindMethod
interfaceInfoFindMethod Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m BaseInfo | Returns: the |
Obtain a method of the interface type given a name
. Nothing
will be
returned if there's no method available with that name.
interfaceInfoFindSignal
interfaceInfoFindSignal Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m BaseInfo | Returns: Info for the signal with name |
TODO
Since: 1.34
interfaceInfoFindVfunc
interfaceInfoFindVfunc Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m BaseInfo | Returns: the |
Locate a virtual function slot with name name
. See the documentation
for objectInfoFindVfunc
for more information on virtuals.
interfaceInfoGetConstant
interfaceInfoGetConstant Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an interface type constant at index n
.
interfaceInfoGetIfaceStruct
interfaceInfoGetIfaceStruct Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
Returns the layout C structure associated with this GInterface
.
interfaceInfoGetMethod
interfaceInfoGetMethod Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an interface type method at index n
.
interfaceInfoGetNConstants
interfaceInfoGetNConstants Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of constants |
Obtain the number of constants that this interface type has.
interfaceInfoGetNMethods
interfaceInfoGetNMethods Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of methods |
Obtain the number of methods that this interface type has.
interfaceInfoGetNPrerequisites
interfaceInfoGetNPrerequisites Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of prerequisites |
Obtain the number of prerequisites for this interface type. A prerequisites is another interface that needs to be implemented for interface, similar to an base class for GObjects.
interfaceInfoGetNProperties
interfaceInfoGetNProperties Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of properties |
Obtain the number of properties that this interface type has.
interfaceInfoGetNSignals
interfaceInfoGetNSignals Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of signals |
Obtain the number of signals that this interface type has.
interfaceInfoGetNVfuncs
interfaceInfoGetNVfuncs Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of virtual functions |
Obtain the number of virtual functions that this interface type has.
interfaceInfoGetPrerequisite
interfaceInfoGetPrerequisite Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the prerequisites as a |
Obtain an interface type prerequisites index n
.
interfaceInfoGetProperty
interfaceInfoGetProperty Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an interface type property at index n
.
interfaceInfoGetSignal
interfaceInfoGetSignal Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an interface type signal at index n
.
interfaceInfoGetVfunc
interfaceInfoGetVfunc Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an interface type virtual function at index n
.
invokeErrorQuark
objectInfoFindMethod
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m (Maybe BaseInfo) | Returns: the |
Obtain a method of the object type given a name
. Nothing
will be
returned if there's no method available with that name.
objectInfoFindMethodUsingInterfaces
objectInfoFindMethodUsingInterfaces Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m (Maybe BaseInfo, BaseInfo) | Returns: the |
Obtain a method of the object given a name
, searching both the
object info
and any interfaces it implements. Nothing
will be
returned if there's no method available with that name.
Note that this function does *not* search parent classes; you will have to chain up if that's desired.
objectInfoFindSignal
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m (Maybe BaseInfo) | Returns: Info for the signal with name |
TODO
objectInfoFindVfunc
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m (Maybe BaseInfo) | Returns: the |
Locate a virtual function slot with name name
. Note that the namespace
for virtuals is distinct from that of methods; there may or may not be
a concrete method associated for a virtual. If there is one, it may
be retrieved using vfuncInfoGetInvoker
, otherwise Nothing
will be
returned.
See the documentation for vfuncInfoGetInvoker
for more
information on invoking virtuals.
objectInfoFindVfuncUsingInterfaces
objectInfoFindVfuncUsingInterfaces Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m (Maybe BaseInfo, BaseInfo) | Returns: the |
Locate a virtual function slot with name name
, searching both the object
info
and any interfaces it implements. Note that the namespace for
virtuals is distinct from that of methods; there may or may not be a
concrete method associated for a virtual. If there is one, it may be
retrieved using vfuncInfoGetInvoker
, otherwise Nothing
will be
returned.
Note that this function does *not* search parent classes; you will have to chain up if that's desired.
objectInfoGetAbstract
objectInfoGetAbstract Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Obtain if the object type is an abstract type, eg if it cannot be instantiated
objectInfoGetClassStruct
objectInfoGetClassStruct Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe BaseInfo) | Returns: the |
Every Object
has two structures; an instance structure and a class
structure. This function returns the metadata for the class structure.
objectInfoGetConstant
objectInfoGetConstant Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an object type constant at index n
.
objectInfoGetField
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an object type field at index n
.
objectInfoGetFinal
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Checks whether the object type is a final type, i.e. if it cannot be derived
Since: 1.70
objectInfoGetFundamental
objectInfoGetFundamental Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Obtain if the object type is of a fundamental type which is not G_TYPE_OBJECT. This is mostly for supporting GstMiniObject.
objectInfoGetGetValueFunction
objectInfoGetGetValueFunction Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe Text) | Returns: the symbol or |
Obtain the symbol name of the function that should be called to convert
an object instance pointer of this object type to a GValue.
I's mainly used fundamental types. The type signature for the symbol
is GIObjectInfoGetValueFunction
, to fetch the function pointer
see objectInfoGetGetValueFunction
.
objectInfoGetInterface
objectInfoGetInterface Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an object type interface at index n
.
objectInfoGetMethod
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an object type method at index n
.
objectInfoGetNConstants
objectInfoGetNConstants Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of constants |
Obtain the number of constants that this object type has.
objectInfoGetNFields
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of fields |
Obtain the number of fields that this object type has.
objectInfoGetNInterfaces
objectInfoGetNInterfaces Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of interfaces |
Obtain the number of interfaces that this object type has.
objectInfoGetNMethods
objectInfoGetNMethods Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of methods |
Obtain the number of methods that this object type has.
objectInfoGetNProperties
objectInfoGetNProperties Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of properties |
Obtain the number of properties that this object type has.
objectInfoGetNSignals
objectInfoGetNSignals Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of signals |
Obtain the number of signals that this object type has.
objectInfoGetNVfuncs
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of virtual functions |
Obtain the number of virtual functions that this object type has.
objectInfoGetParent
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe BaseInfo) | Returns: the |
Obtain the parent of the object type.
objectInfoGetProperty
objectInfoGetProperty Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an object type property at index n
.
objectInfoGetRefFunction
objectInfoGetRefFunction Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe Text) | Returns: the symbol or |
Obtain the symbol name of the function that should be called to ref this
object type. It's mainly used fundamental types. The type signature for
the symbol is GIObjectInfoRefFunction
, to fetch the function pointer
see objectInfoGetRefFunction
.
objectInfoGetSetValueFunction
objectInfoGetSetValueFunction Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe Text) | Returns: the symbol or |
Obtain the symbol name of the function that should be called to convert
set a GValue giving an object instance pointer of this object type.
I's mainly used fundamental types. The type signature for the symbol
is GIObjectInfoSetValueFunction
, to fetch the function pointer
see objectInfoGetSetValueFunction
.
objectInfoGetSignal
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an object type signal at index n
.
objectInfoGetTypeInit
objectInfoGetTypeInit Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Text | Returns: the type init function |
Obtain the function which when called will return the GType function for which this object type is registered.
objectInfoGetTypeName
objectInfoGetTypeName Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Text | Returns: name of the objects type |
Obtain the name of the objects class/type.
objectInfoGetUnrefFunction
objectInfoGetUnrefFunction Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe Text) | Returns: the symbol or |
Obtain the symbol name of the function that should be called to unref this
object type. It's mainly used fundamental types. The type signature for
the symbol is GIObjectInfoUnrefFunction
, to fetch the function pointer
see objectInfoGetUnrefFunction
.
objectInfoGetVfunc
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain an object type virtual function at index n
.
propertyInfoGetFlags
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m [ParamFlags] | Returns: the flags |
Obtain the flags for this property info. See ParamFlags
for
more information about possible flag values.
propertyInfoGetGetter
propertyInfoGetGetter Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe BaseInfo) | Returns: the function info or |
Obtains the getter function associated with this GIPropertyInfo
.
The setter is only available for ParamFlagsReadable
properties.
propertyInfoGetOwnershipTransfer
propertyInfoGetOwnershipTransfer Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Transfer | Returns: the transfer |
Obtain the ownership transfer for this property. See Transfer
for more
information about transfer values.
propertyInfoGetSetter
propertyInfoGetSetter Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe BaseInfo) | Returns: the function info or |
Obtains the setter function associated with this GIPropertyInfo
.
The setter is only available for ParamFlagsWritable
properties that
are also not ParamFlagsConstructOnly
.
propertyInfoGetType
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
Obtain the type information for the property info
.
registeredTypeInfoGetGType
registeredTypeInfoGetGType Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m GType | Returns: the |
Obtain the GType
for this registered type or G_TYPE_NONE which a special meaning.
It means that either there is no type information associated with this info
or
that the shared library which provides the type_init function for this
info
cannot be called.
registeredTypeInfoGetTypeInit
registeredTypeInfoGetTypeInit Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Text | Returns: the symbol name of the type init function, suitable for
passing into |
Obtain the type init function for info
. The type init function is the
function which will register the GType within the GObject type system.
Usually this is not called by langauge bindings or applications, use
registeredTypeInfoGetGType
directly instead.
registeredTypeInfoGetTypeName
registeredTypeInfoGetTypeName Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Text | Returns: the type name |
Obtain the type name of the struct within the GObject type system.
This type can be passed to typeName
to get a GType
.
signalInfoGetClassClosure
signalInfoGetClassClosure Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the class closure or |
Obtain the class closure for this signal if one is set. The class
closure is a virtual function on the type that the signal belongs to.
If the signal lacks a closure Nothing
will be returned.
signalInfoGetFlags
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m [SignalFlags] | Returns: the flags |
Obtain the flags for this signal info. See SignalFlags
for
more information about possible flag values.
signalInfoTrueStopsEmit
signalInfoTrueStopsEmit Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Obtain if the returning true in the signal handler will stop the emission of the signal.
structInfoFindField
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m BaseInfo | Returns: the |
Obtain the type information for field named name
.
Since: 1.46
structInfoFindMethod
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m BaseInfo | Returns: the |
Obtain the type information for method named name
.
structInfoGetAlignment
structInfoGetAlignment Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Word64 | Returns: required alignment in bytes |
Obtain the required alignment of the structure.
structInfoGetCopyFunction
structInfoGetCopyFunction Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe Text) | Returns: the name of the copy function |
Retrieves the name of the copy function for info
, if any is set.
Since: 1.76
structInfoGetField
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain the type information for field with specified index.
structInfoGetFreeFunction
structInfoGetFreeFunction Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe Text) | Returns: the name of the free function |
Retrieves the name of the free function for info
, if any is set.
Since: 1.76
structInfoGetMethod
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain the type information for method with specified index.
structInfoGetNFields
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of fields |
Obtain the number of fields this structure has.
structInfoGetNMethods
structInfoGetNMethods Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of methods |
Obtain the number of methods this structure has.
structInfoGetSize
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Word64 | Returns: size of the structure in bytes |
Obtain the total size of the structure.
structInfoIsForeign
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: TODO |
TODO
structInfoIsGtypeStruct
structInfoIsGtypeStruct Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool |
Return true if this structure represents the "class structure" for some
Object
or GInterface
. This function is mainly useful to hide this kind of structure
from generated public APIs.
typeInfoArgumentFromHashPointer
typeInfoArgumentFromHashPointer Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Ptr () |
|
-> Argument |
|
-> m () |
GLib data structures, such as List
, SList
, and HashTable
, all store
data pointers.
In the case where the list or hash table is storing single types rather than
structs, these data pointers may have values stuffed into them via macros
such as GPOINTER_TO_INT
.
Use this function to ensure that all values are correctly extracted from stuffed pointers, regardless of the machine's architecture or endianness.
This function fills in the appropriate field of arg
with the value extracted
from hashPointer
, depending on the storage type of info
.
Since: 1.66
typeInfoGetArrayFixedSize
typeInfoGetArrayFixedSize Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: the size or -1 if it's not an array |
Obtain the fixed array size of the type. The type tag must be a
GI_TYPE_TAG_ARRAY
or -1 will be returned.
typeInfoGetArrayLength
typeInfoGetArrayLength Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: the array length, or -1 if the type is not an array |
Obtain the position of the argument which gives the array length of the type.
The type tag must be a GI_TYPE_TAG_ARRAY
or -1 will be returned.
typeInfoGetArrayType
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m ArrayType | Returns: the array type or -1 |
Obtain the array type for this type. See ArrayType
for a list of
possible values. If the type tag of this type is not array, -1 will be
returned.
typeInfoGetInterface
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
For types which have GI_TYPE_TAG_INTERFACE
such as GObjects and boxed values,
this function returns full information about the referenced type. You can then
inspect the type of the returned BaseInfo
to further query whether it is
a concrete GObject, a GInterface, a structure, etc. using baseInfoGetType
.
typeInfoGetParamType
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the param type info |
Obtain the parameter type n
.
typeInfoGetStorageType
typeInfoGetStorageType Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m TypeTag | Returns: the type tag |
Obtain the type tag corresponding to the underlying storage type in C for
the type.
See TypeTag
for a list of type tags.
Since: 1.66
typeInfoGetTag
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m TypeTag | Returns: the type tag |
Obtain the type tag for the type. See TypeTag
for a list
of type tags.
typeInfoHashPointerFromArgument
typeInfoHashPointerFromArgument Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Argument |
|
-> m (Ptr ()) | Returns: A stuffed pointer, that can be stored in a |
GLib data structures, such as List
, SList
, and HashTable
, all store
data pointers.
In the case where the list or hash table is storing single types rather than
structs, these data pointers may have values stuffed into them via macros
such as GPOINTER_TO_INT
.
Use this function to ensure that all values are correctly stuffed into pointers, regardless of the machine's architecture or endianness.
This function returns a pointer stuffed with the appropriate field of arg
,
depending on the storage type of info
.
Since: 1.66
typeInfoIsPointer
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Obtain if the type is passed as a reference.
Note that the types of DirectionOut
and DirectionInout
parameters
will only be pointers if the underlying type being transferred is a pointer
(i.e. only if the type of the C function’s formal parameter is a pointer to a
pointer).
typeInfoIsZeroTerminated
typeInfoIsZeroTerminated Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
typeTagArgumentFromHashPointer
typeTagArgumentFromHashPointer Source #
:: (HasCallStack, MonadIO m) | |
=> TypeTag |
|
-> Ptr () |
|
-> Argument |
|
-> m () |
GLib data structures, such as List
, SList
, and HashTable
, all store
data pointers.
In the case where the list or hash table is storing single types rather than
structs, these data pointers may have values stuffed into them via macros
such as GPOINTER_TO_INT
.
Use this function to ensure that all values are correctly extracted from stuffed pointers, regardless of the machine's architecture or endianness.
This function fills in the appropriate field of arg
with the value extracted
from hashPointer
, depending on storageType
.
Since: 1.72
typeTagHashPointerFromArgument
typeTagHashPointerFromArgument Source #
:: (HasCallStack, MonadIO m) | |
=> TypeTag |
|
-> Argument |
|
-> m (Ptr ()) | Returns: A stuffed pointer, that can be stored in a |
GLib data structures, such as List
, SList
, and HashTable
, all store
data pointers.
In the case where the list or hash table is storing single types rather than
structs, these data pointers may have values stuffed into them via macros
such as GPOINTER_TO_INT
.
Use this function to ensure that all values are correctly stuffed into pointers, regardless of the machine's architecture or endianness.
This function returns a pointer stuffed with the appropriate field of arg
,
depending on storageType
.
Since: 1.72
typeTagToString
:: (HasCallStack, MonadIO m) | |
=> TypeTag |
|
-> m Text | Returns: the string |
Obtain a string representation of type
unionInfoFindMethod
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Text |
|
-> m BaseInfo | Returns: the |
Obtain the type information for method named name
.
unionInfoGetAlignment
unionInfoGetAlignment Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Word64 | Returns: required alignment in bytes |
Obtain the required alignment of the union.
unionInfoGetCopyFunction
unionInfoGetCopyFunction Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe Text) | Returns: the name of the copy function |
Retrieves the name of the copy function for info
, if any is set.
Since: 1.76
unionInfoGetDiscriminator
unionInfoGetDiscriminator Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain discriminator value assigned for n-th union field, i.e. n-th union field is the active one if discriminator contains this constant.
unionInfoGetDiscriminatorOffset
unionInfoGetDiscriminatorOffset Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: offset in bytes of the discriminator |
Returns offset of the discriminator field in the structure.
unionInfoGetDiscriminatorType
unionInfoGetDiscriminatorType Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
Obtain the type information of the union discriminator.
unionInfoGetField
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain the type information for field with specified index.
unionInfoGetFreeFunction
unionInfoGetFreeFunction Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m (Maybe Text) | Returns: the name of the free function |
Retrieves the name of the free function for info
, if any is set.
Since: 1.76
unionInfoGetMethod
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> Int32 |
|
-> m BaseInfo | Returns: the |
Obtain the type information for method with specified index.
unionInfoGetNFields
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of fields |
Obtain the number of fields this union has.
unionInfoGetNMethods
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: number of methods |
Obtain the number of methods this union has.
unionInfoGetSize
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Word64 | Returns: size of the union in bytes |
Obtain the total size of the union.
unionInfoIsDiscriminated
unionInfoIsDiscriminated Source #
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Bool | Returns: |
Return true if this union contains discriminator field.
valueInfoGetValue
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int64 | Returns: the enumeration value. This will always be representable as a 32-bit signed or unsigned value. The use of gint64 as the return type is to allow both. |
Obtain the enumeration value of the GIValueInfo
.
vfuncInfoGetAddress
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> GType |
|
-> m (Ptr ()) | Returns: address to a function or |
This method will look up where inside the type struct of implementorGtype
is the implementation for info
.
vfuncInfoGetFlags
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m [VFuncInfoFlags] | Returns: the flags |
Obtain the flags for this virtual function info. See VFuncInfoFlags
for
more information about possible flag values.
vfuncInfoGetInvoker
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the |
If this virtual function has an associated invoker method, this method will return it. An invoker method is a C entry point.
Not all virtuals will have invokers.
vfuncInfoGetOffset
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m Int32 | Returns: the struct offset or 0xFFFF if it's unknown |
Obtain the offset of the function pointer in the class struct. The value 0xFFFF indicates that the struct offset is unknown.
vfuncInfoGetSignal
:: (HasCallStack, MonadIO m) | |
=> BaseInfo |
|
-> m BaseInfo | Returns: the signal or |
Obtain the signal for the virtual function if one is set. The signal comes from the object or interface to which this virtual function belongs.