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