Data.GI.Base.GHashTable

Machinery for some basic support of GHashTable.

The GLib GHashTable implementation requires two things: we need to "pack" a datatype into a pointer (for datatypes that are represented by pointers this is the trivial operation, for integers it is not, and GLib has some helper macros).

We also need to be able to hash and check for equality different datatypes.

Documentation

type GHashFunc a = FunPtr (PtrWrapped a -> IO Word32)

A pointer to a hashing function on the C side.

type GEqualFunc a = FunPtr (PtrWrapped a -> PtrWrapped a -> IO Int32)

A pointer to an equality checking function on the C side.

gDirectHash :: GHashFunc (Ptr a)

Compute the hash for a Ptr.

gDirectEqual :: GEqualFunc (Ptr a)

Check whether two pointers are equal.

ptrPackPtr :: Ptr a -> PtrWrapped (Ptr a)

Pack a Ptr into a PtrWrapped Ptr.

ptrUnpackPtr :: PtrWrapped (Ptr a) -> Ptr a

Extract a Ptr from a PtrWrapped Ptr.

gStrHash :: GHashFunc CString

Compute the hash for a CString.

gStrEqual :: GEqualFunc CString

Check whether two CStrings are equal.

cstringPackPtr :: CString -> PtrWrapped CString

Pack a CString into a Ptr than can go into a GHashTable.

cstringUnpackPtr :: PtrWrapped CString -> CString

Extract a CString wrapped into a Ptr coming from a GHashTable.

gvaluePackPtr :: Ptr GValue -> PtrWrapped (Ptr GValue)

Pack a Ptr to GValue into a Ptr than can go into a GHashTable.

gvalueUnpackPtr :: PtrWrapped (Ptr GValue) -> Ptr GValue

Extract a Ptr to GValue wrapped into a Ptr coming from a GHashTable.