gobject: Clean up logic in property checks
[platform/upstream/glib.git] / gobject / gobject.c
1 /* GObject - GLib Type, Object, Parameter and Signal Library
2  * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 /*
21  * MT safe with regards to reference counting.
22  */
23
24 #include "config.h"
25
26 #include <string.h>
27 #include <signal.h>
28
29 #include "gobject.h"
30 #include "gtype-private.h"
31 #include "gvaluecollector.h"
32 #include "gsignal.h"
33 #include "gparamspecs.h"
34 #include "gvaluetypes.h"
35 #include "gobject_trace.h"
36
37 /**
38  * SECTION:objects
39  * @title: GObject
40  * @short_description: The base object type
41  * @see_also: #GParamSpecObject, g_param_spec_object()
42  *
43  * GObject is the fundamental type providing the common attributes and
44  * methods for all object types in GTK+, Pango and other libraries
45  * based on GObject.  The GObject class provides methods for object
46  * construction and destruction, property access methods, and signal
47  * support.  Signals are described in detail in <xref
48  * linkend="gobject-Signals"/>.
49  *
50  * <para id="floating-ref">
51  * GInitiallyUnowned is derived from GObject. The only difference between
52  * the two is that the initial reference of a GInitiallyUnowned is flagged
53  * as a <firstterm>floating</firstterm> reference.
54  * This means that it is not specifically claimed to be "owned" by
55  * any code portion. The main motivation for providing floating references is
56  * C convenience. In particular, it allows code to be written as:
57  * |[
58  * container = create_container ();
59  * container_add_child (container, create_child());
60  * ]|
61  * If <function>container_add_child()</function> will g_object_ref_sink() the
62  * passed in child, no reference of the newly created child is leaked.
63  * Without floating references, <function>container_add_child()</function>
64  * can only g_object_ref() the new child, so to implement this code without
65  * reference leaks, it would have to be written as:
66  * |[
67  * Child *child;
68  * container = create_container ();
69  * child = create_child ();
70  * container_add_child (container, child);
71  * g_object_unref (child);
72  * ]|
73  * The floating reference can be converted into
74  * an ordinary reference by calling g_object_ref_sink().
75  * For already sunken objects (objects that don't have a floating reference
76  * anymore), g_object_ref_sink() is equivalent to g_object_ref() and returns
77  * a new reference.
78  * Since floating references are useful almost exclusively for C convenience,
79  * language bindings that provide automated reference and memory ownership
80  * maintenance (such as smart pointers or garbage collection) should not
81  * expose floating references in their API.
82  * </para>
83  *
84  * Some object implementations may need to save an objects floating state
85  * across certain code portions (an example is #GtkMenu), to achieve this,
86  * the following sequence can be used:
87  *
88  * |[
89  * /&ast; save floating state &ast;/
90  * gboolean was_floating = g_object_is_floating (object);
91  * g_object_ref_sink (object);
92  * /&ast; protected code portion &ast;/
93  * ...;
94  * /&ast; restore floating state &ast;/
95  * if (was_floating)
96  *   g_object_force_floating (object);
97  * g_object_unref (object); /&ast; release previously acquired reference &ast;/
98  * ]|
99  */
100
101
102 /* --- macros --- */
103 #define PARAM_SPEC_PARAM_ID(pspec)              ((pspec)->param_id)
104 #define PARAM_SPEC_SET_PARAM_ID(pspec, id)      ((pspec)->param_id = (id))
105
106 #define OBJECT_HAS_TOGGLE_REF_FLAG 0x1
107 #define OBJECT_HAS_TOGGLE_REF(object) \
108     ((g_datalist_get_flags (&(object)->qdata) & OBJECT_HAS_TOGGLE_REF_FLAG) != 0)
109 #define OBJECT_FLOATING_FLAG 0x2
110
111 #define CLASS_HAS_PROPS_FLAG 0x1
112 #define CLASS_HAS_PROPS(class) \
113     ((class)->flags & CLASS_HAS_PROPS_FLAG)
114 #define CLASS_HAS_CUSTOM_CONSTRUCTOR(class) \
115     ((class)->constructor != g_object_constructor)
116 #define CLASS_HAS_CUSTOM_CONSTRUCTED(class) \
117     ((class)->constructed != g_object_constructed)
118
119 #define CLASS_HAS_DERIVED_CLASS_FLAG 0x2
120 #define CLASS_HAS_DERIVED_CLASS(class) \
121     ((class)->flags & CLASS_HAS_DERIVED_CLASS_FLAG)
122
123 /* --- signals --- */
124 enum {
125   NOTIFY,
126   LAST_SIGNAL
127 };
128
129
130 /* --- properties --- */
131 enum {
132   PROP_NONE
133 };
134
135
136 /* --- prototypes --- */
137 static void     g_object_base_class_init                (GObjectClass   *class);
138 static void     g_object_base_class_finalize            (GObjectClass   *class);
139 static void     g_object_do_class_init                  (GObjectClass   *class);
140 static void     g_object_init                           (GObject        *object,
141                                                          GObjectClass   *class);
142 static GObject* g_object_constructor                    (GType                  type,
143                                                          guint                  n_construct_properties,
144                                                          GObjectConstructParam *construct_params);
145 static void     g_object_constructed                    (GObject        *object);
146 static void     g_object_real_dispose                   (GObject        *object);
147 static void     g_object_finalize                       (GObject        *object);
148 static void     g_object_do_set_property                (GObject        *object,
149                                                          guint           property_id,
150                                                          const GValue   *value,
151                                                          GParamSpec     *pspec);
152 static void     g_object_do_get_property                (GObject        *object,
153                                                          guint           property_id,
154                                                          GValue         *value,
155                                                          GParamSpec     *pspec);
156 static void     g_value_object_init                     (GValue         *value);
157 static void     g_value_object_free_value               (GValue         *value);
158 static void     g_value_object_copy_value               (const GValue   *src_value,
159                                                          GValue         *dest_value);
160 static void     g_value_object_transform_value          (const GValue   *src_value,
161                                                          GValue         *dest_value);
162 static gpointer g_value_object_peek_pointer             (const GValue   *value);
163 static gchar*   g_value_object_collect_value            (GValue         *value,
164                                                          guint           n_collect_values,
165                                                          GTypeCValue    *collect_values,
166                                                          guint           collect_flags);
167 static gchar*   g_value_object_lcopy_value              (const GValue   *value,
168                                                          guint           n_collect_values,
169                                                          GTypeCValue    *collect_values,
170                                                          guint           collect_flags);
171 static void     g_object_dispatch_properties_changed    (GObject        *object,
172                                                          guint           n_pspecs,
173                                                          GParamSpec    **pspecs);
174 static guint               object_floating_flag_handler (GObject        *object,
175                                                          gint            job);
176
177 static void object_interface_check_properties           (gpointer        func_data,
178                                                          gpointer        g_iface);
179
180 /* --- typedefs --- */
181 typedef struct _GObjectNotifyQueue            GObjectNotifyQueue;
182
183 struct _GObjectNotifyQueue
184 {
185   GSList  *pspecs;
186   guint16  n_pspecs;
187   guint16  freeze_count;
188 };
189
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 GQuark               quark_notify_queue;
198 static GParamSpecPool      *pspec_pool = NULL;
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;
203
204 G_LOCK_DEFINE_STATIC(notify_lock);
205
206 /* --- functions --- */
207 static void
208 g_object_notify_queue_free (gpointer data)
209 {
210   GObjectNotifyQueue *nqueue = data;
211
212   g_slist_free (nqueue->pspecs);
213   g_slice_free (GObjectNotifyQueue, nqueue);
214 }
215
216 static GObjectNotifyQueue*
217 g_object_notify_queue_freeze (GObject  *object,
218                               gboolean  conditional)
219 {
220   GObjectNotifyQueue *nqueue;
221
222   G_LOCK(notify_lock);
223   nqueue = g_datalist_id_get_data (&object->qdata, quark_notify_queue);
224   if (!nqueue)
225     {
226       if (conditional)
227         {
228           G_UNLOCK(notify_lock);
229           return NULL;
230         }
231
232       nqueue = g_slice_new0 (GObjectNotifyQueue);
233       g_datalist_id_set_data_full (&object->qdata, quark_notify_queue,
234                                    nqueue, g_object_notify_queue_free);
235     }
236
237   if (nqueue->freeze_count >= 65535)
238     g_critical("Free queue for %s (%p) is larger than 65535,"
239                " called g_object_freeze_notify() too often."
240                " Forgot to call g_object_thaw_notify() or infinite loop",
241                G_OBJECT_TYPE_NAME (object), object);
242   else
243     nqueue->freeze_count++;
244   G_UNLOCK(notify_lock);
245
246   return nqueue;
247 }
248
249 static void
250 g_object_notify_queue_thaw (GObject            *object,
251                             GObjectNotifyQueue *nqueue)
252 {
253   GParamSpec *pspecs_mem[16], **pspecs, **free_me = NULL;
254   GSList *slist;
255   guint n_pspecs = 0;
256
257   g_return_if_fail (nqueue->freeze_count > 0);
258   g_return_if_fail (g_atomic_int_get(&object->ref_count) > 0);
259
260   G_LOCK(notify_lock);
261
262   /* Just make sure we never get into some nasty race condition */
263   if (G_UNLIKELY(nqueue->freeze_count == 0)) {
264     G_UNLOCK(notify_lock);
265     g_warning ("%s: property-changed notification for %s(%p) is not frozen",
266                G_STRFUNC, G_OBJECT_TYPE_NAME (object), object);
267     return;
268   }
269
270   nqueue->freeze_count--;
271   if (nqueue->freeze_count) {
272     G_UNLOCK(notify_lock);
273     return;
274   }
275
276   pspecs = nqueue->n_pspecs > 16 ? free_me = g_new (GParamSpec*, nqueue->n_pspecs) : pspecs_mem;
277
278   for (slist = nqueue->pspecs; slist; slist = slist->next)
279     {
280       pspecs[n_pspecs++] = slist->data;
281     }
282   g_datalist_id_set_data (&object->qdata, quark_notify_queue, NULL);
283
284   G_UNLOCK(notify_lock);
285
286   if (n_pspecs)
287     G_OBJECT_GET_CLASS (object)->dispatch_properties_changed (object, n_pspecs, pspecs);
288   g_free (free_me);
289 }
290
291 static void
292 g_object_notify_queue_add (GObject            *object,
293                            GObjectNotifyQueue *nqueue,
294                            GParamSpec         *pspec)
295 {
296   G_LOCK(notify_lock);
297
298   g_return_if_fail (nqueue->n_pspecs < 65535);
299
300   if (g_slist_find (nqueue->pspecs, pspec) == NULL)
301     {
302       nqueue->pspecs = g_slist_prepend (nqueue->pspecs, pspec);
303       nqueue->n_pspecs++;
304     }
305
306   G_UNLOCK(notify_lock);
307 }
308
309 #ifdef  G_ENABLE_DEBUG
310 #define IF_DEBUG(debug_type)    if (_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type)
311 G_LOCK_DEFINE_STATIC     (debug_objects);
312 static volatile GObject *g_trap_object_ref = NULL;
313 static guint             debug_objects_count = 0;
314 static GHashTable       *debug_objects_ht = NULL;
315
316 static void
317 debug_objects_foreach (gpointer key,
318                        gpointer value,
319                        gpointer user_data)
320 {
321   GObject *object = value;
322
323   g_message ("[%p] stale %s\tref_count=%u",
324              object,
325              G_OBJECT_TYPE_NAME (object),
326              object->ref_count);
327 }
328
329 static void
330 debug_objects_atexit (void)
331 {
332   IF_DEBUG (OBJECTS)
333     {
334       G_LOCK (debug_objects);
335       g_message ("stale GObjects: %u", debug_objects_count);
336       g_hash_table_foreach (debug_objects_ht, debug_objects_foreach, NULL);
337       G_UNLOCK (debug_objects);
338     }
339 }
340 #endif  /* G_ENABLE_DEBUG */
341
342 void
343 _g_object_type_init (void)
344 {
345   static gboolean initialized = FALSE;
346   static const GTypeFundamentalInfo finfo = {
347     G_TYPE_FLAG_CLASSED | G_TYPE_FLAG_INSTANTIATABLE | G_TYPE_FLAG_DERIVABLE | G_TYPE_FLAG_DEEP_DERIVABLE,
348   };
349   GTypeInfo info = {
350     sizeof (GObjectClass),
351     (GBaseInitFunc) g_object_base_class_init,
352     (GBaseFinalizeFunc) g_object_base_class_finalize,
353     (GClassInitFunc) g_object_do_class_init,
354     NULL        /* class_destroy */,
355     NULL        /* class_data */,
356     sizeof (GObject),
357     0           /* n_preallocs */,
358     (GInstanceInitFunc) g_object_init,
359     NULL,       /* value_table */
360   };
361   static const GTypeValueTable value_table = {
362     g_value_object_init,          /* value_init */
363     g_value_object_free_value,    /* value_free */
364     g_value_object_copy_value,    /* value_copy */
365     g_value_object_peek_pointer,  /* value_peek_pointer */
366     "p",                          /* collect_format */
367     g_value_object_collect_value, /* collect_value */
368     "p",                          /* lcopy_format */
369     g_value_object_lcopy_value,   /* lcopy_value */
370   };
371   GType type;
372   
373   g_return_if_fail (initialized == FALSE);
374   initialized = TRUE;
375   
376   /* G_TYPE_OBJECT
377    */
378   info.value_table = &value_table;
379   type = g_type_register_fundamental (G_TYPE_OBJECT, g_intern_static_string ("GObject"), &info, &finfo, 0);
380   g_assert (type == G_TYPE_OBJECT);
381   g_value_register_transform_func (G_TYPE_OBJECT, G_TYPE_OBJECT, g_value_object_transform_value);
382   
383 #ifdef  G_ENABLE_DEBUG
384   IF_DEBUG (OBJECTS)
385     {
386       debug_objects_ht = g_hash_table_new (g_direct_hash, NULL);
387       g_atexit (debug_objects_atexit);
388     }
389 #endif  /* G_ENABLE_DEBUG */
390 }
391
392 static void
393 g_object_base_class_init (GObjectClass *class)
394 {
395   GObjectClass *pclass = g_type_class_peek_parent (class);
396
397   /* Don't inherit HAS_DERIVED_CLASS flag from parent class */
398   class->flags &= ~CLASS_HAS_DERIVED_CLASS_FLAG;
399
400   if (pclass)
401     pclass->flags |= CLASS_HAS_DERIVED_CLASS_FLAG;
402
403   /* reset instance specific fields and methods that don't get inherited */
404   class->construct_properties = pclass ? g_slist_copy (pclass->construct_properties) : NULL;
405   class->get_property = NULL;
406   class->set_property = NULL;
407 }
408
409 static void
410 g_object_base_class_finalize (GObjectClass *class)
411 {
412   GList *list, *node;
413   
414   _g_signals_destroy (G_OBJECT_CLASS_TYPE (class));
415
416   g_slist_free (class->construct_properties);
417   class->construct_properties = NULL;
418   list = g_param_spec_pool_list_owned (pspec_pool, G_OBJECT_CLASS_TYPE (class));
419   for (node = list; node; node = node->next)
420     {
421       GParamSpec *pspec = node->data;
422       
423       g_param_spec_pool_remove (pspec_pool, pspec);
424       PARAM_SPEC_SET_PARAM_ID (pspec, 0);
425       g_param_spec_unref (pspec);
426     }
427   g_list_free (list);
428 }
429
430 static void
431 g_object_do_class_init (GObjectClass *class)
432 {
433   /* read the comment about typedef struct CArray; on why not to change this quark */
434   quark_closure_array = g_quark_from_static_string ("GObject-closure-array");
435
436   quark_weak_refs = g_quark_from_static_string ("GObject-weak-references");
437   quark_toggle_refs = g_quark_from_static_string ("GObject-toggle-references");
438   quark_notify_queue = g_quark_from_static_string ("GObject-notify-queue");
439   pspec_pool = g_param_spec_pool_new (TRUE);
440
441   class->constructor = g_object_constructor;
442   class->constructed = g_object_constructed;
443   class->set_property = g_object_do_set_property;
444   class->get_property = g_object_do_get_property;
445   class->dispose = g_object_real_dispose;
446   class->finalize = g_object_finalize;
447   class->dispatch_properties_changed = g_object_dispatch_properties_changed;
448   class->notify = NULL;
449
450   /**
451    * GObject::notify:
452    * @gobject: the object which received the signal.
453    * @pspec: the #GParamSpec of the property which changed.
454    *
455    * The notify signal is emitted on an object when one of its
456    * properties has been changed. Note that getting this signal
457    * doesn't guarantee that the value of the property has actually
458    * changed, it may also be emitted when the setter for the property
459    * is called to reinstate the previous value.
460    *
461    * This signal is typically used to obtain change notification for a
462    * single property, by specifying the property name as a detail in the
463    * g_signal_connect() call, like this:
464    * |[
465    * g_signal_connect (text_view->buffer, "notify::paste-target-list",
466    *                   G_CALLBACK (gtk_text_view_target_list_notify),
467    *                   text_view)
468    * ]|
469    * It is important to note that you must use
470    * <link linkend="canonical-parameter-name">canonical</link> parameter names as
471    * detail strings for the notify signal.
472    */
473   gobject_signals[NOTIFY] =
474     g_signal_new (g_intern_static_string ("notify"),
475                   G_TYPE_FROM_CLASS (class),
476                   G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED | G_SIGNAL_NO_HOOKS | G_SIGNAL_ACTION,
477                   G_STRUCT_OFFSET (GObjectClass, notify),
478                   NULL, NULL,
479                   g_cclosure_marshal_VOID__PARAM,
480                   G_TYPE_NONE,
481                   1, G_TYPE_PARAM);
482
483   /* Install a check function that we'll use to verify that classes that
484    * implement an interface implement all properties for that interface
485    */
486   g_type_add_interface_check (NULL, object_interface_check_properties);
487 }
488
489 static inline void
490 install_property_internal (GType       g_type,
491                            guint       property_id,
492                            GParamSpec *pspec)
493 {
494   if (g_param_spec_pool_lookup (pspec_pool, pspec->name, g_type, FALSE))
495     {
496       g_warning ("When installing property: type `%s' already has a property named `%s'",
497                  g_type_name (g_type),
498                  pspec->name);
499       return;
500     }
501
502   g_param_spec_ref_sink (pspec);
503   PARAM_SPEC_SET_PARAM_ID (pspec, property_id);
504   g_param_spec_pool_insert (pspec_pool, pspec, g_type);
505 }
506
507 /**
508  * g_object_class_install_property:
509  * @oclass: a #GObjectClass
510  * @property_id: the id for the new property
511  * @pspec: the #GParamSpec for the new property
512  *
513  * Installs a new property. This is usually done in the class initializer.
514  *
515  * Note that it is possible to redefine a property in a derived class,
516  * by installing a property with the same name. This can be useful at times,
517  * e.g. to change the range of allowed values or the default value.
518  */
519 void
520 g_object_class_install_property (GObjectClass *class,
521                                  guint         property_id,
522                                  GParamSpec   *pspec)
523 {
524   g_return_if_fail (G_IS_OBJECT_CLASS (class));
525   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
526
527   if (CLASS_HAS_DERIVED_CLASS (class))
528     g_error ("Attempt to add property %s::%s to class after it was derived",
529              G_OBJECT_CLASS_NAME (class), pspec->name);
530
531   class->flags |= CLASS_HAS_PROPS_FLAG;
532
533   if (pspec->flags & G_PARAM_WRITABLE)
534     g_return_if_fail (class->set_property != NULL);
535   if (pspec->flags & G_PARAM_READABLE)
536     g_return_if_fail (class->get_property != NULL);
537   g_return_if_fail (property_id > 0);
538   g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0);  /* paranoid */
539   if (pspec->flags & G_PARAM_CONSTRUCT)
540     g_return_if_fail ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
541   if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
542     g_return_if_fail (pspec->flags & G_PARAM_WRITABLE);
543
544   install_property_internal (G_OBJECT_CLASS_TYPE (class), property_id, pspec);
545
546   if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
547     class->construct_properties = g_slist_prepend (class->construct_properties, pspec);
548
549   /* for property overrides of construct properties, we have to get rid
550    * of the overidden inherited construct property
551    */
552   pspec = g_param_spec_pool_lookup (pspec_pool, pspec->name, g_type_parent (G_OBJECT_CLASS_TYPE (class)), TRUE);
553   if (pspec && pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
554     class->construct_properties = g_slist_remove (class->construct_properties, pspec);
555 }
556
557 /**
558  * g_object_class_install_properties:
559  * @oclass: a #GObjectClass
560  * @n_pspecs: the length of the #GParamSpec<!-- -->s array
561  * @pspecs: (array length=n_pspecs): the #GParamSpec<!-- -->s array
562  *   defining the new properties
563  *
564  * Installs new properties from an array of #GParamSpec<!-- -->s. This is
565  * usually done in the class initializer.
566  *
567  * The property id of each property is the index of each #GParamSpec in
568  * the @pspecs array.
569  *
570  * The property id of 0 is treated specially by #GObject and it should not
571  * be used to store a #GParamSpec.
572  *
573  * This function should be used if you plan to use a static array of
574  * #GParamSpec<!-- -->s and g_object_notify_by_pspec(). For instance, this
575  * class initialization:
576  *
577  * |[
578  * enum {
579  *   PROP_0, PROP_FOO, PROP_BAR, N_PROPERTIES
580  * };
581  *
582  * static GParamSpec *obj_properties[N_PROPERTIES] = { NULL, };
583  *
584  * static void
585  * my_object_class_init (MyObjectClass *klass)
586  * {
587  *   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
588  *
589  *   obj_properties[PROP_FOO] =
590  *     g_param_spec_int ("foo", "Foo", "Foo",
591  *                       -1, G_MAXINT,
592  *                       0,
593  *                       G_PARAM_READWRITE);
594  *
595  *   obj_properties[PROP_BAR] =
596  *     g_param_spec_string ("bar", "Bar", "Bar",
597  *                          NULL,
598  *                          G_PARAM_READWRITE);
599  *
600  *   gobject_class->set_property = my_object_set_property;
601  *   gobject_class->get_property = my_object_get_property;
602  *   g_object_class_install_properties (gobject_class,
603  *                                      N_PROPERTIES,
604  *                                      obj_properties);
605  * }
606  * ]|
607  *
608  * allows calling g_object_notify_by_pspec() to notify of property changes:
609  *
610  * |[
611  * void
612  * my_object_set_foo (MyObject *self, gint foo)
613  * {
614  *   if (self->foo != foo)
615  *     {
616  *       self->foo = foo;
617  *       g_object_notify_by_pspec (G_OBJECT (self), obj_properties[PROP_FOO]);
618  *     }
619  *  }
620  * ]|
621  *
622  * Since: 2.26
623  */
624 void
625 g_object_class_install_properties (GObjectClass  *oclass,
626                                    guint          n_pspecs,
627                                    GParamSpec   **pspecs)
628 {
629   GType oclass_type, parent_type;
630   gint i;
631
632   g_return_if_fail (G_IS_OBJECT_CLASS (oclass));
633   g_return_if_fail (n_pspecs > 1);
634   g_return_if_fail (pspecs[0] == NULL);
635
636   if (CLASS_HAS_DERIVED_CLASS (oclass))
637     g_error ("Attempt to add properties to %s after it was derived",
638              G_OBJECT_CLASS_NAME (oclass));
639
640   oclass_type = G_OBJECT_CLASS_TYPE (oclass);
641   parent_type = g_type_parent (oclass_type);
642
643   /* we skip the first element of the array as it would have a 0 prop_id */
644   for (i = 1; i < n_pspecs; i++)
645     {
646       GParamSpec *pspec = pspecs[i];
647
648       g_return_if_fail (pspec != NULL);
649
650       if (pspec->flags & G_PARAM_WRITABLE)
651         g_return_if_fail (oclass->set_property != NULL);
652       if (pspec->flags & G_PARAM_READABLE)
653         g_return_if_fail (oclass->get_property != NULL);
654       g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0);      /* paranoid */
655       if (pspec->flags & G_PARAM_CONSTRUCT)
656         g_return_if_fail ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
657       if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
658         g_return_if_fail (pspec->flags & G_PARAM_WRITABLE);
659
660       oclass->flags |= CLASS_HAS_PROPS_FLAG;
661       install_property_internal (oclass_type, i, pspec);
662
663       if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
664         oclass->construct_properties = g_slist_prepend (oclass->construct_properties, pspec);
665
666       /* for property overrides of construct properties, we have to get rid
667        * of the overidden inherited construct property
668        */
669       pspec = g_param_spec_pool_lookup (pspec_pool, pspec->name, parent_type, TRUE);
670       if (pspec && pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
671         oclass->construct_properties = g_slist_remove (oclass->construct_properties, pspec);
672     }
673 }
674
675 /**
676  * g_object_interface_install_property:
677  * @g_iface: any interface vtable for the interface, or the default
678  *  vtable for the interface.
679  * @pspec: the #GParamSpec for the new property
680  *
681  * Add a property to an interface; this is only useful for interfaces
682  * that are added to GObject-derived types. Adding a property to an
683  * interface forces all objects classes with that interface to have a
684  * compatible property. The compatible property could be a newly
685  * created #GParamSpec, but normally
686  * g_object_class_override_property() will be used so that the object
687  * class only needs to provide an implementation and inherits the
688  * property description, default value, bounds, and so forth from the
689  * interface property.
690  *
691  * This function is meant to be called from the interface's default
692  * vtable initialization function (the @class_init member of
693  * #GTypeInfo.) It must not be called after after @class_init has
694  * been called for any object types implementing this interface.
695  *
696  * Since: 2.4
697  */
698 void
699 g_object_interface_install_property (gpointer      g_iface,
700                                      GParamSpec   *pspec)
701 {
702   GTypeInterface *iface_class = g_iface;
703         
704   g_return_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type));
705   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
706   g_return_if_fail (!G_IS_PARAM_SPEC_OVERRIDE (pspec)); /* paranoid */
707   g_return_if_fail (PARAM_SPEC_PARAM_ID (pspec) == 0);  /* paranoid */
708                     
709   install_property_internal (iface_class->g_type, 0, pspec);
710 }
711
712 /**
713  * g_object_class_find_property:
714  * @oclass: a #GObjectClass
715  * @property_name: the name of the property to look up
716  *
717  * Looks up the #GParamSpec for a property of a class.
718  *
719  * Returns: (transfer none): the #GParamSpec for the property, or
720  *          %NULL if the class doesn't have a property of that name
721  */
722 GParamSpec*
723 g_object_class_find_property (GObjectClass *class,
724                               const gchar  *property_name)
725 {
726   GParamSpec *pspec;
727   GParamSpec *redirect;
728         
729   g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
730   g_return_val_if_fail (property_name != NULL, NULL);
731   
732   pspec = g_param_spec_pool_lookup (pspec_pool,
733                                     property_name,
734                                     G_OBJECT_CLASS_TYPE (class),
735                                     TRUE);
736   if (pspec)
737     {
738       redirect = g_param_spec_get_redirect_target (pspec);
739       if (redirect)
740         return redirect;
741       else
742         return pspec;
743     }
744   else
745     return NULL;
746 }
747
748 /**
749  * g_object_interface_find_property:
750  * @g_iface: any interface vtable for the interface, or the default
751  *  vtable for the interface
752  * @property_name: name of a property to lookup.
753  *
754  * Find the #GParamSpec with the given name for an
755  * interface. Generally, the interface vtable passed in as @g_iface
756  * will be the default vtable from g_type_default_interface_ref(), or,
757  * if you know the interface has already been loaded,
758  * g_type_default_interface_peek().
759  *
760  * Since: 2.4
761  *
762  * Returns: (transfer none): the #GParamSpec for the property of the
763  *          interface with the name @property_name, or %NULL if no
764  *          such property exists.
765  */
766 GParamSpec*
767 g_object_interface_find_property (gpointer      g_iface,
768                                   const gchar  *property_name)
769 {
770   GTypeInterface *iface_class = g_iface;
771         
772   g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type), NULL);
773   g_return_val_if_fail (property_name != NULL, NULL);
774   
775   return g_param_spec_pool_lookup (pspec_pool,
776                                    property_name,
777                                    iface_class->g_type,
778                                    FALSE);
779 }
780
781 /**
782  * g_object_class_override_property:
783  * @oclass: a #GObjectClass
784  * @property_id: the new property ID
785  * @name: the name of a property registered in a parent class or
786  *  in an interface of this class.
787  *
788  * Registers @property_id as referring to a property with the
789  * name @name in a parent class or in an interface implemented
790  * by @oclass. This allows this class to <firstterm>override</firstterm>
791  * a property implementation in a parent class or to provide
792  * the implementation of a property from an interface.
793  *
794  * <note>
795  * Internally, overriding is implemented by creating a property of type
796  * #GParamSpecOverride; generally operations that query the properties of
797  * the object class, such as g_object_class_find_property() or
798  * g_object_class_list_properties() will return the overridden
799  * property. However, in one case, the @construct_properties argument of
800  * the @constructor virtual function, the #GParamSpecOverride is passed
801  * instead, so that the @param_id field of the #GParamSpec will be
802  * correct.  For virtually all uses, this makes no difference. If you
803  * need to get the overridden property, you can call
804  * g_param_spec_get_redirect_target().
805  * </note>
806  *
807  * Since: 2.4
808  */
809 void
810 g_object_class_override_property (GObjectClass *oclass,
811                                   guint         property_id,
812                                   const gchar  *name)
813 {
814   GParamSpec *overridden = NULL;
815   GParamSpec *new;
816   GType parent_type;
817   
818   g_return_if_fail (G_IS_OBJECT_CLASS (oclass));
819   g_return_if_fail (property_id > 0);
820   g_return_if_fail (name != NULL);
821
822   /* Find the overridden property; first check parent types
823    */
824   parent_type = g_type_parent (G_OBJECT_CLASS_TYPE (oclass));
825   if (parent_type != G_TYPE_NONE)
826     overridden = g_param_spec_pool_lookup (pspec_pool,
827                                            name,
828                                            parent_type,
829                                            TRUE);
830   if (!overridden)
831     {
832       GType *ifaces;
833       guint n_ifaces;
834       
835       /* Now check interfaces
836        */
837       ifaces = g_type_interfaces (G_OBJECT_CLASS_TYPE (oclass), &n_ifaces);
838       while (n_ifaces-- && !overridden)
839         {
840           overridden = g_param_spec_pool_lookup (pspec_pool,
841                                                  name,
842                                                  ifaces[n_ifaces],
843                                                  FALSE);
844         }
845       
846       g_free (ifaces);
847     }
848
849   if (!overridden)
850     {
851       g_warning ("%s: Can't find property to override for '%s::%s'",
852                  G_STRFUNC, G_OBJECT_CLASS_NAME (oclass), name);
853       return;
854     }
855
856   new = g_param_spec_override (name, overridden);
857   g_object_class_install_property (oclass, property_id, new);
858 }
859
860 /**
861  * g_object_class_list_properties:
862  * @oclass: a #GObjectClass
863  * @n_properties: (out): return location for the length of the returned array
864  *
865  * Get an array of #GParamSpec* for all properties of a class.
866  *
867  * Returns: (array length=n_properties) (transfer container): an array of
868  *          #GParamSpec* which should be freed after use
869  */
870 GParamSpec** /* free result */
871 g_object_class_list_properties (GObjectClass *class,
872                                 guint        *n_properties_p)
873 {
874   GParamSpec **pspecs;
875   guint n;
876
877   g_return_val_if_fail (G_IS_OBJECT_CLASS (class), NULL);
878
879   pspecs = g_param_spec_pool_list (pspec_pool,
880                                    G_OBJECT_CLASS_TYPE (class),
881                                    &n);
882   if (n_properties_p)
883     *n_properties_p = n;
884
885   return pspecs;
886 }
887
888 /**
889  * g_object_interface_list_properties:
890  * @g_iface: any interface vtable for the interface, or the default
891  *  vtable for the interface
892  * @n_properties_p: (out): location to store number of properties returned.
893  *
894  * Lists the properties of an interface.Generally, the interface
895  * vtable passed in as @g_iface will be the default vtable from
896  * g_type_default_interface_ref(), or, if you know the interface has
897  * already been loaded, g_type_default_interface_peek().
898  *
899  * Since: 2.4
900  *
901  * Returns: (array length=n_properties_p) (transfer container): a
902  *          pointer to an array of pointers to #GParamSpec
903  *          structures. The paramspecs are owned by GLib, but the
904  *          array should be freed with g_free() when you are done with
905  *          it.
906  */
907 GParamSpec**
908 g_object_interface_list_properties (gpointer      g_iface,
909                                     guint        *n_properties_p)
910 {
911   GTypeInterface *iface_class = g_iface;
912   GParamSpec **pspecs;
913   guint n;
914
915   g_return_val_if_fail (G_TYPE_IS_INTERFACE (iface_class->g_type), NULL);
916
917   pspecs = g_param_spec_pool_list (pspec_pool,
918                                    iface_class->g_type,
919                                    &n);
920   if (n_properties_p)
921     *n_properties_p = n;
922
923   return pspecs;
924 }
925
926 static void
927 g_object_init (GObject          *object,
928                GObjectClass     *class)
929 {
930   object->ref_count = 1;
931   object->qdata = NULL;
932
933   if (CLASS_HAS_PROPS (class))
934     {
935       /* freeze object's notification queue, g_object_newv() preserves pairedness */
936       g_object_notify_queue_freeze (object, FALSE);
937     }
938
939   if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
940     {
941       /* enter construction list for notify_queue_thaw() and to allow construct-only properties */
942       G_LOCK (construction_mutex);
943       construction_objects = g_slist_prepend (construction_objects, object);
944       G_UNLOCK (construction_mutex);
945     }
946
947 #ifdef  G_ENABLE_DEBUG
948   IF_DEBUG (OBJECTS)
949     {
950       G_LOCK (debug_objects);
951       debug_objects_count++;
952       g_hash_table_insert (debug_objects_ht, object, object);
953       G_UNLOCK (debug_objects);
954     }
955 #endif  /* G_ENABLE_DEBUG */
956 }
957
958 static void
959 g_object_do_set_property (GObject      *object,
960                           guint         property_id,
961                           const GValue *value,
962                           GParamSpec   *pspec)
963 {
964   switch (property_id)
965     {
966     default:
967       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
968       break;
969     }
970 }
971
972 static void
973 g_object_do_get_property (GObject     *object,
974                           guint        property_id,
975                           GValue      *value,
976                           GParamSpec  *pspec)
977 {
978   switch (property_id)
979     {
980     default:
981       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
982       break;
983     }
984 }
985
986 static void
987 g_object_real_dispose (GObject *object)
988 {
989   g_signal_handlers_destroy (object);
990   g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
991   g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
992 }
993
994 static void
995 g_object_finalize (GObject *object)
996 {
997   g_datalist_clear (&object->qdata);
998   
999 #ifdef  G_ENABLE_DEBUG
1000   IF_DEBUG (OBJECTS)
1001     {
1002       G_LOCK (debug_objects);
1003       g_assert (g_hash_table_lookup (debug_objects_ht, object) == object);
1004       g_hash_table_remove (debug_objects_ht, object);
1005       debug_objects_count--;
1006       G_UNLOCK (debug_objects);
1007     }
1008 #endif  /* G_ENABLE_DEBUG */
1009 }
1010
1011
1012 static void
1013 g_object_dispatch_properties_changed (GObject     *object,
1014                                       guint        n_pspecs,
1015                                       GParamSpec **pspecs)
1016 {
1017   guint i;
1018
1019   for (i = 0; i < n_pspecs; i++)
1020     g_signal_emit (object, gobject_signals[NOTIFY], g_quark_from_string (pspecs[i]->name), pspecs[i]);
1021 }
1022
1023 /**
1024  * g_object_run_dispose:
1025  * @object: a #GObject
1026  *
1027  * Releases all references to other objects. This can be used to break
1028  * reference cycles.
1029  *
1030  * This functions should only be called from object system implementations.
1031  */
1032 void
1033 g_object_run_dispose (GObject *object)
1034 {
1035   g_return_if_fail (G_IS_OBJECT (object));
1036   g_return_if_fail (object->ref_count > 0);
1037
1038   g_object_ref (object);
1039   TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 0));
1040   G_OBJECT_GET_CLASS (object)->dispose (object);
1041   TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 0));
1042   g_object_unref (object);
1043 }
1044
1045 /**
1046  * g_object_freeze_notify:
1047  * @object: a #GObject
1048  *
1049  * Increases the freeze count on @object. If the freeze count is
1050  * non-zero, the emission of "notify" signals on @object is
1051  * stopped. The signals are queued until the freeze count is decreased
1052  * to zero.
1053  *
1054  * This is necessary for accessors that modify multiple properties to prevent
1055  * premature notification while the object is still being modified.
1056  */
1057 void
1058 g_object_freeze_notify (GObject *object)
1059 {
1060   g_return_if_fail (G_IS_OBJECT (object));
1061
1062   if (g_atomic_int_get (&object->ref_count) == 0)
1063     return;
1064
1065   g_object_ref (object);
1066   g_object_notify_queue_freeze (object, FALSE);
1067   g_object_unref (object);
1068 }
1069
1070 static GParamSpec *
1071 get_notify_pspec (GParamSpec *pspec)
1072 {
1073   GParamSpec *redirected;
1074
1075   /* we don't notify on non-READABLE parameters */
1076   if (~pspec->flags & G_PARAM_READABLE)
1077     return NULL;
1078
1079   /* if the paramspec is redirected, notify on the target */
1080   redirected = g_param_spec_get_redirect_target (pspec);
1081   if (redirected != NULL)
1082     return redirected;
1083
1084   /* else, notify normally */
1085   return pspec;
1086 }
1087
1088 static inline void
1089 g_object_notify_by_spec_internal (GObject    *object,
1090                                   GParamSpec *pspec)
1091 {
1092   GParamSpec *notify_pspec;
1093
1094   notify_pspec = get_notify_pspec (pspec);
1095
1096   if (notify_pspec != NULL)
1097     {
1098       GObjectNotifyQueue *nqueue;
1099
1100       /* conditional freeze: only increase freeze count if already frozen */
1101       nqueue = g_object_notify_queue_freeze (object, TRUE);
1102
1103       if (nqueue != NULL)
1104         {
1105           /* we're frozen, so add to the queue and release our freeze */
1106           g_object_notify_queue_add (object, nqueue, notify_pspec);
1107           g_object_notify_queue_thaw (object, nqueue);
1108         }
1109       else
1110         /* not frozen, so just dispatch the notification directly */
1111         G_OBJECT_GET_CLASS (object)
1112           ->dispatch_properties_changed (object, 1, &notify_pspec);
1113     }
1114 }
1115
1116 /**
1117  * g_object_notify:
1118  * @object: a #GObject
1119  * @property_name: the name of a property installed on the class of @object.
1120  *
1121  * Emits a "notify" signal for the property @property_name on @object.
1122  *
1123  * When possible, eg. when signaling a property change from within the class
1124  * that registered the property, you should use g_object_notify_by_pspec()
1125  * instead.
1126  */
1127 void
1128 g_object_notify (GObject     *object,
1129                  const gchar *property_name)
1130 {
1131   GParamSpec *pspec;
1132   
1133   g_return_if_fail (G_IS_OBJECT (object));
1134   g_return_if_fail (property_name != NULL);
1135   if (g_atomic_int_get (&object->ref_count) == 0)
1136     return;
1137   
1138   g_object_ref (object);
1139   /* We don't need to get the redirect target
1140    * (by, e.g. calling g_object_class_find_property())
1141    * because g_object_notify_queue_add() does that
1142    */
1143   pspec = g_param_spec_pool_lookup (pspec_pool,
1144                                     property_name,
1145                                     G_OBJECT_TYPE (object),
1146                                     TRUE);
1147
1148   if (!pspec)
1149     g_warning ("%s: object class `%s' has no property named `%s'",
1150                G_STRFUNC,
1151                G_OBJECT_TYPE_NAME (object),
1152                property_name);
1153   else
1154     g_object_notify_by_spec_internal (object, pspec);
1155   g_object_unref (object);
1156 }
1157
1158 /**
1159  * g_object_notify_by_pspec:
1160  * @object: a #GObject
1161  * @pspec: the #GParamSpec of a property installed on the class of @object.
1162  *
1163  * Emits a "notify" signal for the property specified by @pspec on @object.
1164  *
1165  * This function omits the property name lookup, hence it is faster than
1166  * g_object_notify().
1167  *
1168  * One way to avoid using g_object_notify() from within the
1169  * class that registered the properties, and using g_object_notify_by_pspec()
1170  * instead, is to store the GParamSpec used with
1171  * g_object_class_install_property() inside a static array, e.g.:
1172  *
1173  *|[
1174  *   enum
1175  *   {
1176  *     PROP_0,
1177  *     PROP_FOO,
1178  *     PROP_LAST
1179  *   };
1180  *
1181  *   static GParamSpec *properties[PROP_LAST];
1182  *
1183  *   static void
1184  *   my_object_class_init (MyObjectClass *klass)
1185  *   {
1186  *     properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
1187  *                                              0, 100,
1188  *                                              50,
1189  *                                              G_PARAM_READWRITE);
1190  *     g_object_class_install_property (gobject_class,
1191  *                                      PROP_FOO,
1192  *                                      properties[PROP_FOO]);
1193  *   }
1194  * ]|
1195  *
1196  * and then notify a change on the "foo" property with:
1197  *
1198  * |[
1199  *   g_object_notify_by_pspec (self, properties[PROP_FOO]);
1200  * ]|
1201  *
1202  * Since: 2.26
1203  */
1204 void
1205 g_object_notify_by_pspec (GObject    *object,
1206                           GParamSpec *pspec)
1207 {
1208
1209   g_return_if_fail (G_IS_OBJECT (object));
1210   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
1211
1212   g_object_ref (object);
1213   g_object_notify_by_spec_internal (object, pspec);
1214   g_object_unref (object);
1215 }
1216
1217 /**
1218  * g_object_thaw_notify:
1219  * @object: a #GObject
1220  *
1221  * Reverts the effect of a previous call to
1222  * g_object_freeze_notify(). The freeze count is decreased on @object
1223  * and when it reaches zero, all queued "notify" signals are emitted.
1224  *
1225  * It is an error to call this function when the freeze count is zero.
1226  */
1227 void
1228 g_object_thaw_notify (GObject *object)
1229 {
1230   GObjectNotifyQueue *nqueue;
1231   
1232   g_return_if_fail (G_IS_OBJECT (object));
1233   if (g_atomic_int_get (&object->ref_count) == 0)
1234     return;
1235   
1236   g_object_ref (object);
1237
1238   /* FIXME: Freezing is the only way to get at the notify queue.
1239    * So we freeze once and then thaw twice.
1240    */
1241   nqueue = g_object_notify_queue_freeze (object, FALSE);
1242   g_object_notify_queue_thaw (object, nqueue);
1243   g_object_notify_queue_thaw (object, nqueue);
1244
1245   g_object_unref (object);
1246 }
1247
1248 static inline void
1249 object_get_property (GObject     *object,
1250                      GParamSpec  *pspec,
1251                      GValue      *value)
1252 {
1253   GObjectClass *class = g_type_class_peek (pspec->owner_type);
1254   guint param_id = PARAM_SPEC_PARAM_ID (pspec);
1255   GParamSpec *redirect;
1256
1257   if (class == NULL)
1258     {
1259       g_warning ("'%s::%s' is not a valid property name; '%s' is not a GObject subtype",
1260                  g_type_name (pspec->owner_type), pspec->name, g_type_name (pspec->owner_type));
1261       return;
1262     }
1263
1264   redirect = g_param_spec_get_redirect_target (pspec);
1265   if (redirect)
1266     pspec = redirect;    
1267   
1268   class->get_property (object, param_id, value, pspec);
1269 }
1270
1271 static inline void
1272 object_set_property (GObject             *object,
1273                      GParamSpec          *pspec,
1274                      const GValue        *value,
1275                      GObjectNotifyQueue  *nqueue)
1276 {
1277   GValue tmp_value = G_VALUE_INIT;
1278   GObjectClass *class = g_type_class_peek (pspec->owner_type);
1279   guint param_id = PARAM_SPEC_PARAM_ID (pspec);
1280   GParamSpec *redirect;
1281   static const gchar * enable_diagnostic = NULL;
1282
1283   if (class == NULL)
1284     {
1285       g_warning ("'%s::%s' is not a valid property name; '%s' is not a GObject subtype",
1286                  g_type_name (pspec->owner_type), pspec->name, g_type_name (pspec->owner_type));
1287       return;
1288     }
1289
1290   redirect = g_param_spec_get_redirect_target (pspec);
1291   if (redirect)
1292     pspec = redirect;
1293
1294   if (G_UNLIKELY (!enable_diagnostic))
1295     {
1296       enable_diagnostic = g_getenv ("G_ENABLE_DIAGNOSTIC");
1297       if (!enable_diagnostic)
1298         enable_diagnostic = "0";
1299     }
1300
1301   if (enable_diagnostic[0] == '1')
1302     {
1303       if (pspec->flags & G_PARAM_DEPRECATED)
1304         g_warning ("The property %s:%s is deprecated and shouldn't be used "
1305                    "anymore. It will be removed in a future version.",
1306                    G_OBJECT_TYPE_NAME (object), pspec->name);
1307     }
1308
1309   /* provide a copy to work from, convert (if necessary) and validate */
1310   g_value_init (&tmp_value, pspec->value_type);
1311   if (!g_value_transform (value, &tmp_value))
1312     g_warning ("unable to set property `%s' of type `%s' from value of type `%s'",
1313                pspec->name,
1314                g_type_name (pspec->value_type),
1315                G_VALUE_TYPE_NAME (value));
1316   else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
1317     {
1318       gchar *contents = g_strdup_value_contents (value);
1319
1320       g_warning ("value \"%s\" of type `%s' is invalid or out of range for property `%s' of type `%s'",
1321                  contents,
1322                  G_VALUE_TYPE_NAME (value),
1323                  pspec->name,
1324                  g_type_name (pspec->value_type));
1325       g_free (contents);
1326     }
1327   else
1328     {
1329       GParamSpec *notify_pspec;
1330
1331       class->set_property (object, param_id, &tmp_value, pspec);
1332
1333       notify_pspec = get_notify_pspec (pspec);
1334
1335       if (notify_pspec != NULL)
1336         g_object_notify_queue_add (object, nqueue, notify_pspec);
1337     }
1338   g_value_unset (&tmp_value);
1339 }
1340
1341 static void
1342 object_interface_check_properties (gpointer func_data,
1343                                    gpointer g_iface)
1344 {
1345   GTypeInterface *iface_class = g_iface;
1346   GObjectClass *class;
1347   GType iface_type = iface_class->g_type;
1348   GParamSpec **pspecs;
1349   guint n;
1350
1351   class = g_type_class_ref (iface_class->g_instance_type);
1352
1353   if (!G_IS_OBJECT_CLASS (class))
1354     return;
1355
1356   pspecs = g_param_spec_pool_list (pspec_pool, iface_type, &n);
1357
1358   while (n--)
1359     {
1360       GParamSpec *class_pspec = g_param_spec_pool_lookup (pspec_pool,
1361                                                           pspecs[n]->name,
1362                                                           G_OBJECT_CLASS_TYPE (class),
1363                                                           TRUE);
1364
1365       if (!class_pspec)
1366         {
1367           g_critical ("Object class %s doesn't implement property "
1368                       "'%s' from interface '%s'",
1369                       g_type_name (G_OBJECT_CLASS_TYPE (class)),
1370                       pspecs[n]->name,
1371                       g_type_name (iface_type));
1372
1373           continue;
1374         }
1375
1376       /* The implementation paramspec must have a less restrictive
1377        * type than the interface parameter spec for set() and a
1378        * more restrictive type for get(). We just require equality,
1379        * rather than doing something more complicated checking
1380        * the READABLE and WRITABLE flags. We also simplify here
1381        * by only checking the value type, not the G_PARAM_SPEC_TYPE.
1382        */
1383       if (g_type_is_a (pspecs[n]->value_type, class_pspec->value_type))
1384         g_critical ("Property '%s' on class '%s' has type '%s' "
1385                     "which is different from the type '%s', "
1386                     "of the property on interface '%s'\n",
1387                     pspecs[n]->name,
1388                     g_type_name (G_OBJECT_CLASS_TYPE (class)),
1389                     g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1390                     g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])),
1391                     g_type_name (iface_type));
1392
1393 #define SUBSET(a,b,mask) (((a) & ~(b) & (mask)) == 0)
1394
1395       /* CONSTRUCT and CONSTRUCT_ONLY add restrictions to writability.
1396        * READABLE and WRITABLE remove restrictions. The implementation
1397        * paramspec must have less restrictive flags.
1398        */
1399       if (pspecs[n]->flags & G_PARAM_WRITABLE)
1400         {
1401           if (!SUBSET (class_pspec->flags, pspecs[n]->flags, G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1402             g_critical ("Flags for property '%s' on class '%s' introduce additional restrictions on "
1403                         "writability compared with the property on interface '%s'\n", pspecs[n]->name,
1404                         g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (iface_type));
1405         }
1406
1407       if (!SUBSET (pspecs[n]->flags, class_pspec->flags, G_PARAM_READABLE | G_PARAM_WRITABLE))
1408         g_critical ("Flags for property '%s' on class '%s' remove functionality compared with the "
1409                     "property on interface '%s'\n", pspecs[n]->name,
1410                     g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (iface_type));
1411 #undef SUBSET
1412     }
1413
1414   g_free (pspecs);
1415
1416   g_type_class_unref (class);
1417 }
1418
1419 GType
1420 g_object_get_type (void)
1421 {
1422     return G_TYPE_OBJECT;
1423 }
1424
1425 /**
1426  * g_object_new: (skip)
1427  * @object_type: the type id of the #GObject subtype to instantiate
1428  * @first_property_name: the name of the first property
1429  * @...: the value of the first property, followed optionally by more
1430  *  name/value pairs, followed by %NULL
1431  *
1432  * Creates a new instance of a #GObject subtype and sets its properties.
1433  *
1434  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1435  * which are not explicitly specified are set to their default values.
1436  *
1437  * Returns: (transfer full): a new instance of @object_type
1438  */
1439 gpointer
1440 g_object_new (GType        object_type,
1441               const gchar *first_property_name,
1442               ...)
1443 {
1444   GObject *object;
1445   va_list var_args;
1446   
1447   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1448   
1449   /* short circuit for calls supplying no properties */
1450   if (!first_property_name)
1451     return g_object_newv (object_type, 0, NULL);
1452
1453   va_start (var_args, first_property_name);
1454   object = g_object_new_valist (object_type, first_property_name, var_args);
1455   va_end (var_args);
1456   
1457   return object;
1458 }
1459
1460 static gboolean
1461 slist_maybe_remove (GSList       **slist,
1462                     gconstpointer  data)
1463 {
1464   GSList *last = NULL, *node = *slist;
1465   while (node)
1466     {
1467       if (node->data == data)
1468         {
1469           if (last)
1470             last->next = node->next;
1471           else
1472             *slist = node->next;
1473           g_slist_free_1 (node);
1474           return TRUE;
1475         }
1476       last = node;
1477       node = last->next;
1478     }
1479   return FALSE;
1480 }
1481
1482 static inline gboolean
1483 object_in_construction_list (GObject *object)
1484 {
1485   gboolean in_construction;
1486   G_LOCK (construction_mutex);
1487   in_construction = g_slist_find (construction_objects, object) != NULL;
1488   G_UNLOCK (construction_mutex);
1489   return in_construction;
1490 }
1491
1492 /**
1493  * g_object_newv:
1494  * @object_type: the type id of the #GObject subtype to instantiate
1495  * @n_parameters: the length of the @parameters array
1496  * @parameters: (array length=n_parameters): an array of #GParameter
1497  *
1498  * Creates a new instance of a #GObject subtype and sets its properties.
1499  *
1500  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1501  * which are not explicitly specified are set to their default values.
1502  *
1503  * Rename to: g_object_new
1504  * Returns: (type GObject.Object) (transfer full): a new instance of
1505  * @object_type
1506  */
1507 gpointer
1508 g_object_newv (GType       object_type,
1509                guint       n_parameters,
1510                GParameter *parameters)
1511 {
1512   GObjectConstructParam *cparams = NULL, *oparams;
1513   GObjectNotifyQueue *nqueue = NULL; /* shouldn't be initialized, just to silence compiler */
1514   GObject *object;
1515   GObjectClass *class, *unref_class = NULL;
1516   GSList *slist;
1517   guint n_total_cparams = 0, n_cparams = 0, n_oparams = 0, n_cvalues;
1518   GValue *cvalues;
1519   GList *clist = NULL;
1520   gboolean newly_constructed;
1521   guint i;
1522
1523   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1524
1525   class = g_type_class_peek_static (object_type);
1526   if (!class)
1527     class = unref_class = g_type_class_ref (object_type);
1528   for (slist = class->construct_properties; slist; slist = slist->next)
1529     {
1530       clist = g_list_prepend (clist, slist->data);
1531       n_total_cparams += 1;
1532     }
1533
1534   if (n_parameters == 0 && n_total_cparams == 0)
1535     {
1536       /* This is a simple object with no construct properties, and
1537        * no properties are being set, so short circuit the parameter
1538        * handling. This speeds up simple object construction.
1539        */
1540       oparams = NULL;
1541       object = class->constructor (object_type, 0, NULL);
1542       goto did_construction;
1543     }
1544
1545   /* collect parameters, sort into construction and normal ones */
1546   oparams = g_new (GObjectConstructParam, n_parameters);
1547   cparams = g_new (GObjectConstructParam, n_total_cparams);
1548   for (i = 0; i < n_parameters; i++)
1549     {
1550       GValue *value = &parameters[i].value;
1551       GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1552                                                     parameters[i].name,
1553                                                     object_type,
1554                                                     TRUE);
1555       if (!pspec)
1556         {
1557           g_warning ("%s: object class `%s' has no property named `%s'",
1558                      G_STRFUNC,
1559                      g_type_name (object_type),
1560                      parameters[i].name);
1561           continue;
1562         }
1563       if (!(pspec->flags & G_PARAM_WRITABLE))
1564         {
1565           g_warning ("%s: property `%s' of object class `%s' is not writable",
1566                      G_STRFUNC,
1567                      pspec->name,
1568                      g_type_name (object_type));
1569           continue;
1570         }
1571       if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1572         {
1573           GList *list = g_list_find (clist, pspec);
1574
1575           if (!list)
1576             {
1577               g_warning ("%s: construct property \"%s\" for object `%s' can't be set twice",
1578                          G_STRFUNC, pspec->name, g_type_name (object_type));
1579               continue;
1580             }
1581           cparams[n_cparams].pspec = pspec;
1582           cparams[n_cparams].value = value;
1583           n_cparams++;
1584           if (!list->prev)
1585             clist = list->next;
1586           else
1587             list->prev->next = list->next;
1588           if (list->next)
1589             list->next->prev = list->prev;
1590           g_list_free_1 (list);
1591         }
1592       else
1593         {
1594           oparams[n_oparams].pspec = pspec;
1595           oparams[n_oparams].value = value;
1596           n_oparams++;
1597         }
1598     }
1599
1600   /* set remaining construction properties to default values */
1601   n_cvalues = n_total_cparams - n_cparams;
1602   cvalues = g_new (GValue, n_cvalues);
1603   while (clist)
1604     {
1605       GList *tmp = clist->next;
1606       GParamSpec *pspec = clist->data;
1607       GValue *value = cvalues + n_total_cparams - n_cparams - 1;
1608
1609       value->g_type = 0;
1610       g_value_init (value, pspec->value_type);
1611       g_param_value_set_default (pspec, value);
1612
1613       cparams[n_cparams].pspec = pspec;
1614       cparams[n_cparams].value = value;
1615       n_cparams++;
1616
1617       g_list_free_1 (clist);
1618       clist = tmp;
1619     }
1620
1621   /* construct object from construction parameters */
1622   object = class->constructor (object_type, n_total_cparams, cparams);
1623   /* free construction values */
1624   g_free (cparams);
1625   while (n_cvalues--)
1626     g_value_unset (cvalues + n_cvalues);
1627   g_free (cvalues);
1628
1629  did_construction:
1630   if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
1631     {
1632       /* adjust freeze_count according to g_object_init() and remaining properties */
1633       G_LOCK (construction_mutex);
1634       newly_constructed = slist_maybe_remove (&construction_objects, object);
1635       G_UNLOCK (construction_mutex);
1636     }
1637   else
1638     newly_constructed = TRUE;
1639
1640   if (CLASS_HAS_PROPS (class))
1641     {
1642       if (newly_constructed || n_oparams)
1643         nqueue = g_object_notify_queue_freeze (object, FALSE);
1644       if (newly_constructed)
1645         g_object_notify_queue_thaw (object, nqueue);
1646     }
1647
1648   /* run 'constructed' handler if there is a custom one */
1649   if (newly_constructed && CLASS_HAS_CUSTOM_CONSTRUCTED (class))
1650     class->constructed (object);
1651
1652   /* set remaining properties */
1653   for (i = 0; i < n_oparams; i++)
1654     object_set_property (object, oparams[i].pspec, oparams[i].value, nqueue);
1655   g_free (oparams);
1656
1657   if (CLASS_HAS_PROPS (class))
1658     {
1659       /* release our own freeze count and handle notifications */
1660       if (newly_constructed || n_oparams)
1661         g_object_notify_queue_thaw (object, nqueue);
1662     }
1663
1664   if (unref_class)
1665     g_type_class_unref (unref_class);
1666
1667   return object;
1668 }
1669
1670 /**
1671  * g_object_new_valist: (skip)
1672  * @object_type: the type id of the #GObject subtype to instantiate
1673  * @first_property_name: the name of the first property
1674  * @var_args: the value of the first property, followed optionally by more
1675  *  name/value pairs, followed by %NULL
1676  *
1677  * Creates a new instance of a #GObject subtype and sets its properties.
1678  *
1679  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1680  * which are not explicitly specified are set to their default values.
1681  *
1682  * Returns: a new instance of @object_type
1683  */
1684 GObject*
1685 g_object_new_valist (GType        object_type,
1686                      const gchar *first_property_name,
1687                      va_list      var_args)
1688 {
1689   GObjectClass *class;
1690   GParameter *params;
1691   const gchar *name;
1692   GObject *object;
1693   guint n_params = 0, n_alloced_params = 16;
1694   
1695   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1696
1697   if (!first_property_name)
1698     return g_object_newv (object_type, 0, NULL);
1699
1700   class = g_type_class_ref (object_type);
1701
1702   params = g_new0 (GParameter, n_alloced_params);
1703   name = first_property_name;
1704   while (name)
1705     {
1706       gchar *error = NULL;
1707       GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1708                                                     name,
1709                                                     object_type,
1710                                                     TRUE);
1711       if (!pspec)
1712         {
1713           g_warning ("%s: object class `%s' has no property named `%s'",
1714                      G_STRFUNC,
1715                      g_type_name (object_type),
1716                      name);
1717           break;
1718         }
1719       if (n_params >= n_alloced_params)
1720         {
1721           n_alloced_params += 16;
1722           params = g_renew (GParameter, params, n_alloced_params);
1723           memset (params + n_params, 0, 16 * (sizeof *params));
1724         }
1725       params[n_params].name = name;
1726       G_VALUE_COLLECT_INIT (&params[n_params].value, pspec->value_type,
1727                             var_args, 0, &error);
1728       if (error)
1729         {
1730           g_warning ("%s: %s", G_STRFUNC, error);
1731           g_free (error);
1732           g_value_unset (&params[n_params].value);
1733           break;
1734         }
1735       n_params++;
1736       name = va_arg (var_args, gchar*);
1737     }
1738
1739   object = g_object_newv (object_type, n_params, params);
1740
1741   while (n_params--)
1742     g_value_unset (&params[n_params].value);
1743   g_free (params);
1744
1745   g_type_class_unref (class);
1746
1747   return object;
1748 }
1749
1750 static GObject*
1751 g_object_constructor (GType                  type,
1752                       guint                  n_construct_properties,
1753                       GObjectConstructParam *construct_params)
1754 {
1755   GObject *object;
1756
1757   /* create object */
1758   object = (GObject*) g_type_create_instance (type);
1759   
1760   /* set construction parameters */
1761   if (n_construct_properties)
1762     {
1763       GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (object, FALSE);
1764       
1765       /* set construct properties */
1766       while (n_construct_properties--)
1767         {
1768           GValue *value = construct_params->value;
1769           GParamSpec *pspec = construct_params->pspec;
1770
1771           construct_params++;
1772           object_set_property (object, pspec, value, nqueue);
1773         }
1774       g_object_notify_queue_thaw (object, nqueue);
1775       /* the notification queue is still frozen from g_object_init(), so
1776        * we don't need to handle it here, g_object_newv() takes
1777        * care of that
1778        */
1779     }
1780
1781   return object;
1782 }
1783
1784 static void
1785 g_object_constructed (GObject *object)
1786 {
1787   /* empty default impl to allow unconditional upchaining */
1788 }
1789
1790 /**
1791  * g_object_set_valist: (skip)
1792  * @object: a #GObject
1793  * @first_property_name: name of the first property to set
1794  * @var_args: value for the first property, followed optionally by more
1795  *  name/value pairs, followed by %NULL
1796  *
1797  * Sets properties on an object.
1798  */
1799 void
1800 g_object_set_valist (GObject     *object,
1801                      const gchar *first_property_name,
1802                      va_list      var_args)
1803 {
1804   GObjectNotifyQueue *nqueue;
1805   const gchar *name;
1806   
1807   g_return_if_fail (G_IS_OBJECT (object));
1808   
1809   g_object_ref (object);
1810   nqueue = g_object_notify_queue_freeze (object, FALSE);
1811   
1812   name = first_property_name;
1813   while (name)
1814     {
1815       GValue value = G_VALUE_INIT;
1816       GParamSpec *pspec;
1817       gchar *error = NULL;
1818       
1819       pspec = g_param_spec_pool_lookup (pspec_pool,
1820                                         name,
1821                                         G_OBJECT_TYPE (object),
1822                                         TRUE);
1823       if (!pspec)
1824         {
1825           g_warning ("%s: object class `%s' has no property named `%s'",
1826                      G_STRFUNC,
1827                      G_OBJECT_TYPE_NAME (object),
1828                      name);
1829           break;
1830         }
1831       if (!(pspec->flags & G_PARAM_WRITABLE))
1832         {
1833           g_warning ("%s: property `%s' of object class `%s' is not writable",
1834                      G_STRFUNC,
1835                      pspec->name,
1836                      G_OBJECT_TYPE_NAME (object));
1837           break;
1838         }
1839       if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
1840         {
1841           g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
1842                      G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
1843           break;
1844         }
1845
1846       G_VALUE_COLLECT_INIT (&value, pspec->value_type, var_args,
1847                             0, &error);
1848       if (error)
1849         {
1850           g_warning ("%s: %s", G_STRFUNC, error);
1851           g_free (error);
1852           g_value_unset (&value);
1853           break;
1854         }
1855       
1856       object_set_property (object, pspec, &value, nqueue);
1857       g_value_unset (&value);
1858       
1859       name = va_arg (var_args, gchar*);
1860     }
1861
1862   g_object_notify_queue_thaw (object, nqueue);
1863   g_object_unref (object);
1864 }
1865
1866 /**
1867  * g_object_get_valist: (skip)
1868  * @object: a #GObject
1869  * @first_property_name: name of the first property to get
1870  * @var_args: return location for the first property, followed optionally by more
1871  *  name/return location pairs, followed by %NULL
1872  *
1873  * Gets properties of an object.
1874  *
1875  * In general, a copy is made of the property contents and the caller
1876  * is responsible for freeing the memory in the appropriate manner for
1877  * the type, for instance by calling g_free() or g_object_unref().
1878  *
1879  * See g_object_get().
1880  */
1881 void
1882 g_object_get_valist (GObject     *object,
1883                      const gchar *first_property_name,
1884                      va_list      var_args)
1885 {
1886   const gchar *name;
1887   
1888   g_return_if_fail (G_IS_OBJECT (object));
1889   
1890   g_object_ref (object);
1891   
1892   name = first_property_name;
1893   
1894   while (name)
1895     {
1896       GValue value = G_VALUE_INIT;
1897       GParamSpec *pspec;
1898       gchar *error;
1899       
1900       pspec = g_param_spec_pool_lookup (pspec_pool,
1901                                         name,
1902                                         G_OBJECT_TYPE (object),
1903                                         TRUE);
1904       if (!pspec)
1905         {
1906           g_warning ("%s: object class `%s' has no property named `%s'",
1907                      G_STRFUNC,
1908                      G_OBJECT_TYPE_NAME (object),
1909                      name);
1910           break;
1911         }
1912       if (!(pspec->flags & G_PARAM_READABLE))
1913         {
1914           g_warning ("%s: property `%s' of object class `%s' is not readable",
1915                      G_STRFUNC,
1916                      pspec->name,
1917                      G_OBJECT_TYPE_NAME (object));
1918           break;
1919         }
1920       
1921       g_value_init (&value, pspec->value_type);
1922       
1923       object_get_property (object, pspec, &value);
1924       
1925       G_VALUE_LCOPY (&value, var_args, 0, &error);
1926       if (error)
1927         {
1928           g_warning ("%s: %s", G_STRFUNC, error);
1929           g_free (error);
1930           g_value_unset (&value);
1931           break;
1932         }
1933       
1934       g_value_unset (&value);
1935       
1936       name = va_arg (var_args, gchar*);
1937     }
1938   
1939   g_object_unref (object);
1940 }
1941
1942 /**
1943  * g_object_set: (skip)
1944  * @object: a #GObject
1945  * @first_property_name: name of the first property to set
1946  * @...: value for the first property, followed optionally by more
1947  *  name/value pairs, followed by %NULL
1948  *
1949  * Sets properties on an object.
1950  */
1951 void
1952 g_object_set (gpointer     _object,
1953               const gchar *first_property_name,
1954               ...)
1955 {
1956   GObject *object = _object;
1957   va_list var_args;
1958   
1959   g_return_if_fail (G_IS_OBJECT (object));
1960   
1961   va_start (var_args, first_property_name);
1962   g_object_set_valist (object, first_property_name, var_args);
1963   va_end (var_args);
1964 }
1965
1966 /**
1967  * g_object_get: (skip)
1968  * @object: a #GObject
1969  * @first_property_name: name of the first property to get
1970  * @...: return location for the first property, followed optionally by more
1971  *  name/return location pairs, followed by %NULL
1972  *
1973  * Gets properties of an object.
1974  *
1975  * In general, a copy is made of the property contents and the caller
1976  * is responsible for freeing the memory in the appropriate manner for
1977  * the type, for instance by calling g_free() or g_object_unref().
1978  *
1979  * <example>
1980  * <title>Using g_object_get(<!-- -->)</title>
1981  * An example of using g_object_get() to get the contents
1982  * of three properties - one of type #G_TYPE_INT,
1983  * one of type #G_TYPE_STRING, and one of type #G_TYPE_OBJECT:
1984  * <programlisting>
1985  *  gint intval;
1986  *  gchar *strval;
1987  *  GObject *objval;
1988  *
1989  *  g_object_get (my_object,
1990  *                "int-property", &intval,
1991  *                "str-property", &strval,
1992  *                "obj-property", &objval,
1993  *                NULL);
1994  *
1995  *  // Do something with intval, strval, objval
1996  *
1997  *  g_free (strval);
1998  *  g_object_unref (objval);
1999  * </programlisting>
2000  * </example>
2001  */
2002 void
2003 g_object_get (gpointer     _object,
2004               const gchar *first_property_name,
2005               ...)
2006 {
2007   GObject *object = _object;
2008   va_list var_args;
2009   
2010   g_return_if_fail (G_IS_OBJECT (object));
2011   
2012   va_start (var_args, first_property_name);
2013   g_object_get_valist (object, first_property_name, var_args);
2014   va_end (var_args);
2015 }
2016
2017 /**
2018  * g_object_set_property:
2019  * @object: a #GObject
2020  * @property_name: the name of the property to set
2021  * @value: the value
2022  *
2023  * Sets a property on an object.
2024  */
2025 void
2026 g_object_set_property (GObject      *object,
2027                        const gchar  *property_name,
2028                        const GValue *value)
2029 {
2030   GObjectNotifyQueue *nqueue;
2031   GParamSpec *pspec;
2032   
2033   g_return_if_fail (G_IS_OBJECT (object));
2034   g_return_if_fail (property_name != NULL);
2035   g_return_if_fail (G_IS_VALUE (value));
2036   
2037   g_object_ref (object);
2038   nqueue = g_object_notify_queue_freeze (object, FALSE);
2039   
2040   pspec = g_param_spec_pool_lookup (pspec_pool,
2041                                     property_name,
2042                                     G_OBJECT_TYPE (object),
2043                                     TRUE);
2044   if (!pspec)
2045     g_warning ("%s: object class `%s' has no property named `%s'",
2046                G_STRFUNC,
2047                G_OBJECT_TYPE_NAME (object),
2048                property_name);
2049   else if (!(pspec->flags & G_PARAM_WRITABLE))
2050     g_warning ("%s: property `%s' of object class `%s' is not writable",
2051                G_STRFUNC,
2052                pspec->name,
2053                G_OBJECT_TYPE_NAME (object));
2054   else if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
2055     g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
2056                G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
2057   else
2058     object_set_property (object, pspec, value, nqueue);
2059   
2060   g_object_notify_queue_thaw (object, nqueue);
2061   g_object_unref (object);
2062 }
2063
2064 /**
2065  * g_object_get_property:
2066  * @object: a #GObject
2067  * @property_name: the name of the property to get
2068  * @value: return location for the property value
2069  *
2070  * Gets a property of an object. @value must have been initialized to the
2071  * expected type of the property (or a type to which the expected type can be
2072  * transformed) using g_value_init().
2073  *
2074  * In general, a copy is made of the property contents and the caller is
2075  * responsible for freeing the memory by calling g_value_unset().
2076  *
2077  * Note that g_object_get_property() is really intended for language
2078  * bindings, g_object_get() is much more convenient for C programming.
2079  */
2080 void
2081 g_object_get_property (GObject     *object,
2082                        const gchar *property_name,
2083                        GValue      *value)
2084 {
2085   GParamSpec *pspec;
2086   
2087   g_return_if_fail (G_IS_OBJECT (object));
2088   g_return_if_fail (property_name != NULL);
2089   g_return_if_fail (G_IS_VALUE (value));
2090   
2091   g_object_ref (object);
2092   
2093   pspec = g_param_spec_pool_lookup (pspec_pool,
2094                                     property_name,
2095                                     G_OBJECT_TYPE (object),
2096                                     TRUE);
2097   if (!pspec)
2098     g_warning ("%s: object class `%s' has no property named `%s'",
2099                G_STRFUNC,
2100                G_OBJECT_TYPE_NAME (object),
2101                property_name);
2102   else if (!(pspec->flags & G_PARAM_READABLE))
2103     g_warning ("%s: property `%s' of object class `%s' is not readable",
2104                G_STRFUNC,
2105                pspec->name,
2106                G_OBJECT_TYPE_NAME (object));
2107   else
2108     {
2109       GValue *prop_value, tmp_value = G_VALUE_INIT;
2110       
2111       /* auto-conversion of the callers value type
2112        */
2113       if (G_VALUE_TYPE (value) == pspec->value_type)
2114         {
2115           g_value_reset (value);
2116           prop_value = value;
2117         }
2118       else if (!g_value_type_transformable (pspec->value_type, G_VALUE_TYPE (value)))
2119         {
2120           g_warning ("%s: can't retrieve property `%s' of type `%s' as value of type `%s'",
2121                      G_STRFUNC, pspec->name,
2122                      g_type_name (pspec->value_type),
2123                      G_VALUE_TYPE_NAME (value));
2124           g_object_unref (object);
2125           return;
2126         }
2127       else
2128         {
2129           g_value_init (&tmp_value, pspec->value_type);
2130           prop_value = &tmp_value;
2131         }
2132       object_get_property (object, pspec, prop_value);
2133       if (prop_value != value)
2134         {
2135           g_value_transform (prop_value, value);
2136           g_value_unset (&tmp_value);
2137         }
2138     }
2139   
2140   g_object_unref (object);
2141 }
2142
2143 /**
2144  * g_object_connect: (skip)
2145  * @object: a #GObject
2146  * @signal_spec: the spec for the first signal
2147  * @...: #GCallback for the first signal, followed by data for the
2148  *       first signal, followed optionally by more signal
2149  *       spec/callback/data triples, followed by %NULL
2150  *
2151  * A convenience function to connect multiple signals at once.
2152  *
2153  * The signal specs expected by this function have the form
2154  * "modifier::signal_name", where modifier can be one of the following:
2155  * <variablelist>
2156  * <varlistentry>
2157  * <term>signal</term>
2158  * <listitem><para>
2159  * equivalent to <literal>g_signal_connect_data (..., NULL, 0)</literal>
2160  * </para></listitem>
2161  * </varlistentry>
2162  * <varlistentry>
2163  * <term>object_signal</term>
2164  * <term>object-signal</term>
2165  * <listitem><para>
2166  * equivalent to <literal>g_signal_connect_object (..., 0)</literal>
2167  * </para></listitem>
2168  * </varlistentry>
2169  * <varlistentry>
2170  * <term>swapped_signal</term>
2171  * <term>swapped-signal</term>
2172  * <listitem><para>
2173  * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)</literal>
2174  * </para></listitem>
2175  * </varlistentry>
2176  * <varlistentry>
2177  * <term>swapped_object_signal</term>
2178  * <term>swapped-object-signal</term>
2179  * <listitem><para>
2180  * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED)</literal>
2181  * </para></listitem>
2182  * </varlistentry>
2183  * <varlistentry>
2184  * <term>signal_after</term>
2185  * <term>signal-after</term>
2186  * <listitem><para>
2187  * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_AFTER)</literal>
2188  * </para></listitem>
2189  * </varlistentry>
2190  * <varlistentry>
2191  * <term>object_signal_after</term>
2192  * <term>object-signal-after</term>
2193  * <listitem><para>
2194  * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_AFTER)</literal>
2195  * </para></listitem>
2196  * </varlistentry>
2197  * <varlistentry>
2198  * <term>swapped_signal_after</term>
2199  * <term>swapped-signal-after</term>
2200  * <listitem><para>
2201  * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2202  * </para></listitem>
2203  * </varlistentry>
2204  * <varlistentry>
2205  * <term>swapped_object_signal_after</term>
2206  * <term>swapped-object-signal-after</term>
2207  * <listitem><para>
2208  * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2209  * </para></listitem>
2210  * </varlistentry>
2211  * </variablelist>
2212  *
2213  * |[
2214  *   menu->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
2215  *                                                 "type", GTK_WINDOW_POPUP,
2216  *                                                 "child", menu,
2217  *                                                 NULL),
2218  *                                   "signal::event", gtk_menu_window_event, menu,
2219  *                                   "signal::size_request", gtk_menu_window_size_request, menu,
2220  *                                   "signal::destroy", gtk_widget_destroyed, &amp;menu-&gt;toplevel,
2221  *                                   NULL);
2222  * ]|
2223  *
2224  * Returns: (transfer none): @object
2225  */
2226 gpointer
2227 g_object_connect (gpointer     _object,
2228                   const gchar *signal_spec,
2229                   ...)
2230 {
2231   GObject *object = _object;
2232   va_list var_args;
2233
2234   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2235   g_return_val_if_fail (object->ref_count > 0, object);
2236
2237   va_start (var_args, signal_spec);
2238   while (signal_spec)
2239     {
2240       GCallback callback = va_arg (var_args, GCallback);
2241       gpointer data = va_arg (var_args, gpointer);
2242
2243       if (strncmp (signal_spec, "signal::", 8) == 0)
2244         g_signal_connect_data (object, signal_spec + 8,
2245                                callback, data, NULL,
2246                                0);
2247       else if (strncmp (signal_spec, "object_signal::", 15) == 0 ||
2248                strncmp (signal_spec, "object-signal::", 15) == 0)
2249         g_signal_connect_object (object, signal_spec + 15,
2250                                  callback, data,
2251                                  0);
2252       else if (strncmp (signal_spec, "swapped_signal::", 16) == 0 ||
2253                strncmp (signal_spec, "swapped-signal::", 16) == 0)
2254         g_signal_connect_data (object, signal_spec + 16,
2255                                callback, data, NULL,
2256                                G_CONNECT_SWAPPED);
2257       else if (strncmp (signal_spec, "swapped_object_signal::", 23) == 0 ||
2258                strncmp (signal_spec, "swapped-object-signal::", 23) == 0)
2259         g_signal_connect_object (object, signal_spec + 23,
2260                                  callback, data,
2261                                  G_CONNECT_SWAPPED);
2262       else if (strncmp (signal_spec, "signal_after::", 14) == 0 ||
2263                strncmp (signal_spec, "signal-after::", 14) == 0)
2264         g_signal_connect_data (object, signal_spec + 14,
2265                                callback, data, NULL,
2266                                G_CONNECT_AFTER);
2267       else if (strncmp (signal_spec, "object_signal_after::", 21) == 0 ||
2268                strncmp (signal_spec, "object-signal-after::", 21) == 0)
2269         g_signal_connect_object (object, signal_spec + 21,
2270                                  callback, data,
2271                                  G_CONNECT_AFTER);
2272       else if (strncmp (signal_spec, "swapped_signal_after::", 22) == 0 ||
2273                strncmp (signal_spec, "swapped-signal-after::", 22) == 0)
2274         g_signal_connect_data (object, signal_spec + 22,
2275                                callback, data, NULL,
2276                                G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2277       else if (strncmp (signal_spec, "swapped_object_signal_after::", 29) == 0 ||
2278                strncmp (signal_spec, "swapped-object-signal-after::", 29) == 0)
2279         g_signal_connect_object (object, signal_spec + 29,
2280                                  callback, data,
2281                                  G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2282       else
2283         {
2284           g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2285           break;
2286         }
2287       signal_spec = va_arg (var_args, gchar*);
2288     }
2289   va_end (var_args);
2290
2291   return object;
2292 }
2293
2294 /**
2295  * g_object_disconnect: (skip)
2296  * @object: a #GObject
2297  * @signal_spec: the spec for the first signal
2298  * @...: #GCallback for the first signal, followed by data for the first signal,
2299  *  followed optionally by more signal spec/callback/data triples,
2300  *  followed by %NULL
2301  *
2302  * A convenience function to disconnect multiple signals at once.
2303  *
2304  * The signal specs expected by this function have the form
2305  * "any_signal", which means to disconnect any signal with matching
2306  * callback and data, or "any_signal::signal_name", which only
2307  * disconnects the signal named "signal_name".
2308  */
2309 void
2310 g_object_disconnect (gpointer     _object,
2311                      const gchar *signal_spec,
2312                      ...)
2313 {
2314   GObject *object = _object;
2315   va_list var_args;
2316
2317   g_return_if_fail (G_IS_OBJECT (object));
2318   g_return_if_fail (object->ref_count > 0);
2319
2320   va_start (var_args, signal_spec);
2321   while (signal_spec)
2322     {
2323       GCallback callback = va_arg (var_args, GCallback);
2324       gpointer data = va_arg (var_args, gpointer);
2325       guint sid = 0, detail = 0, mask = 0;
2326
2327       if (strncmp (signal_spec, "any_signal::", 12) == 0 ||
2328           strncmp (signal_spec, "any-signal::", 12) == 0)
2329         {
2330           signal_spec += 12;
2331           mask = G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2332         }
2333       else if (strcmp (signal_spec, "any_signal") == 0 ||
2334                strcmp (signal_spec, "any-signal") == 0)
2335         {
2336           signal_spec += 10;
2337           mask = G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2338         }
2339       else
2340         {
2341           g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2342           break;
2343         }
2344
2345       if ((mask & G_SIGNAL_MATCH_ID) &&
2346           !g_signal_parse_name (signal_spec, G_OBJECT_TYPE (object), &sid, &detail, FALSE))
2347         g_warning ("%s: invalid signal name \"%s\"", G_STRFUNC, signal_spec);
2348       else if (!g_signal_handlers_disconnect_matched (object, mask | (detail ? G_SIGNAL_MATCH_DETAIL : 0),
2349                                                       sid, detail,
2350                                                       NULL, (gpointer)callback, data))
2351         g_warning ("%s: signal handler %p(%p) is not connected", G_STRFUNC, callback, data);
2352       signal_spec = va_arg (var_args, gchar*);
2353     }
2354   va_end (var_args);
2355 }
2356
2357 typedef struct {
2358   GObject *object;
2359   guint n_weak_refs;
2360   struct {
2361     GWeakNotify notify;
2362     gpointer    data;
2363   } weak_refs[1];  /* flexible array */
2364 } WeakRefStack;
2365
2366 static void
2367 weak_refs_notify (gpointer data)
2368 {
2369   WeakRefStack *wstack = data;
2370   guint i;
2371
2372   for (i = 0; i < wstack->n_weak_refs; i++)
2373     wstack->weak_refs[i].notify (wstack->weak_refs[i].data, wstack->object);
2374   g_free (wstack);
2375 }
2376
2377 /**
2378  * g_object_weak_ref: (skip)
2379  * @object: #GObject to reference weakly
2380  * @notify: callback to invoke before the object is freed
2381  * @data: extra data to pass to notify
2382  *
2383  * Adds a weak reference callback to an object. Weak references are
2384  * used for notification when an object is finalized. They are called
2385  * "weak references" because they allow you to safely hold a pointer
2386  * to an object without calling g_object_ref() (g_object_ref() adds a
2387  * strong reference, that is, forces the object to stay alive).
2388  */
2389 void
2390 g_object_weak_ref (GObject    *object,
2391                    GWeakNotify notify,
2392                    gpointer    data)
2393 {
2394   WeakRefStack *wstack;
2395   guint i;
2396   
2397   g_return_if_fail (G_IS_OBJECT (object));
2398   g_return_if_fail (notify != NULL);
2399   g_return_if_fail (object->ref_count >= 1);
2400
2401   G_LOCK (weak_refs_mutex);
2402   wstack = g_datalist_id_remove_no_notify (&object->qdata, quark_weak_refs);
2403   if (wstack)
2404     {
2405       i = wstack->n_weak_refs++;
2406       wstack = g_realloc (wstack, sizeof (*wstack) + sizeof (wstack->weak_refs[0]) * i);
2407     }
2408   else
2409     {
2410       wstack = g_renew (WeakRefStack, NULL, 1);
2411       wstack->object = object;
2412       wstack->n_weak_refs = 1;
2413       i = 0;
2414     }
2415   wstack->weak_refs[i].notify = notify;
2416   wstack->weak_refs[i].data = data;
2417   g_datalist_id_set_data_full (&object->qdata, quark_weak_refs, wstack, weak_refs_notify);
2418   G_UNLOCK (weak_refs_mutex);
2419 }
2420
2421 /**
2422  * g_object_weak_unref: (skip)
2423  * @object: #GObject to remove a weak reference from
2424  * @notify: callback to search for
2425  * @data: data to search for
2426  *
2427  * Removes a weak reference callback to an object.
2428  */
2429 void
2430 g_object_weak_unref (GObject    *object,
2431                      GWeakNotify notify,
2432                      gpointer    data)
2433 {
2434   WeakRefStack *wstack;
2435   gboolean found_one = FALSE;
2436
2437   g_return_if_fail (G_IS_OBJECT (object));
2438   g_return_if_fail (notify != NULL);
2439
2440   G_LOCK (weak_refs_mutex);
2441   wstack = g_datalist_id_get_data (&object->qdata, quark_weak_refs);
2442   if (wstack)
2443     {
2444       guint i;
2445
2446       for (i = 0; i < wstack->n_weak_refs; i++)
2447         if (wstack->weak_refs[i].notify == notify &&
2448             wstack->weak_refs[i].data == data)
2449           {
2450             found_one = TRUE;
2451             wstack->n_weak_refs -= 1;
2452             if (i != wstack->n_weak_refs)
2453               wstack->weak_refs[i] = wstack->weak_refs[wstack->n_weak_refs];
2454
2455             break;
2456           }
2457     }
2458   G_UNLOCK (weak_refs_mutex);
2459   if (!found_one)
2460     g_warning ("%s: couldn't find weak ref %p(%p)", G_STRFUNC, notify, data);
2461 }
2462
2463 /**
2464  * g_object_add_weak_pointer: (skip)
2465  * @object: The object that should be weak referenced.
2466  * @weak_pointer_location: (inout): The memory address of a pointer.
2467  *
2468  * Adds a weak reference from weak_pointer to @object to indicate that
2469  * the pointer located at @weak_pointer_location is only valid during
2470  * the lifetime of @object. When the @object is finalized,
2471  * @weak_pointer will be set to %NULL.
2472  */
2473 void
2474 g_object_add_weak_pointer (GObject  *object, 
2475                            gpointer *weak_pointer_location)
2476 {
2477   g_return_if_fail (G_IS_OBJECT (object));
2478   g_return_if_fail (weak_pointer_location != NULL);
2479
2480   g_object_weak_ref (object, 
2481                      (GWeakNotify) g_nullify_pointer, 
2482                      weak_pointer_location);
2483 }
2484
2485 /**
2486  * g_object_remove_weak_pointer: (skip)
2487  * @object: The object that is weak referenced.
2488  * @weak_pointer_location: (inout): The memory address of a pointer.
2489  *
2490  * Removes a weak reference from @object that was previously added
2491  * using g_object_add_weak_pointer(). The @weak_pointer_location has
2492  * to match the one used with g_object_add_weak_pointer().
2493  */
2494 void
2495 g_object_remove_weak_pointer (GObject  *object, 
2496                               gpointer *weak_pointer_location)
2497 {
2498   g_return_if_fail (G_IS_OBJECT (object));
2499   g_return_if_fail (weak_pointer_location != NULL);
2500
2501   g_object_weak_unref (object, 
2502                        (GWeakNotify) g_nullify_pointer, 
2503                        weak_pointer_location);
2504 }
2505
2506 static guint
2507 object_floating_flag_handler (GObject        *object,
2508                               gint            job)
2509 {
2510   switch (job)
2511     {
2512       gpointer oldvalue;
2513     case +1:    /* force floating if possible */
2514       do
2515         oldvalue = g_atomic_pointer_get (&object->qdata);
2516       while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2517                                                      (gpointer) ((gsize) oldvalue | OBJECT_FLOATING_FLAG)));
2518       return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2519     case -1:    /* sink if possible */
2520       do
2521         oldvalue = g_atomic_pointer_get (&object->qdata);
2522       while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2523                                                      (gpointer) ((gsize) oldvalue & ~(gsize) OBJECT_FLOATING_FLAG)));
2524       return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2525     default:    /* check floating */
2526       return 0 != ((gsize) g_atomic_pointer_get (&object->qdata) & OBJECT_FLOATING_FLAG);
2527     }
2528 }
2529
2530 /**
2531  * g_object_is_floating:
2532  * @object: (type GObject.Object): a #GObject
2533  *
2534  * Checks whether @object has a <link linkend="floating-ref">floating</link>
2535  * reference.
2536  *
2537  * Since: 2.10
2538  *
2539  * Returns: %TRUE if @object has a floating reference
2540  */
2541 gboolean
2542 g_object_is_floating (gpointer _object)
2543 {
2544   GObject *object = _object;
2545   g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
2546   return floating_flag_handler (object, 0);
2547 }
2548
2549 /**
2550  * g_object_ref_sink:
2551  * @object: (type GObject.Object): a #GObject
2552  *
2553  * Increase the reference count of @object, and possibly remove the
2554  * <link linkend="floating-ref">floating</link> reference, if @object
2555  * has a floating reference.
2556  *
2557  * In other words, if the object is floating, then this call "assumes
2558  * ownership" of the floating reference, converting it to a normal
2559  * reference by clearing the floating flag while leaving the reference
2560  * count unchanged.  If the object is not floating, then this call
2561  * adds a new normal reference increasing the reference count by one.
2562  *
2563  * Since: 2.10
2564  *
2565  * Returns: (type GObject.Object) (transfer none): @object
2566  */
2567 gpointer
2568 g_object_ref_sink (gpointer _object)
2569 {
2570   GObject *object = _object;
2571   gboolean was_floating;
2572   g_return_val_if_fail (G_IS_OBJECT (object), object);
2573   g_return_val_if_fail (object->ref_count >= 1, object);
2574   g_object_ref (object);
2575   was_floating = floating_flag_handler (object, -1);
2576   if (was_floating)
2577     g_object_unref (object);
2578   return object;
2579 }
2580
2581 /**
2582  * g_object_force_floating:
2583  * @object: a #GObject
2584  *
2585  * This function is intended for #GObject implementations to re-enforce a
2586  * <link linkend="floating-ref">floating</link> object reference.
2587  * Doing this is seldom required: all
2588  * #GInitiallyUnowned<!-- -->s are created with a floating reference which
2589  * usually just needs to be sunken by calling g_object_ref_sink().
2590  *
2591  * Since: 2.10
2592  */
2593 void
2594 g_object_force_floating (GObject *object)
2595 {
2596   g_return_if_fail (G_IS_OBJECT (object));
2597   g_return_if_fail (object->ref_count >= 1);
2598
2599   floating_flag_handler (object, +1);
2600 }
2601
2602 typedef struct {
2603   GObject *object;
2604   guint n_toggle_refs;
2605   struct {
2606     GToggleNotify notify;
2607     gpointer    data;
2608   } toggle_refs[1];  /* flexible array */
2609 } ToggleRefStack;
2610
2611 static void
2612 toggle_refs_notify (GObject *object,
2613                     gboolean is_last_ref)
2614 {
2615   ToggleRefStack tstack, *tstackptr;
2616
2617   G_LOCK (toggle_refs_mutex);
2618   tstackptr = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2619   tstack = *tstackptr;
2620   G_UNLOCK (toggle_refs_mutex);
2621
2622   /* Reentrancy here is not as tricky as it seems, because a toggle reference
2623    * will only be notified when there is exactly one of them.
2624    */
2625   g_assert (tstack.n_toggle_refs == 1);
2626   tstack.toggle_refs[0].notify (tstack.toggle_refs[0].data, tstack.object, is_last_ref);
2627 }
2628
2629 /**
2630  * g_object_add_toggle_ref: (skip)
2631  * @object: a #GObject
2632  * @notify: a function to call when this reference is the
2633  *  last reference to the object, or is no longer
2634  *  the last reference.
2635  * @data: data to pass to @notify
2636  *
2637  * Increases the reference count of the object by one and sets a
2638  * callback to be called when all other references to the object are
2639  * dropped, or when this is already the last reference to the object
2640  * and another reference is established.
2641  *
2642  * This functionality is intended for binding @object to a proxy
2643  * object managed by another memory manager. This is done with two
2644  * paired references: the strong reference added by
2645  * g_object_add_toggle_ref() and a reverse reference to the proxy
2646  * object which is either a strong reference or weak reference.
2647  *
2648  * The setup is that when there are no other references to @object,
2649  * only a weak reference is held in the reverse direction from @object
2650  * to the proxy object, but when there are other references held to
2651  * @object, a strong reference is held. The @notify callback is called
2652  * when the reference from @object to the proxy object should be
2653  * <firstterm>toggled</firstterm> from strong to weak (@is_last_ref
2654  * true) or weak to strong (@is_last_ref false).
2655  *
2656  * Since a (normal) reference must be held to the object before
2657  * calling g_object_add_toggle_ref(), the initial state of the reverse
2658  * link is always strong.
2659  *
2660  * Multiple toggle references may be added to the same gobject,
2661  * however if there are multiple toggle references to an object, none
2662  * of them will ever be notified until all but one are removed.  For
2663  * this reason, you should only ever use a toggle reference if there
2664  * is important state in the proxy object.
2665  *
2666  * Since: 2.8
2667  */
2668 void
2669 g_object_add_toggle_ref (GObject       *object,
2670                          GToggleNotify  notify,
2671                          gpointer       data)
2672 {
2673   ToggleRefStack *tstack;
2674   guint i;
2675   
2676   g_return_if_fail (G_IS_OBJECT (object));
2677   g_return_if_fail (notify != NULL);
2678   g_return_if_fail (object->ref_count >= 1);
2679
2680   g_object_ref (object);
2681
2682   G_LOCK (toggle_refs_mutex);
2683   tstack = g_datalist_id_remove_no_notify (&object->qdata, quark_toggle_refs);
2684   if (tstack)
2685     {
2686       i = tstack->n_toggle_refs++;
2687       /* allocate i = tstate->n_toggle_refs - 1 positions beyond the 1 declared
2688        * in tstate->toggle_refs */
2689       tstack = g_realloc (tstack, sizeof (*tstack) + sizeof (tstack->toggle_refs[0]) * i);
2690     }
2691   else
2692     {
2693       tstack = g_renew (ToggleRefStack, NULL, 1);
2694       tstack->object = object;
2695       tstack->n_toggle_refs = 1;
2696       i = 0;
2697     }
2698
2699   /* Set a flag for fast lookup after adding the first toggle reference */
2700   if (tstack->n_toggle_refs == 1)
2701     g_datalist_set_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2702   
2703   tstack->toggle_refs[i].notify = notify;
2704   tstack->toggle_refs[i].data = data;
2705   g_datalist_id_set_data_full (&object->qdata, quark_toggle_refs, tstack,
2706                                (GDestroyNotify)g_free);
2707   G_UNLOCK (toggle_refs_mutex);
2708 }
2709
2710 /**
2711  * g_object_remove_toggle_ref: (skip)
2712  * @object: a #GObject
2713  * @notify: a function to call when this reference is the
2714  *  last reference to the object, or is no longer
2715  *  the last reference.
2716  * @data: data to pass to @notify
2717  *
2718  * Removes a reference added with g_object_add_toggle_ref(). The
2719  * reference count of the object is decreased by one.
2720  *
2721  * Since: 2.8
2722  */
2723 void
2724 g_object_remove_toggle_ref (GObject       *object,
2725                             GToggleNotify  notify,
2726                             gpointer       data)
2727 {
2728   ToggleRefStack *tstack;
2729   gboolean found_one = FALSE;
2730
2731   g_return_if_fail (G_IS_OBJECT (object));
2732   g_return_if_fail (notify != NULL);
2733
2734   G_LOCK (toggle_refs_mutex);
2735   tstack = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2736   if (tstack)
2737     {
2738       guint i;
2739
2740       for (i = 0; i < tstack->n_toggle_refs; i++)
2741         if (tstack->toggle_refs[i].notify == notify &&
2742             tstack->toggle_refs[i].data == data)
2743           {
2744             found_one = TRUE;
2745             tstack->n_toggle_refs -= 1;
2746             if (i != tstack->n_toggle_refs)
2747               tstack->toggle_refs[i] = tstack->toggle_refs[tstack->n_toggle_refs];
2748
2749             if (tstack->n_toggle_refs == 0)
2750               g_datalist_unset_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2751
2752             break;
2753           }
2754     }
2755   G_UNLOCK (toggle_refs_mutex);
2756
2757   if (found_one)
2758     g_object_unref (object);
2759   else
2760     g_warning ("%s: couldn't find toggle ref %p(%p)", G_STRFUNC, notify, data);
2761 }
2762
2763 /**
2764  * g_object_ref:
2765  * @object: (type GObject.Object): a #GObject
2766  *
2767  * Increases the reference count of @object.
2768  *
2769  * Returns: (type GObject.Object) (transfer none): the same @object
2770  */
2771 gpointer
2772 g_object_ref (gpointer _object)
2773 {
2774   GObject *object = _object;
2775   gint old_val;
2776
2777   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2778   g_return_val_if_fail (object->ref_count > 0, NULL);
2779   
2780 #ifdef  G_ENABLE_DEBUG
2781   if (g_trap_object_ref == object)
2782     G_BREAKPOINT ();
2783 #endif  /* G_ENABLE_DEBUG */
2784
2785
2786   old_val = g_atomic_int_add (&object->ref_count, 1);
2787
2788   if (old_val == 1 && OBJECT_HAS_TOGGLE_REF (object))
2789     toggle_refs_notify (object, FALSE);
2790
2791   TRACE (GOBJECT_OBJECT_REF(object,G_TYPE_FROM_INSTANCE(object),old_val));
2792
2793   return object;
2794 }
2795
2796 /**
2797  * g_object_unref:
2798  * @object: (type GObject.Object): a #GObject
2799  *
2800  * Decreases the reference count of @object. When its reference count
2801  * drops to 0, the object is finalized (i.e. its memory is freed).
2802  */
2803 void
2804 g_object_unref (gpointer _object)
2805 {
2806   GObject *object = _object;
2807   gint old_ref;
2808   
2809   g_return_if_fail (G_IS_OBJECT (object));
2810   g_return_if_fail (object->ref_count > 0);
2811   
2812 #ifdef  G_ENABLE_DEBUG
2813   if (g_trap_object_ref == object)
2814     G_BREAKPOINT ();
2815 #endif  /* G_ENABLE_DEBUG */
2816
2817   /* here we want to atomically do: if (ref_count>1) { ref_count--; return; } */
2818  retry_atomic_decrement1:
2819   old_ref = g_atomic_int_get (&object->ref_count);
2820   if (old_ref > 1)
2821     {
2822       /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2823       gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2824
2825       if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2826         goto retry_atomic_decrement1;
2827
2828       TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2829
2830       /* if we went from 2->1 we need to notify toggle refs if any */
2831       if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2832         toggle_refs_notify (object, TRUE);
2833     }
2834   else
2835     {
2836       /* we are about tp remove the last reference */
2837       TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 1));
2838       G_OBJECT_GET_CLASS (object)->dispose (object);
2839       TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 1));
2840
2841       /* may have been re-referenced meanwhile */
2842     retry_atomic_decrement2:
2843       old_ref = g_atomic_int_get ((int *)&object->ref_count);
2844       if (old_ref > 1)
2845         {
2846           /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2847           gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2848
2849           if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2850             goto retry_atomic_decrement2;
2851
2852           TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2853
2854           /* if we went from 2->1 we need to notify toggle refs if any */
2855           if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2856             toggle_refs_notify (object, TRUE);
2857
2858           return;
2859         }
2860
2861       /* we are still in the process of taking away the last ref */
2862       g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
2863       g_signal_handlers_destroy (object);
2864       g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
2865       
2866       /* decrement the last reference */
2867       old_ref = g_atomic_int_add (&object->ref_count, -1);
2868
2869       TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2870
2871       /* may have been re-referenced meanwhile */
2872       if (G_LIKELY (old_ref == 1))
2873         {
2874           TRACE (GOBJECT_OBJECT_FINALIZE(object,G_TYPE_FROM_INSTANCE(object)));
2875           G_OBJECT_GET_CLASS (object)->finalize (object);
2876
2877           TRACE (GOBJECT_OBJECT_FINALIZE_END(object,G_TYPE_FROM_INSTANCE(object)));
2878
2879 #ifdef  G_ENABLE_DEBUG
2880           IF_DEBUG (OBJECTS)
2881             {
2882               /* catch objects not chaining finalize handlers */
2883               G_LOCK (debug_objects);
2884               g_assert (g_hash_table_lookup (debug_objects_ht, object) == NULL);
2885               G_UNLOCK (debug_objects);
2886             }
2887 #endif  /* G_ENABLE_DEBUG */
2888           g_type_free_instance ((GTypeInstance*) object);
2889         }
2890     }
2891 }
2892
2893 /**
2894  * g_clear_object: (skip)
2895  * @object_ptr: a pointer to a #GObject reference
2896  *
2897  * Clears a reference to a #GObject.
2898  *
2899  * @object_ptr must not be %NULL.
2900  *
2901  * If the reference is %NULL then this function does nothing.
2902  * Otherwise, the reference count of the object is decreased and the
2903  * pointer is set to %NULL.
2904  *
2905  * This function is threadsafe and modifies the pointer atomically,
2906  * using memory barriers where needed.
2907  *
2908  * A macro is also included that allows this function to be used without
2909  * pointer casts.
2910  *
2911  * Since: 2.28
2912  **/
2913 #undef g_clear_object
2914 void
2915 g_clear_object (volatile GObject **object_ptr)
2916 {
2917   gpointer *ptr = (gpointer) object_ptr;
2918   gpointer old;
2919
2920   /* This is a little frustrating.
2921    * Would be nice to have an atomic exchange (with no compare).
2922    */
2923   do
2924     old = g_atomic_pointer_get (ptr);
2925   while G_UNLIKELY (!g_atomic_pointer_compare_and_exchange (ptr, old, NULL));
2926
2927   if (old)
2928     g_object_unref (old);
2929 }
2930
2931 /**
2932  * g_object_get_qdata:
2933  * @object: The GObject to get a stored user data pointer from
2934  * @quark: A #GQuark, naming the user data pointer
2935  * 
2936  * This function gets back user data pointers stored via
2937  * g_object_set_qdata().
2938  * 
2939  * Returns: (transfer none): The user data pointer set, or %NULL
2940  */
2941 gpointer
2942 g_object_get_qdata (GObject *object,
2943                     GQuark   quark)
2944 {
2945   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2946   
2947   return quark ? g_datalist_id_get_data (&object->qdata, quark) : NULL;
2948 }
2949
2950 /**
2951  * g_object_set_qdata: (skip)
2952  * @object: The GObject to set store a user data pointer
2953  * @quark: A #GQuark, naming the user data pointer
2954  * @data: An opaque user data pointer
2955  *
2956  * This sets an opaque, named pointer on an object.
2957  * The name is specified through a #GQuark (retrived e.g. via
2958  * g_quark_from_static_string()), and the pointer
2959  * can be gotten back from the @object with g_object_get_qdata()
2960  * until the @object is finalized.
2961  * Setting a previously set user data pointer, overrides (frees)
2962  * the old pointer set, using #NULL as pointer essentially
2963  * removes the data stored.
2964  */
2965 void
2966 g_object_set_qdata (GObject *object,
2967                     GQuark   quark,
2968                     gpointer data)
2969 {
2970   g_return_if_fail (G_IS_OBJECT (object));
2971   g_return_if_fail (quark > 0);
2972   
2973   g_datalist_id_set_data (&object->qdata, quark, data);
2974 }
2975
2976 /**
2977  * g_object_set_qdata_full: (skip)
2978  * @object: The GObject to set store a user data pointer
2979  * @quark: A #GQuark, naming the user data pointer
2980  * @data: An opaque user data pointer
2981  * @destroy: Function to invoke with @data as argument, when @data
2982  *           needs to be freed
2983  *
2984  * This function works like g_object_set_qdata(), but in addition,
2985  * a void (*destroy) (gpointer) function may be specified which is
2986  * called with @data as argument when the @object is finalized, or
2987  * the data is being overwritten by a call to g_object_set_qdata()
2988  * with the same @quark.
2989  */
2990 void
2991 g_object_set_qdata_full (GObject       *object,
2992                          GQuark         quark,
2993                          gpointer       data,
2994                          GDestroyNotify destroy)
2995 {
2996   g_return_if_fail (G_IS_OBJECT (object));
2997   g_return_if_fail (quark > 0);
2998   
2999   g_datalist_id_set_data_full (&object->qdata, quark, data,
3000                                data ? destroy : (GDestroyNotify) NULL);
3001 }
3002
3003 /**
3004  * g_object_steal_qdata:
3005  * @object: The GObject to get a stored user data pointer from
3006  * @quark: A #GQuark, naming the user data pointer
3007  *
3008  * This function gets back user data pointers stored via
3009  * g_object_set_qdata() and removes the @data from object
3010  * without invoking its destroy() function (if any was
3011  * set).
3012  * Usually, calling this function is only required to update
3013  * user data pointers with a destroy notifier, for example:
3014  * |[
3015  * void
3016  * object_add_to_user_list (GObject     *object,
3017  *                          const gchar *new_string)
3018  * {
3019  *   // the quark, naming the object data
3020  *   GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
3021  *   // retrive the old string list
3022  *   GList *list = g_object_steal_qdata (object, quark_string_list);
3023  *
3024  *   // prepend new string
3025  *   list = g_list_prepend (list, g_strdup (new_string));
3026  *   // this changed 'list', so we need to set it again
3027  *   g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
3028  * }
3029  * static void
3030  * free_string_list (gpointer data)
3031  * {
3032  *   GList *node, *list = data;
3033  *
3034  *   for (node = list; node; node = node->next)
3035  *     g_free (node->data);
3036  *   g_list_free (list);
3037  * }
3038  * ]|
3039  * Using g_object_get_qdata() in the above example, instead of
3040  * g_object_steal_qdata() would have left the destroy function set,
3041  * and thus the partial string list would have been freed upon
3042  * g_object_set_qdata_full().
3043  *
3044  * Returns: (transfer full): The user data pointer set, or %NULL
3045  */
3046 gpointer
3047 g_object_steal_qdata (GObject *object,
3048                       GQuark   quark)
3049 {
3050   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3051   g_return_val_if_fail (quark > 0, NULL);
3052   
3053   return g_datalist_id_remove_no_notify (&object->qdata, quark);
3054 }
3055
3056 /**
3057  * g_object_get_data:
3058  * @object: #GObject containing the associations
3059  * @key: name of the key for that association
3060  * 
3061  * Gets a named field from the objects table of associations (see g_object_set_data()).
3062  * 
3063  * Returns: (transfer none): the data if found, or %NULL if no such data exists.
3064  */
3065 gpointer
3066 g_object_get_data (GObject     *object,
3067                    const gchar *key)
3068 {
3069   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3070   g_return_val_if_fail (key != NULL, NULL);
3071
3072   return g_datalist_get_data (&object->qdata, key);
3073 }
3074
3075 /**
3076  * g_object_set_data:
3077  * @object: #GObject containing the associations.
3078  * @key: name of the key
3079  * @data: data to associate with that key
3080  *
3081  * Each object carries around a table of associations from
3082  * strings to pointers.  This function lets you set an association.
3083  *
3084  * If the object already had an association with that name,
3085  * the old association will be destroyed.
3086  */
3087 void
3088 g_object_set_data (GObject     *object,
3089                    const gchar *key,
3090                    gpointer     data)
3091 {
3092   g_return_if_fail (G_IS_OBJECT (object));
3093   g_return_if_fail (key != NULL);
3094
3095   g_datalist_id_set_data (&object->qdata, g_quark_from_string (key), data);
3096 }
3097
3098 /**
3099  * g_object_set_data_full: (skip)
3100  * @object: #GObject containing the associations
3101  * @key: name of the key
3102  * @data: data to associate with that key
3103  * @destroy: function to call when the association is destroyed
3104  *
3105  * Like g_object_set_data() except it adds notification
3106  * for when the association is destroyed, either by setting it
3107  * to a different value or when the object is destroyed.
3108  *
3109  * Note that the @destroy callback is not called if @data is %NULL.
3110  */
3111 void
3112 g_object_set_data_full (GObject       *object,
3113                         const gchar   *key,
3114                         gpointer       data,
3115                         GDestroyNotify destroy)
3116 {
3117   g_return_if_fail (G_IS_OBJECT (object));
3118   g_return_if_fail (key != NULL);
3119
3120   g_datalist_id_set_data_full (&object->qdata, g_quark_from_string (key), data,
3121                                data ? destroy : (GDestroyNotify) NULL);
3122 }
3123
3124 /**
3125  * g_object_steal_data:
3126  * @object: #GObject containing the associations
3127  * @key: name of the key
3128  *
3129  * Remove a specified datum from the object's data associations,
3130  * without invoking the association's destroy handler.
3131  *
3132  * Returns: (transfer full): the data if found, or %NULL if no such data exists.
3133  */
3134 gpointer
3135 g_object_steal_data (GObject     *object,
3136                      const gchar *key)
3137 {
3138   GQuark quark;
3139
3140   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3141   g_return_val_if_fail (key != NULL, NULL);
3142
3143   quark = g_quark_try_string (key);
3144
3145   return quark ? g_datalist_id_remove_no_notify (&object->qdata, quark) : NULL;
3146 }
3147
3148 static void
3149 g_value_object_init (GValue *value)
3150 {
3151   value->data[0].v_pointer = NULL;
3152 }
3153
3154 static void
3155 g_value_object_free_value (GValue *value)
3156 {
3157   if (value->data[0].v_pointer)
3158     g_object_unref (value->data[0].v_pointer);
3159 }
3160
3161 static void
3162 g_value_object_copy_value (const GValue *src_value,
3163                            GValue       *dest_value)
3164 {
3165   if (src_value->data[0].v_pointer)
3166     dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3167   else
3168     dest_value->data[0].v_pointer = NULL;
3169 }
3170
3171 static void
3172 g_value_object_transform_value (const GValue *src_value,
3173                                 GValue       *dest_value)
3174 {
3175   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)))
3176     dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3177   else
3178     dest_value->data[0].v_pointer = NULL;
3179 }
3180
3181 static gpointer
3182 g_value_object_peek_pointer (const GValue *value)
3183 {
3184   return value->data[0].v_pointer;
3185 }
3186
3187 static gchar*
3188 g_value_object_collect_value (GValue      *value,
3189                               guint        n_collect_values,
3190                               GTypeCValue *collect_values,
3191                               guint        collect_flags)
3192 {
3193   if (collect_values[0].v_pointer)
3194     {
3195       GObject *object = collect_values[0].v_pointer;
3196       
3197       if (object->g_type_instance.g_class == NULL)
3198         return g_strconcat ("invalid unclassed object pointer for value type `",
3199                             G_VALUE_TYPE_NAME (value),
3200                             "'",
3201                             NULL);
3202       else if (!g_value_type_compatible (G_OBJECT_TYPE (object), G_VALUE_TYPE (value)))
3203         return g_strconcat ("invalid object type `",
3204                             G_OBJECT_TYPE_NAME (object),
3205                             "' for value type `",
3206                             G_VALUE_TYPE_NAME (value),
3207                             "'",
3208                             NULL);
3209       /* never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types */
3210       value->data[0].v_pointer = g_object_ref (object);
3211     }
3212   else
3213     value->data[0].v_pointer = NULL;
3214   
3215   return NULL;
3216 }
3217
3218 static gchar*
3219 g_value_object_lcopy_value (const GValue *value,
3220                             guint        n_collect_values,
3221                             GTypeCValue *collect_values,
3222                             guint        collect_flags)
3223 {
3224   GObject **object_p = collect_values[0].v_pointer;
3225   
3226   if (!object_p)
3227     return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
3228
3229   if (!value->data[0].v_pointer)
3230     *object_p = NULL;
3231   else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
3232     *object_p = value->data[0].v_pointer;
3233   else
3234     *object_p = g_object_ref (value->data[0].v_pointer);
3235   
3236   return NULL;
3237 }
3238
3239 /**
3240  * g_value_set_object:
3241  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3242  * @v_object: (type GObject.Object) (allow-none): object value to be set
3243  *
3244  * Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
3245  *
3246  * g_value_set_object() increases the reference count of @v_object
3247  * (the #GValue holds a reference to @v_object).  If you do not wish
3248  * to increase the reference count of the object (i.e. you wish to
3249  * pass your current reference to the #GValue because you no longer
3250  * need it), use g_value_take_object() instead.
3251  *
3252  * It is important that your #GValue holds a reference to @v_object (either its
3253  * own, or one it has taken) to ensure that the object won't be destroyed while
3254  * the #GValue still exists).
3255  */
3256 void
3257 g_value_set_object (GValue   *value,
3258                     gpointer  v_object)
3259 {
3260   GObject *old;
3261         
3262   g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3263
3264   old = value->data[0].v_pointer;
3265   
3266   if (v_object)
3267     {
3268       g_return_if_fail (G_IS_OBJECT (v_object));
3269       g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3270
3271       value->data[0].v_pointer = v_object;
3272       g_object_ref (value->data[0].v_pointer);
3273     }
3274   else
3275     value->data[0].v_pointer = NULL;
3276   
3277   if (old)
3278     g_object_unref (old);
3279 }
3280
3281 /**
3282  * g_value_set_object_take_ownership: (skip)
3283  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3284  * @v_object: (allow-none): object value to be set
3285  *
3286  * This is an internal function introduced mainly for C marshallers.
3287  *
3288  * Deprecated: 2.4: Use g_value_take_object() instead.
3289  */
3290 void
3291 g_value_set_object_take_ownership (GValue  *value,
3292                                    gpointer v_object)
3293 {
3294   g_value_take_object (value, v_object);
3295 }
3296
3297 /**
3298  * g_value_take_object: (skip)
3299  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3300  * @v_object: (allow-none): object value to be set
3301  *
3302  * Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
3303  * and takes over the ownership of the callers reference to @v_object;
3304  * the caller doesn't have to unref it any more (i.e. the reference
3305  * count of the object is not increased).
3306  *
3307  * If you want the #GValue to hold its own reference to @v_object, use
3308  * g_value_set_object() instead.
3309  *
3310  * Since: 2.4
3311  */
3312 void
3313 g_value_take_object (GValue  *value,
3314                      gpointer v_object)
3315 {
3316   g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3317
3318   if (value->data[0].v_pointer)
3319     {
3320       g_object_unref (value->data[0].v_pointer);
3321       value->data[0].v_pointer = NULL;
3322     }
3323
3324   if (v_object)
3325     {
3326       g_return_if_fail (G_IS_OBJECT (v_object));
3327       g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3328
3329       value->data[0].v_pointer = v_object; /* we take over the reference count */
3330     }
3331 }
3332
3333 /**
3334  * g_value_get_object:
3335  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3336  * 
3337  * Get the contents of a %G_TYPE_OBJECT derived #GValue.
3338  * 
3339  * Returns: (type GObject.Object) (transfer none): object contents of @value
3340  */
3341 gpointer
3342 g_value_get_object (const GValue *value)
3343 {
3344   g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3345   
3346   return value->data[0].v_pointer;
3347 }
3348
3349 /**
3350  * g_value_dup_object:
3351  * @value: a valid #GValue whose type is derived from %G_TYPE_OBJECT
3352  *
3353  * Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing
3354  * its reference count. If the contents of the #GValue are %NULL, then
3355  * %NULL will be returned.
3356  *
3357  * Returns: (type GObject.Object) (transfer full): object content of @value,
3358  *          should be unreferenced when no longer needed.
3359  */
3360 gpointer
3361 g_value_dup_object (const GValue *value)
3362 {
3363   g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3364   
3365   return value->data[0].v_pointer ? g_object_ref (value->data[0].v_pointer) : NULL;
3366 }
3367
3368 /**
3369  * g_signal_connect_object: (skip)
3370  * @instance: the instance to connect to.
3371  * @detailed_signal: a string of the form "signal-name::detail".
3372  * @c_handler: the #GCallback to connect.
3373  * @gobject: the object to pass as data to @c_handler.
3374  * @connect_flags: a combination of #GConnectFlags.
3375  *
3376  * This is similar to g_signal_connect_data(), but uses a closure which
3377  * ensures that the @gobject stays alive during the call to @c_handler
3378  * by temporarily adding a reference count to @gobject.
3379  *
3380  * Note that there is a bug in GObject that makes this function
3381  * much less useful than it might seem otherwise. Once @gobject is
3382  * disposed, the callback will no longer be called, but, the signal
3383  * handler is <emphasis>not</emphasis> currently disconnected. If the
3384  * @instance is itself being freed at the same time than this doesn't
3385  * matter, since the signal will automatically be removed, but
3386  * if @instance persists, then the signal handler will leak. You
3387  * should not remove the signal yourself because in a future versions of
3388  * GObject, the handler <emphasis>will</emphasis> automatically
3389  * be disconnected.
3390  *
3391  * It's possible to work around this problem in a way that will
3392  * continue to work with future versions of GObject by checking
3393  * that the signal handler is still connected before disconnected it:
3394  * <informalexample><programlisting>
3395  *  if (g_signal_handler_is_connected (instance, id))
3396  *    g_signal_handler_disconnect (instance, id);
3397  * </programlisting></informalexample>
3398  *
3399  * Returns: the handler id.
3400  */
3401 gulong
3402 g_signal_connect_object (gpointer      instance,
3403                          const gchar  *detailed_signal,
3404                          GCallback     c_handler,
3405                          gpointer      gobject,
3406                          GConnectFlags connect_flags)
3407 {
3408   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
3409   g_return_val_if_fail (detailed_signal != NULL, 0);
3410   g_return_val_if_fail (c_handler != NULL, 0);
3411
3412   if (gobject)
3413     {
3414       GClosure *closure;
3415
3416       g_return_val_if_fail (G_IS_OBJECT (gobject), 0);
3417
3418       closure = ((connect_flags & G_CONNECT_SWAPPED) ? g_cclosure_new_object_swap : g_cclosure_new_object) (c_handler, gobject);
3419
3420       return g_signal_connect_closure (instance, detailed_signal, closure, connect_flags & G_CONNECT_AFTER);
3421     }
3422   else
3423     return g_signal_connect_data (instance, detailed_signal, c_handler, NULL, NULL, connect_flags);
3424 }
3425
3426 typedef struct {
3427   GObject  *object;
3428   guint     n_closures;
3429   GClosure *closures[1]; /* flexible array */
3430 } CArray;
3431 /* don't change this structure without supplying an accessor for
3432  * watched closures, e.g.:
3433  * GSList* g_object_list_watched_closures (GObject *object)
3434  * {
3435  *   CArray *carray;
3436  *   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3437  *   carray = g_object_get_data (object, "GObject-closure-array");
3438  *   if (carray)
3439  *     {
3440  *       GSList *slist = NULL;
3441  *       guint i;
3442  *       for (i = 0; i < carray->n_closures; i++)
3443  *         slist = g_slist_prepend (slist, carray->closures[i]);
3444  *       return slist;
3445  *     }
3446  *   return NULL;
3447  * }
3448  */
3449
3450 static void
3451 object_remove_closure (gpointer  data,
3452                        GClosure *closure)
3453 {
3454   GObject *object = data;
3455   CArray *carray;
3456   guint i;
3457   
3458   G_LOCK (closure_array_mutex);
3459   carray = g_object_get_qdata (object, quark_closure_array);
3460   for (i = 0; i < carray->n_closures; i++)
3461     if (carray->closures[i] == closure)
3462       {
3463         carray->n_closures--;
3464         if (i < carray->n_closures)
3465           carray->closures[i] = carray->closures[carray->n_closures];
3466         G_UNLOCK (closure_array_mutex);
3467         return;
3468       }
3469   G_UNLOCK (closure_array_mutex);
3470   g_assert_not_reached ();
3471 }
3472
3473 static void
3474 destroy_closure_array (gpointer data)
3475 {
3476   CArray *carray = data;
3477   GObject *object = carray->object;
3478   guint i, n = carray->n_closures;
3479   
3480   for (i = 0; i < n; i++)
3481     {
3482       GClosure *closure = carray->closures[i];
3483       
3484       /* removing object_remove_closure() upfront is probably faster than
3485        * letting it fiddle with quark_closure_array which is empty anyways
3486        */
3487       g_closure_remove_invalidate_notifier (closure, object, object_remove_closure);
3488       g_closure_invalidate (closure);
3489     }
3490   g_free (carray);
3491 }
3492
3493 /**
3494  * g_object_watch_closure:
3495  * @object: GObject restricting lifetime of @closure
3496  * @closure: GClosure to watch
3497  *
3498  * This function essentially limits the life time of the @closure to
3499  * the life time of the object. That is, when the object is finalized,
3500  * the @closure is invalidated by calling g_closure_invalidate() on
3501  * it, in order to prevent invocations of the closure with a finalized
3502  * (nonexisting) object. Also, g_object_ref() and g_object_unref() are
3503  * added as marshal guards to the @closure, to ensure that an extra
3504  * reference count is held on @object during invocation of the
3505  * @closure.  Usually, this function will be called on closures that
3506  * use this @object as closure data.
3507  */
3508 void
3509 g_object_watch_closure (GObject  *object,
3510                         GClosure *closure)
3511 {
3512   CArray *carray;
3513   guint i;
3514   
3515   g_return_if_fail (G_IS_OBJECT (object));
3516   g_return_if_fail (closure != NULL);
3517   g_return_if_fail (closure->is_invalid == FALSE);
3518   g_return_if_fail (closure->in_marshal == FALSE);
3519   g_return_if_fail (object->ref_count > 0);     /* this doesn't work on finalizing objects */
3520   
3521   g_closure_add_invalidate_notifier (closure, object, object_remove_closure);
3522   g_closure_add_marshal_guards (closure,
3523                                 object, (GClosureNotify) g_object_ref,
3524                                 object, (GClosureNotify) g_object_unref);
3525   G_LOCK (closure_array_mutex);
3526   carray = g_datalist_id_remove_no_notify (&object->qdata, quark_closure_array);
3527   if (!carray)
3528     {
3529       carray = g_renew (CArray, NULL, 1);
3530       carray->object = object;
3531       carray->n_closures = 1;
3532       i = 0;
3533     }
3534   else
3535     {
3536       i = carray->n_closures++;
3537       carray = g_realloc (carray, sizeof (*carray) + sizeof (carray->closures[0]) * i);
3538     }
3539   carray->closures[i] = closure;
3540   g_datalist_id_set_data_full (&object->qdata, quark_closure_array, carray, destroy_closure_array);
3541   G_UNLOCK (closure_array_mutex);
3542 }
3543
3544 /**
3545  * g_closure_new_object:
3546  * @sizeof_closure: the size of the structure to allocate, must be at least
3547  *  <literal>sizeof (GClosure)</literal>
3548  * @object: a #GObject pointer to store in the @data field of the newly
3549  *  allocated #GClosure
3550  *
3551  * A variant of g_closure_new_simple() which stores @object in the
3552  * @data field of the closure and calls g_object_watch_closure() on
3553  * @object and the created closure. This function is mainly useful
3554  * when implementing new types of closures.
3555  *
3556  * Returns: (transfer full): a newly allocated #GClosure
3557  */
3558 GClosure*
3559 g_closure_new_object (guint    sizeof_closure,
3560                       GObject *object)
3561 {
3562   GClosure *closure;
3563
3564   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3565   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
3566
3567   closure = g_closure_new_simple (sizeof_closure, object);
3568   g_object_watch_closure (object, closure);
3569
3570   return closure;
3571 }
3572
3573 /**
3574  * g_cclosure_new_object: (skip)
3575  * @callback_func: the function to invoke
3576  * @object: a #GObject pointer to pass to @callback_func
3577  *
3578  * A variant of g_cclosure_new() which uses @object as @user_data and
3579  * calls g_object_watch_closure() on @object and the created
3580  * closure. This function is useful when you have a callback closely
3581  * associated with a #GObject, and want the callback to no longer run
3582  * after the object is is freed.
3583  *
3584  * Returns: a new #GCClosure
3585  */
3586 GClosure*
3587 g_cclosure_new_object (GCallback callback_func,
3588                        GObject  *object)
3589 {
3590   GClosure *closure;
3591
3592   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3593   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
3594   g_return_val_if_fail (callback_func != NULL, NULL);
3595
3596   closure = g_cclosure_new (callback_func, object, NULL);
3597   g_object_watch_closure (object, closure);
3598
3599   return closure;
3600 }
3601
3602 /**
3603  * g_cclosure_new_object_swap: (skip)
3604  * @callback_func: the function to invoke
3605  * @object: a #GObject pointer to pass to @callback_func
3606  *
3607  * A variant of g_cclosure_new_swap() which uses @object as @user_data
3608  * and calls g_object_watch_closure() on @object and the created
3609  * closure. This function is useful when you have a callback closely
3610  * associated with a #GObject, and want the callback to no longer run
3611  * after the object is is freed.
3612  *
3613  * Returns: a new #GCClosure
3614  */
3615 GClosure*
3616 g_cclosure_new_object_swap (GCallback callback_func,
3617                             GObject  *object)
3618 {
3619   GClosure *closure;
3620
3621   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3622   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
3623   g_return_val_if_fail (callback_func != NULL, NULL);
3624
3625   closure = g_cclosure_new_swap (callback_func, object, NULL);
3626   g_object_watch_closure (object, closure);
3627
3628   return closure;
3629 }
3630
3631 gsize
3632 g_object_compat_control (gsize           what,
3633                          gpointer        data)
3634 {
3635   switch (what)
3636     {
3637       gpointer *pp;
3638     case 1:     /* floating base type */
3639       return G_TYPE_INITIALLY_UNOWNED;
3640     case 2:     /* FIXME: remove this once GLib/Gtk+ break ABI again */
3641       floating_flag_handler = (guint(*)(GObject*,gint)) data;
3642       return 1;
3643     case 3:     /* FIXME: remove this once GLib/Gtk+ break ABI again */
3644       pp = data;
3645       *pp = floating_flag_handler;
3646       return 1;
3647     default:
3648       return 0;
3649     }
3650 }
3651
3652 G_DEFINE_TYPE (GInitiallyUnowned, g_initially_unowned, G_TYPE_OBJECT);
3653
3654 static void
3655 g_initially_unowned_init (GInitiallyUnowned *object)
3656 {
3657   g_object_force_floating (object);
3658 }
3659
3660 static void
3661 g_initially_unowned_class_init (GInitiallyUnownedClass *klass)
3662 {
3663 }