gobject.h 21.7 KB
Newer Older
1
/* GObject - GLib Type, Object, Parameter and Signal Library
2
 * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
3 4 5 6 7 8 9 10
 *
 * 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
11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12 13 14 15 16 17 18
 * 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.
 */
19 20 21 22
#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
#error "Only <glib-object.h> can be included directly."
#endif

23 24 25
#ifndef __G_OBJECT_H__
#define __G_OBJECT_H__

26 27 28 29
#include        <gobject/gtype.h>
#include        <gobject/gvalue.h>
#include        <gobject/gparam.h>
#include        <gobject/gclosure.h>
30
#include        <gobject/gsignal.h>
31

32
G_BEGIN_DECLS
33 34

/* --- type macros --- */
Stefan Kost's avatar
Stefan Kost committed
35 36 37 38 39 40 41 42
/**
 * G_TYPE_IS_OBJECT:
 * @type: Type id to check
 * 
 * Check if the passed in type id is a %G_TYPE_OBJECT or derived from it.
 * 
 * Returns: %FALSE or %TRUE, indicating whether @type is a %G_TYPE_OBJECT.
 */
43
#define G_TYPE_IS_OBJECT(type)      (G_TYPE_FUNDAMENTAL (type) == G_TYPE_OBJECT)
Stefan Kost's avatar
Stefan Kost committed
44 45 46 47 48 49 50 51
/**
 * G_OBJECT:
 * @object: Object which is subject to casting.
 * 
 * Casts a #GObject or derived pointer into a (GObject*) pointer.
 * Depending on the current debugging level, this function may invoke
 * certain runtime checks to identify invalid casts.
 */
52
#define G_OBJECT(object)            (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_OBJECT, GObject))
Stefan Kost's avatar
Stefan Kost committed
53 54 55 56 57 58
/**
 * G_OBJECT_CLASS:
 * @class: a valid #GObjectClass
 * 
 * Casts a derived #GObjectClass structure into a #GObjectClass structure.
 */
59
#define G_OBJECT_CLASS(class)       (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_OBJECT, GObjectClass))
Stefan Kost's avatar
Stefan Kost committed
60 61 62 63 64 65
/**
 * G_IS_OBJECT:
 * @object: Instance to check for being a %G_TYPE_OBJECT.
 * 
 * Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_OBJECT.
 */
66
#define G_IS_OBJECT(object)         (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_OBJECT))
Stefan Kost's avatar
Stefan Kost committed
67 68 69 70 71 72 73
/**
 * G_IS_OBJECT_CLASS:
 * @class: a #GObjectClass
 * 
 * Checks whether @class "is a" valid #GObjectClass structure of type
 * %G_TYPE_OBJECT or derived.
 */
74
#define G_IS_OBJECT_CLASS(class)    (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_OBJECT))
Stefan Kost's avatar
Stefan Kost committed
75 76 77 78 79 80 81 82
/**
 * G_OBJECT_GET_CLASS:
 * @object: a #GObject instance.
 * 
 * Get the class structure associated to a #GObject instance.
 *
 * Returns: pointer to object class structure.
 */
83
#define G_OBJECT_GET_CLASS(object)  (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_OBJECT, GObjectClass))
Stefan Kost's avatar
Stefan Kost committed
84 85 86 87 88 89 90 91
/**
 * G_OBJECT_TYPE:
 * @object: Object to return the type id for.
 * 
 * Get the type id of an object.
 * 
 * Returns: Type id of @object.
 */
92
#define G_OBJECT_TYPE(object)       (G_TYPE_FROM_INSTANCE (object))
Stefan Kost's avatar
Stefan Kost committed
93 94 95 96 97 98 99 100 101
/**
 * G_OBJECT_TYPE_NAME:
 * @object: Object to return the type name for.
 * 
 * Get the name of an object's type.
 * 
 * Returns: Type name of @object. The string is owned by the type system and 
 *  should not be freed.
 */
102
#define G_OBJECT_TYPE_NAME(object)  (g_type_name (G_OBJECT_TYPE (object)))
Stefan Kost's avatar
Stefan Kost committed
103 104 105 106 107 108 109 110
/**
 * G_OBJECT_CLASS_TYPE:
 * @class: a valid #GObjectClass
 * 
 * Get the type id of a class structure.
 * 
 * Returns: Type id of @class.
 */
