gobject/gobject.c

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