GI.Json.Callbacks

Signals

ArrayForeach

type ArrayForeach

Arguments

 = Array

array: the iterated JSON array

-> Word32

index_: the index of the element

-> Node

elementNode: the value of the element at the given index_

-> IO ()

The function to be passed to arrayForeachElement.

You should not add or remove elements to and from array within this function.

It is safe to change the value of elementNode.

Since: 0.8

type ArrayForeach_WithClosures

Arguments

 = Array

array: the iterated JSON array

-> Word32

index_: the index of the element

-> Node

elementNode: the value of the element at the given index_

-> Ptr ()

userData: data passed to the function

-> IO ()

The function to be passed to arrayForeachElement.

You should not add or remove elements to and from array within this function.

It is safe to change the value of elementNode.

Since: 0.8

type C_ArrayForeach = Ptr Array -> Word32 -> Ptr Node -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

drop_closures_ArrayForeach :: ArrayForeach -> ArrayForeach_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_ArrayForeach

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_ArrayForeach

-> Array

array: the iterated JSON array

-> Word32

index_: the index of the element

-> Node

elementNode: the value of the element at the given index_

-> Ptr ()

userData: data passed to the function

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_ArrayForeach :: MonadIO m => ArrayForeach -> m (GClosure C_ArrayForeach)

Wrap the callback into a GClosure.

mk_ArrayForeach :: C_ArrayForeach -> IO (FunPtr C_ArrayForeach)

Generate a function pointer callable from C code, from a C_ArrayForeach.

noArrayForeach :: Maybe ArrayForeach

A convenience synonym for Nothing :: Maybe ArrayForeach.

noArrayForeach_WithClosures :: Maybe ArrayForeach_WithClosures

A convenience synonym for Nothing :: Maybe ArrayForeach_WithClosures.

wrap_ArrayForeach :: Maybe (Ptr (FunPtr C_ArrayForeach)) -> ArrayForeach_WithClosures -> C_ArrayForeach

Wrap a ArrayForeach into a C_ArrayForeach.

BoxedDeserializeFunc

type BoxedDeserializeFunc

Arguments

 = Node

node: a node tree representing a boxed data

-> IO (Ptr ())

Returns: the newly created boxed structure

Deserializes the contents of the passed JsonNode into a GBoxed, for instance:

c code

static gpointer
my_point_deserialize (JsonNode *node)
{
  double x = 0.0, y = 0.0;

  if (JSON_NODE_HOLDS_ARRAY (node))
    {
      JsonArray *array = json_node_get_array (node);

      if (json_array_get_length (array) == 2)
        {
          x = json_array_get_double_element (array, 0);
          y = json_array_get_double_element (array, 1);
        }
    }
  else if (JSON_NODE_HOLDS_OBJECT (node))
    {
      JsonObject *obj = json_node_get_object (node);

      x = json_object_get_double_member_with_default (obj, "x", 0.0);
      y = json_object_get_double_member_with_default (obj, "y", 0.0);
    }

  // my_point_new() is defined elsewhere
  return my_point_new (x, y);
}

Since: 0.10

type C_BoxedDeserializeFunc = Ptr Node -> IO (Ptr ())

Type for the callback on the (unwrapped) C side.

dynamic_BoxedDeserializeFunc

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_BoxedDeserializeFunc

-> Node

node: a node tree representing a boxed data

-> m (Ptr ())

Returns: the newly created boxed structure

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_BoxedDeserializeFunc :: MonadIO m => BoxedDeserializeFunc -> m (GClosure C_BoxedDeserializeFunc)

Wrap the callback into a GClosure.

mk_BoxedDeserializeFunc :: C_BoxedDeserializeFunc -> IO (FunPtr C_BoxedDeserializeFunc)

Generate a function pointer callable from C code, from a C_BoxedDeserializeFunc.

noBoxedDeserializeFunc :: Maybe BoxedDeserializeFunc

A convenience synonym for Nothing :: Maybe BoxedDeserializeFunc.

wrap_BoxedDeserializeFunc :: Maybe (Ptr (FunPtr C_BoxedDeserializeFunc)) -> BoxedDeserializeFunc -> C_BoxedDeserializeFunc

Wrap a BoxedDeserializeFunc into a C_BoxedDeserializeFunc.

BoxedSerializeFunc

type BoxedSerializeFunc

Arguments

 = IO Node

Returns: the newly created JSON node tree representing the boxed data

Serializes the passed GBoxed and stores it inside a JsonNode, for instance:

c code