111
#define G_OBJECT_CLASS_TYPE(class)  (G_TYPE_FROM_CLASS (class))
Stefan Kost's avatar
Stefan Kost committed
112 113 114 115 116 117 118 119 120
/**
 * G_OBJECT_CLASS_NAME:
 * @class: a valid #GObjectClass
 * 
 * Return the name of a class structure's type.
 * 
 * Returns: Type name of @class. The string is owned by the type system and 
 *  should not be freed.
 */
121
#define G_OBJECT_CLASS_NAME(class)  (g_type_name (G_OBJECT_CLASS_TYPE (class)))
Stefan Kost's avatar
Stefan Kost committed
122 123 124 125 126 127 128 129
/**
 * G_VALUE_HOLDS_OBJECT:
 * @value: a valid #GValue structure
 * 
 * Checks whether the given #GValue can hold values derived from type %G_TYPE_OBJECT.
 * 
 * Returns: %TRUE on success.
 */
130
#define G_VALUE_HOLDS_OBJECT(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_OBJECT))
131

132
/* --- type macros --- */
Stefan Kost's avatar
Stefan Kost committed
133 134 135 136 137
/**
 * G_TYPE_INITIALLY_UNOWNED:
 * 
 * The type for #GInitiallyUnowned.
 */
138
#define G_TYPE_INITIALLY_UNOWNED	      (g_initially_unowned_get_type())
139 140 141 142 143 144 145 146
/**
 * G_INITIALLY_UNOWNED:
 * @object: Object which is subject to casting.
 * 
 * Casts a #GInitiallyUnowned or derived pointer into a (GInitiallyUnowned*) 
 * pointer. Depending on the current debugging level, this function may invoke
 * certain runtime checks to identify invalid casts.
 */
147
#define G_INITIALLY_UNOWNED(object)           (G_TYPE_CHECK_INSTANCE_CAST ((object), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnowned))
148 149 150 151 152 153 154
/**
 * G_INITIALLY_UNOWNED_CLASS:
 * @class: a valid #GInitiallyUnownedClass
 * 
 * Casts a derived #GInitiallyUnownedClass structure into a
 * #GInitiallyUnownedClass structure.
 */
155
#define G_INITIALLY_UNOWNED_CLASS(class)      (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnownedClass))
156 157 158 159 160 161
/**
 * G_IS_INITIALLY_UNOWNED:
 * @object: Instance to check for being a %G_TYPE_INITIALLY_UNOWNED.
 * 
 * Checks whether a valid #GTypeInstance pointer is of type %G_TYPE_INITIALLY_UNOWNED.
 */
162
#define G_IS_INITIALLY_UNOWNED(object)        (G_TYPE_CHECK_INSTANCE_TYPE ((object), G_TYPE_INITIALLY_UNOWNED))
163 164 165 166 167 168 169
/**
 * G_IS_INITIALLY_UNOWNED_CLASS:
 * @class: a #GInitiallyUnownedClass
 * 
 * Checks whether @class "is a" valid #GInitiallyUnownedClass structure of type
 * %G_TYPE_INITIALLY_UNOWNED or derived.
 */
170
#define G_IS_INITIALLY_UNOWNED_CLASS(class)   (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_INITIALLY_UNOWNED))
171 172 173 174 175 176 177 178
/**
 * G_INITIALLY_UNOWNED_GET_CLASS:
 * @object: a #GInitiallyUnowned instance.
 * 
 * Get the class structure associated to a #GInitiallyUnowned instance.
 *
 * Returns: pointer to object class structure.
 */
179 180
#define G_INITIALLY_UNOWNED_GET_CLASS(object) (G_TYPE_INSTANCE_GET_CLASS ((object), G_TYPE_INITIALLY_UNOWNED, GInitiallyUnownedClass))
/* GInitiallyUnowned ia a GObject with initially floating reference count */
181

182 183

