Data.GI.Base.BasicTypes

Basic types used in the bindings.

GType related

newtype GType

A newtype for use on the haskell side.

Constructors

GType

Fields

• gtypeToCGType :: CGType

Instances

IsGValue GType

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.

gtypeString :: GType

GType of strings.

gtypePointer :: GType

GType of pointers.

gtypeInt32 :: GType

GType for signed integers.

gtypeUInt32 :: GType

GType for unsigned integers.

gtypeInt64 :: GType

GType for signed 64 bit integers.

gtypeUInt64 :: GType

GType for unsigned 64 bit integers.

gtypeFloat :: GType

GType for floating point values.

gtypeDouble :: GType

GType for gdouble.

gtypeBoolean :: GType

GType corresponding to gboolean.

gtypeGType :: GType

GType corresponding to a GType itself.

gtypeStrv :: GType

GType for a NULL terminated array of strings.

gtypeBoxed :: GType

GType corresponding to a BoxedObject.

gtypeObject :: GType

GType corresponding to a GObject.

Memory management

type ForeignPtrNewtype a = Coercible a (ForeignPtr ())

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

newtype Foo = Foo (ForeignPtr Foo)

which is the typical shape of wrapped GObjects.

class ForeignPtrNewtype a => BoxedObject a where

Wrapped boxed structures, identified by their GType.

Minimal complete definition

boxedType

Methods

boxedType :: a -> IO GType

Instances

BoxedObject Closure

Methods

boxedType :: Closure -> IO GType

BoxedObject GError

Methods

boxedType :: GError -> IO GType

BoxedObject GValue

Methods

boxedType :: GValue -> IO GType

class BoxedEnum a where

Enums with an associated GType.

Minimal complete definition

boxedEnumType

Methods

boxedEnumType :: a -> IO GType

class ForeignPtrNewtype a => GObject a where

A wrapped GObject.

Minimal complete definition

gobjectIsInitiallyUnowned, gobjectType

Methods

gobjectIsInitiallyUnowned :: a -> Bool

Whether the GObject is a descendent of GInitiallyUnowned.

gobjectType :: a -> IO GType

The GType for this object.

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

Methods

showsPrec :: Int -> UnexpectedNullPointerReturn -> ShowS

show :: UnexpectedNullPointerReturn -> String

showList :: [UnexpectedNullPointerReturn] -> ShowS

Exception UnexpectedNullPointerReturn

Methods

toException :: UnexpectedNullPointerReturn -> SomeException

fromException :: SomeException -> Maybe UnexpectedNullPointerReturn

displayException :: UnexpectedNullPointerReturn -> String

Basic GLib / GObject types

newtype GVariant

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

Constructors

GVariant (ForeignPtr GVariant)

Instances

IsGVariant 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 (ForeignPtr 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.