gclosure.c 61.9 KB
Newer Older
1
/* GObject - GLib Type, Object, Parameter and Signal Library
2
 * Copyright (C) 2000-2001 Red Hat, Inc.
3
 * Copyright (C) 2005 Imendio AB
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 */
20 21 22 23 24 25 26 27 28

/*
 * MT safe with regards to reference counting.
 */

#include "config.h"

#include <string.h>

29 30
#include <ffi.h>

31
#include "gclosure.h"
Dan Winship's avatar
Dan Winship committed
32
#include "gboxed.h"
33
#include "gobject.h"
34
#include "genums.h"
35
#include "gvalue.h"
Dan Winship's avatar
Dan Winship committed
36
#include "gvaluetypes.h"
37
#include  "gtype-private.h"
38

39

Stefan Kost's avatar
Stefan Kost committed
40
/**
41
 * SECTION:gclosure
42 43
 * @short_description: Functions as first-class objects
 * @title: Closures
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
 *
 * A #GClosure represents a callback supplied by the programmer. It
 * will generally comprise a function of some kind and a marshaller
 * used to call it. It is the reponsibility of the marshaller to
 * convert the arguments for the invocation from #GValue<!-- -->s into
 * a suitable form, perform the callback on the converted arguments,
 * and transform the return value back into a #GValue.
 *
 * In the case of C programs, a closure usually just holds a pointer
 * to a function and maybe a data argument, and the marshaller
 * converts between #GValue<!-- --> and native C types. The GObject
 * library provides the #GCClosure type for this purpose. Bindings for
 * other languages need marshallers which convert between #GValue<!--
 * -->s and suitable representations in the runtime of the language in
 * order to use functions written in that languages as callbacks.
 *
 * Within GObject, closures play an important role in the
 * implementation of signals. When a signal is registered, the
 * @c_marshaller argument to g_signal_new() specifies the default C
 * marshaller for any closure which is connected to this
 * signal. GObject provides a number of C marshallers for this
 * purpose, see the g_cclosure_marshal_*() functions. Additional C
 * marshallers can be generated with the <link
 * linkend="glib-genmarshal">glib-genmarshal</link> utility.  Closures
 * can be explicitly connected to signals with
 * g_signal_connect_closure(), but it usually more convenient to let
 * GObject create a closure automatically by using one of the
 * g_signal_connect_*() functions which take a callback function/user
 * data pair.
 *
Stefan Kost's avatar
Stefan Kost committed
74 75 76 77
 * Using closures has a number of important advantages over a simple
 * callback function/data pointer combination:
 * <itemizedlist>
 * <listitem><para>
78 79
 * Closures allow the callee to get the types of the callback parameters,
 * which means that language bindings don't have to write individual glue
Stefan Kost's avatar
Stefan Kost committed
80 81 82
 * for each callback type.
 * </para></listitem>
 * <listitem><para>
83 84
 * The reference counting of #GClosure makes it easy to handle reentrancy
 * right; if a callback is removed while it is being invoked, the closure
85
 * and its parameters won't be freed until the invocation finishes.
Stefan Kost's avatar
Stefan Kost committed
86 87 88 89 90 91 92 93
 * </para></listitem>
 * <listitem><para>
 * g_closure_invalidate() and invalidation notifiers allow callbacks to be
 * automatically removed when the objects they point to go away.
 * </para></listitem>
 * </itemizedlist>
 */

94 95 96 97
#define	CLOSURE_MAX_REF_COUNT		((1 << 15) - 1)
#define	CLOSURE_MAX_N_GUARDS		((1 << 1) - 1)
#define	CLOSURE_MAX_N_FNOTIFIERS	((1 << 2) - 1)
#define	CLOSURE_MAX_N_INOTIFIERS	((1 << 8) - 1)
98
#define	CLOSURE_N_MFUNCS(cl)		(((cl)->n_guards << 1L))
99
/* same as G_CLOSURE_N_NOTIFIERS() (keep in sync) */
100 101 102
#define	CLOSURE_N_NOTIFIERS(cl)		(CLOSURE_N_MFUNCS (cl) + \
                                         (cl)->n_fnotifiers + \
                                         (cl)->n_inotifiers)
103 104 105

typedef union {
  GClosure closure;
106
  volatile gint vint;
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
} ClosureInt;

#define CHANGE_FIELD(_closure, _field, _OP, _value, _must_set, _SET_OLD, _SET_NEW)      \
G_STMT_START {                                                                          \
  ClosureInt *cunion = (ClosureInt*) _closure;                 		                \
  gint new_int, old_int, success;                              		                \
  do                                                    		                \
    {                                                   		                \
      ClosureInt tmp;                                   		                \
      tmp.vint = old_int = cunion->vint;                		                \
      _SET_OLD tmp.closure._field;                                                      \
      tmp.closure._field _OP _value;                      		                \
      _SET_NEW tmp.closure._field;                                                      \
      new_int = tmp.vint;                               		                \
      success = g_atomic_int_compare_and_exchange (&cunion->vint, old_int, new_int);    \
    }                                                   		                \
  while (!success && _must_set);                                                        \
} G_STMT_END

#define SWAP(_closure, _field, _value, _oldv)   CHANGE_FIELD (_closure, _field, =, _value, TRUE, *(_oldv) =,     (void) )
#define SET(_closure, _field, _value)           CHANGE_FIELD (_closure, _field, =, _value, TRUE,     (void),     (void) )
#define INC(_closure, _field)                   CHANGE_FIELD (_closure, _field, +=,     1, TRUE,     (void),     (void) )
#define INC_ASSIGN(_closure, _field, _newv)     CHANGE_FIELD (_closure, _field, +=,     1, TRUE,     (void), *(_newv) = )
#define DEC(_closure, _field)                   CHANGE_FIELD (_closure, _field, -=,     1, TRUE,     (void),     (void) )
#define DEC_ASSIGN(_closure, _field, _newv)     CHANGE_FIELD (_closure, _field, -=,     1, TRUE,     (void), *(_newv) = )

Matthias Clasen's avatar
Matthias Clasen committed
133
#if 0   /* for non-thread-safe closures */
134 135 136 137 138 139 140 141
#define SWAP(cl,f,v,o)     (void) (*(o) = cl->f, cl->f = v)
#define SET(cl,f,v)        (void) (cl->f = v)
#define INC(cl,f)          (void) (cl->f += 1)
#define INC_ASSIGN(cl,f,n) (void) (cl->f += 1, *(n) = cl->f)
#define DEC(cl,f)          (void) (cl->f -= 1)
#define DEC_ASSIGN(cl,f,n) (void) (cl->f -= 1, *(n) = cl->f)
#endif

142 143 144 145 146 147 148 149 150
enum {
  FNOTIFY,
  INOTIFY,
  PRE_NOTIFY,
  POST_NOTIFY
};


/* --- functions --- */
Stefan Kost's avatar
Stefan Kost committed
151 152
/**
 * g_closure_new_simple:
153 154
 * @sizeof_closure: the size of the structure to allocate, must be at least
 *                  <literal>sizeof (GClosure)</literal>
Stefan Kost's avatar
Stefan Kost committed
155
 * @data: data to store in the @data field of the newly allocated #GClosure
156 157 158 159 160
 *
 * Allocates a struct of the given size and initializes the initial
 * part as a #GClosure. This function is mainly useful when
 * implementing new types of closures.
 *
Stefan Kost's avatar
Stefan Kost committed
161 162
 * |[
 * typedef struct _MyClosure MyClosure;
163
 * struct _MyClosure
Stefan Kost's avatar
Stefan Kost committed
164 165 166
 * {
 *   GClosure closure;
 *   // extra data goes here
167 168
 * };
 *
Stefan Kost's avatar
Stefan Kost committed
169
 * static void
170
 * my_closure_finalize (gpointer  notify_data,
Stefan Kost's avatar
Stefan Kost committed
171 172 173
 *                      GClosure *closure)
 * {
 *   MyClosure *my_closure = (MyClosure *)closure;
174
 *
Stefan Kost's avatar
Stefan Kost committed
175 176
 *   // free extra data here
 * }
177
 *
Stefan Kost's avatar
Stefan Kost committed
178 179 180 181
 * MyClosure *my_closure_new (gpointer data)
 * {
 *   GClosure *closure;
 *   MyClosure *my_closure;
182
 *
Stefan Kost's avatar
Stefan Kost committed
183 184
 *   closure = g_closure_new_simple (sizeof (MyClosure), data);
 *   my_closure = (MyClosure *) closure;
185
 *
Stefan Kost's avatar
Stefan Kost committed
186
 *   // initialize extra data here
187
 *
Stefan Kost's avatar
Stefan Kost committed
188 189 190 191 192
 *   g_closure_add_finalize_notifier (closure, notify_data,
 *                                    my_closure_finalize);
 *   return my_closure;
 * }
 * ]|
193
 *
194
 * Returns: (transfer full): a newly allocated #GClosure
Stefan Kost's avatar
Stefan Kost committed
195
 */