/* --- typedefs & structures --- */
184 185
typedef struct _GObject                  GObject;
typedef struct _GObjectClass             GObjectClass;
186 187
typedef struct _GObject                  GInitiallyUnowned;
typedef struct _GObjectClass             GInitiallyUnownedClass;
188
typedef struct _GObjectConstructParam    GObjectConstructParam;
Stefan Kost's avatar
Stefan Kost committed
189 190 191 192 193 194 195 196 197 198
/**
 * GObjectGetPropertyFunc:
 * @object: a #GObject
 * @property_id: the numeric id under which the property was registered with
 *  g_object_class_install_property().
 * @value: a #GValue to return the property value in
 * @pspec: the #GParamSpec describing the property
 * 
 * The type of the @get_property function of #GObjectClass. 
 */
199 200 201
typedef void (*GObjectGetPropertyFunc)  (GObject      *object,
                                         guint         property_id,
                                         GValue       *value,
202
                                         GParamSpec   *pspec);
Stefan Kost's avatar
Stefan Kost committed
203 204 205 206 207 208 209 210 211 212
/**
 * GObjectSetPropertyFunc:
 * @object: a #GObject
 * @property_id: the numeric id under which the property was registered with
 *  g_object_class_install_property().
 * @value: the new value for the property
 * @pspec: the #GParamSpec describing the property
 * 
 * The type of the @set_property function of #GObjectClass. 
 */
213 214 215
typedef void (*GObjectSetPropertyFunc)  (GObject      *object,
                                         guint         property_id,
                                         const GValue *value,
216
                                         GParamSpec   *pspec);
Stefan Kost's avatar
Stefan Kost committed
217 218 219 220 221 222
/**
 * GObjectFinalizeFunc:
 * @object: the #GObject being finalized
 * 
 * The type of the @finalize function of #GObjectClass.
 */
223
typedef void (*GObjectFinalizeFunc)     (GObject      *object);
Stefan Kost's avatar
Stefan Kost committed
224 225 226 227 228 229 230 231 232 233
/**
 * GWeakNotify:
 * @data: data that was provided when the weak reference was established
 * @where_the_object_was: the object being finalized
 * 
 * A #GWeakNotify function can be added to an object as a callback that gets
 * triggered when the object is finalized. Since the object is already being
 * finalized when the #GWeakNotify is called, there's not much you could do 
 * with the object, apart from e.g. using its adress as hash-index or the like. 
 */
234 235
typedef void (*GWeakNotify)		(gpointer      data,
					 GObject      *where_the_object_was);
Stefan Kost's avatar
Stefan Kost committed
236 237 238 239 240 241
/**
 * GObject:
 * 
 * All the fields in the <structname>GObject</structname> structure are private 
 * to the #GObject implementation and should never be accessed directly.
 */
242
struct  _GObject
243
{
244
  GTypeInstance  g_type_instance;
245 246
  
  /*< private >*/
247 248
  volatile guint ref_count;
  GData         *qdata;
249
};
Stefan Kost's avatar
Stefan Kost committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
/**
 * GObjectClass:
 * @g_type_class: the parent class
 * @constructor: the @constructor function is called by g_object_new () to 
 *  complete the object initialization after all the construction properties are
 *  set. The first thing a @constructor implementation must do is chain up to the
 *  @constructor of the parent class. Overriding @constructor should be rarely 
 *  needed, e.g. to handle construct properties, or to implement singletons.
 * @set_property: the generic setter for all properties of this type. Should be
 *  overridden for every type with properties. Implementations of @set_property
 *  don't need to emit property change notification explicitly, this is handled
 *  by the type system.
 * @get_property: the generic getter for all properties of this type. Should be
 *  overridden for every type with properties.
 * @dispose: the @dispose function is supposed to drop all references to other 
 *  objects, but keep the instance otherwise intact, so that client method 
 *  invocations still work. It may be run multiple times (due to reference 
 *  loops). Before returning, @dispose should chain up to the @dispose method 
 *  of the parent class.
 * @finalize: instance finalization function, should finish the finalization of 
 *  the instance begun in @dispose and chain up to the @finalize method of the 
 *  parent class.
 * @dispatch_properties_changed: emits property change notification for a bunch
 *  of properties. Overriding @dispatch_properties_changed should be rarely 
 *  needed.
 * @notify: the class closure for the notify signal
 * @constructed: the @constructed function is called by g_object_new() as the
 *  final step of the object creation process.  At the point of the call, all
 *  construction properties have been set on the object.  The purpose of this
 *  call is to allow for object initialisation steps that can only be performed
 *  after construction properties have been set.  @constructed implementors
 *  should chain up to the @constructed call of their parent class to allow it
 *  to complete its initialisation.
 * 
 * The class structure for the <structname>GObject</structname> type.
 * 
 * <example>
 * <title>Implementing singletons using a constructor</title>
 * <programlisting>
 * static MySingleton *the_singleton = NULL;
 * 
 * static GObject*
 * my_singleton_constructor (GType                  type,
 *                           guint                  n_construct_params,
 *                           GObjectConstructParam *construct_params)
 * {
 *   GObject *object;
 *   
 *   if (!the_singleton)
 *     {
 *       object = G_OBJECT_CLASS (parent_class)->constructor (type,
 *                                                            n_construct_params,
 *                                                            construct_params);
 *       the_singleton = MY_SINGLETON (object);
 *     }
 *   else
 *     object = g_object_ref (G_OBJECT (the_singleton));
 * 
 *   return object;
 * }
 * </programlisting></example>
 */
