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