196 197 198 199
GClosure*
g_closure_new_simple (guint           sizeof_closure,
		      gpointer        data)
{
200
  GRealClosure *real_closure;
201 202 203
  GClosure *closure;

  g_return_val_if_fail (sizeof_closure >= sizeof (GClosure), NULL);
204
  sizeof_closure = sizeof_closure + sizeof (GRealClosure) - sizeof (GClosure);
205

206 207
  real_closure = g_malloc0 (sizeof_closure);
  closure = &real_closure->closure;
208 209
  SET (closure, ref_count, 1);
  SET (closure, floating, TRUE);
210 211 212 213 214 215 216 217 218 219
  closure->data = data;

  return closure;
}

static inline void
closure_invoke_notifiers (GClosure *closure,
			  guint     notify_type)
{
  /* notifier layout:
220 221
   *     n_guards    n_guards     n_fnotif.  n_inotifiers
   * ->[[pre_guards][post_guards][fnotifiers][inotifiers]]
222
   *
223
   * CLOSURE_N_MFUNCS(cl)    = n_guards + n_guards;
224 225 226 227 228 229
   * CLOSURE_N_NOTIFIERS(cl) = CLOSURE_N_MFUNCS(cl) + n_fnotifiers + n_inotifiers
   *
   * constrains/catches:
   * - closure->notifiers may be reloacted during callback
   * - closure->n_fnotifiers and closure->n_inotifiers may change during callback
   * - i.e. callbacks can be removed/added during invocation
230 231
   * - must prepare for callback removal during FNOTIFY and INOTIFY (done via ->marshal= & ->data=)
   * - must distinguish (->marshal= & ->data=) for INOTIFY vs. FNOTIFY (via ->in_inotify)
232 233 234 235 236 237 238 239 240
   * + closure->n_guards is const during PRE_NOTIFY & POST_NOTIFY
   * + none of the callbacks can cause recursion
   * + closure->n_inotifiers is const 0 during FNOTIFY
   */
  switch (notify_type)
    {
      GClosureNotifyData *ndata;
      guint i, offs;
    case FNOTIFY:
241
      while (closure->n_fnotifiers)
242
	{
243 244
          guint n;
	  DEC_ASSIGN (closure, n_fnotifiers, &n);
245

246
	  ndata = closure->notifiers + CLOSURE_N_MFUNCS (closure) + n;
247
	  closure->marshal = (GClosureMarshal) ndata->notify;
248 249 250 251 252 253 254
	  closure->data = ndata->data;
	  ndata->notify (ndata->data, closure);
	}
      closure->marshal = NULL;
      closure->data = NULL;
      break;
    case INOTIFY:
255
      SET (closure, in_inotify, TRUE);
256
      while (closure->n_inotifiers)
257
	{
258 259
          guint n;
          DEC_ASSIGN (closure, n_inotifiers, &n);
260

261
	  ndata = closure->notifiers + CLOSURE_N_MFUNCS (closure) + closure->n_fnotifiers + n;
262
	  closure->marshal = (GClosureMarshal) ndata->notify;
263 264 265 266 267
	  closure->data = ndata->data;
	  ndata->notify (ndata->data, closure);
	}
      closure->marshal = NULL;
      closure->data = NULL;
268
      SET (closure, in_inotify, FALSE);
269 270
      break;
    case PRE_NOTIFY:
271
      i = closure->n_guards;
272
      offs = 0;
273 274 275 276 277 278 279
      while (i--)
	{
	  ndata = closure->notifiers + offs + i;
	  ndata->notify (ndata->data, closure);
	}
      break;
    case POST_NOTIFY:
280
      i = closure->n_guards;
281
      offs = i;
282 283 284 285 286 287 288 289 290
      while (i--)
	{
	  ndata = closure->notifiers + offs + i;
	  ndata->notify (ndata->data, closure);
	}
      break;
    }
}

291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
static void
g_closure_set_meta_va_marshal (GClosure       *closure,
			       GVaClosureMarshal va_meta_marshal)
{
  GRealClosure *real_closure;

  g_return_if_fail (closure != NULL);
  g_return_if_fail (va_meta_marshal != NULL);
  g_return_if_fail (closure->is_invalid == FALSE);
  g_return_if_fail (closure->in_marshal == FALSE);

  real_closure = G_REAL_CLOSURE (closure);

  g_return_if_fail (real_closure->meta_marshal != NULL);

  real_closure->va_meta_marshal = va_meta_marshal;
}

Stefan Kost's avatar
Stefan Kost committed
309
/**
310
 * g_closure_set_meta_marshal: (skip)
Stefan Kost's avatar
Stefan Kost committed
311 312 313
 * @closure: a #GClosure
 * @marshal_data: context-dependent data to pass to @meta_marshal
 * @meta_marshal: a #GClosureMarshal function
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329
 *
 * Sets the meta marshaller of @closure.  A meta marshaller wraps
 * @closure->marshal and modifies the way it is called in some
 * fashion. The most common use of this facility is for C callbacks.
 * The same marshallers (generated by <link
 * linkend="glib-genmarshal">glib-genmarshal</link>) are used
 * everywhere, but the way that we get the callback function
 * differs. In most cases we want to use @closure->callback, but in
 * other cases we want to use some different technique to retrieve the
 * callback function.
 *
 * For example, class closures for signals (see
 * g_signal_type_cclosure_new()) retrieve the callback function from a
 * fixed offset in the class structure.  The meta marshaller retrieves
 * the right callback and passes it to the marshaller as the
 * @marshal_data argument.
Stefan Kost's avatar
Stefan Kost committed
330
 */
331 332 333 334 335
void
g_closure_set_meta_marshal (GClosure       *closure,
			    gpointer        marshal_data,
			    GClosureMarshal meta_marshal)
{
336
  GRealClosure *real_closure;
337 338 339

  g_return_if_fail (closure != NULL);
  g_return_if_fail (meta_marshal != NULL);
340 341 342
  g_return_if_fail (closure->is_invalid == FALSE);
  g_return_if_fail (closure->in_marshal == FALSE);

343 344 345 346 347 348
  real_closure = G_REAL_CLOSURE (closure);

  g_return_if_fail (real_closure->meta_marshal == NULL);

  real_closure->meta_marshal = meta_marshal;
  real_closure->meta_marshal_data = marshal_data;
349 350
}

Stefan Kost's avatar
Stefan Kost committed
351
/**
352
 * g_closure_add_marshal_guards: (skip)
Stefan Kost's avatar
Stefan Kost committed
353 354 355 356 357
 * @closure: a #GClosure
 * @pre_marshal_data: data to pass to @pre_marshal_notify
 * @pre_marshal_notify: a function to call before the closure callback
 * @post_marshal_data: data to pass to @post_marshal_notify
 * @post_marshal_notify: a function to call after the closure callback
358 359 360 361 362
 *
 * Adds a pair of notifiers which get invoked before and after the
 * closure callback, respectively. This is typically used to protect
 * the extra arguments for the duration of the callback. See
 * g_object_watch_closure() for an example of marshal guards.
Stefan Kost's avatar
Stefan Kost committed
363
 */
364 365 366 367 368 369 370 371 372 373 374 375
void
g_closure_add_marshal_guards (GClosure      *closure,
			      gpointer       pre_marshal_data,
			      GClosureNotify pre_marshal_notify,
			      gpointer       post_marshal_data,
			      GClosureNotify post_marshal_notify)
{
  guint i;

  g_return_if_fail (closure != NULL);
  g_return_if_fail (pre_marshal_notify != NULL);
  g_return_if_fail (post_marshal_notify != NULL);
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
  g_return_if_fail (closure->is_invalid == FALSE);
  g_return_if_fail (closure->in_marshal == FALSE);
  g_return_if_fail (closure->n_guards < CLOSURE_MAX_N_GUARDS);

  closure->notifiers = g_renew (GClosureNotifyData, closure->notifiers, CLOSURE_N_NOTIFIERS (closure) + 2);
  if (closure->n_inotifiers)
    closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
			closure->n_fnotifiers +
			closure->n_inotifiers + 1)] = closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
									  closure->n_fnotifiers + 0)];
  if (closure->n_inotifiers > 1)
    closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
			closure->n_fnotifiers +
			closure->n_inotifiers)] = closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
								      closure->n_fnotifiers + 1)];
  if (closure->n_fnotifiers)
    closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
			closure->n_fnotifiers + 1)] = closure->notifiers[CLOSURE_N_MFUNCS (closure) + 0];
  if (closure->n_fnotifiers > 1)
    closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
			closure->n_fnotifiers)] = closure->notifiers[CLOSURE_N_MFUNCS (closure) + 1];
  if (closure->n_guards)
