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 "gtype-private.h"
31 #include "gvaluecollector.h"
33 #include "gparamspecs.h"
34 #include "gvaluetypes.h"
35 #include "gobject_trace.h"
37 #include "gobjectnotifyqueue.c"
41 * @short_description: The base object type
42 * @see_also: #GParamSpecObject, g_param_spec_object()
43 * @title: The Base Object Type
45 * GObject is the fundamental type providing the common attributes and
46 * methods for all object types in GTK+, Pango and other libraries
47 * based on GObject. The GObject class provides methods for object
48 * construction and destruction, property access methods, and signal
49 * support. Signals are described in detail in <xref
50 * linkend="gobject-Signals"/>.
52 * <para id="floating-ref">
53 * #GInitiallyUnowned is derived from #GObject. The only difference between
54 * the two is that the initial reference of a #GInitiallyUnowned is flagged
55 * as a <firstterm>floating</firstterm> reference.
56 * This means that it is not specifically claimed to be "owned" by
57 * any code portion. The main motivation for providing floating references is
58 * C convenience. In particular, it allows code to be written as:
60 * container = create_container();
61 * container_add_child (container, create_child());
63 * If <function>container_add_child()</function> will g_object_ref_sink() the
64 * passed in child, no reference of the newly created child is leaked.
65 * Without floating references, <function>container_add_child()</function>
66 * can only g_object_ref() the new child, so to implement this code without
67 * reference leaks, it would have to be written as:
70 * container = create_container();
71 * child = create_child();
72 * container_add_child (container, child);
73 * g_object_unref (child);
75 * The floating reference can be converted into
76 * an ordinary reference by calling g_object_ref_sink().
77 * For already sunken objects (objects that don't have a floating reference
78 * anymore), g_object_ref_sink() is equivalent to g_object_ref() and returns
80 * Since floating references are useful almost exclusively for C convenience,
81 * language bindings that provide automated reference and memory ownership
82 * maintenance (such as smart pointers or garbage collection) therefore don't
83 * need to expose floating references in their API.
86 * Some object implementations may need to save an objects floating state
87 * across certain code portions (an example is #GtkMenu), to achive this, the
88 * following sequence can be used:
91 * // save floating state
92 * gboolean was_floating = g_object_is_floating (object);
93 * g_object_ref_sink (object);
94 * // protected code portion
96 * // restore floating state
98 * g_object_force_floating (object);
99 * g_obejct_unref (object); // release previously acquired reference
105 #define PARAM_SPEC_PARAM_ID(pspec) ((pspec)->param_id)
106 #define PARAM_SPEC_SET_PARAM_ID(pspec, id) ((pspec)->param_id = (id))
108 #define OBJECT_HAS_TOGGLE_REF_FLAG 0x1
109 #define OBJECT_HAS_TOGGLE_REF(object) \
110 ((g_datalist_get_flags (&(object)->qdata) & OBJECT_HAS_TOGGLE_REF_FLAG) != 0)
111 #define OBJECT_FLOATING_FLAG 0x2
113 #define CLASS_HAS_PROPS_FLAG 0x1
114 #define CLASS_HAS_PROPS(class) \
115 ((class)->flags & CLASS_HAS_PROPS_FLAG)
116 #define CLASS_HAS_CUSTOM_CONSTRUCTOR(class) \
117 ((class)->constructor != g_object_constructor)
118 #define CLASS_HAS_CUSTOM_CONSTRUCTED(class) \
119 ((class)->constructed != g_object_constructed)
121 #define CLASS_HAS_DERIVED_CLASS_FLAG 0x2
122 #define CLASS_HAS_DERIVED_CLASS(class) \
123 ((class)->flags & CLASS_HAS_DERIVED_CLASS_FLAG)
125 /* --- signals --- */
132 /* --- properties --- */
138 /* --- prototypes --- */
139 static void g_object_base_class_init (GObjectClass *class);
140 static void g_object_base_class_finalize (GObjectClass *class);
141 static void g_object_do_class_init (GObjectClass *class);
142 static void g_object_init (GObject *object,
143 GObjectClass *class);
144 static GObject* g_object_constructor (GType type,
145 guint n_construct_properties,
146 GObjectConstructParam *construct_params);
147 static void g_object_constructed (GObject *object);
148 static void g_object_real_dispose (GObject *object);
149 static void g_object_finalize (GObject *object);
150 static void g_object_do_set_property (GObject *object,
154 static void g_object_do_get_property (GObject *object,
158 static void g_value_object_init (GValue *value);
159 static void g_value_object_free_value (GValue *value);
160 static void g_value_object_copy_value (const GValue *src_value,
162 static void g_value_object_transform_value (const GValue *src_value,
164 static gpointer g_value_object_peek_pointer (const GValue *value);
165 static gchar* g_value_object_collect_value (GValue *value,
166 guint n_collect_values,
167 GTypeCValue *collect_values,
168 guint collect_flags);
169 static gchar* g_value_object_lcopy_value (const GValue *value,
170 guint n_collect_values,
171 GTypeCValue *collect_values,
172 guint collect_flags);
173 static void g_object_dispatch_properties_changed (GObject *object,
175 GParamSpec **pspecs);
176 static inline void object_get_property (GObject *object,
179 static inline void object_set_property (GObject *object,
182 GObjectNotifyQueue *nqueue);
183 static guint object_floating_flag_handler (GObject *object,
186 static void object_interface_check_properties (gpointer func_data,
190 /* --- variables --- */
191 G_LOCK_DEFINE_STATIC (closure_array_mutex);
192 G_LOCK_DEFINE_STATIC (weak_refs_mutex);
193 G_LOCK_DEFINE_STATIC (toggle_refs_mutex);
194 static GQuark quark_closure_array = 0;
195 static GQuark quark_weak_refs = 0;
196 static GQuark quark_toggle_refs = 0;
197 static GParamSpecPool *pspec_pool = NULL;
198 static GObjectNotifyContext property_notify_context = { 0, };
199 static gulong gobject_signals[LAST_SIGNAL] = { 0, };
200 static guint (*floating_flag_handler) (GObject*, gint) = object_floating_flag_handler;
201 G_LOCK_DEFINE_STATIC (construction_mutex);
202 static GSList *construction_objects = NULL;
204 /* --- functions --- */
205 #ifdef G_ENABLE_DEBUG
206 #define IF_DEBUG(debug_type) if (_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type)
207 G_LOCK_DEFINE_STATIC (debug_objects);
208 static volatile GObject *g_trap_object_ref = NULL;
209 static guint debug_objects_count = 0;
210 static GHashTable *debug_objects_ht = NULL;
213 debug_objects_foreach (gpointer key,
217 GObject *object = value;
219 g_message ("[%p] stale %s\tref_count=%u",
221 G_OBJECT_TYPE_NAME (object),
226 debug_objects_atexit (void)
230 G_LOCK (debug_objects);
231 g_message ("stale GObjects: %u", debug_objects_count);
232 g_hash_table_foreach (debug_objects_ht, debug_objects_foreach, NULL);
233 G_UNLOCK (debug_objects);
236 #endif /* G_ENABLE_DEBUG */
239 _g_object_type_init (void)
241 static gboolean initialized = FALSE;
242 static const GTypeFundamentalInfo finfo = {
243 G_TYPE_FLAG_CLASSED | G_TYPE_FLAG_INSTANTIATABLE | G_TYPE_FLAG_DERIVABLE | G_TYPE_FLAG_DEEP_DERIVABLE,
245 static GTypeInfo info = {
246 sizeof (GObjectClass),
247 (GBaseInitFunc) g_object_base_class_init,
248 (GBaseFinalizeFunc) g_object_base_class_finalize,
249 (GClassInitFunc) g_object_do_class_init,
250 NULL /* class_destroy */,
251 NULL /* class_data */,
254 (GInstanceInitFunc) g_object_init,
255 NULL, /* value_table */
257 static const GTypeValueTable value_table = {
258 g_value_object_init, /* value_init */
259 g_value_object_free_value, /* value_free */
260 g_value_object_copy_value, /* value_copy */
261 g_value_object_peek_pointer, /* value_peek_pointer */
262 "p", /* collect_format */
263 g_value_object_collect_value, /* collect_value */
264 "p", /* lcopy_format */
265 g_value_object_lcopy_value, /* lcopy_value */
269 g_return_if_fail (initialized == FALSE);
274 info.value_table = &value_table;
275 type = g_type_register_fundamental (G_TYPE_OBJECT, g_intern_static_string ("GObject"), &info, &finfo, 0);
276 g_assert (type == G_TYPE_OBJECT);
277 g_value_register_transform_func (G_TYPE_OBJECT, G_TYPE_OBJECT, g_value_object_transform_value);
279 #ifdef G_ENABLE_DEBUG
282 debug_objects_ht = g_hash_table_new (g_direct_hash, NULL);
283 g_atexit (debug_objects_atexit);
285 #endif /* G_ENABLE_DEBUG */
289 g_object_base_class_init (GObjectClass *class)
291 GObjectClass *pclass = g_type_class_peek_parent (class);
293 /* Don't inherit HAS_DERIVED_CLASS flag from parent class */
294 class->flags &= ~CLASS_HAS_DERIVED_CLASS_FLAG;
297 pclass->flags |= CLASS_HAS_DERIVED_CLASS_FLAG;
299 /* reset instance specific fields and methods that don't get inherited */
300 class->construct_properties = pclass ? g_slist_copy (pclass->construct_properties) : NULL;
301 class->get_property = NULL;
302 class->set_property = NULL;
306 g_object_base_class_finalize (GObjectClass *class)
310 _g_signals_destroy (G_OBJECT_CLASS_TYPE (class));
312 g_slist_free (class->construct_properties);
313 class->construct_properties = NULL;
314 list = g_param_spec_pool_list_owned (pspec_pool, G_OBJECT_CLASS_TYPE (class));
315 for (node = list; node; node = node->next)
317 GParamSpec *pspec = node->data;
319 g_param_spec_pool_remove (pspec_pool, pspec);
320 PARAM_SPEC_SET_PARAM_ID (pspec, 0);
321 g_param_spec_unref (pspec);
327 g_object_notify_dispatcher (GObject *object,
331 G_OBJECT_GET_CLASS (object)->dispatch_properties_changed (object, n_pspecs, pspecs);
335 g_object_do_class_init (GObjectClass *class)
337 /* read the comment about typedef struct CArray; on why not to change this quark */
338 quark_closure_array = g_quark_from_static_string ("GObject-closure-array");
340 quark_weak_refs = g_quark_from_static_string ("GObject-weak-references");
341 quark_toggle_refs = g_quark_from_static_string ("GObject-toggle-references");
342 pspec_pool = g_param_spec_pool_new (TRUE);
343 property_notify_context.quark_notify_queue = g_quark_from_static_string ("GObject-notify-queue");
344 property_notify_context.dispatcher = g_object_notify_dispatcher;
346 class->constructor = g_object_constructor;
347 class->constructed = g_object_constructed;
348 class->set_property = g_object_do_set_property;
349 class->get_property = g_object_do_get_property;
350 class->dispose = g_object_real_dispose;
351 class->finalize = g_object_finalize;
352 class->dispatch_properties_changed = g_object_dispatch_properties_changed;
353 class->notify = NULL;
357 * @gobject: the object which received the signal.
358 * @pspec: the #GParamSpec of the property which changed.
360 * The notify signal is emitted on an object when one of its
361 * properties has been changed. Note that getting this signal
362 * doesn't guarantee that the value of the property has actually
363 * changed, it may also be emitted when the setter for the property
364 * is called to reinstate the previous value.
366 * This signal is typically used to obtain change notification for a
367 * single property, by specifying the property name as a detail in the
368 * g_signal_connect() call, like this:
370 * g_signal_connect (text_view->buffer, "notify::paste-target-list",
371 * G_CALLBACK (gtk_text_view_target_list_notify),
374 * It is important to note that you must use
375 * <link linkend="canonical-parameter-name">canonical</link> parameter names as
376 * detail strings for the notify signal.
378 gobject_signals[NOTIFY] =
379 g_signal_new (g_intern_static_string ("notify"),
380 G_TYPE_FROM_CLASS (class),
381 G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS | G_SIGNAL_ACTION,
382 G_STRUCT_OFFSET (GObjectClass, notify),
384 g_cclosure_marshal_VOID__PARAM,
388 /* Install a check function that we'll use to verify that classes that
389 * implement an interface implement all properties for that interface
391 g_type_add_interface_check (NULL, object_interface_check_properties);
395 install_property_internal (GType g_type,
399 if (g_param_spec_pool_lookup (pspec_pool, pspec->name, g_type, FALSE))
401 g_warning ("When installing property: type `%s' already has a property named `%s'",
402 g_type_name (g_type),
407 g_param_spec_ref (pspec);
408 g_param_spec_sink (pspec);
409 PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
410 g_param_spec_pool_insert (pspec_pool, pspec, g_type);
414 * g_object_class_install_property:
415 * @oclass: a #GObjectClass
416 * @property_id: the id for the new property
417 * @pspec: the #GParamSpec for the new property
419 * Installs a new property. This is usually done in the class initializer.
421 * Note that it is possible to redefine a property in a derived class,
422 * by installing a property with the same name. This can be useful at times,
423 * e.g. to change the range of allowed values or the default value.
426 g_object_class_install_property (GObjectClass *class,
430 g_return_if_fail (G_IS_OBJECT_CLASS (class));
431 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
433 if (CLASS_HAS_DERIVED_CLASS (class))
434 g_error ("Attempt to add property %s::%s to class after it was derived",
435 G_OBJECT_CLASS_NAME (class), pspec->name);
437 class->flags |= CLASS_HAS_PROPS_FLAG;
439 if (pspec->flags & G_PARAM_WRITABLE)
440 g_return_if_fail (class->set_property != NULL);
441 if (pspec->flags & G_PARAM_READABLE)
442 g_return_if_fail (class->get_property != NULL);
443 g_return_if_fail (property_id > 0);
444 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
445 if (pspec->flags & G_PARAM_CONSTRUCT)
446 g_return_if_fail ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
447 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
448 g_return_if_fail (pspec->flags & G_PARAM_WRITABLE);
450 install_property_internal (G_OBJECT_CLASS_TYPE (class), property_id, pspec);
452 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
453 class->construct_properties = g_slist_prepend (class->construct_properties, pspec);
455 /* for property overrides of construct properties, we have to get rid
456 * of the overidden inherited construct property
458 pspec = g_param_spec_pool_lookup (pspec_pool, pspec->name, g_type_parent (G_OBJECT_CLASS_TYPE (class)), TRUE);
459 if (pspec && pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
460 class->construct_properties = g_slist_remove (class->construct_properties, pspec);
464 * g_object_class_install_properties:
465 * @oclass: a #GObjectClass
466 * @n_pspecs: the length of the #GParamSpec<!-- -->s array
467 * @pspecs: (array length=n_pspecs): the #GParamSpec<!-- -->s array
468 * defining the new properties
470 * Installs new properties from an array of #GParamSpec<!-- -->s. This is
471 * usually done in the class initializer.
473 * The property id of each property is the index of each #GParamSpec in
476 * The property id of 0 is treated specially by #GObject and it should not
477 * be used to store a #GParamSpec.
479 * This function should be used if you plan to use a static array of
480 * #GParamSpec<!-- -->s and g_object_notify_by_pspec(). For instance, this
481 * class initialization:
485 * PROP_0, PROP_FOO, PROP_BAR, N_PROPERTIES
488 * static GParamSpec *obj_properties[N_PROPERTIES] = { NULL, };
491 * my_object_class_init (MyObjectClass *klass)
493 * GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
495 * obj_properties[PROP_FOO] =
496 * g_param_spec_int ("foo", "Foo", "Foo",
499 * G_PARAM_READWRITE);
501 * obj_properties[PROP_BAR] =
502 * g_param_spec_string ("bar", "Bar", "Bar",
504 * G_PARAM_READWRITE);
506 * gobject_class->set_property = my_object_set_property;
507 * gobject_class->get_property = my_object_get_property;
508 * g_object_class_install_properties (gobject_class,
514 * allows calling g_object_notify_by_pspec() to notify of property changes:
518 * my_object_set_foo (MyObject *self, gint foo)
520 * if (self->foo != foo)
523 * g_object_notify_by_pspec (G_OBJECT (self), obj_properties[PROP_FOO]);
531 g_object_class_install_properties (GObjectClass *oclass,
535 GType oclass_type, parent_type;
538 g_return_if_fail (G_IS_OBJECT_CLASS (oclass));
539 g_return_if_fail (n_pspecs > 1);
540 g_return_if_fail (pspecs[0] == NULL);
542 if (CLASS_HAS_DERIVED_CLASS (oclass))
543 g_error ("Attempt to add properties to %s after it was derived",
544 G_OBJECT_CLASS_NAME (oclass));
546 oclass_type = G_OBJECT_CLASS_TYPE (oclass);
547 parent_type = g_type_parent (oclass_type);
549 /* we skip the first element of the array as it would have a 0 prop_id */
550 for (i = 1; i < n_pspecs; i++)
552 GParamSpec *pspec = pspecs[i];
554 g_return_if_fail (pspec != NULL);
556 if (pspec->flags & G_PARAM_WRITABLE)
557 g_return_if_fail (oclass->set_property != NULL);
558 if (pspec->flags & G_PARAM_READABLE)
559 g_return_if_fail (oclass->get_property != NULL);
560 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
561 if (pspec->flags & G_PARAM_CONSTRUCT)
562 g_return_if_fail ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
563 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
564 g_return_if_fail (pspec->flags & G_PARAM_WRITABLE);
566 oclass->flags |= CLASS_HAS_PROPS_FLAG;
567 install_property_internal (oclass_type, i, pspec);
569 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
570 oclass->construct_properties = g_slist_prepend (oclass->construct_properties, pspec);
572 /* for property overrides of construct properties, we have to get rid
573 * of the overidden inherited construct property
575 pspec = g_param_spec_pool_lookup (pspec_pool, pspec->name, parent_type, TRUE);
576 if (pspec && pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
577 oclass->construct_properties = g_slist_remove (oclass->construct_properties, pspec);
582 * g_object_interface_install_property:
583 * @g_iface: any interface vtable for the interface, or the default
584 * vtable for the interface.
585 * @pspec: the #GParamSpec for the new property
587 * Add a property to an interface; this is only useful for interfaces
588 * that are added to GObject-derived types. Adding a property to an
589 * interface forces all objects classes with that interface to have a
590 * compatible property. The compatible property could be a newly
591 * created #GParamSpec, but normally
592 * g_object_class_override_property() will be used so that the object
593 * class only needs to provide an implementation and inherits the
594 * property description, default value, bounds, and so forth from the
595 * interface property.
597 * This function is meant to be called from the interface's default
598 * vtable initialization function (the @class_init member of
599 * #GTypeInfo.) It must not be called after after @class_init has
600 * been called for any object types implementing this interface.
605 g_object_interface_install_property (gpointer g_iface,
608 GTypeInterface *iface_class = g_iface;
610 g_return_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type));
611 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
612 g_return_if_fail (!G_IS_PARAM_SPEC_OVERRIDE (pspec)); /* paranoid */
613 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
615 install_property_internal (iface_class->g_type, 0, pspec);
619 * g_object_class_find_property:
620 * @oclass: a #GObjectClass
621 * @property_name: the name of the property to look up
623 * Looks up the #GParamSpec for a property of a class.
625 * Returns: (transfer none): the #GParamSpec for the property, or
626 * %NULL if the class doesn't have a property of that name
629 g_object_class_find_property (GObjectClass *class,
630 const gchar *property_name)
633 GParamSpec *redirect;
635 g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
636 g_return_val_if_fail (property_name != NULL, NULL);
638 pspec = g_param_spec_pool_lookup (pspec_pool,
640 G_OBJECT_CLASS_TYPE (class),
644 redirect = g_param_spec_get_redirect_target (pspec);
655 * g_object_interface_find_property:
656 * @g_iface: any interface vtable for the interface, or the default
657 * vtable for the interface
658 * @property_name: name of a property to lookup.
660 * Find the #GParamSpec with the given name for an
661 * interface. Generally, the interface vtable passed in as @g_iface
662 * will be the default vtable from g_type_default_interface_ref(), or,
663 * if you know the interface has already been loaded,
664 * g_type_default_interface_peek().
668 * Returns: (transfer none): the #GParamSpec for the property of the
669 * interface with the name @property_name, or %NULL if no
670 * such property exists.
673 g_object_interface_find_property (gpointer g_iface,
674 const gchar *property_name)
676 GTypeInterface *iface_class = g_iface;
678 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type), NULL);
679 g_return_val_if_fail (property_name != NULL, NULL);
681 return g_param_spec_pool_lookup (pspec_pool,
688 * g_object_class_override_property:
689 * @oclass: a #GObjectClass
690 * @property_id: the new property ID
691 * @name: the name of a property registered in a parent class or
692 * in an interface of this class.
694 * Registers @property_id as referring to a property with the
695 * name @name in a parent class or in an interface implemented
696 * by @oclass. This allows this class to <firstterm>override</firstterm>
697 * a property implementation in a parent class or to provide
698 * the implementation of a property from an interface.
701 * Internally, overriding is implemented by creating a property of type
702 * #GParamSpecOverride; generally operations that query the properties of
703 * the object class, such as g_object_class_find_property() or
704 * g_object_class_list_properties() will return the overridden
705 * property. However, in one case, the @construct_properties argument of
706 * the @constructor virtual function, the #GParamSpecOverride is passed
707 * instead, so that the @param_id field of the #GParamSpec will be
708 * correct. For virtually all uses, this makes no difference. If you
709 * need to get the overridden property, you can call
710 * g_param_spec_get_redirect_target().
716 g_object_class_override_property (GObjectClass *oclass,
720 GParamSpec *overridden = NULL;
724 g_return_if_fail (G_IS_OBJECT_CLASS (oclass));
725 g_return_if_fail (property_id > 0);
726 g_return_if_fail (name != NULL);
728 /* Find the overridden property; first check parent types
730 parent_type = g_type_parent (G_OBJECT_CLASS_TYPE (oclass));
731 if (parent_type != G_TYPE_NONE)
732 overridden = g_param_spec_pool_lookup (pspec_pool,
741 /* Now check interfaces
743 ifaces = g_type_interfaces (G_OBJECT_CLASS_TYPE (oclass), &n_ifaces);
744 while (n_ifaces-- && !overridden)
746 overridden = g_param_spec_pool_lookup (pspec_pool,
757 g_warning ("%s: Can't find property to override for '%s::%s'",
758 G_STRFUNC, G_OBJECT_CLASS_NAME (oclass), name);
762 new = g_param_spec_override (name, overridden);
763 g_object_class_install_property (oclass, property_id, new);
767 * g_object_class_list_properties:
768 * @oclass: a #GObjectClass
769 * @n_properties: (out): return location for the length of the returned array
771 * Get an array of #GParamSpec* for all properties of a class.
773 * Returns: (array length=n_properties) (transfer container): an array of
774 * #GParamSpec* which should be freed after use
776 GParamSpec** /* free result */
777 g_object_class_list_properties (GObjectClass *class,
778 guint *n_properties_p)
783 g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
785 pspecs = g_param_spec_pool_list (pspec_pool,
786 G_OBJECT_CLASS_TYPE (class),
795 * g_object_interface_list_properties:
796 * @g_iface: any interface vtable for the interface, or the default
797 * vtable for the interface
798 * @n_properties_p: (out): location to store number of properties returned.
800 * Lists the properties of an interface.Generally, the interface
801 * vtable passed in as @g_iface will be the default vtable from
802 * g_type_default_interface_ref(), or, if you know the interface has
803 * already been loaded, g_type_default_interface_peek().
807 * Returns: (array length=n_properties_p) (transfer container): a
808 * pointer to an array of pointers to #GParamSpec
809 * structures. The paramspecs are owned by GLib, but the
810 * array should be freed with g_free() when you are done with
814 g_object_interface_list_properties (gpointer g_iface,
815 guint *n_properties_p)
817 GTypeInterface *iface_class = g_iface;
821 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type), NULL);
823 pspecs = g_param_spec_pool_list (pspec_pool,
833 g_object_init (GObject *object,
836 object->ref_count = 1;
837 g_datalist_init (&object->qdata);
839 if (CLASS_HAS_PROPS (class))
841 /* freeze object's notification queue, g_object_newv() preserves pairedness */
842 g_object_notify_queue_freeze (object, &property_notify_context);
845 if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
847 /* enter construction list for notify_queue_thaw() and to allow construct-only properties */
848 G_LOCK (construction_mutex);
849 construction_objects = g_slist_prepend (construction_objects, object);
850 G_UNLOCK (construction_mutex);
853 #ifdef G_ENABLE_DEBUG
856 G_LOCK (debug_objects);
857 debug_objects_count++;
858 g_hash_table_insert (debug_objects_ht, object, object);
859 G_UNLOCK (debug_objects);
861 #endif /* G_ENABLE_DEBUG */
865 g_object_do_set_property (GObject *object,
873 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
879 g_object_do_get_property (GObject *object,
887 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
893 g_object_real_dispose (GObject *object)
895 g_signal_handlers_destroy (object);
896 g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
897 g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
901 g_object_finalize (GObject *object)
903 g_datalist_clear (&object->qdata);
905 #ifdef G_ENABLE_DEBUG
908 G_LOCK (debug_objects);
909 g_assert (g_hash_table_lookup (debug_objects_ht, object) == object);
910 g_hash_table_remove (debug_objects_ht, object);
911 debug_objects_count--;
912 G_UNLOCK (debug_objects);
914 #endif /* G_ENABLE_DEBUG */
919 g_object_dispatch_properties_changed (GObject *object,
925 for (i = 0; i < n_pspecs; i++)
926 g_signal_emit (object, gobject_signals[NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
930 * g_object_run_dispose:
931 * @object: a #GObject
933 * Releases all references to other objects. This can be used to break
936 * This functions should only be called from object system implementations.
939 g_object_run_dispose (GObject *object)
941 g_return_if_fail (G_IS_OBJECT (object));
942 g_return_if_fail (object->ref_count > 0);
944 g_object_ref (object);
945 TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 0));
946 G_OBJECT_GET_CLASS (object)->dispose (object);
947 TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 0));
948 g_object_unref (object);
952 * g_object_freeze_notify:
953 * @object: a #GObject
955 * Increases the freeze count on @object. If the freeze count is
956 * non-zero, the emission of "notify" signals on @object is
957 * stopped. The signals are queued until the freeze count is decreased
960 * This is necessary for accessors that modify multiple properties to prevent
961 * premature notification while the object is still being modified.
964 g_object_freeze_notify (GObject *object)
966 g_return_if_fail (G_IS_OBJECT (object));
968 if (g_atomic_int_get (&object->ref_count) == 0)
971 g_object_ref (object);
972 g_object_notify_queue_freeze (object, &property_notify_context);
973 g_object_unref (object);
977 g_object_notify_by_spec_internal (GObject *object,
980 GObjectNotifyQueue *nqueue;
982 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
983 g_object_notify_queue_add (object, nqueue, pspec);
984 g_object_notify_queue_thaw (object, nqueue);
989 * @object: a #GObject
990 * @property_name: the name of a property installed on the class of @object.
992 * Emits a "notify" signal for the property @property_name on @object.
994 * When possible, eg. when signaling a property change from within the class
995 * that registered the property, you should use g_object_notify_by_pspec()
999 g_object_notify (GObject *object,
1000 const gchar *property_name)
1004 g_return_if_fail (G_IS_OBJECT (object));
1005 g_return_if_fail (property_name != NULL);
1006 if (g_atomic_int_get (&object->ref_count) == 0)
1009 g_object_ref (object);
1010 /* We don't need to get the redirect target
1011 * (by, e.g. calling g_object_class_find_property())
1012 * because g_object_notify_queue_add() does that
1014 pspec = g_param_spec_pool_lookup (pspec_pool,
1016 G_OBJECT_TYPE (object),
1020 g_warning ("%s: object class `%s' has no property named `%s'",
1022 G_OBJECT_TYPE_NAME (object),
1025 g_object_notify_by_spec_internal (object, pspec);
1026 g_object_unref (object);
1030 * g_object_notify_by_pspec:
1031 * @object: a #GObject
1032 * @pspec: the #GParamSpec of a property installed on the class of @object.
1034 * Emits a "notify" signal for the property specified by @pspec on @object.
1036 * This function omits the property name lookup, hence it is faster than
1037 * g_object_notify().
1039 * One way to avoid using g_object_notify() from within the
1040 * class that registered the properties, and using g_object_notify_by_pspec()
1041 * instead, is to store the GParamSpec used with
1042 * g_object_class_install_property() inside a static array, e.g.:
1052 * static GParamSpec *properties[PROP_LAST];
1055 * my_object_class_init (MyObjectClass *klass)
1057 * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
1060 * G_PARAM_READWRITE);
1061 * g_object_class_install_property (gobject_class,
1063 * properties[PROP_FOO]);
1067 * and then notify a change on the "foo" property with:
1070 * g_object_notify_by_pspec (self, properties[PROP_FOO]);
1076 g_object_notify_by_pspec (GObject *object,
1080 g_return_if_fail (G_IS_OBJECT (object));
1081 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
1083 g_object_ref (object);
1084 g_object_notify_by_spec_internal (object, pspec);
1085 g_object_unref (object);
1089 * g_object_thaw_notify:
1090 * @object: a #GObject
1092 * Reverts the effect of a previous call to
1093 * g_object_freeze_notify(). The freeze count is decreased on @object
1094 * and when it reaches zero, all queued "notify" signals are emitted.
1096 * It is an error to call this function when the freeze count is zero.
1099 g_object_thaw_notify (GObject *object)
1101 GObjectNotifyQueue *nqueue;
1103 g_return_if_fail (G_IS_OBJECT (object));
1104 if (g_atomic_int_get (&object->ref_count) == 0)
1107 g_object_ref (object);
1109 /* FIXME: Freezing is the only way to get at the notify queue.
1110 * So we freeze once and then thaw twice.
1112 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1113 g_object_notify_queue_thaw (object, nqueue);
1114 g_object_notify_queue_thaw (object, nqueue);
1116 g_object_unref (object);
1120 object_get_property (GObject *object,
1124 GObjectClass *class = g_type_class_peek (pspec->owner_type);
1125 guint param_id = PARAM_SPEC_PARAM_ID (pspec);
1126 GParamSpec *redirect;
1130 g_warning ("'%s::%s' is not a valid property name; '%s' is not a GObject subtype",
1131 g_type_name (pspec->owner_type), pspec->name, g_type_name (pspec->owner_type));
1135 redirect = g_param_spec_get_redirect_target (pspec);
1139 class->get_property (object, param_id, value, pspec);
1143 object_set_property (GObject *object,
1145 const GValue *value,
1146 GObjectNotifyQueue *nqueue)
1148 GValue tmp_value = { 0, };
1149 GObjectClass *class = g_type_class_peek (pspec->owner_type);
1150 guint param_id = PARAM_SPEC_PARAM_ID (pspec);
1151 GParamSpec *redirect;
1152 static gchar* enable_diagnostic = NULL;
1156 g_warning ("'%s::%s' is not a valid property name; '%s' is not a GObject subtype",
1157 g_type_name (pspec->owner_type), pspec->name, g_type_name (pspec->owner_type));
1161 redirect = g_param_spec_get_redirect_target (pspec);
1165 if (G_UNLIKELY (!enable_diagnostic))
1167 enable_diagnostic = g_getenv ("G_ENABLE_DIAGNOSTIC");
1168 if (!enable_diagnostic)
1169 enable_diagnostic = "0";
1172 if (enable_diagnostic[0] == '1')
1174 if (pspec->flags & G_PARAM_DEPRECATED)
1175 g_warning ("The property %s::%s is deprecated and shouldn't be used "
1176 "anymore. It will be removed in a future version.",
1177 G_OBJECT_TYPE_NAME (object), pspec->name);
1180 /* provide a copy to work from, convert (if necessary) and validate */
1181 g_value_init (&tmp_value, pspec->value_type);
1182 if (!g_value_transform (value, &tmp_value))
1183 g_warning ("unable to set property `%s' of type `%s' from value of type `%s'",
1185 g_type_name (pspec->value_type),
1186 G_VALUE_TYPE_NAME (value));
1187 else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
1189 gchar *contents = g_strdup_value_contents (value);
1191 g_warning ("value \"%s\" of type `%s' is invalid or out of range for property `%s' of type `%s'",
1193 G_VALUE_TYPE_NAME (value),
1195 g_type_name (pspec->value_type));
1200 class->set_property (object, param_id, &tmp_value, pspec);
1201 g_object_notify_queue_add (object, nqueue, pspec);
1203 g_value_unset (&tmp_value);
1207 object_interface_check_properties (gpointer func_data,
1210 GTypeInterface *iface_class = g_iface;
1211 GObjectClass *class;
1212 GType iface_type = iface_class->g_type;
1213 GParamSpec **pspecs;
1216 class = g_type_class_ref (iface_class->g_instance_type);
1218 if (!G_IS_OBJECT_CLASS (class))
1221 pspecs = g_param_spec_pool_list (pspec_pool, iface_type, &n);
1225 GParamSpec *class_pspec = g_param_spec_pool_lookup (pspec_pool,
1227 G_OBJECT_CLASS_TYPE (class),
1232 g_critical ("Object class %s doesn't implement property "
1233 "'%s' from interface '%s'",
1234 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1236 g_type_name (iface_type));
1241 /* The implementation paramspec must have a less restrictive
1242 * type than the interface parameter spec for set() and a
1243 * more restrictive type for get(). We just require equality,
1244 * rather than doing something more complicated checking
1245 * the READABLE and WRITABLE flags. We also simplify here
1246 * by only checking the value type, not the G_PARAM_SPEC_TYPE.
1249 !g_type_is_a (pspecs[n]->value_type,
1250 class_pspec->value_type))
1252 g_critical ("Property '%s' on class '%s' has type '%s' "
1253 "which is different from the type '%s', "
1254 "of the property on interface '%s'\n",
1256 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1257 g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1258 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])),
1259 g_type_name (iface_type));
1262 #define SUBSET(a,b,mask) (((a) & ~(b) & (mask)) == 0)
1264 /* CONSTRUCT and CONSTRUCT_ONLY add restrictions.
1265 * READABLE and WRITABLE remove restrictions. The implementation
1266 * paramspec must have less restrictive flags.
1269 (!SUBSET (class_pspec->flags,
1271 G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY) ||
1272 !SUBSET (pspecs[n]->flags,
1274 G_PARAM_READABLE | G_PARAM_WRITABLE)))
1276 g_critical ("Flags for property '%s' on class '%s' "
1277 "are not compatible with the property on"
1280 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1281 g_type_name (iface_type));
1288 g_type_class_unref (class);
1292 g_object_get_type (void)
1294 return G_TYPE_OBJECT;
1298 * g_object_new: (skip)
1299 * @object_type: the type id of the #GObject subtype to instantiate
1300 * @first_property_name: the name of the first property
1301 * @...: the value of the first property, followed optionally by more
1302 * name/value pairs, followed by %NULL
1304 * Creates a new instance of a #GObject subtype and sets its properties.
1306 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1307 * which are not explicitly specified are set to their default values.
1309 * Returns: (transfer full): a new instance of @object_type
1312 g_object_new (GType object_type,
1313 const gchar *first_property_name,
1319 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1321 /* short circuit for calls supplying no properties */
1322 if (!first_property_name)
1323 return g_object_newv (object_type, 0, NULL);
1325 va_start (var_args, first_property_name);
1326 object = g_object_new_valist (object_type, first_property_name, var_args);
1333 slist_maybe_remove (GSList **slist,
1336 GSList *last = NULL, *node = *slist;
1339 if (node->data == data)
1342 last->next = node->next;
1344 *slist = node->next;
1345 g_slist_free_1 (node);
1354 static inline gboolean
1355 object_in_construction_list (GObject *object)
1357 gboolean in_construction;
1358 G_LOCK (construction_mutex);
1359 in_construction = g_slist_find (construction_objects, object) != NULL;
1360 G_UNLOCK (construction_mutex);
1361 return in_construction;
1366 * @object_type: the type id of the #GObject subtype to instantiate
1367 * @n_parameters: the length of the @parameters array
1368 * @parameters: (array length=n_parameters): an array of #GParameter
1370 * Creates a new instance of a #GObject subtype and sets its properties.
1372 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1373 * which are not explicitly specified are set to their default values.
1375 * Rename to: g_object_new
1376 * Returns: (type GObject.Object) (transfer full): a new instance of
1380 g_object_newv (GType object_type,
1382 GParameter *parameters)
1384 GObjectConstructParam *cparams = NULL, *oparams;
1385 GObjectNotifyQueue *nqueue = NULL; /* shouldn't be initialized, just to silence compiler */
1387 GObjectClass *class, *unref_class = NULL;
1389 guint n_total_cparams = 0, n_cparams = 0, n_oparams = 0, n_cvalues;
1391 GList *clist = NULL;
1392 gboolean newly_constructed;
1395 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1397 class = g_type_class_peek_static (object_type);
1399 class = unref_class = g_type_class_ref (object_type);
1400 for (slist = class->construct_properties; slist; slist = slist->next)
1402 clist = g_list_prepend (clist, slist->data);
1403 n_total_cparams += 1;
1406 if (n_parameters == 0 && n_total_cparams == 0)
1408 /* This is a simple object with no construct properties, and
1409 * no properties are being set, so short circuit the parameter
1410 * handling. This speeds up simple object construction.
1413 object = class->constructor (object_type, 0, NULL);
1414 goto did_construction;
1417 /* collect parameters, sort into construction and normal ones */
1418 oparams = g_new (GObjectConstructParam, n_parameters);
1419 cparams = g_new (GObjectConstructParam, n_total_cparams);
1420 for (i = 0; i < n_parameters; i++)
1422 GValue *value = ¶meters[i].value;
1423 GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1429 g_warning ("%s: object class `%s' has no property named `%s'",
1431 g_type_name (object_type),
1432 parameters[i].name);
1435 if (!(pspec->flags & G_PARAM_WRITABLE))
1437 g_warning ("%s: property `%s' of object class `%s' is not writable",
1440 g_type_name (object_type));
1443 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1445 GList *list = g_list_find (clist, pspec);
1449 g_warning ("%s: construct property \"%s\" for object `%s' can't be set twice",
1450 G_STRFUNC, pspec->name, g_type_name (object_type));
1453 cparams[n_cparams].pspec = pspec;
1454 cparams[n_cparams].value = value;
1459 list->prev->next = list->next;
1461 list->next->prev = list->prev;
1462 g_list_free_1 (list);
1466 oparams[n_oparams].pspec = pspec;
1467 oparams[n_oparams].value = value;
1472 /* set remaining construction properties to default values */
1473 n_cvalues = n_total_cparams - n_cparams;
1474 cvalues = g_new (GValue, n_cvalues);
1477 GList *tmp = clist->next;
1478 GParamSpec *pspec = clist->data;
1479 GValue *value = cvalues + n_total_cparams - n_cparams - 1;
1482 g_value_init (value, pspec->value_type);
1483 g_param_value_set_default (pspec, value);
1485 cparams[n_cparams].pspec = pspec;
1486 cparams[n_cparams].value = value;
1489 g_list_free_1 (clist);
1493 /* construct object from construction parameters */
1494 object = class->constructor (object_type, n_total_cparams, cparams);
1495 /* free construction values */
1498 g_value_unset (cvalues + n_cvalues);
1502 if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
1504 /* adjust freeze_count according to g_object_init() and remaining properties */
1505 G_LOCK (construction_mutex);
1506 newly_constructed = slist_maybe_remove (&construction_objects, object);
1507 G_UNLOCK (construction_mutex);
1510 newly_constructed = TRUE;
1512 if (CLASS_HAS_PROPS (class))
1514 if (newly_constructed || n_oparams)
1515 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1516 if (newly_constructed)
1517 g_object_notify_queue_thaw (object, nqueue);
1520 /* run 'constructed' handler if there is a custom one */
1521 if (newly_constructed && CLASS_HAS_CUSTOM_CONSTRUCTED (class))
1522 class->constructed (object);
1524 /* set remaining properties */
1525 for (i = 0; i < n_oparams; i++)
1526 object_set_property (object, oparams[i].pspec, oparams[i].value, nqueue);
1529 if (CLASS_HAS_PROPS (class))
1531 /* release our own freeze count and handle notifications */
1532 if (newly_constructed || n_oparams)
1533 g_object_notify_queue_thaw (object, nqueue);
1537 g_type_class_unref (unref_class);
1543 * g_object_new_valist: (skip)
1544 * @object_type: the type id of the #GObject subtype to instantiate
1545 * @first_property_name: the name of the first property
1546 * @var_args: the value of the first property, followed optionally by more
1547 * name/value pairs, followed by %NULL
1549 * Creates a new instance of a #GObject subtype and sets its properties.
1551 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1552 * which are not explicitly specified are set to their default values.
1554 * Returns: a new instance of @object_type
1557 g_object_new_valist (GType object_type,
1558 const gchar *first_property_name,
1561 GObjectClass *class;
1565 guint n_params = 0, n_alloced_params = 16;
1567 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1569 if (!first_property_name)
1570 return g_object_newv (object_type, 0, NULL);
1572 class = g_type_class_ref (object_type);
1574 params = g_new0 (GParameter, n_alloced_params);
1575 name = first_property_name;
1578 gchar *error = NULL;
1579 GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1585 g_warning ("%s: object class `%s' has no property named `%s'",
1587 g_type_name (object_type),
1591 if (n_params >= n_alloced_params)
1593 n_alloced_params += 16;
1594 params = g_renew (GParameter, params, n_alloced_params);
1595 memset (params + n_params, 0, 16 * (sizeof *params));
1597 params[n_params].name = name;
1598 G_VALUE_COLLECT_INIT (¶ms[n_params].value, pspec->value_type,
1599 var_args, 0, &error);
1602 g_warning ("%s: %s", G_STRFUNC, error);
1604 g_value_unset (¶ms[n_params].value);
1608 name = va_arg (var_args, gchar*);
1611 object = g_object_newv (object_type, n_params, params);
1614 g_value_unset (¶ms[n_params].value);
1617 g_type_class_unref (class);
1623 g_object_constructor (GType type,
1624 guint n_construct_properties,
1625 GObjectConstructParam *construct_params)
1630 object = (GObject*) g_type_create_instance (type);
1632 /* set construction parameters */
1633 if (n_construct_properties)
1635 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1637 /* set construct properties */
1638 while (n_construct_properties--)
1640 GValue *value = construct_params->value;
1641 GParamSpec *pspec = construct_params->pspec;
1644 object_set_property (object, pspec, value, nqueue);
1646 g_object_notify_queue_thaw (object, nqueue);
1647 /* the notification queue is still frozen from g_object_init(), so
1648 * we don't need to handle it here, g_object_newv() takes
1657 g_object_constructed (GObject *object)
1659 /* empty default impl to allow unconditional upchaining */
1663 * g_object_set_valist: (skip)
1664 * @object: a #GObject
1665 * @first_property_name: name of the first property to set
1666 * @var_args: value for the first property, followed optionally by more
1667 * name/value pairs, followed by %NULL
1669 * Sets properties on an object.
1672 g_object_set_valist (GObject *object,
1673 const gchar *first_property_name,
1676 GObjectNotifyQueue *nqueue;
1679 g_return_if_fail (G_IS_OBJECT (object));
1681 g_object_ref (object);
1682 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1684 name = first_property_name;
1687 GValue value = { 0, };
1689 gchar *error = NULL;
1691 pspec = g_param_spec_pool_lookup (pspec_pool,
1693 G_OBJECT_TYPE (object),
1697 g_warning ("%s: object class `%s' has no property named `%s'",
1699 G_OBJECT_TYPE_NAME (object),
1703 if (!(pspec->flags & G_PARAM_WRITABLE))
1705 g_warning ("%s: property `%s' of object class `%s' is not writable",
1708 G_OBJECT_TYPE_NAME (object));
1711 if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
1713 g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
1714 G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
1718 G_VALUE_COLLECT_INIT (&value, pspec->value_type, var_args,
1722 g_warning ("%s: %s", G_STRFUNC, error);
1724 g_value_unset (&value);
1728 object_set_property (object, pspec, &value, nqueue);
1729 g_value_unset (&value);
1731 name = va_arg (var_args, gchar*);
1734 g_object_notify_queue_thaw (object, nqueue);
1735 g_object_unref (object);
1739 * g_object_get_valist: (skip)
1740 * @object: a #GObject
1741 * @first_property_name: name of the first property to get
1742 * @var_args: return location for the first property, followed optionally by more
1743 * name/return location pairs, followed by %NULL
1745 * Gets properties of an object.
1747 * In general, a copy is made of the property contents and the caller
1748 * is responsible for freeing the memory in the appropriate manner for
1749 * the type, for instance by calling g_free() or g_object_unref().
1751 * See g_object_get().
1754 g_object_get_valist (GObject *object,
1755 const gchar *first_property_name,
1760 g_return_if_fail (G_IS_OBJECT (object));
1762 g_object_ref (object);
1764 name = first_property_name;
1768 GValue value = { 0, };
1772 pspec = g_param_spec_pool_lookup (pspec_pool,
1774 G_OBJECT_TYPE (object),
1778 g_warning ("%s: object class `%s' has no property named `%s'",
1780 G_OBJECT_TYPE_NAME (object),
1784 if (!(pspec->flags & G_PARAM_READABLE))
1786 g_warning ("%s: property `%s' of object class `%s' is not readable",
1789 G_OBJECT_TYPE_NAME (object));
1793 g_value_init (&value, pspec->value_type);
1795 object_get_property (object, pspec, &value);
1797 G_VALUE_LCOPY (&value, var_args, 0, &error);
1800 g_warning ("%s: %s", G_STRFUNC, error);
1802 g_value_unset (&value);
1806 g_value_unset (&value);
1808 name = va_arg (var_args, gchar*);
1811 g_object_unref (object);
1815 * g_object_set: (skip)
1816 * @object: a #GObject
1817 * @first_property_name: name of the first property to set
1818 * @...: value for the first property, followed optionally by more
1819 * name/value pairs, followed by %NULL
1821 * Sets properties on an object.
1824 g_object_set (gpointer _object,
1825 const gchar *first_property_name,
1828 GObject *object = _object;
1831 g_return_if_fail (G_IS_OBJECT (object));
1833 va_start (var_args, first_property_name);
1834 g_object_set_valist (object, first_property_name, var_args);
1839 * g_object_get: (skip)
1840 * @object: a #GObject
1841 * @first_property_name: name of the first property to get
1842 * @...: return location for the first property, followed optionally by more
1843 * name/return location pairs, followed by %NULL
1845 * Gets properties of an object.
1847 * In general, a copy is made of the property contents and the caller
1848 * is responsible for freeing the memory in the appropriate manner for
1849 * the type, for instance by calling g_free() or g_object_unref().
1852 * <title>Using g_object_get(<!-- -->)</title>
1853 * An example of using g_object_get() to get the contents
1854 * of three properties - one of type #G_TYPE_INT,
1855 * one of type #G_TYPE_STRING, and one of type #G_TYPE_OBJECT:
1861 * g_object_get (my_object,
1862 * "int-property", &intval,
1863 * "str-property", &strval,
1864 * "obj-property", &objval,
1867 * // Do something with intval, strval, objval
1870 * g_object_unref (objval);
1875 g_object_get (gpointer _object,
1876 const gchar *first_property_name,
1879 GObject *object = _object;
1882 g_return_if_fail (G_IS_OBJECT (object));
1884 va_start (var_args, first_property_name);
1885 g_object_get_valist (object, first_property_name, var_args);
1890 * g_object_set_property:
1891 * @object: a #GObject
1892 * @property_name: the name of the property to set
1895 * Sets a property on an object.
1898 g_object_set_property (GObject *object,
1899 const gchar *property_name,
1900 const GValue *value)
1902 GObjectNotifyQueue *nqueue;
1905 g_return_if_fail (G_IS_OBJECT (object));
1906 g_return_if_fail (property_name != NULL);
1907 g_return_if_fail (G_IS_VALUE (value));
1909 g_object_ref (object);
1910 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1912 pspec = g_param_spec_pool_lookup (pspec_pool,
1914 G_OBJECT_TYPE (object),
1917 g_warning ("%s: object class `%s' has no property named `%s'",
1919 G_OBJECT_TYPE_NAME (object),
1921 else if (!(pspec->flags & G_PARAM_WRITABLE))
1922 g_warning ("%s: property `%s' of object class `%s' is not writable",
1925 G_OBJECT_TYPE_NAME (object));
1926 else if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
1927 g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
1928 G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
1930 object_set_property (object, pspec, value, nqueue);
1932 g_object_notify_queue_thaw (object, nqueue);
1933 g_object_unref (object);
1937 * g_object_get_property:
1938 * @object: a #GObject
1939 * @property_name: the name of the property to get
1940 * @value: return location for the property value
1942 * Gets a property of an object. @value must have been initialized to the
1943 * expected type of the property (or a type to which the expected type can be
1944 * transformed) using g_value_init().
1946 * In general, a copy is made of the property contents and the caller is
1947 * responsible for freeing the memory by calling g_value_unset().
1949 * Note that g_object_get_property() is really intended for language
1950 * bindings, g_object_get() is much more convenient for C programming.
1953 g_object_get_property (GObject *object,
1954 const gchar *property_name,
1959 g_return_if_fail (G_IS_OBJECT (object));
1960 g_return_if_fail (property_name != NULL);
1961 g_return_if_fail (G_IS_VALUE (value));
1963 g_object_ref (object);
1965 pspec = g_param_spec_pool_lookup (pspec_pool,
1967 G_OBJECT_TYPE (object),
1970 g_warning ("%s: object class `%s' has no property named `%s'",
1972 G_OBJECT_TYPE_NAME (object),
1974 else if (!(pspec->flags & G_PARAM_READABLE))
1975 g_warning ("%s: property `%s' of object class `%s' is not readable",
1978 G_OBJECT_TYPE_NAME (object));
1981 GValue *prop_value, tmp_value = { 0, };
1983 /* auto-conversion of the callers value type
1985 if (G_VALUE_TYPE (value) == pspec->value_type)
1987 g_value_reset (value);
1990 else if (!g_value_type_transformable (pspec->value_type, G_VALUE_TYPE (value)))
1992 g_warning ("%s: can't retrieve property `%s' of type `%s' as value of type `%s'",
1993 G_STRFUNC, pspec->name,
1994 g_type_name (pspec->value_type),
1995 G_VALUE_TYPE_NAME (value));
1996 g_object_unref (object);
2001 g_value_init (&tmp_value, pspec->value_type);
2002 prop_value = &tmp_value;
2004 object_get_property (object, pspec, prop_value);
2005 if (prop_value != value)
2007 g_value_transform (prop_value, value);
2008 g_value_unset (&tmp_value);
2012 g_object_unref (object);
2016 * g_object_connect: (skip)
2017 * @object: a #GObject
2018 * @signal_spec: the spec for the first signal
2019 * @...: #GCallback for the first signal, followed by data for the
2020 * first signal, followed optionally by more signal
2021 * spec/callback/data triples, followed by %NULL
2023 * A convenience function to connect multiple signals at once.
2025 * The signal specs expected by this function have the form
2026 * "modifier::signal_name", where modifier can be one of the following:
2029 * <term>signal</term>
2031 * equivalent to <literal>g_signal_connect_data (..., NULL, 0)</literal>
2032 * </para></listitem>
2035 * <term>object_signal</term>
2036 * <term>object-signal</term>
2038 * equivalent to <literal>g_signal_connect_object (..., 0)</literal>
2039 * </para></listitem>
2042 * <term>swapped_signal</term>
2043 * <term>swapped-signal</term>
2045 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)</literal>
2046 * </para></listitem>
2049 * <term>swapped_object_signal</term>
2050 * <term>swapped-object-signal</term>
2052 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED)</literal>
2053 * </para></listitem>
2056 * <term>signal_after</term>
2057 * <term>signal-after</term>
2059 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_AFTER)</literal>
2060 * </para></listitem>
2063 * <term>object_signal_after</term>
2064 * <term>object-signal-after</term>
2066 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_AFTER)</literal>
2067 * </para></listitem>
2070 * <term>swapped_signal_after</term>
2071 * <term>swapped-signal-after</term>
2073 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2074 * </para></listitem>
2077 * <term>swapped_object_signal_after</term>
2078 * <term>swapped-object-signal-after</term>
2080 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2081 * </para></listitem>
2086 * menu->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
2087 * "type", GTK_WINDOW_POPUP,
2090 * "signal::event", gtk_menu_window_event, menu,
2091 * "signal::size_request", gtk_menu_window_size_request, menu,
2092 * "signal::destroy", gtk_widget_destroyed, &menu->toplevel,
2096 * Returns: (transfer none): @object
2099 g_object_connect (gpointer _object,
2100 const gchar *signal_spec,
2103 GObject *object = _object;
2106 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2107 g_return_val_if_fail (object->ref_count > 0, object);
2109 va_start (var_args, signal_spec);
2112 GCallback callback = va_arg (var_args, GCallback);
2113 gpointer data = va_arg (var_args, gpointer);
2115 if (strncmp (signal_spec, "signal::", 8) == 0)
2116 g_signal_connect_data (object, signal_spec + 8,
2117 callback, data, NULL,
2119 else if (strncmp (signal_spec, "object_signal::", 15) == 0 ||
2120 strncmp (signal_spec, "object-signal::", 15) == 0)
2121 g_signal_connect_object (object, signal_spec + 15,
2124 else if (strncmp (signal_spec, "swapped_signal::", 16) == 0 ||
2125 strncmp (signal_spec, "swapped-signal::", 16) == 0)
2126 g_signal_connect_data (object, signal_spec + 16,
2127 callback, data, NULL,
2129 else if (strncmp (signal_spec, "swapped_object_signal::", 23) == 0 ||
2130 strncmp (signal_spec, "swapped-object-signal::", 23) == 0)
2131 g_signal_connect_object (object, signal_spec + 23,
2134 else if (strncmp (signal_spec, "signal_after::", 14) == 0 ||
2135 strncmp (signal_spec, "signal-after::", 14) == 0)
2136 g_signal_connect_data (object, signal_spec + 14,
2137 callback, data, NULL,
2139 else if (strncmp (signal_spec, "object_signal_after::", 21) == 0 ||
2140 strncmp (signal_spec, "object-signal-after::", 21) == 0)
2141 g_signal_connect_object (object, signal_spec + 21,
2144 else if (strncmp (signal_spec, "swapped_signal_after::", 22) == 0 ||
2145 strncmp (signal_spec, "swapped-signal-after::", 22) == 0)
2146 g_signal_connect_data (object, signal_spec + 22,
2147 callback, data, NULL,
2148 G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2149 else if (strncmp (signal_spec, "swapped_object_signal_after::", 29) == 0 ||
2150 strncmp (signal_spec, "swapped-object-signal-after::", 29) == 0)
2151 g_signal_connect_object (object, signal_spec + 29,
2153 G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2156 g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2159 signal_spec = va_arg (var_args, gchar*);
2167 * g_object_disconnect: (skip)
2168 * @object: a #GObject
2169 * @signal_spec: the spec for the first signal
2170 * @...: #GCallback for the first signal, followed by data for the first signal,
2171 * followed optionally by more signal spec/callback/data triples,
2174 * A convenience function to disconnect multiple signals at once.
2176 * The signal specs expected by this function have the form
2177 * "any_signal", which means to disconnect any signal with matching
2178 * callback and data, or "any_signal::signal_name", which only
2179 * disconnects the signal named "signal_name".
2182 g_object_disconnect (gpointer _object,
2183 const gchar *signal_spec,
2186 GObject *object = _object;
2189 g_return_if_fail (G_IS_OBJECT (object));
2190 g_return_if_fail (object->ref_count > 0);
2192 va_start (var_args, signal_spec);
2195 GCallback callback = va_arg (var_args, GCallback);
2196 gpointer data = va_arg (var_args, gpointer);
2197 guint sid = 0, detail = 0, mask = 0;
2199 if (strncmp (signal_spec, "any_signal::", 12) == 0 ||
2200 strncmp (signal_spec, "any-signal::", 12) == 0)
2203 mask = G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2205 else if (strcmp (signal_spec, "any_signal") == 0 ||
2206 strcmp (signal_spec, "any-signal") == 0)
2209 mask = G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2213 g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2217 if ((mask & G_SIGNAL_MATCH_ID) &&
2218 !g_signal_parse_name (signal_spec, G_OBJECT_TYPE (object), &sid, &detail, FALSE))
2219 g_warning ("%s: invalid signal name \"%s\"", G_STRFUNC, signal_spec);
2220 else if (!g_signal_handlers_disconnect_matched (object, mask | (detail ? G_SIGNAL_MATCH_DETAIL : 0),
2222 NULL, (gpointer)callback, data))
2223 g_warning ("%s: signal handler %p(%p) is not connected", G_STRFUNC, callback, data);
2224 signal_spec = va_arg (var_args, gchar*);
2235 } weak_refs[1]; /* flexible array */
2239 weak_refs_notify (gpointer data)
2241 WeakRefStack *wstack = data;
2244 for (i = 0; i < wstack->n_weak_refs; i++)
2245 wstack->weak_refs[i].notify (wstack->weak_refs[i].data, wstack->object);
2250 * g_object_weak_ref: (skip)
2251 * @object: #GObject to reference weakly
2252 * @notify: callback to invoke before the object is freed
2253 * @data: extra data to pass to notify
2255 * Adds a weak reference callback to an object. Weak references are
2256 * used for notification when an object is finalized. They are called
2257 * "weak references" because they allow you to safely hold a pointer
2258 * to an object without calling g_object_ref() (g_object_ref() adds a
2259 * strong reference, that is, forces the object to stay alive).
2262 g_object_weak_ref (GObject *object,
2266 WeakRefStack *wstack;
2269 g_return_if_fail (G_IS_OBJECT (object));
2270 g_return_if_fail (notify != NULL);
2271 g_return_if_fail (object->ref_count >= 1);
2273 G_LOCK (weak_refs_mutex);
2274 wstack = g_datalist_id_remove_no_notify (&object->qdata, quark_weak_refs);
2277 i = wstack->n_weak_refs++;
2278 wstack = g_realloc (wstack, sizeof (*wstack) + sizeof (wstack->weak_refs[0]) * i);
2282 wstack = g_renew (WeakRefStack, NULL, 1);
2283 wstack->object = object;
2284 wstack->n_weak_refs = 1;
2287 wstack->weak_refs[i].notify = notify;
2288 wstack->weak_refs[i].data = data;
2289 g_datalist_id_set_data_full (&object->qdata, quark_weak_refs, wstack, weak_refs_notify);
2290 G_UNLOCK (weak_refs_mutex);
2294 * g_object_weak_unref: (skip)
2295 * @object: #GObject to remove a weak reference from
2296 * @notify: callback to search for
2297 * @data: data to search for
2299 * Removes a weak reference callback to an object.
2302 g_object_weak_unref (GObject *object,
2306 WeakRefStack *wstack;
2307 gboolean found_one = FALSE;
2309 g_return_if_fail (G_IS_OBJECT (object));
2310 g_return_if_fail (notify != NULL);
2312 G_LOCK (weak_refs_mutex);
2313 wstack = g_datalist_id_get_data (&object->qdata, quark_weak_refs);
2318 for (i = 0; i < wstack->n_weak_refs; i++)
2319 if (wstack->weak_refs[i].notify == notify &&
2320 wstack->weak_refs[i].data == data)
2323 wstack->n_weak_refs -= 1;
2324 if (i != wstack->n_weak_refs)
2325 wstack->weak_refs[i] = wstack->weak_refs[wstack->n_weak_refs];
2330 G_UNLOCK (weak_refs_mutex);
2332 g_warning ("%s: couldn't find weak ref %p(%p)", G_STRFUNC, notify, data);
2336 * g_object_add_weak_pointer: (skip)
2337 * @object: The object that should be weak referenced.
2338 * @weak_pointer_location: (inout): The memory address of a pointer.
2340 * Adds a weak reference from weak_pointer to @object to indicate that
2341 * the pointer located at @weak_pointer_location is only valid during
2342 * the lifetime of @object. When the @object is finalized,
2343 * @weak_pointer will be set to %NULL.
2346 g_object_add_weak_pointer (GObject *object,
2347 gpointer *weak_pointer_location)
2349 g_return_if_fail (G_IS_OBJECT (object));
2350 g_return_if_fail (weak_pointer_location != NULL);
2352 g_object_weak_ref (object,
2353 (GWeakNotify) g_nullify_pointer,
2354 weak_pointer_location);
2358 * g_object_remove_weak_pointer: (skip)
2359 * @object: The object that is weak referenced.
2360 * @weak_pointer_location: (inout): The memory address of a pointer.
2362 * Removes a weak reference from @object that was previously added
2363 * using g_object_add_weak_pointer(). The @weak_pointer_location has
2364 * to match the one used with g_object_add_weak_pointer().
2367 g_object_remove_weak_pointer (GObject *object,
2368 gpointer *weak_pointer_location)
2370 g_return_if_fail (G_IS_OBJECT (object));
2371 g_return_if_fail (weak_pointer_location != NULL);
2373 g_object_weak_unref (object,
2374 (GWeakNotify) g_nullify_pointer,
2375 weak_pointer_location);
2379 object_floating_flag_handler (GObject *object,
2385 case +1: /* force floating if possible */
2387 oldvalue = g_atomic_pointer_get (&object->qdata);
2388 while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2389 (gpointer) ((gsize) oldvalue | OBJECT_FLOATING_FLAG)));
2390 return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2391 case -1: /* sink if possible */
2393 oldvalue = g_atomic_pointer_get (&object->qdata);
2394 while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2395 (gpointer) ((gsize) oldvalue & ~(gsize) OBJECT_FLOATING_FLAG)));
2396 return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2397 default: /* check floating */
2398 return 0 != ((gsize) g_atomic_pointer_get (&object->qdata) & OBJECT_FLOATING_FLAG);
2403 * g_object_is_floating:
2404 * @object: (type GObject.Object): a #GObject
2406 * Checks whether @object has a <link linkend="floating-ref">floating</link>
2411 * Returns: %TRUE if @object has a floating reference
2414 g_object_is_floating (gpointer _object)
2416 GObject *object = _object;
2417 g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
2418 return floating_flag_handler (object, 0);
2422 * g_object_ref_sink:
2423 * @object: (type GObject.Object): a #GObject
2425 * Increase the reference count of @object, and possibly remove the
2426 * <link linkend="floating-ref">floating</link> reference, if @object
2427 * has a floating reference.
2429 * In other words, if the object is floating, then this call "assumes
2430 * ownership" of the floating reference, converting it to a normal
2431 * reference by clearing the floating flag while leaving the reference
2432 * count unchanged. If the object is not floating, then this call
2433 * adds a new normal reference increasing the reference count by one.
2437 * Returns: (type GObject.Object) (transfer none): @object
2440 g_object_ref_sink (gpointer _object)
2442 GObject *object = _object;
2443 gboolean was_floating;
2444 g_return_val_if_fail (G_IS_OBJECT (object), object);
2445 g_return_val_if_fail (object->ref_count >= 1, object);
2446 g_object_ref (object);
2447 was_floating = floating_flag_handler (object, -1);
2449 g_object_unref (object);
2454 * g_object_force_floating:
2455 * @object: a #GObject
2457 * This function is intended for #GObject implementations to re-enforce a
2458 * <link linkend="floating-ref">floating</link> object reference.
2459 * Doing this is seldomly required: all
2460 * #GInitiallyUnowned<!-- -->s are created with a floating reference which
2461 * usually just needs to be sunken by calling g_object_ref_sink().
2466 g_object_force_floating (GObject *object)
2468 g_return_if_fail (G_IS_OBJECT (object));
2469 g_return_if_fail (object->ref_count >= 1);
2471 floating_flag_handler (object, +1);
2476 guint n_toggle_refs;
2478 GToggleNotify notify;
2480 } toggle_refs[1]; /* flexible array */
2484 toggle_refs_notify (GObject *object,
2485 gboolean is_last_ref)
2487 ToggleRefStack tstack, *tstackptr;
2489 G_LOCK (toggle_refs_mutex);
2490 tstackptr = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2491 tstack = *tstackptr;
2492 G_UNLOCK (toggle_refs_mutex);
2494 /* Reentrancy here is not as tricky as it seems, because a toggle reference
2495 * will only be notified when there is exactly one of them.
2497 g_assert (tstack.n_toggle_refs == 1);
2498 tstack.toggle_refs[0].notify (tstack.toggle_refs[0].data, tstack.object, is_last_ref);
2502 * g_object_add_toggle_ref: (skip)
2503 * @object: a #GObject
2504 * @notify: a function to call when this reference is the
2505 * last reference to the object, or is no longer
2506 * the last reference.
2507 * @data: data to pass to @notify
2509 * Increases the reference count of the object by one and sets a
2510 * callback to be called when all other references to the object are
2511 * dropped, or when this is already the last reference to the object
2512 * and another reference is established.
2514 * This functionality is intended for binding @object to a proxy
2515 * object managed by another memory manager. This is done with two
2516 * paired references: the strong reference added by
2517 * g_object_add_toggle_ref() and a reverse reference to the proxy
2518 * object which is either a strong reference or weak reference.
2520 * The setup is that when there are no other references to @object,
2521 * only a weak reference is held in the reverse direction from @object
2522 * to the proxy object, but when there are other references held to
2523 * @object, a strong reference is held. The @notify callback is called
2524 * when the reference from @object to the proxy object should be
2525 * <firstterm>toggled</firstterm> from strong to weak (@is_last_ref
2526 * true) or weak to strong (@is_last_ref false).
2528 * Since a (normal) reference must be held to the object before
2529 * calling g_object_toggle_ref(), the initial state of the reverse
2530 * link is always strong.
2532 * Multiple toggle references may be added to the same gobject,
2533 * however if there are multiple toggle references to an object, none
2534 * of them will ever be notified until all but one are removed. For
2535 * this reason, you should only ever use a toggle reference if there
2536 * is important state in the proxy object.
2541 g_object_add_toggle_ref (GObject *object,
2542 GToggleNotify notify,
2545 ToggleRefStack *tstack;
2548 g_return_if_fail (G_IS_OBJECT (object));
2549 g_return_if_fail (notify != NULL);
2550 g_return_if_fail (object->ref_count >= 1);
2552 g_object_ref (object);
2554 G_LOCK (toggle_refs_mutex);
2555 tstack = g_datalist_id_remove_no_notify (&object->qdata, quark_toggle_refs);
2558 i = tstack->n_toggle_refs++;
2559 /* allocate i = tstate->n_toggle_refs - 1 positions beyond the 1 declared
2560 * in tstate->toggle_refs */
2561 tstack = g_realloc (tstack, sizeof (*tstack) + sizeof (tstack->toggle_refs[0]) * i);
2565 tstack = g_renew (ToggleRefStack, NULL, 1);
2566 tstack->object = object;
2567 tstack->n_toggle_refs = 1;
2571 /* Set a flag for fast lookup after adding the first toggle reference */
2572 if (tstack->n_toggle_refs == 1)
2573 g_datalist_set_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2575 tstack->toggle_refs[i].notify = notify;
2576 tstack->toggle_refs[i].data = data;
2577 g_datalist_id_set_data_full (&object->qdata, quark_toggle_refs, tstack,
2578 (GDestroyNotify)g_free);
2579 G_UNLOCK (toggle_refs_mutex);
2583 * g_object_remove_toggle_ref: (skip)
2584 * @object: a #GObject
2585 * @notify: a function to call when this reference is the
2586 * last reference to the object, or is no longer
2587 * the last reference.
2588 * @data: data to pass to @notify
2590 * Removes a reference added with g_object_add_toggle_ref(). The
2591 * reference count of the object is decreased by one.
2596 g_object_remove_toggle_ref (GObject *object,
2597 GToggleNotify notify,
2600 ToggleRefStack *tstack;
2601 gboolean found_one = FALSE;
2603 g_return_if_fail (G_IS_OBJECT (object));
2604 g_return_if_fail (notify != NULL);
2606 G_LOCK (toggle_refs_mutex);
2607 tstack = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2612 for (i = 0; i < tstack->n_toggle_refs; i++)
2613 if (tstack->toggle_refs[i].notify == notify &&
2614 tstack->toggle_refs[i].data == data)
2617 tstack->n_toggle_refs -= 1;
2618 if (i != tstack->n_toggle_refs)
2619 tstack->toggle_refs[i] = tstack->toggle_refs[tstack->n_toggle_refs];
2621 if (tstack->n_toggle_refs == 0)
2622 g_datalist_unset_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2627 G_UNLOCK (toggle_refs_mutex);
2630 g_object_unref (object);
2632 g_warning ("%s: couldn't find toggle ref %p(%p)", G_STRFUNC, notify, data);
2637 * @object: (type GObject.Object): a #GObject
2639 * Increases the reference count of @object.
2641 * Returns: (type GObject.Object) (transfer none): the same @object
2644 g_object_ref (gpointer _object)
2646 GObject *object = _object;
2649 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2650 g_return_val_if_fail (object->ref_count > 0, NULL);
2652 #ifdef G_ENABLE_DEBUG
2653 if (g_trap_object_ref == object)
2655 #endif /* G_ENABLE_DEBUG */
2658 old_val = g_atomic_int_add (&object->ref_count, 1);
2660 if (old_val == 1 && OBJECT_HAS_TOGGLE_REF (object))
2661 toggle_refs_notify (object, FALSE);
2663 TRACE (GOBJECT_OBJECT_REF(object,G_TYPE_FROM_INSTANCE(object),old_val));
2670 * @object: (type GObject.Object): a #GObject
2672 * Decreases the reference count of @object. When its reference count
2673 * drops to 0, the object is finalized (i.e. its memory is freed).
2676 g_object_unref (gpointer _object)
2678 GObject *object = _object;
2681 g_return_if_fail (G_IS_OBJECT (object));
2682 g_return_if_fail (object->ref_count > 0);
2684 #ifdef G_ENABLE_DEBUG
2685 if (g_trap_object_ref == object)
2687 #endif /* G_ENABLE_DEBUG */
2689 /* here we want to atomically do: if (ref_count>1) { ref_count--; return; } */
2690 retry_atomic_decrement1:
2691 old_ref = g_atomic_int_get (&object->ref_count);
2694 /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2695 gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2697 if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2698 goto retry_atomic_decrement1;
2700 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2702 /* if we went from 2->1 we need to notify toggle refs if any */
2703 if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2704 toggle_refs_notify (object, TRUE);
2708 /* we are about tp remove the last reference */
2709 TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 1));
2710 G_OBJECT_GET_CLASS (object)->dispose (object);
2711 TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 1));
2713 /* may have been re-referenced meanwhile */
2714 retry_atomic_decrement2:
2715 old_ref = g_atomic_int_get ((int *)&object->ref_count);
2718 /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2719 gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2721 if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2722 goto retry_atomic_decrement2;
2724 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2726 /* if we went from 2->1 we need to notify toggle refs if any */
2727 if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2728 toggle_refs_notify (object, TRUE);
2733 /* we are still in the process of taking away the last ref */
2734 g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
2735 g_signal_handlers_destroy (object);
2736 g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
2738 /* decrement the last reference */
2739 old_ref = g_atomic_int_add (&object->ref_count, -1);
2741 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2743 /* may have been re-referenced meanwhile */
2744 if (G_LIKELY (old_ref == 1))
2746 TRACE (GOBJECT_OBJECT_FINALIZE(object,G_TYPE_FROM_INSTANCE(object)));
2747 G_OBJECT_GET_CLASS (object)->finalize (object);
2749 TRACE (GOBJECT_OBJECT_FINALIZE_END(object,G_TYPE_FROM_INSTANCE(object)));
2751 #ifdef G_ENABLE_DEBUG
2754 /* catch objects not chaining finalize handlers */
2755 G_LOCK (debug_objects);
2756 g_assert (g_hash_table_lookup (debug_objects_ht, object) == NULL);
2757 G_UNLOCK (debug_objects);
2759 #endif /* G_ENABLE_DEBUG */
2760 g_type_free_instance ((GTypeInstance*) object);
2766 * g_clear_object: (skip)
2767 * @object_ptr: a pointer to a #GObject reference
2769 * Clears a reference to a #GObject.
2771 * @object_ptr must not be %NULL.
2773 * If the reference is %NULL then this function does nothing.
2774 * Otherwise, the reference count of the object is decreased and the
2775 * pointer is set to %NULL.
2777 * This function is threadsafe and modifies the pointer atomically,
2778 * using memory barriers where needed.
2780 * A macro is also included that allows this function to be used without
2785 #undef g_clear_object
2787 g_clear_object (volatile GObject **object_ptr)
2789 gpointer *ptr = (gpointer) object_ptr;
2792 /* This is a little frustrating.
2793 * Would be nice to have an atomic exchange (with no compare).
2796 old = g_atomic_pointer_get (ptr);
2797 while G_UNLIKELY (!g_atomic_pointer_compare_and_exchange (ptr, old, NULL));
2800 g_object_unref (old);
2804 * g_object_get_qdata:
2805 * @object: The GObject to get a stored user data pointer from
2806 * @quark: A #GQuark, naming the user data pointer
2808 * This function gets back user data pointers stored via
2809 * g_object_set_qdata().
2811 * Returns: (transfer none): The user data pointer set, or %NULL
2814 g_object_get_qdata (GObject *object,
2817 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2819 return quark ? g_datalist_id_get_data (&object->qdata, quark) : NULL;
2823 * g_object_set_qdata: (skip)
2824 * @object: The GObject to set store a user data pointer
2825 * @quark: A #GQuark, naming the user data pointer
2826 * @data: An opaque user data pointer
2828 * This sets an opaque, named pointer on an object.
2829 * The name is specified through a #GQuark (retrived e.g. via
2830 * g_quark_from_static_string()), and the pointer
2831 * can be gotten back from the @object with g_object_get_qdata()
2832 * until the @object is finalized.
2833 * Setting a previously set user data pointer, overrides (frees)
2834 * the old pointer set, using #NULL as pointer essentially
2835 * removes the data stored.
2838 g_object_set_qdata (GObject *object,
2842 g_return_if_fail (G_IS_OBJECT (object));
2843 g_return_if_fail (quark > 0);
2845 g_datalist_id_set_data (&object->qdata, quark, data);
2849 * g_object_set_qdata_full: (skip)
2850 * @object: The GObject to set store a user data pointer
2851 * @quark: A #GQuark, naming the user data pointer
2852 * @data: An opaque user data pointer
2853 * @destroy: Function to invoke with @data as argument, when @data
2856 * This function works like g_object_set_qdata(), but in addition,
2857 * a void (*destroy) (gpointer) function may be specified which is
2858 * called with @data as argument when the @object is finalized, or
2859 * the data is being overwritten by a call to g_object_set_qdata()
2860 * with the same @quark.
2863 g_object_set_qdata_full (GObject *object,
2866 GDestroyNotify destroy)
2868 g_return_if_fail (G_IS_OBJECT (object));
2869 g_return_if_fail (quark > 0);
2871 g_datalist_id_set_data_full (&object->qdata, quark, data,
2872 data ? destroy : (GDestroyNotify) NULL);
2876 * g_object_steal_qdata:
2877 * @object: The GObject to get a stored user data pointer from
2878 * @quark: A #GQuark, naming the user data pointer
2880 * This function gets back user data pointers stored via
2881 * g_object_set_qdata() and removes the @data from object
2882 * without invoking its destroy() function (if any was
2884 * Usually, calling this function is only required to update
2885 * user data pointers with a destroy notifier, for example:
2888 * object_add_to_user_list (GObject *object,
2889 * const gchar *new_string)
2891 * // the quark, naming the object data
2892 * GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
2893 * // retrive the old string list
2894 * GList *list = g_object_steal_qdata (object, quark_string_list);
2896 * // prepend new string
2897 * list = g_list_prepend (list, g_strdup (new_string));
2898 * // this changed 'list', so we need to set it again
2899 * g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
2902 * free_string_list (gpointer data)
2904 * GList *node, *list = data;
2906 * for (node = list; node; node = node->next)
2907 * g_free (node->data);
2908 * g_list_free (list);
2911 * Using g_object_get_qdata() in the above example, instead of
2912 * g_object_steal_qdata() would have left the destroy function set,
2913 * and thus the partial string list would have been freed upon
2914 * g_object_set_qdata_full().
2916 * Returns: (transfer full): The user data pointer set, or %NULL
2919 g_object_steal_qdata (GObject *object,
2922 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2923 g_return_val_if_fail (quark > 0, NULL);
2925 return g_datalist_id_remove_no_notify (&object->qdata, quark);
2929 * g_object_get_data:
2930 * @object: #GObject containing the associations
2931 * @key: name of the key for that association
2933 * Gets a named field from the objects table of associations (see g_object_set_data()).
2935 * Returns: (transfer none): the data if found, or %NULL if no such data exists.
2938 g_object_get_data (GObject *object,
2943 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2944 g_return_val_if_fail (key != NULL, NULL);
2946 quark = g_quark_try_string (key);
2948 return quark ? g_datalist_id_get_data (&object->qdata, quark) : NULL;
2952 * g_object_set_data:
2953 * @object: #GObject containing the associations.
2954 * @key: name of the key
2955 * @data: data to associate with that key
2957 * Each object carries around a table of associations from
2958 * strings to pointers. This function lets you set an association.
2960 * If the object already had an association with that name,
2961 * the old association will be destroyed.
2964 g_object_set_data (GObject *object,
2968 g_return_if_fail (G_IS_OBJECT (object));
2969 g_return_if_fail (key != NULL);
2971 g_datalist_id_set_data (&object->qdata, g_quark_from_string (key), data);
2975 * g_object_set_data_full: (skip)
2976 * @object: #GObject containing the associations
2977 * @key: name of the key
2978 * @data: data to associate with that key
2979 * @destroy: function to call when the association is destroyed
2981 * Like g_object_set_data() except it adds notification
2982 * for when the association is destroyed, either by setting it
2983 * to a different value or when the object is destroyed.
2985 * Note that the @destroy callback is not called if @data is %NULL.
2988 g_object_set_data_full (GObject *object,
2991 GDestroyNotify destroy)
2993 g_return_if_fail (G_IS_OBJECT (object));
2994 g_return_if_fail (key != NULL);
2996 g_datalist_id_set_data_full (&object->qdata, g_quark_from_string (key), data,
2997 data ? destroy : (GDestroyNotify) NULL);
3001 * g_object_steal_data:
3002 * @object: #GObject containing the associations
3003 * @key: name of the key
3005 * Remove a specified datum from the object's data associations,
3006 * without invoking the association's destroy handler.
3008 * Returns: (transfer full): the data if found, or %NULL if no such data exists.
3011 g_object_steal_data (GObject *object,
3016 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3017 g_return_val_if_fail (key != NULL, NULL);
3019 quark = g_quark_try_string (key);
3021 return quark ? g_datalist_id_remove_no_notify (&object->qdata, quark) : NULL;
3025 g_value_object_init (GValue *value)
3027 value->data[0].v_pointer = NULL;
3031 g_value_object_free_value (GValue *value)
3033 if (value->data[0].v_pointer)
3034 g_object_unref (value->data[0].v_pointer);
3038 g_value_object_copy_value (const GValue *src_value,
3041 if (src_value->data[0].v_pointer)
3042 dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3044 dest_value->data[0].v_pointer = NULL;
3048 g_value_object_transform_value (const GValue *src_value,
3051 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)))
3052 dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3054 dest_value->data[0].v_pointer = NULL;
3058 g_value_object_peek_pointer (const GValue *value)
3060 return value->data[0].v_pointer;
3064 g_value_object_collect_value (GValue *value,
3065 guint n_collect_values,
3066 GTypeCValue *collect_values,
3067 guint collect_flags)
3069 if (collect_values[0].v_pointer)
3071 GObject *object = collect_values[0].v_pointer;
3073 if (object->g_type_instance.g_class == NULL)
3074 return g_strconcat ("invalid unclassed object pointer for value type `",
3075 G_VALUE_TYPE_NAME (value),
3078 else if (!g_value_type_compatible (G_OBJECT_TYPE (object), G_VALUE_TYPE (value)))
3079 return g_strconcat ("invalid object type `",
3080 G_OBJECT_TYPE_NAME (object),
3081 "' for value type `",
3082 G_VALUE_TYPE_NAME (value),
3085 /* never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types */
3086 value->data[0].v_pointer = g_object_ref (object);
3089 value->data[0].v_pointer = NULL;
3095 g_value_object_lcopy_value (const GValue *value,
3096 guint n_collect_values,
3097 GTypeCValue *collect_values,
3098 guint collect_flags)
3100 GObject **object_p = collect_values[0].v_pointer;
3103 return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
3105 if (!value->data[0].v_pointer)
3107 else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
3108 *object_p = value->data[0].v_pointer;
3110 *object_p = g_object_ref (value->data[0].v_pointer);
3116 * g_value_set_object:
3117 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3118 * @v_object: (type GObject.Object): object value to be set
3120 * Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
3122 * g_value_set_object() increases the reference count of @v_object
3123 * (the #GValue holds a reference to @v_object). If you do not wish
3124 * to increase the reference count of the object (i.e. you wish to
3125 * pass your current reference to the #GValue because you no longer
3126 * need it), use g_value_take_object() instead.
3128 * It is important that your #GValue holds a reference to @v_object (either its
3129 * own, or one it has taken) to ensure that the object won't be destroyed while
3130 * the #GValue still exists).
3133 g_value_set_object (GValue *value,
3138 g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3140 old = value->data[0].v_pointer;
3144 g_return_if_fail (G_IS_OBJECT (v_object));
3145 g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3147 value->data[0].v_pointer = v_object;
3148 g_object_ref (value->data[0].v_pointer);
3151 value->data[0].v_pointer = NULL;
3154 g_object_unref (old);
3158 * g_value_set_object_take_ownership: (skip)
3159 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3160 * @v_object: object value to be set
3162 * This is an internal function introduced mainly for C marshallers.
3164 * Deprecated: 2.4: Use g_value_take_object() instead.
3167 g_value_set_object_take_ownership (GValue *value,
3170 g_value_take_object (value, v_object);
3174 * g_value_take_object: (skip)
3175 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3176 * @v_object: object value to be set
3178 * Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
3179 * and takes over the ownership of the callers reference to @v_object;
3180 * the caller doesn't have to unref it any more (i.e. the reference
3181 * count of the object is not increased).
3183 * If you want the #GValue to hold its own reference to @v_object, use
3184 * g_value_set_object() instead.
3189 g_value_take_object (GValue *value,
3192 g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3194 if (value->data[0].v_pointer)
3196 g_object_unref (value->data[0].v_pointer);
3197 value->data[0].v_pointer = NULL;
3202 g_return_if_fail (G_IS_OBJECT (v_object));
3203 g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3205 value->data[0].v_pointer = v_object; /* we take over the reference count */
3210 * g_value_get_object:
3211 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3213 * Get the contents of a %G_TYPE_OBJECT derived #GValue.
3215 * Returns: (type GObject.Object) (transfer none): object contents of @value
3218 g_value_get_object (const GValue *value)
3220 g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3222 return value->data[0].v_pointer;
3226 * g_value_dup_object:
3227 * @value: a valid #GValue whose type is derived from %G_TYPE_OBJECT
3229 * Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing
3230 * its reference count. If the contents of the #GValue are %NULL, then
3231 * %NULL will be returned.
3233 * Returns: (type GObject.Object) (transfer full): object content of @value,
3234 * should be unreferenced when no longer needed.
3237 g_value_dup_object (const GValue *value)
3239 g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3241 return value->data[0].v_pointer ? g_object_ref (value->data[0].v_pointer) : NULL;
3245 * g_signal_connect_object: (skip)
3246 * @instance: the instance to connect to.
3247 * @detailed_signal: a string of the form "signal-name::detail".
3248 * @c_handler: the #GCallback to connect.
3249 * @gobject: the object to pass as data to @c_handler.
3250 * @connect_flags: a combination of #GConnnectFlags.
3252 * This is similar to g_signal_connect_data(), but uses a closure which
3253 * ensures that the @gobject stays alive during the call to @c_handler
3254 * by temporarily adding a reference count to @gobject.
3256 * Note that there is a bug in GObject that makes this function
3257 * much less useful than it might seem otherwise. Once @gobject is
3258 * disposed, the callback will no longer be called, but, the signal
3259 * handler is <emphasis>not</emphasis> currently disconnected. If the
3260 * @instance is itself being freed at the same time than this doesn't
3261 * matter, since the signal will automatically be removed, but
3262 * if @instance persists, then the signal handler will leak. You
3263 * should not remove the signal yourself because in a future versions of
3264 * GObject, the handler <emphasis>will</emphasis> automatically
3267 * It's possible to work around this problem in a way that will
3268 * continue to work with future versions of GObject by checking
3269 * that the signal handler is still connected before disconnected it:
3270 * <informalexample><programlisting>
3271 * if (g_signal_handler_is_connected (instance, id))
3272 * g_signal_handler_disconnect (instance, id);
3273 * </programlisting></informalexample>
3275 * Returns: the handler id.
3278 g_signal_connect_object (gpointer instance,
3279 const gchar *detailed_signal,
3280 GCallback c_handler,
3282 GConnectFlags connect_flags)
3284 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
3285 g_return_val_if_fail (detailed_signal != NULL, 0);
3286 g_return_val_if_fail (c_handler != NULL, 0);
3292 g_return_val_if_fail (G_IS_OBJECT (gobject), 0);
3294 closure = ((connect_flags & G_CONNECT_SWAPPED) ? g_cclosure_new_object_swap : g_cclosure_new_object) (c_handler, gobject);
3296 return g_signal_connect_closure (instance, detailed_signal, closure, connect_flags & G_CONNECT_AFTER);
3299 return g_signal_connect_data (instance, detailed_signal, c_handler, NULL, NULL, connect_flags);
3305 GClosure *closures[1]; /* flexible array */
3307 /* don't change this structure without supplying an accessor for
3308 * watched closures, e.g.:
3309 * GSList* g_object_list_watched_closures (GObject *object)
3312 * g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3313 * carray = g_object_get_data (object, "GObject-closure-array");
3316 * GSList *slist = NULL;
3318 * for (i = 0; i < carray->n_closures; i++)
3319 * slist = g_slist_prepend (slist, carray->closures[i]);
3327 object_remove_closure (gpointer data,
3330 GObject *object = data;
3334 G_LOCK (closure_array_mutex);
3335 carray = g_object_get_qdata (object, quark_closure_array);
3336 for (i = 0; i < carray->n_closures; i++)
3337 if (carray->closures[i] == closure)
3339 carray->n_closures--;
3340 if (i < carray->n_closures)
3341 carray->closures[i] = carray->closures[carray->n_closures];
3342 G_UNLOCK (closure_array_mutex);
3345 G_UNLOCK (closure_array_mutex);
3346 g_assert_not_reached ();
3350 destroy_closure_array (gpointer data)
3352 CArray *carray = data;
3353 GObject *object = carray->object;
3354 guint i, n = carray->n_closures;
3356 for (i = 0; i < n; i++)
3358 GClosure *closure = carray->closures[i];
3360 /* removing object_remove_closure() upfront is probably faster than
3361 * letting it fiddle with quark_closure_array which is empty anyways
3363 g_closure_remove_invalidate_notifier (closure, object, object_remove_closure);
3364 g_closure_invalidate (closure);
3370 * g_object_watch_closure:
3371 * @object: GObject restricting lifetime of @closure
3372 * @closure: GClosure to watch
3374 * This function essentially limits the life time of the @closure to
3375 * the life time of the object. That is, when the object is finalized,
3376 * the @closure is invalidated by calling g_closure_invalidate() on
3377 * it, in order to prevent invocations of the closure with a finalized
3378 * (nonexisting) object. Also, g_object_ref() and g_object_unref() are
3379 * added as marshal guards to the @closure, to ensure that an extra
3380 * reference count is held on @object during invocation of the
3381 * @closure. Usually, this function will be called on closures that
3382 * use this @object as closure data.
3385 g_object_watch_closure (GObject *object,
3391 g_return_if_fail (G_IS_OBJECT (object));
3392 g_return_if_fail (closure != NULL);
3393 g_return_if_fail (closure->is_invalid == FALSE);
3394 g_return_if_fail (closure->in_marshal == FALSE);
3395 g_return_if_fail (object->ref_count > 0); /* this doesn't work on finalizing objects */
3397 g_closure_add_invalidate_notifier (closure, object, object_remove_closure);
3398 g_closure_add_marshal_guards (closure,
3399 object, (GClosureNotify) g_object_ref,
3400 object, (GClosureNotify) g_object_unref);
3401 G_LOCK (closure_array_mutex);
3402 carray = g_datalist_id_remove_no_notify (&object->qdata, quark_closure_array);
3405 carray = g_renew (CArray, NULL, 1);
3406 carray->object = object;
3407 carray->n_closures = 1;
3412 i = carray->n_closures++;
3413 carray = g_realloc (carray, sizeof (*carray) + sizeof (carray->closures[0]) * i);
3415 carray->closures[i] = closure;
3416 g_datalist_id_set_data_full (&object->qdata, quark_closure_array, carray, destroy_closure_array);
3417 G_UNLOCK (closure_array_mutex);
3421 * g_closure_new_object:
3422 * @sizeof_closure: the size of the structure to allocate, must be at least
3423 * <literal>sizeof (GClosure)</literal>
3424 * @object: a #GObject pointer to store in the @data field of the newly
3425 * allocated #GClosure
3427 * A variant of g_closure_new_simple() which stores @object in the
3428 * @data field of the closure and calls g_object_watch_closure() on
3429 * @object and the created closure. This function is mainly useful
3430 * when implementing new types of closures.
3432 * Returns: (transfer full): a newly allocated #GClosure
3435 g_closure_new_object (guint sizeof_closure,
3440 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3441 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3443 closure = g_closure_new_simple (sizeof_closure, object);
3444 g_object_watch_closure (object, closure);
3450 * g_cclosure_new_object: (skip)
3451 * @callback_func: the function to invoke
3452 * @object: a #GObject pointer to pass to @callback_func
3454 * A variant of g_cclosure_new() which uses @object as @user_data and
3455 * calls g_object_watch_closure() on @object and the created
3456 * closure. This function is useful when you have a callback closely
3457 * associated with a #GObject, and want the callback to no longer run
3458 * after the object is is freed.
3460 * Returns: a new #GCClosure
3463 g_cclosure_new_object (GCallback callback_func,
3468 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3469 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3470 g_return_val_if_fail (callback_func != NULL, NULL);
3472 closure = g_cclosure_new (callback_func, object, NULL);
3473 g_object_watch_closure (object, closure);
3479 * g_cclosure_new_object_swap: (skip)
3480 * @callback_func: the function to invoke
3481 * @object: a #GObject pointer to pass to @callback_func
3483 * A variant of g_cclosure_new_swap() which uses @object as @user_data
3484 * and calls g_object_watch_closure() on @object and the created
3485 * closure. This function is useful when you have a callback closely
3486 * associated with a #GObject, and want the callback to no longer run
3487 * after the object is is freed.
3489 * Returns: a new #GCClosure
3492 g_cclosure_new_object_swap (GCallback callback_func,
3497 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3498 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3499 g_return_val_if_fail (callback_func != NULL, NULL);
3501 closure = g_cclosure_new_swap (callback_func, object, NULL);
3502 g_object_watch_closure (object, closure);
3508 g_object_compat_control (gsize what,
3514 case 1: /* floating base type */
3515 return G_TYPE_INITIALLY_UNOWNED;
3516 case 2: /* FIXME: remove this once GLib/Gtk+ break ABI again */
3517 floating_flag_handler = (guint(*)(GObject*,gint)) data;
3519 case 3: /* FIXME: remove this once GLib/Gtk+ break ABI again */
3521 *pp = floating_flag_handler;
3528 G_DEFINE_TYPE (GInitiallyUnowned, g_initially_unowned, G_TYPE_OBJECT);
3531 g_initially_unowned_init (GInitiallyUnowned *object)
3533 g_object_force_floating (object);
3537 g_initially_unowned_class_init (GInitiallyUnownedClass *klass)