Data.GI.Base.BasicTypes

Basic types used in the bindings.

Memory management

data ManagedPtr a

Thin wrapper over ForeignPtr, supporting the extra notion of disowning, that is, not running the finalizers associated with the foreign ptr.

Constructors

ManagedPtr

Fields

• managedForeignPtr :: ForeignPtr a
• managedPtrAllocCallStack :: Maybe CallStack

  CallStack for the call that created the pointer.

• managedPtrIsDisowned :: IORef (Maybe CallStack)

  When disowned, the CallStack for the disowning call.

type ManagedPtrNewtype a = Coercible a (ManagedPtr ())

A constraint ensuring that the given type is coercible to a ManagedPtr. It will hold for newtypes of the form

newtype Foo = Foo (ManagedPtr Foo)

which is the typical shape of wrapped GObjects.

class ManagedPtrNewtype a => BoxedObject a where

Wrapped boxed structures, identified by their GType.

Methods

boxedType :: a -> IO GType

Instances

BoxedObject GValue

Defined in Data.GI.Base.GValue

Methods

boxedType :: GValue -> IO GType

BoxedObject GError

Defined in Data.GI.Base.GError

Methods

boxedType :: GError -> IO GType

BoxedObject (GClosure a)

Defined in Data.GI.Base.GClosure

Methods

boxedType :: GClosure a -> IO GType

class BoxedEnum a where

Enums with an associated GType.

Methods

boxedEnumType :: a -> IO GType

class BoxedFlags a where

Flags with an associated GType.

Methods

boxedFlagsType :: Proxy a -> IO GType

class ManagedPtrNewtype a => WrappedPtr a where

Pointers to structs/unions without an associated GType.

Methods

wrappedPtrCalloc :: IO (Ptr a)

Allocate a zero-initialized block of memory for the given type.

wrappedPtrCopy :: a -> IO a

Make a copy of the given WrappedPtr.

wrappedPtrFree :: Maybe (GDestroyNotify a)

A pointer to a function for freeing the given pointer, or Nothing is the memory associated to the pointer does not need to be freed.

data UnexpectedNullPointerReturn

A common omission in the introspection data is missing (nullable) annotations for return types, when they clearly are nullable. (A common idiom is "Returns: valid value, or %NULL if something went wrong.")

Haskell wrappers will raise this exception if the return value is an unexpected nullPtr.

Constructors

UnexpectedNullPointerReturn

Fields

• nullPtrErrorMsg :: Text

Instances

Show UnexpectedNullPointerReturn

Defined in Data.GI.Base.BasicTypes

Methods

showsPrec :: Int -> UnexpectedNullPointerReturn -> ShowS

show :: UnexpectedNullPointerReturn -> String

showList :: [UnexpectedNullPointerReturn] -> ShowS

Exception UnexpectedNullPointerReturn

Defined in Data.GI.Base.BasicTypes

Methods

toException :: UnexpectedNullPointerReturn -> SomeException

fromException :: SomeException -> Maybe UnexpectedNullPointerReturn

displayException :: UnexpectedNullPointerReturn -> String

Basic GLib / GObject types

class (ManagedPtrNewtype a, HasParentTypes a) => GObject a where

A wrapped GObject.

Methods

gobjectType :: IO GType

The GType for this object.

newtype GType

A newtype for use on the haskell side.

Constructors

GType

Fields

• gtypeToCGType :: CGType

Instances

IsGValue GType

Defined in Data.GI.Base.GValue

Methods

toGValue :: GType -> IO GValue

fromGValue :: GValue -> IO GType

type CGType = Word64

A type identifier in the GLib type system. This is the low-level type associated with the representation in memory, when using this on the Haskell side use GType below.

gtypeName :: GType -> IO String

Get the name assigned to the given GType.

newtype GVariant

A GVariant. See Data.GI.Base.GVariant for further methods.

Constructors

GVariant (ManagedPtr GVariant)

Instances

IsGVariant GVariant

Defined in Data.GI.Base.GVariant

Methods

toGVariant :: GVariant -> IO GVariant

fromGVariant :: GVariant -> IO (Maybe GVariant)

toGVariantFormatString :: GVariant -> Text

newtype GParamSpec

A GParamSpec. See Data.GI.Base.GParamSpec for further methods.

Constructors

GParamSpec (ManagedPtr GParamSpec)

noGParamSpec :: Maybe GParamSpec

A convenient synonym for Nothing :: Maybe GParamSpec.

data GArray a

A GArray. Marshalling for this type is done in Data.GI.Base.BasicConversions, it is mapped to a list on the Haskell side.

Constructors

GArray (Ptr (GArray a))

data GPtrArray a

A GPtrArray. Marshalling for this type is done in Data.GI.Base.BasicConversions, it is mapped to a list on the Haskell side.

Constructors

GPtrArray (Ptr (GPtrArray a))

data GByteArray

A GByteArray. Marshalling for this type is done in Data.GI.Base.BasicConversions, it is packed to a ByteString on the Haskell side.

Constructors

GByteArray (Ptr GByteArray)

data GHashTable a b

A GHashTable. It is mapped to a Map on the Haskell side.

Constructors

GHashTable (Ptr (GHashTable a b))

data GList a

A GList, mapped to a list on the Haskell side. Marshalling is done in Data.GI.Base.BasicConversions.

Constructors

GList (Ptr (GList a))

g_list_free :: Ptr (GList a) -> IO ()

Free the given GList.

data GSList a

A GSList, mapped to a list on the Haskell side. Marshalling is done in Data.GI.Base.BasicConversions.

Constructors

GSList (Ptr (GSList a))

g_slist_free :: Ptr (GSList a) -> IO ()

Free the given GSList.

class Enum a => IsGFlag a

An enum usable as a flag for a function.

newtype PtrWrapped a

Some APIs, such as GHashTable, pass around scalar types wrapped into a pointer. We encode such a type as follows.

Constructors

PtrWrapped

Fields

• unwrapPtr :: Ptr a

type GDestroyNotify a = FunPtr (Ptr a -> IO ())

Destroy the memory associated with a given pointer.