398 399
    closure->notifiers[(closure->n_guards +
			closure->n_guards + 1)] = closure->notifiers[closure->n_guards];
400
  i = closure->n_guards;
401 402 403 404
  closure->notifiers[i].data = pre_marshal_data;
  closure->notifiers[i].notify = pre_marshal_notify;
  closure->notifiers[i + 1].data = post_marshal_data;
  closure->notifiers[i + 1].notify = post_marshal_notify;
405
  INC (closure, n_guards);
406 407
}

Stefan Kost's avatar
Stefan Kost committed
408
/**
409
 * g_closure_add_finalize_notifier: (skip)
Stefan Kost's avatar
Stefan Kost committed
410 411 412
 * @closure: a #GClosure
 * @notify_data: data to pass to @notify_func
 * @notify_func: the callback function to register
413 414 415 416 417 418 419
 *
 * Registers a finalization notifier which will be called when the
 * reference count of @closure goes down to 0. Multiple finalization
 * notifiers on a single closure are invoked in unspecified order. If
 * a single call to g_closure_unref() results in the closure being
 * both invalidated and finalized, then the invalidate notifiers will
 * be run before the finalize notifiers.
Stefan Kost's avatar
Stefan Kost committed
420
 */
421
void
422 423 424
g_closure_add_finalize_notifier (GClosure      *closure,
				 gpointer       notify_data,
				 GClosureNotify notify_func)
425 426 427 428 429
{
  guint i;

  g_return_if_fail (closure != NULL);
  g_return_if_fail (notify_func != NULL);
430 431 432 433 434 435 436 437
  g_return_if_fail (closure->n_fnotifiers < CLOSURE_MAX_N_FNOTIFIERS);

  closure->notifiers = g_renew (GClosureNotifyData, closure->notifiers, CLOSURE_N_NOTIFIERS (closure) + 1);
  if (closure->n_inotifiers)
    closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
			closure->n_fnotifiers +
			closure->n_inotifiers)] = closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
								      closure->n_fnotifiers + 0)];
438
  i = CLOSURE_N_MFUNCS (closure) + closure->n_fnotifiers;
439 440
  closure->notifiers[i].data = notify_data;
  closure->notifiers[i].notify = notify_func;
441
  INC (closure, n_fnotifiers);
442 443
}

Stefan Kost's avatar
Stefan Kost committed
444
/**
445
 * g_closure_add_invalidate_notifier: (skip)
Stefan Kost's avatar
Stefan Kost committed
446 447 448
 * @closure: a #GClosure
 * @notify_data: data to pass to @notify_func
 * @notify_func: the callback function to register
449 450 451 452 453
 *
 * Registers an invalidation notifier which will be called when the
 * @closure is invalidated with g_closure_invalidate(). Invalidation
 * notifiers are invoked before finalization notifiers, in an
 * unspecified order.
Stefan Kost's avatar
Stefan Kost committed
454
 */
455
void
456 457 458
g_closure_add_invalidate_notifier (GClosure      *closure,
				   gpointer       notify_data,
				   GClosureNotify notify_func)
459 460 461 462 463
{
  guint i;

  g_return_if_fail (closure != NULL);
  g_return_if_fail (notify_func != NULL);
464 465
  g_return_if_fail (closure->is_invalid == FALSE);
  g_return_if_fail (closure->n_inotifiers < CLOSURE_MAX_N_INOTIFIERS);
466

467
  closure->notifiers = g_renew (GClosureNotifyData, closure->notifiers, CLOSURE_N_NOTIFIERS (closure) + 1);
468
  i = CLOSURE_N_MFUNCS (closure) + closure->n_fnotifiers + closure->n_inotifiers;
469 470
  closure->notifiers[i].data = notify_data;
  closure->notifiers[i].notify = notify_func;
471
  INC (closure, n_inotifiers);
472 473 474 475 476 477 478 479 480
}

static inline gboolean
closure_try_remove_inotify (GClosure       *closure,
			    gpointer       notify_data,
			    GClosureNotify notify_func)
{
  GClosureNotifyData *ndata, *nlast;

481 482
  nlast = closure->notifiers + CLOSURE_N_NOTIFIERS (closure) - 1;
  for (ndata = nlast + 1 - closure->n_inotifiers; ndata <= nlast; ndata++)
483 484
    if (ndata->notify == notify_func && ndata->data == notify_data)
      {
485
	DEC (closure, n_inotifiers);
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
	if (ndata < nlast)
	  *ndata = *nlast;

	return TRUE;
      }
  return FALSE;
}

static inline gboolean
closure_try_remove_fnotify (GClosure       *closure,
			    gpointer       notify_data,
			    GClosureNotify notify_func)
{
  GClosureNotifyData *ndata, *nlast;

501 502
  nlast = closure->notifiers + CLOSURE_N_NOTIFIERS (closure) - closure->n_inotifiers - 1;
  for (ndata = nlast + 1 - closure->n_fnotifiers; ndata <= nlast; ndata++)
503 504
    if (ndata->notify == notify_func && ndata->data == notify_data)
      {
505
	DEC (closure, n_fnotifiers);
506 507
	if (ndata < nlast)
	  *ndata = *nlast;
508 509 510 511 512
	if (closure->n_inotifiers)
	  closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
			      closure->n_fnotifiers)] = closure->notifiers[(CLOSURE_N_MFUNCS (closure) +
									    closure->n_fnotifiers +
									    closure->n_inotifiers)];
513 514 515 516 517
	return TRUE;
      }
  return FALSE;
}

Stefan Kost's avatar
Stefan Kost committed
518 519 520
/**
 * g_closure_ref:
 * @closure: #GClosure to increment the reference count on
521
 *
Stefan Kost's avatar
Stefan Kost committed
522 523
 * Increments the reference count on a closure to force it staying
 * alive while the caller holds a pointer to it.
524
 *
525
 * Returns: (transfer none): The @closure passed in, for convenience
Stefan Kost's avatar
Stefan Kost committed
526
 */
527 528 529
GClosure*
g_closure_ref (GClosure *closure)
{
530
  guint new_ref_count;
531 532 533 534
  g_return_val_if_fail (closure != NULL, NULL);
  g_return_val_if_fail (closure->ref_count > 0, NULL);
  g_return_val_if_fail (closure->ref_count < CLOSURE_MAX_REF_COUNT, NULL);

535 536
  INC_ASSIGN (closure, ref_count, &new_ref_count);
  g_return_val_if_fail (new_ref_count > 1, NULL);
537 538 539 540

  return closure;
}

Stefan Kost's avatar
Stefan Kost committed
541 542 543
/**
 * g_closure_invalidate:
 * @closure: GClosure to invalidate
544
 *
545
 * Sets a flag on the closure to indicate that its calling
546 547 548 549 550 551 552 553 554 555 556 557
 * environment has become invalid, and thus causes any future
 * invocations of g_closure_invoke() on this @closure to be
 * ignored. Also, invalidation notifiers installed on the closure will
 * be called at this point. Note that unless you are holding a
 * reference to the closure yourself, the invalidation notifiers may
 * unref the closure and cause it to be destroyed, so if you need to
 * access the closure after calling g_closure_invalidate(), make sure
 * that you've previously called g_closure_ref().
 *
 * Note that g_closure_invalidate() will also be called when the
 * reference count of a closure drops to zero (unless it has already
 * been invalidated before).
Stefan Kost's avatar
Stefan Kost committed
558
 */
559 560 561 562 563
void
g_closure_invalidate (GClosure *closure)
{
  g_return_if_fail (closure != NULL);

564
  if (!closure->is_invalid)
565
    {
566 567 568 569 570 571
      gboolean was_invalid;
      g_closure_ref (closure);           /* preserve floating flag */
      SWAP (closure, is_invalid, TRUE, &was_invalid);
      /* invalidate only once */
      if (!was_invalid)
        closure_invoke_notifiers (closure, INOTIFY);
572 573 574 575
      g_closure_unref (closure);
    }
}