static JsonNode *
my_point_serialize (gconstpointer boxed)
{
  const MyPoint *point = boxed;

  g_autoptr(JsonBuilder) builder = json_builder_new ();

  json_builder_begin_object (builder);
  json_builder_set_member_name (builder, "x");
  json_builder_add_double_value (builder, point->x);
  json_builder_set_member_name (builder, "y");
  json_builder_add_double_value (builder, point->y);
  json_builder_end_object (builder);

  return json_builder_get_root (builder);
}

Since: 0.10

type BoxedSerializeFunc_WithClosures

Arguments

 = Ptr ()

boxed: a boxed data structure

-> IO Node

Returns: the newly created JSON node tree representing the boxed data

Serializes the passed GBoxed and stores it inside a JsonNode, for instance:

c code

static JsonNode *
my_point_serialize (gconstpointer boxed)
{
  const MyPoint *point = boxed;

  g_autoptr(JsonBuilder) builder = json_builder_new ();

  json_builder_begin_object (builder);
  json_builder_set_member_name (builder, "x");
  json_builder_add_double_value (builder, point->x);
  json_builder_set_member_name (builder, "y");
  json_builder_add_double_value (builder, point->y);
  json_builder_end_object (builder);

  return json_builder_get_root (builder);
}

Since: 0.10

type C_BoxedSerializeFunc = Ptr () -> IO (Ptr Node)

Type for the callback on the (unwrapped) C side.

drop_closures_BoxedSerializeFunc :: BoxedSerializeFunc -> BoxedSerializeFunc_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_BoxedSerializeFunc

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_BoxedSerializeFunc

-> Ptr ()

boxed: a boxed data structure

-> m Node

Returns: the newly created JSON node tree representing the boxed data

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_BoxedSerializeFunc :: MonadIO m => BoxedSerializeFunc -> m (GClosure C_BoxedSerializeFunc)

Wrap the callback into a GClosure.

mk_BoxedSerializeFunc :: C_BoxedSerializeFunc -> IO (FunPtr C_BoxedSerializeFunc)

Generate a function pointer callable from C code, from a C_BoxedSerializeFunc.

noBoxedSerializeFunc :: Maybe BoxedSerializeFunc

A convenience synonym for Nothing :: Maybe BoxedSerializeFunc.

noBoxedSerializeFunc_WithClosures :: Maybe BoxedSerializeFunc_WithClosures

A convenience synonym for Nothing :: Maybe BoxedSerializeFunc_WithClosures.

wrap_BoxedSerializeFunc :: Maybe (Ptr (FunPtr C_BoxedSerializeFunc)) -> BoxedSerializeFunc_WithClosures -> C_BoxedSerializeFunc

Wrap a BoxedSerializeFunc into a C_BoxedSerializeFunc.

ObjectForeach

type C_ObjectForeach = Ptr Object -> CString -> Ptr Node -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type ObjectForeach

Arguments

 = Object

object: the iterated JSON object

-> Text

memberName: the name of the member

-> Node

memberNode: the value of the member

-> IO ()

The function to be passed to objectForeachMember.

You should not add or remove members to and from object within this function.

It is safe to change the value of memberNode.

Since: 0.8

type ObjectForeach_WithClosures

Arguments

 = Object

object: the iterated JSON object

-> Text

memberName: the name of the member

-> Node

memberNode: the value of the member

-> Ptr ()

userData: data passed to the function

-> IO ()

The function to be passed to objectForeachMember.

You should not add or remove members to and from object within this function.

It is safe to change the value of memberNode.

Since: 0.8

drop_closures_ObjectForeach :: ObjectForeach -> ObjectForeach_WithClosures

A simple wrapper that ignores the closure arguments.

dynamic_ObjectForeach

Arguments

:: (HasCallStack, MonadIO m)

=> FunPtr C_ObjectForeach

-> Object

object: the iterated JSON object

-> Text

memberName: the name of the member

-> Node

memberNode: the value of the member

-> Ptr ()

userData: data passed to the function

-> m ()

Given a pointer to a foreign C function, wrap it into a function callable from Haskell.

genClosure_ObjectForeach :: MonadIO m => ObjectForeach -> m (GClosure C_ObjectForeach)

Wrap the callback into a GClosure.

mk_ObjectForeach :: C_ObjectForeach -> IO (FunPtr C_ObjectForeach)

Generate a function pointer callable from C code, from a C_ObjectForeach.

noObjectForeach :: Maybe ObjectForeach

A convenience synonym for Nothing :: Maybe ObjectForeach.

noObjectForeach_WithClosures :: Maybe ObjectForeach_WithClosures

A convenience synonym for Nothing :: Maybe ObjectForeach_WithClosures.

wrap_ObjectForeach :: Maybe (Ptr (FunPtr C_ObjectForeach)) -> ObjectForeach_WithClosures -> C_ObjectForeach

Wrap a ObjectForeach into a C_ObjectForeach.