312
struct  _GObjectClass
313 314 315
{
  GTypeClass   g_type_class;

316
  /*< private >*/
317
  GSList      *construct_properties;
318

Matthias Clasen's avatar
Matthias Clasen committed
319
  /*< public >*/
320
  /* seldomly overidden */
321 322
  GObject*   (*constructor)     (GType                  type,
                                 guint                  n_construct_properties,
323
                                 GObjectConstructParam *construct_properties);
324
  /* overridable methods */
Tim Janik's avatar
Tim Janik committed
325
  void       (*set_property)		(GObject        *object,
326
                                         guint           property_id,
327
                                         const GValue   *value,
328
                                         GParamSpec     *pspec);
Tim Janik's avatar
Tim Janik committed
329
  void       (*get_property)		(GObject        *object,
330
                                         guint           property_id,
331
                                         GValue         *value,
332
                                         GParamSpec     *pspec);
Tim Janik's avatar
Tim Janik committed
333 334
  void       (*dispose)			(GObject        *object);
  void       (*finalize)		(GObject        *object);
335
  /* seldomly overidden */
336 337 338 339 340
  void       (*dispatch_properties_changed) (GObject      *object,
					     guint	   n_pspecs,
					     GParamSpec  **pspecs);
  /* signals */
  void	     (*notify)			(GObject	*object,
341
					 GParamSpec	*pspec);
342 343 344 345

  /* called when done constructing */
  void	     (*constructed)		(GObject	*object);

Matthias Clasen's avatar
Matthias Clasen committed
346
  /*< private >*/
347 348
  gsize		flags;

349
  /* padding */
350
  gpointer	pdummy[6];
351
};
Stefan Kost's avatar
Stefan Kost committed
352 353 354 355 356 357 358 359 360
/**
 * GObjectConstructParam:
 * @pspec: the #GParamSpec of the construct parameter
 * @value: the value to set the parameter to
 * 
 * The <structname>GObjectConstructParam</structname> struct is an auxiliary 
 * structure used to hand #GParamSpec/#GValue pairs to the @constructor of
 * a #GObjectClass.
 */
361 362
struct _GObjectConstructParam
{
363 364
  GParamSpec *pspec;
  GValue     *value;
365
};
366

Stefan Kost's avatar
Stefan Kost committed
367 368 369 370 371 372 373 374 375 376 377 378 379
/**
 * GInitiallyUnowned:
 * 
 * All the fields in the <structname>GInitiallyUnowned</structname> structure 
 * are private to the #GInitiallyUnowned implementation and should never be 
 * accessed directly.
 */
/**
 * GInitiallyUnownedClass:
 * 
 * The class structure for the <structname>GInitiallyUnowned</structname> type.
 */

380 381

/* --- prototypes --- */
382
GType       g_initially_unowned_get_type      (void);
383 384 385 386 387
void        g_object_class_install_property   (GObjectClass   *oclass,
					       guint           property_id,
					       GParamSpec     *pspec);
GParamSpec* g_object_class_find_property      (GObjectClass   *oclass,
					       const gchar    *property_name);