Stefan Kost's avatar
Stefan Kost committed
576 577 578
/**
 * g_closure_unref:
 * @closure: #GClosure to decrement the reference count on
579 580 581 582
 *
 * Decrements the reference count of a closure after it was previously
 * incremented by the same caller. If no other callers are using the
 * closure, then the closure will be destroyed and freed.
Stefan Kost's avatar
Stefan Kost committed
583
 */
584 585 586
void
g_closure_unref (GClosure *closure)
{
587 588
  guint new_ref_count;

589 590 591
  g_return_if_fail (closure != NULL);
  g_return_if_fail (closure->ref_count > 0);

592 593
  if (closure->ref_count == 1)	/* last unref, invalidate first */
    g_closure_invalidate (closure);
594

595
  DEC_ASSIGN (closure, ref_count, &new_ref_count);
596

597
  if (new_ref_count == 0)
598 599
    {
      closure_invoke_notifiers (closure, FNOTIFY);
600
      g_free (closure->notifiers);
601
      g_free (G_REAL_CLOSURE (closure));
602 603 604
    }
}

Stefan Kost's avatar
Stefan Kost committed
605 606 607
/**
 * g_closure_sink:
 * @closure: #GClosure to decrement the initial reference count on, if it's
608 609 610 611 612 613 614 615
 *           still being held
 *
 * Takes over the initial ownership of a closure.  Each closure is
 * initially created in a <firstterm>floating</firstterm> state, which
 * means that the initial reference count is not owned by any caller.
 * g_closure_sink() checks to see if the object is still floating, and
 * if so, unsets the floating state and decreases the reference
 * count. If the closure is not floating, g_closure_sink() does
Matthias Clasen's avatar
Matthias Clasen committed
616
 * nothing. The reason for the existence of the floating state is to
617
 * prevent cumbersome code sequences like:
Stefan Kost's avatar
Stefan Kost committed
618
 * |[
619 620
 * closure = g_cclosure_new (cb_func, cb_data);
 * g_source_set_closure (source, closure);
Stefan Kost's avatar
Stefan Kost committed
621 622
 * g_closure_unref (closure); // XXX GObject doesn't really need this
 * ]|
623 624
 * Because g_source_set_closure() (and similar functions) take ownership of the
 * initial reference count, if it is unowned, we instead can write:
Stefan Kost's avatar
Stefan Kost committed
625 626 627
 * |[
 * g_source_set_closure (source, g_cclosure_new (cb_func, cb_data));
 * ]|
628 629
 *
 * Generally, this function is used together with g_closure_ref(). Ane example
Stefan Kost's avatar
Stefan Kost committed
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
 * of storing a closure for later notification looks like:
 * |[
 * static GClosure *notify_closure = NULL;
 * void
 * foo_notify_set_closure (GClosure *closure)
 * {
 *   if (notify_closure)
 *     g_closure_unref (notify_closure);
 *   notify_closure = closure;
 *   if (notify_closure)
 *     {
 *       g_closure_ref (notify_closure);
 *       g_closure_sink (notify_closure);
 *     }
 * }
 * ]|
646
 *
Stefan Kost's avatar
Stefan Kost committed
647 648 649 650
 * Because g_closure_sink() may decrement the reference count of a closure
 * (if it hasn't been called on @closure yet) just like g_closure_unref(),
 * g_closure_ref() should be called prior to this function.
 */
651 652 653 654 655 656 657
void
g_closure_sink (GClosure *closure)
{
  g_return_if_fail (closure != NULL);
  g_return_if_fail (closure->ref_count > 0);

  /* floating is basically a kludge to avoid creating closures
Matthias Clasen's avatar
Matthias Clasen committed
658
   * with a ref_count of 0. so the initial ref_count a closure has
659 660 661
   * is unowned. with invoking g_closure_sink() code may
   * indicate that it takes over that intiial ref_count.
   */
662
  if (closure->floating)
663
    {
664 665 666 667 668
      gboolean was_floating;
      SWAP (closure, floating, FALSE, &was_floating);
      /* unref floating flag only once */
      if (was_floating)
        g_closure_unref (closure);
669 670 671
    }
}

Stefan Kost's avatar
Stefan Kost committed
672
/**
673
 * g_closure_remove_invalidate_notifier: (skip)
Stefan Kost's avatar
Stefan Kost committed
674 675
 * @closure: a #GClosure
 * @notify_data: data which was passed to g_closure_add_invalidate_notifier()
676
 *               when registering @notify_func
Stefan Kost's avatar
Stefan Kost committed
677
 * @notify_func: the callback function to remove
678
 *
Stefan Kost's avatar
Stefan Kost committed
679
 * Removes an invalidation notifier.
680
 *
Stefan Kost's avatar
Stefan Kost committed
681 682
 * Notice that notifiers are automatically removed after they are run.
 */
683
void
684 685 686
g_closure_remove_invalidate_notifier (GClosure      *closure,
				      gpointer       notify_data,
				      GClosureNotify notify_func)
687 688 689 690
{
  g_return_if_fail (closure != NULL);
  g_return_if_fail (notify_func != NULL);

691
  if (closure->is_invalid && closure->in_inotify && /* account removal of notify_func() while it's called */
692 693
      ((gpointer) closure->marshal) == ((gpointer) notify_func) &&
      closure->data == notify_data)
694 695 696 697 698 699
    closure->marshal = NULL;
  else if (!closure_try_remove_inotify (closure, notify_data, notify_func))
    g_warning (G_STRLOC ": unable to remove uninstalled invalidation notifier: %p (%p)",
	       notify_func, notify_data);
}

Stefan Kost's avatar
Stefan Kost committed
700
/**
701
 * g_closure_remove_finalize_notifier: (skip)
Stefan Kost's avatar
Stefan Kost committed
702 703 704 705
 * @closure: a #GClosure
 * @notify_data: data which was passed to g_closure_add_finalize_notifier()
 *  when registering @notify_func
 * @notify_func: the callback function to remove
706
 *
Stefan Kost's avatar
Stefan Kost committed
707
 * Removes a finalization notifier.
708
 *
Stefan Kost's avatar
Stefan Kost committed
709 710
 * Notice that notifiers are automatically removed after they are run.
 */
711
void
712 713 714
g_closure_remove_finalize_notifier (GClosure      *closure,
				    gpointer       notify_data,
				    GClosureNotify notify_func)
715 716 717 718
{
  g_return_if_fail (closure != NULL);
  g_return_if_fail (notify_func != NULL);

719
  if (closure->is_invalid && !closure->in_inotify && /* account removal of notify_func() while it's called */
720 721
      ((gpointer) closure->marshal) == ((gpointer) notify_func) &&
      closure->data == notify_data)
722 723 724 725 726 727
    closure->marshal = NULL;
  else if (!closure_try_remove_fnotify (closure, notify_data, notify_func))
    g_warning (G_STRLOC ": unable to remove uninstalled finalization notifier: %p (%p)",
               notify_func, notify_data);
}

Stefan Kost's avatar
Stefan Kost committed
728 729 730
/**
 * g_closure_invoke:
 * @closure: a #GClosure
731 732 733
 * @return_value: (allow-none): a #GValue to store the return
 *                value. May be %NULL if the callback of @closure
 *                doesn't return a value.
Stefan Kost's avatar
Stefan Kost committed
734
 * @n_param_values: the length of the @param_values array
735 736 737
 * @param_values: (array length=n_param_values): an array of
 *                #GValue<!-- -->s holding the arguments on which to
 *                invoke the callback of @closure
738
 * @invocation_hint: (allow-none): a context-dependent invocation hint
739
 *
Stefan Kost's avatar
Stefan Kost committed
740 741
 * Invokes the closure, i.e. executes the callback represented by the @closure.
 */
742 743 744 745
void
g_closure_invoke (GClosure       *closure,
		  GValue /*out*/ *return_value,
		  guint           n_param_values,
746 747
		  const GValue   *param_values,
		  gpointer        invocation_hint)
