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) should not
83 * 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 achieve this,
88 * the 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_object_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_sink (pspec);
408 PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
409 g_param_spec_pool_insert (pspec_pool, pspec, g_type);
413 * g_object_class_install_property:
414 * @oclass: a #GObjectClass
415 * @property_id: the id for the new property
416 * @pspec: the #GParamSpec for the new property
418 * Installs a new property. This is usually done in the class initializer.
420 * Note that it is possible to redefine a property in a derived class,
421 * by installing a property with the same name. This can be useful at times,
422 * e.g. to change the range of allowed values or the default value.
425 g_object_class_install_property (GObjectClass *class,
429 g_return_if_fail (G_IS_OBJECT_CLASS (class));
430 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
432 if (CLASS_HAS_DERIVED_CLASS (class))
433 g_error ("Attempt to add property %s::%s to class after it was derived",
434 G_OBJECT_CLASS_NAME (class), pspec->name);
436 class->flags |= CLASS_HAS_PROPS_FLAG;
438 if (pspec->flags & G_PARAM_WRITABLE)
439 g_return_if_fail (class->set_property != NULL);
440 if (pspec->flags & G_PARAM_READABLE)
441 g_return_if_fail (class->get_property != NULL);
442 g_return_if_fail (property_id > 0);
443 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
444 if (pspec->flags & G_PARAM_CONSTRUCT)
445 g_return_if_fail ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
446 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
447 g_return_if_fail (pspec->flags & G_PARAM_WRITABLE);
449 install_property_internal (G_OBJECT_CLASS_TYPE (class), property_id, pspec);
451 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
452 class->construct_properties = g_slist_prepend (class->construct_properties, pspec);
454 /* for property overrides of construct properties, we have to get rid
455 * of the overidden inherited construct property
457 pspec = g_param_spec_pool_lookup (pspec_pool, pspec->name, g_type_parent (G_OBJECT_CLASS_TYPE (class)), TRUE);
458 if (pspec && pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
459 class->construct_properties = g_slist_remove (class->construct_properties, pspec);
463 * g_object_class_install_properties:
464 * @oclass: a #GObjectClass
465 * @n_pspecs: the length of the #GParamSpec<!-- -->s array
466 * @pspecs: (array length=n_pspecs): the #GParamSpec<!-- -->s array
467 * defining the new properties
469 * Installs new properties from an array of #GParamSpec<!-- -->s. This is
470 * usually done in the class initializer.
472 * The property id of each property is the index of each #GParamSpec in
475 * The property id of 0 is treated specially by #GObject and it should not
476 * be used to store a #GParamSpec.
478 * This function should be used if you plan to use a static array of
479 * #GParamSpec<!-- -->s and g_object_notify_by_pspec(). For instance, this
480 * class initialization:
484 * PROP_0, PROP_FOO, PROP_BAR, N_PROPERTIES
487 * static GParamSpec *obj_properties[N_PROPERTIES] = { NULL, };
490 * my_object_class_init (MyObjectClass *klass)
492 * GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
494 * obj_properties[PROP_FOO] =
495 * g_param_spec_int ("foo", "Foo", "Foo",
498 * G_PARAM_READWRITE);
500 * obj_properties[PROP_BAR] =
501 * g_param_spec_string ("bar", "Bar", "Bar",
503 * G_PARAM_READWRITE);
505 * gobject_class->set_property = my_object_set_property;
506 * gobject_class->get_property = my_object_get_property;
507 * g_object_class_install_properties (gobject_class,
513 * allows calling g_object_notify_by_pspec() to notify of property changes:
517 * my_object_set_foo (MyObject *self, gint foo)
519 * if (self->foo != foo)
522 * g_object_notify_by_pspec (G_OBJECT (self), obj_properties[PROP_FOO]);
530 g_object_class_install_properties (GObjectClass *oclass,
534 GType oclass_type, parent_type;
537 g_return_if_fail (G_IS_OBJECT_CLASS (oclass));
538 g_return_if_fail (n_pspecs > 1);
539 g_return_if_fail (pspecs[0] == NULL);
541 if (CLASS_HAS_DERIVED_CLASS (oclass))
542 g_error ("Attempt to add properties to %s after it was derived",
543 G_OBJECT_CLASS_NAME (oclass));
545 oclass_type = G_OBJECT_CLASS_TYPE (oclass);
546 parent_type = g_type_parent (oclass_type);
548 /* we skip the first element of the array as it would have a 0 prop_id */
549 for (i = 1; i < n_pspecs; i++)
551 GParamSpec *pspec = pspecs[i];
553 g_return_if_fail (pspec != NULL);
555 if (pspec->flags & G_PARAM_WRITABLE)
556 g_return_if_fail (oclass->set_property != NULL);
557 if (pspec->flags & G_PARAM_READABLE)
558 g_return_if_fail (oclass->get_property != NULL);
559 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
560 if (pspec->flags & G_PARAM_CONSTRUCT)
561 g_return_if_fail ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
562 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
563 g_return_if_fail (pspec->flags & G_PARAM_WRITABLE);
565 oclass->flags |= CLASS_HAS_PROPS_FLAG;
566 install_property_internal (oclass_type, i, pspec);
568 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
569 oclass->construct_properties = g_slist_prepend (oclass->construct_properties, pspec);
571 /* for property overrides of construct properties, we have to get rid
572 * of the overidden inherited construct property
574 pspec = g_param_spec_pool_lookup (pspec_pool, pspec->name, parent_type, TRUE);
575 if (pspec && pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
576 oclass->construct_properties = g_slist_remove (oclass->construct_properties, pspec);
581 * g_object_interface_install_property:
582 * @g_iface: any interface vtable for the interface, or the default
583 * vtable for the interface.
584 * @pspec: the #GParamSpec for the new property
586 * Add a property to an interface; this is only useful for interfaces
587 * that are added to GObject-derived types. Adding a property to an
588 * interface forces all objects classes with that interface to have a
589 * compatible property. The compatible property could be a newly
590 * created #GParamSpec, but normally
591 * g_object_class_override_property() will be used so that the object
592 * class only needs to provide an implementation and inherits the
593 * property description, default value, bounds, and so forth from the
594 * interface property.
596 * This function is meant to be called from the interface's default
597 * vtable initialization function (the @class_init member of
598 * #GTypeInfo.) It must not be called after after @class_init has
599 * been called for any object types implementing this interface.
604 g_object_interface_install_property (gpointer g_iface,
607 GTypeInterface *iface_class = g_iface;
609 g_return_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type));
610 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
611 g_return_if_fail (!G_IS_PARAM_SPEC_OVERRIDE (pspec)); /* paranoid */
612 g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0); /* paranoid */
614 install_property_internal (iface_class->g_type, 0, pspec);
618 * g_object_class_find_property:
619 * @oclass: a #GObjectClass
620 * @property_name: the name of the property to look up
622 * Looks up the #GParamSpec for a property of a class.
624 * Returns: (transfer none): the #GParamSpec for the property, or
625 * %NULL if the class doesn't have a property of that name
628 g_object_class_find_property (GObjectClass *class,
629 const gchar *property_name)
632 GParamSpec *redirect;
634 g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
635 g_return_val_if_fail (property_name != NULL, NULL);
637 pspec = g_param_spec_pool_lookup (pspec_pool,
639 G_OBJECT_CLASS_TYPE (class),
643 redirect = g_param_spec_get_redirect_target (pspec);
654 * g_object_interface_find_property:
655 * @g_iface: any interface vtable for the interface, or the default
656 * vtable for the interface
657 * @property_name: name of a property to lookup.
659 * Find the #GParamSpec with the given name for an
660 * interface. Generally, the interface vtable passed in as @g_iface
661 * will be the default vtable from g_type_default_interface_ref(), or,
662 * if you know the interface has already been loaded,
663 * g_type_default_interface_peek().
667 * Returns: (transfer none): the #GParamSpec for the property of the
668 * interface with the name @property_name, or %NULL if no
669 * such property exists.
672 g_object_interface_find_property (gpointer g_iface,
673 const gchar *property_name)
675 GTypeInterface *iface_class = g_iface;
677 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type), NULL);
678 g_return_val_if_fail (property_name != NULL, NULL);
680 return g_param_spec_pool_lookup (pspec_pool,
687 * g_object_class_override_property:
688 * @oclass: a #GObjectClass
689 * @property_id: the new property ID
690 * @name: the name of a property registered in a parent class or
691 * in an interface of this class.
693 * Registers @property_id as referring to a property with the
694 * name @name in a parent class or in an interface implemented
695 * by @oclass. This allows this class to <firstterm>override</firstterm>
696 * a property implementation in a parent class or to provide
697 * the implementation of a property from an interface.
700 * Internally, overriding is implemented by creating a property of type
701 * #GParamSpecOverride; generally operations that query the properties of
702 * the object class, such as g_object_class_find_property() or
703 * g_object_class_list_properties() will return the overridden
704 * property. However, in one case, the @construct_properties argument of
705 * the @constructor virtual function, the #GParamSpecOverride is passed
706 * instead, so that the @param_id field of the #GParamSpec will be
707 * correct. For virtually all uses, this makes no difference. If you
708 * need to get the overridden property, you can call
709 * g_param_spec_get_redirect_target().
715 g_object_class_override_property (GObjectClass *oclass,
719 GParamSpec *overridden = NULL;
723 g_return_if_fail (G_IS_OBJECT_CLASS (oclass));
724 g_return_if_fail (property_id > 0);
725 g_return_if_fail (name != NULL);
727 /* Find the overridden property; first check parent types
729 parent_type = g_type_parent (G_OBJECT_CLASS_TYPE (oclass));
730 if (parent_type != G_TYPE_NONE)
731 overridden = g_param_spec_pool_lookup (pspec_pool,
740 /* Now check interfaces
742 ifaces = g_type_interfaces (G_OBJECT_CLASS_TYPE (oclass), &n_ifaces);
743 while (n_ifaces-- && !overridden)
745 overridden = g_param_spec_pool_lookup (pspec_pool,
756 g_warning ("%s: Can't find property to override for '%s::%s'",
757 G_STRFUNC, G_OBJECT_CLASS_NAME (oclass), name);
761 new = g_param_spec_override (name, overridden);
762 g_object_class_install_property (oclass, property_id, new);
766 * g_object_class_list_properties:
767 * @oclass: a #GObjectClass
768 * @n_properties: (out): return location for the length of the returned array
770 * Get an array of #GParamSpec* for all properties of a class.
772 * Returns: (array length=n_properties) (transfer container): an array of
773 * #GParamSpec* which should be freed after use
775 GParamSpec** /* free result */
776 g_object_class_list_properties (GObjectClass *class,
777 guint *n_properties_p)
782 g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
784 pspecs = g_param_spec_pool_list (pspec_pool,
785 G_OBJECT_CLASS_TYPE (class),
794 * g_object_interface_list_properties:
795 * @g_iface: any interface vtable for the interface, or the default
796 * vtable for the interface
797 * @n_properties_p: (out): location to store number of properties returned.
799 * Lists the properties of an interface.Generally, the interface
800 * vtable passed in as @g_iface will be the default vtable from
801 * g_type_default_interface_ref(), or, if you know the interface has
802 * already been loaded, g_type_default_interface_peek().
806 * Returns: (array length=n_properties_p) (transfer container): a
807 * pointer to an array of pointers to #GParamSpec
808 * structures. The paramspecs are owned by GLib, but the
809 * array should be freed with g_free() when you are done with
813 g_object_interface_list_properties (gpointer g_iface,
814 guint *n_properties_p)
816 GTypeInterface *iface_class = g_iface;
820 g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type), NULL);
822 pspecs = g_param_spec_pool_list (pspec_pool,
832 g_object_init (GObject *object,
835 object->ref_count = 1;
836 object->qdata = NULL;
838 if (CLASS_HAS_PROPS (class))
840 /* freeze object's notification queue, g_object_newv() preserves pairedness */
841 g_object_notify_queue_freeze (object, &property_notify_context);
844 if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
846 /* enter construction list for notify_queue_thaw() and to allow construct-only properties */
847 G_LOCK (construction_mutex);
848 construction_objects = g_slist_prepend (construction_objects, object);
849 G_UNLOCK (construction_mutex);
852 #ifdef G_ENABLE_DEBUG
855 G_LOCK (debug_objects);
856 debug_objects_count++;
857 g_hash_table_insert (debug_objects_ht, object, object);
858 G_UNLOCK (debug_objects);
860 #endif /* G_ENABLE_DEBUG */
864 g_object_do_set_property (GObject *object,
872 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
878 g_object_do_get_property (GObject *object,
886 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
892 g_object_real_dispose (GObject *object)
894 g_signal_handlers_destroy (object);
895 g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
896 g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
900 g_object_finalize (GObject *object)
902 g_datalist_clear (&object->qdata);
904 #ifdef G_ENABLE_DEBUG
907 G_LOCK (debug_objects);
908 g_assert (g_hash_table_lookup (debug_objects_ht, object) == object);
909 g_hash_table_remove (debug_objects_ht, object);
910 debug_objects_count--;
911 G_UNLOCK (debug_objects);
913 #endif /* G_ENABLE_DEBUG */
918 g_object_dispatch_properties_changed (GObject *object,
924 for (i = 0; i < n_pspecs; i++)
925 g_signal_emit (object, gobject_signals[NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
929 * g_object_run_dispose:
930 * @object: a #GObject
932 * Releases all references to other objects. This can be used to break
935 * This functions should only be called from object system implementations.
938 g_object_run_dispose (GObject *object)
940 g_return_if_fail (G_IS_OBJECT (object));
941 g_return_if_fail (object->ref_count > 0);
943 g_object_ref (object);
944 TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 0));
945 G_OBJECT_GET_CLASS (object)->dispose (object);
946 TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 0));
947 g_object_unref (object);
951 * g_object_freeze_notify:
952 * @object: a #GObject
954 * Increases the freeze count on @object. If the freeze count is
955 * non-zero, the emission of "notify" signals on @object is
956 * stopped. The signals are queued until the freeze count is decreased
959 * This is necessary for accessors that modify multiple properties to prevent
960 * premature notification while the object is still being modified.
963 g_object_freeze_notify (GObject *object)
965 g_return_if_fail (G_IS_OBJECT (object));
967 if (g_atomic_int_get (&object->ref_count) == 0)
970 g_object_ref (object);
971 g_object_notify_queue_freeze (object, &property_notify_context);
972 g_object_unref (object);
976 g_object_notify_by_spec_internal (GObject *object,
979 GObjectNotifyQueue *nqueue;
981 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
982 g_object_notify_queue_add (object, nqueue, pspec);
983 g_object_notify_queue_thaw (object, nqueue);
988 * @object: a #GObject
989 * @property_name: the name of a property installed on the class of @object.
991 * Emits a "notify" signal for the property @property_name on @object.
993 * When possible, eg. when signaling a property change from within the class
994 * that registered the property, you should use g_object_notify_by_pspec()
998 g_object_notify (GObject *object,
999 const gchar *property_name)
1003 g_return_if_fail (G_IS_OBJECT (object));
1004 g_return_if_fail (property_name != NULL);
1005 if (g_atomic_int_get (&object->ref_count) == 0)
1008 g_object_ref (object);
1009 /* We don't need to get the redirect target
1010 * (by, e.g. calling g_object_class_find_property())
1011 * because g_object_notify_queue_add() does that
1013 pspec = g_param_spec_pool_lookup (pspec_pool,
1015 G_OBJECT_TYPE (object),
1019 g_warning ("%s: object class `%s' has no property named `%s'",
1021 G_OBJECT_TYPE_NAME (object),
1024 g_object_notify_by_spec_internal (object, pspec);
1025 g_object_unref (object);
1029 * g_object_notify_by_pspec:
1030 * @object: a #GObject
1031 * @pspec: the #GParamSpec of a property installed on the class of @object.
1033 * Emits a "notify" signal for the property specified by @pspec on @object.
1035 * This function omits the property name lookup, hence it is faster than
1036 * g_object_notify().
1038 * One way to avoid using g_object_notify() from within the
1039 * class that registered the properties, and using g_object_notify_by_pspec()
1040 * instead, is to store the GParamSpec used with
1041 * g_object_class_install_property() inside a static array, e.g.:
1051 * static GParamSpec *properties[PROP_LAST];
1054 * my_object_class_init (MyObjectClass *klass)
1056 * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
1059 * G_PARAM_READWRITE);
1060 * g_object_class_install_property (gobject_class,
1062 * properties[PROP_FOO]);
1066 * and then notify a change on the "foo" property with:
1069 * g_object_notify_by_pspec (self, properties[PROP_FOO]);
1075 g_object_notify_by_pspec (GObject *object,
1079 g_return_if_fail (G_IS_OBJECT (object));
1080 g_return_if_fail (G_IS_PARAM_SPEC (pspec));
1082 g_object_ref (object);
1083 g_object_notify_by_spec_internal (object, pspec);
1084 g_object_unref (object);
1088 * g_object_thaw_notify:
1089 * @object: a #GObject
1091 * Reverts the effect of a previous call to
1092 * g_object_freeze_notify(). The freeze count is decreased on @object
1093 * and when it reaches zero, all queued "notify" signals are emitted.
1095 * It is an error to call this function when the freeze count is zero.
1098 g_object_thaw_notify (GObject *object)
1100 GObjectNotifyQueue *nqueue;
1102 g_return_if_fail (G_IS_OBJECT (object));
1103 if (g_atomic_int_get (&object->ref_count) == 0)
1106 g_object_ref (object);
1108 /* FIXME: Freezing is the only way to get at the notify queue.
1109 * So we freeze once and then thaw twice.
1111 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1112 g_object_notify_queue_thaw (object, nqueue);
1113 g_object_notify_queue_thaw (object, nqueue);
1115 g_object_unref (object);
1119 object_get_property (GObject *object,
1123 GObjectClass *class = g_type_class_peek (pspec->owner_type);
1124 guint param_id = PARAM_SPEC_PARAM_ID (pspec);
1125 GParamSpec *redirect;
1129 g_warning ("'%s::%s' is not a valid property name; '%s' is not a GObject subtype",
1130 g_type_name (pspec->owner_type), pspec->name, g_type_name (pspec->owner_type));
1134 redirect = g_param_spec_get_redirect_target (pspec);
1138 class->get_property (object, param_id, value, pspec);
1142 object_set_property (GObject *object,
1144 const GValue *value,
1145 GObjectNotifyQueue *nqueue)
1147 GValue tmp_value = { 0, };
1148 GObjectClass *class = g_type_class_peek (pspec->owner_type);
1149 guint param_id = PARAM_SPEC_PARAM_ID (pspec);
1150 GParamSpec *redirect;
1151 static const gchar * enable_diagnostic = NULL;
1155 g_warning ("'%s::%s' is not a valid property name; '%s' is not a GObject subtype",
1156 g_type_name (pspec->owner_type), pspec->name, g_type_name (pspec->owner_type));
1160 redirect = g_param_spec_get_redirect_target (pspec);
1164 if (G_UNLIKELY (!enable_diagnostic))
1166 enable_diagnostic = g_getenv ("G_ENABLE_DIAGNOSTIC");
1167 if (!enable_diagnostic)
1168 enable_diagnostic = "0";
1171 if (enable_diagnostic[0] == '1')
1173 if (pspec->flags & G_PARAM_DEPRECATED)
1174 g_warning ("The property %s::%s is deprecated and shouldn't be used "
1175 "anymore. It will be removed in a future version.",
1176 G_OBJECT_TYPE_NAME (object), pspec->name);
1179 /* provide a copy to work from, convert (if necessary) and validate */
1180 g_value_init (&tmp_value, pspec->value_type);
1181 if (!g_value_transform (value, &tmp_value))
1182 g_warning ("unable to set property `%s' of type `%s' from value of type `%s'",
1184 g_type_name (pspec->value_type),
1185 G_VALUE_TYPE_NAME (value));
1186 else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
1188 gchar *contents = g_strdup_value_contents (value);
1190 g_warning ("value \"%s\" of type `%s' is invalid or out of range for property `%s' of type `%s'",
1192 G_VALUE_TYPE_NAME (value),
1194 g_type_name (pspec->value_type));
1199 class->set_property (object, param_id, &tmp_value, pspec);
1200 g_object_notify_queue_add (object, nqueue, pspec);
1202 g_value_unset (&tmp_value);
1206 object_interface_check_properties (gpointer func_data,
1209 GTypeInterface *iface_class = g_iface;
1210 GObjectClass *class;
1211 GType iface_type = iface_class->g_type;
1212 GParamSpec **pspecs;
1215 class = g_type_class_ref (iface_class->g_instance_type);
1217 if (!G_IS_OBJECT_CLASS (class))
1220 pspecs = g_param_spec_pool_list (pspec_pool, iface_type, &n);
1224 GParamSpec *class_pspec = g_param_spec_pool_lookup (pspec_pool,
1226 G_OBJECT_CLASS_TYPE (class),
1231 g_critical ("Object class %s doesn't implement property "
1232 "'%s' from interface '%s'",
1233 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1235 g_type_name (iface_type));
1240 /* The implementation paramspec must have a less restrictive
1241 * type than the interface parameter spec for set() and a
1242 * more restrictive type for get(). We just require equality,
1243 * rather than doing something more complicated checking
1244 * the READABLE and WRITABLE flags. We also simplify here
1245 * by only checking the value type, not the G_PARAM_SPEC_TYPE.
1248 !g_type_is_a (pspecs[n]->value_type,
1249 class_pspec->value_type))
1251 g_critical ("Property '%s' on class '%s' has type '%s' "
1252 "which is different from the type '%s', "
1253 "of the property on interface '%s'\n",
1255 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1256 g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1257 g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])),
1258 g_type_name (iface_type));
1261 #define SUBSET(a,b,mask) (((a) & ~(b) & (mask)) == 0)
1263 /* CONSTRUCT and CONSTRUCT_ONLY add restrictions.
1264 * READABLE and WRITABLE remove restrictions. The implementation
1265 * paramspec must have less restrictive flags.
1268 (!SUBSET (class_pspec->flags,
1270 G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY) ||
1271 !SUBSET (pspecs[n]->flags,
1273 G_PARAM_READABLE | G_PARAM_WRITABLE)))
1275 g_critical ("Flags for property '%s' on class '%s' "
1276 "are not compatible with the property on"
1279 g_type_name (G_OBJECT_CLASS_TYPE (class)),
1280 g_type_name (iface_type));
1287 g_type_class_unref (class);
1291 g_object_get_type (void)
1293 return G_TYPE_OBJECT;
1297 * g_object_new: (skip)
1298 * @object_type: the type id of the #GObject subtype to instantiate
1299 * @first_property_name: the name of the first property
1300 * @...: the value of the first property, followed optionally by more
1301 * name/value pairs, followed by %NULL
1303 * Creates a new instance of a #GObject subtype and sets its properties.
1305 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1306 * which are not explicitly specified are set to their default values.
1308 * Returns: (transfer full): a new instance of @object_type
1311 g_object_new (GType object_type,
1312 const gchar *first_property_name,
1318 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1320 /* short circuit for calls supplying no properties */
1321 if (!first_property_name)
1322 return g_object_newv (object_type, 0, NULL);
1324 va_start (var_args, first_property_name);
1325 object = g_object_new_valist (object_type, first_property_name, var_args);
1332 slist_maybe_remove (GSList **slist,
1335 GSList *last = NULL, *node = *slist;
1338 if (node->data == data)
1341 last->next = node->next;
1343 *slist = node->next;
1344 g_slist_free_1 (node);
1353 static inline gboolean
1354 object_in_construction_list (GObject *object)
1356 gboolean in_construction;
1357 G_LOCK (construction_mutex);
1358 in_construction = g_slist_find (construction_objects, object) != NULL;
1359 G_UNLOCK (construction_mutex);
1360 return in_construction;
1365 * @object_type: the type id of the #GObject subtype to instantiate
1366 * @n_parameters: the length of the @parameters array
1367 * @parameters: (array length=n_parameters): an array of #GParameter
1369 * Creates a new instance of a #GObject subtype and sets its properties.
1371 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1372 * which are not explicitly specified are set to their default values.
1374 * Rename to: g_object_new
1375 * Returns: (type GObject.Object) (transfer full): a new instance of
1379 g_object_newv (GType object_type,
1381 GParameter *parameters)
1383 GObjectConstructParam *cparams = NULL, *oparams;
1384 GObjectNotifyQueue *nqueue = NULL; /* shouldn't be initialized, just to silence compiler */
1386 GObjectClass *class, *unref_class = NULL;
1388 guint n_total_cparams = 0, n_cparams = 0, n_oparams = 0, n_cvalues;
1390 GList *clist = NULL;
1391 gboolean newly_constructed;
1394 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1396 class = g_type_class_peek_static (object_type);
1398 class = unref_class = g_type_class_ref (object_type);
1399 for (slist = class->construct_properties; slist; slist = slist->next)
1401 clist = g_list_prepend (clist, slist->data);
1402 n_total_cparams += 1;
1405 if (n_parameters == 0 && n_total_cparams == 0)
1407 /* This is a simple object with no construct properties, and
1408 * no properties are being set, so short circuit the parameter
1409 * handling. This speeds up simple object construction.
1412 object = class->constructor (object_type, 0, NULL);
1413 goto did_construction;
1416 /* collect parameters, sort into construction and normal ones */
1417 oparams = g_new (GObjectConstructParam, n_parameters);
1418 cparams = g_new (GObjectConstructParam, n_total_cparams);
1419 for (i = 0; i < n_parameters; i++)
1421 GValue *value = ¶meters[i].value;
1422 GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1428 g_warning ("%s: object class `%s' has no property named `%s'",
1430 g_type_name (object_type),
1431 parameters[i].name);
1434 if (!(pspec->flags & G_PARAM_WRITABLE))
1436 g_warning ("%s: property `%s' of object class `%s' is not writable",
1439 g_type_name (object_type));
1442 if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1444 GList *list = g_list_find (clist, pspec);
1448 g_warning ("%s: construct property \"%s\" for object `%s' can't be set twice",
1449 G_STRFUNC, pspec->name, g_type_name (object_type));
1452 cparams[n_cparams].pspec = pspec;
1453 cparams[n_cparams].value = value;
1458 list->prev->next = list->next;
1460 list->next->prev = list->prev;
1461 g_list_free_1 (list);
1465 oparams[n_oparams].pspec = pspec;
1466 oparams[n_oparams].value = value;
1471 /* set remaining construction properties to default values */
1472 n_cvalues = n_total_cparams - n_cparams;
1473 cvalues = g_new (GValue, n_cvalues);
1476 GList *tmp = clist->next;
1477 GParamSpec *pspec = clist->data;
1478 GValue *value = cvalues + n_total_cparams - n_cparams - 1;
1481 g_value_init (value, pspec->value_type);
1482 g_param_value_set_default (pspec, value);
1484 cparams[n_cparams].pspec = pspec;
1485 cparams[n_cparams].value = value;
1488 g_list_free_1 (clist);
1492 /* construct object from construction parameters */
1493 object = class->constructor (object_type, n_total_cparams, cparams);
1494 /* free construction values */
1497 g_value_unset (cvalues + n_cvalues);
1501 if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
1503 /* adjust freeze_count according to g_object_init() and remaining properties */
1504 G_LOCK (construction_mutex);
1505 newly_constructed = slist_maybe_remove (&construction_objects, object);
1506 G_UNLOCK (construction_mutex);
1509 newly_constructed = TRUE;
1511 if (CLASS_HAS_PROPS (class))
1513 if (newly_constructed || n_oparams)
1514 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1515 if (newly_constructed)
1516 g_object_notify_queue_thaw (object, nqueue);
1519 /* run 'constructed' handler if there is a custom one */
1520 if (newly_constructed && CLASS_HAS_CUSTOM_CONSTRUCTED (class))
1521 class->constructed (object);
1523 /* set remaining properties */
1524 for (i = 0; i < n_oparams; i++)
1525 object_set_property (object, oparams[i].pspec, oparams[i].value, nqueue);
1528 if (CLASS_HAS_PROPS (class))
1530 /* release our own freeze count and handle notifications */
1531 if (newly_constructed || n_oparams)
1532 g_object_notify_queue_thaw (object, nqueue);
1536 g_type_class_unref (unref_class);
1542 * g_object_new_valist: (skip)
1543 * @object_type: the type id of the #GObject subtype to instantiate
1544 * @first_property_name: the name of the first property
1545 * @var_args: the value of the first property, followed optionally by more
1546 * name/value pairs, followed by %NULL
1548 * Creates a new instance of a #GObject subtype and sets its properties.
1550 * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1551 * which are not explicitly specified are set to their default values.
1553 * Returns: a new instance of @object_type
1556 g_object_new_valist (GType object_type,
1557 const gchar *first_property_name,
1560 GObjectClass *class;
1564 guint n_params = 0, n_alloced_params = 16;
1566 g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1568 if (!first_property_name)
1569 return g_object_newv (object_type, 0, NULL);
1571 class = g_type_class_ref (object_type);
1573 params = g_new0 (GParameter, n_alloced_params);
1574 name = first_property_name;
1577 gchar *error = NULL;
1578 GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1584 g_warning ("%s: object class `%s' has no property named `%s'",
1586 g_type_name (object_type),
1590 if (n_params >= n_alloced_params)
1592 n_alloced_params += 16;
1593 params = g_renew (GParameter, params, n_alloced_params);
1594 memset (params + n_params, 0, 16 * (sizeof *params));
1596 params[n_params].name = name;
1597 G_VALUE_COLLECT_INIT (¶ms[n_params].value, pspec->value_type,
1598 var_args, 0, &error);
1601 g_warning ("%s: %s", G_STRFUNC, error);
1603 g_value_unset (¶ms[n_params].value);
1607 name = va_arg (var_args, gchar*);
1610 object = g_object_newv (object_type, n_params, params);
1613 g_value_unset (¶ms[n_params].value);
1616 g_type_class_unref (class);
1622 g_object_constructor (GType type,
1623 guint n_construct_properties,
1624 GObjectConstructParam *construct_params)
1629 object = (GObject*) g_type_create_instance (type);
1631 /* set construction parameters */
1632 if (n_construct_properties)
1634 GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1636 /* set construct properties */
1637 while (n_construct_properties--)
1639 GValue *value = construct_params->value;
1640 GParamSpec *pspec = construct_params->pspec;
1643 object_set_property (object, pspec, value, nqueue);
1645 g_object_notify_queue_thaw (object, nqueue);
1646 /* the notification queue is still frozen from g_object_init(), so
1647 * we don't need to handle it here, g_object_newv() takes
1656 g_object_constructed (GObject *object)
1658 /* empty default impl to allow unconditional upchaining */
1662 * g_object_set_valist: (skip)
1663 * @object: a #GObject
1664 * @first_property_name: name of the first property to set
1665 * @var_args: value for the first property, followed optionally by more
1666 * name/value pairs, followed by %NULL
1668 * Sets properties on an object.
1671 g_object_set_valist (GObject *object,
1672 const gchar *first_property_name,
1675 GObjectNotifyQueue *nqueue;
1678 g_return_if_fail (G_IS_OBJECT (object));
1680 g_object_ref (object);
1681 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1683 name = first_property_name;
1686 GValue value = { 0, };
1688 gchar *error = NULL;
1690 pspec = g_param_spec_pool_lookup (pspec_pool,
1692 G_OBJECT_TYPE (object),
1696 g_warning ("%s: object class `%s' has no property named `%s'",
1698 G_OBJECT_TYPE_NAME (object),
1702 if (!(pspec->flags & G_PARAM_WRITABLE))
1704 g_warning ("%s: property `%s' of object class `%s' is not writable",
1707 G_OBJECT_TYPE_NAME (object));
1710 if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
1712 g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
1713 G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
1717 G_VALUE_COLLECT_INIT (&value, pspec->value_type, var_args,
1721 g_warning ("%s: %s", G_STRFUNC, error);
1723 g_value_unset (&value);
1727 object_set_property (object, pspec, &value, nqueue);
1728 g_value_unset (&value);
1730 name = va_arg (var_args, gchar*);
1733 g_object_notify_queue_thaw (object, nqueue);
1734 g_object_unref (object);
1738 * g_object_get_valist: (skip)
1739 * @object: a #GObject
1740 * @first_property_name: name of the first property to get
1741 * @var_args: return location for the first property, followed optionally by more
1742 * name/return location pairs, followed by %NULL
1744 * Gets properties of an object.
1746 * In general, a copy is made of the property contents and the caller
1747 * is responsible for freeing the memory in the appropriate manner for
1748 * the type, for instance by calling g_free() or g_object_unref().
1750 * See g_object_get().
1753 g_object_get_valist (GObject *object,
1754 const gchar *first_property_name,
1759 g_return_if_fail (G_IS_OBJECT (object));
1761 g_object_ref (object);
1763 name = first_property_name;
1767 GValue value = { 0, };
1771 pspec = g_param_spec_pool_lookup (pspec_pool,
1773 G_OBJECT_TYPE (object),
1777 g_warning ("%s: object class `%s' has no property named `%s'",
1779 G_OBJECT_TYPE_NAME (object),
1783 if (!(pspec->flags & G_PARAM_READABLE))
1785 g_warning ("%s: property `%s' of object class `%s' is not readable",
1788 G_OBJECT_TYPE_NAME (object));
1792 g_value_init (&value, pspec->value_type);
1794 object_get_property (object, pspec, &value);
1796 G_VALUE_LCOPY (&value, var_args, 0, &error);
1799 g_warning ("%s: %s", G_STRFUNC, error);
1801 g_value_unset (&value);
1805 g_value_unset (&value);
1807 name = va_arg (var_args, gchar*);
1810 g_object_unref (object);
1814 * g_object_set: (skip)
1815 * @object: a #GObject
1816 * @first_property_name: name of the first property to set
1817 * @...: value for the first property, followed optionally by more
1818 * name/value pairs, followed by %NULL
1820 * Sets properties on an object.
1823 g_object_set (gpointer _object,
1824 const gchar *first_property_name,
1827 GObject *object = _object;
1830 g_return_if_fail (G_IS_OBJECT (object));
1832 va_start (var_args, first_property_name);
1833 g_object_set_valist (object, first_property_name, var_args);
1838 * g_object_get: (skip)
1839 * @object: a #GObject
1840 * @first_property_name: name of the first property to get
1841 * @...: return location for the first property, followed optionally by more
1842 * name/return location pairs, followed by %NULL
1844 * Gets properties of an object.
1846 * In general, a copy is made of the property contents and the caller
1847 * is responsible for freeing the memory in the appropriate manner for
1848 * the type, for instance by calling g_free() or g_object_unref().
1851 * <title>Using g_object_get(<!-- -->)</title>
1852 * An example of using g_object_get() to get the contents
1853 * of three properties - one of type #G_TYPE_INT,
1854 * one of type #G_TYPE_STRING, and one of type #G_TYPE_OBJECT:
1860 * g_object_get (my_object,
1861 * "int-property", &intval,
1862 * "str-property", &strval,
1863 * "obj-property", &objval,
1866 * // Do something with intval, strval, objval
1869 * g_object_unref (objval);
1874 g_object_get (gpointer _object,
1875 const gchar *first_property_name,
1878 GObject *object = _object;
1881 g_return_if_fail (G_IS_OBJECT (object));
1883 va_start (var_args, first_property_name);
1884 g_object_get_valist (object, first_property_name, var_args);
1889 * g_object_set_property:
1890 * @object: a #GObject
1891 * @property_name: the name of the property to set
1894 * Sets a property on an object.
1897 g_object_set_property (GObject *object,
1898 const gchar *property_name,
1899 const GValue *value)
1901 GObjectNotifyQueue *nqueue;
1904 g_return_if_fail (G_IS_OBJECT (object));
1905 g_return_if_fail (property_name != NULL);
1906 g_return_if_fail (G_IS_VALUE (value));
1908 g_object_ref (object);
1909 nqueue = g_object_notify_queue_freeze (object, &property_notify_context);
1911 pspec = g_param_spec_pool_lookup (pspec_pool,
1913 G_OBJECT_TYPE (object),
1916 g_warning ("%s: object class `%s' has no property named `%s'",
1918 G_OBJECT_TYPE_NAME (object),
1920 else if (!(pspec->flags & G_PARAM_WRITABLE))
1921 g_warning ("%s: property `%s' of object class `%s' is not writable",
1924 G_OBJECT_TYPE_NAME (object));
1925 else if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
1926 g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
1927 G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
1929 object_set_property (object, pspec, value, nqueue);
1931 g_object_notify_queue_thaw (object, nqueue);
1932 g_object_unref (object);
1936 * g_object_get_property:
1937 * @object: a #GObject
1938 * @property_name: the name of the property to get
1939 * @value: return location for the property value
1941 * Gets a property of an object. @value must have been initialized to the
1942 * expected type of the property (or a type to which the expected type can be
1943 * transformed) using g_value_init().
1945 * In general, a copy is made of the property contents and the caller is
1946 * responsible for freeing the memory by calling g_value_unset().
1948 * Note that g_object_get_property() is really intended for language
1949 * bindings, g_object_get() is much more convenient for C programming.
1952 g_object_get_property (GObject *object,
1953 const gchar *property_name,
1958 g_return_if_fail (G_IS_OBJECT (object));
1959 g_return_if_fail (property_name != NULL);
1960 g_return_if_fail (G_IS_VALUE (value));
1962 g_object_ref (object);
1964 pspec = g_param_spec_pool_lookup (pspec_pool,
1966 G_OBJECT_TYPE (object),
1969 g_warning ("%s: object class `%s' has no property named `%s'",
1971 G_OBJECT_TYPE_NAME (object),
1973 else if (!(pspec->flags & G_PARAM_READABLE))
1974 g_warning ("%s: property `%s' of object class `%s' is not readable",
1977 G_OBJECT_TYPE_NAME (object));
1980 GValue *prop_value, tmp_value = { 0, };
1982 /* auto-conversion of the callers value type
1984 if (G_VALUE_TYPE (value) == pspec->value_type)
1986 g_value_reset (value);
1989 else if (!g_value_type_transformable (pspec->value_type, G_VALUE_TYPE (value)))
1991 g_warning ("%s: can't retrieve property `%s' of type `%s' as value of type `%s'",
1992 G_STRFUNC, pspec->name,
1993 g_type_name (pspec->value_type),
1994 G_VALUE_TYPE_NAME (value));
1995 g_object_unref (object);
2000 g_value_init (&tmp_value, pspec->value_type);
2001 prop_value = &tmp_value;
2003 object_get_property (object, pspec, prop_value);
2004 if (prop_value != value)
2006 g_value_transform (prop_value, value);
2007 g_value_unset (&tmp_value);
2011 g_object_unref (object);
2015 * g_object_connect: (skip)
2016 * @object: a #GObject
2017 * @signal_spec: the spec for the first signal
2018 * @...: #GCallback for the first signal, followed by data for the
2019 * first signal, followed optionally by more signal
2020 * spec/callback/data triples, followed by %NULL
2022 * A convenience function to connect multiple signals at once.
2024 * The signal specs expected by this function have the form
2025 * "modifier::signal_name", where modifier can be one of the following:
2028 * <term>signal</term>
2030 * equivalent to <literal>g_signal_connect_data (..., NULL, 0)</literal>
2031 * </para></listitem>
2034 * <term>object_signal</term>
2035 * <term>object-signal</term>
2037 * equivalent to <literal>g_signal_connect_object (..., 0)</literal>
2038 * </para></listitem>
2041 * <term>swapped_signal</term>
2042 * <term>swapped-signal</term>
2044 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)</literal>
2045 * </para></listitem>
2048 * <term>swapped_object_signal</term>
2049 * <term>swapped-object-signal</term>
2051 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED)</literal>
2052 * </para></listitem>
2055 * <term>signal_after</term>
2056 * <term>signal-after</term>
2058 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_AFTER)</literal>
2059 * </para></listitem>
2062 * <term>object_signal_after</term>
2063 * <term>object-signal-after</term>
2065 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_AFTER)</literal>
2066 * </para></listitem>
2069 * <term>swapped_signal_after</term>
2070 * <term>swapped-signal-after</term>
2072 * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2073 * </para></listitem>
2076 * <term>swapped_object_signal_after</term>
2077 * <term>swapped-object-signal-after</term>
2079 * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2080 * </para></listitem>
2085 * menu->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
2086 * "type", GTK_WINDOW_POPUP,
2089 * "signal::event", gtk_menu_window_event, menu,
2090 * "signal::size_request", gtk_menu_window_size_request, menu,
2091 * "signal::destroy", gtk_widget_destroyed, &menu->toplevel,
2095 * Returns: (transfer none): @object
2098 g_object_connect (gpointer _object,
2099 const gchar *signal_spec,
2102 GObject *object = _object;
2105 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2106 g_return_val_if_fail (object->ref_count > 0, object);
2108 va_start (var_args, signal_spec);
2111 GCallback callback = va_arg (var_args, GCallback);
2112 gpointer data = va_arg (var_args, gpointer);
2114 if (strncmp (signal_spec, "signal::", 8) == 0)
2115 g_signal_connect_data (object, signal_spec + 8,
2116 callback, data, NULL,
2118 else if (strncmp (signal_spec, "object_signal::", 15) == 0 ||
2119 strncmp (signal_spec, "object-signal::", 15) == 0)
2120 g_signal_connect_object (object, signal_spec + 15,
2123 else if (strncmp (signal_spec, "swapped_signal::", 16) == 0 ||
2124 strncmp (signal_spec, "swapped-signal::", 16) == 0)
2125 g_signal_connect_data (object, signal_spec + 16,
2126 callback, data, NULL,
2128 else if (strncmp (signal_spec, "swapped_object_signal::", 23) == 0 ||
2129 strncmp (signal_spec, "swapped-object-signal::", 23) == 0)
2130 g_signal_connect_object (object, signal_spec + 23,
2133 else if (strncmp (signal_spec, "signal_after::", 14) == 0 ||
2134 strncmp (signal_spec, "signal-after::", 14) == 0)
2135 g_signal_connect_data (object, signal_spec + 14,
2136 callback, data, NULL,
2138 else if (strncmp (signal_spec, "object_signal_after::", 21) == 0 ||
2139 strncmp (signal_spec, "object-signal-after::", 21) == 0)
2140 g_signal_connect_object (object, signal_spec + 21,
2143 else if (strncmp (signal_spec, "swapped_signal_after::", 22) == 0 ||
2144 strncmp (signal_spec, "swapped-signal-after::", 22) == 0)
2145 g_signal_connect_data (object, signal_spec + 22,
2146 callback, data, NULL,
2147 G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2148 else if (strncmp (signal_spec, "swapped_object_signal_after::", 29) == 0 ||
2149 strncmp (signal_spec, "swapped-object-signal-after::", 29) == 0)
2150 g_signal_connect_object (object, signal_spec + 29,
2152 G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2155 g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2158 signal_spec = va_arg (var_args, gchar*);
2166 * g_object_disconnect: (skip)
2167 * @object: a #GObject
2168 * @signal_spec: the spec for the first signal
2169 * @...: #GCallback for the first signal, followed by data for the first signal,
2170 * followed optionally by more signal spec/callback/data triples,
2173 * A convenience function to disconnect multiple signals at once.
2175 * The signal specs expected by this function have the form
2176 * "any_signal", which means to disconnect any signal with matching
2177 * callback and data, or "any_signal::signal_name", which only
2178 * disconnects the signal named "signal_name".
2181 g_object_disconnect (gpointer _object,
2182 const gchar *signal_spec,
2185 GObject *object = _object;
2188 g_return_if_fail (G_IS_OBJECT (object));
2189 g_return_if_fail (object->ref_count > 0);
2191 va_start (var_args, signal_spec);
2194 GCallback callback = va_arg (var_args, GCallback);
2195 gpointer data = va_arg (var_args, gpointer);
2196 guint sid = 0, detail = 0, mask = 0;
2198 if (strncmp (signal_spec, "any_signal::", 12) == 0 ||
2199 strncmp (signal_spec, "any-signal::", 12) == 0)
2202 mask = G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2204 else if (strcmp (signal_spec, "any_signal") == 0 ||
2205 strcmp (signal_spec, "any-signal") == 0)
2208 mask = G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2212 g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2216 if ((mask & G_SIGNAL_MATCH_ID) &&
2217 !g_signal_parse_name (signal_spec, G_OBJECT_TYPE (object), &sid, &detail, FALSE))
2218 g_warning ("%s: invalid signal name \"%s\"", G_STRFUNC, signal_spec);
2219 else if (!g_signal_handlers_disconnect_matched (object, mask | (detail ? G_SIGNAL_MATCH_DETAIL : 0),
2221 NULL, (gpointer)callback, data))
2222 g_warning ("%s: signal handler %p(%p) is not connected", G_STRFUNC, callback, data);
2223 signal_spec = va_arg (var_args, gchar*);
2234 } weak_refs[1]; /* flexible array */
2238 weak_refs_notify (gpointer data)
2240 WeakRefStack *wstack = data;
2243 for (i = 0; i < wstack->n_weak_refs; i++)
2244 wstack->weak_refs[i].notify (wstack->weak_refs[i].data, wstack->object);
2249 * g_object_weak_ref: (skip)
2250 * @object: #GObject to reference weakly
2251 * @notify: callback to invoke before the object is freed
2252 * @data: extra data to pass to notify
2254 * Adds a weak reference callback to an object. Weak references are
2255 * used for notification when an object is finalized. They are called
2256 * "weak references" because they allow you to safely hold a pointer
2257 * to an object without calling g_object_ref() (g_object_ref() adds a
2258 * strong reference, that is, forces the object to stay alive).
2261 g_object_weak_ref (GObject *object,
2265 WeakRefStack *wstack;
2268 g_return_if_fail (G_IS_OBJECT (object));
2269 g_return_if_fail (notify != NULL);
2270 g_return_if_fail (object->ref_count >= 1);
2272 G_LOCK (weak_refs_mutex);
2273 wstack = g_datalist_id_remove_no_notify (&object->qdata, quark_weak_refs);
2276 i = wstack->n_weak_refs++;
2277 wstack = g_realloc (wstack, sizeof (*wstack) + sizeof (wstack->weak_refs[0]) * i);
2281 wstack = g_renew (WeakRefStack, NULL, 1);
2282 wstack->object = object;
2283 wstack->n_weak_refs = 1;
2286 wstack->weak_refs[i].notify = notify;
2287 wstack->weak_refs[i].data = data;
2288 g_datalist_id_set_data_full (&object->qdata, quark_weak_refs, wstack, weak_refs_notify);
2289 G_UNLOCK (weak_refs_mutex);
2293 * g_object_weak_unref: (skip)
2294 * @object: #GObject to remove a weak reference from
2295 * @notify: callback to search for
2296 * @data: data to search for
2298 * Removes a weak reference callback to an object.
2301 g_object_weak_unref (GObject *object,
2305 WeakRefStack *wstack;
2306 gboolean found_one = FALSE;
2308 g_return_if_fail (G_IS_OBJECT (object));
2309 g_return_if_fail (notify != NULL);
2311 G_LOCK (weak_refs_mutex);
2312 wstack = g_datalist_id_get_data (&object->qdata, quark_weak_refs);
2317 for (i = 0; i < wstack->n_weak_refs; i++)
2318 if (wstack->weak_refs[i].notify == notify &&
2319 wstack->weak_refs[i].data == data)
2322 wstack->n_weak_refs -= 1;
2323 if (i != wstack->n_weak_refs)
2324 wstack->weak_refs[i] = wstack->weak_refs[wstack->n_weak_refs];
2329 G_UNLOCK (weak_refs_mutex);
2331 g_warning ("%s: couldn't find weak ref %p(%p)", G_STRFUNC, notify, data);
2335 * g_object_add_weak_pointer: (skip)
2336 * @object: The object that should be weak referenced.
2337 * @weak_pointer_location: (inout): The memory address of a pointer.
2339 * Adds a weak reference from weak_pointer to @object to indicate that
2340 * the pointer located at @weak_pointer_location is only valid during
2341 * the lifetime of @object. When the @object is finalized,
2342 * @weak_pointer will be set to %NULL.
2345 g_object_add_weak_pointer (GObject *object,
2346 gpointer *weak_pointer_location)
2348 g_return_if_fail (G_IS_OBJECT (object));
2349 g_return_if_fail (weak_pointer_location != NULL);
2351 g_object_weak_ref (object,
2352 (GWeakNotify) g_nullify_pointer,
2353 weak_pointer_location);
2357 * g_object_remove_weak_pointer: (skip)
2358 * @object: The object that is weak referenced.
2359 * @weak_pointer_location: (inout): The memory address of a pointer.
2361 * Removes a weak reference from @object that was previously added
2362 * using g_object_add_weak_pointer(). The @weak_pointer_location has
2363 * to match the one used with g_object_add_weak_pointer().
2366 g_object_remove_weak_pointer (GObject *object,
2367 gpointer *weak_pointer_location)
2369 g_return_if_fail (G_IS_OBJECT (object));
2370 g_return_if_fail (weak_pointer_location != NULL);
2372 g_object_weak_unref (object,
2373 (GWeakNotify) g_nullify_pointer,
2374 weak_pointer_location);
2378 object_floating_flag_handler (GObject *object,
2384 case +1: /* force floating if possible */
2386 oldvalue = g_atomic_pointer_get (&object->qdata);
2387 while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2388 (gpointer) ((gsize) oldvalue | OBJECT_FLOATING_FLAG)));
2389 return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2390 case -1: /* sink if possible */
2392 oldvalue = g_atomic_pointer_get (&object->qdata);
2393 while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2394 (gpointer) ((gsize) oldvalue & ~(gsize) OBJECT_FLOATING_FLAG)));
2395 return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2396 default: /* check floating */
2397 return 0 != ((gsize) g_atomic_pointer_get (&object->qdata) & OBJECT_FLOATING_FLAG);
2402 * g_object_is_floating:
2403 * @object: (type GObject.Object): a #GObject
2405 * Checks whether @object has a <link linkend="floating-ref">floating</link>
2410 * Returns: %TRUE if @object has a floating reference
2413 g_object_is_floating (gpointer _object)
2415 GObject *object = _object;
2416 g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
2417 return floating_flag_handler (object, 0);
2421 * g_object_ref_sink:
2422 * @object: (type GObject.Object): a #GObject
2424 * Increase the reference count of @object, and possibly remove the
2425 * <link linkend="floating-ref">floating</link> reference, if @object
2426 * has a floating reference.
2428 * In other words, if the object is floating, then this call "assumes
2429 * ownership" of the floating reference, converting it to a normal
2430 * reference by clearing the floating flag while leaving the reference
2431 * count unchanged. If the object is not floating, then this call
2432 * adds a new normal reference increasing the reference count by one.
2436 * Returns: (type GObject.Object) (transfer none): @object
2439 g_object_ref_sink (gpointer _object)
2441 GObject *object = _object;
2442 gboolean was_floating;
2443 g_return_val_if_fail (G_IS_OBJECT (object), object);
2444 g_return_val_if_fail (object->ref_count >= 1, object);
2445 g_object_ref (object);
2446 was_floating = floating_flag_handler (object, -1);
2448 g_object_unref (object);
2453 * g_object_force_floating:
2454 * @object: a #GObject
2456 * This function is intended for #GObject implementations to re-enforce a
2457 * <link linkend="floating-ref">floating</link> object reference.
2458 * Doing this is seldomly required: all
2459 * #GInitiallyUnowned<!-- -->s are created with a floating reference which
2460 * usually just needs to be sunken by calling g_object_ref_sink().
2465 g_object_force_floating (GObject *object)
2467 g_return_if_fail (G_IS_OBJECT (object));
2468 g_return_if_fail (object->ref_count >= 1);
2470 floating_flag_handler (object, +1);
2475 guint n_toggle_refs;
2477 GToggleNotify notify;
2479 } toggle_refs[1]; /* flexible array */
2483 toggle_refs_notify (GObject *object,
2484 gboolean is_last_ref)
2486 ToggleRefStack tstack, *tstackptr;
2488 G_LOCK (toggle_refs_mutex);
2489 tstackptr = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2490 tstack = *tstackptr;
2491 G_UNLOCK (toggle_refs_mutex);
2493 /* Reentrancy here is not as tricky as it seems, because a toggle reference
2494 * will only be notified when there is exactly one of them.
2496 g_assert (tstack.n_toggle_refs == 1);
2497 tstack.toggle_refs[0].notify (tstack.toggle_refs[0].data, tstack.object, is_last_ref);
2501 * g_object_add_toggle_ref: (skip)
2502 * @object: a #GObject
2503 * @notify: a function to call when this reference is the
2504 * last reference to the object, or is no longer
2505 * the last reference.
2506 * @data: data to pass to @notify
2508 * Increases the reference count of the object by one and sets a
2509 * callback to be called when all other references to the object are
2510 * dropped, or when this is already the last reference to the object
2511 * and another reference is established.
2513 * This functionality is intended for binding @object to a proxy
2514 * object managed by another memory manager. This is done with two
2515 * paired references: the strong reference added by
2516 * g_object_add_toggle_ref() and a reverse reference to the proxy
2517 * object which is either a strong reference or weak reference.
2519 * The setup is that when there are no other references to @object,
2520 * only a weak reference is held in the reverse direction from @object
2521 * to the proxy object, but when there are other references held to
2522 * @object, a strong reference is held. The @notify callback is called
2523 * when the reference from @object to the proxy object should be
2524 * <firstterm>toggled</firstterm> from strong to weak (@is_last_ref
2525 * true) or weak to strong (@is_last_ref false).
2527 * Since a (normal) reference must be held to the object before
2528 * calling g_object_toggle_ref(), the initial state of the reverse
2529 * link is always strong.
2531 * Multiple toggle references may be added to the same gobject,
2532 * however if there are multiple toggle references to an object, none
2533 * of them will ever be notified until all but one are removed. For
2534 * this reason, you should only ever use a toggle reference if there
2535 * is important state in the proxy object.
2540 g_object_add_toggle_ref (GObject *object,
2541 GToggleNotify notify,
2544 ToggleRefStack *tstack;
2547 g_return_if_fail (G_IS_OBJECT (object));
2548 g_return_if_fail (notify != NULL);
2549 g_return_if_fail (object->ref_count >= 1);
2551 g_object_ref (object);
2553 G_LOCK (toggle_refs_mutex);
2554 tstack = g_datalist_id_remove_no_notify (&object->qdata, quark_toggle_refs);
2557 i = tstack->n_toggle_refs++;
2558 /* allocate i = tstate->n_toggle_refs - 1 positions beyond the 1 declared
2559 * in tstate->toggle_refs */
2560 tstack = g_realloc (tstack, sizeof (*tstack) + sizeof (tstack->toggle_refs[0]) * i);
2564 tstack = g_renew (ToggleRefStack, NULL, 1);
2565 tstack->object = object;
2566 tstack->n_toggle_refs = 1;
2570 /* Set a flag for fast lookup after adding the first toggle reference */
2571 if (tstack->n_toggle_refs == 1)
2572 g_datalist_set_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2574 tstack->toggle_refs[i].notify = notify;
2575 tstack->toggle_refs[i].data = data;
2576 g_datalist_id_set_data_full (&object->qdata, quark_toggle_refs, tstack,
2577 (GDestroyNotify)g_free);
2578 G_UNLOCK (toggle_refs_mutex);
2582 * g_object_remove_toggle_ref: (skip)
2583 * @object: a #GObject
2584 * @notify: a function to call when this reference is the
2585 * last reference to the object, or is no longer
2586 * the last reference.
2587 * @data: data to pass to @notify
2589 * Removes a reference added with g_object_add_toggle_ref(). The
2590 * reference count of the object is decreased by one.
2595 g_object_remove_toggle_ref (GObject *object,
2596 GToggleNotify notify,
2599 ToggleRefStack *tstack;
2600 gboolean found_one = FALSE;
2602 g_return_if_fail (G_IS_OBJECT (object));
2603 g_return_if_fail (notify != NULL);
2605 G_LOCK (toggle_refs_mutex);
2606 tstack = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2611 for (i = 0; i < tstack->n_toggle_refs; i++)
2612 if (tstack->toggle_refs[i].notify == notify &&
2613 tstack->toggle_refs[i].data == data)
2616 tstack->n_toggle_refs -= 1;
2617 if (i != tstack->n_toggle_refs)
2618 tstack->toggle_refs[i] = tstack->toggle_refs[tstack->n_toggle_refs];
2620 if (tstack->n_toggle_refs == 0)
2621 g_datalist_unset_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2626 G_UNLOCK (toggle_refs_mutex);
2629 g_object_unref (object);
2631 g_warning ("%s: couldn't find toggle ref %p(%p)", G_STRFUNC, notify, data);
2636 * @object: (type GObject.Object): a #GObject
2638 * Increases the reference count of @object.
2640 * Returns: (type GObject.Object) (transfer none): the same @object
2643 g_object_ref (gpointer _object)
2645 GObject *object = _object;
2648 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2649 g_return_val_if_fail (object->ref_count > 0, NULL);
2651 #ifdef G_ENABLE_DEBUG
2652 if (g_trap_object_ref == object)
2654 #endif /* G_ENABLE_DEBUG */
2657 old_val = g_atomic_int_add (&object->ref_count, 1);
2659 if (old_val == 1 && OBJECT_HAS_TOGGLE_REF (object))
2660 toggle_refs_notify (object, FALSE);
2662 TRACE (GOBJECT_OBJECT_REF(object,G_TYPE_FROM_INSTANCE(object),old_val));
2669 * @object: (type GObject.Object): a #GObject
2671 * Decreases the reference count of @object. When its reference count
2672 * drops to 0, the object is finalized (i.e. its memory is freed).
2675 g_object_unref (gpointer _object)
2677 GObject *object = _object;
2680 g_return_if_fail (G_IS_OBJECT (object));
2681 g_return_if_fail (object->ref_count > 0);
2683 #ifdef G_ENABLE_DEBUG
2684 if (g_trap_object_ref == object)
2686 #endif /* G_ENABLE_DEBUG */
2688 /* here we want to atomically do: if (ref_count>1) { ref_count--; return; } */
2689 retry_atomic_decrement1:
2690 old_ref = g_atomic_int_get (&object->ref_count);
2693 /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2694 gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2696 if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2697 goto retry_atomic_decrement1;
2699 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2701 /* if we went from 2->1 we need to notify toggle refs if any */
2702 if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2703 toggle_refs_notify (object, TRUE);
2707 /* we are about tp remove the last reference */
2708 TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 1));
2709 G_OBJECT_GET_CLASS (object)->dispose (object);
2710 TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 1));
2712 /* may have been re-referenced meanwhile */
2713 retry_atomic_decrement2:
2714 old_ref = g_atomic_int_get ((int *)&object->ref_count);
2717 /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2718 gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2720 if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2721 goto retry_atomic_decrement2;
2723 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2725 /* if we went from 2->1 we need to notify toggle refs if any */
2726 if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2727 toggle_refs_notify (object, TRUE);
2732 /* we are still in the process of taking away the last ref */
2733 g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
2734 g_signal_handlers_destroy (object);
2735 g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
2737 /* decrement the last reference */
2738 old_ref = g_atomic_int_add (&object->ref_count, -1);
2740 TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2742 /* may have been re-referenced meanwhile */
2743 if (G_LIKELY (old_ref == 1))
2745 TRACE (GOBJECT_OBJECT_FINALIZE(object,G_TYPE_FROM_INSTANCE(object)));
2746 G_OBJECT_GET_CLASS (object)->finalize (object);
2748 TRACE (GOBJECT_OBJECT_FINALIZE_END(object,G_TYPE_FROM_INSTANCE(object)));
2750 #ifdef G_ENABLE_DEBUG
2753 /* catch objects not chaining finalize handlers */
2754 G_LOCK (debug_objects);
2755 g_assert (g_hash_table_lookup (debug_objects_ht, object) == NULL);
2756 G_UNLOCK (debug_objects);
2758 #endif /* G_ENABLE_DEBUG */
2759 g_type_free_instance ((GTypeInstance*) object);
2765 * g_clear_object: (skip)
2766 * @object_ptr: a pointer to a #GObject reference
2768 * Clears a reference to a #GObject.
2770 * @object_ptr must not be %NULL.
2772 * If the reference is %NULL then this function does nothing.
2773 * Otherwise, the reference count of the object is decreased and the
2774 * pointer is set to %NULL.
2776 * This function is threadsafe and modifies the pointer atomically,
2777 * using memory barriers where needed.
2779 * A macro is also included that allows this function to be used without
2784 #undef g_clear_object
2786 g_clear_object (volatile GObject **object_ptr)
2788 gpointer *ptr = (gpointer) object_ptr;
2791 /* This is a little frustrating.
2792 * Would be nice to have an atomic exchange (with no compare).
2795 old = g_atomic_pointer_get (ptr);
2796 while G_UNLIKELY (!g_atomic_pointer_compare_and_exchange (ptr, old, NULL));
2799 g_object_unref (old);
2803 * g_object_get_qdata:
2804 * @object: The GObject to get a stored user data pointer from
2805 * @quark: A #GQuark, naming the user data pointer
2807 * This function gets back user data pointers stored via
2808 * g_object_set_qdata().
2810 * Returns: (transfer none): The user data pointer set, or %NULL
2813 g_object_get_qdata (GObject *object,
2816 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2818 return quark ? g_datalist_id_get_data (&object->qdata, quark) : NULL;
2822 * g_object_set_qdata: (skip)
2823 * @object: The GObject to set store a user data pointer
2824 * @quark: A #GQuark, naming the user data pointer
2825 * @data: An opaque user data pointer
2827 * This sets an opaque, named pointer on an object.
2828 * The name is specified through a #GQuark (retrived e.g. via
2829 * g_quark_from_static_string()), and the pointer
2830 * can be gotten back from the @object with g_object_get_qdata()
2831 * until the @object is finalized.
2832 * Setting a previously set user data pointer, overrides (frees)
2833 * the old pointer set, using #NULL as pointer essentially
2834 * removes the data stored.
2837 g_object_set_qdata (GObject *object,
2841 g_return_if_fail (G_IS_OBJECT (object));
2842 g_return_if_fail (quark > 0);
2844 g_datalist_id_set_data (&object->qdata, quark, data);
2848 * g_object_set_qdata_full: (skip)
2849 * @object: The GObject to set store a user data pointer
2850 * @quark: A #GQuark, naming the user data pointer
2851 * @data: An opaque user data pointer
2852 * @destroy: Function to invoke with @data as argument, when @data
2855 * This function works like g_object_set_qdata(), but in addition,
2856 * a void (*destroy) (gpointer) function may be specified which is
2857 * called with @data as argument when the @object is finalized, or
2858 * the data is being overwritten by a call to g_object_set_qdata()
2859 * with the same @quark.
2862 g_object_set_qdata_full (GObject *object,
2865 GDestroyNotify destroy)
2867 g_return_if_fail (G_IS_OBJECT (object));
2868 g_return_if_fail (quark > 0);
2870 g_datalist_id_set_data_full (&object->qdata, quark, data,
2871 data ? destroy : (GDestroyNotify) NULL);
2875 * g_object_steal_qdata:
2876 * @object: The GObject to get a stored user data pointer from
2877 * @quark: A #GQuark, naming the user data pointer
2879 * This function gets back user data pointers stored via
2880 * g_object_set_qdata() and removes the @data from object
2881 * without invoking its destroy() function (if any was
2883 * Usually, calling this function is only required to update
2884 * user data pointers with a destroy notifier, for example:
2887 * object_add_to_user_list (GObject *object,
2888 * const gchar *new_string)
2890 * // the quark, naming the object data
2891 * GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
2892 * // retrive the old string list
2893 * GList *list = g_object_steal_qdata (object, quark_string_list);
2895 * // prepend new string
2896 * list = g_list_prepend (list, g_strdup (new_string));
2897 * // this changed 'list', so we need to set it again
2898 * g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
2901 * free_string_list (gpointer data)
2903 * GList *node, *list = data;
2905 * for (node = list; node; node = node->next)
2906 * g_free (node->data);
2907 * g_list_free (list);
2910 * Using g_object_get_qdata() in the above example, instead of
2911 * g_object_steal_qdata() would have left the destroy function set,
2912 * and thus the partial string list would have been freed upon
2913 * g_object_set_qdata_full().
2915 * Returns: (transfer full): The user data pointer set, or %NULL
2918 g_object_steal_qdata (GObject *object,
2921 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2922 g_return_val_if_fail (quark > 0, NULL);
2924 return g_datalist_id_remove_no_notify (&object->qdata, quark);
2928 * g_object_get_data:
2929 * @object: #GObject containing the associations
2930 * @key: name of the key for that association
2932 * Gets a named field from the objects table of associations (see g_object_set_data()).
2934 * Returns: (transfer none): the data if found, or %NULL if no such data exists.
2937 g_object_get_data (GObject *object,
2940 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2941 g_return_val_if_fail (key != NULL, NULL);
2943 return g_datalist_get_data (&object->qdata, key);
2947 * g_object_set_data:
2948 * @object: #GObject containing the associations.
2949 * @key: name of the key
2950 * @data: data to associate with that key
2952 * Each object carries around a table of associations from
2953 * strings to pointers. This function lets you set an association.
2955 * If the object already had an association with that name,
2956 * the old association will be destroyed.
2959 g_object_set_data (GObject *object,
2963 g_return_if_fail (G_IS_OBJECT (object));
2964 g_return_if_fail (key != NULL);
2966 g_datalist_id_set_data (&object->qdata, g_quark_from_string (key), data);
2970 * g_object_set_data_full: (skip)
2971 * @object: #GObject containing the associations
2972 * @key: name of the key
2973 * @data: data to associate with that key
2974 * @destroy: function to call when the association is destroyed
2976 * Like g_object_set_data() except it adds notification
2977 * for when the association is destroyed, either by setting it
2978 * to a different value or when the object is destroyed.
2980 * Note that the @destroy callback is not called if @data is %NULL.
2983 g_object_set_data_full (GObject *object,
2986 GDestroyNotify destroy)
2988 g_return_if_fail (G_IS_OBJECT (object));
2989 g_return_if_fail (key != NULL);
2991 g_datalist_id_set_data_full (&object->qdata, g_quark_from_string (key), data,
2992 data ? destroy : (GDestroyNotify) NULL);
2996 * g_object_steal_data:
2997 * @object: #GObject containing the associations
2998 * @key: name of the key
3000 * Remove a specified datum from the object's data associations,
3001 * without invoking the association's destroy handler.
3003 * Returns: (transfer full): the data if found, or %NULL if no such data exists.
3006 g_object_steal_data (GObject *object,
3011 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3012 g_return_val_if_fail (key != NULL, NULL);
3014 quark = g_quark_try_string (key);
3016 return quark ? g_datalist_id_remove_no_notify (&object->qdata, quark) : NULL;
3020 g_value_object_init (GValue *value)
3022 value->data[0].v_pointer = NULL;
3026 g_value_object_free_value (GValue *value)
3028 if (value->data[0].v_pointer)
3029 g_object_unref (value->data[0].v_pointer);
3033 g_value_object_copy_value (const GValue *src_value,
3036 if (src_value->data[0].v_pointer)
3037 dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3039 dest_value->data[0].v_pointer = NULL;
3043 g_value_object_transform_value (const GValue *src_value,
3046 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)))
3047 dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3049 dest_value->data[0].v_pointer = NULL;
3053 g_value_object_peek_pointer (const GValue *value)
3055 return value->data[0].v_pointer;
3059 g_value_object_collect_value (GValue *value,
3060 guint n_collect_values,
3061 GTypeCValue *collect_values,
3062 guint collect_flags)
3064 if (collect_values[0].v_pointer)
3066 GObject *object = collect_values[0].v_pointer;
3068 if (object->g_type_instance.g_class == NULL)
3069 return g_strconcat ("invalid unclassed object pointer for value type `",
3070 G_VALUE_TYPE_NAME (value),
3073 else if (!g_value_type_compatible (G_OBJECT_TYPE (object), G_VALUE_TYPE (value)))
3074 return g_strconcat ("invalid object type `",
3075 G_OBJECT_TYPE_NAME (object),
3076 "' for value type `",
3077 G_VALUE_TYPE_NAME (value),
3080 /* never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types */
3081 value->data[0].v_pointer = g_object_ref (object);
3084 value->data[0].v_pointer = NULL;
3090 g_value_object_lcopy_value (const GValue *value,
3091 guint n_collect_values,
3092 GTypeCValue *collect_values,
3093 guint collect_flags)
3095 GObject **object_p = collect_values[0].v_pointer;
3098 return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
3100 if (!value->data[0].v_pointer)
3102 else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
3103 *object_p = value->data[0].v_pointer;
3105 *object_p = g_object_ref (value->data[0].v_pointer);
3111 * g_value_set_object:
3112 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3113 * @v_object: (type GObject.Object) (allow-none): object value to be set
3115 * Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
3117 * g_value_set_object() increases the reference count of @v_object
3118 * (the #GValue holds a reference to @v_object). If you do not wish
3119 * to increase the reference count of the object (i.e. you wish to
3120 * pass your current reference to the #GValue because you no longer
3121 * need it), use g_value_take_object() instead.
3123 * It is important that your #GValue holds a reference to @v_object (either its
3124 * own, or one it has taken) to ensure that the object won't be destroyed while
3125 * the #GValue still exists).
3128 g_value_set_object (GValue *value,
3133 g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3135 old = value->data[0].v_pointer;
3139 g_return_if_fail (G_IS_OBJECT (v_object));
3140 g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3142 value->data[0].v_pointer = v_object;
3143 g_object_ref (value->data[0].v_pointer);
3146 value->data[0].v_pointer = NULL;
3149 g_object_unref (old);
3153 * g_value_set_object_take_ownership: (skip)
3154 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3155 * @v_object: (allow-none): object value to be set
3157 * This is an internal function introduced mainly for C marshallers.
3159 * Deprecated: 2.4: Use g_value_take_object() instead.
3162 g_value_set_object_take_ownership (GValue *value,
3165 g_value_take_object (value, v_object);
3169 * g_value_take_object: (skip)
3170 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3171 * @v_object: (allow-none): object value to be set
3173 * Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
3174 * and takes over the ownership of the callers reference to @v_object;
3175 * the caller doesn't have to unref it any more (i.e. the reference
3176 * count of the object is not increased).
3178 * If you want the #GValue to hold its own reference to @v_object, use
3179 * g_value_set_object() instead.
3184 g_value_take_object (GValue *value,
3187 g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3189 if (value->data[0].v_pointer)
3191 g_object_unref (value->data[0].v_pointer);
3192 value->data[0].v_pointer = NULL;
3197 g_return_if_fail (G_IS_OBJECT (v_object));
3198 g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3200 value->data[0].v_pointer = v_object; /* we take over the reference count */
3205 * g_value_get_object:
3206 * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3208 * Get the contents of a %G_TYPE_OBJECT derived #GValue.
3210 * Returns: (type GObject.Object) (transfer none): object contents of @value
3213 g_value_get_object (const GValue *value)
3215 g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3217 return value->data[0].v_pointer;
3221 * g_value_dup_object:
3222 * @value: a valid #GValue whose type is derived from %G_TYPE_OBJECT
3224 * Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing
3225 * its reference count. If the contents of the #GValue are %NULL, then
3226 * %NULL will be returned.
3228 * Returns: (type GObject.Object) (transfer full): object content of @value,
3229 * should be unreferenced when no longer needed.
3232 g_value_dup_object (const GValue *value)
3234 g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3236 return value->data[0].v_pointer ? g_object_ref (value->data[0].v_pointer) : NULL;
3240 * g_signal_connect_object: (skip)
3241 * @instance: the instance to connect to.
3242 * @detailed_signal: a string of the form "signal-name::detail".
3243 * @c_handler: the #GCallback to connect.
3244 * @gobject: the object to pass as data to @c_handler.
3245 * @connect_flags: a combination of #GConnnectFlags.
3247 * This is similar to g_signal_connect_data(), but uses a closure which
3248 * ensures that the @gobject stays alive during the call to @c_handler
3249 * by temporarily adding a reference count to @gobject.
3251 * Note that there is a bug in GObject that makes this function
3252 * much less useful than it might seem otherwise. Once @gobject is
3253 * disposed, the callback will no longer be called, but, the signal
3254 * handler is <emphasis>not</emphasis> currently disconnected. If the
3255 * @instance is itself being freed at the same time than this doesn't
3256 * matter, since the signal will automatically be removed, but
3257 * if @instance persists, then the signal handler will leak. You
3258 * should not remove the signal yourself because in a future versions of
3259 * GObject, the handler <emphasis>will</emphasis> automatically
3262 * It's possible to work around this problem in a way that will
3263 * continue to work with future versions of GObject by checking
3264 * that the signal handler is still connected before disconnected it:
3265 * <informalexample><programlisting>
3266 * if (g_signal_handler_is_connected (instance, id))
3267 * g_signal_handler_disconnect (instance, id);
3268 * </programlisting></informalexample>
3270 * Returns: the handler id.
3273 g_signal_connect_object (gpointer instance,
3274 const gchar *detailed_signal,
3275 GCallback c_handler,
3277 GConnectFlags connect_flags)
3279 g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
3280 g_return_val_if_fail (detailed_signal != NULL, 0);
3281 g_return_val_if_fail (c_handler != NULL, 0);
3287 g_return_val_if_fail (G_IS_OBJECT (gobject), 0);
3289 closure = ((connect_flags & G_CONNECT_SWAPPED) ? g_cclosure_new_object_swap : g_cclosure_new_object) (c_handler, gobject);
3291 return g_signal_connect_closure (instance, detailed_signal, closure, connect_flags & G_CONNECT_AFTER);
3294 return g_signal_connect_data (instance, detailed_signal, c_handler, NULL, NULL, connect_flags);
3300 GClosure *closures[1]; /* flexible array */
3302 /* don't change this structure without supplying an accessor for
3303 * watched closures, e.g.:
3304 * GSList* g_object_list_watched_closures (GObject *object)
3307 * g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3308 * carray = g_object_get_data (object, "GObject-closure-array");
3311 * GSList *slist = NULL;
3313 * for (i = 0; i < carray->n_closures; i++)
3314 * slist = g_slist_prepend (slist, carray->closures[i]);
3322 object_remove_closure (gpointer data,
3325 GObject *object = data;
3329 G_LOCK (closure_array_mutex);
3330 carray = g_object_get_qdata (object, quark_closure_array);
3331 for (i = 0; i < carray->n_closures; i++)
3332 if (carray->closures[i] == closure)
3334 carray->n_closures--;
3335 if (i < carray->n_closures)
3336 carray->closures[i] = carray->closures[carray->n_closures];
3337 G_UNLOCK (closure_array_mutex);
3340 G_UNLOCK (closure_array_mutex);
3341 g_assert_not_reached ();
3345 destroy_closure_array (gpointer data)
3347 CArray *carray = data;
3348 GObject *object = carray->object;
3349 guint i, n = carray->n_closures;
3351 for (i = 0; i < n; i++)
3353 GClosure *closure = carray->closures[i];
3355 /* removing object_remove_closure() upfront is probably faster than
3356 * letting it fiddle with quark_closure_array which is empty anyways
3358 g_closure_remove_invalidate_notifier (closure, object, object_remove_closure);
3359 g_closure_invalidate (closure);
3365 * g_object_watch_closure:
3366 * @object: GObject restricting lifetime of @closure
3367 * @closure: GClosure to watch
3369 * This function essentially limits the life time of the @closure to
3370 * the life time of the object. That is, when the object is finalized,
3371 * the @closure is invalidated by calling g_closure_invalidate() on
3372 * it, in order to prevent invocations of the closure with a finalized
3373 * (nonexisting) object. Also, g_object_ref() and g_object_unref() are
3374 * added as marshal guards to the @closure, to ensure that an extra
3375 * reference count is held on @object during invocation of the
3376 * @closure. Usually, this function will be called on closures that
3377 * use this @object as closure data.
3380 g_object_watch_closure (GObject *object,
3386 g_return_if_fail (G_IS_OBJECT (object));
3387 g_return_if_fail (closure != NULL);
3388 g_return_if_fail (closure->is_invalid == FALSE);
3389 g_return_if_fail (closure->in_marshal == FALSE);
3390 g_return_if_fail (object->ref_count > 0); /* this doesn't work on finalizing objects */
3392 g_closure_add_invalidate_notifier (closure, object, object_remove_closure);
3393 g_closure_add_marshal_guards (closure,
3394 object, (GClosureNotify) g_object_ref,
3395 object, (GClosureNotify) g_object_unref);
3396 G_LOCK (closure_array_mutex);
3397 carray = g_datalist_id_remove_no_notify (&object->qdata, quark_closure_array);
3400 carray = g_renew (CArray, NULL, 1);
3401 carray->object = object;
3402 carray->n_closures = 1;
3407 i = carray->n_closures++;
3408 carray = g_realloc (carray, sizeof (*carray) + sizeof (carray->closures[0]) * i);
3410 carray->closures[i] = closure;
3411 g_datalist_id_set_data_full (&object->qdata, quark_closure_array, carray, destroy_closure_array);
3412 G_UNLOCK (closure_array_mutex);
3416 * g_closure_new_object:
3417 * @sizeof_closure: the size of the structure to allocate, must be at least
3418 * <literal>sizeof (GClosure)</literal>
3419 * @object: a #GObject pointer to store in the @data field of the newly
3420 * allocated #GClosure
3422 * A variant of g_closure_new_simple() which stores @object in the
3423 * @data field of the closure and calls g_object_watch_closure() on
3424 * @object and the created closure. This function is mainly useful
3425 * when implementing new types of closures.
3427 * Returns: (transfer full): a newly allocated #GClosure
3430 g_closure_new_object (guint sizeof_closure,
3435 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3436 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3438 closure = g_closure_new_simple (sizeof_closure, object);
3439 g_object_watch_closure (object, closure);
3445 * g_cclosure_new_object: (skip)
3446 * @callback_func: the function to invoke
3447 * @object: a #GObject pointer to pass to @callback_func
3449 * A variant of g_cclosure_new() which uses @object as @user_data and
3450 * calls g_object_watch_closure() on @object and the created
3451 * closure. This function is useful when you have a callback closely
3452 * associated with a #GObject, and want the callback to no longer run
3453 * after the object is is freed.
3455 * Returns: a new #GCClosure
3458 g_cclosure_new_object (GCallback callback_func,
3463 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3464 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3465 g_return_val_if_fail (callback_func != NULL, NULL);
3467 closure = g_cclosure_new (callback_func, object, NULL);
3468 g_object_watch_closure (object, closure);
3474 * g_cclosure_new_object_swap: (skip)
3475 * @callback_func: the function to invoke
3476 * @object: a #GObject pointer to pass to @callback_func
3478 * A variant of g_cclosure_new_swap() which uses @object as @user_data
3479 * and calls g_object_watch_closure() on @object and the created
3480 * closure. This function is useful when you have a callback closely
3481 * associated with a #GObject, and want the callback to no longer run
3482 * after the object is is freed.
3484 * Returns: a new #GCClosure
3487 g_cclosure_new_object_swap (GCallback callback_func,
3492 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3493 g_return_val_if_fail (object->ref_count > 0, NULL); /* this doesn't work on finalizing objects */
3494 g_return_val_if_fail (callback_func != NULL, NULL);
3496 closure = g_cclosure_new_swap (callback_func, object, NULL);
3497 g_object_watch_closure (object, closure);
3503 g_object_compat_control (gsize what,
3509 case 1: /* floating base type */
3510 return G_TYPE_INITIALLY_UNOWNED;
3511 case 2: /* FIXME: remove this once GLib/Gtk+ break ABI again */
3512 floating_flag_handler = (guint(*)(GObject*,gint)) data;
3514 case 3: /* FIXME: remove this once GLib/Gtk+ break ABI again */
3516 *pp = floating_flag_handler;
3523 G_DEFINE_TYPE (GInitiallyUnowned, g_initially_unowned, G_TYPE_OBJECT);
3526 g_initially_unowned_init (GInitiallyUnowned *object)
3528 g_object_force_floating (object);
3532 g_initially_unowned_class_init (GInitiallyUnownedClass *klass)