388 389
GParamSpec**g_object_class_list_properties    (GObjectClass   *oclass,
					       guint	      *n_properties);
390 391 392 393 394 395 396 397 398 399 400
void        g_object_class_override_property  (GObjectClass   *oclass,
					       guint           property_id,
					       const gchar    *name);

void        g_object_interface_install_property (gpointer     g_iface,
						 GParamSpec  *pspec);
GParamSpec* g_object_interface_find_property    (gpointer     g_iface,
						 const gchar *property_name);
GParamSpec**g_object_interface_list_properties  (gpointer     g_iface,
						 guint       *n_properties_p);

401
GType       g_object_get_type                 (void) G_GNUC_CONST;
402 403
gpointer    g_object_new                      (GType           object_type,
					       const gchar    *first_property_name,
404
					       ...);
405 406 407
gpointer    g_object_newv		      (GType           object_type,
					       guint	       n_parameters,
					       GParameter     *parameters);
408
GObject*    g_object_new_valist               (GType           object_type,
409 410
					       const gchar    *first_property_name,
					       va_list         var_args);
411
void	    g_object_set                      (gpointer	       object,
412
					       const gchar    *first_property_name,
413
					       ...) G_GNUC_NULL_TERMINATED;
414
void        g_object_get                      (gpointer        object,
415
					       const gchar    *first_property_name,
416
					       ...) G_GNUC_NULL_TERMINATED;
417 418
gpointer    g_object_connect                  (gpointer	       object,
					       const gchar    *signal_spec,
419
					       ...) G_GNUC_NULL_TERMINATED;
420
void	    g_object_disconnect               (gpointer	       object,
421
					       const gchar    *signal_spec,
422
					       ...) G_GNUC_NULL_TERMINATED;
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
void        g_object_set_valist               (GObject        *object,
					       const gchar    *first_property_name,
					       va_list         var_args);
void        g_object_get_valist               (GObject        *object,
					       const gchar    *first_property_name,
					       va_list         var_args);
void        g_object_set_property             (GObject        *object,
					       const gchar    *property_name,
					       const GValue   *value);
void        g_object_get_property             (GObject        *object,
					       const gchar    *property_name,
					       GValue         *value);
void        g_object_freeze_notify            (GObject        *object);
void        g_object_notify                   (GObject        *object,
					       const gchar    *property_name);
void        g_object_thaw_notify              (GObject        *object);
439 440
gboolean    g_object_is_floating    	      (gpointer        object);
gpointer    g_object_ref_sink       	      (gpointer	       object);
441 442
gpointer    g_object_ref                      (gpointer        object);
void        g_object_unref                    (gpointer        object);
Tim Janik's avatar
Tim Janik committed
443 444 445 446 447 448
void	    g_object_weak_ref		      (GObject	      *object,
					       GWeakNotify     notify,
					       gpointer	       data);
void	    g_object_weak_unref		      (GObject	      *object,
					       GWeakNotify     notify,
					       gpointer	       data);
449 450 451 452
void        g_object_add_weak_pointer         (GObject        *object, 
                                               gpointer       *weak_pointer_location);
void        g_object_remove_weak_pointer      (GObject        *object, 
                                               gpointer       *weak_pointer_location);
453

Stefan Kost's avatar
Stefan Kost committed
454 455 456 457 458 459 460 461 462 463 464 465
/**
 * GToggleNotify:
 * @data: Callback data passed to g_object_add_toggle_ref()
 * @object: The object on which g_object_add_toggle_ref() was called.
 * @is_last_ref: %TRUE if the toggle reference is now the
 *  last reference to the object. %FALSE if the toggle
 *  reference was the last reference and there are now other
 *  references.
 * 
 * A callback function used for notification when the state
 * of a toggle reference changes. See g_object_add_toggle_ref().
 */
466 467 468 469 470 471 472 473 474 475 476
typedef void (*GToggleNotify) (gpointer      data,
			       GObject      *object,
			       gboolean      is_last_ref);

void g_object_add_toggle_ref    (GObject       *object,
				 GToggleNotify  notify,
				 gpointer       data);