748
{
749 750
  GRealClosure *real_closure;

751 752
  g_return_if_fail (closure != NULL);

753 754
  real_closure = G_REAL_CLOSURE (closure);

755
  g_closure_ref (closure);      /* preserve floating flag */
756 757
  if (!closure->is_invalid)
    {
758 759
      GClosureMarshal marshal;
      gpointer marshal_data;
760
      gboolean in_marshal = closure->in_marshal;
761

762
      g_return_if_fail (closure->marshal || real_closure->meta_marshal);
763

764
      SET (closure, in_marshal, TRUE);
765
      if (real_closure->meta_marshal)
766
	{
767 768
	  marshal_data = real_closure->meta_marshal_data;
	  marshal = real_closure->meta_marshal;
769 770 771 772 773 774 775 776
	}
      else
	{
	  marshal_data = NULL;
	  marshal = closure->marshal;
	}
      if (!in_marshal)
	closure_invoke_notifiers (closure, PRE_NOTIFY);
777
      marshal (closure,
778 779
	       return_value,
	       n_param_values, param_values,
780
	       invocation_hint,
781 782 783
	       marshal_data);
      if (!in_marshal)
	closure_invoke_notifiers (closure, POST_NOTIFY);
784
      SET (closure, in_marshal, in_marshal);
785
    }
786
  g_closure_unref (closure);
787 788
}

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
gboolean
_g_closure_supports_invoke_va (GClosure       *closure)
{
  GRealClosure *real_closure;

  g_return_val_if_fail (closure != NULL, FALSE);

  real_closure = G_REAL_CLOSURE (closure);

  return
    real_closure->va_marshal != NULL &&
    (real_closure->meta_marshal == NULL ||
     real_closure->va_meta_marshal != NULL);
}

void
_g_closure_invoke_va (GClosure       *closure,
		      GValue /*out*/ *return_value,
		      gpointer        instance,
		      va_list         args,
		      int             n_params,
		      GType          *param_types)
{
  GRealClosure *real_closure;

  g_return_if_fail (closure != NULL);

  real_closure = G_REAL_CLOSURE (closure);

  g_closure_ref (closure);      /* preserve floating flag */
  if (!closure->is_invalid)
    {
      GVaClosureMarshal marshal;
      gpointer marshal_data;
      gboolean in_marshal = closure->in_marshal;

      g_return_if_fail (closure->marshal || real_closure->meta_marshal);

      SET (closure, in_marshal, TRUE);
      if (real_closure->va_meta_marshal)
	{
	  marshal_data = real_closure->meta_marshal_data;
	  marshal = real_closure->va_meta_marshal;
	}
      else
	{
	  marshal_data = NULL;
	  marshal = real_closure->va_marshal;
	}
      if (!in_marshal)
	closure_invoke_notifiers (closure, PRE_NOTIFY);
      marshal (closure,
	       return_value,
	       instance, args,
	       marshal_data,
	       n_params, param_types);
      if (!in_marshal)
	closure_invoke_notifiers (closure, POST_NOTIFY);
      SET (closure, in_marshal, in_marshal);
    }
  g_closure_unref (closure);
}


Stefan Kost's avatar
Stefan Kost committed
853
/**
854
 * g_closure_set_marshal: (skip)
Stefan Kost's avatar
Stefan Kost committed
855 856
 * @closure: a #GClosure
 * @marshal: a #GClosureMarshal function
857
 *
Stefan Kost's avatar
Stefan Kost committed
858 859 860 861 862 863 864
 * Sets the marshaller of @closure. The <literal>marshal_data</literal>
 * of @marshal provides a way for a meta marshaller to provide additional
 * information to the marshaller. (See g_closure_set_meta_marshal().) For
 * GObject's C predefined marshallers (the g_cclosure_marshal_*()
 * functions), what it provides is a callback function to use instead of
 * @closure->callback.
 */
865 866 867 868 869 870 871 872 873 874 875 876 877 878
void
g_closure_set_marshal (GClosure       *closure,
		       GClosureMarshal marshal)
{
  g_return_if_fail (closure != NULL);
  g_return_if_fail (marshal != NULL);

  if (closure->marshal && closure->marshal != marshal)
    g_warning ("attempt to override closure->marshal (%p) with new marshal (%p)",
	       closure->marshal, marshal);
  else
    closure->marshal = marshal;
}

879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
void
_g_closure_set_va_marshal (GClosure       *closure,
			   GVaClosureMarshal marshal)
{
  GRealClosure *real_closure;

  g_return_if_fail (closure != NULL);
  g_return_if_fail (marshal != NULL);

  real_closure = G_REAL_CLOSURE (closure);

  if (real_closure->va_marshal && real_closure->va_marshal != marshal)
    g_warning ("attempt to override closure->va_marshal (%p) with new marshal (%p)",
	       real_closure->va_marshal, marshal);
  else
    real_closure->va_marshal = marshal;
}

Stefan Kost's avatar
Stefan Kost committed
897
/**
898
 * g_cclosure_new: (skip)
Stefan Kost's avatar
Stefan Kost committed
899 900 901
 * @callback_func: the function to invoke
 * @user_data: user data to pass to @callback_func
 * @destroy_data: destroy notify to be called when @user_data is no longer used
902 903 904 905
 *
 * Creates a new closure which invokes @callback_func with @user_data as
 * the last parameter.
 *
Stefan Kost's avatar
Stefan Kost committed
906 907
 * Returns: a new #GCClosure
 */
908 909 910 911 912 913 914 915 916 917 918
GClosure*
g_cclosure_new (GCallback      callback_func,
		gpointer       user_data,
		GClosureNotify destroy_data)
{
  GClosure *closure;
  
  g_return_val_if_fail (callback_func != NULL, NULL);
  
  closure = g_closure_new_simple (sizeof (GCClosure), user_data);
  if (destroy_data)
919
    g_closure_add_finalize_notifier (closure, user_data, destroy_data);
920
  ((GCClosure*) closure)->callback = (gpointer) callback_func;
921 922 923 924
  
  return closure;
}

Stefan Kost's avatar
Stefan Kost committed
925
/**
926
 * g_cclosure_new_swap: (skip)
Stefan Kost's avatar
Stefan Kost committed
927 928 929
 * @callback_func: the function to invoke
 * @user_data: user data to pass to @callback_func
 * @destroy_data: destroy notify to be called when @user_data is no longer used
930 931 932 933
 *
 * Creates a new closure which invokes @callback_func with @user_data as
 * the first parameter.
 *
934
 * Returns: (transfer full): a new #GCClosure
Stefan Kost's avatar
Stefan Kost committed
935
 */
936 937 938 939 940 941 942 943 944 945 946
GClosure*
g_cclosure_new_swap (GCallback      callback_func,
		     gpointer       user_data,
		     GClosureNotify destroy_data)
{
  GClosure *closure;
  
  g_return_val_if_fail (callback_func != NULL, NULL);
  
  closure = g_closure_new_simple (sizeof (GCClosure), user_data);
  if (destroy_data)
947
    g_closure_add_finalize_notifier (closure, user_data, destroy_data);
948
  ((GCClosure*) closure)->callback = (gpointer) callback_func;
949
  SET (closure, derivative_flag, TRUE);
950 951 952 953 954 955 956 957 958
  
  return closure;
}

static void
g_type_class_meta_marshal (GClosure       *closure,
			   GValue /*out*/ *return_value,
			   guint           n_param_values,
			   const GValue   *param_values,
959
			   gpointer        invocation_hint,
960 961 962 963
			   gpointer        marshal_data)
{
  GTypeClass *class;
  gpointer callback;
964
  /* GType itype = (GType) closure->data; */
965 966
  guint offset = GPOINTER_TO_UINT (marshal_data);
  
967
  class = G_TYPE_INSTANCE_GET_CLASS (g_value_peek_pointer (param_values + 0), itype, GTypeClass);
968 969
  callback = G_STRUCT_MEMBER (gpointer, class, offset);
  if (callback)
970 971 972 973 974
    closure->marshal (closure,
		      return_value,
		      n_param_values, param_values,
		      invocation_hint,
		      callback);
975 976
}

977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
static void
g_type_class_meta_marshalv (GClosure *closure,
			    GValue   *return_value,
			    gpointer  instance,
			    va_list   args,
			    gpointer  marshal_data,
			    int       n_params,
			    GType    *param_types)
{
  GRealClosure *real_closure;
  GTypeClass *class;
  gpointer callback;
  /* GType itype = (GType) closure->data; */
  guint offset = GPOINTER_TO_UINT (marshal_data);

  real_closure = G_REAL_CLOSURE (closure);

  class = G_TYPE_INSTANCE_GET_CLASS (instance, itype, GTypeClass);
  callback = G_STRUCT_MEMBER (gpointer, class, offset);
  if (callback)
    real_closure->va_marshal (closure,
			      return_value,
			      instance, args,
			      callback,
			      n_params,
			      param_types);
}

1005 1006 1007 1008 1009
static void
g_type_iface_meta_marshal (GClosure       *closure,
			   GValue /*out*/ *return_value,
			   guint           n_param_values,
			   const GValue   *param_values,
1010
			   gpointer        invocation_hint,
1011 1012 1013 1014
			   gpointer        marshal_data)
{
  GTypeClass *class;
  gpointer callback;
1015
  GType itype = (GType) closure->data;
1016 1017
  guint offset = GPOINTER_TO_UINT (marshal_data);
  
1018
  class = G_TYPE_INSTANCE_GET_INTERFACE (g_value_peek_pointer (param_values + 0), itype, GTypeClass);
1019 1020
  callback = G_STRUCT_MEMBER (gpointer, class, offset);
  if (callback)
1021 1022 1023 1024 1025
    closure->marshal (closure,
		      return_value,
		      n_param_values, param_values,
		      invocation_hint,
		      callback);
1026 1027
}

