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_error ("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         g_warning ("The property %s:%s is deprecated and shouldn't be used "
1352                    "anymore. It will be removed in a future version.",
1353                    G_OBJECT_TYPE_NAME (object), pspec->name);
1354     }
1355
1356   /* provide a copy to work from, convert (if necessary) and validate */
1357   g_value_init (&tmp_value, pspec->value_type);
1358   if (!g_value_transform (value, &tmp_value))
1359     g_warning ("unable to set property '%s' of type '%s' from value of type '%s'",
1360                pspec->name,
1361                g_type_name (pspec->value_type),
1362                G_VALUE_TYPE_NAME (value));
1363   else if (g_param_value_validate (pspec, &tmp_value) && !(pspec->flags & G_PARAM_LAX_VALIDATION))
1364     {
1365       gchar *contents = g_strdup_value_contents (value);
1366
1367       g_warning ("value \"%s\" of type '%s' is invalid or out of range for property '%s' of type '%s'",
1368                  contents,
1369                  G_VALUE_TYPE_NAME (value),
1370                  pspec->name,
1371                  g_type_name (pspec->value_type));
1372       g_free (contents);
1373     }
1374   else
1375     {
1376       GParamSpec *notify_pspec;
1377
1378       class->set_property (object, param_id, &tmp_value, pspec);
1379
1380       notify_pspec = get_notify_pspec (pspec);
1381
1382       if (notify_pspec != NULL)
1383         g_object_notify_queue_add (object, nqueue, notify_pspec);
1384     }
1385   g_value_unset (&tmp_value);
1386 }
1387
1388 static void
1389 object_interface_check_properties (gpointer check_data,
1390                                    gpointer g_iface)
1391 {
1392   GTypeInterface *iface_class = g_iface;
1393   GObjectClass *class;
1394   GType iface_type = iface_class->g_type;
1395   GParamSpec **pspecs;
1396   guint n;
1397
1398   class = g_type_class_ref (iface_class->g_instance_type);
1399
1400   if (!G_IS_OBJECT_CLASS (class))
1401     return;
1402
1403   pspecs = g_param_spec_pool_list (pspec_pool, iface_type, &n);
1404
1405   while (n--)
1406     {
1407       GParamSpec *class_pspec = g_param_spec_pool_lookup (pspec_pool,
1408                                                           pspecs[n]->name,
1409                                                           G_OBJECT_CLASS_TYPE (class),
1410                                                           TRUE);
1411
1412       if (!class_pspec)
1413         {
1414           g_critical ("Object class %s doesn't implement property "
1415                       "'%s' from interface '%s'",
1416                       g_type_name (G_OBJECT_CLASS_TYPE (class)),
1417                       pspecs[n]->name,
1418                       g_type_name (iface_type));
1419
1420           continue;
1421         }
1422
1423       /* We do a number of checks on the properties of an interface to
1424        * make sure that all classes implementing the interface are
1425        * overriding the properties in a sane way.
1426        *
1427        * We do the checks in order of importance so that we can give
1428        * more useful error messages first.
1429        *
1430        * First, we check that the implementation doesn't remove the
1431        * basic functionality (readability, writability) advertised by
1432        * the interface.  Next, we check that it doesn't introduce
1433        * additional restrictions (such as construct-only).  Finally, we
1434        * make sure the types are compatible.
1435        */
1436
1437 #define SUBSET(a,b,mask) (((a) & ~(b) & (mask)) == 0)
1438       /* If the property on the interface is readable then the
1439        * implementation must be readable.  If the interface is writable
1440        * then the implementation must be writable.
1441        */
1442       if (!SUBSET (pspecs[n]->flags, class_pspec->flags, G_PARAM_READABLE | G_PARAM_WRITABLE))
1443         {
1444           g_critical ("Flags for property '%s' on class '%s' remove functionality compared with the "
1445                       "property on interface '%s'\n", pspecs[n]->name,
1446                       g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (iface_type));
1447           continue;
1448         }
1449
1450       /* If the property on the interface is writable then we need to
1451        * make sure the implementation doesn't introduce new restrictions
1452        * on that writability (ie: construct-only).
1453        *
1454        * If the interface was not writable to begin with then we don't
1455        * really have any problems here because "writable at construct
1456        * type only" is still more permissive than "read only".
1457        */
1458       if (pspecs[n]->flags & G_PARAM_WRITABLE)
1459         {
1460           if (!SUBSET (class_pspec->flags, pspecs[n]->flags, G_PARAM_CONSTRUCT_ONLY))
1461             {
1462               g_critical ("Flags for property '%s' on class '%s' introduce additional restrictions on "
1463                           "writability compared with the property on interface '%s'\n", pspecs[n]->name,
1464                           g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (iface_type));
1465               continue;
1466             }
1467         }
1468 #undef SUBSET
1469
1470       /* If the property on the interface is readable then we are
1471        * effectively advertising that reading the property will return a
1472        * value of a specific type.  All implementations of the interface
1473        * need to return items of this type -- but may be more
1474        * restrictive.  For example, it is legal to have:
1475        *
1476        *   GtkWidget *get_item();
1477        *
1478        * that is implemented by a function that always returns a
1479        * GtkEntry.  In short: readability implies that the
1480        * implementation  value type must be equal or more restrictive.
1481        *
1482        * Similarly, if the property on the interface is writable then
1483        * must be able to accept the property being set to any value of
1484        * that type, including subclasses.  In this case, we may also be
1485        * less restrictive.  For example, it is legal to have:
1486        *
1487        *   set_item (GtkEntry *);
1488        *
1489        * that is implemented by a function that will actually work with
1490        * any GtkWidget.  In short: writability implies that the
1491        * implementation value type must be equal or less restrictive.
1492        *
1493        * In the case that the property is both readable and writable
1494        * then the only way that both of the above can be satisfied is
1495        * with a type that is exactly equal.
1496        */
1497       switch (pspecs[n]->flags & (G_PARAM_READABLE | G_PARAM_WRITABLE))
1498         {
1499         case G_PARAM_READABLE | G_PARAM_WRITABLE:
1500           /* class pspec value type must have exact equality with interface */
1501           if (pspecs[n]->value_type != class_pspec->value_type)
1502             g_critical ("Read/writable property '%s' on class '%s' has type '%s' which is not exactly equal to the "
1503                         "type '%s' of the property on the interface '%s'\n", pspecs[n]->name,
1504                         g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1505                         g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])), g_type_name (iface_type));
1506           break;
1507
1508         case G_PARAM_READABLE:
1509           /* class pspec value type equal or more restrictive than interface */
1510           if (!g_type_is_a (class_pspec->value_type, pspecs[n]->value_type))
1511             g_critical ("Read-only property '%s' on class '%s' has type '%s' which is not equal to or more "
1512                         "restrictive than the type '%s' of the property on the interface '%s'\n", pspecs[n]->name,
1513                         g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1514                         g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])), g_type_name (iface_type));
1515           break;
1516
1517         case G_PARAM_WRITABLE:
1518           /* class pspec value type equal or less restrictive than interface */
1519           if (!g_type_is_a (pspecs[n]->value_type, class_pspec->value_type))
1520             g_critical ("Write-only property '%s' on class '%s' has type '%s' which is not equal to or less "
1521                         "restrictive than the type '%s' of the property on the interface '%s' \n", pspecs[n]->name,
1522                         g_type_name (G_OBJECT_CLASS_TYPE (class)), g_type_name (G_PARAM_SPEC_VALUE_TYPE (class_pspec)),
1523                         g_type_name (G_PARAM_SPEC_VALUE_TYPE (pspecs[n])), g_type_name (iface_type));
1524           break;
1525
1526         default:
1527           g_assert_not_reached ();
1528         }
1529     }
1530
1531   g_free (pspecs);
1532
1533   g_type_class_unref (class);
1534 }
1535
1536 GType
1537 g_object_get_type (void)
1538 {
1539     return G_TYPE_OBJECT;
1540 }
1541
1542 /**
1543  * g_object_new: (skip)
1544  * @object_type: the type id of the #GObject subtype to instantiate
1545  * @first_property_name: the name of the first property
1546  * @...: the value of the first property, followed optionally by more
1547  *  name/value pairs, followed by %NULL
1548  *
1549  * Creates a new instance of a #GObject subtype and sets its properties.
1550  *
1551  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1552  * which are not explicitly specified are set to their default values.
1553  *
1554  * Returns: (transfer full): a new instance of @object_type
1555  */
1556 gpointer
1557 g_object_new (GType        object_type,
1558               const gchar *first_property_name,
1559               ...)
1560 {
1561   GObject *object;
1562   va_list var_args;
1563
1564   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1565
1566   /* short circuit for calls supplying no properties */
1567   if (!first_property_name)
1568     return g_object_newv (object_type, 0, NULL);
1569
1570   va_start (var_args, first_property_name);
1571   object = g_object_new_valist (object_type, first_property_name, var_args);
1572   va_end (var_args);
1573
1574   return object;
1575 }
1576
1577 static gpointer
1578 g_object_new_with_custom_constructor (GObjectClass          *class,
1579                                       GObjectConstructParam *params,
1580                                       guint                  n_params)
1581 {
1582   GObjectNotifyQueue *nqueue = NULL;
1583   gboolean newly_constructed;
1584   GObjectConstructParam *cparams;
1585   GObject *object;
1586   GValue *cvalues;
1587   gint n_cparams;
1588   gint cvals_used;
1589   GSList *node;
1590   gint i;
1591
1592   /* If we have ->constructed() then we have to do a lot more work.
1593    * It's possible that this is a singleton and it's also possible
1594    * that the user's constructor() will attempt to modify the values
1595    * that we pass in, so we'll need to allocate copies of them.
1596    * It's also possible that the user may attempt to call
1597    * g_object_set() from inside of their constructor, so we need to
1598    * add ourselves to a list of objects for which that is allowed
1599    * while their constructor() is running.
1600    */
1601
1602   /* Create the array of GObjectConstructParams for constructor() */
1603   n_cparams = g_slist_length (class->construct_properties);
1604   cparams = g_new (GObjectConstructParam, n_cparams);
1605   cvalues = g_new0 (GValue, n_cparams);
1606   cvals_used = 0;
1607   i = 0;
1608
1609   /* As above, we may find the value in the passed-in params list.
1610    *
1611    * If we have the value passed in then we can use the GValue from
1612    * it directly because it is safe to modify.  If we use the
1613    * default value from the class, we had better not pass that in
1614    * and risk it being modified, so we create a new one.
1615    * */
1616   for (node = class->construct_properties; node; node = node->next)
1617     {
1618       GParamSpec *pspec;
1619       GValue *value;
1620       gint j;
1621
1622       pspec = node->data;
1623       value = NULL; /* to silence gcc... */
1624
1625       for (j = 0; j < n_params; j++)
1626         if (params[j].pspec == pspec)
1627           {
1628             value = params[j].value;
1629             break;
1630           }
1631
1632       if (j == n_params)
1633         {
1634           value = &cvalues[cvals_used++];
1635           g_value_init (value, pspec->value_type);
1636           g_param_value_set_default (pspec, value);
1637         }
1638
1639       cparams[i].pspec = pspec;
1640       cparams[i].value = value;
1641       i++;
1642     }
1643
1644   /* construct object from construction parameters */
1645   object = class->constructor (class->g_type_class.g_type, n_cparams, cparams);
1646   /* free construction values */
1647   g_free (cparams);
1648   while (cvals_used--)
1649     g_value_unset (&cvalues[cvals_used]);
1650   g_free (cvalues);
1651
1652   /* There is code in the wild that relies on being able to return NULL
1653    * from its custom constructor.  This was never a supported operation,
1654    * but since the code is already out there...
1655    */
1656   if (object == NULL)
1657     {
1658       g_critical ("Custom constructor for class %s returned NULL (which is invalid). "
1659                   "Please use GInitable instead.", G_OBJECT_CLASS_NAME (class));
1660       return NULL;
1661     }
1662
1663   /* g_object_init() will have marked the object as being in-construction.
1664    * Check if the returned object still is so marked, or if this is an
1665    * already-existing singleton (in which case we should not do 'constructed').
1666    */
1667   newly_constructed = object_in_construction (object);
1668   if (newly_constructed)
1669     g_datalist_id_set_data (&object->qdata, quark_in_construction, NULL);
1670
1671   if (CLASS_HAS_PROPS (class))
1672     {
1673       /* If this object was newly_constructed then g_object_init()
1674        * froze the queue.  We need to freeze it here in order to get
1675        * the handle so that we can thaw it below (otherwise it will
1676        * be frozen forever).
1677        *
1678        * We also want to do a freeze if we have any params to set,
1679        * even on a non-newly_constructed object.
1680        *
1681        * It's possible that we have the case of non-newly created
1682        * singleton and all of the passed-in params were construct
1683        * properties so n_params > 0 but we will actually set no
1684        * properties.  This is a pretty lame case to optimise, so
1685        * just ignore it and freeze anyway.
1686        */
1687       if (newly_constructed || n_params)
1688         nqueue = g_object_notify_queue_freeze (object, FALSE);
1689
1690       /* Remember: if it was newly_constructed then g_object_init()
1691        * already did a freeze, so we now have two.  Release one.
1692        */
1693       if (newly_constructed)
1694         g_object_notify_queue_thaw (object, nqueue);
1695     }
1696
1697   /* run 'constructed' handler if there is a custom one */
1698   if (newly_constructed && CLASS_HAS_CUSTOM_CONSTRUCTED (class))
1699     class->constructed (object);
1700
1701   /* set remaining properties */
1702   for (i = 0; i < n_params; i++)
1703     if (!(params[i].pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)))
1704       object_set_property (object, params[i].pspec, params[i].value, nqueue);
1705
1706   /* If nqueue is non-NULL then we are frozen.  Thaw it. */
1707   if (nqueue)
1708     g_object_notify_queue_thaw (object, nqueue);
1709
1710   return object;
1711 }
1712
1713 static gpointer
1714 g_object_new_internal (GObjectClass          *class,
1715                        GObjectConstructParam *params,
1716                        guint                  n_params)
1717 {
1718   GObjectNotifyQueue *nqueue = NULL;
1719   GObject *object;
1720
1721   if G_UNLIKELY (CLASS_HAS_CUSTOM_CONSTRUCTOR (class))
1722     return g_object_new_with_custom_constructor (class, params, n_params);
1723
1724   object = (GObject *) g_type_create_instance (class->g_type_class.g_type);
1725
1726   if (CLASS_HAS_PROPS (class))
1727     {
1728       GSList *node;
1729
1730       /* This will have been setup in g_object_init() */
1731       nqueue = g_datalist_id_get_data (&object->qdata, quark_notify_queue);
1732       g_assert (nqueue != NULL);
1733
1734       /* We will set exactly n_construct_properties construct
1735        * properties, but they may come from either the class default
1736        * values or the passed-in parameter list.
1737        */
1738       for (node = class->construct_properties; node; node = node->next)
1739         {
1740           const GValue *value;
1741           GParamSpec *pspec;
1742           gint j;
1743
1744           pspec = node->data;
1745           value = NULL; /* to silence gcc... */
1746
1747           for (j = 0; j < n_params; j++)
1748             if (params[j].pspec == pspec)
1749               {
1750                 value = params[j].value;
1751                 break;
1752               }
1753
1754           if (j == n_params)
1755             value = g_param_spec_get_default_value (pspec);
1756
1757           object_set_property (object, pspec, value, nqueue);
1758         }
1759     }
1760
1761   /* run 'constructed' handler if there is a custom one */
1762   if (CLASS_HAS_CUSTOM_CONSTRUCTED (class))
1763     class->constructed (object);
1764
1765   if (nqueue)
1766     {
1767       gint i;
1768
1769       /* Set remaining properties.  The construct properties will
1770        * already have been taken, so set only the non-construct
1771        * ones.
1772        */
1773       for (i = 0; i < n_params; i++)
1774         if (!(params[i].pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)))
1775           object_set_property (object, params[i].pspec, params[i].value, nqueue);
1776
1777       g_object_notify_queue_thaw (object, nqueue);
1778     }
1779
1780   return object;
1781 }
1782
1783 /**
1784  * g_object_newv:
1785  * @object_type: the type id of the #GObject subtype to instantiate
1786  * @n_parameters: the length of the @parameters array
1787  * @parameters: (array length=n_parameters): an array of #GParameter
1788  *
1789  * Creates a new instance of a #GObject subtype and sets its properties.
1790  *
1791  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1792  * which are not explicitly specified are set to their default values.
1793  *
1794  * Rename to: g_object_new
1795  * Returns: (type GObject.Object) (transfer full): a new instance of
1796  * @object_type
1797  */
1798 gpointer
1799 g_object_newv (GType       object_type,
1800                guint       n_parameters,
1801                GParameter *parameters)
1802 {
1803   GObjectClass *class, *unref_class = NULL;
1804   GObject *object;
1805
1806   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1807   g_return_val_if_fail (n_parameters == 0 || parameters != NULL, NULL);
1808
1809   /* Try to avoid thrashing the ref_count if we don't need to (since
1810    * it's a locked operation).
1811    */
1812   class = g_type_class_peek_static (object_type);
1813
1814   if (!class)
1815     class = unref_class = g_type_class_ref (object_type);
1816
1817   if (n_parameters)
1818     {
1819       GObjectConstructParam *cparams;
1820       guint i, j;
1821
1822       cparams = g_newa (GObjectConstructParam, n_parameters);
1823       j = 0;
1824
1825       for (i = 0; i < n_parameters; i++)
1826         {
1827           GParamSpec *pspec;
1828           gint k;
1829
1830           pspec = g_param_spec_pool_lookup (pspec_pool, parameters[i].name, object_type, TRUE);
1831
1832           if G_UNLIKELY (!pspec)
1833             {
1834               g_critical ("%s: object class '%s' has no property named '%s'",
1835                           G_STRFUNC, g_type_name (object_type), parameters[i].name);
1836               continue;
1837             }
1838
1839           if G_UNLIKELY (~pspec->flags & G_PARAM_WRITABLE)
1840             {
1841               g_critical ("%s: property '%s' of object class '%s' is not writable",
1842                           G_STRFUNC, pspec->name, g_type_name (object_type));
1843               continue;
1844             }
1845
1846           if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1847             {
1848               for (k = 0; k < j; k++)
1849                 if (cparams[k].pspec == pspec)
1850                     break;
1851               if G_UNLIKELY (k != j)
1852                 {
1853                   g_critical ("%s: construct property '%s' for type '%s' cannot be set twice",
1854                               G_STRFUNC, parameters[i].name, g_type_name (object_type));
1855                   continue;
1856                 }
1857             }
1858
1859           cparams[j].pspec = pspec;
1860           cparams[j].value = &parameters[i].value;
1861           j++;
1862         }
1863
1864       object = g_object_new_internal (class, cparams, j);
1865     }
1866   else
1867     /* Fast case: no properties passed in. */
1868     object = g_object_new_internal (class, NULL, 0);
1869
1870   if (unref_class)
1871     g_type_class_unref (unref_class);
1872
1873   return object;
1874 }
1875
1876 /**
1877  * g_object_new_valist: (skip)
1878  * @object_type: the type id of the #GObject subtype to instantiate
1879  * @first_property_name: the name of the first property
1880  * @var_args: the value of the first property, followed optionally by more
1881  *  name/value pairs, followed by %NULL
1882  *
1883  * Creates a new instance of a #GObject subtype and sets its properties.
1884  *
1885  * Construction parameters (see #G_PARAM_CONSTRUCT, #G_PARAM_CONSTRUCT_ONLY)
1886  * which are not explicitly specified are set to their default values.
1887  *
1888  * Returns: a new instance of @object_type
1889  */
1890 GObject*
1891 g_object_new_valist (GType        object_type,
1892                      const gchar *first_property_name,
1893                      va_list      var_args)
1894 {
1895   GObjectClass *class, *unref_class = NULL;
1896   GObject *object;
1897
1898   g_return_val_if_fail (G_TYPE_IS_OBJECT (object_type), NULL);
1899
1900   /* Try to avoid thrashing the ref_count if we don't need to (since
1901    * it's a locked operation).
1902    */
1903   class = g_type_class_peek_static (object_type);
1904
1905   if (!class)
1906     class = unref_class = g_type_class_ref (object_type);
1907
1908   if (first_property_name)
1909     {
1910       GObjectConstructParam stack_params[16];
1911       GObjectConstructParam *params;
1912       const gchar *name;
1913       gint n_params = 0;
1914
1915       name = first_property_name;
1916       params = stack_params;
1917
1918       do
1919         {
1920           gchar *error = NULL;
1921           GParamSpec *pspec;
1922           gint i;
1923
1924           pspec = g_param_spec_pool_lookup (pspec_pool, name, object_type, TRUE);
1925
1926           if G_UNLIKELY (!pspec)
1927             {
1928               g_critical ("%s: object class '%s' has no property named '%s'",
1929                           G_STRFUNC, g_type_name (object_type), name);
1930               /* Can't continue because arg list will be out of sync. */
1931               break;
1932             }
1933
1934           if G_UNLIKELY (~pspec->flags & G_PARAM_WRITABLE)
1935             {
1936               g_critical ("%s: property '%s' of object class '%s' is not writable",
1937                           G_STRFUNC, pspec->name, g_type_name (object_type));
1938               break;
1939             }
1940
1941           if (pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY))
1942             {
1943               for (i = 0; i < n_params; i++)
1944                 if (params[i].pspec == pspec)
1945                     break;
1946               if G_UNLIKELY (i != n_params)
1947                 {
1948                   g_critical ("%s: property '%s' for type '%s' cannot be set twice",
1949                               G_STRFUNC, name, g_type_name (object_type));
1950                   break;
1951                 }
1952             }
1953
1954           if (n_params == 16)
1955             {
1956               params = g_new (GObjectConstructParam, n_params + 1);
1957               memcpy (params, stack_params, sizeof stack_params);
1958             }
1959           else if (n_params > 16)
1960             params = g_renew (GObjectConstructParam, params, n_params + 1);
1961
1962           params[n_params].pspec = pspec;
1963           params[n_params].value = g_newa (GValue, 1);
1964           memset (params[n_params].value, 0, sizeof (GValue));
1965
1966           G_VALUE_COLLECT_INIT (params[n_params].value, pspec->value_type, var_args, 0, &error);
1967
1968           if (error)
1969             {
1970               g_critical ("%s: %s", G_STRFUNC, error);
1971               g_value_unset (params[n_params].value);
1972               g_free (error);
1973               break;
1974             }
1975
1976           n_params++;
1977         }
1978       while ((name = va_arg (var_args, const gchar *)));
1979
1980       object = g_object_new_internal (class, params, n_params);
1981
1982       while (n_params--)
1983         g_value_unset (params[n_params].value);
1984
1985       if (params != stack_params)
1986         g_free (params);
1987     }
1988   else
1989     /* Fast case: no properties passed in. */
1990     object = g_object_new_internal (class, NULL, 0);
1991
1992   if (unref_class)
1993     g_type_class_unref (unref_class);
1994
1995   return object;
1996 }
1997
1998 static GObject*
1999 g_object_constructor (GType                  type,
2000                       guint                  n_construct_properties,
2001                       GObjectConstructParam *construct_params)
2002 {
2003   GObject *object;
2004
2005   /* create object */
2006   object = (GObject*) g_type_create_instance (type);
2007
2008   /* set construction parameters */
2009   if (n_construct_properties)
2010     {
2011       GObjectNotifyQueue *nqueue = g_object_notify_queue_freeze (object, FALSE);
2012
2013       /* set construct properties */
2014       while (n_construct_properties--)
2015         {
2016           GValue *value = construct_params->value;
2017           GParamSpec *pspec = construct_params->pspec;
2018
2019           construct_params++;
2020           object_set_property (object, pspec, value, nqueue);
2021         }
2022       g_object_notify_queue_thaw (object, nqueue);
2023       /* the notification queue is still frozen from g_object_init(), so
2024        * we don't need to handle it here, g_object_newv() takes
2025        * care of that
2026        */
2027     }
2028
2029   return object;
2030 }
2031
2032 static void
2033 g_object_constructed (GObject *object)
2034 {
2035   /* empty default impl to allow unconditional upchaining */
2036 }
2037
2038 /**
2039  * g_object_set_valist: (skip)
2040  * @object: a #GObject
2041  * @first_property_name: name of the first property to set
2042  * @var_args: value for the first property, followed optionally by more
2043  *  name/value pairs, followed by %NULL
2044  *
2045  * Sets properties on an object.
2046  */
2047 void
2048 g_object_set_valist (GObject     *object,
2049                      const gchar *first_property_name,
2050                      va_list      var_args)
2051 {
2052   GObjectNotifyQueue *nqueue;
2053   const gchar *name;
2054
2055   g_return_if_fail (G_IS_OBJECT (object));
2056
2057   g_object_ref (object);
2058   nqueue = g_object_notify_queue_freeze (object, FALSE);
2059
2060   name = first_property_name;
2061   while (name)
2062     {
2063       GValue value = G_VALUE_INIT;
2064       GParamSpec *pspec;
2065       gchar *error = NULL;
2066
2067       pspec = g_param_spec_pool_lookup (pspec_pool,
2068                                         name,
2069                                         G_OBJECT_TYPE (object),
2070                                         TRUE);
2071       if (!pspec)
2072         {
2073           g_warning ("%s: object class '%s' has no property named '%s'",
2074                      G_STRFUNC,
2075                      G_OBJECT_TYPE_NAME (object),
2076                      name);
2077           break;
2078         }
2079       if (!(pspec->flags & G_PARAM_WRITABLE))
2080         {
2081           g_warning ("%s: property '%s' of object class '%s' is not writable",
2082                      G_STRFUNC,
2083                      pspec->name,
2084                      G_OBJECT_TYPE_NAME (object));
2085           break;
2086         }
2087       if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction (object))
2088         {
2089           g_warning ("%s: construct property \"%s\" for object '%s' can't be set after construction",
2090                      G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
2091           break;
2092         }
2093
2094       G_VALUE_COLLECT_INIT (&value, pspec->value_type, var_args,
2095                             0, &error);
2096       if (error)
2097         {
2098           g_warning ("%s: %s", G_STRFUNC, error);
2099           g_free (error);
2100           g_value_unset (&value);
2101           break;
2102         }
2103
2104       object_set_property (object, pspec, &value, nqueue);
2105       g_value_unset (&value);
2106
2107       name = va_arg (var_args, gchar*);
2108     }
2109
2110   g_object_notify_queue_thaw (object, nqueue);
2111   g_object_unref (object);
2112 }
2113
2114 /**
2115  * g_object_get_valist: (skip)
2116  * @object: a #GObject
2117  * @first_property_name: name of the first property to get
2118  * @var_args: return location for the first property, followed optionally by more
2119  *  name/return location pairs, followed by %NULL
2120  *
2121  * Gets properties of an object.
2122  *
2123  * In general, a copy is made of the property contents and the caller
2124  * is responsible for freeing the memory in the appropriate manner for
2125  * the type, for instance by calling g_free() or g_object_unref().
2126  *
2127  * See g_object_get().
2128  */
2129 void
2130 g_object_get_valist (GObject     *object,
2131                      const gchar *first_property_name,
2132                      va_list      var_args)
2133 {
2134   const gchar *name;
2135
2136   g_return_if_fail (G_IS_OBJECT (object));
2137
2138   g_object_ref (object);
2139
2140   name = first_property_name;
2141
2142   while (name)
2143     {
2144       GValue value = G_VALUE_INIT;
2145       GParamSpec *pspec;
2146       gchar *error;
2147
2148       pspec = g_param_spec_pool_lookup (pspec_pool,
2149                                         name,
2150                                         G_OBJECT_TYPE (object),
2151                                         TRUE);
2152       if (!pspec)
2153         {
2154           g_warning ("%s: object class '%s' has no property named '%s'",
2155                      G_STRFUNC,
2156                      G_OBJECT_TYPE_NAME (object),
2157                      name);
2158           break;
2159         }
2160       if (!(pspec->flags & G_PARAM_READABLE))
2161         {
2162           g_warning ("%s: property '%s' of object class '%s' is not readable",
2163                      G_STRFUNC,
2164                      pspec->name,
2165                      G_OBJECT_TYPE_NAME (object));
2166           break;
2167         }
2168
2169       g_value_init (&value, pspec->value_type);
2170
2171       object_get_property (object, pspec, &value);
2172
2173       G_VALUE_LCOPY (&value, var_args, 0, &error);
2174       if (error)
2175         {
2176           g_warning ("%s: %s", G_STRFUNC, error);
2177           g_free (error);
2178           g_value_unset (&value);
2179           break;
2180         }
2181
2182       g_value_unset (&value);
2183
2184       name = va_arg (var_args, gchar*);
2185     }
2186
2187   g_object_unref (object);
2188 }
2189
2190 /**
2191  * g_object_set: (skip)
2192  * @object: a #GObject
2193  * @first_property_name: name of the first property to set
2194  * @...: value for the first property, followed optionally by more
2195  *  name/value pairs, followed by %NULL
2196  *
2197  * Sets properties on an object.
2198  *
2199  * Note that the "notify" signals are queued and only emitted (in
2200  * reverse order) after all properties have been set. See
2201  * g_object_freeze_notify().
2202  */
2203 void
2204 g_object_set (gpointer     _object,
2205               const gchar *first_property_name,
2206               ...)
2207 {
2208   GObject *object = _object;
2209   va_list var_args;
2210
2211   g_return_if_fail (G_IS_OBJECT (object));
2212
2213   va_start (var_args, first_property_name);
2214   g_object_set_valist (object, first_property_name, var_args);
2215   va_end (var_args);
2216 }
2217
2218 /**
2219  * g_object_get: (skip)
2220  * @object: a #GObject
2221  * @first_property_name: name of the first property to get
2222  * @...: return location for the first property, followed optionally by more
2223  *  name/return location pairs, followed by %NULL
2224  *
2225  * Gets properties of an object.
2226  *
2227  * In general, a copy is made of the property contents and the caller
2228  * is responsible for freeing the memory in the appropriate manner for
2229  * the type, for instance by calling g_free() or g_object_unref().
2230  *
2231  * Here is an example of using g_object_get() to get the contents
2232  * of three properties: an integer, a string and an object:
2233  * |[<!-- language="C" -->
2234  *  gint intval;
2235  *  gchar *strval;
2236  *  GObject *objval;
2237  *
2238  *  g_object_get (my_object,
2239  *                "int-property", &intval,
2240  *                "str-property", &strval,
2241  *                "obj-property", &objval,
2242  *                NULL);
2243  *
2244  *  // Do something with intval, strval, objval
2245  *
2246  *  g_free (strval);
2247  *  g_object_unref (objval);
2248  *  ]|
2249  */
2250 void
2251 g_object_get (gpointer     _object,
2252               const gchar *first_property_name,
2253               ...)
2254 {
2255   GObject *object = _object;
2256   va_list var_args;
2257
2258   g_return_if_fail (G_IS_OBJECT (object));
2259
2260   va_start (var_args, first_property_name);
2261   g_object_get_valist (object, first_property_name, var_args);
2262   va_end (var_args);
2263 }
2264
2265 /**
2266  * g_object_set_property:
2267  * @object: a #GObject
2268  * @property_name: the name of the property to set
2269  * @value: the value
2270  *
2271  * Sets a property on an object.
2272  */
2273 void
2274 g_object_set_property (GObject      *object,
2275                        const gchar  *property_name,
2276                        const GValue *value)
2277 {
2278   GObjectNotifyQueue *nqueue;
2279   GParamSpec *pspec;
2280
2281   g_return_if_fail (G_IS_OBJECT (object));
2282   g_return_if_fail (property_name != NULL);
2283   g_return_if_fail (G_IS_VALUE (value));
2284
2285   g_object_ref (object);
2286   nqueue = g_object_notify_queue_freeze (object, FALSE);
2287
2288   pspec = g_param_spec_pool_lookup (pspec_pool,
2289                                     property_name,
2290                                     G_OBJECT_TYPE (object),
2291                                     TRUE);
2292   if (!pspec)
2293     g_warning ("%s: object class '%s' has no property named '%s'",
2294                G_STRFUNC,
2295                G_OBJECT_TYPE_NAME (object),
2296                property_name);
2297   else if (!(pspec->flags & G_PARAM_WRITABLE))
2298     g_warning ("%s: property '%s' of object class '%s' is not writable",
2299                G_STRFUNC,
2300                pspec->name,
2301                G_OBJECT_TYPE_NAME (object));
2302   else if ((pspec->flags & G_PARAM_CONSTRUCT_ONLY) && !object_in_construction (object))
2303     g_warning ("%s: construct property \"%s\" for object '%s' can't be set after construction",
2304                G_STRFUNC, pspec->name, G_OBJECT_TYPE_NAME (object));
2305   else
2306     object_set_property (object, pspec, value, nqueue);
2307
2308   g_object_notify_queue_thaw (object, nqueue);
2309   g_object_unref (object);
2310 }
2311
2312 /**
2313  * g_object_get_property:
2314  * @object: a #GObject
2315  * @property_name: the name of the property to get
2316  * @value: return location for the property value
2317  *
2318  * Gets a property of an object. @value must have been initialized to the
2319  * expected type of the property (or a type to which the expected type can be
2320  * transformed) using g_value_init().
2321  *
2322  * In general, a copy is made of the property contents and the caller is
2323  * responsible for freeing the memory by calling g_value_unset().
2324  *
2325  * Note that g_object_get_property() is really intended for language
2326  * bindings, g_object_get() is much more convenient for C programming.
2327  */
2328 void
2329 g_object_get_property (GObject     *object,
2330                        const gchar *property_name,
2331                        GValue      *value)
2332 {
2333   GParamSpec *pspec;
2334
2335   g_return_if_fail (G_IS_OBJECT (object));
2336   g_return_if_fail (property_name != NULL);
2337   g_return_if_fail (G_IS_VALUE (value));
2338
2339   g_object_ref (object);
2340
2341   pspec = g_param_spec_pool_lookup (pspec_pool,
2342                                     property_name,
2343                                     G_OBJECT_TYPE (object),
2344                                     TRUE);
2345   if (!pspec)
2346     g_warning ("%s: object class '%s' has no property named '%s'",
2347                G_STRFUNC,
2348                G_OBJECT_TYPE_NAME (object),
2349                property_name);
2350   else if (!(pspec->flags & G_PARAM_READABLE))
2351     g_warning ("%s: property '%s' of object class '%s' is not readable",
2352                G_STRFUNC,
2353                pspec->name,
2354                G_OBJECT_TYPE_NAME (object));
2355   else
2356     {
2357       GValue *prop_value, tmp_value = G_VALUE_INIT;
2358
2359       /* auto-conversion of the callers value type
2360        */
2361       if (G_VALUE_TYPE (value) == pspec->value_type)
2362         {
2363           g_value_reset (value);
2364           prop_value = value;
2365         }
2366       else if (!g_value_type_transformable (pspec->value_type, G_VALUE_TYPE (value)))
2367         {
2368           g_warning ("%s: can't retrieve property '%s' of type '%s' as value of type '%s'",
2369                      G_STRFUNC, pspec->name,
2370                      g_type_name (pspec->value_type),
2371                      G_VALUE_TYPE_NAME (value));
2372           g_object_unref (object);
2373           return;
2374         }
2375       else
2376         {
2377           g_value_init (&tmp_value, pspec->value_type);
2378           prop_value = &tmp_value;
2379         }
2380       object_get_property (object, pspec, prop_value);
2381       if (prop_value != value)
2382         {
2383           g_value_transform (prop_value, value);
2384           g_value_unset (&tmp_value);
2385         }
2386     }
2387
2388   g_object_unref (object);
2389 }
2390
2391 /**
2392  * g_object_connect: (skip)
2393  * @object: a #GObject
2394  * @signal_spec: the spec for the first signal
2395  * @...: #GCallback for the first signal, followed by data for the
2396  *       first signal, followed optionally by more signal
2397  *       spec/callback/data triples, followed by %NULL
2398  *
2399  * A convenience function to connect multiple signals at once.
2400  *
2401  * The signal specs expected by this function have the form
2402  * "modifier::signal_name", where modifier can be one of the following:
2403  * * - signal: equivalent to g_signal_connect_data (..., NULL, 0)
2404  * - object-signal, object_signal: equivalent to g_signal_connect_object (..., 0)
2405  * - swapped-signal, swapped_signal: equivalent to g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED)
2406  * - swapped_object_signal, swapped-object-signal: equivalent to g_signal_connect_object (..., G_CONNECT_SWAPPED)
2407  * - signal_after, signal-after: equivalent to g_signal_connect_data (..., NULL, G_CONNECT_AFTER)
2408  * - object_signal_after, object-signal-after: equivalent to g_signal_connect_object (..., G_CONNECT_AFTER)
2409  * - swapped_signal_after, swapped-signal-after: equivalent to g_signal_connect_data (..., NULL, G_CONNECT_SWAPPED | G_CONNECT_AFTER)
2410  * - swapped_object_signal_after, swapped-object-signal-after: equivalent to g_signal_connect_object (..., G_CONNECT_SWAPPED | G_CONNECT_AFTER)
2411  *
2412  * |[<!-- language="C" -->
2413  *   menu->toplevel = g_object_connect (g_object_new (GTK_TYPE_WINDOW,
2414  *                                                 "type", GTK_WINDOW_POPUP,
2415  *                                                 "child", menu,
2416  *                                                 NULL),
2417  *                                   "signal::event", gtk_menu_window_event, menu,
2418  *                                   "signal::size_request", gtk_menu_window_size_request, menu,
2419  *                                   "signal::destroy", gtk_widget_destroyed, &menu->toplevel,
2420  *                                   NULL);
2421  * ]|
2422  *
2423  * Returns: (transfer none): @object
2424  */
2425 gpointer
2426 g_object_connect (gpointer     _object,
2427                   const gchar *signal_spec,
2428                   ...)
2429 {
2430   GObject *object = _object;
2431   va_list var_args;
2432
2433   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2434   g_return_val_if_fail (object->ref_count > 0, object);
2435
2436   va_start (var_args, signal_spec);
2437   while (signal_spec)
2438     {
2439       GCallback callback = va_arg (var_args, GCallback);
2440       gpointer data = va_arg (var_args, gpointer);
2441
2442       if (strncmp (signal_spec, "signal::", 8) == 0)
2443         g_signal_connect_data (object, signal_spec + 8,
2444                                callback, data, NULL,
2445                                0);
2446       else if (strncmp (signal_spec, "object_signal::", 15) == 0 ||
2447                strncmp (signal_spec, "object-signal::", 15) == 0)
2448         g_signal_connect_object (object, signal_spec + 15,
2449                                  callback, data,
2450                                  0);
2451       else if (strncmp (signal_spec, "swapped_signal::", 16) == 0 ||
2452                strncmp (signal_spec, "swapped-signal::", 16) == 0)
2453         g_signal_connect_data (object, signal_spec + 16,
2454                                callback, data, NULL,
2455                                G_CONNECT_SWAPPED);
2456       else if (strncmp (signal_spec, "swapped_object_signal::", 23) == 0 ||
2457                strncmp (signal_spec, "swapped-object-signal::", 23) == 0)
2458         g_signal_connect_object (object, signal_spec + 23,
2459                                  callback, data,
2460                                  G_CONNECT_SWAPPED);
2461       else if (strncmp (signal_spec, "signal_after::", 14) == 0 ||
2462                strncmp (signal_spec, "signal-after::", 14) == 0)
2463         g_signal_connect_data (object, signal_spec + 14,
2464                                callback, data, NULL,
2465                                G_CONNECT_AFTER);
2466       else if (strncmp (signal_spec, "object_signal_after::", 21) == 0 ||
2467                strncmp (signal_spec, "object-signal-after::", 21) == 0)
2468         g_signal_connect_object (object, signal_spec + 21,
2469                                  callback, data,
2470                                  G_CONNECT_AFTER);
2471       else if (strncmp (signal_spec, "swapped_signal_after::", 22) == 0 ||
2472                strncmp (signal_spec, "swapped-signal-after::", 22) == 0)
2473         g_signal_connect_data (object, signal_spec + 22,
2474                                callback, data, NULL,
2475                                G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2476       else if (strncmp (signal_spec, "swapped_object_signal_after::", 29) == 0 ||
2477                strncmp (signal_spec, "swapped-object-signal-after::", 29) == 0)
2478         g_signal_connect_object (object, signal_spec + 29,
2479                                  callback, data,
2480                                  G_CONNECT_SWAPPED | G_CONNECT_AFTER);
2481       else
2482         {
2483           g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2484           break;
2485         }
2486       signal_spec = va_arg (var_args, gchar*);
2487     }
2488   va_end (var_args);
2489
2490   return object;
2491 }
2492
2493 /**
2494  * g_object_disconnect: (skip)
2495  * @object: a #GObject
2496  * @signal_spec: the spec for the first signal
2497  * @...: #GCallback for the first signal, followed by data for the first signal,
2498  *  followed optionally by more signal spec/callback/data triples,
2499  *  followed by %NULL
2500  *
2501  * A convenience function to disconnect multiple signals at once.
2502  *
2503  * The signal specs expected by this function have the form
2504  * "any_signal", which means to disconnect any signal with matching
2505  * callback and data, or "any_signal::signal_name", which only
2506  * disconnects the signal named "signal_name".
2507  */
2508 void
2509 g_object_disconnect (gpointer     _object,
2510                      const gchar *signal_spec,
2511                      ...)
2512 {
2513   GObject *object = _object;
2514   va_list var_args;
2515
2516   g_return_if_fail (G_IS_OBJECT (object));
2517   g_return_if_fail (object->ref_count > 0);
2518
2519   va_start (var_args, signal_spec);
2520   while (signal_spec)
2521     {
2522       GCallback callback = va_arg (var_args, GCallback);
2523       gpointer data = va_arg (var_args, gpointer);
2524       guint sid = 0, detail = 0, mask = 0;
2525
2526       if (strncmp (signal_spec, "any_signal::", 12) == 0 ||
2527           strncmp (signal_spec, "any-signal::", 12) == 0)
2528         {
2529           signal_spec += 12;
2530           mask = G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2531         }
2532       else if (strcmp (signal_spec, "any_signal") == 0 ||
2533                strcmp (signal_spec, "any-signal") == 0)
2534         {
2535           signal_spec += 10;
2536           mask = G_SIGNAL_MATCH_FUNC | G_SIGNAL_MATCH_DATA;
2537         }
2538       else
2539         {
2540           g_warning ("%s: invalid signal spec \"%s\"", G_STRFUNC, signal_spec);
2541           break;
2542         }
2543
2544       if ((mask & G_SIGNAL_MATCH_ID) &&
2545           !g_signal_parse_name (signal_spec, G_OBJECT_TYPE (object), &sid, &detail, FALSE))
2546         g_warning ("%s: invalid signal name \"%s\"", G_STRFUNC, signal_spec);
2547       else if (!g_signal_handlers_disconnect_matched (object, mask | (detail ? G_SIGNAL_MATCH_DETAIL : 0),
2548                                                       sid, detail,
2549                                                       NULL, (gpointer)callback, data))
2550         g_warning ("%s: signal handler %p(%p) is not connected", G_STRFUNC, callback, data);
2551       signal_spec = va_arg (var_args, gchar*);
2552     }
2553   va_end (var_args);
2554 }
2555
2556 typedef struct {
2557   GObject *object;
2558   guint n_weak_refs;
2559   struct {
2560     GWeakNotify notify;
2561     gpointer    data;
2562   } weak_refs[1];  /* flexible array */
2563 } WeakRefStack;
2564
2565 static void
2566 weak_refs_notify (gpointer data)
2567 {
2568   WeakRefStack *wstack = data;
2569   guint i;
2570
2571   for (i = 0; i < wstack->n_weak_refs; i++)
2572     wstack->weak_refs[i].notify (wstack->weak_refs[i].data, wstack->object);
2573   g_free (wstack);
2574 }
2575
2576 /**
2577  * g_object_weak_ref: (skip)
2578  * @object: #GObject to reference weakly
2579  * @notify: callback to invoke before the object is freed
2580  * @data: extra data to pass to notify
2581  *
2582  * Adds a weak reference callback to an object. Weak references are
2583  * used for notification when an object is finalized. They are called
2584  * "weak references" because they allow you to safely hold a pointer
2585  * to an object without calling g_object_ref() (g_object_ref() adds a
2586  * strong reference, that is, forces the object to stay alive).
2587  *
2588  * Note that the weak references created by this method are not
2589  * thread-safe: they cannot safely be used in one thread if the
2590  * object's last g_object_unref() might happen in another thread.
2591  * Use #GWeakRef if thread-safety is required.
2592  */
2593 void
2594 g_object_weak_ref (GObject    *object,
2595                    GWeakNotify notify,
2596                    gpointer    data)
2597 {
2598   WeakRefStack *wstack;
2599   guint i;
2600
2601   g_return_if_fail (G_IS_OBJECT (object));
2602   g_return_if_fail (notify != NULL);
2603   g_return_if_fail (object->ref_count >= 1);
2604
2605   G_LOCK (weak_refs_mutex);
2606   wstack = g_datalist_id_remove_no_notify (&object->qdata, quark_weak_refs);
2607   if (wstack)
2608     {
2609       i = wstack->n_weak_refs++;
2610       wstack = g_realloc (wstack, sizeof (*wstack) + sizeof (wstack->weak_refs[0]) * i);
2611     }
2612   else
2613     {
2614       wstack = g_renew (WeakRefStack, NULL, 1);
2615       wstack->object = object;
2616       wstack->n_weak_refs = 1;
2617       i = 0;
2618     }
2619   wstack->weak_refs[i].notify = notify;
2620   wstack->weak_refs[i].data = data;
2621   g_datalist_id_set_data_full (&object->qdata, quark_weak_refs, wstack, weak_refs_notify);
2622   G_UNLOCK (weak_refs_mutex);
2623 }
2624
2625 /**
2626  * g_object_weak_unref: (skip)
2627  * @object: #GObject to remove a weak reference from
2628  * @notify: callback to search for
2629  * @data: data to search for
2630  *
2631  * Removes a weak reference callback to an object.
2632  */
2633 void
2634 g_object_weak_unref (GObject    *object,
2635                      GWeakNotify notify,
2636                      gpointer    data)
2637 {
2638   WeakRefStack *wstack;
2639   gboolean found_one = FALSE;
2640
2641   g_return_if_fail (G_IS_OBJECT (object));
2642   g_return_if_fail (notify != NULL);
2643
2644   G_LOCK (weak_refs_mutex);
2645   wstack = g_datalist_id_get_data (&object->qdata, quark_weak_refs);
2646   if (wstack)
2647     {
2648       guint i;
2649
2650       for (i = 0; i < wstack->n_weak_refs; i++)
2651         if (wstack->weak_refs[i].notify == notify &&
2652             wstack->weak_refs[i].data == data)
2653           {
2654             found_one = TRUE;
2655             wstack->n_weak_refs -= 1;
2656             if (i != wstack->n_weak_refs)
2657               wstack->weak_refs[i] = wstack->weak_refs[wstack->n_weak_refs];
2658
2659             break;
2660           }
2661     }
2662   G_UNLOCK (weak_refs_mutex);
2663   if (!found_one)
2664     g_warning ("%s: couldn't find weak ref %p(%p)", G_STRFUNC, notify, data);
2665 }
2666
2667 /**
2668  * g_object_add_weak_pointer: (skip)
2669  * @object: The object that should be weak referenced.
2670  * @weak_pointer_location: (inout): The memory address of a pointer.
2671  *
2672  * Adds a weak reference from weak_pointer to @object to indicate that
2673  * the pointer located at @weak_pointer_location is only valid during
2674  * the lifetime of @object. When the @object is finalized,
2675  * @weak_pointer will be set to %NULL.
2676  *
2677  * Note that as with g_object_weak_ref(), the weak references created by
2678  * this method are not thread-safe: they cannot safely be used in one
2679  * thread if the object's last g_object_unref() might happen in another
2680  * thread. Use #GWeakRef if thread-safety is required.
2681  */
2682 void
2683 g_object_add_weak_pointer (GObject  *object,
2684                            gpointer *weak_pointer_location)
2685 {
2686   g_return_if_fail (G_IS_OBJECT (object));
2687   g_return_if_fail (weak_pointer_location != NULL);
2688
2689   g_object_weak_ref (object,
2690                      (GWeakNotify) g_nullify_pointer,
2691                      weak_pointer_location);
2692 }
2693
2694 /**
2695  * g_object_remove_weak_pointer: (skip)
2696  * @object: The object that is weak referenced.
2697  * @weak_pointer_location: (inout): The memory address of a pointer.
2698  *
2699  * Removes a weak reference from @object that was previously added
2700  * using g_object_add_weak_pointer(). The @weak_pointer_location has
2701  * to match the one used with g_object_add_weak_pointer().
2702  */
2703 void
2704 g_object_remove_weak_pointer (GObject  *object,
2705                               gpointer *weak_pointer_location)
2706 {
2707   g_return_if_fail (G_IS_OBJECT (object));
2708   g_return_if_fail (weak_pointer_location != NULL);
2709
2710   g_object_weak_unref (object,
2711                        (GWeakNotify) g_nullify_pointer,
2712                        weak_pointer_location);
2713 }
2714
2715 static guint
2716 object_floating_flag_handler (GObject        *object,
2717                               gint            job)
2718 {
2719   switch (job)
2720     {
2721       gpointer oldvalue;
2722     case +1:    /* force floating if possible */
2723       do
2724         oldvalue = g_atomic_pointer_get (&object->qdata);
2725       while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2726                                                      (gpointer) ((gsize) oldvalue | OBJECT_FLOATING_FLAG)));
2727       return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2728     case -1:    /* sink if possible */
2729       do
2730         oldvalue = g_atomic_pointer_get (&object->qdata);
2731       while (!g_atomic_pointer_compare_and_exchange ((void**) &object->qdata, oldvalue,
2732                                                      (gpointer) ((gsize) oldvalue & ~(gsize) OBJECT_FLOATING_FLAG)));
2733       return (gsize) oldvalue & OBJECT_FLOATING_FLAG;
2734     default:    /* check floating */
2735       return 0 != ((gsize) g_atomic_pointer_get (&object->qdata) & OBJECT_FLOATING_FLAG);
2736     }
2737 }
2738
2739 /**
2740  * g_object_is_floating:
2741  * @object: (type GObject.Object): a #GObject
2742  *
2743  * Checks whether @object has a [floating][floating-ref] reference.
2744  *
2745  * Since: 2.10
2746  *
2747  * Returns: %TRUE if @object has a floating reference
2748  */
2749 gboolean
2750 g_object_is_floating (gpointer _object)
2751 {
2752   GObject *object = _object;
2753   g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
2754   return floating_flag_handler (object, 0);
2755 }
2756
2757 /**
2758  * g_object_ref_sink:
2759  * @object: (type GObject.Object): a #GObject
2760  *
2761  * Increase the reference count of @object, and possibly remove the
2762  * [floating][floating-ref] reference, if @object has a floating reference.
2763  *
2764  * In other words, if the object is floating, then this call "assumes
2765  * ownership" of the floating reference, converting it to a normal
2766  * reference by clearing the floating flag while leaving the reference
2767  * count unchanged.  If the object is not floating, then this call
2768  * adds a new normal reference increasing the reference count by one.
2769  *
2770  * Since: 2.10
2771  *
2772  * Returns: (type GObject.Object) (transfer none): @object
2773  */
2774 gpointer
2775 g_object_ref_sink (gpointer _object)
2776 {
2777   GObject *object = _object;
2778   gboolean was_floating;
2779   g_return_val_if_fail (G_IS_OBJECT (object), object);
2780   g_return_val_if_fail (object->ref_count >= 1, object);
2781   g_object_ref (object);
2782   was_floating = floating_flag_handler (object, -1);
2783   if (was_floating)
2784     g_object_unref (object);
2785   return object;
2786 }
2787
2788 /**
2789  * g_object_force_floating:
2790  * @object: a #GObject
2791  *
2792  * This function is intended for #GObject implementations to re-enforce
2793  * a [floating][floating-ref] object reference. Doing this is seldom
2794  * required: all #GInitiallyUnowneds are created with a floating reference
2795  * which usually just needs to be sunken by calling g_object_ref_sink().
2796  *
2797  * Since: 2.10
2798  */
2799 void
2800 g_object_force_floating (GObject *object)
2801 {
2802   g_return_if_fail (G_IS_OBJECT (object));
2803   g_return_if_fail (object->ref_count >= 1);
2804
2805   floating_flag_handler (object, +1);
2806 }
2807
2808 typedef struct {
2809   GObject *object;
2810   guint n_toggle_refs;
2811   struct {
2812     GToggleNotify notify;
2813     gpointer    data;
2814   } toggle_refs[1];  /* flexible array */
2815 } ToggleRefStack;
2816
2817 static void
2818 toggle_refs_notify (GObject *object,
2819                     gboolean is_last_ref)
2820 {
2821   ToggleRefStack tstack, *tstackptr;
2822
2823   G_LOCK (toggle_refs_mutex);
2824   tstackptr = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2825   tstack = *tstackptr;
2826   G_UNLOCK (toggle_refs_mutex);
2827
2828   /* Reentrancy here is not as tricky as it seems, because a toggle reference
2829    * will only be notified when there is exactly one of them.
2830    */
2831   g_assert (tstack.n_toggle_refs == 1);
2832   tstack.toggle_refs[0].notify (tstack.toggle_refs[0].data, tstack.object, is_last_ref);
2833 }
2834
2835 /**
2836  * g_object_add_toggle_ref: (skip)
2837  * @object: a #GObject
2838  * @notify: a function to call when this reference is the
2839  *  last reference to the object, or is no longer
2840  *  the last reference.
2841  * @data: data to pass to @notify
2842  *
2843  * Increases the reference count of the object by one and sets a
2844  * callback to be called when all other references to the object are
2845  * dropped, or when this is already the last reference to the object
2846  * and another reference is established.
2847  *
2848  * This functionality is intended for binding @object to a proxy
2849  * object managed by another memory manager. This is done with two
2850  * paired references: the strong reference added by
2851  * g_object_add_toggle_ref() and a reverse reference to the proxy
2852  * object which is either a strong reference or weak reference.
2853  *
2854  * The setup is that when there are no other references to @object,
2855  * only a weak reference is held in the reverse direction from @object
2856  * to the proxy object, but when there are other references held to
2857  * @object, a strong reference is held. The @notify callback is called
2858  * when the reference from @object to the proxy object should be
2859  * "toggled" from strong to weak (@is_last_ref true) or weak to strong
2860  * (@is_last_ref false).
2861  *
2862  * Since a (normal) reference must be held to the object before
2863  * calling g_object_add_toggle_ref(), the initial state of the reverse
2864  * link is always strong.
2865  *
2866  * Multiple toggle references may be added to the same gobject,
2867  * however if there are multiple toggle references to an object, none
2868  * of them will ever be notified until all but one are removed.  For
2869  * this reason, you should only ever use a toggle reference if there
2870  * is important state in the proxy object.
2871  *
2872  * Since: 2.8
2873  */
2874 void
2875 g_object_add_toggle_ref (GObject       *object,
2876                          GToggleNotify  notify,
2877                          gpointer       data)
2878 {
2879   ToggleRefStack *tstack;
2880   guint i;
2881
2882   g_return_if_fail (G_IS_OBJECT (object));
2883   g_return_if_fail (notify != NULL);
2884   g_return_if_fail (object->ref_count >= 1);
2885
2886   g_object_ref (object);
2887
2888   G_LOCK (toggle_refs_mutex);
2889   tstack = g_datalist_id_remove_no_notify (&object->qdata, quark_toggle_refs);
2890   if (tstack)
2891     {
2892       i = tstack->n_toggle_refs++;
2893       /* allocate i = tstate->n_toggle_refs - 1 positions beyond the 1 declared
2894        * in tstate->toggle_refs */
2895       tstack = g_realloc (tstack, sizeof (*tstack) + sizeof (tstack->toggle_refs[0]) * i);
2896     }
2897   else
2898     {
2899       tstack = g_renew (ToggleRefStack, NULL, 1);
2900       tstack->object = object;
2901       tstack->n_toggle_refs = 1;
2902       i = 0;
2903     }
2904
2905   /* Set a flag for fast lookup after adding the first toggle reference */
2906   if (tstack->n_toggle_refs == 1)
2907     g_datalist_set_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2908
2909   tstack->toggle_refs[i].notify = notify;
2910   tstack->toggle_refs[i].data = data;
2911   g_datalist_id_set_data_full (&object->qdata, quark_toggle_refs, tstack,
2912                                (GDestroyNotify)g_free);
2913   G_UNLOCK (toggle_refs_mutex);
2914 }
2915
2916 /**
2917  * g_object_remove_toggle_ref: (skip)
2918  * @object: a #GObject
2919  * @notify: a function to call when this reference is the
2920  *  last reference to the object, or is no longer
2921  *  the last reference.
2922  * @data: data to pass to @notify
2923  *
2924  * Removes a reference added with g_object_add_toggle_ref(). The
2925  * reference count of the object is decreased by one.
2926  *
2927  * Since: 2.8
2928  */
2929 void
2930 g_object_remove_toggle_ref (GObject       *object,
2931                             GToggleNotify  notify,
2932                             gpointer       data)
2933 {
2934   ToggleRefStack *tstack;
2935   gboolean found_one = FALSE;
2936
2937   g_return_if_fail (G_IS_OBJECT (object));
2938   g_return_if_fail (notify != NULL);
2939
2940   G_LOCK (toggle_refs_mutex);
2941   tstack = g_datalist_id_get_data (&object->qdata, quark_toggle_refs);
2942   if (tstack)
2943     {
2944       guint i;
2945
2946       for (i = 0; i < tstack->n_toggle_refs; i++)
2947         if (tstack->toggle_refs[i].notify == notify &&
2948             tstack->toggle_refs[i].data == data)
2949           {
2950             found_one = TRUE;
2951             tstack->n_toggle_refs -= 1;
2952             if (i != tstack->n_toggle_refs)
2953               tstack->toggle_refs[i] = tstack->toggle_refs[tstack->n_toggle_refs];
2954
2955             if (tstack->n_toggle_refs == 0)
2956               g_datalist_unset_flags (&object->qdata, OBJECT_HAS_TOGGLE_REF_FLAG);
2957
2958             break;
2959           }
2960     }
2961   G_UNLOCK (toggle_refs_mutex);
2962
2963   if (found_one)
2964     g_object_unref (object);
2965   else
2966     g_warning ("%s: couldn't find toggle ref %p(%p)", G_STRFUNC, notify, data);
2967 }
2968
2969 /**
2970  * g_object_ref:
2971  * @object: (type GObject.Object): a #GObject
2972  *
2973  * Increases the reference count of @object.
2974  *
2975  * Returns: (type GObject.Object) (transfer none): the same @object
2976  */
2977 gpointer
2978 g_object_ref (gpointer _object)
2979 {
2980   GObject *object = _object;
2981   gint old_val;
2982
2983   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
2984   g_return_val_if_fail (object->ref_count > 0, NULL);
2985
2986   old_val = g_atomic_int_add (&object->ref_count, 1);
2987
2988   if (old_val == 1 && OBJECT_HAS_TOGGLE_REF (object))
2989     toggle_refs_notify (object, FALSE);
2990
2991   TRACE (GOBJECT_OBJECT_REF(object,G_TYPE_FROM_INSTANCE(object),old_val));
2992
2993   return object;
2994 }
2995
2996 /**
2997  * g_object_unref:
2998  * @object: (type GObject.Object): a #GObject
2999  *
3000  * Decreases the reference count of @object. When its reference count
3001  * drops to 0, the object is finalized (i.e. its memory is freed).
3002  */
3003 void
3004 g_object_unref (gpointer _object)
3005 {
3006   GObject *object = _object;
3007   gint old_ref;
3008
3009   g_return_if_fail (G_IS_OBJECT (object));
3010   g_return_if_fail (object->ref_count > 0);
3011
3012   /* here we want to atomically do: if (ref_count>1) { ref_count--; return; } */
3013  retry_atomic_decrement1:
3014   old_ref = g_atomic_int_get (&object->ref_count);
3015   if (old_ref > 1)
3016     {
3017       /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
3018       gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
3019
3020       if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
3021         goto retry_atomic_decrement1;
3022
3023       TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
3024
3025       /* if we went from 2->1 we need to notify toggle refs if any */
3026       if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
3027         toggle_refs_notify (object, TRUE);
3028     }
3029   else
3030     {
3031       GSList **weak_locations;
3032
3033       /* The only way that this object can live at this point is if
3034        * there are outstanding weak references already established
3035        * before we got here.
3036        *
3037        * If there were not already weak references then no more can be
3038        * established at this time, because the other thread would have
3039        * to hold a strong ref in order to call
3040        * g_object_add_weak_pointer() and then we wouldn't be here.
3041        */
3042       weak_locations = g_datalist_id_get_data (&object->qdata, quark_weak_locations);
3043
3044       if (weak_locations != NULL)
3045         {
3046           g_rw_lock_writer_lock (&weak_locations_lock);
3047
3048           /* It is possible that one of the weak references beat us to
3049            * the lock. Make sure the refcount is still what we expected
3050            * it to be.
3051            */
3052           old_ref = g_atomic_int_get (&object->ref_count);
3053           if (old_ref != 1)
3054             {
3055               g_rw_lock_writer_unlock (&weak_locations_lock);
3056               goto retry_atomic_decrement1;
3057             }
3058
3059           /* We got the lock first, so the object will definitely die
3060            * now. Clear out all the weak references.
3061            */
3062           while (*weak_locations)
3063             {
3064               GWeakRef *weak_ref_location = (*weak_locations)->data;
3065
3066               weak_ref_location->priv.p = NULL;
3067               *weak_locations = g_slist_delete_link (*weak_locations, *weak_locations);
3068             }
3069
3070           g_rw_lock_writer_unlock (&weak_locations_lock);
3071         }
3072
3073       /* we are about to remove the last reference */
3074       TRACE (GOBJECT_OBJECT_DISPOSE(object,G_TYPE_FROM_INSTANCE(object), 1));
3075       G_OBJECT_GET_CLASS (object)->dispose (object);
3076       TRACE (GOBJECT_OBJECT_DISPOSE_END(object,G_TYPE_FROM_INSTANCE(object), 1));
3077
3078       /* may have been re-referenced meanwhile */
3079     retry_atomic_decrement2:
3080       old_ref = g_atomic_int_get ((int *)&object->ref_count);
3081       if (old_ref > 1)
3082         {
3083           /* valid if last 2 refs are owned by this call to unref and the toggle_ref */
3084           gboolean has_toggle_ref = OBJECT_HAS_TOGGLE_REF (object);
3085
3086           if (!g_atomic_int_compare_and_exchange ((int *)&object->ref_count, old_ref, old_ref - 1))
3087             goto retry_atomic_decrement2;
3088
3089           TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
3090
3091           /* if we went from 2->1 we need to notify toggle refs if any */
3092           if (old_ref == 2 && has_toggle_ref) /* The last ref being held in this case is owned by the toggle_ref */
3093             toggle_refs_notify (object, TRUE);
3094
3095           return;
3096         }
3097
3098       /* we are still in the process of taking away the last ref */
3099       g_datalist_id_set_data (&object->qdata, quark_closure_array, NULL);
3100       g_signal_handlers_destroy (object);
3101       g_datalist_id_set_data (&object->qdata, quark_weak_refs, NULL);
3102
3103       /* decrement the last reference */
3104       old_ref = g_atomic_int_add (&object->ref_count, -1);
3105
3106       TRACE (GOBJECT_OBJECT_UNREF(object,G_TYPE_FROM_INSTANCE(object),old_ref));
3107
3108       /* may have been re-referenced meanwhile */
3109       if (G_LIKELY (old_ref == 1))
3110         {
3111           TRACE (GOBJECT_OBJECT_FINALIZE(object,G_TYPE_FROM_INSTANCE(object)));
3112           G_OBJECT_GET_CLASS (object)->finalize (object);
3113
3114           TRACE (GOBJECT_OBJECT_FINALIZE_END(object,G_TYPE_FROM_INSTANCE(object)));
3115
3116 #ifdef  G_ENABLE_DEBUG
3117           IF_DEBUG (OBJECTS)
3118             {
3119               /* catch objects not chaining finalize handlers */
3120               G_LOCK (debug_objects);
3121               g_assert (g_hash_table_lookup (debug_objects_ht, object) == NULL);
3122               G_UNLOCK (debug_objects);
3123             }
3124 #endif  /* G_ENABLE_DEBUG */
3125           g_type_free_instance ((GTypeInstance*) object);
3126         }
3127     }
3128 }
3129
3130 /**
3131  * g_clear_object: (skip)
3132  * @object_ptr: a pointer to a #GObject reference
3133  *
3134  * Clears a reference to a #GObject.
3135  *
3136  * @object_ptr must not be %NULL.
3137  *
3138  * If the reference is %NULL then this function does nothing.
3139  * Otherwise, the reference count of the object is decreased and the
3140  * pointer is set to %NULL.
3141  *
3142  * This function is threadsafe and modifies the pointer atomically,
3143  * using memory barriers where needed.
3144  *
3145  * A macro is also included that allows this function to be used without
3146  * pointer casts.
3147  *
3148  * Since: 2.28
3149  **/
3150 #undef g_clear_object
3151 void
3152 g_clear_object (volatile GObject **object_ptr)
3153 {
3154   g_clear_pointer (object_ptr, g_object_unref);
3155 }
3156
3157 /**
3158  * g_object_get_qdata:
3159  * @object: The GObject to get a stored user data pointer from
3160  * @quark: A #GQuark, naming the user data pointer
3161  *
3162  * This function gets back user data pointers stored via
3163  * g_object_set_qdata().
3164  *
3165  * Returns: (transfer none): The user data pointer set, or %NULL
3166  */
3167 gpointer
3168 g_object_get_qdata (GObject *object,
3169                     GQuark   quark)
3170 {
3171   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3172
3173   return quark ? g_datalist_id_get_data (&object->qdata, quark) : NULL;
3174 }
3175
3176 /**
3177  * g_object_set_qdata: (skip)
3178  * @object: The GObject to set store a user data pointer
3179  * @quark: A #GQuark, naming the user data pointer
3180  * @data: An opaque user data pointer
3181  *
3182  * This sets an opaque, named pointer on an object.
3183  * The name is specified through a #GQuark (retrived e.g. via
3184  * g_quark_from_static_string()), and the pointer
3185  * can be gotten back from the @object with g_object_get_qdata()
3186  * until the @object is finalized.
3187  * Setting a previously set user data pointer, overrides (frees)
3188  * the old pointer set, using #NULL as pointer essentially
3189  * removes the data stored.
3190  */
3191 void
3192 g_object_set_qdata (GObject *object,
3193                     GQuark   quark,
3194                     gpointer data)
3195 {
3196   g_return_if_fail (G_IS_OBJECT (object));
3197   g_return_if_fail (quark > 0);
3198
3199   g_datalist_id_set_data (&object->qdata, quark, data);
3200 }
3201
3202 /**
3203  * g_object_dup_qdata:
3204  * @object: the #GObject to store user data on
3205  * @quark: a #GQuark, naming the user data pointer
3206  * @dup_func: (allow-none): function to dup the value
3207  * @user_data: (allow-none): passed as user_data to @dup_func
3208  *
3209  * This is a variant of g_object_get_qdata() which returns
3210  * a 'duplicate' of the value. @dup_func defines the
3211  * meaning of 'duplicate' in this context, it could e.g.
3212  * take a reference on a ref-counted object.
3213  *
3214  * If the @quark is not set on the object then @dup_func
3215  * will be called with a %NULL argument.
3216  *
3217  * Note that @dup_func is called while user data of @object
3218  * is locked.
3219  *
3220  * This function can be useful to avoid races when multiple
3221  * threads are using object data on the same key on the same
3222  * object.
3223  *
3224  * Returns: the result of calling @dup_func on the value
3225  *     associated with @quark on @object, or %NULL if not set.
3226  *     If @dup_func is %NULL, the value is returned
3227  *     unmodified.
3228  *
3229  * Since: 2.34
3230  */
3231 gpointer
3232 g_object_dup_qdata (GObject        *object,
3233                     GQuark          quark,
3234                     GDuplicateFunc   dup_func,
3235                     gpointer         user_data)
3236 {
3237   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3238   g_return_val_if_fail (quark > 0, NULL);
3239
3240   return g_datalist_id_dup_data (&object->qdata, quark, dup_func, user_data);
3241 }
3242
3243 /**
3244  * g_object_replace_qdata:
3245  * @object: the #GObject to store user data on
3246  * @quark: a #GQuark, naming the user data pointer
3247  * @oldval: (allow-none): the old value to compare against
3248  * @newval: (allow-none): the new value
3249  * @destroy: (allow-none): a destroy notify for the new value
3250  * @old_destroy: (allow-none): destroy notify for the existing value
3251  *
3252  * Compares the user data for the key @quark on @object with
3253  * @oldval, and if they are the same, replaces @oldval with
3254  * @newval.
3255  *
3256  * This is like a typical atomic compare-and-exchange
3257  * operation, for user data on an object.
3258  *
3259  * If the previous value was replaced then ownership of the
3260  * old value (@oldval) is passed to the caller, including
3261  * the registered destroy notify for it (passed out in @old_destroy).
3262  * Its up to the caller to free this as he wishes, which may
3263  * or may not include using @old_destroy as sometimes replacement
3264  * should not destroy the object in the normal way.
3265  *
3266  * Return: %TRUE if the existing value for @quark was replaced
3267  *  by @newval, %FALSE otherwise.
3268  *
3269  * Since: 2.34
3270  */
3271 gboolean
3272 g_object_replace_qdata (GObject        *object,
3273                         GQuark          quark,
3274                         gpointer        oldval,
3275                         gpointer        newval,
3276                         GDestroyNotify  destroy,
3277                         GDestroyNotify *old_destroy)
3278 {
3279   g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
3280   g_return_val_if_fail (quark > 0, FALSE);
3281
3282   return g_datalist_id_replace_data (&object->qdata, quark,
3283                                      oldval, newval, destroy,
3284                                      old_destroy);
3285 }
3286
3287 /**
3288  * g_object_set_qdata_full: (skip)
3289  * @object: The GObject to set store a user data pointer
3290  * @quark: A #GQuark, naming the user data pointer
3291  * @data: An opaque user data pointer
3292  * @destroy: Function to invoke with @data as argument, when @data
3293  *           needs to be freed
3294  *
3295  * This function works like g_object_set_qdata(), but in addition,
3296  * a void (*destroy) (gpointer) function may be specified which is
3297  * called with @data as argument when the @object is finalized, or
3298  * the data is being overwritten by a call to g_object_set_qdata()
3299  * with the same @quark.
3300  */
3301 void
3302 g_object_set_qdata_full (GObject       *object,
3303                          GQuark         quark,
3304                          gpointer       data,
3305                          GDestroyNotify destroy)
3306 {
3307   g_return_if_fail (G_IS_OBJECT (object));
3308   g_return_if_fail (quark > 0);
3309
3310   g_datalist_id_set_data_full (&object->qdata, quark, data,
3311                                data ? destroy : (GDestroyNotify) NULL);
3312 }
3313
3314 /**
3315  * g_object_steal_qdata:
3316  * @object: The GObject to get a stored user data pointer from
3317  * @quark: A #GQuark, naming the user data pointer
3318  *
3319  * This function gets back user data pointers stored via
3320  * g_object_set_qdata() and removes the @data from object
3321  * without invoking its destroy() function (if any was
3322  * set).
3323  * Usually, calling this function is only required to update
3324  * user data pointers with a destroy notifier, for example:
3325  * |[<!-- language="C" -->
3326  * void
3327  * object_add_to_user_list (GObject     *object,
3328  *                          const gchar *new_string)
3329  * {
3330  *   // the quark, naming the object data
3331  *   GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
3332  *   // retrive the old string list
3333  *   GList *list = g_object_steal_qdata (object, quark_string_list);
3334  *
3335  *   // prepend new string
3336  *   list = g_list_prepend (list, g_strdup (new_string));
3337  *   // this changed 'list', so we need to set it again
3338  *   g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
3339  * }
3340  * static void
3341  * free_string_list (gpointer data)
3342  * {
3343  *   GList *node, *list = data;
3344  *
3345  *   for (node = list; node; node = node->next)
3346  *     g_free (node->data);
3347  *   g_list_free (list);
3348  * }
3349  * ]|
3350  * Using g_object_get_qdata() in the above example, instead of
3351  * g_object_steal_qdata() would have left the destroy function set,
3352  * and thus the partial string list would have been freed upon
3353  * g_object_set_qdata_full().
3354  *
3355  * Returns: (transfer full): The user data pointer set, or %NULL
3356  */
3357 gpointer
3358 g_object_steal_qdata (GObject *object,
3359                       GQuark   quark)
3360 {
3361   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3362   g_return_val_if_fail (quark > 0, NULL);
3363
3364   return g_datalist_id_remove_no_notify (&object->qdata, quark);
3365 }
3366
3367 /**
3368  * g_object_get_data:
3369  * @object: #GObject containing the associations
3370  * @key: name of the key for that association
3371  *
3372  * Gets a named field from the objects table of associations (see g_object_set_data()).
3373  *
3374  * Returns: (transfer none): the data if found, or %NULL if no such data exists.
3375  */
3376 gpointer
3377 g_object_get_data (GObject     *object,
3378                    const gchar *key)
3379 {
3380   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3381   g_return_val_if_fail (key != NULL, NULL);
3382
3383   return g_datalist_get_data (&object->qdata, key);
3384 }
3385
3386 /**
3387  * g_object_set_data:
3388  * @object: #GObject containing the associations.
3389  * @key: name of the key
3390  * @data: data to associate with that key
3391  *
3392  * Each object carries around a table of associations from
3393  * strings to pointers.  This function lets you set an association.
3394  *
3395  * If the object already had an association with that name,
3396  * the old association will be destroyed.
3397  */
3398 void
3399 g_object_set_data (GObject     *object,
3400                    const gchar *key,
3401                    gpointer     data)
3402 {
3403   g_return_if_fail (G_IS_OBJECT (object));
3404   g_return_if_fail (key != NULL);
3405
3406   g_datalist_id_set_data (&object->qdata, g_quark_from_string (key), data);
3407 }
3408
3409 /**
3410  * g_object_dup_data:
3411  * @object: the #GObject to store user data on
3412  * @key: a string, naming the user data pointer
3413  * @dup_func: (allow-none): function to dup the value
3414  * @user_data: (allow-none): passed as user_data to @dup_func
3415  *
3416  * This is a variant of g_object_get_data() which returns
3417  * a 'duplicate' of the value. @dup_func defines the
3418  * meaning of 'duplicate' in this context, it could e.g.
3419  * take a reference on a ref-counted object.
3420  *
3421  * If the @key is not set on the object then @dup_func
3422  * will be called with a %NULL argument.
3423  *
3424  * Note that @dup_func is called while user data of @object
3425  * is locked.
3426  *
3427  * This function can be useful to avoid races when multiple
3428  * threads are using object data on the same key on the same
3429  * object.
3430  *
3431  * Returns: the result of calling @dup_func on the value
3432  *     associated with @key on @object, or %NULL if not set.
3433  *     If @dup_func is %NULL, the value is returned
3434  *     unmodified.
3435  *
3436  * Since: 2.34
3437  */
3438 gpointer
3439 g_object_dup_data (GObject        *object,
3440                    const gchar    *key,
3441                    GDuplicateFunc   dup_func,
3442                    gpointer         user_data)
3443 {
3444   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3445   g_return_val_if_fail (key != NULL, NULL);
3446
3447   return g_datalist_id_dup_data (&object->qdata,
3448                                  g_quark_from_string (key),
3449                                  dup_func, user_data);
3450 }
3451
3452 /**
3453  * g_object_replace_data:
3454  * @object: the #GObject to store user data on
3455  * @key: a string, naming the user data pointer
3456  * @oldval: (allow-none): the old value to compare against
3457  * @newval: (allow-none): the new value
3458  * @destroy: (allow-none): a destroy notify for the new value
3459  * @old_destroy: (allow-none): destroy notify for the existing value
3460  *
3461  * Compares the user data for the key @key on @object with
3462  * @oldval, and if they are the same, replaces @oldval with
3463  * @newval.
3464  *
3465  * This is like a typical atomic compare-and-exchange
3466  * operation, for user data on an object.
3467  *
3468  * If the previous value was replaced then ownership of the
3469  * old value (@oldval) is passed to the caller, including
3470  * the registered destroy notify for it (passed out in @old_destroy).
3471  * Its up to the caller to free this as he wishes, which may
3472  * or may not include using @old_destroy as sometimes replacement
3473  * should not destroy the object in the normal way.
3474  *
3475  * Return: %TRUE if the existing value for @key was replaced
3476  *  by @newval, %FALSE otherwise.
3477  *
3478  * Since: 2.34
3479  */
3480 gboolean
3481 g_object_replace_data (GObject        *object,
3482                        const gchar    *key,
3483                        gpointer        oldval,
3484                        gpointer        newval,
3485                        GDestroyNotify  destroy,
3486                        GDestroyNotify *old_destroy)
3487 {
3488   g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
3489   g_return_val_if_fail (key != NULL, FALSE);
3490
3491   return g_datalist_id_replace_data (&object->qdata,
3492                                      g_quark_from_string (key),
3493                                      oldval, newval, destroy,
3494                                      old_destroy);
3495 }
3496
3497 /**
3498  * g_object_set_data_full: (skip)
3499  * @object: #GObject containing the associations
3500  * @key: name of the key
3501  * @data: data to associate with that key
3502  * @destroy: function to call when the association is destroyed
3503  *
3504  * Like g_object_set_data() except it adds notification
3505  * for when the association is destroyed, either by setting it
3506  * to a different value or when the object is destroyed.
3507  *
3508  * Note that the @destroy callback is not called if @data is %NULL.
3509  */
3510 void
3511 g_object_set_data_full (GObject       *object,
3512                         const gchar   *key,
3513                         gpointer       data,
3514                         GDestroyNotify destroy)
3515 {
3516   g_return_if_fail (G_IS_OBJECT (object));
3517   g_return_if_fail (key != NULL);
3518
3519   g_datalist_id_set_data_full (&object->qdata, g_quark_from_string (key), data,
3520                                data ? destroy : (GDestroyNotify) NULL);
3521 }
3522
3523 /**
3524  * g_object_steal_data:
3525  * @object: #GObject containing the associations
3526  * @key: name of the key
3527  *
3528  * Remove a specified datum from the object's data associations,
3529  * without invoking the association's destroy handler.
3530  *
3531  * Returns: (transfer full): the data if found, or %NULL if no such data exists.
3532  */
3533 gpointer
3534 g_object_steal_data (GObject     *object,
3535                      const gchar *key)
3536 {
3537   GQuark quark;
3538
3539   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3540   g_return_val_if_fail (key != NULL, NULL);
3541
3542   quark = g_quark_try_string (key);
3543
3544   return quark ? g_datalist_id_remove_no_notify (&object->qdata, quark) : NULL;
3545 }
3546
3547 static void
3548 g_value_object_init (GValue *value)
3549 {
3550   value->data[0].v_pointer = NULL;
3551 }
3552
3553 static void
3554 g_value_object_free_value (GValue *value)
3555 {
3556   if (value->data[0].v_pointer)
3557     g_object_unref (value->data[0].v_pointer);
3558 }
3559
3560 static void
3561 g_value_object_copy_value (const GValue *src_value,
3562                            GValue       *dest_value)
3563 {
3564   if (src_value->data[0].v_pointer)
3565     dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3566   else
3567     dest_value->data[0].v_pointer = NULL;
3568 }
3569
3570 static void
3571 g_value_object_transform_value (const GValue *src_value,
3572                                 GValue       *dest_value)
3573 {
3574   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)))
3575     dest_value->data[0].v_pointer = g_object_ref (src_value->data[0].v_pointer);
3576   else
3577     dest_value->data[0].v_pointer = NULL;
3578 }
3579
3580 static gpointer
3581 g_value_object_peek_pointer (const GValue *value)
3582 {
3583   return value->data[0].v_pointer;
3584 }
3585
3586 static gchar*
3587 g_value_object_collect_value (GValue      *value,
3588                               guint        n_collect_values,
3589                               GTypeCValue *collect_values,
3590                               guint        collect_flags)
3591 {
3592   if (collect_values[0].v_pointer)
3593     {
3594       GObject *object = collect_values[0].v_pointer;
3595
3596       if (object->g_type_instance.g_class == NULL)
3597         return g_strconcat ("invalid unclassed object pointer for value type '",
3598                             G_VALUE_TYPE_NAME (value),
3599                             "'",
3600                             NULL);
3601       else if (!g_value_type_compatible (G_OBJECT_TYPE (object), G_VALUE_TYPE (value)))
3602         return g_strconcat ("invalid object type '",
3603                             G_OBJECT_TYPE_NAME (object),
3604                             "' for value type '",
3605                             G_VALUE_TYPE_NAME (value),
3606                             "'",
3607                             NULL);
3608       /* never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types */
3609       value->data[0].v_pointer = g_object_ref (object);
3610     }
3611   else
3612     value->data[0].v_pointer = NULL;
3613
3614   return NULL;
3615 }
3616
3617 static gchar*
3618 g_value_object_lcopy_value (const GValue *value,
3619                             guint        n_collect_values,
3620                             GTypeCValue *collect_values,
3621                             guint        collect_flags)
3622 {
3623   GObject **object_p = collect_values[0].v_pointer;
3624
3625   if (!object_p)
3626     return g_strdup_printf ("value location for '%s' passed as NULL", G_VALUE_TYPE_NAME (value));
3627
3628   if (!value->data[0].v_pointer)
3629     *object_p = NULL;
3630   else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
3631     *object_p = value->data[0].v_pointer;
3632   else
3633     *object_p = g_object_ref (value->data[0].v_pointer);
3634
3635   return NULL;
3636 }
3637
3638 /**
3639  * g_value_set_object:
3640  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3641  * @v_object: (type GObject.Object) (allow-none): object value to be set
3642  *
3643  * Set the contents of a %G_TYPE_OBJECT derived #GValue to @v_object.
3644  *
3645  * g_value_set_object() increases the reference count of @v_object
3646  * (the #GValue holds a reference to @v_object).  If you do not wish
3647  * to increase the reference count of the object (i.e. you wish to
3648  * pass your current reference to the #GValue because you no longer
3649  * need it), use g_value_take_object() instead.
3650  *
3651  * It is important that your #GValue holds a reference to @v_object (either its
3652  * own, or one it has taken) to ensure that the object won't be destroyed while
3653  * the #GValue still exists).
3654  */
3655 void
3656 g_value_set_object (GValue   *value,
3657                     gpointer  v_object)
3658 {
3659   GObject *old;
3660
3661   g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3662
3663   old = value->data[0].v_pointer;
3664
3665   if (v_object)
3666     {
3667       g_return_if_fail (G_IS_OBJECT (v_object));
3668       g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3669
3670       value->data[0].v_pointer = v_object;
3671       g_object_ref (value->data[0].v_pointer);
3672     }
3673   else
3674     value->data[0].v_pointer = NULL;
3675
3676   if (old)
3677     g_object_unref (old);
3678 }
3679
3680 /**
3681  * g_value_set_object_take_ownership: (skip)
3682  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3683  * @v_object: (allow-none): object value to be set
3684  *
3685  * This is an internal function introduced mainly for C marshallers.
3686  *
3687  * Deprecated: 2.4: Use g_value_take_object() instead.
3688  */
3689 void
3690 g_value_set_object_take_ownership (GValue  *value,
3691                                    gpointer v_object)
3692 {
3693   g_value_take_object (value, v_object);
3694 }
3695
3696 /**
3697  * g_value_take_object: (skip)
3698  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3699  * @v_object: (allow-none): object value to be set
3700  *
3701  * Sets the contents of a %G_TYPE_OBJECT derived #GValue to @v_object
3702  * and takes over the ownership of the callers reference to @v_object;
3703  * the caller doesn't have to unref it any more (i.e. the reference
3704  * count of the object is not increased).
3705  *
3706  * If you want the #GValue to hold its own reference to @v_object, use
3707  * g_value_set_object() instead.
3708  *
3709  * Since: 2.4
3710  */
3711 void
3712 g_value_take_object (GValue  *value,
3713                      gpointer v_object)
3714 {
3715   g_return_if_fail (G_VALUE_HOLDS_OBJECT (value));
3716
3717   if (value->data[0].v_pointer)
3718     {
3719       g_object_unref (value->data[0].v_pointer);
3720       value->data[0].v_pointer = NULL;
3721     }
3722
3723   if (v_object)
3724     {
3725       g_return_if_fail (G_IS_OBJECT (v_object));
3726       g_return_if_fail (g_value_type_compatible (G_OBJECT_TYPE (v_object), G_VALUE_TYPE (value)));
3727
3728       value->data[0].v_pointer = v_object; /* we take over the reference count */
3729     }
3730 }
3731
3732 /**
3733  * g_value_get_object:
3734  * @value: a valid #GValue of %G_TYPE_OBJECT derived type
3735  *
3736  * Get the contents of a %G_TYPE_OBJECT derived #GValue.
3737  *
3738  * Returns: (type GObject.Object) (transfer none): object contents of @value
3739  */
3740 gpointer
3741 g_value_get_object (const GValue *value)
3742 {
3743   g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3744
3745   return value->data[0].v_pointer;
3746 }
3747
3748 /**
3749  * g_value_dup_object:
3750  * @value: a valid #GValue whose type is derived from %G_TYPE_OBJECT
3751  *
3752  * Get the contents of a %G_TYPE_OBJECT derived #GValue, increasing
3753  * its reference count. If the contents of the #GValue are %NULL, then
3754  * %NULL will be returned.
3755  *
3756  * Returns: (type GObject.Object) (transfer full): object content of @value,
3757  *          should be unreferenced when no longer needed.
3758  */
3759 gpointer
3760 g_value_dup_object (const GValue *value)
3761 {
3762   g_return_val_if_fail (G_VALUE_HOLDS_OBJECT (value), NULL);
3763
3764   return value->data[0].v_pointer ? g_object_ref (value->data[0].v_pointer) : NULL;
3765 }
3766
3767 /**
3768  * g_signal_connect_object: (skip)
3769  * @instance: the instance to connect to.
3770  * @detailed_signal: a string of the form "signal-name::detail".
3771  * @c_handler: the #GCallback to connect.
3772  * @gobject: the object to pass as data to @c_handler.
3773  * @connect_flags: a combination of #GConnectFlags.
3774  *
3775  * This is similar to g_signal_connect_data(), but uses a closure which
3776  * ensures that the @gobject stays alive during the call to @c_handler
3777  * by temporarily adding a reference count to @gobject.
3778  *
3779  * When the @gobject is destroyed the signal handler will be automatically
3780  * disconnected.  Note that this is not currently threadsafe (ie:
3781  * emitting a signal while @gobject is being destroyed in another thread
3782  * is not safe).
3783  *
3784  * Returns: the handler id.
3785  */
3786 gulong
3787 g_signal_connect_object (gpointer      instance,
3788                          const gchar  *detailed_signal,
3789                          GCallback     c_handler,
3790                          gpointer      gobject,
3791                          GConnectFlags connect_flags)
3792 {
3793   g_return_val_if_fail (G_TYPE_CHECK_INSTANCE (instance), 0);
3794   g_return_val_if_fail (detailed_signal != NULL, 0);
3795   g_return_val_if_fail (c_handler != NULL, 0);
3796
3797   if (gobject)
3798     {
3799       GClosure *closure;
3800
3801       g_return_val_if_fail (G_IS_OBJECT (gobject), 0);
3802
3803       closure = ((connect_flags & G_CONNECT_SWAPPED) ? g_cclosure_new_object_swap : g_cclosure_new_object) (c_handler, gobject);
3804
3805       return g_signal_connect_closure (instance, detailed_signal, closure, connect_flags & G_CONNECT_AFTER);
3806     }
3807   else
3808     return g_signal_connect_data (instance, detailed_signal, c_handler, NULL, NULL, connect_flags);
3809 }
3810
3811 typedef struct {
3812   GObject  *object;
3813   guint     n_closures;
3814   GClosure *closures[1]; /* flexible array */
3815 } CArray;
3816 /* don't change this structure without supplying an accessor for
3817  * watched closures, e.g.:
3818  * GSList* g_object_list_watched_closures (GObject *object)
3819  * {
3820  *   CArray *carray;
3821  *   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3822  *   carray = g_object_get_data (object, "GObject-closure-array");
3823  *   if (carray)
3824  *     {
3825  *       GSList *slist = NULL;
3826  *       guint i;
3827  *       for (i = 0; i < carray->n_closures; i++)
3828  *         slist = g_slist_prepend (slist, carray->closures[i]);
3829  *       return slist;
3830  *     }
3831  *   return NULL;
3832  * }
3833  */
3834
3835 static void
3836 object_remove_closure (gpointer  data,
3837                        GClosure *closure)
3838 {
3839   GObject *object = data;
3840   CArray *carray;
3841   guint i;
3842
3843   G_LOCK (closure_array_mutex);
3844   carray = g_object_get_qdata (object, quark_closure_array);
3845   for (i = 0; i < carray->n_closures; i++)
3846     if (carray->closures[i] == closure)
3847       {
3848         carray->n_closures--;
3849         if (i < carray->n_closures)
3850           carray->closures[i] = carray->closures[carray->n_closures];
3851         G_UNLOCK (closure_array_mutex);
3852         return;
3853       }
3854   G_UNLOCK (closure_array_mutex);
3855   g_assert_not_reached ();
3856 }
3857
3858 static void
3859 destroy_closure_array (gpointer data)
3860 {
3861   CArray *carray = data;
3862   GObject *object = carray->object;
3863   guint i, n = carray->n_closures;
3864
3865   for (i = 0; i < n; i++)
3866     {
3867       GClosure *closure = carray->closures[i];
3868
3869       /* removing object_remove_closure() upfront is probably faster than
3870        * letting it fiddle with quark_closure_array which is empty anyways
3871        */
3872       g_closure_remove_invalidate_notifier (closure, object, object_remove_closure);
3873       g_closure_invalidate (closure);
3874     }
3875   g_free (carray);
3876 }
3877
3878 /**
3879  * g_object_watch_closure:
3880  * @object: GObject restricting lifetime of @closure
3881  * @closure: GClosure to watch
3882  *
3883  * This function essentially limits the life time of the @closure to
3884  * the life time of the object. That is, when the object is finalized,
3885  * the @closure is invalidated by calling g_closure_invalidate() on
3886  * it, in order to prevent invocations of the closure with a finalized
3887  * (nonexisting) object. Also, g_object_ref() and g_object_unref() are
3888  * added as marshal guards to the @closure, to ensure that an extra
3889  * reference count is held on @object during invocation of the
3890  * @closure.  Usually, this function will be called on closures that
3891  * use this @object as closure data.
3892  */
3893 void
3894 g_object_watch_closure (GObject  *object,
3895                         GClosure *closure)
3896 {
3897   CArray *carray;
3898   guint i;
3899
3900   g_return_if_fail (G_IS_OBJECT (object));
3901   g_return_if_fail (closure != NULL);
3902   g_return_if_fail (closure->is_invalid == FALSE);
3903   g_return_if_fail (closure->in_marshal == FALSE);
3904   g_return_if_fail (object->ref_count > 0);     /* this doesn't work on finalizing objects */
3905
3906   g_closure_add_invalidate_notifier (closure, object, object_remove_closure);
3907   g_closure_add_marshal_guards (closure,
3908                                 object, (GClosureNotify) g_object_ref,
3909                                 object, (GClosureNotify) g_object_unref);
3910   G_LOCK (closure_array_mutex);
3911   carray = g_datalist_id_remove_no_notify (&object->qdata, quark_closure_array);
3912   if (!carray)
3913     {
3914       carray = g_renew (CArray, NULL, 1);
3915       carray->object = object;
3916       carray->n_closures = 1;
3917       i = 0;
3918     }
3919   else
3920     {
3921       i = carray->n_closures++;
3922       carray = g_realloc (carray, sizeof (*carray) + sizeof (carray->closures[0]) * i);
3923     }
3924   carray->closures[i] = closure;
3925   g_datalist_id_set_data_full (&object->qdata, quark_closure_array, carray, destroy_closure_array);
3926   G_UNLOCK (closure_array_mutex);
3927 }
3928
3929 /**
3930  * g_closure_new_object:
3931  * @sizeof_closure: the size of the structure to allocate, must be at least
3932  *  `sizeof (GClosure)`
3933  * @object: a #GObject pointer to store in the @data field of the newly
3934  *  allocated #GClosure
3935  *
3936  * A variant of g_closure_new_simple() which stores @object in the
3937  * @data field of the closure and calls g_object_watch_closure() on
3938  * @object and the created closure. This function is mainly useful
3939  * when implementing new types of closures.
3940  *
3941  * Returns: (transfer full): a newly allocated #GClosure
3942  */
3943 GClosure*
3944 g_closure_new_object (guint    sizeof_closure,
3945                       GObject *object)
3946 {
3947   GClosure *closure;
3948
3949   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3950   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
3951
3952   closure = g_closure_new_simple (sizeof_closure, object);
3953   g_object_watch_closure (object, closure);
3954
3955   return closure;
3956 }
3957
3958 /**
3959  * g_cclosure_new_object: (skip)
3960  * @callback_func: the function to invoke
3961  * @object: a #GObject pointer to pass to @callback_func
3962  *
3963  * A variant of g_cclosure_new() which uses @object as @user_data and
3964  * calls g_object_watch_closure() on @object and the created
3965  * closure. This function is useful when you have a callback closely
3966  * associated with a #GObject, and want the callback to no longer run
3967  * after the object is is freed.
3968  *
3969  * Returns: a new #GCClosure
3970  */
3971 GClosure*
3972 g_cclosure_new_object (GCallback callback_func,
3973                        GObject  *object)
3974 {
3975   GClosure *closure;
3976
3977   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
3978   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
3979   g_return_val_if_fail (callback_func != NULL, NULL);
3980
3981   closure = g_cclosure_new (callback_func, object, NULL);
3982   g_object_watch_closure (object, closure);
3983
3984   return closure;
3985 }
3986
3987 /**
3988  * g_cclosure_new_object_swap: (skip)
3989  * @callback_func: the function to invoke
3990  * @object: a #GObject pointer to pass to @callback_func
3991  *
3992  * A variant of g_cclosure_new_swap() which uses @object as @user_data
3993  * and calls g_object_watch_closure() on @object and the created
3994  * closure. This function is useful when you have a callback closely
3995  * associated with a #GObject, and want the callback to no longer run
3996  * after the object is is freed.
3997  *
3998  * Returns: a new #GCClosure
3999  */
4000 GClosure*
4001 g_cclosure_new_object_swap (GCallback callback_func,
4002                             GObject  *object)
4003 {
4004   GClosure *closure;
4005
4006   g_return_val_if_fail (G_IS_OBJECT (object), NULL);
4007   g_return_val_if_fail (object->ref_count > 0, NULL);     /* this doesn't work on finalizing objects */
4008   g_return_val_if_fail (callback_func != NULL, NULL);
4009
4010   closure = g_cclosure_new_swap (callback_func, object, NULL);
4011   g_object_watch_closure (object, closure);
4012
4013   return closure;
4014 }
4015
4016 gsize
4017 g_object_compat_control (gsize           what,
4018                          gpointer        data)
4019 {
4020   switch (what)
4021     {
4022       gpointer *pp;
4023     case 1:     /* floating base type */
4024       return G_TYPE_INITIALLY_UNOWNED;
4025     case 2:     /* FIXME: remove this once GLib/Gtk+ break ABI again */
4026       floating_flag_handler = (guint(*)(GObject*,gint)) data;
4027       return 1;
4028     case 3:     /* FIXME: remove this once GLib/Gtk+ break ABI again */
4029       pp = data;
4030       *pp = floating_flag_handler;
4031       return 1;
4032     default:
4033       return 0;
4034     }
4035 }
4036
4037 G_DEFINE_TYPE (GInitiallyUnowned, g_initially_unowned, G_TYPE_OBJECT);
4038
4039 static void
4040 g_initially_unowned_init (GInitiallyUnowned *object)
4041 {
4042   g_object_force_floating (object);
4043 }
4044
4045 static void
4046 g_initially_unowned_class_init (GInitiallyUnownedClass *klass)
4047 {
4048 }
4049
4050 /**
4051  * GWeakRef:
4052  *
4053  * A structure containing a weak reference to a #GObject.  It can either
4054  * be empty (i.e. point to %NULL), or point to an object for as long as
4055  * at least one "strong" reference to that object exists. Before the
4056  * object's #GObjectClass.dispose method is called, every #GWeakRef
4057  * associated with becomes empty (i.e. points to %NULL).
4058  *
4059  * Like #GValue, #GWeakRef can be statically allocated, stack- or
4060  * heap-allocated, or embedded in larger structures.
4061  *
4062  * Unlike g_object_weak_ref() and g_object_add_weak_pointer(), this weak
4063  * reference is thread-safe: converting a weak pointer to a reference is
4064  * atomic with respect to invalidation of weak pointers to destroyed
4065  * objects.
4066  *
4067  * If the object's #GObjectClass.dispose method results in additional
4068  * references to the object being held, any #GWeakRefs taken
4069  * before it was disposed will continue to point to %NULL.  If
4070  * #GWeakRefs are taken after the object is disposed and
4071  * re-referenced, they will continue to point to it until its refcount
4072  * goes back to zero, at which point they too will be invalidated.
4073  */
4074
4075 /**
4076  * g_weak_ref_init: (skip)
4077  * @weak_ref: (inout): uninitialized or empty location for a weak
4078  *    reference
4079  * @object: (allow-none): a #GObject or %NULL
4080  *
4081  * Initialise a non-statically-allocated #GWeakRef.
4082  *
4083  * This function also calls g_weak_ref_set() with @object on the
4084  * freshly-initialised weak reference.
4085  *
4086  * This function should always be matched with a call to
4087  * g_weak_ref_clear().  It is not necessary to use this function for a
4088  * #GWeakRef in static storage because it will already be
4089  * properly initialised.  Just use g_weak_ref_set() directly.
4090  *
4091  * Since: 2.32
4092  */
4093 void
4094 g_weak_ref_init (GWeakRef *weak_ref,
4095                  gpointer  object)
4096 {
4097   weak_ref->priv.p = NULL;
4098
4099   g_weak_ref_set (weak_ref, object);
4100 }
4101
4102 /**
4103  * g_weak_ref_clear: (skip)
4104  * @weak_ref: (inout): location of a weak reference, which
4105  *  may be empty
4106  *
4107  * Frees resources associated with a non-statically-allocated #GWeakRef.
4108  * After this call, the #GWeakRef is left in an undefined state.
4109  *
4110  * You should only call this on a #GWeakRef that previously had
4111  * g_weak_ref_init() called on it.
4112  *
4113  * Since: 2.32
4114  */
4115 void
4116 g_weak_ref_clear (GWeakRef *weak_ref)
4117 {
4118   g_weak_ref_set (weak_ref, NULL);
4119
4120   /* be unkind */
4121   weak_ref->priv.p = (void *) 0xccccccccu;
4122 }
4123
4124 /**
4125  * g_weak_ref_get: (skip)
4126  * @weak_ref: (inout): location of a weak reference to a #GObject
4127  *
4128  * If @weak_ref is not empty, atomically acquire a strong
4129  * reference to the object it points to, and return that reference.
4130  *
4131  * This function is needed because of the potential race between taking
4132  * the pointer value and g_object_ref() on it, if the object was losing
4133  * its last reference at the same time in a different thread.
4134  *
4135  * The caller should release the resulting reference in the usual way,
4136  * by using g_object_unref().
4137  *
4138  * Returns: (transfer full) (type GObject.Object): the object pointed to
4139  *     by @weak_ref, or %NULL if it was empty
4140  *
4141  * Since: 2.32
4142  */
4143 gpointer
4144 g_weak_ref_get (GWeakRef *weak_ref)
4145 {
4146   gpointer object_or_null;
4147
4148   g_return_val_if_fail (weak_ref!= NULL, NULL);
4149
4150   g_rw_lock_reader_lock (&weak_locations_lock);
4151
4152   object_or_null = weak_ref->priv.p;
4153
4154   if (object_or_null != NULL)
4155     g_object_ref (object_or_null);
4156
4157   g_rw_lock_reader_unlock (&weak_locations_lock);
4158
4159   return object_or_null;
4160 }
4161
4162 /**
4163  * g_weak_ref_set: (skip)
4164  * @weak_ref: location for a weak reference
4165  * @object: (allow-none): a #GObject or %NULL
4166  *
4167  * Change the object to which @weak_ref points, or set it to
4168  * %NULL.
4169  *
4170  * You must own a strong reference on @object while calling this
4171  * function.
4172  *
4173  * Since: 2.32
4174  */
4175 void
4176 g_weak_ref_set (GWeakRef *weak_ref,
4177                 gpointer  object)
4178 {
4179   GSList **weak_locations;
4180   GObject *new_object;
4181   GObject *old_object;
4182
4183   g_return_if_fail (weak_ref != NULL);
4184   g_return_if_fail (object == NULL || G_IS_OBJECT (object));
4185
4186   new_object = object;
4187
4188   g_rw_lock_writer_lock (&weak_locations_lock);
4189
4190   /* We use the extra level of indirection here so that if we have ever
4191    * had a weak pointer installed at any point in time on this object,
4192    * we can see that there is a non-NULL value associated with the
4193    * weak-pointer quark and know that this value will not change at any
4194    * point in the object's lifetime.
4195    *
4196    * Both properties are important for reducing the amount of times we
4197    * need to acquire locks and for decreasing the duration of time the
4198    * lock is held while avoiding some rather tricky races.
4199    *
4200    * Specifically: we can avoid having to do an extra unconditional lock
4201    * in g_object_unref() without worrying about some extremely tricky
4202    * races.
4203    */
4204
4205   old_object = weak_ref->priv.p;
4206   if (new_object != old_object)
4207     {
4208       weak_ref->priv.p = new_object;
4209
4210       /* Remove the weak ref from the old object */
4211       if (old_object != NULL)
4212         {
4213           weak_locations = g_datalist_id_get_data (&old_object->qdata, quark_weak_locations);
4214           /* for it to point to an object, the object must have had it added once */
4215           g_assert (weak_locations != NULL);
4216
4217           *weak_locations = g_slist_remove (*weak_locations, weak_ref);
4218         }
4219
4220       /* Add the weak ref to the new object */
4221       if (new_object != NULL)
4222         {
4223           weak_locations = g_datalist_id_get_data (&new_object->qdata, quark_weak_locations);
4224
4225           if (weak_locations == NULL)
4226             {
4227               weak_locations = g_new0 (GSList *, 1);
4228               g_datalist_id_set_data_full (&new_object->qdata, quark_weak_locations, weak_locations, g_free);
4229             }
4230
4231           *weak_locations = g_slist_prepend (*weak_locations, weak_ref);
4232         }
4233     }
4234
4235   g_rw_lock_writer_unlock (&weak_locations_lock);
4236 }