void g_object_remove_toggle_ref (GObject       *object,
				 GToggleNotify  notify,
				 gpointer       data);

477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
gpointer    g_object_get_qdata                (GObject        *object,
					       GQuark          quark);
void        g_object_set_qdata                (GObject        *object,
					       GQuark          quark,
					       gpointer        data);
void        g_object_set_qdata_full           (GObject        *object,
					       GQuark          quark,
					       gpointer        data,
					       GDestroyNotify  destroy);
gpointer    g_object_steal_qdata              (GObject        *object,
					       GQuark          quark);
gpointer    g_object_get_data                 (GObject        *object,
					       const gchar    *key);
void        g_object_set_data                 (GObject        *object,
					       const gchar    *key,
					       gpointer        data);
void        g_object_set_data_full            (GObject        *object,
					       const gchar    *key,
					       gpointer        data,
					       GDestroyNotify  destroy);
gpointer    g_object_steal_data               (GObject        *object,
					       const gchar    *key);
void        g_object_watch_closure            (GObject        *object,
					       GClosure       *closure);
GClosure*   g_cclosure_new_object             (GCallback       callback_func,
502
					       GObject	      *object);
503
GClosure*   g_cclosure_new_object_swap        (GCallback       callback_func,
504
					       GObject	      *object);
505 506 507
GClosure*   g_closure_new_object              (guint           sizeof_closure,
					       GObject        *object);
void        g_value_set_object                (GValue         *value,
Owen Taylor's avatar
Owen Taylor committed
508
					       gpointer        v_object);
509
gpointer    g_value_get_object                (const GValue   *value);
510
gpointer    g_value_dup_object                (const GValue   *value);
Tim Janik's avatar
Tim Janik committed
511
gulong	    g_signal_connect_object           (gpointer	       instance,
512 513 514
					       const gchar    *detailed_signal,
					       GCallback       c_handler,
					       gpointer	       gobject,
515
					       GConnectFlags   connect_flags);
516

Tim Janik's avatar
Tim Janik committed
517
/*< protected >*/
518
void        g_object_force_floating           (GObject        *object);
Tim Janik's avatar
Tim Janik committed
519 520 521
void        g_object_run_dispose	      (GObject	      *object);


522 523 524
void        g_value_take_object               (GValue         *value,
					       gpointer        v_object);
#ifndef G_DISABLE_DEPRECATED
525 526
void        g_value_set_object_take_ownership (GValue         *value,
					       gpointer        v_object);
527 528 529
#endif

#if !defined(G_DISABLE_DEPRECATED) || defined(GTK_COMPILATION)
530 531
gsize	    g_object_compat_control	      (gsize	       what,
					       gpointer	       data);
532
#endif
533

534
/* --- implementation macros --- */
535
#define G_OBJECT_WARN_INVALID_PSPEC(object, pname, property_id, pspec) \
536 537 538
G_STMT_START { \
  GObject *_object = (GObject*) (object); \
  GParamSpec *_pspec = (GParamSpec*) (pspec); \
539
  guint _property_id = (property_id); \
540
  g_warning ("%s: invalid %s id %u for \"%s\" of type `%s' in `%s'", \
541
             G_STRLOC, \
542
             (pname), \
543 544 545 546
             _property_id, \
             _pspec->name, \
             g_type_name (G_PARAM_SPEC_TYPE (_pspec)), \
             G_OBJECT_TYPE_NAME (_object)); \
547
} G_STMT_END
Stefan Kost's avatar
Stefan Kost committed
548 549 550 551 552 553 554 555 556
/**
 * G_OBJECT_WARN_INVALID_PROPERTY_ID:
 * @object: the #GObject on which set_property() or get_property() was called
 * @property_id: the numeric id of the property
 * @pspec: the #GParamSpec of the property
 * 
 * This macro should be used to emit a standard warning about unexpected 
 * properties in set_property() and get_property() implementations.
 */
557
#define G_OBJECT_WARN_INVALID_PROPERTY_ID(object, property_id, pspec) \
Tim Janik's avatar
Tim Janik committed
558
    G_OBJECT_WARN_INVALID_PSPEC ((object), "property", (property_id), (pspec))
559

560
G_END_DECLS
561

562
#endif /* __G_OBJECT_H__ */