1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
gboolean
_g_closure_is_void (GClosure *closure,
		    gpointer instance)
{
  GRealClosure *real_closure;
  GTypeClass *class;
  gpointer callback;
  GType itype;
  guint offset;

  if (closure->is_invalid)
    return TRUE;

  real_closure = G_REAL_CLOSURE (closure);

  if (real_closure->meta_marshal == g_type_iface_meta_marshal)
    {
      itype = (GType) closure->data;
      offset = GPOINTER_TO_UINT (real_closure->meta_marshal_data);

      class = G_TYPE_INSTANCE_GET_INTERFACE (instance, itype, GTypeClass);
      callback = G_STRUCT_MEMBER (gpointer, class, offset);
      return callback == NULL;
    }
  else if (real_closure->meta_marshal == g_type_class_meta_marshal)
    {
      offset = GPOINTER_TO_UINT (real_closure->meta_marshal_data);

      class = G_TYPE_INSTANCE_GET_CLASS (instance, itype, GTypeClass);
      callback = G_STRUCT_MEMBER (gpointer, class, offset);
      return callback == NULL;
    }

  return FALSE;
}

1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
static void
g_type_iface_meta_marshalv (GClosure *closure,
			    GValue   *return_value,
			    gpointer  instance,
			    va_list   args,
			    gpointer  marshal_data,
			    int       n_params,
			    GType    *param_types)
{
  GRealClosure *real_closure;
  GTypeClass *class;
  gpointer callback;
  GType itype = (GType) closure->data;
  guint offset = GPOINTER_TO_UINT (marshal_data);

  real_closure = G_REAL_CLOSURE (closure);

  class = G_TYPE_INSTANCE_GET_INTERFACE (instance, itype, GTypeClass);
  callback = G_STRUCT_MEMBER (gpointer, class, offset);
  if (callback)
    real_closure->va_marshal (closure,
			      return_value,
			      instance, args,
			      callback,
			      n_params,
			      param_types);
}

Stefan Kost's avatar
Stefan Kost committed
1092 1093 1094
/**
 * g_signal_type_cclosure_new:
 * @itype: the #GType identifier of an interface or classed type
1095
 * @struct_offset: the offset of the member function of @itype's class
Stefan Kost's avatar
Stefan Kost committed
1096
 *  structure which is to be invoked by the new closure
1097
 *
Stefan Kost's avatar
Stefan Kost committed
1098 1099 1100
 * Creates a new closure which invokes the function found at the offset
 * @struct_offset in the class structure of the interface or classed type
 * identified by @itype.
1101
 *
Stefan Kost's avatar
Stefan Kost committed
1102 1103
 * Returns: a new #GCClosure
 */
1104
GClosure*
1105 1106
g_signal_type_cclosure_new (GType    itype,
			    guint    struct_offset)
1107 1108 1109 1110 1111 1112
{
  GClosure *closure;
  
  g_return_val_if_fail (G_TYPE_IS_CLASSED (itype) || G_TYPE_IS_INTERFACE (itype), NULL);
  g_return_val_if_fail (struct_offset >= sizeof (GTypeClass), NULL);
  
1113
  closure = g_closure_new_simple (sizeof (GClosure), (gpointer) itype);
1114
  if (G_TYPE_IS_INTERFACE (itype))
1115 1116 1117 1118
    {
      g_closure_set_meta_marshal (closure, GUINT_TO_POINTER (struct_offset), g_type_iface_meta_marshal);
      g_closure_set_meta_va_marshal (closure, g_type_iface_meta_marshalv);
    }
1119
  else
1120 1121 1122 1123
    {
      g_closure_set_meta_marshal (closure, GUINT_TO_POINTER (struct_offset), g_type_class_meta_marshal);
      g_closure_set_meta_va_marshal (closure, g_type_class_meta_marshalv);
    }
1124 1125
  return closure;
}
Matthias Clasen's avatar
Matthias Clasen committed
1126

1127 1128
#include <ffi.h>
static ffi_type *
1129 1130 1131 1132
value_to_ffi_type (const GValue *gvalue,
                   gpointer *value,
                   gint *enum_tmpval,
                   gboolean *tmpval_used)
1133 1134 1135 1136 1137
{
  ffi_type *rettype = NULL;
  GType type = g_type_fundamental (G_VALUE_TYPE (gvalue));
  g_assert (type != G_TYPE_INVALID);

1138 1139 1140 1141 1142 1143
  if (enum_tmpval)
    {
      g_assert (tmpval_used != NULL);
      *tmpval_used = FALSE;
    }

1144 1145 1146 1147 1148 1149 1150 1151
  switch (type)
    {
    case G_TYPE_BOOLEAN:
    case G_TYPE_CHAR:
    case G_TYPE_INT:
      rettype = &ffi_type_sint;
      *value = (gpointer)&(gvalue->data[0].v_int);
      break;
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164
    case G_TYPE_ENUM:
      /* enums are stored in v_long even though they are integers, which makes
       * marshalling through libffi somewhat complicated.  They need to be
       * marshalled as signed ints, but we need to use a temporary int sized
       * value to pass to libffi otherwise it'll pull the wrong value on
       * BE machines with 32-bit integers when treating v_long as 32-bit int.
       */
      g_assert (enum_tmpval != NULL);
      rettype = &ffi_type_sint;
      *enum_tmpval = g_value_get_enum (gvalue);
      *value = enum_tmpval;
      *tmpval_used = TRUE;
      break;
1165 1166
    case G_TYPE_UCHAR:
    case G_TYPE_UINT:
1167
    case G_TYPE_FLAGS:
1168 1169 1170 1171 1172 1173
      rettype = &ffi_type_uint;
      *value = (gpointer)&(gvalue->data[0].v_uint);
      break;
    case G_TYPE_STRING:
    case G_TYPE_OBJECT:
    case G_TYPE_BOXED:
1174
    case G_TYPE_PARAM:
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
    case G_TYPE_POINTER:
    case G_TYPE_INTERFACE:
    case G_TYPE_VARIANT:
      rettype = &ffi_type_pointer;
      *value = (gpointer)&(gvalue->data[0].v_pointer);
      break;
    case G_TYPE_FLOAT:
      rettype = &ffi_type_float;
      *value = (gpointer)&(gvalue->data[0].v_float);
      break;
    case G_TYPE_DOUBLE:
      rettype = &ffi_type_double;
      *value = (gpointer)&(gvalue->data[0].v_double);
      break;
    case G_TYPE_LONG:
      rettype = &ffi_type_slong;
      *value = (gpointer)&(gvalue->data[0].v_long);
      break;
    case G_TYPE_ULONG:
      rettype = &ffi_type_ulong;
      *value = (gpointer)&(gvalue->data[0].v_ulong);
      break;
    case G_TYPE_INT64:
      rettype = &ffi_type_sint64;
      *value = (gpointer)&(gvalue->data[0].v_int64);
      break;
    case G_TYPE_UINT64:
      rettype = &ffi_type_uint64;
      *value = (gpointer)&(gvalue->data[0].v_uint64);
      break;
    default:
      rettype = &ffi_type_pointer;
      *value = NULL;
      g_warning ("value_to_ffi_type: Unsupported fundamental type: %s", g_type_name (type));
      break;
    }
  return rettype;
}

