GObject: allow G_PARAM_CONSTRUCT on any override
[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       /* We do a number of checks on the properties of an interface to
1377        * make sure that all classes implementing the interface are
1378        * overriding the properties in a sane way.
1379        *
1380        * We do the checks in order of importance so that we can give
1381        * more useful error messages first.
1382        *
1383        * First, we check that the implementation doesn't remove the
1384        * basic functionality (readability, writability) advertised by
1385        * the interface.  Next, we check that it doesn't introduce
1386        * additional restrictions (such as construct-only).  Finally, we
1387        * make sure the types are compatible.
1388        */
1389
1390 #define SUBSET(a,b,mask) (((a) & ~(b) & (mask)) == 0)
1391       /* If the property on the interface is readable then the
1392        * implementation must be readable.  If the interface is writable
1393        * then the implementation must be writable.
1394        */
1395       if (!SUBSET (pspecs[n]->flags, class_pspec->flags, G_PARAM_READABLE | G_PARAM_WRITABLE))
1396         {
1397           g_critical ("Flags for property '%s' on class '%s' remove functionality compared with the "
1398                       "property on interface '%s'\n", pspecs[n]->name,
1399                       g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (iface_type));
1400           continue;
1401         }
1402
1403       /* If the property on the interface is writable then we need to
1404        * make sure the implementation doesn't introduce new restrictions
1405        * on that writability (ie: construct-only).
1406        *
1407        * If the interface was not writable to begin with then we don't
1408        * really have any problems here because "writable at construct
1409        * type only" is still more permissive than "read only".
1410        */
1411       if (pspecs[n]->flags & G_PARAM_WRITABLE)
1412         {
1413           if (!SUBSET (class_pspec->flags, pspecs[n]->flags, G_PARAM_CONSTRUCT_ONLY))
1414             {
1415               g_critical ("Flags for property '%s' on class '%s' introduce additional restrictions on "
1416                           "writability compared with the property on interface '%s'\n", pspecs[n]->name,
1417                           g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (iface_type));
1418               continue;
1419             }
1420         }
1421 #undef SUBSET
1422
1423       /* If the property on the interface is readable then we are
1424        * effectively advertising that reading the property will return a
1425        * value of a specific type.  All implementations of the interface
1426        * need to return items of this type -- but may be more
1427        * restrictive.  For example, it is legal to have:
1428        *
1429        *   GtkWidget *get_item();
1430        *
1431        * that is implemented by a function that always returns a
1432        * GtkEntry.  In short: readability implies that the
1433        * implementation  value type must be equal or more restrictive.
1434        *
1435        * Similarly, if the property on the interface is writable then
1436        * must be able to accept the property being set to any value of
1437        * that type, including subclasses.  In this case, we may also be
1438        * less restrictive.  For example, it is legal to have:
1439        *
1440        *   set_item (GtkEntry *);
1441        *
1442        * that is implemented by a function that will actually work with
1443        * any GtkWidget.  In short: writability implies that the
1444        * implementation value type must be equal or less restrictive.
1445        *
1446        * In the case that the property is both readable and writable
1447        * then the only way that both of the above can be satisfied is
1448        * with a type that is exactly equal.
1449        */
1450       switch (pspecs[n]->flags & (G_PARAM_READABLE | G_PARAM_WRITABLE))
1451         {
1452         case G_PARAM_READABLE | G_PARAM_WRITABLE:
1453           /* class pspec value type must have exact equality with interface */
1454           if (pspecs[n]->value_type != class_pspec->value_type)
1455             g_critical ("Read/writable property '%s' on class '%s' has type '%s' which is not exactly equal to the "
1456                         "type '%s' of the property on the interface '%s'\n", pspecs[n]->name,
1457                         g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1458                         g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])), g_type_name (iface_type));
1459           break;
1460
1461         case G_PARAM_READABLE:
1462           /* class pspec value type equal or more restrictive than interface */
1463           if (!g_type_is_a (class_pspec->value_type, pspecs[n]->value_type))
1464             g_critical ("Read-only property '%s' on class '%s' has type '%s' which is not equal to or more "
1465                         "restrictive than the type '%s' of the property on the interface '%s'\n", pspecs[n]->name,
1466                         g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1467                         g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])), g_type_name (iface_type));
1468           break;
1469
1470         case G_PARAM_WRITABLE:
1471           /* class pspec value type equal or less restrictive than interface */
1472           if (!g_type_is_a (pspecs[n]->value_type, class_pspec->value_type))
1473             g_critical ("Write-only property '%s' on class '%s' has type '%s' which is not equal to or less "
1474                         "restrictive than the type '%s' of the property on the interface '%s' \n", pspecs[n]->name,
1475                         g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1476                         g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])), g_type_name (iface_type));
1477           break;
1478
1479         default:
1480           g_assert_not_reached ();
1481         }
1482     }
1483
1484   g_free (pspecs);
1485
1486   g_type_class_unref (class);
1487 }
1488
1489 GType
1490 g_object_get_type (void)
1491 {
1492     return G_TYPE_OBJECT;
1493 }
1494
1495 /**
1496  * g_object_new: (skip)
1497  * @object_type: the type id of the #GObject subtype to instantiate
1498  * @first_property_name: the name of the first property
1499  * @...: the value of the first property, followed optionally by more
1500  *  name/value pairs, followed by %NULL
1501  *
1502  * Creates a new instance of a #GObject subtype and sets its properties.
1503  *
1504  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1505  * which are not explicitly specified are set to their default values.
1506  *
1507  * Returns: (transfer full): a new instance of @object_type
1508  */
1509 gpointer
1510 g_object_new (GType        object_type,
1511               const gchar *first_property_name,
1512               ...)
1513 {
1514   GObject *object;
1515   va_list var_args;
1516   
1517   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1518   
1519   /* short circuit for calls supplying no properties */
1520   if (!first_property_name)
1521     return g_object_newv (object_type, 0, NULL);
1522
1523   va_start (var_args, first_property_name);
1524   object = g_object_new_valist (object_type, first_property_name, var_args);
1525   va_end (var_args);
1526   
1527   return object;
1528 }
1529
1530 static gboolean
1531 slist_maybe_remove (GSList       **slist,
1532                     gconstpointer  data)
1533 {
1534   GSList *last = NULL, *node = *slist;
1535   while (node)
1536     {
1537       if (node->data == data)
1538         {
1539           if (last)
1540             last->next = node->next;
1541           else
1542             *slist = node->next;
1543           g_slist_free_1 (node);
1544           return TRUE;
1545         }
1546       last = node;
1547       node = last->next;
1548     }
1549   return FALSE;
1550 }
1551
1552 static inline gboolean
1553 object_in_construction_list (GObject *object)
1554 {
1555   gboolean in_construction;
1556   G_LOCK (construction_mutex);
1557   in_construction = g_slist_find (construction_objects, object) != NULL;
1558   G_UNLOCK (construction_mutex);
1559   return in_construction;
1560 }
1561
1562 /**
1563  * g_object_newv:
1564  * @object_type: the type id of the #GObject subtype to instantiate
1565  * @n_parameters: the length of the @parameters array
1566  * @parameters: (array length=n_parameters): an array of #GParameter
1567  *
1568  * Creates a new instance of a #GObject subtype and sets its properties.
1569  *
1570  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1571  * which are not explicitly specified are set to their default values.
1572  *
1573  * Rename to: g_object_new
1574  * Returns: (type GObject.Object) (transfer full): a new instance of
1575  * @object_type
1576  */
1577 gpointer
1578 g_object_newv (GType       object_type,
1579                guint       n_parameters,
1580                GParameter *parameters)
1581 {
1582   GObjectConstructParam *cparams = NULL, *oparams;
1583   GObjectNotifyQueue *nqueue = NULL; /* shouldn't be initialized, just to silence compiler */
1584   GObject *object;
1585   GObjectClass *class, *unref_class = NULL;
1586   GSList *slist;
1587   guint n_total_cparams = 0, n_cparams = 0, n_oparams = 0, n_cvalues;
1588   GValue *cvalues;
1589   GList *clist = NULL;
1590   gboolean newly_constructed;
1591   guint i;
1592
1593   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1594
1595   class = g_type_class_peek_static (object_type);
1596   if (!class)
1597     class = unref_class = g_type_class_ref (object_type);
1598   for (slist = class->construct_properties; slist; slist = slist->next)
1599     {
1600       clist = g_list_prepend (clist, slist->data);
1601       n_total_cparams += 1;
1602     }
1603
1604   if (n_parameters == 0 && n_total_cparams == 0)
1605     {
1606       /* This is a simple object with no construct properties, and
1607        * no properties are being set, so short circuit the parameter
1608        * handling. This speeds up simple object construction.
1609        */
1610       oparams = NULL;
1611       object = class->constructor (object_type, 0, NULL);
1612       goto did_construction;
1613     }
1614
1615   /* collect parameters, sort into construction and normal ones */
1616   oparams = g_new (GObjectConstructParam, n_parameters);
1617   cparams = g_new (GObjectConstructParam, n_total_cparams);
1618   for (i = 0; i < n_parameters; i++)
1619     {
1620       GValue *value = &parameters[i].value;
1621       GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1622                                                     parameters[i].name,
1623                                                     object_type,
1624                                                     TRUE);
1625       if (!pspec)
1626         {
1627           g_warning ("%s: object class `%s' has no property named `%s'",
1628                      G_STRFUNC,
1629                      g_type_name (object_type),
1630                      parameters[i].name);
1631           continue;
1632         }
1633       if (!(pspec->flags & G_PARAM_WRITABLE))
1634         {
1635           g_warning ("%s: property `%s' of object class `%s' is not writable",
1636                      G_STRFUNC,
1637                      pspec->name,
1638                      g_type_name (object_type));
1639           continue;
1640         }
1641       if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1642         {
1643           GList *list = g_list_find (clist, pspec);
1644
1645           if (!list)
1646             {
1647               g_warning ("%s: construct property \"%s\" for object `%s' can't be set twice",
1648                          G_STRFUNC, pspec->name, g_type_name (object_type));
1649               continue;
1650             }
1651           cparams[n_cparams].pspec = pspec;
1652           cparams[n_cparams].value = value;
1653           n_cparams++;
1654           if (!list->prev)
1655             clist = list->next;
1656           else
1657             list->prev->next = list->next;
1658           if (list->next)
1659             list->next->prev = list->prev;
1660           g_list_free_1 (list);
1661         }
1662       else
1663         {
1664           oparams[n_oparams].pspec = pspec;
1665           oparams[n_oparams].value = value;
1666           n_oparams++;
1667         }
1668     }
1669
1670   /* set remaining construction properties to default values */
1671   n_cvalues = n_total_cparams - n_cparams;
1672   cvalues = g_new (GValue, n_cvalues);
1673   while (clist)
1674     {
1675       GList *tmp = clist->next;
1676       GParamSpec *pspec = clist->data;
1677       GValue *value = cvalues + n_total_cparams - n_cparams - 1;
1678
1679       value->g_type = 0;
1680       g_value_init (value, pspec->value_type);
1681       g_param_value_set_default (pspec, value);
1682
1683       cparams[n_cparams].pspec = pspec;
1684       cparams[n_cparams].value = value;
1685       n_cparams++;
1686
1687       g_list_free_1 (clist);
1688       clist = tmp;
1689     }
1690
1691   /* construct object from construction parameters */
1692   object = class->constructor (object_type, n_total_cparams, cparams);
1693   /* free construction values */
1694   g_free (cparams);
1695   while (n_cvalues--)
1696     g_value_unset (cvalues + n_cvalues);
1697   g_free (cvalues);
1698
1699  did_construction:
1700   if (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
1701     {
1702       /* adjust freeze_count according to g_object_init() and remaining properties */
1703       G_LOCK (construction_mutex);
1704       newly_constructed = slist_maybe_remove (&construction_objects, object);
1705       G_UNLOCK (construction_mutex);
1706     }
1707   else
1708     newly_constructed = TRUE;
1709
1710   if (CLASS_HAS_PROPS (class))
1711     {
1712       if (newly_constructed || n_oparams)
1713         nqueue = g_object_notify_queue_freeze (object, FALSE);
1714       if (newly_constructed)
1715         g_object_notify_queue_thaw (object, nqueue);
1716     }
1717
1718   /* run 'constructed' handler if there is a custom one */
1719   if (newly_constructed && CLASS_HAS_CUSTOM_CONSTRUCTED (class))
1720     class->constructed (object);
1721
1722   /* set remaining properties */
1723   for (i = 0; i < n_oparams; i++)
1724     object_set_property (object, oparams[i].pspec, oparams[i].value, nqueue);
1725   g_free (oparams);
1726
1727   if (CLASS_HAS_PROPS (class))
1728     {
1729       /* release our own freeze count and handle notifications */
1730       if (newly_constructed || n_oparams)
1731         g_object_notify_queue_thaw (object, nqueue);
1732     }
1733
1734   if (unref_class)
1735     g_type_class_unref (unref_class);
1736
1737   return object;
1738 }
1739
1740 /**
1741  * g_object_new_valist: (skip)
1742  * @object_type: the type id of the #GObject subtype to instantiate
1743  * @first_property_name: the name of the first property
1744  * @var_args: the value of the first property, followed optionally by more
1745  *  name/value pairs, followed by %NULL
1746  *
1747  * Creates a new instance of a #GObject subtype and sets its properties.
1748  *
1749  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1750  * which are not explicitly specified are set to their default values.
1751  *
1752  * Returns: a new instance of @object_type
1753  */
1754 GObject*
1755 g_object_new_valist (GType        object_type,
1756                      const gchar *first_property_name,
1757                      va_list      var_args)
1758 {
1759   GObjectClass *class;
1760   GParameter *params;
1761   const gchar *name;
1762   GObject *object;
1763   guint n_params = 0, n_alloced_params = 16;
1764   
1765   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1766
1767   if (!first_property_name)
1768     return g_object_newv (object_type, 0, NULL);
1769
1770   class = g_type_class_ref (object_type);
1771
1772   params = g_new0 (GParameter, n_alloced_params);
1773   name = first_property_name;
1774   while (name)
1775     {
1776       gchar *error = NULL;
1777       GParamSpec *pspec = g_param_spec_pool_lookup (pspec_pool,
1778                                                     name,
1779                                                     object_type,
1780                                                     TRUE);
1781       if (!pspec)
1782         {
1783           g_warning ("%s: object class `%s' has no property named `%s'",
1784                      G_STRFUNC,
1785                      g_type_name (object_type),
1786                      name);
1787           break;
1788         }
1789       if (n_params >= n_alloced_params)
1790         {
1791           n_alloced_params += 16;
1792           params = g_renew (GParameter, params, n_alloced_params);
1793           memset (params + n_params, 0, 16 * (sizeof *params));
1794         }
1795       params[n_params].name = name;
1796       G_VALUE_COLLECT_INIT (&params[n_params].value, pspec->value_type,
1797                             var_args, 0, &error);
1798       if (error)
1799         {
1800           g_warning ("%s: %s", G_STRFUNC, error);
1801           g_free (error);
1802           g_value_unset (&params[n_params].value);
1803           break;
1804         }
1805       n_params++;
1806       name = va_arg (var_args, gchar*);
1807     }
1808
1809   object = g_object_newv (object_type, n_params, params);
1810
1811   while (n_params--)
1812     g_value_unset (&params[n_params].value);
1813   g_free (params);
1814
1815   g_type_class_unref (class);
1816
1817   return object;
1818 }
1819
1820 static GObject*
1821 g_object_constructor (GType                  type,
1822                       guint                  n_construct_properties,
1823                       GObjectConstructParam *construct_params)
1824 {
1825   GObject *object;
1826
1827   /* create object */
1828   object = (GObject*) g_type_create_instance (type);
1829   
1830   /* set construction parameters */
1831   if (n_construct_properties)
1832     {
1833       GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (object, FALSE);
1834       
1835       /* set construct properties */
1836       while (n_construct_properties--)
1837         {
1838           GValue *value = construct_params->value;
1839           GParamSpec *pspec = construct_params->pspec;
1840
1841           construct_params++;
1842           object_set_property (object, pspec, value, nqueue);
1843         }
1844       g_object_notify_queue_thaw (object, nqueue);
1845       /* the notification queue is still frozen from g_object_init(), so
1846        * we don't need to handle it here, g_object_newv() takes
1847        * care of that
1848        */
1849     }
1850
1851   return object;
1852 }
1853
1854 static void
1855 g_object_constructed (GObject *object)
1856 {
1857   /* empty default impl to allow unconditional upchaining */
1858 }
1859
1860 /**
1861  * g_object_set_valist: (skip)
1862  * @object: a #GObject
1863  * @first_property_name: name of the first property to set
1864  * @var_args: value for the first property, followed optionally by more
1865  *  name/value pairs, followed by %NULL
1866  *
1867  * Sets properties on an object.
1868  */
1869 void
1870 g_object_set_valist (GObject     *object,
1871                      const gchar *first_property_name,
1872                      va_list      var_args)
1873 {
1874   GObjectNotifyQueue *nqueue;
1875   const gchar *name;
1876   
1877   g_return_if_fail (G_IS_OBJECT (object));
1878   
1879   g_object_ref (object);
1880   nqueue = g_object_notify_queue_freeze (object, FALSE);
1881   
1882   name = first_property_name;
1883   while (name)
1884     {
1885       GValue value = G_VALUE_INIT;
1886       GParamSpec *pspec;
1887       gchar *error = NULL;
1888       
1889       pspec = g_param_spec_pool_lookup (pspec_pool,
1890                                         name,
1891                                         G_OBJECT_TYPE (object),
1892                                         TRUE);
1893       if (!pspec)
1894         {
1895           g_warning ("%s: object class `%s' has no property named `%s'",
1896                      G_STRFUNC,
1897                      G_OBJECT_TYPE_NAME (object),
1898                      name);
1899           break;
1900         }
1901       if (!(pspec->flags & G_PARAM_WRITABLE))
1902         {
1903           g_warning ("%s: property `%s' of object class `%s' is not writable",
1904                      G_STRFUNC,
1905                      pspec->name,
1906                      G_OBJECT_TYPE_NAME (object));
1907           break;
1908         }
1909       if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
1910         {
1911           g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
1912                      G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
1913           break;
1914         }
1915
1916       G_VALUE_COLLECT_INIT (&value, pspec->value_type, var_args,
1917                             0, &error);
1918       if (error)
1919         {
1920           g_warning ("%s: %s", G_STRFUNC, error);
1921           g_free (error);
1922           g_value_unset (&value);
1923           break;
1924         }
1925       
1926       object_set_property (object, pspec, &value, nqueue);
1927       g_value_unset (&value);
1928       
1929       name = va_arg (var_args, gchar*);
1930     }
1931
1932   g_object_notify_queue_thaw (object, nqueue);
1933   g_object_unref (object);
1934 }
1935
1936 /**
1937  * g_object_get_valist: (skip)
1938  * @object: a #GObject
1939  * @first_property_name: name of the first property to get
1940  * @var_args: return location for the first property, followed optionally by more
1941  *  name/return location pairs, followed by %NULL
1942  *
1943  * Gets properties of an object.
1944  *
1945  * In general, a copy is made of the property contents and the caller
1946  * is responsible for freeing the memory in the appropriate manner for
1947  * the type, for instance by calling g_free() or g_object_unref().
1948  *
1949  * See g_object_get().
1950  */
1951 void
1952 g_object_get_valist (GObject     *object,
1953                      const gchar *first_property_name,
1954                      va_list      var_args)
1955 {
1956   const gchar *name;
1957   
1958   g_return_if_fail (G_IS_OBJECT (object));
1959   
1960   g_object_ref (object);
1961   
1962   name = first_property_name;
1963   
1964   while (name)
1965     {
1966       GValue value = G_VALUE_INIT;
1967       GParamSpec *pspec;
1968       gchar *error;
1969       
1970       pspec = g_param_spec_pool_lookup (pspec_pool,
1971                                         name,
1972                                         G_OBJECT_TYPE (object),
1973                                         TRUE);
1974       if (!pspec)
1975         {
1976           g_warning ("%s: object class `%s' has no property named `%s'",
1977                      G_STRFUNC,
1978                      G_OBJECT_TYPE_NAME (object),
1979                      name);
1980           break;
1981         }
1982       if (!(pspec->flags & G_PARAM_READABLE))
1983         {
1984           g_warning ("%s: property `%s' of object class `%s' is not readable",
1985                      G_STRFUNC,
1986                      pspec->name,
1987                      G_OBJECT_TYPE_NAME (object));
1988           break;
1989         }
1990       
1991       g_value_init (&value, pspec->value_type);
1992       
1993       object_get_property (object, pspec, &value);
1994       
1995       G_VALUE_LCOPY (&value, var_args, 0, &error);
1996       if (error)
1997         {
1998           g_warning ("%s: %s", G_STRFUNC, error);
1999           g_free (error);
2000           g_value_unset (&value);
2001           break;
2002         }
2003       
2004       g_value_unset (&value);
2005       
2006       name = va_arg (var_args, gchar*);
2007     }
2008   
2009   g_object_unref (object);
2010 }
2011
2012 /**
2013  * g_object_set: (skip)
2014  * @object: a #GObject
2015  * @first_property_name: name of the first property to set
2016  * @...: value for the first property, followed optionally by more
2017  *  name/value pairs, followed by %NULL
2018  *
2019  * Sets properties on an object.
2020  */
2021 void
2022 g_object_set (gpointer     _object,
2023               const gchar *first_property_name,
2024               ...)
2025 {
2026   GObject *object = _object;
2027   va_list var_args;
2028   
2029   g_return_if_fail (G_IS_OBJECT (object));
2030   
2031   va_start (var_args, first_property_name);
2032   g_object_set_valist (object, first_property_name, var_args);
2033   va_end (var_args);
2034 }
2035
2036 /**
2037  * g_object_get: (skip)
2038  * @object: a #GObject
2039  * @first_property_name: name of the first property to get
2040  * @...: return location for the first property, followed optionally by more
2041  *  name/return location pairs, followed by %NULL
2042  *
2043  * Gets properties of an object.
2044  *
2045  * In general, a copy is made of the property contents and the caller
2046  * is responsible for freeing the memory in the appropriate manner for
2047  * the type, for instance by calling g_free() or g_object_unref().
2048  *
2049  * <example>
2050  * <title>Using g_object_get(<!-- -->)</title>
2051  * An example of using g_object_get() to get the contents
2052  * of three properties - one of type #G_TYPE_INT,
2053  * one of type #G_TYPE_STRING, and one of type #G_TYPE_OBJECT:
2054  * <programlisting>
2055  *  gint intval;
2056  *  gchar *strval;
2057  *  GObject *objval;
2058  *
2059  *  g_object_get (my_object,
2060  *                "int-property", &intval,
2061  *                "str-property", &strval,
2062  *                "obj-property", &objval,
2063  *                NULL);
2064  *
2065  *  // Do something with intval, strval, objval
2066  *
2067  *  g_free (strval);
2068  *  g_object_unref (objval);
2069  * </programlisting>
2070  * </example>
2071  */
2072 void
2073 g_object_get (gpointer     _object,
2074               const gchar *first_property_name,
2075               ...)
2076 {
2077   GObject *object = _object;
2078   va_list var_args;
2079   
2080   g_return_if_fail (G_IS_OBJECT (object));
2081   
2082   va_start (var_args, first_property_name);
2083   g_object_get_valist (object, first_property_name, var_args);
2084   va_end (var_args);
2085 }
2086
2087 /**
2088  * g_object_set_property:
2089  * @object: a #GObject
2090  * @property_name: the name of the property to set
2091  * @value: the value
2092  *
2093  * Sets a property on an object.
2094  */
2095 void
2096 g_object_set_property (GObject      *object,
2097                        const gchar  *property_name,
2098                        const GValue *value)
2099 {
2100   GObjectNotifyQueue *nqueue;
2101   GParamSpec *pspec;
2102   
2103   g_return_if_fail (G_IS_OBJECT (object));
2104   g_return_if_fail (property_name != NULL);
2105   g_return_if_fail (G_IS_VALUE (value));
2106   
2107   g_object_ref (object);
2108   nqueue = g_object_notify_queue_freeze (object, FALSE);
2109   
2110   pspec = g_param_spec_pool_lookup (pspec_pool,
2111                                     property_name,
2112                                     G_OBJECT_TYPE (object),
2113                                     TRUE);
2114   if (!pspec)
2115     g_warning ("%s: object class `%s' has no property named `%s'",
2116                G_STRFUNC,
2117                G_OBJECT_TYPE_NAME (object),
2118                property_name);
2119   else if (!(pspec->flags & G_PARAM_WRITABLE))
2120     g_warning ("%s: property `%s' of object class `%s' is not writable",
2121                G_STRFUNC,
2122                pspec->name,
2123                G_OBJECT_TYPE_NAME (object));
2124   else if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction_list (object))
2125     g_warning ("%s: construct property \"%s\" for object `%s' can't be set after construction",
2126                G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
2127   else
2128     object_set_property (object, pspec, value, nqueue);
2129   
2130   g_object_notify_queue_thaw (object, nqueue);
2131   g_object_unref (object);
2132 }
2133
2134 /**
2135  * g_object_get_property:
2136  * @object: a #GObject
2137  * @property_name: the name of the property to get
2138  * @value: return location for the property value
2139  *
2140  * Gets a property of an object. @value must have been initialized to the
2141  * expected type of the property (or a type to which the expected type can be
2142  * transformed) using g_value_init().
2143  *
2144  * In general, a copy is made of the property contents and the caller is
2145  * responsible for freeing the memory by calling g_value_unset().
2146  *
2147  * Note that g_object_get_property() is really intended for language
2148  * bindings, g_object_get() is much more convenient for C programming.
2149  */
2150 void
2151 g_object_get_property (GObject     *object,
2152                        const gchar *property_name,
2153                        GValue      *value)
2154 {
2155   GParamSpec *pspec;
2156   
2157   g_return_if_fail (G_IS_OBJECT (object));
2158   g_return_if_fail (property_name != NULL);
2159   g_return_if_fail (G_IS_VALUE (value));
2160   
2161   g_object_ref (object);
2162   
2163   pspec = g_param_spec_pool_lookup (pspec_pool,
2164                                     property_name,
2165                                     G_OBJECT_TYPE (object),
2166                                     TRUE);
2167   if (!pspec)
2168     g_warning ("%s: object class `%s' has no property named `%s'",
2169                G_STRFUNC,
2170                G_OBJECT_TYPE_NAME (object),
2171                property_name);
2172   else if (!(pspec->flags & G_PARAM_READABLE))
2173     g_warning ("%s: property `%s' of object class `%s' is not readable",
2174                G_STRFUNC,
2175                pspec->name,
2176                G_OBJECT_TYPE_NAME (object));
2177   else
2178     {
2179       GValue *prop_value, tmp_value = G_VALUE_INIT;
2180       
2181       /* auto-conversion of the callers value type
2182        */
2183       if (G_VALUE_TYPE (value) == pspec->value_type)
2184         {
2185           g_value_reset (value);
2186           prop_value = value;
2187         }
2188       else if (!g_value_type_transformable (pspec->value_type, G_VALUE_TYPE (value)))
2189         {
2190           g_warning ("%s: can't retrieve property `%s' of type `%s' as value of type `%s'",
2191                      G_STRFUNC, pspec->name,
2192                      g_type_name (pspec->value_type),
2193                      G_VALUE_TYPE_NAME (value));
2194           g_object_unref (object);
2195           return;
2196         }
2197       else
2198         {
2199           g_value_init (&tmp_value, pspec->value_type);
2200           prop_value = &tmp_value;
2201         }
2202       object_get_property (object, pspec, prop_value);
2203       if (prop_value != value)
2204         {
2205           g_value_transform (prop_value, value);
2206           g_value_unset (&tmp_value);
2207         }
2208     }
2209   
2210   g_object_unref (object);
2211 }
2212
2213 /**
2214  * g_object_connect: (skip)
2215  * @object: a #GObject
2216  * @signal_spec: the spec for the first signal
2217  * @...: #GCallback for the first signal, followed by data for the
2218  *       first signal, followed optionally by more signal
2219  *       spec/callback/data triples, followed by %NULL
2220  *
2221  * A convenience function to connect multiple signals at once.
2222  *
2223  * The signal specs expected by this function have the form
2224  * "modifier::signal_name", where modifier can be one of the following:
2225  * <variablelist>
2226  * <varlistentry>
2227  * <term>signal</term>
2228  * <listitem><para>
2229  * equivalent to <literal>g_signal_connect_data (..., NULL, 0)</literal>
2230  * </para></listitem>
2231  * </varlistentry>
2232  * <varlistentry>
2233  * <term>object_signal</term>
2234  * <term>object-signal</term>
2235  * <listitem><para>
2236  * equivalent to <literal>g_signal_connect_object (..., 0)</literal>
2237  * </para></listitem>
2238  * </varlistentry>
2239  * <varlistentry>
2240  * <term>swapped_signal</term>
2241  * <term>swapped-signal</term>
2242  * <listitem><para>
2243  * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)</literal>
2244  * </para></listitem>
2245  * </varlistentry>
2246  * <varlistentry>
2247  * <term>swapped_object_signal</term>
2248  * <term>swapped-object-signal</term>
2249  * <listitem><para>
2250  * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED)</literal>
2251  * </para></listitem>
2252  * </varlistentry>
2253  * <varlistentry>
2254  * <term>signal_after</term>
2255  * <term>signal-after</term>
2256  * <listitem><para>
2257  * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_AFTER)</literal>
2258  * </para></listitem>
2259  * </varlistentry>
2260  * <varlistentry>
2261  * <term>object_signal_after</term>
2262  * <term>object-signal-after</term>
2263  * <listitem><para>
2264  * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_AFTER)</literal>
2265  * </para></listitem>
2266  * </varlistentry>
2267  * <varlistentry>
2268  * <term>swapped_signal_after</term>
2269  * <term>swapped-signal-after</term>
2270  * <listitem><para>
2271  * equivalent to <literal>g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2272  * </para></listitem>
2273  * </varlistentry>
2274  * <varlistentry>
2275  * <term>swapped_object_signal_after</term>
2276  * <term>swapped-object-signal-after</term>
2277  * <listitem><para>
2278  * equivalent to <literal>g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)</literal>
2279  * </para></listitem>
2280  * </varlistentry>
2281  * </variablelist>
2282  *
2283  * |[
2284  *   menu->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
2285  *                                                 "type", GTK_WINDOW_POPUP,
2286  *                                                 "child", menu,
2287  *                                                 NULL),
2288  *                                   "signal::event", gtk_menu_window_event, menu,
2289  *                                   "signal::size_request", gtk_menu_window_size_request, menu,
2290  *                                   "signal::destroy", gtk_widget_destroyed, &amp;menu-&gt;toplevel,
2291  *                                   NULL);
2292  * ]|
2293  *
2294  * Returns: (transfer none): @object
2295  */
2296 gpointer
2297 g_object_connect (gpointer     _object,
2298                   const gchar *signal_spec,
2299                   ...)
2300 {
2301   GObject *object = _object;
2302   va_list var_args;
2303
2304   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2305   g_return_val_if_fail (object->ref_count > 0, object);
2306
2307   va_start (var_args, signal_spec);
2308   while (signal_spec)
2309     {
2310       GCallback callback = va_arg (var_args, GCallback);
2311       gpointer data = va_arg (var_args, gpointer);
2312
2313       if (strncmp (signal_spec, "signal::", 8) == 0)
2314         g_signal_connect_data (object, signal_spec + 8,
2315                                callback, data, NULL,
2316                                0);
2317       else if (strncmp (signal_spec, "object_signal::", 15) == 0 ||
2318                strncmp (signal_spec, "object-signal::", 15) == 0)
2319         g_signal_connect_object (object, signal_spec + 15,
2320                                  callback, data,
2321                                  0);
2322       else if (strncmp (signal_spec, "swapped_signal::", 16) == 0 ||
2323                strncmp (signal_spec, "swapped-signal::", 16) == 0)
2324         g_signal_connect_data (object, signal_spec + 16,
2325                                callback, data, NULL,
2326                                G_CONNECT_SWAPPED);
2327       else if (strncmp (signal_spec, "swapped_object_signal::", 23) == 0 ||
2328                strncmp (signal_spec, "swapped-object-signal::", 23) == 0)
2329         g_signal_connect_object (object, signal_spec + 23,
2330                                  callback, data,
2331                                  G_CONNECT_SWAPPED);
2332       else if (strncmp (signal_spec, "signal_after::", 14) == 0 ||
2333                strncmp (signal_spec, "signal-after::", 14) == 0)
2334         g_signal_connect_data (object, signal_spec + 14,
2335                                callback, data, NULL,
2336                                G_CONNECT_AFTER);
2337       else if (strncmp (signal_spec, "object_signal_after::", 21) == 0 ||
2338                strncmp (signal_spec, "object-signal-after::", 21) == 0)
2339         g_signal_connect_object (object, signal_spec + 21,
2340                                  callback, data,
2341                                  G_CONNECT_AFTER);
2342       else if (strncmp (signal_spec, "swapped_signal_after::", 22) == 0 ||
2343                strncmp (signal_spec, "swapped-signal-after::", 22) == 0)
2344         g_signal_connect_data (object, signal_spec + 22,
2345                                callback, data, NULL,
2346                                G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2347       else if (strncmp (signal_spec, "swapped_object_signal_after::", 29) == 0 ||
2348                strncmp (signal_spec, "swapped-object-signal-after::", 29) == 0)
2349         g_signal_connect_object (object, signal_spec + 29,
2350                                  callback, data,
2351                                  G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2352       else
2353         {
2354           g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2355           break;
2356         }
2357       signal_spec = va_arg (var_args, gchar*);
2358     }
2359   va_end (var_args);
2360
2361   return object;
2362 }
2363
2364 /**
2365  * g_object_disconnect: (skip)
2366  * @object: a #GObject
2367  * @signal_spec: the spec for the first signal
2368  * @...: #GCallback for the first signal, followed by data for the first signal,
2369  *  followed optionally by more signal spec/callback/data triples,
2370  *  followed by %NULL
2371  *
2372  * A convenience function to disconnect multiple signals at once.
2373  *
2374  * The signal specs expected by this function have the form
2375  * "any_signal", which means to disconnect any signal with matching
2376  * callback and data, or "any_signal::signal_name", which only
2377  * disconnects the signal named "signal_name".
2378  */
2379 void
2380 g_object_disconnect (gpointer     _object,
2381                      const gchar *signal_spec,
2382                      ...)
2383 {
2384   GObject *object = _object;
2385   va_list var_args;
2386
2387   g_return_if_fail (G_IS_OBJECT (object));
2388   g_return_if_fail (object->ref_count > 0);
2389
2390   va_start (var_args, signal_spec);
2391   while (signal_spec)
2392     {
2393       GCallback callback = va_arg (var_args, GCallback);
2394       gpointer data = va_arg (var_args, gpointer);
2395       guint sid = 0, detail = 0, mask = 0;
2396
2397       if (strncmp (signal_spec, "any_signal::", 12) == 0 ||
2398           strncmp (signal_spec, "any-signal::", 12) == 0)
2399         {
2400           signal_spec += 12;
2401           mask = G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2402         }
2403       else if (strcmp (signal_spec, "any_signal") == 0 ||
2404                strcmp (signal_spec, "any-signal") == 0)
2405         {
2406           signal_spec += 10;
2407           mask = G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2408         }
2409       else
2410         {
2411           g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2412           break;
2413         }
2414
2415       if ((mask & G_SIGNAL_MATCH_ID) &&
2416           !g_signal_parse_name (signal_spec, G_OBJECT_TYPE (object), &sid, &detail, FALSE))
2417         g_warning ("%s: invalid signal name \"%s\"", G_STRFUNC, signal_spec);
2418       else if (!g_signal_handlers_disconnect_matched (object, mask | (detail ? G_SIGNAL_MATCH_DETAIL : 0),
2419                                                       sid, detail,
2420                                                       NULL, (gpointer)callback, data))
2421         g_warning ("%s: signal handler %p(%p) is not connected", G_STRFUNC, callback, data);
2422       signal_spec = va_arg (var_args, gchar*);
2423     }
2424   va_end (var_args);
2425 }
2426
2427 typedef struct {
2428   GObject *object;
2429   guint n_weak_refs;
2430   struct {
2431     GWeakNotify notify;
2432     gpointer    data;
2433   } weak_refs[1];  /* flexible array */
2434 } WeakRefStack;
2435
2436 static void
2437 weak_refs_notify (gpointer data)
2438 {
2439   WeakRefStack *wstack = data;
2440   guint i;
2441
2442   for (i = 0; i < wstack->n_weak_refs; i++)
2443     wstack->weak_refs[i].notify (wstack->weak_refs[i].data, wstack->object);
2444   g_free (wstack);
2445 }
2446
2447 /**
2448  * g_object_weak_ref: (skip)
2449  * @object: #GObject to reference weakly
2450  * @notify: callback to invoke before the object is freed
2451  * @data: extra data to pass to notify
2452  *
2453  * Adds a weak reference callback to an object. Weak references are
2454  * used for notification when an object is finalized. They are called
2455  * "weak references" because they allow you to safely hold a pointer
2456  * to an object without calling g_object_ref() (g_object_ref() adds a
2457  * strong reference, that is, forces the object to stay alive).
2458  */
2459 void
2460 g_object_weak_ref (GObject    *object,
2461                    GWeakNotify notify,
2462                    gpointer    data)
2463 {
2464   WeakRefStack *wstack;
2465   guint i;
2466   
2467   g_return_if_fail (G_IS_OBJECT (object));
2468   g_return_if_fail (notify != NULL);
2469   g_return_if_fail (object->ref_count >= 1);
2470
2471   G_LOCK (weak_refs_mutex);
2472   wstack = g_datalist_id_remove_no_notify (&object->qdata, quark_weak_refs);
2473   if (wstack)
2474     {
2475       i = wstack->n_weak_refs++;
2476       wstack = g_realloc (wstack, sizeof (*wstack) + sizeof (wstack->weak_refs[0]) * i);
2477     }
2478   else
2479     {
2480       wstack = g_renew (WeakRefStack, NULL, 1);
2481       wstack->object = object;
2482       wstack->n_weak_refs = 1;
2483       i = 0;
2484     }
2485   wstack->weak_refs[i].notify = notify;
2486   wstack->weak_refs[i].data = data;
2487   g_datalist_id_set_data_full (&object->qdata, quark_weak_refs, wstack, weak_refs_notify);
2488   G_UNLOCK (weak_refs_mutex);
2489 }
2490
2491 /**
2492  * g_object_weak_unref: (skip)
2493  * @object: #GObject to remove a weak reference from
2494  * @notify: callback to search for
2495  * @data: data to search for
2496  *
2497  * Removes a weak reference callback to an object.
2498  */
2499 void
2500 g_object_weak_unref (GObject    *object,
2501                      GWeakNotify notify,
2502                      gpointer    data)
2503 {
2504   WeakRefStack *wstack;
2505   gboolean found_one = FALSE;
2506
2507   g_return_if_fail (G_IS_OBJECT (object));
2508   g_return_if_fail (notify != NULL);
2509
2510   G_LOCK (weak_refs_mutex);
2511   wstack = g_datalist_id_get_data (&object->qdata, quark_weak_refs);
2512   if (wstack)
2513     {
2514       guint i;
2515
2516       for (i = 0; i < wstack->n_weak_refs; i++)
2517         if (wstack->weak_refs[i].notify == notify &&
2518             wstack->weak_refs[i].data == data)
2519           {
2520             found_one = TRUE;
2521             wstack->n_weak_refs -= 1;
2522             if (i != wstack->n_weak_refs)
2523               wstack->weak_refs[i] = wstack->weak_refs[wstack->n_weak_refs];
2524
2525             break;
2526           }
2527     }
2528   G_UNLOCK (weak_refs_mutex);
2529   if (!found_one)
2530     g_warning ("%s: couldn't find weak ref %p(%p)", G_STRFUNC, notify, data);
2531 }
2532
2533 /**
2534  * g_object_add_weak_pointer: (skip)
2535  * @object: The object that should be weak referenced.
2536  * @weak_pointer_location: (inout): The memory address of a pointer.
2537  *
2538  * Adds a weak reference from weak_pointer to @object to indicate that
2539  * the pointer located at @weak_pointer_location is only valid during
2540  * the lifetime of @object. When the @object is finalized,
2541  * @weak_pointer will be set to %NULL.
2542  */
2543 void
2544 g_object_add_weak_pointer (GObject  *object, 
2545                            gpointer *weak_pointer_location)
2546 {
2547   g_return_if_fail (G_IS_OBJECT (object));
2548   g_return_if_fail (weak_pointer_location != NULL);
2549
2550   g_object_weak_ref (object, 
2551                      (GWeakNotify) g_nullify_pointer, 
2552                      weak_pointer_location);
2553 }
2554
2555 /**
2556  * g_object_remove_weak_pointer: (skip)
2557  * @object: The object that is weak referenced.
2558  * @weak_pointer_location: (inout): The memory address of a pointer.
2559  *
2560  * Removes a weak reference from @object that was previously added
2561  * using g_object_add_weak_pointer(). The @weak_pointer_location has
2562  * to match the one used with g_object_add_weak_pointer().
2563  */
2564 void
2565 g_object_remove_weak_pointer (GObject  *object, 
2566                               gpointer *weak_pointer_location)
2567 {
2568   g_return_if_fail (G_IS_OBJECT (object));
2569   g_return_if_fail (weak_pointer_location != NULL);
2570
2571   g_object_weak_unref (object, 
2572                        (GWeakNotify) g_nullify_pointer, 
2573                        weak_pointer_location);
2574 }
2575
2576 static guint
2577 object_floating_flag_handler (GObject        *object,
2578                               gint            job)
2579 {
2580   switch (job)
2581     {
2582       gpointer oldvalue;
2583     case +1:    /* force floating if possible */
2584       do
2585         oldvalue = g_atomic_pointer_get (&object->qdata);
2586       while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2587                                                      (gpointer) ((gsize) oldvalue | OBJECT_FLOATING_FLAG)));
2588       return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2589     case -1:    /* sink if possible */
2590       do
2591         oldvalue = g_atomic_pointer_get (&object->qdata);
2592       while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2593                                                      (gpointer) ((gsize) oldvalue & ~(gsize) OBJECT_FLOATING_FLAG)));
2594       return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2595     default:    /* check floating */
2596       return 0 != ((gsize) g_atomic_pointer_get (&object->qdata) & OBJECT_FLOATING_FLAG);
2597     }
2598 }
2599
2600 /**
2601  * g_object_is_floating:
2602  * @object: (type GObject.Object): a #GObject
2603  *
2604  * Checks whether @object has a <link linkend="floating-ref">floating</link>
2605  * reference.
2606  *
2607  * Since: 2.10
2608  *
2609  * Returns: %TRUE if @object has a floating reference
2610  */
2611 gboolean
2612 g_object_is_floating (gpointer _object)
2613 {
2614   GObject *object = _object;
2615   g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
2616   return floating_flag_handler (object, 0);
2617 }
2618
2619 /**
2620  * g_object_ref_sink:
2621  * @object: (type GObject.Object): a #GObject
2622  *
2623  * Increase the reference count of @object, and possibly remove the
2624  * <link linkend="floating-ref">floating</link> reference, if @object
2625  * has a floating reference.
2626  *
2627  * In other words, if the object is floating, then this call "assumes
2628  * ownership" of the floating reference, converting it to a normal
2629  * reference by clearing the floating flag while leaving the reference
2630  * count unchanged.  If the object is not floating, then this call
2631  * adds a new normal reference increasing the reference count by one.
2632  *
2633  * Since: 2.10
2634  *
2635  * Returns: (type GObject.Object) (transfer none): @object
2636  */
2637 gpointer
2638 g_object_ref_sink (gpointer _object)
2639 {
2640   GObject *object = _object;
2641   gboolean was_floating;
2642   g_return_val_if_fail (G_IS_OBJECT (object), object);
2643   g_return_val_if_fail (object->ref_count >= 1, object);
2644   g_object_ref (object);
2645   was_floating = floating_flag_handler (object, -1);
2646   if (was_floating)
2647     g_object_unref (object);
2648   return object;
2649 }
2650
2651 /**
2652  * g_object_force_floating:
2653  * @object: a #GObject
2654  *
2655  * This function is intended for #GObject implementations to re-enforce a
2656  * <link linkend="floating-ref">floating</link> object reference.
2657  * Doing this is seldom required: all
2658  * #GInitiallyUnowned<!-- -->s are created with a floating reference which
2659  * usually just needs to be sunken by calling g_object_ref_sink().
2660  *
2661  * Since: 2.10
2662  */
2663 void
2664 g_object_force_floating (GObject *object)
2665 {
2666   g_return_if_fail (G_IS_OBJECT (object));
2667   g_return_if_fail (object->ref_count >= 1);
2668
2669   floating_flag_handler (object, +1);
2670 }
2671
2672 typedef struct {
2673   GObject *object;
2674   guint n_toggle_refs;
2675   struct {
2676     GToggleNotify notify;
2677     gpointer    data;
2678   } toggle_refs[1];  /* flexible array */
2679 } ToggleRefStack;
2680
2681 static void
2682 toggle_refs_notify (GObject *object,
2683                     gboolean is_last_ref)
2684 {
2685   ToggleRefStack tstack, *tstackptr;
2686
2687   G_LOCK (toggle_refs_mutex);
2688   tstackptr = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2689   tstack = *tstackptr;
2690   G_UNLOCK (toggle_refs_mutex);
2691
2692   /* Reentrancy here is not as tricky as it seems, because a toggle reference
2693    * will only be notified when there is exactly one of them.
2694    */
2695   g_assert (tstack.n_toggle_refs == 1);
2696   tstack.toggle_refs[0].notify (tstack.toggle_refs[0].data, tstack.object, is_last_ref);
2697 }
2698
2699 /**
2700  * g_object_add_toggle_ref: (skip)
2701  * @object: a #GObject
2702  * @notify: a function to call when this reference is the
2703  *  last reference to the object, or is no longer
2704  *  the last reference.
2705  * @data: data to pass to @notify
2706  *
2707  * Increases the reference count of the object by one and sets a
2708  * callback to be called when all other references to the object are
2709  * dropped, or when this is already the last reference to the object
2710  * and another reference is established.
2711  *
2712  * This functionality is intended for binding @object to a proxy
2713  * object managed by another memory manager. This is done with two
2714  * paired references: the strong reference added by
2715  * g_object_add_toggle_ref() and a reverse reference to the proxy
2716  * object which is either a strong reference or weak reference.
2717  *
2718  * The setup is that when there are no other references to @object,
2719  * only a weak reference is held in the reverse direction from @object
2720  * to the proxy object, but when there are other references held to
2721  * @object, a strong reference is held. The @notify callback is called
2722  * when the reference from @object to the proxy object should be
2723  * <firstterm>toggled</firstterm> from strong to weak (@is_last_ref
2724  * true) or weak to strong (@is_last_ref false).
2725  *
2726  * Since a (normal) reference must be held to the object before
2727  * calling g_object_add_toggle_ref(), the initial state of the reverse
2728  * link is always strong.
2729  *
2730  * Multiple toggle references may be added to the same gobject,
2731  * however if there are multiple toggle references to an object, none
2732  * of them will ever be notified until all but one are removed.  For
2733  * this reason, you should only ever use a toggle reference if there
2734  * is important state in the proxy object.
2735  *
2736  * Since: 2.8
2737  */
2738 void
2739 g_object_add_toggle_ref (GObject       *object,
2740                          GToggleNotify  notify,
2741                          gpointer       data)
2742 {
2743   ToggleRefStack *tstack;
2744   guint i;
2745   
2746   g_return_if_fail (G_IS_OBJECT (object));
2747   g_return_if_fail (notify != NULL);
2748   g_return_if_fail (object->ref_count >= 1);
2749
2750   g_object_ref (object);
2751
2752   G_LOCK (toggle_refs_mutex);
2753   tstack = g_datalist_id_remove_no_notify (&object->qdata, quark_toggle_refs);
2754   if (tstack)
2755     {
2756       i = tstack->n_toggle_refs++;
2757       /* allocate i = tstate->n_toggle_refs - 1 positions beyond the 1 declared
2758        * in tstate->toggle_refs */
2759       tstack = g_realloc (tstack, sizeof (*tstack) + sizeof (tstack->toggle_refs[0]) * i);
2760     }
2761   else
2762     {
2763       tstack = g_renew (ToggleRefStack, NULL, 1);
2764       tstack->object = object;
2765       tstack->n_toggle_refs = 1;
2766       i = 0;
2767     }
2768
2769   /* Set a flag for fast lookup after adding the first toggle reference */
2770   if (tstack->n_toggle_refs == 1)
2771     g_datalist_set_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2772   
2773   tstack->toggle_refs[i].notify = notify;
2774   tstack->toggle_refs[i].data = data;
2775   g_datalist_id_set_data_full (&object->qdata, quark_toggle_refs, tstack,
2776                                (GDestroyNotify)g_free);
2777   G_UNLOCK (toggle_refs_mutex);
2778 }
2779
2780 /**
2781  * g_object_remove_toggle_ref: (skip)
2782  * @object: a #GObject
2783  * @notify: a function to call when this reference is the
2784  *  last reference to the object, or is no longer
2785  *  the last reference.
2786  * @data: data to pass to @notify
2787  *
2788  * Removes a reference added with g_object_add_toggle_ref(). The
2789  * reference count of the object is decreased by one.
2790  *
2791  * Since: 2.8
2792  */
2793 void
2794 g_object_remove_toggle_ref (GObject       *object,
2795                             GToggleNotify  notify,
2796                             gpointer       data)
2797 {
2798   ToggleRefStack *tstack;
2799   gboolean found_one = FALSE;
2800
2801   g_return_if_fail (G_IS_OBJECT (object));
2802   g_return_if_fail (notify != NULL);
2803
2804   G_LOCK (toggle_refs_mutex);
2805   tstack = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2806   if (tstack)
2807     {
2808       guint i;
2809
2810       for (i = 0; i < tstack->n_toggle_refs; i++)
2811         if (tstack->toggle_refs[i].notify == notify &&
2812             tstack->toggle_refs[i].data == data)
2813           {
2814             found_one = TRUE;
2815             tstack->n_toggle_refs -= 1;
2816             if (i != tstack->n_toggle_refs)
2817               tstack->toggle_refs[i] = tstack->toggle_refs[tstack->n_toggle_refs];
2818
2819             if (tstack->n_toggle_refs == 0)
2820               g_datalist_unset_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2821
2822             break;
2823           }
2824     }
2825   G_UNLOCK (toggle_refs_mutex);
2826
2827   if (found_one)
2828     g_object_unref (object);
2829   else
2830     g_warning ("%s: couldn't find toggle ref %p(%p)", G_STRFUNC, notify, data);
2831 }
2832
2833 /**
2834  * g_object_ref:
2835  * @object: (type GObject.Object): a #GObject
2836  *
2837  * Increases the reference count of @object.
2838  *
2839  * Returns: (type GObject.Object) (transfer none): the same @object
2840  */
2841 gpointer
2842 g_object_ref (gpointer _object)
2843 {
2844   GObject *object = _object;
2845   gint old_val;
2846
2847   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2848   g_return_val_if_fail (object->ref_count > 0, NULL);
2849   
2850 #ifdef  G_ENABLE_DEBUG
2851   if (g_trap_object_ref == object)
2852     G_BREAKPOINT ();
2853 #endif  /* G_ENABLE_DEBUG */
2854
2855
2856   old_val = g_atomic_int_add (&object->ref_count, 1);
2857
2858   if (old_val == 1 && OBJECT_HAS_TOGGLE_REF (object))
2859     toggle_refs_notify (object, FALSE);
2860
2861   TRACE (GOBJECT_OBJECT_REF(object,G_TYPE_FROM_INSTANCE(object),old_val));
2862
2863   return object;
2864 }
2865
2866 /**
2867  * g_object_unref:
2868  * @object: (type GObject.Object): a #GObject
2869  *
2870  * Decreases the reference count of @object. When its reference count
2871  * drops to 0, the object is finalized (i.e. its memory is freed).
2872  */
2873 void
2874 g_object_unref (gpointer _object)
2875 {
2876   GObject *object = _object;
2877   gint old_ref;
2878   
2879   g_return_if_fail (G_IS_OBJECT (object));
2880   g_return_if_fail (object->ref_count > 0);
2881   
2882 #ifdef  G_ENABLE_DEBUG
2883   if (g_trap_object_ref == object)
2884     G_BREAKPOINT ();
2885 #endif  /* G_ENABLE_DEBUG */
2886
2887   /* here we want to atomically do: if (ref_count>1) { ref_count--; return; } */
2888  retry_atomic_decrement1:
2889   old_ref = g_atomic_int_get (&object->ref_count);
2890   if (old_ref > 1)
2891     {
2892       /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2893       gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2894
2895       if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2896         goto retry_atomic_decrement1;
2897
2898       TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2899
2900       /* if we went from 2->1 we need to notify toggle refs if any */
2901       if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2902         toggle_refs_notify (object, TRUE);
2903     }
2904   else
2905     {
2906       /* we are about tp remove the last reference */
2907       TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 1));
2908       G_OBJECT_GET_CLASS (object)->dispose (object);
2909       TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 1));
2910
2911       /* may have been re-referenced meanwhile */
2912     retry_atomic_decrement2:
2913       old_ref = g_atomic_int_get ((int *)&object->ref_count);
2914       if (old_ref > 1)
2915         {
2916           /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
2917           gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
2918
2919           if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
2920             goto retry_atomic_decrement2;
2921
2922           TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2923
2924           /* if we went from 2->1 we need to notify toggle refs if any */
2925           if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
2926             toggle_refs_notify (object, TRUE);
2927
2928           return;
2929         }
2930
2931       /* we are still in the process of taking away the last ref */
2932       g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
2933       g_signal_handlers_destroy (object);
2934       g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
2935       
2936       /* decrement the last reference */
2937       old_ref = g_atomic_int_add (&object->ref_count, -1);
2938
2939       TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
2940
2941       /* may have been re-referenced meanwhile */
2942       if (G_LIKELY (old_ref == 1))
2943         {
2944           TRACE (GOBJECT_OBJECT_FINALIZE(object,G_TYPE_FROM_INSTANCE(object)));
2945           G_OBJECT_GET_CLASS (object)->finalize (object);
2946
2947           TRACE (GOBJECT_OBJECT_FINALIZE_END(object,G_TYPE_FROM_INSTANCE(object)));
2948
2949 #ifdef  G_ENABLE_DEBUG
2950           IF_DEBUG (OBJECTS)
2951             {
2952               /* catch objects not chaining finalize handlers */
2953               G_LOCK (debug_objects);
2954               g_assert (g_hash_table_lookup (debug_objects_ht, object) == NULL);
2955               G_UNLOCK (debug_objects);
2956             }
2957 #endif  /* G_ENABLE_DEBUG */
2958           g_type_free_instance ((GTypeInstance*) object);
2959         }
2960     }
2961 }
2962
2963 /**
2964  * g_clear_object: (skip)
2965  * @object_ptr: a pointer to a #GObject reference
2966  *
2967  * Clears a reference to a #GObject.
2968  *
2969  * @object_ptr must not be %NULL.
2970  *
2971  * If the reference is %NULL then this function does nothing.
2972  * Otherwise, the reference count of the object is decreased and the
2973  * pointer is set to %NULL.
2974  *
2975  * This function is threadsafe and modifies the pointer atomically,
2976  * using memory barriers where needed.
2977  *
2978  * A macro is also included that allows this function to be used without
2979  * pointer casts.
2980  *
2981  * Since: 2.28
2982  **/
2983 #undef g_clear_object
2984 void
2985 g_clear_object (volatile GObject **object_ptr)
2986 {
2987   gpointer *ptr = (gpointer) object_ptr;
2988   gpointer old;
2989
2990   /* This is a little frustrating.
2991    * Would be nice to have an atomic exchange (with no compare).
2992    */
2993   do
2994     old = g_atomic_pointer_get (ptr);
2995   while G_UNLIKELY (!g_atomic_pointer_compare_and_exchange (ptr, old, NULL));
2996
2997   if (old)
2998     g_object_unref (old);
2999 }
3000
3001 /**
3002  * g_object_get_qdata:
3003  * @object: The GObject to get a stored user data pointer from
3004  * @quark: A #GQuark, naming the user data pointer
3005  * 
3006  * This function gets back user data pointers stored via
3007  * g_object_set_qdata().
3008  * 
3009  * Returns: (transfer none): The user data pointer set, or %NULL
3010  */
3011 gpointer
3012 g_object_get_qdata (GObject *object,
3013                     GQuark   quark)
3014 {
3015   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3016   
3017   return quark ? g_datalist_id_get_data (&object->qdata, quark) : NULL;
3018 }
3019
3020 /**
3021  * g_object_set_qdata: (skip)
3022  * @object: The GObject to set store a user data pointer
3023  * @quark: A #GQuark, naming the user data pointer
3024  * @data: An opaque user data pointer
3025  *
3026  * This sets an opaque, named pointer on an object.
3027  * The name is specified through a #GQuark (retrived e.g. via
3028  * g_quark_from_static_string()), and the pointer
3029  * can be gotten back from the @object with g_object_get_qdata()
3030  * until the @object is finalized.
3031  * Setting a previously set user data pointer, overrides (frees)
3032  * the old pointer set, using #NULL as pointer essentially
3033  * removes the data stored.
3034  */
3035 void
3036 g_object_set_qdata (GObject *object,
3037                     GQuark   quark,
3038                     gpointer data)
3039 {
3040   g_return_if_fail (G_IS_OBJECT (object));
3041   g_return_if_fail (quark > 0);
3042   
3043   g_datalist_id_set_data (&object->qdata, quark, data);
3044 }
3045
3046 /**
3047  * g_object_set_qdata_full: (skip)
3048  * @object: The GObject to set store a user data pointer
3049  * @quark: A #GQuark, naming the user data pointer
3050  * @data: An opaque user data pointer
3051  * @destroy: Function to invoke with @data as argument, when @data
3052  *           needs to be freed
3053  *
3054  * This function works like g_object_set_qdata(), but in addition,
3055  * a void (*destroy) (gpointer) function may be specified which is
3056  * called with @data as argument when the @object is finalized, or
3057  * the data is being overwritten by a call to g_object_set_qdata()
3058  * with the same @quark.
3059  */
3060 void
3061 g_object_set_qdata_full (GObject       *object,
3062                          GQuark         quark,
3063                          gpointer       data,
3064                          GDestroyNotify destroy)
3065 {
3066   g_return_if_fail (G_IS_OBJECT (object));
3067   g_return_if_fail (quark > 0);
3068   
3069   g_datalist_id_set_data_full (&object->qdata, quark, data,
3070                                data ? destroy : (GDestroyNotify) NULL);
3071 }
3072
3073 /**
3074  * g_object_steal_qdata:
3075  * @object: The GObject to get a stored user data pointer from
3076  * @quark: A #GQuark, naming the user data pointer
3077  *
3078  * This function gets back user data pointers stored via
3079  * g_object_set_qdata() and removes the @data from object
3080  * without invoking its destroy() function (if any was
3081  * set).
3082  * Usually, calling this function is only required to update
3083  * user data pointers with a destroy notifier, for example:
3084  * |[
3085  * void
3086  * object_add_to_user_list (GObject     *object,
3087  *                          const gchar *new_string)
3088  * {
3089  *   // the quark, naming the object data
3090  *   GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
3091  *   // retrive the old string list
3092  *   GList *list = g_object_steal_qdata (object, quark_string_list);
3093  *
3094  *   // prepend new string
3095  *   list = g_list_prepend (list, g_strdup (new_string));
3096  *   // this changed 'list', so we need to set it again
3097  *   g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
3098  * }
3099  * static void
3100  * free_string_list (gpointer data)
3101  * {
3102  *   GList *node, *list = data;
3103  *
3104  *   for (node = list; node; node = node->next)
3105  *     g_free (node->data);
3106  *   g_list_free (list);
3107  * }
3108  * ]|
3109  * Using g_object_get_qdata() in the above example, instead of
3110  * g_object_steal_qdata() would have left the destroy function set,
3111  * and thus the partial string list would have been freed upon
3112  * g_object_set_qdata_full().
3113  *
3114  * Returns: (transfer full): The user data pointer set, or %NULL
3115  */
3116 gpointer
3117 g_object_steal_qdata (GObject *object,
3118                       GQuark   quark)
3119 {
3120   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3121   g_return_val_if_fail (quark > 0, NULL);
3122   
3123   return g_datalist_id_remove_no_notify (&object->qdata, quark);
3124 }
3125
3126 /**
3127  * g_object_get_data:
3128  * @object: #GObject containing the associations
3129  * @key: name of the key for that association
3130  * 
3131  * Gets a named field from the objects table of associations (see g_object_set_data()).
3132  * 
3133  * Returns: (transfer none): the data if found, or %NULL if no such data exists.
3134  */
3135 gpointer
3136 g_object_get_data (GObject     *object,
3137                    const gchar *key)
3138 {
3139   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3140   g_return_val_if_fail (key != NULL, NULL);
3141
3142   return g_datalist_get_data (&object->qdata, key);
3143 }
3144
3145 /**
3146  * g_object_set_data:
3147  * @object: #GObject containing the associations.
3148  * @key: name of the key
3149  * @data: data to associate with that key
3150  *
3151  * Each object carries around a table of associations from
3152  * strings to pointers.  This function lets you set an association.
3153  *
3154  * If the object already had an association with that name,
3155  * the old association will be destroyed.
3156  */
3157 void
3158 g_object_set_data (GObject     *object,
3159                    const gchar *key,
3160                    gpointer     data)
3161 {
3162   g_return_if_fail (G_IS_OBJECT (object));
3163   g_return_if_fail (key != NULL);
3164
3165   g_datalist_id_set_data (&object->qdata, g_quark_from_string (key), data);
3166 }
3167
3168 /**
3169  * g_object_set_data_full: (skip)
3170  * @object: #GObject containing the associations
3171  * @key: name of the key
3172  * @data: data to associate with that key
3173  * @destroy: function to call when the association is destroyed
3174  *
3175  * Like g_object_set_data() except it adds notification
3176  * for when the association is destroyed, either by setting it
3177  * to a different value or when the object is destroyed.
3178  *
3179  * Note that the @destroy callback is not called if @data is %NULL.
3180  */
3181 void
3182 g_object_set_data_full (GObject       *object,
3183                         const gchar   *key,
3184                         gpointer       data,
3185                         GDestroyNotify destroy)
3186 {
3187   g_return_if_fail (G_IS_OBJECT (object));
3188   g_return_if_fail (key != NULL);
3189
3190   g_datalist_id_set_data_full (&object->qdata, g_quark_from_string (key), data,
3191                                data ? destroy : (GDestroyNotify) NULL);
3192 }
3193
3194 /**
3195  * g_object_steal_data:
3196  * @object: #GObject containing the associations
3197  * @key: name of the key
3198  *
3199  * Remove a specified datum from the object's data associations,
3200  * without invoking the association's destroy handler.
3201  *
3202  * Returns: (transfer full): the data if found, or %NULL if no such data exists.
3203  */
3204 gpointer
3205 g_object_steal_data (GObject     *object,
3206                      const gchar *key)
3207 {
3208   GQuark quark;
3209
3210   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3211   g_return_val_if_fail (key != NULL, NULL);
3212
3213   quark = g_quark_try_string (key);
3214
3215   return quark ? g_datalist_id_remove_no_notify (&object->qdata, quark) : NULL;
3216 }
3217
3218 static void
3219 g_value_object_init (GValue *value)
3220 {
3221   value->data[0].v_pointer = NULL;
3222 }
3223
3224 static void
3225 g_value_object_free_value (GValue *value)
3226 {
3227   if (value->data[0].v_pointer)
3228     g_object_unref (value->data[0].v_pointer);
3229 }
3230
3231 static void
3232 g_value_object_copy_value (const GValue *src_value,
3233                            GValue       *dest_value)
3234 {
3235   if (src_value->data[0].v_pointer)
3236     dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3237   else
3238     dest_value->data[0].v_pointer = NULL;
3239 }
3240
3241 static void
3242 g_value_object_transform_value (const GValue *src_value,
3243                                 GValue       *dest_value)
3244 {
3245   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)))
3246     dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3247   else
3248     dest_value->data[0].v_pointer = NULL;
3249 }
3250
3251 static gpointer
3252 g_value_object_peek_pointer (const GValue *value)
3253 {
3254   return value->data[0].v_pointer;
3255 }
3256
3257 static gchar*
3258 g_value_object_collect_value (GValue      *value,
3259                               guint        n_collect_values,
3260                               GTypeCValue *collect_values,
3261                               guint        collect_flags)
3262 {
3263   if (collect_values[0].v_pointer)
3264     {
3265       GObject *object = collect_values[0].v_pointer;
3266       
3267       if (object->g_type_instance.g_class == NULL)
3268         return g_strconcat ("invalid unclassed object pointer for value type `",
3269                             G_VALUE_TYPE_NAME (value),
3270                             "'",
3271                             NULL);
3272       else if (!g_value_type_compatible (G_OBJECT_TYPE (object), G_VALUE_TYPE (value)))
3273         return g_strconcat ("invalid object type `",
3274                             G_OBJECT_TYPE_NAME (object),
3275                             "' for value type `",
3276                             G_VALUE_TYPE_NAME (value),
3277                             "'",
3278                             NULL);
3279       /* never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types */
3280       value->data[0].v_pointer = g_object_ref (object);
3281     }
3282   else
3283     value->data[0].v_pointer = NULL;
3284   
3285   return NULL;
3286 }
3287
3288 static gchar*
3289 g_value_object_lcopy_value (const GValue *value,
3290                             guint        n_collect_values,
3291                             GTypeCValue *collect_values,
3292                             guint        collect_flags)
3293 {
3294   GObject **object_p = collect_values[0].v_pointer;
3295   
3296   if (!object_p)
3297     return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
3298
3299   if (!value->data[0].v_pointer)
3300     *object_p = NULL;
3301   else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
3302     *object_p = value->data[0].v_pointer;
3303   else
3304     *object_p = g_object_ref (value->data[0].v_pointer);
3305   
3306   return NULL;
3307 }
3308
3309 /**
3310  * g_value_set_object:
3311  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3312  * @v_object: (type GObject.Object) (allow-none): object value to be set
3313  *
3314  * Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
3315  *
3316  * g_value_set_object() increases the reference count of @v_object
3317  * (the #GValue holds a reference to @v_object).  If you do not wish
3318  * to increase the reference count of the object (i.e. you wish to
3319  * pass your current reference to the #GValue because you no longer
3320  * need it), use g_value_take_object() instead.
3321  *
3322  * It is important that your #GValue holds a reference to @v_object (either its
3323  * own, or one it has taken) to ensure that the object won't be destroyed while
3324  * the #GValue still exists).
3325  */
3326 void
3327 g_value_set_object (GValue   *value,
3328                     gpointer  v_object)
3329 {
3330   GObject *old;
3331         
3332   g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3333
3334   old = value->data[0].v_pointer;
3335   
3336   if (v_object)
3337     {
3338       g_return_if_fail (G_IS_OBJECT (v_object));
3339       g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3340
3341       value->data[0].v_pointer = v_object;
3342       g_object_ref (value->data[0].v_pointer);
3343     }
3344   else
3345     value->data[0].v_pointer = NULL;
3346   
3347   if (old)
3348     g_object_unref (old);
3349 }
3350
3351 /**
3352  * g_value_set_object_take_ownership: (skip)
3353  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3354  * @v_object: (allow-none): object value to be set
3355  *
3356  * This is an internal function introduced mainly for C marshallers.
3357  *
3358  * Deprecated: 2.4: Use g_value_take_object() instead.
3359  */
3360 void
3361 g_value_set_object_take_ownership (GValue  *value,
3362                                    gpointer v_object)
3363 {
3364   g_value_take_object (value, v_object);
3365 }
3366
3367 /**
3368  * g_value_take_object: (skip)
3369  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3370  * @v_object: (allow-none): object value to be set
3371  *
3372  * Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
3373  * and takes over the ownership of the callers reference to @v_object;
3374  * the caller doesn't have to unref it any more (i.e. the reference
3375  * count of the object is not increased).
3376  *
3377  * If you want the #GValue to hold its own reference to @v_object, use
3378  * g_value_set_object() instead.
3379  *
3380  * Since: 2.4
3381  */
3382 void
3383 g_value_take_object (GValue  *value,
3384                      gpointer v_object)
3385 {
3386   g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3387
3388   if (value->data[0].v_pointer)
3389     {
3390       g_object_unref (value->data[0].v_pointer);
3391       value->data[0].v_pointer = NULL;
3392     }
3393
3394   if (v_object)
3395     {
3396       g_return_if_fail (G_IS_OBJECT (v_object));
3397       g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3398
3399       value->data[0].v_pointer = v_object; /* we take over the reference count */
3400     }
3401 }
3402
3403 /**
3404  * g_value_get_object:
3405  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3406  * 
3407  * Get the contents of a %G_TYPE_OBJECT derived #GValue.
3408  * 
3409  * Returns: (type GObject.Object) (transfer none): object contents of @value
3410  */
3411 gpointer
3412 g_value_get_object (const GValue *value)
3413 {
3414   g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3415   
3416   return value->data[0].v_pointer;
3417 }
3418
3419 /**
3420  * g_value_dup_object:
3421  * @value: a valid #GValue whose type is derived from %G_TYPE_OBJECT
3422  *
3423  * Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing
3424  * its reference count. If the contents of the #GValue are %NULL, then
3425  * %NULL will be returned.
3426  *
3427  * Returns: (type GObject.Object) (transfer full): object content of @value,
3428  *          should be unreferenced when no longer needed.
3429  */
3430 gpointer
3431 g_value_dup_object (const GValue *value)
3432 {
3433   g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3434   
3435   return value->data[0].v_pointer ? g_object_ref (value->data[0].v_pointer) : NULL;
3436 }
3437
3438 /**
3439  * g_signal_connect_object: (skip)
3440  * @instance: the instance to connect to.
3441  * @detailed_signal: a string of the form "signal-name::detail".
3442  * @c_handler: the #GCallback to connect.
3443  * @gobject: the object to pass as data to @c_handler.
3444  * @connect_flags: a combination of #GConnectFlags.
3445  *
3446  * This is similar to g_signal_connect_data(), but uses a closure which
3447  * ensures that the @gobject stays alive during the call to @c_handler
3448  * by temporarily adding a reference count to @gobject.
3449  *
3450  * Note that there is a bug in GObject that makes this function
3451  * much less useful than it might seem otherwise. Once @gobject is
3452  * disposed, the callback will no longer be called, but, the signal
3453  * handler is <emphasis>not</emphasis> currently disconnected. If the
3454  * @instance is itself being freed at the same time than this doesn't
3455  * matter, since the signal will automatically be removed, but
3456  * if @instance persists, then the signal handler will leak. You
3457  * should not remove the signal yourself because in a future versions of
3458  * GObject, the handler <emphasis>will</emphasis> automatically
3459  * be disconnected.
3460  *
3461  * It's possible to work around this problem in a way that will
3462  * continue to work with future versions of GObject by checking
3463  * that the signal handler is still connected before disconnected it:
3464  * <informalexample><programlisting>
3465  *  if (g_signal_handler_is_connected (instance, id))
3466  *    g_signal_handler_disconnect (instance, id);
3467  * </programlisting></informalexample>
3468  *
3469  * Returns: the handler id.
3470  */
3471 gulong
3472 g_signal_connect_object (gpointer      instance,
3473                          const gchar  *detailed_signal,
3474                          GCallback     c_handler,
3475                          gpointer      gobject,
3476                          GConnectFlags connect_flags)
3477 {
3478   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
3479   g_return_val_if_fail (detailed_signal != NULL, 0);
3480   g_return_val_if_fail (c_handler != NULL, 0);
3481
3482   if (gobject)
3483     {
3484       GClosure *closure;
3485
3486       g_return_val_if_fail (G_IS_OBJECT (gobject), 0);
3487
3488       closure = ((connect_flags & G_CONNECT_SWAPPED) ? g_cclosure_new_object_swap : g_cclosure_new_object) (c_handler, gobject);
3489
3490       return g_signal_connect_closure (instance, detailed_signal, closure, connect_flags & G_CONNECT_AFTER);
3491     }
3492   else
3493     return g_signal_connect_data (instance, detailed_signal, c_handler, NULL, NULL, connect_flags);
3494 }
3495
3496 typedef struct {
3497   GObject  *object;
3498   guint     n_closures;
3499   GClosure *closures[1]; /* flexible array */
3500 } CArray;
3501 /* don't change this structure without supplying an accessor for
3502  * watched closures, e.g.:
3503  * GSList* g_object_list_watched_closures (GObject *object)
3504  * {
3505  *   CArray *carray;
3506  *   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3507  *   carray = g_object_get_data (object, "GObject-closure-array");
3508  *   if (carray)
3509  *     {
3510  *       GSList *slist = NULL;
3511  *       guint i;
3512  *       for (i = 0; i < carray->n_closures; i++)
3513  *         slist = g_slist_prepend (slist, carray->closures[i]);
3514  *       return slist;
3515  *     }
3516  *   return NULL;
3517  * }
3518  */
3519
3520 static void
3521 object_remove_closure (gpointer  data,
3522                        GClosure *closure)
3523 {
3524   GObject *object = data;
3525   CArray *carray;
3526   guint i;
3527   
3528   G_LOCK (closure_array_mutex);
3529   carray = g_object_get_qdata (object, quark_closure_array);
3530   for (i = 0; i < carray->n_closures; i++)
3531     if (carray->closures[i] == closure)
3532       {
3533         carray->n_closures--;
3534         if (i < carray->n_closures)
3535           carray->closures[i] = carray->closures[carray->n_closures];
3536         G_UNLOCK (closure_array_mutex);
3537         return;
3538       }
3539   G_UNLOCK (closure_array_mutex);
3540   g_assert_not_reached ();
3541 }
3542
3543 static void
3544 destroy_closure_array (gpointer data)
3545 {
3546   CArray *carray = data;
3547   GObject *object = carray->object;
3548   guint i, n = carray->n_closures;
3549   
3550   for (i = 0; i < n; i++)
3551     {
3552       GClosure *closure = carray->closures[i];
3553       
3554       /* removing object_remove_closure() upfront is probably faster than
3555        * letting it fiddle with quark_closure_array which is empty anyways
3556        */
3557       g_closure_remove_invalidate_notifier (closure, object, object_remove_closure);
3558       g_closure_invalidate (closure);
3559     }
3560   g_free (carray);
3561 }
3562
3563 /**
3564  * g_object_watch_closure:
3565  * @object: GObject restricting lifetime of @closure
3566  * @closure: GClosure to watch
3567  *
3568  * This function essentially limits the life time of the @closure to
3569  * the life time of the object. That is, when the object is finalized,
3570  * the @closure is invalidated by calling g_closure_invalidate() on
3571  * it, in order to prevent invocations of the closure with a finalized
3572  * (nonexisting) object. Also, g_object_ref() and g_object_unref() are
3573  * added as marshal guards to the @closure, to ensure that an extra
3574  * reference count is held on @object during invocation of the
3575  * @closure.  Usually, this function will be called on closures that
3576  * use this @object as closure data.
3577  */
3578 void
3579 g_object_watch_closure (GObject  *object,
3580                         GClosure *closure)
3581 {
3582   CArray *carray;
3583   guint i;
3584   
3585   g_return_if_fail (G_IS_OBJECT (object));
3586   g_return_if_fail (closure != NULL);
3587   g_return_if_fail (closure->is_invalid == FALSE);
3588   g_return_if_fail (closure->in_marshal == FALSE);
3589   g_return_if_fail (object->ref_count > 0);     /* this doesn't work on finalizing objects */
3590   
3591   g_closure_add_invalidate_notifier (closure, object, object_remove_closure);
3592   g_closure_add_marshal_guards (closure,
3593                                 object, (GClosureNotify) g_object_ref,
3594                                 object, (GClosureNotify) g_object_unref);
3595   G_LOCK (closure_array_mutex);
3596   carray = g_datalist_id_remove_no_notify (&object->qdata, quark_closure_array);
3597   if (!carray)
3598     {
3599       carray = g_renew (CArray, NULL, 1);
3600       carray->object = object;
3601       carray->n_closures = 1;
3602       i = 0;
3603     }
3604   else
3605     {
3606       i = carray->n_closures++;
3607       carray = g_realloc (carray, sizeof (*carray) + sizeof (carray->closures[0]) * i);
3608     }
3609   carray->closures[i] = closure;
3610   g_datalist_id_set_data_full (&object->qdata, quark_closure_array, carray, destroy_closure_array);
3611   G_UNLOCK (closure_array_mutex);
3612 }
3613
3614 /**
3615  * g_closure_new_object:
3616  * @sizeof_closure: the size of the structure to allocate, must be at least
3617  *  <literal>sizeof (GClosure)</literal>
3618  * @object: a #GObject pointer to store in the @data field of the newly
3619  *  allocated #GClosure
3620  *
3621  * A variant of g_closure_new_simple() which stores @object in the
3622  * @data field of the closure and calls g_object_watch_closure() on
3623  * @object and the created closure. This function is mainly useful
3624  * when implementing new types of closures.
3625  *
3626  * Returns: (transfer full): a newly allocated #GClosure
3627  */
3628 GClosure*
3629 g_closure_new_object (guint    sizeof_closure,
3630                       GObject *object)
3631 {
3632   GClosure *closure;
3633
3634   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3635   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
3636
3637   closure = g_closure_new_simple (sizeof_closure, object);
3638   g_object_watch_closure (object, closure);
3639
3640   return closure;
3641 }
3642
3643 /**
3644  * g_cclosure_new_object: (skip)
3645  * @callback_func: the function to invoke
3646  * @object: a #GObject pointer to pass to @callback_func
3647  *
3648  * A variant of g_cclosure_new() which uses @object as @user_data and
3649  * calls g_object_watch_closure() on @object and the created
3650  * closure. This function is useful when you have a callback closely
3651  * associated with a #GObject, and want the callback to no longer run
3652  * after the object is is freed.
3653  *
3654  * Returns: a new #GCClosure
3655  */
3656 GClosure*
3657 g_cclosure_new_object (GCallback callback_func,
3658                        GObject  *object)
3659 {
3660   GClosure *closure;
3661
3662   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3663   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
3664   g_return_val_if_fail (callback_func != NULL, NULL);
3665
3666   closure = g_cclosure_new (callback_func, object, NULL);
3667   g_object_watch_closure (object, closure);
3668
3669   return closure;
3670 }
3671
3672 /**
3673  * g_cclosure_new_object_swap: (skip)
3674  * @callback_func: the function to invoke
3675  * @object: a #GObject pointer to pass to @callback_func
3676  *
3677  * A variant of g_cclosure_new_swap() which uses @object as @user_data
3678  * and calls g_object_watch_closure() on @object and the created
3679  * closure. This function is useful when you have a callback closely
3680  * associated with a #GObject, and want the callback to no longer run
3681  * after the object is is freed.
3682  *
3683  * Returns: a new #GCClosure
3684  */
3685 GClosure*
3686 g_cclosure_new_object_swap (GCallback callback_func,
3687                             GObject  *object)
3688 {
3689   GClosure *closure;
3690
3691   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3692   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
3693   g_return_val_if_fail (callback_func != NULL, NULL);
3694
3695   closure = g_cclosure_new_swap (callback_func, object, NULL);
3696   g_object_watch_closure (object, closure);
3697
3698   return closure;
3699 }
3700
3701 gsize
3702 g_object_compat_control (gsize           what,
3703                          gpointer        data)
3704 {
3705   switch (what)
3706     {
3707       gpointer *pp;
3708     case 1:     /* floating base type */
3709       return G_TYPE_INITIALLY_UNOWNED;
3710     case 2:     /* FIXME: remove this once GLib/Gtk+ break ABI again */
3711       floating_flag_handler = (guint(*)(GObject*,gint)) data;
3712       return 1;
3713     case 3:     /* FIXME: remove this once GLib/Gtk+ break ABI again */
3714       pp = data;
3715       *pp = floating_flag_handler;
3716       return 1;
3717     default:
3718       return 0;
3719     }
3720 }
3721
3722 G_DEFINE_TYPE (GInitiallyUnowned, g_initially_unowned, G_TYPE_OBJECT);
3723
3724 static void
3725 g_initially_unowned_init (GInitiallyUnowned *object)
3726 {
3727   g_object_force_floating (object);
3728 }
3729
3730 static void
3731 g_initially_unowned_class_init (GInitiallyUnownedClass *klass)
3732 {
3733 }