1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * MT safe with regards to reference counting.
30 #include "gvaluecollector.h"
32 #include "gparamspecs.h"
33 #include "gvaluetypes.h"
34 #include "gobject_trace.h"
36 #include "gobjectnotifyqueue.c"
40 * @short_description: The base object type
41 * @see_also: #GParamSpecObject, g_param_spec_object()
42 * @title: The Base Object Type
44 * GObject is the fundamental type providing the common attributes and
45 * methods for all object types in GTK+, Pango and other libraries
46 * based on GObject. The GObject class provides methods for object
47 * construction and destruction, property access methods, and signal
48 * support. Signals are described in detail in <xref
49 * linkend="gobject-Signals"/>.
51 * <para id="floating-ref">
52 * #GInitiallyUnowned is derived from #GObject. The only difference between
53 * the two is that the initial reference of a #GInitiallyUnowned is flagged
54 * as a <firstterm>floating</firstterm> reference.
55 * This means that it is not specifically claimed to be "owned" by
56 * any code portion. The main motivation for providing floating references is
57 * C convenience. In particular, it allows code to be written as:
59 * container = create_container();
60 * container_add_child (container, create_child());
62 * If <function>container_add_child()</function> will g_object_ref_sink() the
63 * passed in child, no reference of the newly created child is leaked.
64 * Without floating references, <function>container_add_child()</function>
65 * can only g_object_ref() the new child, so to implement this code without
66 * reference leaks, it would have to be written as:
69 * container = create_container();
70 * child = create_child();
71 * container_add_child (container, child);
72 * g_object_unref (child);
74 * The floating reference can be converted into
75 * an ordinary reference by calling g_object_ref_sink().
76 * For already sunken objects (objects that don't have a floating reference
77 * anymore), g_object_ref_sink() is equivalent to g_object_ref() and returns
79 * Since floating references are useful almost exclusively for C convenience,
80 * language bindings that provide automated reference and memory ownership
81 * maintenance (such as smart pointers or garbage collection) therefore don't
82 * need to expose floating references in their API.
85 * Some object implementations may need to save an objects floating state
86 * across certain code portions (an example is #GtkMenu), to achive this, the
87 * following sequence can be used:
90 * // save floating state
91 * gboolean was_floating = g_object_is_floating (object);
92 * g_object_ref_sink (object);
93 * // protected code portion
95 * // restore floating state
97 * g_object_force_floating (object);
98 * g_obejct_unref (object); // release previously acquired reference
104 #define PARAM_SPEC_PARAM_ID(pspec) ((pspec)->param_id)
105 #define PARAM_SPEC_SET_PARAM_ID(pspec, id) ((pspec)->param_id = (id))
107 #define OBJECT_HAS_TOGGLE_REF_FLAG 0x1
108 #define OBJECT_HAS_TOGGLE_REF(object) \
109 ((g_datalist_get_flags (&(object)->qdata) & OBJECT_HAS_TOGGLE_REF_FLAG) != 0)
110 #define OBJECT_FLOATING_FLAG 0x2
112 #define CLASS_HAS_PROPS_FLAG 0x1
113 #define CLASS_HAS_PROPS(class) \
114 ((class)->flags & CLASS_HAS_PROPS_FLAG)
115 #define CLASS_HAS_CUSTOM_CONSTRUCTOR(class) \
116 ((class)->constructor != g_object_constructor)
118 #define CLASS_HAS_DERIVED_CLASS_FLAG 0x2
119 #define CLASS_HAS_DERIVED_CLASS(class) \
120 ((class)->flags & CLASS_HAS_DERIVED_CLASS_FLAG)
122 /* --- signals --- */
129 /* --- properties --- */
135 /* --- prototypes --- */
136 static void g_object_base_class_init (GObjectClass *class);
137 static void g_object_base_class_finalize (GObjectClass *class);
138 static void g_object_do_class_init (GObjectClass *class);
139 static void g_object_init (GObject *object,
140 GObjectClass *class);
141 static GObject* g_object_constructor (GType type,
142 guint n_construct_properties,
143 GObjectConstructParam *construct_params);
144 static void g_object_real_dispose (GObject *object);
145 static void g_object_finalize (GObject *object);
146 static void g_object_do_set_property (GObject *object,
150 static void g_object_do_get_property (GObject *object,
154 static void g_value_object_init (GValue *value);
155 static void g_value_object_free_value (GValue *value);
156 static void g_value_object_copy_value (const GValue *src_value,
158 static void g_value_object_transform_value (const GValue *src_value,
160 static gpointer g_value_object_peek_pointer (const GValue *value);
161 static gchar* g_value_object_collect_value (GValue *value,
162 guint n_collect_values,
163 GTypeCValue *collect_values,
164 guint collect_flags);
165 static gchar* g_value_object_lcopy_value (const GValue *value,
166 guint n_collect_values,
167 GTypeCValue *collect_values,
168 guint collect_flags);
169 static void g_object_dispatch_properties_changed (GObject *object,
171 GParamSpec **pspecs);
172 static inline void object_get_property (GObject *object,
175 static inline void object_set_property (GObject *object,
178 GObjectNotifyQueue *nqueue);
179 static guint object_floating_flag_handler (GObject *object,
182 static void object_interface_check_properties (gpointer func_data,
186 /* --- variables --- */
187 static GQuark quark_closure_array = 0;
188 static GQuark quark_weak_refs = 0;
189 static GQuark quark_toggle_refs = 0;
190 static GParamSpecPool *pspec_pool = NULL;
191 static GObjectNotifyContext property_notify_context = { 0, };
192 static gulong gobject_signals[LAST_SIGNAL] = { 0, };
193 static guint (*floating_flag_handler) (GObject*, gint) = object_floating_flag_handler;
194 G_LOCK_DEFINE_STATIC (construction_mutex);
195 static GSList *construction_objects = NULL;
197 /* --- functions --- */
198 #ifdef G_ENABLE_DEBUG
199 #define IF_DEBUG(debug_type) if (_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type)
200 G_LOCK_DEFINE_STATIC (debug_objects);
201 static volatile GObject *g_trap_object_ref = NULL;
202 static guint debug_objects_count = 0;
203 static GHashTable *debug_objects_ht = NULL;
206 debug_objects_foreach (gpointer key,
210 GObject *object = value;
212 g_message ("[%p] stale %s\tref_count=%u",
214 G_OBJECT_TYPE_NAME (object),
219 debug_objects_atexit (void)
223 G_LOCK (debug_objects);
224 g_message ("stale GObjects: %u", debug_objects_count);
225 g_hash_table_foreach (debug_objects_ht, debug_objects_foreach, NULL);
226 G_UNLOCK (debug_objects);
229 #endif /* G_ENABLE_DEBUG */
232 g_object_type_init (void)
234 static gboolean initialized = FALSE;
235 static const GTypeFundamentalInfo finfo = {
236 G_TYPE_FLAG_CLASSED | G_TYPE_FLAG_INSTANTIATABLE | G_TYPE_FLAG_DERIVABLE | G_TYPE_FLAG_DEEP_DERIVABLE,
238 static GTypeInfo info = {
239 sizeof (GObjectClass),
240 (GBaseInitFunc) g_object_base_class_init,
241 (GBaseFinalizeFunc) g_object_base_class_finalize,
242 (GClassInitFunc) g_object_do_class_init,
243 NULL /* class_destroy */,
244 NULL /* class_data */,
247 (GInstanceInitFunc) g_object_init,
248 NULL, /* value_table */
250 static const GTypeValueTable value_table = {
251 g_value_object_init, /* value_init */
252 g_value_object_free_value, /* value_free */
253 g_value_object_copy_value, /* value_copy */
254 g_value_object_peek_pointer, /* value_peek_pointer */
255 "p", /* collect_format */
256 g_value_object_collect_value, /* collect_value */
257 "p", /* lcopy_format */
258 g_value_object_lcopy_value, /* lcopy_value */
262 g_return_if_fail (initialized == FALSE);
267 info.value_table = &value_table;
268 type = g_type_register_fundamental (G_TYPE_OBJECT, g_intern_static_string ("GObject"), &info, &finfo, 0);
269 g_assert (type == G_TYPE_OBJECT);
270 g_value_register_transform_func (G_TYPE_OBJECT, G_TYPE_OBJECT, g_value_object_transform_value);
272 #ifdef G_ENABLE_DEBUG
275 debug_objects_ht = g_hash_table_new (g_direct_hash, NULL);
276 g_atexit (debug_objects_atexit);
278 #endif /* G_ENABLE_DEBUG */
282 g_object_base_class_init (GObjectClass *class)
284 GObjectClass *pclass = g_type_class_peek_parent (class);
286 /* Don't inherit HAS_DERIVED_CLASS flag from parent class */
287 class->flags &= ~CLASS_HAS_DERIVED_CLASS_FLAG;
290 pclass->flags |= CLASS_HAS_DERIVED_CLASS_FLAG;
292 /* reset instance specific fields and methods that don't get inherited */
293 class->construct_properties = pclass ? g_slist_copy (pclass->construct_properties) : NULL;
294 class->get_property = NULL;
295 class->set_property = NULL;
299 g_object_base_class_finalize (GObjectClass *class)
303 _g_signals_destroy (G_OBJECT_CLASS_TYPE (class));
305 g_slist_free (class->construct_properties);
306 class->construct_properties = NULL;
307 list = g_param_spec_pool_list_owned (pspec_pool, G_OBJECT_CLASS_TYPE (class));
308 for (node = list; node; node = node->next)
310 GParamSpec *pspec = node->data;
312 g_param_spec_pool_remove (pspec_pool, pspec);
313 PARAM_SPEC_SET_PARAM_ID (pspec, 0);
314 g_param_spec_unref (pspec);
320 g_object_notify_dispatcher (GObject *object,
324 G_OBJECT_GET_CLASS (object)->dispatch_properties_changed (object, n_pspecs, pspecs);
328 g_object_do_class_init (GObjectClass *class)
330 /* read the comment about typedef struct CArray; on why not to change this quark */
331 quark_closure_array = g_quark_from_static_string ("GObject-closure-array");
333 quark_weak_refs = g_quark_from_static_string ("GObject-weak-references");
334 quark_toggle_refs = g_quark_from_static_string ("GObject-toggle-references");
335 pspec_pool = g_param_spec_pool_new (TRUE);
336 property_notify_context.quark_notify_queue = g_quark_from_static_string ("GObject-notify-queue");
337 property_notify_context.dispatcher = g_object_notify_dispatcher;
339 class->constructor = g_object_constructor;
340 class->set_property = g_object_do_set_property;
341 class->get_property = g_object_do_get_property;
342 class->dispose = g_object_real_dispose;
343 class->finalize = g_object_finalize;
344 class->dispatch_properties_changed = g_object_dispatch_properties_changed;
345 class->notify = NULL;
349 * @gobject: the object which received the signal.
350 * @pspec: the #GParamSpec of the property which changed.
352 * The notify signal is emitted on an object when one of its
353 * properties has been changed. Note that getting this signal
354 * doesn't guarantee that the value of the property has actually
355 * changed, it may also be emitted when the setter for the property
356 * is called to reinstate the previous value.
358 * This signal is typically used to obtain change notification for a
359 * single property, by specifying the property name as a detail in the
360 * g_signal_connect() call, like this:
362 * g_signal_connect (text_view->buffer, "notify::paste-target-list",
363 * G_CALLBACK (gtk_text_view_target_list_notify),
366 * It is important to note that you must use
367 * <link linkend="canonical-parameter-name">canonical</link> parameter names as
368 * detail strings for the notify signal.
370 gobject_signals[NOTIFY] =
371 g_signal_new (g_intern_static_string ("notify"),
372 G_TYPE_FROM_CLASS (class),
373 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS | G_SIGNAL_ACTION,
374 G_STRUCT_OFFSET (GObjectClass, notify),
376 g_cclosure_marshal_VOID__PARAM,
380 /* Install a check function that we'll use to verify that classes that
381 * implement an interface implement all properties for that interface
383 g_type_add_interface_check (NULL, object_interface_check_properties);
387 install_property_internal (GType g_type,
391 if (g_param_spec_pool_lookup (pspec_pool, pspec->name, g_type, FALSE))
393 g_warning ("When installing property: type `%s' already has a property named `%s'",
394 g_type_name (g_type),
399 g_param_spec_ref (pspec);
400 g_param_spec_sink (pspec);
401 PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
402 g_param_spec_pool_insert (pspec_pool, pspec, g_type);
406 * g_object_class_install_property:
407 * @oclass: a #GObjectClass
408 * @property_id: the id for the new property
409 * @pspec: the #GParamSpec for the new property
411 * Installs a new property. This is usually done in the class initializer.
413 * Note that it is possible to redefine a property in a derived class,
414 * by installing a property with the same name. This can be useful at times,
415 * e.g. to change the range of allowed values or the default value.
418 g_object_class_install_property (GObjectClass *class,
422 g_return_if_fail (G_IS_OBJECT_CLASS (class));
423 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
425 if (CLASS_HAS_DERIVED_CLASS (class))
426 g_error ("Attempt to add property %s::%s to class after it was derived",
427 G_OBJECT_CLASS_NAME (class), pspec->name);
429 class->flags |= CLASS_HAS_PROPS_FLAG;
431 if (pspec->flags & G_PARAM_WRITABLE)
432 g_return_if_fail (class->set_property != NULL);
433 if (pspec->flags & G_PARAM_READABLE)
434 g_return_if_fail (class->get_property != NULL);
435 g_return_if_fail (property_id > 0);
436 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
437 if (pspec->flags & G_PARAM_CONSTRUCT)
438 g_return_if_fail ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
439 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
440 g_return_if_fail (pspec->flags & G_PARAM_WRITABLE);
442 install_property_internal (G_OBJECT_CLASS_TYPE (class), property_id, pspec);
444 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
445 class->construct_properties = g_slist_prepend (class->construct_properties, pspec);
447 /* for property overrides of construct properties, we have to get rid
448 * of the overidden inherited construct property
450 pspec = g_param_spec_pool_lookup (pspec_pool, pspec->name, g_type_parent (G_OBJECT_CLASS_TYPE (class)), TRUE);
451 if (pspec && pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
452 class->construct_properties = g_slist_remove (class->construct_properties, pspec);
456 * g_object_class_install_properties:
457 * @oclass: a #GObjectClass
458 * @n_pspecs: the length of the #GParamSpec<!-- -->s array
459 * @pspecs: (array length=n_pspecs): the #GParamSpec<!-- -->s array
460 * defining the new properties
462 * Installs new properties from an array of #GParamSpec<!-- -->s. This is
463 * usually done in the class initializer.
465 * The property id of each property is the index of each #GParamSpec in
468 * The property id of 0 is treated specially by #GObject and it should not
469 * be used to store a #GParamSpec.
471 * This function should be used if you plan to use a static array of
472 * #GParamSpec<!-- -->s and g_object_notify_pspec(). For instance, this
473 * class initialization:
477 * PROP_0, PROP_FOO, PROP_BAR, N_PROPERTIES
480 * static GParamSpec *obj_properties[N_PROPERTIES] = { NULL, };
483 * my_object_class_init (MyObjectClass *klass)
485 * GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
487 * obj_properties[PROP_FOO] =
488 * g_param_spec_int ("foo", "Foo", "Foo",
491 * G_PARAM_READWRITE);
493 * obj_properties[PROP_BAR] =
494 * g_param_spec_string ("bar", "Bar", "Bar",
496 * G_PARAM_READWRITE);
498 * gobject_class->set_property = my_object_set_property;
499 * gobject_class->get_property = my_object_get_property;
500 * g_object_class_install_properties (gobject_class,
506 * allows calling g_object_notify_by_pspec() to notify of property changes:
510 * my_object_set_foo (MyObject *self, gint foo)
512 * if (self->foo != foo)
515 * g_object_notify_by_pspec (G_OBJECT (self), obj_properties[PROP_FOO]);
523 g_object_class_install_properties (GObjectClass *oclass,
530 g_return_if_fail (G_IS_OBJECT_CLASS (oclass));
531 g_return_if_fail (n_pspecs > 1);
532 g_return_if_fail (pspecs[0] == NULL);
534 if (CLASS_HAS_DERIVED_CLASS (oclass))
535 g_error ("Attempt to add properties to %s after it was derived",
536 G_OBJECT_CLASS_NAME (oclass));
538 oclass_type = G_OBJECT_CLASS_TYPE (oclass);
540 /* we skip the first element of the array as it would have a 0 prop_id */
541 for (i = 1; i < n_pspecs; i++)
543 GParamSpec *pspec = pspecs[i];
545 g_return_if_fail (pspec != NULL);
547 if (pspec->flags & G_PARAM_WRITABLE)
548 g_return_if_fail (oclass->set_property != NULL);
549 if (pspec->flags & G_PARAM_READABLE)
550 g_return_if_fail (oclass->get_property != NULL);
551 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
552 if (pspec->flags & G_PARAM_CONSTRUCT)
553 g_return_if_fail ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
554 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
555 g_return_if_fail (pspec->flags & G_PARAM_WRITABLE);
557 oclass->flags |= CLASS_HAS_PROPS_FLAG;
558 install_property_internal (oclass_type, i, pspec);
560 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
561 oclass->construct_properties = g_slist_prepend (oclass->construct_properties, pspec);
563 /* for property overrides of construct properties, we have to get rid
564 * of the overidden inherited construct property
566 pspec = g_param_spec_pool_lookup (pspec_pool, pspec->name, g_type_parent (G_OBJECT_CLASS_TYPE (oclass)), TRUE);
567 if (pspec && pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
568 oclass->construct_properties = g_slist_remove (oclass->construct_properties, pspec);
573 * g_object_interface_install_property:
574 * @g_iface: any interface vtable for the interface, or the default
575 * vtable for the interface.
576 * @pspec: the #GParamSpec for the new property
578 * Add a property to an interface; this is only useful for interfaces
579 * that are added to GObject-derived types. Adding a property to an
580 * interface forces all objects classes with that interface to have a
581 * compatible property. The compatible property could be a newly
582 * created #GParamSpec, but normally
583 * g_object_class_override_property() will be used so that the object
584 * class only needs to provide an implementation and inherits the
585 * property description, default value, bounds, and so forth from the
586 * interface property.
588 * This function is meant to be called from the interface's default
589 * vtable initialization function (the @class_init member of
590 * #GTypeInfo.) It must not be called after after @class_init has
591 * been called for any object types implementing this interface.
596 g_object_interface_install_property (gpointer g_iface,
599 GTypeInterface *iface_class = g_iface;
601 g_return_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type));
602 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
603 g_return_if_fail (!G_IS_PARAM_SPEC_OVERRIDE (pspec)); /* paranoid */
604 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
606 install_property_internal (iface_class->g_type, 0, pspec);
610 * g_object_class_find_property:
611 * @oclass: a #GObjectClass
612 * @property_name: the name of the property to look up
614 * Looks up the #GParamSpec for a property of a class.
616 * Returns: the #GParamSpec for the property, or %NULL if the class
617 * doesn't have a property of that name
620 g_object_class_find_property (GObjectClass *class,
621 const gchar *property_name)
624 GParamSpec *redirect;
626 g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
627 g_return_val_if_fail (property_name != NULL, NULL);
629 pspec = g_param_spec_pool_lookup (pspec_pool,
631 G_OBJECT_CLASS_TYPE (class),
635 redirect = g_param_spec_get_redirect_target (pspec);
646 * g_object_interface_find_property:
647 * @g_iface: any interface vtable for the interface, or the default
648 * vtable for the interface
649 * @property_name: name of a property to lookup.
651 * Find the #GParamSpec with the given name for an
652 * interface. Generally, the interface vtable passed in as @g_iface
653 * will be the default vtable from g_type_default_interface_ref(), or,
654 * if you know the interface has already been loaded,
655 * g_type_default_interface_peek().
659 * Returns: the #GParamSpec for the property of the interface with the
660 * name @property_name, or %NULL if no such property exists.
663 g_object_interface_find_property (gpointer g_iface,
664 const gchar *property_name)
666 GTypeInterface *iface_class = g_iface;
668 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type), NULL);
669 g_return_val_if_fail (property_name != NULL, NULL);
671 return g_param_spec_pool_lookup (pspec_pool,
678 * g_object_class_override_property:
679 * @oclass: a #GObjectClass
680 * @property_id: the new property ID
681 * @name: the name of a property registered in a parent class or
682 * in an interface of this class.
684 * Registers @property_id as referring to a property with the
685 * name @name in a parent class or in an interface implemented
686 * by @oclass. This allows this class to <firstterm>override</firstterm>
687 * a property implementation in a parent class or to provide
688 * the implementation of a property from an interface.
691 * Internally, overriding is implemented by creating a property of type
692 * #GParamSpecOverride; generally operations that query the properties of
693 * the object class, such as g_object_class_find_property() or
694 * g_object_class_list_properties() will return the overridden
695 * property. However, in one case, the @construct_properties argument of
696 * the @constructor virtual function, the #GParamSpecOverride is passed
697 * instead, so that the @param_id field of the #GParamSpec will be
698 * correct. For virtually all uses, this makes no difference. If you
699 * need to get the overridden property, you can call
700 * g_param_spec_get_redirect_target().
706 g_object_class_override_property (GObjectClass *oclass,
710 GParamSpec *overridden = NULL;
714 g_return_if_fail (G_IS_OBJECT_CLASS (oclass));
715 g_return_if_fail (property_id > 0);
716 g_return_if_fail (name != NULL);
718 /* Find the overridden property; first check parent types
720 parent_type = g_type_parent (G_OBJECT_CLASS_TYPE (oclass));
721 if (parent_type != G_TYPE_NONE)
722 overridden = g_param_spec_pool_lookup (pspec_pool,
731 /* Now check interfaces
733 ifaces = g_type_interfaces (G_OBJECT_CLASS_TYPE (oclass), &n_ifaces);
734 while (n_ifaces-- && !overridden)
736 overridden = g_param_spec_pool_lookup (pspec_pool,
747 g_warning ("%s: Can't find property to override for '%s::%s'",
748 G_STRFUNC, G_OBJECT_CLASS_NAME (oclass), name);
752 new = g_param_spec_override (name, overridden);
753 g_object_class_install_property (oclass, property_id, new);
757 * g_object_class_list_properties:
758 * @oclass: a #GObjectClass
759 * @n_properties: return location for the length of the returned array
761 * Get an array of #GParamSpec* for all properties of a class.
763 * Returns: (array length=n_properties) (transfer full): an array of
764 * #GParamSpec* which should be freed after use
766 GParamSpec** /* free result */
767 g_object_class_list_properties (GObjectClass *class,
768 guint *n_properties_p)
773 g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
775 pspecs = g_param_spec_pool_list (pspec_pool,
776 G_OBJECT_CLASS_TYPE (class),
785 * g_object_interface_list_properties:
786 * @g_iface: any interface vtable for the interface, or the default
787 * vtable for the interface
788 * @n_properties_p: location to store number of properties returned.
790 * Lists the properties of an interface.Generally, the interface
791 * vtable passed in as @g_iface will be the default vtable from
792 * g_type_default_interface_ref(), or, if you know the interface has
793 * already been loaded, g_type_default_interface_peek().
797 * Returns: a pointer to an array of pointers to #GParamSpec
798 * structures. The paramspecs are owned by GLib, but the
799 * array should be freed with g_free() when you are done with
803 g_object_interface_list_properties (gpointer g_iface,
804 guint *n_properties_p)
806 GTypeInterface *iface_class = g_iface;
810 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type), NULL);
812 pspecs = g_param_spec_pool_list (pspec_pool,
822 g_object_init (GObject *object,
825 object->ref_count = 1;
826 g_datalist_init (&object->qdata);
828 if (CLASS_HAS_PROPS (class))
830 /* freeze object's notification queue, g_object_newv() preserves pairedness */
831 g_object_notify_queue_freeze (object, &property_notify_context);
834 if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
836 /* enter construction list for notify_queue_thaw() and to allow construct-only properties */
837 G_LOCK (construction_mutex);
838 construction_objects = g_slist_prepend (construction_objects, object);
839 G_UNLOCK (construction_mutex);
842 #ifdef G_ENABLE_DEBUG
845 G_LOCK (debug_objects);
846 debug_objects_count++;
847 g_hash_table_insert (debug_objects_ht, object, object);
848 G_UNLOCK (debug_objects);
850 #endif /* G_ENABLE_DEBUG */
854 g_object_do_set_property (GObject *object,
862 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
868 g_object_do_get_property (GObject *object,
876 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
882 g_object_real_dispose (GObject *object)
884 g_signal_handlers_destroy (object);
885 g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
886 g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
890 g_object_finalize (GObject *object)
892 g_datalist_clear (&object->qdata);
894 #ifdef G_ENABLE_DEBUG
897 G_LOCK (debug_objects);
898 g_assert (g_hash_table_lookup (debug_objects_ht, object) == object);
899 g_hash_table_remove (debug_objects_ht, object);
900 debug_objects_count--;
901 G_UNLOCK (debug_objects);
903 #endif /* G_ENABLE_DEBUG */
908 g_object_dispatch_properties_changed (GObject *object,
914 for (i = 0; i < n_pspecs; i++)
915 g_signal_emit (object, gobject_signals[NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
919 * g_object_run_dispose:
920 * @object: a #GObject
922 * Releases all references to other objects. This can be used to break
925 * This functions should only be called from object system implementations.
928 g_object_run_dispose (GObject *object)
930 g_return_if_fail (G_IS_OBJECT (object));
931 g_return_if_fail (object->ref_count > 0);
933 g_object_ref (object);
934 TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 0));
935 G_OBJECT_GET_CLASS (object)->dispose (object);
936 TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 0));
937 g_object_unref (object);
941 * g_object_freeze_notify:
942 * @object: a #GObject
944 * Increases the freeze count on @object. If the freeze count is
945 * non-zero, the emission of "notify" signals on @object is
946 * stopped. The signals are queued until the freeze count is decreased
949 * This is necessary for accessors that modify multiple properties to prevent
950 * premature notification while the object is still being modified.
953 g_object_freeze_notify (GObject *object)
955 g_return_if_fail (G_IS_OBJECT (object));
957 if (g_atomic_int_get (&object->ref_count) == 0)
960 g_object_ref (object);
961 g_object_notify_queue_freeze (object, &property_notify_context);
962 g_object_unref (object);
966 g_object_notify_by_spec_internal (GObject *object,
969 GObjectNotifyQueue *nqueue;
971 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
972 g_object_notify_queue_add (object, nqueue, pspec);
973 g_object_notify_queue_thaw (object, nqueue);
978 * @object: a #GObject
979 * @property_name: the name of a property installed on the class of @object.
981 * Emits a "notify" signal for the property @property_name on @object.
983 * When possible, eg. when signaling a property change from within the class
984 * that registered the property, you should use g_object_notify_by_pspec()
988 g_object_notify (GObject *object,
989 const gchar *property_name)
993 g_return_if_fail (G_IS_OBJECT (object));
994 g_return_if_fail (property_name != NULL);
995 if (g_atomic_int_get (&object->ref_count) == 0)
998 g_object_ref (object);
999 /* We don't need to get the redirect target
1000 * (by, e.g. calling g_object_class_find_property())
1001 * because g_object_notify_queue_add() does that
1003 pspec = g_param_spec_pool_lookup (pspec_pool,
1005 G_OBJECT_TYPE (object),
1009 g_warning ("%s: object class `%s' has no property named `%s'",
1011 G_OBJECT_TYPE_NAME (object),
1014 g_object_notify_by_spec_internal (object, pspec);
1015 g_object_unref (object);
1019 * g_object_notify_by_pspec:
1020 * @object: a #GObject
1021 * @pspec: the #GParamSpec of a property installed on the class of @object.
1023 * Emits a "notify" signal for the property specified by @pspec on @object.
1025 * This function omits the property name lookup, hence it is faster than
1026 * g_object_notify().
1028 * One way to avoid using g_object_notify() from within the
1029 * class that registered the properties, and using g_object_notify_by_pspec()
1030 * instead, is to store the GParamSpec used with
1031 * g_object_class_install_property() inside a static array, e.g.:
1041 * static GParamSpec *properties[PROP_LAST];
1044 * my_object_class_init (MyObjectClass *klass)
1046 * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
1049 * G_PARAM_READWRITE);
1050 * g_object_class_install_property (gobject_class,
1052 * properties[PROP_FOO]);
1056 * and then notify a change on the "foo" property with:
1059 * g_object_notify_by_pspec (self, properties[PROP_FOO]);
1065 g_object_notify_by_pspec (GObject *object,
1069 g_return_if_fail (G_IS_OBJECT (object));
1070 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
1072 g_object_ref (object);
1073 g_object_notify_by_spec_internal (object, pspec);
1074 g_object_unref (object);
1078 * g_object_thaw_notify:
1079 * @object: a #GObject
1081 * Reverts the effect of a previous call to
1082 * g_object_freeze_notify(). The freeze count is decreased on @object
1083 * and when it reaches zero, all queued "notify" signals are emitted.
1085 * It is an error to call this function when the freeze count is zero.
1088 g_object_thaw_notify (GObject *object)
1090 GObjectNotifyQueue *nqueue;
1092 g_return_if_fail (G_IS_OBJECT (object));
1093 if (g_atomic_int_get (&object->ref_count) == 0)
1096 g_object_ref (object);
1098 /* FIXME: Freezing is the only way to get at the notify queue.
1099 * So we freeze once and then thaw twice.
1101 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1102 g_object_notify_queue_thaw (object, nqueue);
1103 g_object_notify_queue_thaw (object, nqueue);
1105 g_object_unref (object);
1109 object_get_property (GObject *object,
1113 GObjectClass *class = g_type_class_peek (pspec->owner_type);
1114 guint param_id = PARAM_SPEC_PARAM_ID (pspec);
1115 GParamSpec *redirect;
1117 redirect = g_param_spec_get_redirect_target (pspec);
1121 class->get_property (object, param_id, value, pspec);
1125 object_set_property (GObject *object,
1127 const GValue *value,
1128 GObjectNotifyQueue *nqueue)
1130 GValue tmp_value = { 0, };
1131 GObjectClass *class = g_type_class_peek (pspec->owner_type);
1132 guint param_id = PARAM_SPEC_PARAM_ID (pspec);
1133 GParamSpec *redirect;
1134 static gchar* enable_diagnostic = NULL;
1136 redirect = g_param_spec_get_redirect_target (pspec);
1140 if (G_UNLIKELY (!enable_diagnostic))
1142 enable_diagnostic = g_getenv ("G_ENABLE_DIAGNOSTIC");
1143 if (!enable_diagnostic)
1144 enable_diagnostic = "0";
1147 if (enable_diagnostic[0] == '1')
1149 if (pspec->flags & G_PARAM_DEPRECATED)
1150 g_warning ("The property %s::%s is deprecated and shouldn't be used "
1151 "anymore. It will be removed in a future version.",
1152 G_OBJECT_TYPE_NAME (object), pspec->name);
1155 /* provide a copy to work from, convert (if necessary) and validate */
1156 g_value_init (&tmp_value, pspec->value_type);
1157 if (!g_value_transform (value, &tmp_value))
1158 g_warning ("unable to set property `%s' of type `%s' from value of type `%s'",
1160 g_type_name (pspec->value_type),
1161 G_VALUE_TYPE_NAME (value));
1162 else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
1164 gchar *contents = g_strdup_value_contents (value);
1166 g_warning ("value \"%s\" of type `%s' is invalid or out of range for property `%s' of type `%s'",
1168 G_VALUE_TYPE_NAME (value),
1170 g_type_name (pspec->value_type));
1175 class->set_property (object, param_id, &tmp_value, pspec);
1176 g_object_notify_queue_add (object, nqueue, pspec);
1178 g_value_unset (&tmp_value);
1182 object_interface_check_properties (gpointer func_data,
1185 GTypeInterface *iface_class = g_iface;
1186 GObjectClass *class = g_type_class_peek (iface_class->g_instance_type);
1187 GType iface_type = iface_class->g_type;
1188 GParamSpec **pspecs;
1191 if (!G_IS_OBJECT_CLASS (class))
1194 pspecs = g_param_spec_pool_list (pspec_pool, iface_type, &n);
1198 GParamSpec *class_pspec = g_param_spec_pool_lookup (pspec_pool,
1200 G_OBJECT_CLASS_TYPE (class),
1205 g_critical ("Object class %s doesn't implement property "
1206 "'%s' from interface '%s'",
1207 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1209 g_type_name (iface_type));
1214 /* The implementation paramspec must have a less restrictive
1215 * type than the interface parameter spec for set() and a
1216 * more restrictive type for get(). We just require equality,
1217 * rather than doing something more complicated checking
1218 * the READABLE and WRITABLE flags. We also simplify here
1219 * by only checking the value type, not the G_PARAM_SPEC_TYPE.
1222 !g_type_is_a (pspecs[n]->value_type,
1223 class_pspec->value_type))
1225 g_critical ("Property '%s' on class '%s' has type '%s' "
1226 "which is different from the type '%s', "
1227 "of the property on interface '%s'\n",
1229 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1230 g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1231 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])),
1232 g_type_name (iface_type));
1235 #define SUBSET(a,b,mask) (((a) & ~(b) & (mask)) == 0)
1237 /* CONSTRUCT and CONSTRUCT_ONLY add restrictions.
1238 * READABLE and WRITABLE remove restrictions. The implementation
1239 * paramspec must have less restrictive flags.
1242 (!SUBSET (class_pspec->flags,
1244 G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY) ||
1245 !SUBSET (pspecs[n]->flags,
1247 G_PARAM_READABLE | G_PARAM_WRITABLE)))
1249 g_critical ("Flags for property '%s' on class '%s' "
1250 "are not compatible with the property on"
1253 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1254 g_type_name (iface_type));
1263 g_object_get_type (void)
1265 return G_TYPE_OBJECT;
1270 * @object_type: the type id of the #GObject subtype to instantiate
1271 * @first_property_name: the name of the first property
1272 * @...: the value of the first property, followed optionally by more
1273 * name/value pairs, followed by %NULL
1275 * Creates a new instance of a #GObject subtype and sets its properties.
1277 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1278 * which are not explicitly specified are set to their default values.
1280 * Returns: a new instance of @object_type
1283 g_object_new (GType object_type,
1284 const gchar *first_property_name,
1290 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1292 /* short circuit for calls supplying no properties */
1293 if (!first_property_name)
1294 return g_object_newv (object_type, 0, NULL);
1296 va_start (var_args, first_property_name);
1297 object = g_object_new_valist (object_type, first_property_name, var_args);
1304 slist_maybe_remove (GSList **slist,
1307 GSList *last = NULL, *node = *slist;
1310 if (node->data == data)
1313 last->next = node->next;
1315 *slist = node->next;
1316 g_slist_free_1 (node);
1325 static inline gboolean
1326 object_in_construction_list (GObject *object)
1328 gboolean in_construction;
1329 G_LOCK (construction_mutex);
1330 in_construction = g_slist_find (construction_objects, object) != NULL;
1331 G_UNLOCK (construction_mutex);
1332 return in_construction;
1337 * @object_type: the type id of the #GObject subtype to instantiate
1338 * @n_parameters: the length of the @parameters array
1339 * @parameters: an array of #GParameter
1341 * Creates a new instance of a #GObject subtype and sets its properties.
1343 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1344 * which are not explicitly specified are set to their default values.
1346 * Returns: a new instance of @object_type
1349 g_object_newv (GType object_type,
1351 GParameter *parameters)
1353 GObjectConstructParam *cparams = NULL, *oparams;
1354 GObjectNotifyQueue *nqueue = NULL; /* shouldn't be initialized, just to silence compiler */
1356 GObjectClass *class, *unref_class = NULL;
1358 guint n_total_cparams = 0, n_cparams = 0, n_oparams = 0, n_cvalues;
1360 GList *clist = NULL;
1361 gboolean newly_constructed;
1364 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1366 class = g_type_class_peek_static (object_type);
1368 class = unref_class = g_type_class_ref (object_type);
1369 for (slist = class->construct_properties; slist; slist = slist->next)
1371 clist = g_list_prepend (clist, slist->data);
1372 n_total_cparams += 1;
1375 if (n_parameters == 0 && n_total_cparams == 0)
1377 /* This is a simple object with no construct properties, and
1378 * no properties are being set, so short circuit the parameter
1379 * handling. This speeds up simple object construction.
1382 object = class->constructor (object_type, 0, NULL);
1383 goto did_construction;
1386 /* collect parameters, sort into construction and normal ones */
1387 oparams = g_new (GObjectConstructParam, n_parameters);
1388 cparams = g_new (GObjectConstructParam, n_total_cparams);
1389 for (i = 0; i < n_parameters; i++)
1391 GValue *value = ¶meters[i].value;
1392 GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1398 g_warning ("%s: object class `%s' has no property named `%s'",
1400 g_type_name (object_type),
1401 parameters[i].name);
1404 if (!(pspec->flags & G_PARAM_WRITABLE))
1406 g_warning ("%s: property `%s' of object class `%s' is not writable",
1409 g_type_name (object_type));
1412 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1414 GList *list = g_list_find (clist, pspec);
1418 g_warning ("%s: construct property \"%s\" for object `%s' can't be set twice",
1419 G_STRFUNC, pspec->name, g_type_name (object_type));
1422 cparams[n_cparams].pspec = pspec;
1423 cparams[n_cparams].value = value;
1428 list->prev->next = list->next;
1430 list->next->prev = list->prev;
1431 g_list_free_1 (list);
1435 oparams[n_oparams].pspec = pspec;
1436 oparams[n_oparams].value = value;
1441 /* set remaining construction properties to default values */
1442 n_cvalues = n_total_cparams - n_cparams;
1443 cvalues = g_new (GValue, n_cvalues);
1446 GList *tmp = clist->next;
1447 GParamSpec *pspec = clist->data;
1448 GValue *value = cvalues + n_total_cparams - n_cparams - 1;
1451 g_value_init (value, pspec->value_type);
1452 g_param_value_set_default (pspec, value);
1454 cparams[n_cparams].pspec = pspec;
1455 cparams[n_cparams].value = value;
1458 g_list_free_1 (clist);
1462 /* construct object from construction parameters */
1463 object = class->constructor (object_type, n_total_cparams, cparams);
1464 /* free construction values */
1467 g_value_unset (cvalues + n_cvalues);
1471 if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
1473 /* adjust freeze_count according to g_object_init() and remaining properties */
1474 G_LOCK (construction_mutex);
1475 newly_constructed = slist_maybe_remove (&construction_objects, object);
1476 G_UNLOCK (construction_mutex);
1479 newly_constructed = TRUE;
1481 if (CLASS_HAS_PROPS (class))
1483 if (newly_constructed || n_oparams)
1484 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1485 if (newly_constructed)
1486 g_object_notify_queue_thaw (object, nqueue);
1489 /* run 'constructed' handler if there is one */
1490 if (newly_constructed && class->constructed)
1491 class->constructed (object);
1493 /* set remaining properties */
1494 for (i = 0; i < n_oparams; i++)
1495 object_set_property (object, oparams[i].pspec, oparams[i].value, nqueue);
1498 if (CLASS_HAS_PROPS (class))
1500 /* release our own freeze count and handle notifications */
1501 if (newly_constructed || n_oparams)
1502 g_object_notify_queue_thaw (object, nqueue);
1506 g_type_class_unref (unref_class);
1512 * g_object_new_valist:
1513 * @object_type: the type id of the #GObject subtype to instantiate
1514 * @first_property_name: the name of the first property
1515 * @var_args: the value of the first property, followed optionally by more
1516 * name/value pairs, followed by %NULL
1518 * Creates a new instance of a #GObject subtype and sets its properties.
1520 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1521 * which are not explicitly specified are set to their default values.
1523 * Returns: a new instance of @object_type
1526 g_object_new_valist (GType object_type,
1527 const gchar *first_property_name,
1530 GObjectClass *class;
1534 guint n_params = 0, n_alloced_params = 16;
1536 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1538 if (!first_property_name)
1539 return g_object_newv (object_type, 0, NULL);
1541 class = g_type_class_ref (object_type);
1543 params = g_new0 (GParameter, n_alloced_params);
1544 name = first_property_name;
1547 gchar *error = NULL;
1548 GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1554 g_warning ("%s: object class `%s' has no property named `%s'",
1556 g_type_name (object_type),
1560 if (n_params >= n_alloced_params)
1562 n_alloced_params += 16;
1563 params = g_renew (GParameter, params, n_alloced_params);
1565 params[n_params].name = name;
1566 G_VALUE_COLLECT_INIT (¶ms[n_params].value, pspec->value_type,
1567 var_args, 0, &error);
1570 g_warning ("%s: %s", G_STRFUNC, error);
1572 g_value_unset (¶ms[n_params].value);
1576 name = va_arg (var_args, gchar*);
1579 object = g_object_newv (object_type, n_params, params);
1582 g_value_unset (¶ms[n_params].value);
1585 g_type_class_unref (class);
1591 g_object_constructor (GType type,
1592 guint n_construct_properties,
1593 GObjectConstructParam *construct_params)
1598 object = (GObject*) g_type_create_instance (type);
1600 /* set construction parameters */
1601 if (n_construct_properties)
1603 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1605 /* set construct properties */
1606 while (n_construct_properties--)
1608 GValue *value = construct_params->value;
1609 GParamSpec *pspec = construct_params->pspec;
1612 object_set_property (object, pspec, value, nqueue);
1614 g_object_notify_queue_thaw (object, nqueue);
1615 /* the notification queue is still frozen from g_object_init(), so
1616 * we don't need to handle it here, g_object_newv() takes
1625 * g_object_set_valist:
1626 * @object: a #GObject
1627 * @first_property_name: name of the first property to set
1628 * @var_args: value for the first property, followed optionally by more
1629 * name/value pairs, followed by %NULL
1631 * Sets properties on an object.
1634 g_object_set_valist (GObject *object,
1635 const gchar *first_property_name,
1638 GObjectNotifyQueue *nqueue;
1641 g_return_if_fail (G_IS_OBJECT (object));
1643 g_object_ref (object);
1644 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1646 name = first_property_name;
1649 GValue value = { 0, };
1651 gchar *error = NULL;
1653 pspec = g_param_spec_pool_lookup (pspec_pool,
1655 G_OBJECT_TYPE (object),
1659 g_warning ("%s: object class `%s' has no property named `%s'",
1661 G_OBJECT_TYPE_NAME (object),
1665 if (!(pspec->flags & G_PARAM_WRITABLE))
1667 g_warning ("%s: property `%s' of object class `%s' is not writable",
1670 G_OBJECT_TYPE_NAME (object));
1673 if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
1675 g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
1676 G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
1680 G_VALUE_COLLECT_INIT (&value, pspec->value_type, var_args,
1684 g_warning ("%s: %s", G_STRFUNC, error);
1686 g_value_unset (&value);
1690 object_set_property (object, pspec, &value, nqueue);
1691 g_value_unset (&value);
1693 name = va_arg (var_args, gchar*);
1696 g_object_notify_queue_thaw (object, nqueue);
1697 g_object_unref (object);
1701 * g_object_get_valist:
1702 * @object: a #GObject
1703 * @first_property_name: name of the first property to get
1704 * @var_args: return location for the first property, followed optionally by more
1705 * name/return location pairs, followed by %NULL
1707 * Gets properties of an object.
1709 * In general, a copy is made of the property contents and the caller
1710 * is responsible for freeing the memory in the appropriate manner for
1711 * the type, for instance by calling g_free() or g_object_unref().
1713 * See g_object_get().
1716 g_object_get_valist (GObject *object,
1717 const gchar *first_property_name,
1722 g_return_if_fail (G_IS_OBJECT (object));
1724 g_object_ref (object);
1726 name = first_property_name;
1730 GValue value = { 0, };
1734 pspec = g_param_spec_pool_lookup (pspec_pool,
1736 G_OBJECT_TYPE (object),
1740 g_warning ("%s: object class `%s' has no property named `%s'",
1742 G_OBJECT_TYPE_NAME (object),
1746 if (!(pspec->flags & G_PARAM_READABLE))
1748 g_warning ("%s: property `%s' of object class `%s' is not readable",
1751 G_OBJECT_TYPE_NAME (object));
1755 g_value_init (&value, pspec->value_type);
1757 object_get_property (object, pspec, &value);
1759 G_VALUE_LCOPY (&value, var_args, 0, &error);
1762 g_warning ("%s: %s", G_STRFUNC, error);
1764 g_value_unset (&value);
1768 g_value_unset (&value);
1770 name = va_arg (var_args, gchar*);
1773 g_object_unref (object);
1778 * @object: a #GObject
1779 * @first_property_name: name of the first property to set
1780 * @...: value for the first property, followed optionally by more
1781 * name/value pairs, followed by %NULL
1783 * Sets properties on an object.
1786 g_object_set (gpointer _object,
1787 const gchar *first_property_name,
1790 GObject *object = _object;
1793 g_return_if_fail (G_IS_OBJECT (object));
1795 va_start (var_args, first_property_name);
1796 g_object_set_valist (object, first_property_name, var_args);
1802 * @object: a #GObject
1803 * @first_property_name: name of the first property to get
1804 * @...: return location for the first property, followed optionally by more
1805 * name/return location pairs, followed by %NULL
1807 * Gets properties of an object.
1809 * In general, a copy is made of the property contents and the caller
1810 * is responsible for freeing the memory in the appropriate manner for
1811 * the type, for instance by calling g_free() or g_object_unref().
1814 * <title>Using g_object_get(<!-- -->)</title>
1815 * An example of using g_object_get() to get the contents
1816 * of three properties - one of type #G_TYPE_INT,
1817 * one of type #G_TYPE_STRING, and one of type #G_TYPE_OBJECT:
1823 * g_object_get (my_object,
1824 * "int-property", &intval,
1825 * "str-property", &strval,
1826 * "obj-property", &objval,
1829 * // Do something with intval, strval, objval
1832 * g_object_unref (objval);
1837 g_object_get (gpointer _object,
1838 const gchar *first_property_name,
1841 GObject *object = _object;
1844 g_return_if_fail (G_IS_OBJECT (object));
1846 va_start (var_args, first_property_name);
1847 g_object_get_valist (object, first_property_name, var_args);
1852 * g_object_set_property:
1853 * @object: a #GObject
1854 * @property_name: the name of the property to set
1857 * Sets a property on an object.
1860 g_object_set_property (GObject *object,
1861 const gchar *property_name,
1862 const GValue *value)
1864 GObjectNotifyQueue *nqueue;
1867 g_return_if_fail (G_IS_OBJECT (object));
1868 g_return_if_fail (property_name != NULL);
1869 g_return_if_fail (G_IS_VALUE (value));
1871 g_object_ref (object);
1872 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1874 pspec = g_param_spec_pool_lookup (pspec_pool,
1876 G_OBJECT_TYPE (object),
1879 g_warning ("%s: object class `%s' has no property named `%s'",
1881 G_OBJECT_TYPE_NAME (object),
1883 else if (!(pspec->flags & G_PARAM_WRITABLE))
1884 g_warning ("%s: property `%s' of object class `%s' is not writable",
1887 G_OBJECT_TYPE_NAME (object));
1888 else if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
1889 g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
1890 G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
1892 object_set_property (object, pspec, value, nqueue);
1894 g_object_notify_queue_thaw (object, nqueue);
1895 g_object_unref (object);
1899 * g_object_get_property:
1900 * @object: a #GObject
1901 * @property_name: the name of the property to get
1902 * @value: return location for the property value
1904 * Gets a property of an object.
1906 * In general, a copy is made of the property contents and the caller is
1907 * responsible for freeing the memory by calling g_value_unset().
1909 * Note that g_object_get_property() is really intended for language
1910 * bindings, g_object_get() is much more convenient for C programming.
1913 g_object_get_property (GObject *object,
1914 const gchar *property_name,
1919 g_return_if_fail (G_IS_OBJECT (object));
1920 g_return_if_fail (property_name != NULL);
1921 g_return_if_fail (G_IS_VALUE (value));
1923 g_object_ref (object);
1925 pspec = g_param_spec_pool_lookup (pspec_pool,
1927 G_OBJECT_TYPE (object),
1930 g_warning ("%s: object class `%s' has no property named `%s'",
1932 G_OBJECT_TYPE_NAME (object),
1934 else if (!(pspec->flags & G_PARAM_READABLE))
1935 g_warning ("%s: property `%s' of object class `%s' is not readable",
1938 G_OBJECT_TYPE_NAME (object));
1941 GValue *prop_value, tmp_value = { 0, };
1943 /* auto-conversion of the callers value type
1945 if (G_VALUE_TYPE (value) == pspec->value_type)
1947 g_value_reset (value);
1950 else if (!g_value_type_transformable (pspec->value_type, G_VALUE_TYPE (value)))
1952 g_warning ("%s: can't retrieve property `%s' of type `%s' as value of type `%s'",
1953 G_STRFUNC, pspec->name,
1954 g_type_name (pspec->value_type),
1955 G_VALUE_TYPE_NAME (value));
1956 g_object_unref (object);
1961 g_value_init (&tmp_value, pspec->value_type);
1962 prop_value = &tmp_value;
1964 object_get_property (object, pspec, prop_value);
1965 if (prop_value != value)
1967 g_value_transform (prop_value, value);
1968 g_value_unset (&tmp_value);
1972 g_object_unref (object);
1977 * @object: a #GObject
1978 * @signal_spec: the spec for the first signal
1979 * @...: #GCallback for the first signal, followed by data for the
1980 * first signal, followed optionally by more signal
1981 * spec/callback/data triples, followed by %NULL
1983 * A convenience function to connect multiple signals at once.
1985 * The signal specs expected by this function have the form
1986 * "modifier::signal_name", where modifier can be one of the following:
1989 * <term>signal</term>
1991 * equivalent to <literal>g_signal_connect_data (..., NULL, 0)</literal>
1992 * </para></listitem>
1995 * <term>object_signal</term>
1996 * <term>object-signal</term>
1998 * equivalent to <literal>g_signal_connect_object (..., 0)</literal>
1999 * </para></listitem>
2002 * <term>swapped_signal</term>
2003 * <term>swapped-signal</term>
2005 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)</literal>
2006 * </para></listitem>
2009 * <term>swapped_object_signal</term>
2010 * <term>swapped-object-signal</term>
2012 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED)</literal>
2013 * </para></listitem>
2016 * <term>signal_after</term>
2017 * <term>signal-after</term>
2019 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_AFTER)</literal>
2020 * </para></listitem>
2023 * <term>object_signal_after</term>
2024 * <term>object-signal-after</term>
2026 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_AFTER)</literal>
2027 * </para></listitem>
2030 * <term>swapped_signal_after</term>
2031 * <term>swapped-signal-after</term>
2033 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2034 * </para></listitem>
2037 * <term>swapped_object_signal_after</term>
2038 * <term>swapped-object-signal-after</term>
2040 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2041 * </para></listitem>
2046 * menu->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
2047 * "type", GTK_WINDOW_POPUP,
2050 * "signal::event", gtk_menu_window_event, menu,
2051 * "signal::size_request", gtk_menu_window_size_request, menu,
2052 * "signal::destroy", gtk_widget_destroyed, &menu->toplevel,
2059 g_object_connect (gpointer _object,
2060 const gchar *signal_spec,
2063 GObject *object = _object;
2066 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2067 g_return_val_if_fail (object->ref_count > 0, object);
2069 va_start (var_args, signal_spec);
2072 GCallback callback = va_arg (var_args, GCallback);
2073 gpointer data = va_arg (var_args, gpointer);
2076 if (strncmp (signal_spec, "signal::", 8) == 0)
2077 sid = g_signal_connect_data (object, signal_spec + 8,
2078 callback, data, NULL,
2080 else if (strncmp (signal_spec, "object_signal::", 15) == 0 ||
2081 strncmp (signal_spec, "object-signal::", 15) == 0)
2082 sid = g_signal_connect_object (object, signal_spec + 15,
2085 else if (strncmp (signal_spec, "swapped_signal::", 16) == 0 ||
2086 strncmp (signal_spec, "swapped-signal::", 16) == 0)
2087 sid = g_signal_connect_data (object, signal_spec + 16,
2088 callback, data, NULL,
2090 else if (strncmp (signal_spec, "swapped_object_signal::", 23) == 0 ||
2091 strncmp (signal_spec, "swapped-object-signal::", 23) == 0)
2092 sid = g_signal_connect_object (object, signal_spec + 23,
2095 else if (strncmp (signal_spec, "signal_after::", 14) == 0 ||
2096 strncmp (signal_spec, "signal-after::", 14) == 0)
2097 sid = g_signal_connect_data (object, signal_spec + 14,
2098 callback, data, NULL,
2100 else if (strncmp (signal_spec, "object_signal_after::", 21) == 0 ||
2101 strncmp (signal_spec, "object-signal-after::", 21) == 0)
2102 sid = g_signal_connect_object (object, signal_spec + 21,
2105 else if (strncmp (signal_spec, "swapped_signal_after::", 22) == 0 ||
2106 strncmp (signal_spec, "swapped-signal-after::", 22) == 0)
2107 sid = g_signal_connect_data (object, signal_spec + 22,
2108 callback, data, NULL,
2109 G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2110 else if (strncmp (signal_spec, "swapped_object_signal_after::", 29) == 0 ||
2111 strncmp (signal_spec, "swapped-object-signal-after::", 29) == 0)
2112 sid = g_signal_connect_object (object, signal_spec + 29,
2114 G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2117 g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2120 signal_spec = va_arg (var_args, gchar*);
2128 * g_object_disconnect:
2129 * @object: a #GObject
2130 * @signal_spec: the spec for the first signal
2131 * @...: #GCallback for the first signal, followed by data for the first signal,
2132 * followed optionally by more signal spec/callback/data triples,
2135 * A convenience function to disconnect multiple signals at once.
2137 * The signal specs expected by this function have the form
2138 * "any_signal", which means to disconnect any signal with matching
2139 * callback and data, or "any_signal::signal_name", which only
2140 * disconnects the signal named "signal_name".
2143 g_object_disconnect (gpointer _object,
2144 const gchar *signal_spec,
2147 GObject *object = _object;
2150 g_return_if_fail (G_IS_OBJECT (object));
2151 g_return_if_fail (object->ref_count > 0);
2153 va_start (var_args, signal_spec);
2156 GCallback callback = va_arg (var_args, GCallback);
2157 gpointer data = va_arg (var_args, gpointer);
2158 guint sid = 0, detail = 0, mask = 0;
2160 if (strncmp (signal_spec, "any_signal::", 12) == 0 ||
2161 strncmp (signal_spec, "any-signal::", 12) == 0)
2164 mask = G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2166 else if (strcmp (signal_spec, "any_signal") == 0 ||
2167 strcmp (signal_spec, "any-signal") == 0)
2170 mask = G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2174 g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2178 if ((mask & G_SIGNAL_MATCH_ID) &&
2179 !g_signal_parse_name (signal_spec, G_OBJECT_TYPE (object), &sid, &detail, FALSE))
2180 g_warning ("%s: invalid signal name \"%s\"", G_STRFUNC, signal_spec);
2181 else if (!g_signal_handlers_disconnect_matched (object, mask | (detail ? G_SIGNAL_MATCH_DETAIL : 0),
2183 NULL, (gpointer)callback, data))
2184 g_warning ("%s: signal handler %p(%p) is not connected", G_STRFUNC, callback, data);
2185 signal_spec = va_arg (var_args, gchar*);
2196 } weak_refs[1]; /* flexible array */
2200 weak_refs_notify (gpointer data)
2202 WeakRefStack *wstack = data;
2205 for (i = 0; i < wstack->n_weak_refs; i++)
2206 wstack->weak_refs[i].notify (wstack->weak_refs[i].data, wstack->object);
2211 * g_object_weak_ref:
2212 * @object: #GObject to reference weakly
2213 * @notify: callback to invoke before the object is freed
2214 * @data: extra data to pass to notify
2216 * Adds a weak reference callback to an object. Weak references are
2217 * used for notification when an object is finalized. They are called
2218 * "weak references" because they allow you to safely hold a pointer
2219 * to an object without calling g_object_ref() (g_object_ref() adds a
2220 * strong reference, that is, forces the object to stay alive).
2223 g_object_weak_ref (GObject *object,
2227 WeakRefStack *wstack;
2230 g_return_if_fail (G_IS_OBJECT (object));
2231 g_return_if_fail (notify != NULL);
2232 g_return_if_fail (object->ref_count >= 1);
2234 wstack = g_datalist_id_remove_no_notify (&object->qdata, quark_weak_refs);
2237 i = wstack->n_weak_refs++;
2238 wstack = g_realloc (wstack, sizeof (*wstack) + sizeof (wstack->weak_refs[0]) * i);
2242 wstack = g_renew (WeakRefStack, NULL, 1);
2243 wstack->object = object;
2244 wstack->n_weak_refs = 1;
2247 wstack->weak_refs[i].notify = notify;
2248 wstack->weak_refs[i].data = data;
2249 g_datalist_id_set_data_full (&object->qdata, quark_weak_refs, wstack, weak_refs_notify);
2253 * g_object_weak_unref:
2254 * @object: #GObject to remove a weak reference from
2255 * @notify: callback to search for
2256 * @data: data to search for
2258 * Removes a weak reference callback to an object.
2261 g_object_weak_unref (GObject *object,
2265 WeakRefStack *wstack;
2266 gboolean found_one = FALSE;
2268 g_return_if_fail (G_IS_OBJECT (object));
2269 g_return_if_fail (notify != NULL);
2271 wstack = g_datalist_id_get_data (&object->qdata, quark_weak_refs);
2276 for (i = 0; i < wstack->n_weak_refs; i++)
2277 if (wstack->weak_refs[i].notify == notify &&
2278 wstack->weak_refs[i].data == data)
2281 wstack->n_weak_refs -= 1;
2282 if (i != wstack->n_weak_refs)
2283 wstack->weak_refs[i] = wstack->weak_refs[wstack->n_weak_refs];
2289 g_warning ("%s: couldn't find weak ref %p(%p)", G_STRFUNC, notify, data);
2293 * g_object_add_weak_pointer:
2294 * @object: The object that should be weak referenced.
2295 * @weak_pointer_location: (inout): The memory address of a pointer.
2297 * Adds a weak reference from weak_pointer to @object to indicate that
2298 * the pointer located at @weak_pointer_location is only valid during
2299 * the lifetime of @object. When the @object is finalized,
2300 * @weak_pointer will be set to %NULL.
2303 g_object_add_weak_pointer (GObject *object,
2304 gpointer *weak_pointer_location)
2306 g_return_if_fail (G_IS_OBJECT (object));
2307 g_return_if_fail (weak_pointer_location != NULL);
2309 g_object_weak_ref (object,
2310 (GWeakNotify) g_nullify_pointer,
2311 weak_pointer_location);
2315 * g_object_remove_weak_pointer:
2316 * @object: The object that is weak referenced.
2317 * @weak_pointer_location: (inout): The memory address of a pointer.
2319 * Removes a weak reference from @object that was previously added
2320 * using g_object_add_weak_pointer(). The @weak_pointer_location has
2321 * to match the one used with g_object_add_weak_pointer().
2324 g_object_remove_weak_pointer (GObject *object,
2325 gpointer *weak_pointer_location)
2327 g_return_if_fail (G_IS_OBJECT (object));
2328 g_return_if_fail (weak_pointer_location != NULL);
2330 g_object_weak_unref (object,
2331 (GWeakNotify) g_nullify_pointer,
2332 weak_pointer_location);
2336 object_floating_flag_handler (GObject *object,
2342 case +1: /* force floating if possible */
2344 oldvalue = g_atomic_pointer_get (&object->qdata);
2345 while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2346 (gpointer) ((gsize) oldvalue | OBJECT_FLOATING_FLAG)));
2347 return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2348 case -1: /* sink if possible */
2350 oldvalue = g_atomic_pointer_get (&object->qdata);
2351 while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2352 (gpointer) ((gsize) oldvalue & ~(gsize) OBJECT_FLOATING_FLAG)));
2353 return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2354 default: /* check floating */
2355 return 0 != ((gsize) g_atomic_pointer_get (&object->qdata) & OBJECT_FLOATING_FLAG);
2360 * g_object_is_floating:
2361 * @object: a #GObject
2363 * Checks wether @object has a <link linkend="floating-ref">floating</link>
2368 * Returns: %TRUE if @object has a floating reference
2371 g_object_is_floating (gpointer _object)
2373 GObject *object = _object;
2374 g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
2375 return floating_flag_handler (object, 0);
2379 * g_object_ref_sink:
2380 * @object: a #GObject
2382 * Increase the reference count of @object, and possibly remove the
2383 * <link linkend="floating-ref">floating</link> reference, if @object
2384 * has a floating reference.
2386 * In other words, if the object is floating, then this call "assumes
2387 * ownership" of the floating reference, converting it to a normal
2388 * reference by clearing the floating flag while leaving the reference
2389 * count unchanged. If the object is not floating, then this call
2390 * adds a new normal reference increasing the reference count by one.
2397 g_object_ref_sink (gpointer _object)
2399 GObject *object = _object;
2400 gboolean was_floating;
2401 g_return_val_if_fail (G_IS_OBJECT (object), object);
2402 g_return_val_if_fail (object->ref_count >= 1, object);
2403 g_object_ref (object);
2404 was_floating = floating_flag_handler (object, -1);
2406 g_object_unref (object);
2411 * g_object_force_floating:
2412 * @object: a #GObject
2414 * This function is intended for #GObject implementations to re-enforce a
2415 * <link linkend="floating-ref">floating</link> object reference.
2416 * Doing this is seldomly required, all
2417 * #GInitiallyUnowned<!-- -->s are created with a floating reference which
2418 * usually just needs to be sunken by calling g_object_ref_sink().
2423 g_object_force_floating (GObject *object)
2425 gboolean was_floating;
2426 g_return_if_fail (G_IS_OBJECT (object));
2427 g_return_if_fail (object->ref_count >= 1);
2429 was_floating = floating_flag_handler (object, +1);
2434 guint n_toggle_refs;
2436 GToggleNotify notify;
2438 } toggle_refs[1]; /* flexible array */
2442 toggle_refs_notify (GObject *object,
2443 gboolean is_last_ref)
2445 ToggleRefStack *tstack = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2447 /* Reentrancy here is not as tricky as it seems, because a toggle reference
2448 * will only be notified when there is exactly one of them.
2450 g_assert (tstack->n_toggle_refs == 1);
2451 tstack->toggle_refs[0].notify (tstack->toggle_refs[0].data, tstack->object, is_last_ref);
2455 * g_object_add_toggle_ref:
2456 * @object: a #GObject
2457 * @notify: a function to call when this reference is the
2458 * last reference to the object, or is no longer
2459 * the last reference.
2460 * @data: data to pass to @notify
2462 * Increases the reference count of the object by one and sets a
2463 * callback to be called when all other references to the object are
2464 * dropped, or when this is already the last reference to the object
2465 * and another reference is established.
2467 * This functionality is intended for binding @object to a proxy
2468 * object managed by another memory manager. This is done with two
2469 * paired references: the strong reference added by
2470 * g_object_add_toggle_ref() and a reverse reference to the proxy
2471 * object which is either a strong reference or weak reference.
2473 * The setup is that when there are no other references to @object,
2474 * only a weak reference is held in the reverse direction from @object
2475 * to the proxy object, but when there are other references held to
2476 * @object, a strong reference is held. The @notify callback is called
2477 * when the reference from @object to the proxy object should be
2478 * <firstterm>toggled</firstterm> from strong to weak (@is_last_ref
2479 * true) or weak to strong (@is_last_ref false).
2481 * Since a (normal) reference must be held to the object before
2482 * calling g_object_toggle_ref(), the initial state of the reverse
2483 * link is always strong.
2485 * Multiple toggle references may be added to the same gobject,
2486 * however if there are multiple toggle references to an object, none
2487 * of them will ever be notified until all but one are removed. For
2488 * this reason, you should only ever use a toggle reference if there
2489 * is important state in the proxy object.
2494 g_object_add_toggle_ref (GObject *object,
2495 GToggleNotify notify,
2498 ToggleRefStack *tstack;
2501 g_return_if_fail (G_IS_OBJECT (object));
2502 g_return_if_fail (notify != NULL);
2503 g_return_if_fail (object->ref_count >= 1);
2505 g_object_ref (object);
2507 tstack = g_datalist_id_remove_no_notify (&object->qdata, quark_toggle_refs);
2510 i = tstack->n_toggle_refs++;
2511 /* allocate i = tstate->n_toggle_refs - 1 positions beyond the 1 declared
2512 * in tstate->toggle_refs */
2513 tstack = g_realloc (tstack, sizeof (*tstack) + sizeof (tstack->toggle_refs[0]) * i);
2517 tstack = g_renew (ToggleRefStack, NULL, 1);
2518 tstack->object = object;
2519 tstack->n_toggle_refs = 1;
2523 /* Set a flag for fast lookup after adding the first toggle reference */
2524 if (tstack->n_toggle_refs == 1)
2525 g_datalist_set_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2527 tstack->toggle_refs[i].notify = notify;
2528 tstack->toggle_refs[i].data = data;
2529 g_datalist_id_set_data_full (&object->qdata, quark_toggle_refs, tstack,
2530 (GDestroyNotify)g_free);
2534 * g_object_remove_toggle_ref:
2535 * @object: a #GObject
2536 * @notify: a function to call when this reference is the
2537 * last reference to the object, or is no longer
2538 * the last reference.
2539 * @data: data to pass to @notify
2541 * Removes a reference added with g_object_add_toggle_ref(). The
2542 * reference count of the object is decreased by one.
2547 g_object_remove_toggle_ref (GObject *object,
2548 GToggleNotify notify,
2551 ToggleRefStack *tstack;
2552 gboolean found_one = FALSE;
2554 g_return_if_fail (G_IS_OBJECT (object));
2555 g_return_if_fail (notify != NULL);
2557 tstack = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2562 for (i = 0; i < tstack->n_toggle_refs; i++)
2563 if (tstack->toggle_refs[i].notify == notify &&
2564 tstack->toggle_refs[i].data == data)
2567 tstack->n_toggle_refs -= 1;
2568 if (i != tstack->n_toggle_refs)
2569 tstack->toggle_refs[i] = tstack->toggle_refs[tstack->n_toggle_refs];
2571 if (tstack->n_toggle_refs == 0)
2572 g_datalist_unset_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2574 g_object_unref (object);
2581 g_warning ("%s: couldn't find toggle ref %p(%p)", G_STRFUNC, notify, data);
2586 * @object: a #GObject
2588 * Increases the reference count of @object.
2590 * Returns: the same @object
2593 g_object_ref (gpointer _object)
2595 GObject *object = _object;
2598 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2599 g_return_val_if_fail (object->ref_count > 0, NULL);
2601 #ifdef G_ENABLE_DEBUG
2602 if (g_trap_object_ref == object)
2604 #endif /* G_ENABLE_DEBUG */
2607 old_val = g_atomic_int_exchange_and_add ((int *)&object->ref_count, 1);
2609 if (old_val == 1 && OBJECT_HAS_TOGGLE_REF (object))
2610 toggle_refs_notify (object, FALSE);
2612 TRACE (GOBJECT_OBJECT_REF(object,G_TYPE_FROM_INSTANCE(object),old_val));
2619 * @object: a #GObject
2621 * Decreases the reference count of @object. When its reference count
2622 * drops to 0, the object is finalized (i.e. its memory is freed).
2625 g_object_unref (gpointer _object)
2627 GObject *object = _object;
2630 g_return_if_fail (G_IS_OBJECT (object));
2631 g_return_if_fail (object->ref_count > 0);
2633 #ifdef G_ENABLE_DEBUG
2634 if (g_trap_object_ref == object)
2636 #endif /* G_ENABLE_DEBUG */
2638 /* here we want to atomically do: if (ref_count>1) { ref_count--; return; } */
2639 retry_atomic_decrement1:
2640 old_ref = g_atomic_int_get (&object->ref_count);
2643 /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2644 gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2646 if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2647 goto retry_atomic_decrement1;
2649 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2651 /* if we went from 2->1 we need to notify toggle refs if any */
2652 if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2653 toggle_refs_notify (object, TRUE);
2657 /* we are about tp remove the last reference */
2658 TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 1));
2659 G_OBJECT_GET_CLASS (object)->dispose (object);
2660 TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 1));
2662 /* may have been re-referenced meanwhile */
2663 retry_atomic_decrement2:
2664 old_ref = g_atomic_int_get ((int *)&object->ref_count);
2667 /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2668 gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2670 if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2671 goto retry_atomic_decrement2;
2673 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2675 /* if we went from 2->1 we need to notify toggle refs if any */
2676 if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2677 toggle_refs_notify (object, TRUE);
2682 /* we are still in the process of taking away the last ref */
2683 g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
2684 g_signal_handlers_destroy (object);
2685 g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
2687 /* decrement the last reference */
2688 old_ref = g_atomic_int_exchange_and_add ((int *)&object->ref_count, -1);
2690 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2692 /* may have been re-referenced meanwhile */
2693 if (G_LIKELY (old_ref == 1))
2695 TRACE (GOBJECT_OBJECT_FINALIZE(object,G_TYPE_FROM_INSTANCE(object)));
2696 G_OBJECT_GET_CLASS (object)->finalize (object);
2698 TRACE (GOBJECT_OBJECT_FINALIZE_END(object,G_TYPE_FROM_INSTANCE(object)));
2700 #ifdef G_ENABLE_DEBUG
2703 /* catch objects not chaining finalize handlers */
2704 G_LOCK (debug_objects);
2705 g_assert (g_hash_table_lookup (debug_objects_ht, object) == NULL);
2706 G_UNLOCK (debug_objects);
2708 #endif /* G_ENABLE_DEBUG */
2709 g_type_free_instance ((GTypeInstance*) object);
2715 * g_object_get_qdata:
2716 * @object: The GObject to get a stored user data pointer from
2717 * @quark: A #GQuark, naming the user data pointer
2719 * This function gets back user data pointers stored via
2720 * g_object_set_qdata().
2722 * Returns: The user data pointer set, or %NULL
2725 g_object_get_qdata (GObject *object,
2728 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2730 return quark ? g_datalist_id_get_data (&object->qdata, quark) : NULL;
2734 * g_object_set_qdata:
2735 * @object: The GObject to set store a user data pointer
2736 * @quark: A #GQuark, naming the user data pointer
2737 * @data: An opaque user data pointer
2739 * This sets an opaque, named pointer on an object.
2740 * The name is specified through a #GQuark (retrived e.g. via
2741 * g_quark_from_static_string()), and the pointer
2742 * can be gotten back from the @object with g_object_get_qdata()
2743 * until the @object is finalized.
2744 * Setting a previously set user data pointer, overrides (frees)
2745 * the old pointer set, using #NULL as pointer essentially
2746 * removes the data stored.
2749 g_object_set_qdata (GObject *object,
2753 g_return_if_fail (G_IS_OBJECT (object));
2754 g_return_if_fail (quark > 0);
2756 g_datalist_id_set_data (&object->qdata, quark, data);
2760 * g_object_set_qdata_full:
2761 * @object: The GObject to set store a user data pointer
2762 * @quark: A #GQuark, naming the user data pointer
2763 * @data: An opaque user data pointer
2764 * @destroy: Function to invoke with @data as argument, when @data
2767 * This function works like g_object_set_qdata(), but in addition,
2768 * a void (*destroy) (gpointer) function may be specified which is
2769 * called with @data as argument when the @object is finalized, or
2770 * the data is being overwritten by a call to g_object_set_qdata()
2771 * with the same @quark.
2774 g_object_set_qdata_full (GObject *object,
2777 GDestroyNotify destroy)
2779 g_return_if_fail (G_IS_OBJECT (object));
2780 g_return_if_fail (quark > 0);
2782 g_datalist_id_set_data_full (&object->qdata, quark, data,
2783 data ? destroy : (GDestroyNotify) NULL);
2787 * g_object_steal_qdata:
2788 * @object: The GObject to get a stored user data pointer from
2789 * @quark: A #GQuark, naming the user data pointer
2791 * This function gets back user data pointers stored via
2792 * g_object_set_qdata() and removes the @data from object
2793 * without invoking its destroy() function (if any was
2795 * Usually, calling this function is only required to update
2796 * user data pointers with a destroy notifier, for example:
2799 * object_add_to_user_list (GObject *object,
2800 * const gchar *new_string)
2802 * // the quark, naming the object data
2803 * GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
2804 * // retrive the old string list
2805 * GList *list = g_object_steal_qdata (object, quark_string_list);
2807 * // prepend new string
2808 * list = g_list_prepend (list, g_strdup (new_string));
2809 * // this changed 'list', so we need to set it again
2810 * g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
2813 * free_string_list (gpointer data)
2815 * GList *node, *list = data;
2817 * for (node = list; node; node = node->next)
2818 * g_free (node->data);
2819 * g_list_free (list);
2822 * Using g_object_get_qdata() in the above example, instead of
2823 * g_object_steal_qdata() would have left the destroy function set,
2824 * and thus the partial string list would have been freed upon
2825 * g_object_set_qdata_full().
2827 * Returns: The user data pointer set, or %NULL
2830 g_object_steal_qdata (GObject *object,
2833 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2834 g_return_val_if_fail (quark > 0, NULL);
2836 return g_datalist_id_remove_no_notify (&object->qdata, quark);
2840 * g_object_get_data:
2841 * @object: #GObject containing the associations
2842 * @key: name of the key for that association
2844 * Gets a named field from the objects table of associations (see g_object_set_data()).
2846 * Returns: the data if found, or %NULL if no such data exists.
2849 g_object_get_data (GObject *object,
2854 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2855 g_return_val_if_fail (key != NULL, NULL);
2857 quark = g_quark_try_string (key);
2859 return quark ? g_datalist_id_get_data (&object->qdata, quark) : NULL;
2863 * g_object_set_data:
2864 * @object: #GObject containing the associations.
2865 * @key: name of the key
2866 * @data: data to associate with that key
2868 * Each object carries around a table of associations from
2869 * strings to pointers. This function lets you set an association.
2871 * If the object already had an association with that name,
2872 * the old association will be destroyed.
2875 g_object_set_data (GObject *object,
2879 g_return_if_fail (G_IS_OBJECT (object));
2880 g_return_if_fail (key != NULL);
2882 g_datalist_id_set_data (&object->qdata, g_quark_from_string (key), data);
2886 * g_object_set_data_full:
2887 * @object: #GObject containing the associations
2888 * @key: name of the key
2889 * @data: data to associate with that key
2890 * @destroy: function to call when the association is destroyed
2892 * Like g_object_set_data() except it adds notification
2893 * for when the association is destroyed, either by setting it
2894 * to a different value or when the object is destroyed.
2896 * Note that the @destroy callback is not called if @data is %NULL.
2899 g_object_set_data_full (GObject *object,
2902 GDestroyNotify destroy)
2904 g_return_if_fail (G_IS_OBJECT (object));
2905 g_return_if_fail (key != NULL);
2907 g_datalist_id_set_data_full (&object->qdata, g_quark_from_string (key), data,
2908 data ? destroy : (GDestroyNotify) NULL);
2912 * g_object_steal_data:
2913 * @object: #GObject containing the associations
2914 * @key: name of the key
2916 * Remove a specified datum from the object's data associations,
2917 * without invoking the association's destroy handler.
2919 * Returns: the data if found, or %NULL if no such data exists.
2922 g_object_steal_data (GObject *object,
2927 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2928 g_return_val_if_fail (key != NULL, NULL);
2930 quark = g_quark_try_string (key);
2932 return quark ? g_datalist_id_remove_no_notify (&object->qdata, quark) : NULL;
2936 g_value_object_init (GValue *value)
2938 value->data[0].v_pointer = NULL;
2942 g_value_object_free_value (GValue *value)
2944 if (value->data[0].v_pointer)
2945 g_object_unref (value->data[0].v_pointer);
2949 g_value_object_copy_value (const GValue *src_value,
2952 if (src_value->data[0].v_pointer)
2953 dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
2955 dest_value->data[0].v_pointer = NULL;
2959 g_value_object_transform_value (const GValue *src_value,
2962 if (src_value->data[0].v_pointer && g_type_is_a (G_OBJECT_TYPE (src_value->data[0].v_pointer), G_VALUE_TYPE (dest_value)))
2963 dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
2965 dest_value->data[0].v_pointer = NULL;
2969 g_value_object_peek_pointer (const GValue *value)
2971 return value->data[0].v_pointer;
2975 g_value_object_collect_value (GValue *value,
2976 guint n_collect_values,
2977 GTypeCValue *collect_values,
2978 guint collect_flags)
2980 if (collect_values[0].v_pointer)
2982 GObject *object = collect_values[0].v_pointer;
2984 if (object->g_type_instance.g_class == NULL)
2985 return g_strconcat ("invalid unclassed object pointer for value type `",
2986 G_VALUE_TYPE_NAME (value),
2989 else if (!g_value_type_compatible (G_OBJECT_TYPE (object), G_VALUE_TYPE (value)))
2990 return g_strconcat ("invalid object type `",
2991 G_OBJECT_TYPE_NAME (object),
2992 "' for value type `",
2993 G_VALUE_TYPE_NAME (value),
2996 /* never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types */
2997 value->data[0].v_pointer = g_object_ref (object);
3000 value->data[0].v_pointer = NULL;
3006 g_value_object_lcopy_value (const GValue *value,
3007 guint n_collect_values,
3008 GTypeCValue *collect_values,
3009 guint collect_flags)
3011 GObject **object_p = collect_values[0].v_pointer;
3014 return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
3016 if (!value->data[0].v_pointer)
3018 else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
3019 *object_p = value->data[0].v_pointer;
3021 *object_p = g_object_ref (value->data[0].v_pointer);
3027 * g_value_set_object:
3028 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3029 * @v_object: object value to be set
3031 * Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
3033 * g_value_set_object() increases the reference count of @v_object
3034 * (the #GValue holds a reference to @v_object). If you do not wish
3035 * to increase the reference count of the object (i.e. you wish to
3036 * pass your current reference to the #GValue because you no longer
3037 * need it), use g_value_take_object() instead.
3039 * It is important that your #GValue holds a reference to @v_object (either its
3040 * own, or one it has taken) to ensure that the object won't be destroyed while
3041 * the #GValue still exists).
3044 g_value_set_object (GValue *value,
3049 g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3051 old = value->data[0].v_pointer;
3055 g_return_if_fail (G_IS_OBJECT (v_object));
3056 g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3058 value->data[0].v_pointer = v_object;
3059 g_object_ref (value->data[0].v_pointer);
3062 value->data[0].v_pointer = NULL;
3065 g_object_unref (old);
3069 * g_value_set_object_take_ownership:
3070 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3071 * @v_object: object value to be set
3073 * This is an internal function introduced mainly for C marshallers.
3075 * Deprecated: 2.4: Use g_value_take_object() instead.
3078 g_value_set_object_take_ownership (GValue *value,
3081 g_value_take_object (value, v_object);
3085 * g_value_take_object:
3086 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3087 * @v_object: object value to be set
3089 * Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
3090 * and takes over the ownership of the callers reference to @v_object;
3091 * the caller doesn't have to unref it any more (i.e. the reference
3092 * count of the object is not increased).
3094 * If you want the #GValue to hold its own reference to @v_object, use
3095 * g_value_set_object() instead.
3100 g_value_take_object (GValue *value,
3103 g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3105 if (value->data[0].v_pointer)
3107 g_object_unref (value->data[0].v_pointer);
3108 value->data[0].v_pointer = NULL;
3113 g_return_if_fail (G_IS_OBJECT (v_object));
3114 g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3116 value->data[0].v_pointer = v_object; /* we take over the reference count */
3121 * g_value_get_object:
3122 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3124 * Get the contents of a %G_TYPE_OBJECT derived #GValue.
3126 * Returns: object contents of @value
3129 g_value_get_object (const GValue *value)
3131 g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3133 return value->data[0].v_pointer;
3137 * g_value_dup_object:
3138 * @value: a valid #GValue whose type is derived from %G_TYPE_OBJECT
3140 * Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing
3141 * its reference count.
3143 * Returns: object content of @value, should be unreferenced when no
3147 g_value_dup_object (const GValue *value)
3149 g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3151 return value->data[0].v_pointer ? g_object_ref (value->data[0].v_pointer) : NULL;
3155 * g_signal_connect_object:
3156 * @instance: the instance to connect to.
3157 * @detailed_signal: a string of the form "signal-name::detail".
3158 * @c_handler: the #GCallback to connect.
3159 * @gobject: the object to pass as data to @c_handler.
3160 * @connect_flags: a combination of #GConnnectFlags.
3162 * This is similar to g_signal_connect_data(), but uses a closure which
3163 * ensures that the @gobject stays alive during the call to @c_handler
3164 * by temporarily adding a reference count to @gobject.
3166 * Note that there is a bug in GObject that makes this function
3167 * much less useful than it might seem otherwise. Once @gobject is
3168 * disposed, the callback will no longer be called, but, the signal
3169 * handler is <emphasis>not</emphasis> currently disconnected. If the
3170 * @instance is itself being freed at the same time than this doesn't
3171 * matter, since the signal will automatically be removed, but
3172 * if @instance persists, then the signal handler will leak. You
3173 * should not remove the signal yourself because in a future versions of
3174 * GObject, the handler <emphasis>will</emphasis> automatically
3177 * It's possible to work around this problem in a way that will
3178 * continue to work with future versions of GObject by checking
3179 * that the signal handler is still connected before disconnected it:
3180 * <informalexample><programlisting>
3181 * if (g_signal_handler_is_connected (instance, id))
3182 * g_signal_handler_disconnect (instance, id);
3183 * </programlisting></informalexample>
3185 * Returns: the handler id.
3188 g_signal_connect_object (gpointer instance,
3189 const gchar *detailed_signal,
3190 GCallback c_handler,
3192 GConnectFlags connect_flags)
3194 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
3195 g_return_val_if_fail (detailed_signal != NULL, 0);
3196 g_return_val_if_fail (c_handler != NULL, 0);
3202 g_return_val_if_fail (G_IS_OBJECT (gobject), 0);
3204 closure = ((connect_flags & G_CONNECT_SWAPPED) ? g_cclosure_new_object_swap : g_cclosure_new_object) (c_handler, gobject);
3206 return g_signal_connect_closure (instance, detailed_signal, closure, connect_flags & G_CONNECT_AFTER);
3209 return g_signal_connect_data (instance, detailed_signal, c_handler, NULL, NULL, connect_flags);
3215 GClosure *closures[1]; /* flexible array */
3217 /* don't change this structure without supplying an accessor for
3218 * watched closures, e.g.:
3219 * GSList* g_object_list_watched_closures (GObject *object)
3222 * g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3223 * carray = g_object_get_data (object, "GObject-closure-array");
3226 * GSList *slist = NULL;
3228 * for (i = 0; i < carray->n_closures; i++)
3229 * slist = g_slist_prepend (slist, carray->closures[i]);
3237 object_remove_closure (gpointer data,
3240 GObject *object = data;
3241 CArray *carray = g_object_get_qdata (object, quark_closure_array);
3244 for (i = 0; i < carray->n_closures; i++)
3245 if (carray->closures[i] == closure)
3247 carray->n_closures--;
3248 if (i < carray->n_closures)
3249 carray->closures[i] = carray->closures[carray->n_closures];
3252 g_assert_not_reached ();
3256 destroy_closure_array (gpointer data)
3258 CArray *carray = data;
3259 GObject *object = carray->object;
3260 guint i, n = carray->n_closures;
3262 for (i = 0; i < n; i++)
3264 GClosure *closure = carray->closures[i];
3266 /* removing object_remove_closure() upfront is probably faster than
3267 * letting it fiddle with quark_closure_array which is empty anyways
3269 g_closure_remove_invalidate_notifier (closure, object, object_remove_closure);
3270 g_closure_invalidate (closure);
3276 * g_object_watch_closure:
3277 * @object: GObject restricting lifetime of @closure
3278 * @closure: GClosure to watch
3280 * This function essentially limits the life time of the @closure to
3281 * the life time of the object. That is, when the object is finalized,
3282 * the @closure is invalidated by calling g_closure_invalidate() on
3283 * it, in order to prevent invocations of the closure with a finalized
3284 * (nonexisting) object. Also, g_object_ref() and g_object_unref() are
3285 * added as marshal guards to the @closure, to ensure that an extra
3286 * reference count is held on @object during invocation of the
3287 * @closure. Usually, this function will be called on closures that
3288 * use this @object as closure data.
3291 g_object_watch_closure (GObject *object,
3297 g_return_if_fail (G_IS_OBJECT (object));
3298 g_return_if_fail (closure != NULL);
3299 g_return_if_fail (closure->is_invalid == FALSE);
3300 g_return_if_fail (closure->in_marshal == FALSE);
3301 g_return_if_fail (object->ref_count > 0); /* this doesn't work on finalizing objects */
3303 g_closure_add_invalidate_notifier (closure, object, object_remove_closure);
3304 g_closure_add_marshal_guards (closure,
3305 object, (GClosureNotify) g_object_ref,
3306 object, (GClosureNotify) g_object_unref);
3307 carray = g_datalist_id_remove_no_notify (&object->qdata, quark_closure_array);
3310 carray = g_renew (CArray, NULL, 1);
3311 carray->object = object;
3312 carray->n_closures = 1;
3317 i = carray->n_closures++;
3318 carray = g_realloc (carray, sizeof (*carray) + sizeof (carray->closures[0]) * i);
3320 carray->closures[i] = closure;
3321 g_datalist_id_set_data_full (&object->qdata, quark_closure_array, carray, destroy_closure_array);
3325 * g_closure_new_object:
3326 * @sizeof_closure: the size of the structure to allocate, must be at least
3327 * <literal>sizeof (GClosure)</literal>
3328 * @object: a #GObject pointer to store in the @data field of the newly
3329 * allocated #GClosure
3331 * A variant of g_closure_new_simple() which stores @object in the
3332 * @data field of the closure and calls g_object_watch_closure() on
3333 * @object and the created closure. This function is mainly useful
3334 * when implementing new types of closures.
3336 * Returns: a newly allocated #GClosure
3339 g_closure_new_object (guint sizeof_closure,
3344 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3345 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3347 closure = g_closure_new_simple (sizeof_closure, object);
3348 g_object_watch_closure (object, closure);
3354 * g_cclosure_new_object:
3355 * @callback_func: the function to invoke
3356 * @object: a #GObject pointer to pass to @callback_func
3358 * A variant of g_cclosure_new() which uses @object as @user_data and
3359 * calls g_object_watch_closure() on @object and the created
3360 * closure. This function is useful when you have a callback closely
3361 * associated with a #GObject, and want the callback to no longer run
3362 * after the object is is freed.
3364 * Returns: a new #GCClosure
3367 g_cclosure_new_object (GCallback callback_func,
3372 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3373 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3374 g_return_val_if_fail (callback_func != NULL, NULL);
3376 closure = g_cclosure_new (callback_func, object, NULL);
3377 g_object_watch_closure (object, closure);
3383 * g_cclosure_new_object_swap:
3384 * @callback_func: the function to invoke
3385 * @object: a #GObject pointer to pass to @callback_func
3387 * A variant of g_cclosure_new_swap() which uses @object as @user_data
3388 * and calls g_object_watch_closure() on @object and the created
3389 * closure. This function is useful when you have a callback closely
3390 * associated with a #GObject, and want the callback to no longer run
3391 * after the object is is freed.
3393 * Returns: a new #GCClosure
3396 g_cclosure_new_object_swap (GCallback callback_func,
3401 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3402 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3403 g_return_val_if_fail (callback_func != NULL, NULL);
3405 closure = g_cclosure_new_swap (callback_func, object, NULL);
3406 g_object_watch_closure (object, closure);
3412 g_object_compat_control (gsize what,
3418 case 1: /* floating base type */
3419 return G_TYPE_INITIALLY_UNOWNED;
3420 case 2: /* FIXME: remove this once GLib/Gtk+ break ABI again */
3421 floating_flag_handler = (guint(*)(GObject*,gint)) data;
3423 case 3: /* FIXME: remove this once GLib/Gtk+ break ABI again */
3425 *pp = floating_flag_handler;
3432 G_DEFINE_TYPE (GInitiallyUnowned, g_initially_unowned, G_TYPE_OBJECT);
3435 g_initially_unowned_init (GInitiallyUnowned *object)
3437 g_object_force_floating (object);
3441 g_initially_unowned_class_init (GInitiallyUnownedClass *klass)