static void
value_from_ffi_type (GValue *gvalue, gpointer *value)
{
1217
  ffi_arg *int_val = (ffi_arg*) value;
1218

1219 1220 1221
  switch (g_type_fundamental (G_VALUE_TYPE (gvalue)))
    {
    case G_TYPE_INT:
1222
      g_value_set_int (gvalue, (gint) *int_val);
1223 1224 1225 1226 1227 1228 1229 1230
      break;
    case G_TYPE_FLOAT:
      g_value_set_float (gvalue, *(gfloat*)value);
      break;
    case G_TYPE_DOUBLE:
      g_value_set_double (gvalue, *(gdouble*)value);
      break;
    case G_TYPE_BOOLEAN:
1231
      g_value_set_boolean (gvalue, (gboolean) *int_val);
1232 1233 1234 1235 1236
      break;
    case G_TYPE_STRING:
      g_value_set_string (gvalue, *(gchar**)value);
      break;
    case G_TYPE_CHAR:
1237
      g_value_set_schar (gvalue, (gint8) *int_val);
1238 1239
      break;
    case G_TYPE_UCHAR:
1240
      g_value_set_uchar (gvalue, (guchar) *int_val);
1241 1242
      break;
    case G_TYPE_UINT:
1243
      g_value_set_uint (gvalue, (guint) *int_val);
1244 1245 1246 1247 1248
      break;
    case G_TYPE_POINTER:
      g_value_set_pointer (gvalue, *(gpointer*)value);
      break;
    case G_TYPE_LONG:
1249
      g_value_set_long (gvalue, (glong) *int_val);
1250 1251
      break;
    case G_TYPE_ULONG:
1252
      g_value_set_ulong (gvalue, (gulong) *int_val);
1253 1254
      break;
    case G_TYPE_INT64:
1255
      g_value_set_int64 (gvalue, (gint64) *int_val);
1256 1257
      break;
    case G_TYPE_UINT64:
1258
      g_value_set_uint64 (gvalue, (guint64) *int_val);
1259 1260 1261 1262
      break;
    case G_TYPE_BOXED:
      g_value_set_boxed (gvalue, *(gpointer*)value);
      break;
1263
    case G_TYPE_ENUM:
1264
      g_value_set_enum (gvalue, (gint) *int_val);
1265
      break;
1266
    case G_TYPE_FLAGS:
1267
      g_value_set_flags (gvalue, (guint) *int_val);
1268
      break;
1269 1270 1271
    case G_TYPE_PARAM:
      g_value_set_param (gvalue, *(gpointer*)value);
      break;
1272 1273 1274
    case G_TYPE_OBJECT:
      g_value_set_object (gvalue, *(gpointer*)value);
      break;
1275 1276 1277
    case G_TYPE_VARIANT:
      g_value_set_variant (gvalue, *(gpointer*)value);
      break;
1278 1279 1280 1281 1282 1283
    default:
      g_warning ("value_from_ffi_type: Unsupported fundamental type: %s",
                g_type_name (g_type_fundamental (G_VALUE_TYPE (gvalue))));
    }
}

1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
typedef union {
  gpointer _gpointer;
  float _float;
  double _double;
  gint _gint;
  guint _guint;
  glong _glong;
  gulong _gulong;
  gint64 _gint64;
  guint64 _guint64;
} va_arg_storage;

static ffi_type *
va_to_ffi_type (GType gtype,
		va_list *va,
		va_arg_storage *storage)
{
  ffi_type *rettype = NULL;
  GType type = g_type_fundamental (gtype);
  g_assert (type != G_TYPE_INVALID);

  switch (type)
    {
    case G_TYPE_BOOLEAN:
    case G_TYPE_CHAR:
    case G_TYPE_INT:
    case G_TYPE_ENUM:
      rettype = &ffi_type_sint;
      storage->_gint = va_arg (*va, gint);
      break;
    case G_TYPE_UCHAR:
    case G_TYPE_UINT:
    case G_TYPE_FLAGS:
      rettype = &ffi_type_uint;
      storage->_guint = va_arg (*va, guint);
      break;
    case G_TYPE_STRING:
    case G_TYPE_OBJECT:
    case G_TYPE_BOXED:
    case G_TYPE_PARAM:
    case G_TYPE_POINTER:
    case G_TYPE_INTERFACE:
    case G_TYPE_VARIANT:
      rettype = &ffi_type_pointer;
      storage->_gpointer = va_arg (*va, gpointer);
      break;
    case G_TYPE_FLOAT:
      /* Float args are passed as doubles in varargs */
      rettype = &ffi_type_float;
      storage->_float = (float)va_arg (*va, double);
      break;
    case G_TYPE_DOUBLE:
      rettype = &ffi_type_double;
      storage->_double = va_arg (*va, double);
      break;
    case G_TYPE_LONG:
      rettype = &ffi_type_slong;
      storage->_glong = va_arg (*va, glong);
      break;
    case G_TYPE_ULONG:
      rettype = &ffi_type_ulong;
      storage->_gulong = va_arg (*va, gulong);
      break;
    case G_TYPE_INT64:
      rettype = &ffi_type_sint64;
      storage->_gint64 = va_arg (*va, gint64);
      break;
    case G_TYPE_UINT64:
      rettype = &ffi_type_uint64;
      storage->_guint64 = va_arg (*va, guint64);
      break;
    default:
      rettype = &ffi_type_pointer;
      storage->_guint64  = 0;
      g_warning ("va_to_ffi_type: Unsupported fundamental type: %s", g_type_name (type));
      break;
    }
  return rettype;
}

1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
/**
 * g_cclosure_marshal_generic:
 * @closure: A #GClosure.
 * @return_gvalue: A #GValue to store the return value. May be %NULL
 *   if the callback of closure doesn't return a value.
 * @n_param_values: The length of the @param_values array.
 * @param_values: An array of #GValue<!-- -->s holding the arguments
 *   on which to invoke the callback of closure.
 * @invocation_hint: The invocation hint given as the last argument to
 *   g_closure_invoke().
 * @marshal_data: Additional data specified when registering the
 *   marshaller, see g_closure_set_marshal() and
 *   g_closure_set_meta_marshal()
 *
 * A generic marshaller function implemented via <ulink
 * url="http://sourceware.org/libffi/">libffi</ulink>.
 *
 * Since: 2.30
 */
void
g_cclosure_marshal_generic (GClosure     *closure,
                            GValue       *return_gvalue,
                            guint         n_param_values,
                            const GValue *param_values,
                            gpointer      invocation_hint,
                            gpointer      marshal_data)
{
  ffi_type *rtype;
  void *rvalue;
  int n_args;
  ffi_type **atypes;
  void **args;
  int i;
  ffi_cif cif;
  GCClosure *cc = (GCClosure*) closure;
1399 1400
  gint *enum_tmpval;
  gboolean tmpval_used = FALSE;
1401

1402
  enum_tmpval = g_alloca (sizeof (gint));
1403 1404
  if (return_gvalue && G_VALUE_TYPE (return_gvalue))
    {
1405
      rtype = value_to_ffi_type (return_gvalue, &rvalue, enum_tmpval, &tmpval_used);
1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
    }
  else
    {
      rtype = &ffi_type_void;
    }

  rvalue = g_alloca (MAX (rtype->size, sizeof (ffi_arg)));

  n_args = n_param_values + 1;
  atypes = g_alloca (sizeof (ffi_type *) * n_args);
  args =  g_alloca (sizeof (gpointer) * n_args);

1418 1419 1420
  if (tmpval_used)
    enum_tmpval = g_alloca (sizeof (gint));

1421 1422 1423
  if (G_CCLOSURE_SWAP_DATA (closure))
    {
      atypes[n_args-1] = value_to_ffi_type (param_values + 0,
1424 1425 1426
                                            &args[n_args-1],
                                            enum_tmpval,
                                            &tmpval_used);
1427 1428 1429 1430 1431
      atypes[0] = &ffi_type_pointer;
      args[0] = &closure->data;
    }
  else
    {
1432 1433 1434 1435
      atypes[0] = value_to_ffi_type (param_values + 0,
                                     &args[0],
                                     enum_tmpval,
                                     &tmpval_used);
1436 1437 1438 1439 1440
      atypes[n_args-1] = &ffi_type_pointer;
      args[n_args-1] = &closure->data;
    }

  for (i = 1; i < n_args - 1; i++)
1441 1442 1443 1444 1445 1446 1447 1448 1449
    {
      if (tmpval_used)
        enum_tmpval = g_alloca (sizeof (gint));

      atypes[i] = value_to_ffi_type (param_values + i,
                                     &args[i],
                                     enum_tmpval,
                                     &tmpval_used);
    }
1450 1451 1452 1453 1454 1455 1456 1457 1458

  if (ffi_prep_cif (&cif, FFI_DEFAULT_ABI, n_args, rtype, atypes) != FFI_OK)
    return;

  ffi_call (&cif, marshal_data ? marshal_data : cc->callback, rvalue, args);

  if (return_gvalue && G_VALUE_TYPE (return_gvalue))
    value_from_ffi_type (return_gvalue, rvalue);
}
Stefan Kost's avatar
Stefan Kost committed
1459

1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
void
g_cclosure_marshal_generic_va (GClosure *closure,
			       GValue   *return_value,
			       gpointer  instance,
			       va_list   args_list,
			       gpointer  marshal_data,
			       int       n_params,
			       GType    *param_types)
{
  ffi_type *rtype;
  void *rvalue;
  int n_args;
  ffi_type **atypes;
  void **args;
  va_arg_storage *storage;
  int i;
  ffi_cif cif;
  GCClosure *cc = (GCClosure*) closure;
  gint *enum_tmpval;
  gboolean tmpval_used = FALSE;
  va_list args_copy;

  enum_tmpval = g_alloca (sizeof (gint));
  if (return_value && G_VALUE_TYPE (return_value))
    {
      rtype = value_to_ffi_type (return_value, &rvalue, enum_tmpval, &tmpval_used);
    }
  else
    {
      rtype = &ffi_type_void;
    }

  rvalue = g_alloca (MAX (rtype->size, sizeof (ffi_arg)));

  n_args = n_params + 2;
  atypes = g_alloca (sizeof (ffi_type *) * n_args);
  args =  g_alloca (sizeof (gpointer) * n_args);
  storage = g_alloca (sizeof (va_arg_storage) * n_params);

  if (tmpval_used)
    enum_tmpval = g_alloca (sizeof (gint));

  if (G_CCLOSURE_SWAP_DATA (closure))
    {
      atypes[n_args-1] = &ffi_type_pointer;
      args[n_args-1] = &instance;
      atypes[0] = &ffi_type_pointer;
      args[0] = &closure->data;
    }
  else
    {
      atypes[0] = &ffi_type_pointer;
      args[0] = &instance;
      atypes[n_args-1] = &ffi_type_pointer;
      args[n_args-1] = &closure->data;
    }

1517
  G_VA_COPY (args_copy, args_list);
1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576

  /* Box non-primitive arguments */
  for (i = 0; i < n_params; i++)
    {
      GType type = param_types[i]  & ~G_SIGNAL_TYPE_STATIC_SCOPE;
      GType fundamental = G_TYPE_FUNDAMENTAL (type);

      atypes[i+1] = va_to_ffi_type (type,
				    &args_copy,
				    &storage[i]);
      args[i+1] = &storage[i];

      if ((param_types[i]  & G_SIGNAL_TYPE_STATIC_SCOPE) == 0)
	{
	  if (fundamental == G_TYPE_STRING && storage[i]._gpointer != NULL)
	    storage[i]._gpointer = g_strdup (storage[i]._gpointer);
	  else if (fundamental == G_TYPE_PARAM && storage[i]._gpointer != NULL)
	    storage[i]._gpointer = g_param_spec_ref (storage[i]._gpointer);
	  else if (fundamental == G_TYPE_BOXED && storage[i]._gpointer != NULL)
	    storage[i]._gpointer = g_boxed_copy (type, storage[i]._gpointer);
	  else if (fundamental == G_TYPE_VARIANT && storage[i]._gpointer != NULL)
	    storage[i]._gpointer = g_variant_ref_sink (storage[i]._gpointer);
	}
      if (fundamental == G_TYPE_OBJECT && storage[i]._gpointer != NULL)
	storage[i]._gpointer = g_object_ref (storage[i]._gpointer);
    }

  va_end (args_copy);
  
  if (ffi_prep_cif (&cif, FFI_DEFAULT_ABI, n_args, rtype, atypes) != FFI_OK)
    return;

  ffi_call (&cif, marshal_data ? marshal_data : cc->callback, rvalue, args);

  /* Unbox non-primitive arguments */
  for (i = 0; i < n_params; i++)
    {
      GType type = param_types[i]  & ~G_SIGNAL_TYPE_STATIC_SCOPE;
      GType fundamental = G_TYPE_FUNDAMENTAL (type);

      if ((param_types[i]  & G_SIGNAL_TYPE_STATIC_SCOPE) == 0)
	{
	  if (fundamental == G_TYPE_STRING && storage[i]._gpointer != NULL)
	    g_free (storage[i]._gpointer);
	  else if (fundamental == G_TYPE_PARAM && storage[i]._gpointer != NULL)
	    g_param_spec_unref (storage[i]._gpointer);
	  else if (fundamental == G_TYPE_BOXED && storage[i]._gpointer != NULL)
	    g_boxed_free (type, storage[i]._gpointer);
	  else if (fundamental == G_TYPE_VARIANT && storage[i]._gpointer != NULL)
	    g_variant_unref (storage[i]._gpointer);
	}
      if (fundamental == G_TYPE_OBJECT && storage[i]._gpointer != NULL)
	g_object_unref (storage[i]._gpointer);
    }
  
  if (return_value && G_VALUE_TYPE (return_value))
    value_from_ffi_type (return_value, rvalue);
}

Stefan Kost's avatar
Stefan Kost committed
1577 1578 1579 1580 1581 1582 1583 1584 1585
/**
 * g_cclosure_marshal_VOID__VOID:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 1
 * @param_values: a #GValue array holding only the instance
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1586
 *
Stefan Kost's avatar
Stefan Kost committed
1587 1588 1589
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, gpointer user_data)</literal>.
 */
1590

Stefan Kost's avatar
Stefan Kost committed
1591 1592 1593 1594 1595 1596 1597 1598 1599
/**
 * g_cclosure_marshal_VOID__BOOLEAN:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 2
 * @param_values: a #GValue array holding the instance and the #gboolean parameter
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1600
 *
Stefan Kost's avatar
Stefan Kost committed
1601 1602 1603
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, gboolean arg1, gpointer user_data)</literal>.
 */
1604

Stefan Kost's avatar
Stefan Kost committed
1605 1606 1607 1608 1609 1610 1611 1612 1613
/**
 * g_cclosure_marshal_VOID__CHAR:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 2
 * @param_values: a #GValue array holding the instance and the #gchar parameter
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1614
 *
Stefan Kost's avatar
Stefan Kost committed
1615 1616 1617
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, gchar arg1, gpointer user_data)</literal>.
 */
1618

Stefan Kost's avatar
Stefan Kost committed
1619 1620 1621 1622 1623 1624 1625 1626 1627
/**
 * g_cclosure_marshal_VOID__UCHAR:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 2
 * @param_values: a #GValue array holding the instance and the #guchar parameter
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1628
 *
Stefan Kost's avatar
Stefan Kost committed
1629 1630 1631
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, guchar arg1, gpointer user_data)</literal>.
 */
1632

Stefan Kost's avatar
Stefan Kost committed
1633 1634 1635 1636 1637 1638 1639 1640 1641
/**
 * g_cclosure_marshal_VOID__INT:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 2
 * @param_values: a #GValue array holding the instance and the #gint parameter
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1642
 *
Stefan Kost's avatar
Stefan Kost committed
1643 1644 1645
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, gint arg1, gpointer user_data)</literal>.
 */
1646

Stefan Kost's avatar
Stefan Kost committed
1647 1648 1649 1650 1651 1652 1653 1654 1655
/**
 * g_cclosure_marshal_VOID__UINT:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 2
 * @param_values: a #GValue array holding the instance and the #guint parameter
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1656
 *
Stefan Kost's avatar
Stefan Kost committed
1657 1658 1659
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, guint arg1, gpointer user_data)</literal>.
 */
1660

Stefan Kost's avatar
Stefan Kost committed
1661 1662 1663 1664 1665 1666 1667 1668 1669
/**
 * g_cclosure_marshal_VOID__LONG:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 2
 * @param_values: a #GValue array holding the instance and the #glong parameter
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1670
 *
Stefan Kost's avatar
Stefan Kost committed
1671 1672 1673
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, glong arg1, gpointer user_data)</literal>.
 */
1674

Stefan Kost's avatar
Stefan Kost committed
1675 1676 1677 1678 1679 1680 1681 1682 1683
/**
 * g_cclosure_marshal_VOID__ULONG:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 2
 * @param_values: a #GValue array holding the instance and the #gulong parameter
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1684
 *
Stefan Kost's avatar
Stefan Kost committed
1685 1686 1687
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, gulong arg1, gpointer user_data)</literal>.
 */
1688

Stefan Kost's avatar
Stefan Kost committed
1689 1690 1691 1692 1693 1694 1695 1696 1697
/**
 * g_cclosure_marshal_VOID__ENUM:
 * @closure: the #GClosure to which the marshaller belongs
 * @return_value: ignored
 * @n_param_values: 2
 * @param_values: a #GValue array holding the instance and the enumeration parameter
 * @invocation_hint: the invocation hint given as the last argument
 *  to g_closure_invoke()
 * @marshal_data: additional data specified when registering the marshaller
1698
 *
Stefan Kost's avatar
Stefan Kost committed
1699 1700 1701
 * A marshaller for a #GCClosure with a callback of type
 * <literal>void (*callback) (gpointer instance, gint arg1, gpointer user_data)</literal> where the #gint parameter denotes an enumeration type..
 */