gobject/gtype.c

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General
  15  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /*
  19  * MT safe
  20  */
  21
  22 #include "config.h"
  23
  24 #include "../glib/valgrind.h"
  25 #include <string.h>
  26
  27 #include "gtype.h"
  28 #include "gtype-private.h"
  29 #include "gtypeplugin.h"
  30 #include "gvaluecollector.h"
  31 #include "gbsearcharray.h"
  32 #include "gatomicarray.h"
  33 #include "gobject_trace.h"
  34
  35 #include "gconstructor.h"
  36
  37
  38 /**
  39  * SECTION:gtype
  40  * @short_description: The GLib Runtime type identification and
  41  *     management system
  42  * @title:Type Information
  43  *
  44  * The GType API is the foundation of the GObject system.  It provides the
  45  * facilities for registering and managing all fundamental data types,
  46  * user-defined object and interface types.
  47  *
  48  * For type creation and registration purposes, all types fall into one of
  49  * two categories: static or dynamic.  Static types are never loaded or
  50  * unloaded at run-time as dynamic types may be.  Static types are created
  51  * with g_type_register_static() that gets type specific information passed
  52  * in via a #GTypeInfo structure.
  53  *
  54  * Dynamic types are created with g_type_register_dynamic() which takes a
  55  * #GTypePlugin structure instead. The remaining type information (the
  56  * #GTypeInfo structure) is retrieved during runtime through #GTypePlugin
  57  * and the g_type_plugin_*() API.
  58  *
  59  * These registration functions are usually called only once from a
  60  * function whose only purpose is to return the type identifier for a
  61  * specific class.  Once the type (or class or interface) is registered,
  62  * it may be instantiated, inherited, or implemented depending on exactly
  63  * what sort of type it is.
  64  *
  65  * There is also a third registration function for registering fundamental
  66  * types called g_type_register_fundamental() which requires both a #GTypeInfo
  67  * structure and a #GTypeFundamentalInfo structure but it is seldom used
  68  * since most fundamental types are predefined rather than user-defined.
  69  *
  70  * Type instance and class structs are limited to a total of 64 KiB,
  71  * including all parent types. Similarly, type instances' private data
  72  * (as created by g_type_class_add_private()) are limited to a total of
  73  * 64 KiB. If a type instance needs a large static buffer, allocate it
  74  * separately (typically by using #GArray or #GPtrArray) and put a pointer
  75  * to the buffer in the structure.
  76  *
  77  * A final word about type names: Such an identifier needs to be at least
  78  * three characters long. There is no upper length limit. The first character
  79  * needs to be a letter (a-z or A-Z) or an underscore '_'. Subsequent
  80  * characters can be letters, numbers or any of '-_+'.
  81  */
  82
  83
  84 /* NOTE: some functions (some internal variants and exported ones)
  85  * invalidate data portions of the TypeNodes. if external functions/callbacks
  86  * are called, pointers to memory maintained by TypeNodes have to be looked up
  87  * again. this affects most of the struct TypeNode fields, e.g. ->children or
  88  * CLASSED_NODE_IFACES_ENTRIES() respectively IFACE_NODE_PREREQUISITES() (but
  89  * not ->supers[]), as all those memory portions can get realloc()ed during
  90  * callback invocation.
  91  *
  92  * LOCKING:
  93  * lock handling issues when calling static functions are indicated by
  94  * uppercase letter postfixes, all static functions have to have
  95  * one of the below postfixes:
  96  * - _I:        [Indifferent about locking]
  97  *   function doesn't care about locks at all
  98  * - _U:        [Unlocked invocation]
  99  *   no read or write lock has to be held across function invocation
 100  *   (locks may be acquired and released during invocation though)
 101  * - _L:        [Locked invocation]
 102  *   a write lock or more than 0 read locks have to be held across
 103  *   function invocation
 104  * - _W:        [Write-locked invocation]
 105  *   a write lock has to be held across function invocation
 106  * - _Wm:       [Write-locked invocation, mutatable]
 107  *   like _W, but the write lock might be released and reacquired
 108  *   during invocation, watch your pointers
 109  * - _WmREC:    [Write-locked invocation, mutatable, recursive]
 110  *   like _Wm, but also acquires recursive mutex class_init_rec_mutex
 111  */
 112
 113 #ifdef LOCK_DEBUG
 114 #define G_READ_LOCK(rw_lock)    do { g_printerr (G_STRLOC ": readL++\n"); g_rw_lock_reader_lock (rw_lock); } while (0)
 115 #define G_READ_UNLOCK(rw_lock)  do { g_printerr (G_STRLOC ": readL--\n"); g_rw_lock_reader_unlock (rw_lock); } while (0)
 116 #define G_WRITE_LOCK(rw_lock)   do { g_printerr (G_STRLOC ": writeL++\n"); g_rw_lock_writer_lock (rw_lock); } while (0)
 117 #define G_WRITE_UNLOCK(rw_lock) do { g_printerr (G_STRLOC ": writeL--\n"); g_rw_lock_writer_unlock (rw_lock); } while (0)
 118 #else
 119 #define G_READ_LOCK(rw_lock)    g_rw_lock_reader_lock (rw_lock)
 120 #define G_READ_UNLOCK(rw_lock)  g_rw_lock_reader_unlock (rw_lock)
 121 #define G_WRITE_LOCK(rw_lock)   g_rw_lock_writer_lock (rw_lock)
 122 #define G_WRITE_UNLOCK(rw_lock) g_rw_lock_writer_unlock (rw_lock)
 123 #endif
 124 #define INVALID_RECURSION(func, arg, type_name) G_STMT_START{ \
 125     static const gchar _action[] = " invalidly modified type ";  \
 126     gpointer _arg = (gpointer) (arg); const gchar *_tname = (type_name), *_fname = (func); \
 127     if (_arg) \
 128       g_error ("%s(%p)%s'%s'", _fname, _arg, _action, _tname); \
 129     else \
 130       g_error ("%s()%s'%s'", _fname, _action, _tname); \
 131 }G_STMT_END
 132 #define g_assert_type_system_initialized() \
 133   g_assert (static_quark_type_flags)
 134
 135 #ifdef  G_ENABLE_DEBUG
 136 #define DEBUG_CODE(debug_type, code_block)  G_STMT_START {    \
 137     if (_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type) \
 138       { code_block; }                                     \
 139 } G_STMT_END
 140 #else /* !G_ENABLE_DEBUG */
 141 #define DEBUG_CODE(debug_type, code_block)  /* code_block */
 142 #endif  /* G_ENABLE_DEBUG */
 143
 144 #define TYPE_FUNDAMENTAL_FLAG_MASK (G_TYPE_FLAG_CLASSED | \
 145                                     G_TYPE_FLAG_INSTANTIATABLE | \
 146                                     G_TYPE_FLAG_DERIVABLE | \
 147                                     G_TYPE_FLAG_DEEP_DERIVABLE)
 148 #define TYPE_FLAG_MASK             (G_TYPE_FLAG_ABSTRACT | G_TYPE_FLAG_VALUE_ABSTRACT)
 149 #define SIZEOF_FUNDAMENTAL_INFO    ((gssize) MAX (MAX (sizeof (GTypeFundamentalInfo), \
 150                                                        sizeof (gpointer)), \
 151                                                   sizeof (glong)))
 152
 153 /* The 2*sizeof(size_t) alignment here is borrowed from
 154  * GNU libc, so it should be good most everywhere.
 155  * It is more conservative than is needed on some 64-bit
 156  * platforms, but ia64 does require a 16-byte alignment.
 157  * The SIMD extensions for x86 and ppc32 would want a
 158  * larger alignment than this, but we don't need to
 159  * do better than malloc.
 160  */
 161 #define STRUCT_ALIGNMENT (2 * sizeof (gsize))
 162 #define ALIGN_STRUCT(offset) \
 163       ((offset + (STRUCT_ALIGNMENT - 1)) & -STRUCT_ALIGNMENT)
 164
 165
 166 /* --- typedefs --- */
 167 typedef struct _TypeNode        TypeNode;
 168 typedef struct _CommonData      CommonData;
 169 typedef struct _BoxedData       BoxedData;
 170 typedef struct _IFaceData       IFaceData;
 171 typedef struct _ClassData       ClassData;
 172 typedef struct _InstanceData    InstanceData;
 173 typedef union  _TypeData        TypeData;
 174 typedef struct _IFaceEntries    IFaceEntries;
 175 typedef struct _IFaceEntry      IFaceEntry;
 176 typedef struct _IFaceHolder     IFaceHolder;
 177
 178
 179 /* --- prototypes --- */
 180 static inline GTypeFundamentalInfo*     type_node_fundamental_info_I    (TypeNode               *node);
 181 static        void                      type_add_flags_W                (TypeNode               *node,
 182                                                                          GTypeFlags              flags);
 183 static        void                      type_data_make_W                (TypeNode               *node,
 184                                                                          const GTypeInfo        *info,
 185                                                                          const GTypeValueTable  *value_table);
 186 static inline void                      type_data_ref_Wm                (TypeNode               *node);
 187 static inline void                      type_data_unref_U               (TypeNode               *node,
 188                                                                          gboolean                uncached);
 189 static void                             type_data_last_unref_Wm         (TypeNode *              node,
 190                                                                          gboolean                uncached);
 191 static inline gpointer                  type_get_qdata_L                (TypeNode               *node,
 192                                                                          GQuark                  quark);
 193 static inline void                      type_set_qdata_W                (TypeNode               *node,
 194                                                                          GQuark                  quark,
 195                                                                          gpointer                data);
 196 static IFaceHolder*                     type_iface_peek_holder_L        (TypeNode               *iface,
 197                                                                          GType                   instance_type);
 198 static gboolean                         type_iface_vtable_base_init_Wm  (TypeNode               *iface,
 199                                                                          TypeNode               *node);
 200 static void                             type_iface_vtable_iface_init_Wm (TypeNode               *iface,
 201                                                                          TypeNode               *node);
 202 static gboolean                         type_node_is_a_L                (TypeNode               *node,
 203                                                                          TypeNode               *iface_node);
 204
 205
 206 /* --- enumeration --- */
 207
 208 /* The InitState enumeration is used to track the progress of initializing
 209  * both classes and interface vtables. Keeping the state of initialization
 210  * is necessary to handle new interfaces being added while we are initializing
 211  * the class or other interfaces.
 212  */
 213 typedef enum
 214 {
 215   UNINITIALIZED,
 216   BASE_CLASS_INIT,
 217   BASE_IFACE_INIT,
 218   CLASS_INIT,
 219   IFACE_INIT,
 220   INITIALIZED
 221 } InitState;
 222
 223 /* --- structures --- */
 224 struct _TypeNode
 225 {
 226   guint volatile ref_count;
 227   GTypePlugin *plugin;
 228   guint        n_children; /* writable with lock */
 229   guint        n_supers : 8;
 230   guint        n_prerequisites : 9;
 231   guint        is_classed : 1;
 232   guint        is_instantiatable : 1;
 233   guint        mutatable_check_cache : 1;       /* combines some common path checks */
 234   GType       *children; /* writable with lock */
 235   TypeData * volatile data;
 236   GQuark       qname;
 237   GData       *global_gdata;
 238   union {
 239     GAtomicArray iface_entries;         /* for !iface types */
 240     GAtomicArray offsets;
 241   } _prot;
 242   GType       *prerequisites;
 243   GType        supers[1]; /* flexible array */
 244 };
 245
 246 #define SIZEOF_BASE_TYPE_NODE()                 (G_STRUCT_OFFSET (TypeNode, supers))
 247 #define MAX_N_SUPERS                            (255)
 248 #define MAX_N_CHILDREN                          (4095)
 249 #define MAX_N_INTERFACES                        (255) /* Limited by offsets being 8 bits */
 250 #define MAX_N_PREREQUISITES                     (511)
 251 #define NODE_TYPE(node)                         (node->supers[0])
 252 #define NODE_PARENT_TYPE(node)                  (node->supers[1])
 253 #define NODE_FUNDAMENTAL_TYPE(node)             (node->supers[node->n_supers])
 254 #define NODE_NAME(node)                         (g_quark_to_string (node->qname))
 255 #define NODE_REFCOUNT(node)                     ((guint) g_atomic_int_get ((int *) &(node)->ref_count))
 256 #define NODE_IS_BOXED(node)                     (NODE_FUNDAMENTAL_TYPE (node) == G_TYPE_BOXED)
 257 #define NODE_IS_IFACE(node)                     (NODE_FUNDAMENTAL_TYPE (node) == G_TYPE_INTERFACE)
 258 #define CLASSED_NODE_IFACES_ENTRIES(node)       (&(node)->_prot.iface_entries)
 259 #define CLASSED_NODE_IFACES_ENTRIES_LOCKED(node)(G_ATOMIC_ARRAY_GET_LOCKED(CLASSED_NODE_IFACES_ENTRIES((node)), IFaceEntries))
 260 #define IFACE_NODE_N_PREREQUISITES(node)        ((node)->n_prerequisites)
 261 #define IFACE_NODE_PREREQUISITES(node)          ((node)->prerequisites)
 262 #define iface_node_get_holders_L(node)          ((IFaceHolder*) type_get_qdata_L ((node), static_quark_iface_holder))
 263 #define iface_node_set_holders_W(node, holders) (type_set_qdata_W ((node), static_quark_iface_holder, (holders)))
 264 #define iface_node_get_dependants_array_L(n)    ((GType*) type_get_qdata_L ((n), static_quark_dependants_array))
 265 #define iface_node_set_dependants_array_W(n,d)  (type_set_qdata_W ((n), static_quark_dependants_array, (d)))
 266 #define TYPE_ID_MASK                            ((GType) ((1 << G_TYPE_FUNDAMENTAL_SHIFT) - 1))
 267
 268 #define NODE_IS_ANCESTOR(ancestor, node)                                                    \
 269         ((ancestor)->n_supers <= (node)->n_supers &&                                        \
 270          (node)->supers[(node)->n_supers - (ancestor)->n_supers] == NODE_TYPE (ancestor))
 271
 272 struct _IFaceHolder
 273 {
 274   GType           instance_type;
 275   GInterfaceInfo *info;
 276   GTypePlugin    *plugin;
 277   IFaceHolder    *next;
 278 };
 279
 280 struct _IFaceEntry
 281 {
 282   GType           iface_type;
 283   GTypeInterface *vtable;
 284   InitState       init_state;
 285 };
 286
 287 struct _IFaceEntries {
 288   guint offset_index;
 289   IFaceEntry entry[1];
 290 };
 291
 292 #define IFACE_ENTRIES_HEADER_SIZE (sizeof(IFaceEntries) - sizeof(IFaceEntry))
 293 #define IFACE_ENTRIES_N_ENTRIES(_entries) ( (G_ATOMIC_ARRAY_DATA_SIZE((_entries)) - IFACE_ENTRIES_HEADER_SIZE) / sizeof(IFaceEntry) )
 294
 295 struct _CommonData
 296 {
 297   GTypeValueTable  *value_table;
 298 };
 299
 300 struct _BoxedData
 301 {
 302   CommonData         data;
 303   GBoxedCopyFunc     copy_func;
 304   GBoxedFreeFunc     free_func;
 305 };
 306
 307 struct _IFaceData
 308 {
 309   CommonData         common;
 310   guint16            vtable_size;
 311   GBaseInitFunc      vtable_init_base;
 312   GBaseFinalizeFunc  vtable_finalize_base;
 313   GClassInitFunc     dflt_init;
 314   GClassFinalizeFunc dflt_finalize;
 315   gconstpointer      dflt_data;
 316   gpointer           dflt_vtable;
 317 };
 318
 319 struct _ClassData
 320 {
 321   CommonData         common;
 322   guint16            class_size;
 323   guint16            class_private_size;
 324   int volatile       init_state; /* atomic - g_type_class_ref reads it unlocked */
 325   GBaseInitFunc      class_init_base;
 326   GBaseFinalizeFunc  class_finalize_base;
 327   GClassInitFunc     class_init;
 328   GClassFinalizeFunc class_finalize;
 329   gconstpointer      class_data;
 330   gpointer           class;
 331 };
 332
 333 struct _InstanceData
 334 {
 335   CommonData         common;
 336   guint16            class_size;
 337   guint16            class_private_size;
 338   int volatile       init_state; /* atomic - g_type_class_ref reads it unlocked */
 339   GBaseInitFunc      class_init_base;
 340   GBaseFinalizeFunc  class_finalize_base;
 341   GClassInitFunc     class_init;
 342   GClassFinalizeFunc class_finalize;
 343   gconstpointer      class_data;
 344   gpointer           class;
 345   guint16            instance_size;
 346   guint16            private_size;
 347   guint16            n_preallocs;
 348   GInstanceInitFunc  instance_init;
 349 };
 350
 351 union _TypeData
 352 {
 353   CommonData         common;
 354   BoxedData          boxed;
 355   IFaceData          iface;
 356   ClassData          class;
 357   InstanceData       instance;
 358 };
 359
 360 typedef struct {
 361   gpointer            cache_data;
 362   GTypeClassCacheFunc cache_func;
 363 } ClassCacheFunc;
 364
 365 typedef struct {
 366   gpointer                check_data;
 367   GTypeInterfaceCheckFunc check_func;
 368 } IFaceCheckFunc;
 369
 370
 371 /* --- variables --- */
 372 static GRWLock         type_rw_lock;
 373 static GRecMutex       class_init_rec_mutex;
 374 static guint           static_n_class_cache_funcs = 0;
 375 static ClassCacheFunc *static_class_cache_funcs = NULL;
 376 static guint           static_n_iface_check_funcs = 0;
 377 static IFaceCheckFunc *static_iface_check_funcs = NULL;
 378 static GQuark          static_quark_type_flags = 0;
 379 static GQuark          static_quark_iface_holder = 0;
 380 static GQuark          static_quark_dependants_array = 0;
 381 static guint           type_registration_serial = 0;
 382 GTypeDebugFlags        _g_type_debug_flags = 0;
 383
 384 /* --- type nodes --- */
 385 static GHashTable       *static_type_nodes_ht = NULL;
 386 static TypeNode         *static_fundamental_type_nodes[(G_TYPE_FUNDAMENTAL_MAX >> G_TYPE_FUNDAMENTAL_SHIFT) + 1] = { NULL, };
 387 static GType             static_fundamental_next = G_TYPE_RESERVED_USER_FIRST;
 388
 389 static inline TypeNode*
 390 lookup_type_node_I (register GType utype)
 391 {
 392   if (utype > G_TYPE_FUNDAMENTAL_MAX)
 393     return (TypeNode*) (utype & ~TYPE_ID_MASK);
 394   else
 395     return static_fundamental_type_nodes[utype >> G_TYPE_FUNDAMENTAL_SHIFT];
 396 }
 397
 398 /**
 399  * g_type_get_type_registration_serial:
 400  *
 401  * Returns an opaque serial number that represents the state of the set
 402  * of registered types. Any time a type is registered this serial changes,
 403  * which means you can cache information based on type lookups (such as
 404  * g_type_from_name()) and know if the cache is still valid at a later
 405  * time by comparing the current serial with the one at the type lookup.
 406  *
 407  * Since: 2.36
 408  *
 409  * Returns: An unsigned int, representing the state of type registrations
 410  */
 411 guint
 412 g_type_get_type_registration_serial (void)
 413 {
 414   return (guint)g_atomic_int_get ((gint *)&type_registration_serial);
 415 }
 416
 417 static TypeNode*
 418 type_node_any_new_W (TypeNode             *pnode,
 419                      GType                 ftype,
 420                      const gchar          *name,
 421                      GTypePlugin          *plugin,
 422                      GTypeFundamentalFlags type_flags)
 423 {
 424   guint n_supers;
 425   GType type;
 426   TypeNode *node;
 427   guint i, node_size = 0;
 428
 429   n_supers = pnode ? pnode->n_supers + 1 : 0;
 430
 431   if (!pnode)
 432     node_size += SIZEOF_FUNDAMENTAL_INFO;             /* fundamental type info */
 433   node_size += SIZEOF_BASE_TYPE_NODE ();              /* TypeNode structure */
 434   node_size += (sizeof (GType) * (1 + n_supers + 1)); /* self + ancestors + (0) for ->supers[] */
 435   node = g_malloc0 (node_size);
 436   if (!pnode)                                         /* offset fundamental types */
 437     {
 438       node = G_STRUCT_MEMBER_P (node, SIZEOF_FUNDAMENTAL_INFO);
 439       static_fundamental_type_nodes[ftype >> G_TYPE_FUNDAMENTAL_SHIFT] = node;
 440       type = ftype;
 441     }
 442   else
 443     type = (GType) node;
 444
 445   g_assert ((type & TYPE_ID_MASK) == 0);
 446
 447   node->n_supers = n_supers;
 448   if (!pnode)
 449     {
 450       node->supers[0] = type;
 451       node->supers[1] = 0;
 452
 453       node->is_classed = (type_flags & G_TYPE_FLAG_CLASSED) != 0;
 454       node->is_instantiatable = (type_flags & G_TYPE_FLAG_INSTANTIATABLE) != 0;
 455
 456       if (NODE_IS_IFACE (node))
 457         {
 458           IFACE_NODE_N_PREREQUISITES (node) = 0;
 459           IFACE_NODE_PREREQUISITES (node) = NULL;
 460         }
 461       else
 462         _g_atomic_array_init (CLASSED_NODE_IFACES_ENTRIES (node));
 463     }
 464   else
 465     {
 466       node->supers[0] = type;
 467       memcpy (node->supers + 1, pnode->supers, sizeof (GType) * (1 + pnode->n_supers + 1));
 468
 469       node->is_classed = pnode->is_classed;
 470       node->is_instantiatable = pnode->is_instantiatable;
 471
 472       if (NODE_IS_IFACE (node))
 473         {
 474           IFACE_NODE_N_PREREQUISITES (node) = 0;
 475           IFACE_NODE_PREREQUISITES (node) = NULL;
 476         }
 477       else
 478         {
 479           guint j;
 480           IFaceEntries *entries;
 481
 482           entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (pnode),
 483                                           IFACE_ENTRIES_HEADER_SIZE,
 484                                           0);
 485           if (entries)
 486             {
 487               for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
 488                 {
 489                   entries->entry[j].vtable = NULL;
 490                   entries->entry[j].init_state = UNINITIALIZED;
 491                 }
 492               _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node),
 493                                       entries);
 494             }
 495         }
 496
 497       i = pnode->n_children++;
 498       pnode->children = g_renew (GType, pnode->children, pnode->n_children);
 499       pnode->children[i] = type;
 500     }
 501
 502   TRACE(GOBJECT_TYPE_NEW(name, node->supers[1], type));
 503
 504   node->plugin = plugin;
 505   node->n_children = 0;
 506   node->children = NULL;
 507   node->data = NULL;
 508   node->qname = g_quark_from_string (name);
 509   node->global_gdata = NULL;
 510
 511   g_hash_table_insert (static_type_nodes_ht,
 512                        (gpointer) g_quark_to_string (node->qname),
 513                        (gpointer) type);
 514
 515   g_atomic_int_inc ((gint *)&type_registration_serial);
 516
 517   return node;
 518 }
 519
 520 static inline GTypeFundamentalInfo*
 521 type_node_fundamental_info_I (TypeNode *node)
 522 {
 523   GType ftype = NODE_FUNDAMENTAL_TYPE (node);
 524
 525   if (ftype != NODE_TYPE (node))
 526     node = lookup_type_node_I (ftype);
 527
 528   return node ? G_STRUCT_MEMBER_P (node, -SIZEOF_FUNDAMENTAL_INFO) : NULL;
 529 }
 530
 531 static TypeNode*
 532 type_node_fundamental_new_W (GType                 ftype,
 533                              const gchar          *name,
 534                              GTypeFundamentalFlags type_flags)
 535 {
 536   GTypeFundamentalInfo *finfo;
 537   TypeNode *node;
 538
 539   g_assert ((ftype & TYPE_ID_MASK) == 0);
 540   g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX);
 541
 542   if (ftype >> G_TYPE_FUNDAMENTAL_SHIFT == static_fundamental_next)
 543     static_fundamental_next++;
 544
 545   type_flags &= TYPE_FUNDAMENTAL_FLAG_MASK;
 546
 547   node = type_node_any_new_W (NULL, ftype, name, NULL, type_flags);
 548
 549   finfo = type_node_fundamental_info_I (node);
 550   finfo->type_flags = type_flags;
 551
 552   return node;
 553 }
 554
 555 static TypeNode*
 556 type_node_new_W (TypeNode    *pnode,
 557                  const gchar *name,
 558                  GTypePlugin *plugin)
 559
 560 {
 561   g_assert (pnode);
 562   g_assert (pnode->n_supers < MAX_N_SUPERS);
 563   g_assert (pnode->n_children < MAX_N_CHILDREN);
 564
 565   return type_node_any_new_W (pnode, NODE_FUNDAMENTAL_TYPE (pnode), name, plugin, 0);
 566 }
 567
 568 static inline IFaceEntry*
 569 lookup_iface_entry_I (volatile IFaceEntries *entries,
 570                       TypeNode *iface_node)
 571 {
 572   guint8 *offsets;
 573   guint offset_index;
 574   IFaceEntry *check;
 575   int index;
 576   IFaceEntry *entry;
 577
 578   if (entries == NULL)
 579     return NULL;
 580
 581   G_ATOMIC_ARRAY_DO_TRANSACTION
 582     (&iface_node->_prot.offsets, guint8,
 583
 584      entry = NULL;
 585      offsets = transaction_data;
 586      offset_index = entries->offset_index;
 587      if (offsets != NULL &&
 588          offset_index < G_ATOMIC_ARRAY_DATA_SIZE(offsets))
 589        {
 590          index = offsets[offset_index];
 591          if (index > 0)
 592            {
 593              /* zero means unset, subtract one to get real index */
 594              index -= 1;
 595
 596              if (index < IFACE_ENTRIES_N_ENTRIES (entries))
 597                {
 598                  check = (IFaceEntry *)&entries->entry[index];
 599                  if (check->iface_type == NODE_TYPE (iface_node))
 600                    entry = check;
 601                }
 602            }
 603        }
 604      );
 605
 606  return entry;
 607 }
 608
 609 static inline IFaceEntry*
 610 type_lookup_iface_entry_L (TypeNode *node,
 611                            TypeNode *iface_node)
 612 {
 613   if (!NODE_IS_IFACE (iface_node))
 614     return NULL;
 615
 616   return lookup_iface_entry_I (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node),
 617                                iface_node);
 618 }
 619
 620
 621 static inline gboolean
 622 type_lookup_iface_vtable_I (TypeNode *node,
 623                             TypeNode *iface_node,
 624                             gpointer *vtable_ptr)
 625 {
 626   IFaceEntry *entry;
 627   gboolean res;
 628
 629   if (!NODE_IS_IFACE (iface_node))
 630     {
 631       if (vtable_ptr)
 632         *vtable_ptr = NULL;
 633       return FALSE;
 634     }
 635
 636   G_ATOMIC_ARRAY_DO_TRANSACTION
 637     (CLASSED_NODE_IFACES_ENTRIES (node), IFaceEntries,
 638
 639      entry = lookup_iface_entry_I (transaction_data, iface_node);
 640      res = entry != NULL;
 641      if (vtable_ptr)
 642        {
 643          if (entry)
 644            *vtable_ptr = entry->vtable;
 645          else
 646            *vtable_ptr = NULL;
 647        }
 648      );
 649
 650   return res;
 651 }
 652
 653 static inline gboolean
 654 type_lookup_prerequisite_L (TypeNode *iface,
 655                             GType     prerequisite_type)
 656 {
 657   if (NODE_IS_IFACE (iface) && IFACE_NODE_N_PREREQUISITES (iface))
 658     {
 659       GType *prerequisites = IFACE_NODE_PREREQUISITES (iface) - 1;
 660       guint n_prerequisites = IFACE_NODE_N_PREREQUISITES (iface);
 661
 662       do
 663         {
 664           guint i;
 665           GType *check;
 666
 667           i = (n_prerequisites + 1) >> 1;
 668           check = prerequisites + i;
 669           if (prerequisite_type == *check)
 670             return TRUE;
 671           else if (prerequisite_type > *check)
 672             {
 673               n_prerequisites -= i;
 674               prerequisites = check;
 675             }
 676           else /* if (prerequisite_type < *check) */
 677             n_prerequisites = i - 1;
 678         }
 679       while (n_prerequisites);
 680     }
 681   return FALSE;
 682 }
 683
 684 static const gchar*
 685 type_descriptive_name_I (GType type)
 686 {
 687   if (type)
 688     {
 689       TypeNode *node = lookup_type_node_I (type);
 690
 691       return node ? NODE_NAME (node) : "<unknown>";
 692     }
 693   else
 694     return "<invalid>";
 695 }
 696
 697
 698 /* --- type consistency checks --- */
 699 static gboolean
 700 check_plugin_U (GTypePlugin *plugin,
 701                 gboolean     need_complete_type_info,
 702                 gboolean     need_complete_interface_info,
 703                 const gchar *type_name)
 704 {
 705   /* G_IS_TYPE_PLUGIN() and G_TYPE_PLUGIN_GET_CLASS() are external calls: _U
 706    */
 707   if (!plugin)
 708     {
 709       g_warning ("plugin handle for type '%s' is NULL",
 710                  type_name);
 711       return FALSE;
 712     }
 713   if (!G_IS_TYPE_PLUGIN (plugin))
 714     {
 715       g_warning ("plugin pointer (%p) for type '%s' is invalid",
 716                  plugin, type_name);
 717       return FALSE;
 718     }
 719   if (need_complete_type_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_type_info)
 720     {
 721       g_warning ("plugin for type '%s' has no complete_type_info() implementation",
 722                  type_name);
 723       return FALSE;
 724     }
 725   if (need_complete_interface_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_interface_info)
 726     {
 727       g_warning ("plugin for type '%s' has no complete_interface_info() implementation",
 728                  type_name);
 729       return FALSE;
 730     }
 731   return TRUE;
 732 }
 733
 734 static gboolean
 735 check_type_name_I (const gchar *type_name)
 736 {
 737   static const gchar extra_chars[] = "-_+";
 738   const gchar *p = type_name;
 739   gboolean name_valid;
 740
 741   if (!type_name[0] || !type_name[1] || !type_name[2])
 742     {
 743       g_warning ("type name '%s' is too short", type_name);
 744       return FALSE;
 745     }
 746   /* check the first letter */
 747   name_valid = (p[0] >= 'A' && p[0] <= 'Z') || (p[0] >= 'a' && p[0] <= 'z') || p[0] == '_';
 748   for (p = type_name + 1; *p; p++)
 749     name_valid &= ((p[0] >= 'A' && p[0] <= 'Z') ||
 750                    (p[0] >= 'a' && p[0] <= 'z') ||
 751                    (p[0] >= '0' && p[0] <= '9') ||
 752                    strchr (extra_chars, p[0]));
 753   if (!name_valid)
 754     {
 755       g_warning ("type name '%s' contains invalid characters", type_name);
 756       return FALSE;
 757     }
 758   if (g_type_from_name (type_name))
 759     {
 760       g_warning ("cannot register existing type '%s'", type_name);
 761       return FALSE;
 762     }
 763
 764   return TRUE;
 765 }
 766
 767 static gboolean
 768 check_derivation_I (GType        parent_type,
 769                     const gchar *type_name)
 770 {
 771   TypeNode *pnode;
 772   GTypeFundamentalInfo* finfo;
 773
 774   pnode = lookup_type_node_I (parent_type);
 775   if (!pnode)
 776     {
 777       g_warning ("cannot derive type '%s' from invalid parent type '%s'",
 778                  type_name,
 779                  type_descriptive_name_I (parent_type));
 780       return FALSE;
 781     }
 782   finfo = type_node_fundamental_info_I (pnode);
 783   /* ensure flat derivability */
 784   if (!(finfo->type_flags & G_TYPE_FLAG_DERIVABLE))
 785     {
 786       g_warning ("cannot derive '%s' from non-derivable parent type '%s'",
 787                  type_name,
 788                  NODE_NAME (pnode));
 789       return FALSE;
 790     }
 791   /* ensure deep derivability */
 792   if (parent_type != NODE_FUNDAMENTAL_TYPE (pnode) &&
 793       !(finfo->type_flags & G_TYPE_FLAG_DEEP_DERIVABLE))
 794     {
 795       g_warning ("cannot derive '%s' from non-fundamental parent type '%s'",
 796                  type_name,
 797                  NODE_NAME (pnode));
 798       return FALSE;
 799     }
 800
 801   return TRUE;
 802 }
 803
 804 static gboolean
 805 check_collect_format_I (const gchar *collect_format)
 806 {
 807   const gchar *p = collect_format;
 808   gchar valid_format[] = { G_VALUE_COLLECT_INT, G_VALUE_COLLECT_LONG,
 809                            G_VALUE_COLLECT_INT64, G_VALUE_COLLECT_DOUBLE,
 810                            G_VALUE_COLLECT_POINTER, 0 };
 811
 812   while (*p)
 813     if (!strchr (valid_format, *p++))
 814       return FALSE;
 815   return p - collect_format <= G_VALUE_COLLECT_FORMAT_MAX_LENGTH;
 816 }
 817
 818 static gboolean
 819 check_value_table_I (const gchar           *type_name,
 820                      const GTypeValueTable *value_table)
 821 {
 822   if (!value_table)
 823     return FALSE;
 824   else if (value_table->value_init == NULL)
 825     {
 826       if (value_table->value_free || value_table->value_copy ||
 827           value_table->value_peek_pointer ||
 828           value_table->collect_format || value_table->collect_value ||
 829           value_table->lcopy_format || value_table->lcopy_value)
 830         g_warning ("cannot handle uninitializable values of type '%s'",
 831                    type_name);
 832       return FALSE;
 833     }
 834   else /* value_table->value_init != NULL */
 835     {
 836       if (!value_table->value_free)
 837         {
 838           /* +++ optional +++
 839            * g_warning ("missing 'value_free()' for type '%s'", type_name);
 840            * return FALSE;
 841            */
 842         }
 843       if (!value_table->value_copy)
 844         {
 845           g_warning ("missing 'value_copy()' for type '%s'", type_name);
 846           return FALSE;
 847         }
 848       if ((value_table->collect_format || value_table->collect_value) &&
 849           (!value_table->collect_format || !value_table->collect_value))
 850         {
 851           g_warning ("one of 'collect_format' and 'collect_value()' is unspecified for type '%s'",
 852                      type_name);
 853           return FALSE;
 854         }
 855       if (value_table->collect_format && !check_collect_format_I (value_table->collect_format))
 856         {
 857           g_warning ("the '%s' specification for type '%s' is too long or invalid",
 858                      "collect_format",
 859                      type_name);
 860           return FALSE;
 861         }
 862       if ((value_table->lcopy_format || value_table->lcopy_value) &&
 863           (!value_table->lcopy_format || !value_table->lcopy_value))
 864         {
 865           g_warning ("one of 'lcopy_format' and 'lcopy_value()' is unspecified for type '%s'",
 866                      type_name);
 867           return FALSE;
 868         }
 869       if (value_table->lcopy_format && !check_collect_format_I (value_table->lcopy_format))
 870         {
 871           g_warning ("the '%s' specification for type '%s' is too long or invalid",
 872                      "lcopy_format",
 873                      type_name);
 874           return FALSE;
 875         }
 876     }
 877   return TRUE;
 878 }
 879
 880 static gboolean
 881 check_type_info_I (TypeNode        *pnode,
 882                    GType            ftype,
 883                    const gchar     *type_name,
 884                    const GTypeInfo *info)
 885 {
 886   GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (lookup_type_node_I (ftype));
 887   gboolean is_interface = ftype == G_TYPE_INTERFACE;
 888
 889   g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX && !(ftype & TYPE_ID_MASK));
 890
 891   /* check instance members */
 892   if (!(finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
 893       (info->instance_size || info->n_preallocs || info->instance_init))
 894     {
 895       if (pnode)
 896         g_warning ("cannot instantiate '%s', derived from non-instantiatable parent type '%s'",
 897                    type_name,
 898                    NODE_NAME (pnode));
 899       else
 900         g_warning ("cannot instantiate '%s' as non-instantiatable fundamental",
 901                    type_name);
 902       return FALSE;
 903     }
 904   /* check class & interface members */
 905   if (!((finfo->type_flags & G_TYPE_FLAG_CLASSED) || is_interface) &&
 906       (info->class_init || info->class_finalize || info->class_data ||
 907        info->class_size || info->base_init || info->base_finalize))
 908     {
 909       if (pnode)
 910         g_warning ("cannot create class for '%s', derived from non-classed parent type '%s'",
 911                    type_name,
 912                    NODE_NAME (pnode));
 913       else
 914         g_warning ("cannot create class for '%s' as non-classed fundamental",
 915                    type_name);
 916       return FALSE;
 917     }
 918   /* check interface size */
 919   if (is_interface && info->class_size < sizeof (GTypeInterface))
 920     {
 921       g_warning ("specified interface size for type '%s' is smaller than 'GTypeInterface' size",
 922                  type_name);
 923       return FALSE;
 924     }
 925   /* check class size */
 926   if (finfo->type_flags & G_TYPE_FLAG_CLASSED)
 927     {
 928       if (info->class_size < sizeof (GTypeClass))
 929         {
 930           g_warning ("specified class size for type '%s' is smaller than 'GTypeClass' size",
 931                      type_name);
 932           return FALSE;
 933         }
 934       if (pnode && info->class_size < pnode->data->class.class_size)
 935         {
 936           g_warning ("specified class size for type '%s' is smaller "
 937                      "than the parent type's '%s' class size",
 938                      type_name,
 939                      NODE_NAME (pnode));
 940           return FALSE;
 941         }
 942     }
 943   /* check instance size */
 944   if (finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE)
 945     {
 946       if (info->instance_size < sizeof (GTypeInstance))
 947         {
 948           g_warning ("specified instance size for type '%s' is smaller than 'GTypeInstance' size",
 949                      type_name);
 950           return FALSE;
 951         }
 952       if (pnode && info->instance_size < pnode->data->instance.instance_size)
 953         {
 954           g_warning ("specified instance size for type '%s' is smaller "
 955                      "than the parent type's '%s' instance size",
 956                      type_name,
 957                      NODE_NAME (pnode));
 958           return FALSE;
 959         }
 960     }
 961
 962   return TRUE;
 963 }
 964
 965 static TypeNode*
 966 find_conforming_child_type_L (TypeNode *pnode,
 967                               TypeNode *iface)
 968 {
 969   TypeNode *node = NULL;
 970   guint i;
 971
 972   if (type_lookup_iface_entry_L (pnode, iface))
 973     return pnode;
 974
 975   for (i = 0; i < pnode->n_children && !node; i++)
 976     node = find_conforming_child_type_L (lookup_type_node_I (pnode->children[i]), iface);
 977
 978   return node;
 979 }
 980
 981 static gboolean
 982 check_add_interface_L (GType instance_type,
 983                        GType iface_type)
 984 {
 985   TypeNode *node = lookup_type_node_I (instance_type);
 986   TypeNode *iface = lookup_type_node_I (iface_type);
 987   IFaceEntry *entry;
 988   TypeNode *tnode;
 989   GType *prerequisites;
 990   guint i;
 991
 992
 993   if (!node || !node->is_instantiatable)
 994     {
 995       g_warning ("cannot add interfaces to invalid (non-instantiatable) type '%s'",
 996                  type_descriptive_name_I (instance_type));
 997       return FALSE;
 998     }
 999   if (!iface || !NODE_IS_IFACE (iface))
1000     {
1001       g_warning ("cannot add invalid (non-interface) type '%s' to type '%s'",
1002                  type_descriptive_name_I (iface_type),
1003                  NODE_NAME (node));
1004       return FALSE;
1005     }
1006   if (node->data && node->data->class.class)
1007     {
1008       g_warning ("attempting to add an interface (%s) to class (%s) after class_init",
1009                  NODE_NAME (iface), NODE_NAME (node));
1010
1011       /* See https://bugzilla.gnome.org/show_bug.cgi?id=697229,
1012        * https://bugzilla.gnome.org/show_bug.cgi?id=687659
1013        */
1014       if (!g_str_has_prefix (NODE_NAME (node), "gtkmm__CustomObject_") && !strstr (NODE_NAME (node), "_gtksharp_"))
1015         return FALSE;
1016     }
1017   tnode = lookup_type_node_I (NODE_PARENT_TYPE (iface));
1018   if (NODE_PARENT_TYPE (tnode) && !type_lookup_iface_entry_L (node, tnode))
1019     {
1020       /* 2001/7/31:timj: erk, i guess this warning is junk as interface derivation is flat */
1021       g_warning ("cannot add sub-interface '%s' to type '%s' which does not conform to super-interface '%s'",
1022                  NODE_NAME (iface),
1023                  NODE_NAME (node),
1024                  NODE_NAME (tnode));
1025       return FALSE;
1026     }
1027   /* allow overriding of interface type introduced for parent type */
1028   entry = type_lookup_iface_entry_L (node, iface);
1029   if (entry && entry->vtable == NULL && !type_iface_peek_holder_L (iface, NODE_TYPE (node)))
1030     {
1031       /* ok, we do conform to this interface already, but the interface vtable was not
1032        * yet intialized, and we just conform to the interface because it got added to
1033        * one of our parents. so we allow overriding of holder info here.
1034        */
1035       return TRUE;
1036     }
1037   /* check whether one of our children already conforms (or whether the interface
1038    * got added to this node already)
1039    */
1040   tnode = find_conforming_child_type_L (node, iface);  /* tnode is_a node */
1041   if (tnode)
1042     {
1043       g_warning ("cannot add interface type '%s' to type '%s', since type '%s' already conforms to interface",
1044                  NODE_NAME (iface),
1045                  NODE_NAME (node),
1046                  NODE_NAME (tnode));
1047       return FALSE;
1048     }
1049   prerequisites = IFACE_NODE_PREREQUISITES (iface);
1050   for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1051     {
1052       tnode = lookup_type_node_I (prerequisites[i]);
1053       if (!type_node_is_a_L (node, tnode))
1054         {
1055           g_warning ("cannot add interface type '%s' to type '%s' which does not conform to prerequisite '%s'",
1056                      NODE_NAME (iface),
1057                      NODE_NAME (node),
1058                      NODE_NAME (tnode));
1059           return FALSE;
1060         }
1061     }
1062   return TRUE;
1063 }
1064
1065 static gboolean
1066 check_interface_info_I (TypeNode             *iface,
1067                         GType                 instance_type,
1068                         const GInterfaceInfo *info)
1069 {
1070   if ((info->interface_finalize || info->interface_data) && !info->interface_init)
1071     {
1072       g_warning ("interface type '%s' for type '%s' comes without initializer",
1073                  NODE_NAME (iface),
1074                  type_descriptive_name_I (instance_type));
1075       return FALSE;
1076     }
1077
1078   return TRUE;
1079 }
1080
1081 /* --- type info (type node data) --- */
1082 static void
1083 type_data_make_W (TypeNode              *node,
1084                   const GTypeInfo       *info,
1085                   const GTypeValueTable *value_table)
1086 {
1087   TypeData *data;
1088   GTypeValueTable *vtable = NULL;
1089   guint vtable_size = 0;
1090
1091   g_assert (node->data == NULL && info != NULL);
1092
1093   if (!value_table)
1094     {
1095       TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1096
1097       if (pnode)
1098         vtable = pnode->data->common.value_table;
1099       else
1100         {
1101           static const GTypeValueTable zero_vtable = { NULL, };
1102
1103           value_table = &zero_vtable;
1104         }
1105     }
1106   if (value_table)
1107     {
1108       /* need to setup vtable_size since we have to allocate it with data in one chunk */
1109       vtable_size = sizeof (GTypeValueTable);
1110       if (value_table->collect_format)
1111         vtable_size += strlen (value_table->collect_format);
1112       if (value_table->lcopy_format)
1113         vtable_size += strlen (value_table->lcopy_format);
1114       vtable_size += 2;
1115     }
1116
1117   if (node->is_instantiatable) /* careful, is_instantiatable is also is_classed */
1118     {
1119       TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1120
1121       data = g_malloc0 (sizeof (InstanceData) + vtable_size);
1122       if (vtable_size)
1123         vtable = G_STRUCT_MEMBER_P (data, sizeof (InstanceData));
1124       data->instance.class_size = info->class_size;
1125       data->instance.class_init_base = info->base_init;
1126       data->instance.class_finalize_base = info->base_finalize;
1127       data->instance.class_init = info->class_init;
1128       data->instance.class_finalize = info->class_finalize;
1129       data->instance.class_data = info->class_data;
1130       data->instance.class = NULL;
1131       data->instance.init_state = UNINITIALIZED;
1132       data->instance.instance_size = info->instance_size;
1133       /* We'll set the final value for data->instance.private size
1134        * after the parent class has been initialized
1135        */
1136       data->instance.private_size = 0;
1137       data->instance.class_private_size = 0;
1138       if (pnode)
1139         data->instance.class_private_size = pnode->data->instance.class_private_size;
1140 #ifdef  DISABLE_MEM_POOLS
1141       data->instance.n_preallocs = 0;
1142 #else   /* !DISABLE_MEM_POOLS */
1143       data->instance.n_preallocs = MIN (info->n_preallocs, 1024);
1144 #endif  /* !DISABLE_MEM_POOLS */
1145       data->instance.instance_init = info->instance_init;
1146     }
1147   else if (node->is_classed) /* only classed */
1148     {
1149       TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1150
1151       data = g_malloc0 (sizeof (ClassData) + vtable_size);
1152       if (vtable_size)
1153         vtable = G_STRUCT_MEMBER_P (data, sizeof (ClassData));
1154       data->class.class_size = info->class_size;
1155       data->class.class_init_base = info->base_init;
1156       data->class.class_finalize_base = info->base_finalize;
1157       data->class.class_init = info->class_init;
1158       data->class.class_finalize = info->class_finalize;
1159       data->class.class_data = info->class_data;
1160       data->class.class = NULL;
1161       data->class.class_private_size = 0;
1162       if (pnode)
1163         data->class.class_private_size = pnode->data->class.class_private_size;
1164       data->class.init_state = UNINITIALIZED;
1165     }
1166   else if (NODE_IS_IFACE (node))
1167     {
1168       data = g_malloc0 (sizeof (IFaceData) + vtable_size);
1169       if (vtable_size)
1170         vtable = G_STRUCT_MEMBER_P (data, sizeof (IFaceData));
1171       data->iface.vtable_size = info->class_size;
1172       data->iface.vtable_init_base = info->base_init;
1173       data->iface.vtable_finalize_base = info->base_finalize;
1174       data->iface.dflt_init = info->class_init;
1175       data->iface.dflt_finalize = info->class_finalize;
1176       data->iface.dflt_data = info->class_data;
1177       data->iface.dflt_vtable = NULL;
1178     }
1179   else if (NODE_IS_BOXED (node))
1180     {
1181       data = g_malloc0 (sizeof (BoxedData) + vtable_size);
1182       if (vtable_size)
1183         vtable = G_STRUCT_MEMBER_P (data, sizeof (BoxedData));
1184     }
1185   else
1186     {
1187       data = g_malloc0 (sizeof (CommonData) + vtable_size);
1188       if (vtable_size)
1189         vtable = G_STRUCT_MEMBER_P (data, sizeof (CommonData));
1190     }
1191
1192   node->data = data;
1193
1194   if (vtable_size)
1195     {
1196       gchar *p;
1197
1198       /* we allocate the vtable and its strings together with the type data, so
1199        * children can take over their parent's vtable pointer, and we don't
1200        * need to worry freeing it or not when the child data is destroyed
1201        */
1202       *vtable = *value_table;
1203       p = G_STRUCT_MEMBER_P (vtable, sizeof (*vtable));
1204       p[0] = 0;
1205       vtable->collect_format = p;
1206       if (value_table->collect_format)
1207         {
1208           strcat (p, value_table->collect_format);
1209           p += strlen (value_table->collect_format);
1210         }
1211       p++;
1212       p[0] = 0;
1213       vtable->lcopy_format = p;
1214       if (value_table->lcopy_format)
1215         strcat  (p, value_table->lcopy_format);
1216     }
1217   node->data->common.value_table = vtable;
1218   node->mutatable_check_cache = (node->data->common.value_table->value_init != NULL &&
1219                                  !((G_TYPE_FLAG_VALUE_ABSTRACT | G_TYPE_FLAG_ABSTRACT) &
1220                                    GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))));
1221
1222   g_assert (node->data->common.value_table != NULL); /* paranoid */
1223
1224   g_atomic_int_set ((int *) &node->ref_count, 1);
1225 }
1226
1227 static inline void
1228 type_data_ref_Wm (TypeNode *node)
1229 {
1230   if (!node->data)
1231     {
1232       TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1233       GTypeInfo tmp_info;
1234       GTypeValueTable tmp_value_table;
1235
1236       g_assert (node->plugin != NULL);
1237
1238       if (pnode)
1239         {
1240           type_data_ref_Wm (pnode);
1241           if (node->data)
1242             INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1243         }
1244
1245       memset (&tmp_info, 0, sizeof (tmp_info));
1246       memset (&tmp_value_table, 0, sizeof (tmp_value_table));
1247
1248       G_WRITE_UNLOCK (&type_rw_lock);
1249       g_type_plugin_use (node->plugin);
1250       g_type_plugin_complete_type_info (node->plugin, NODE_TYPE (node), &tmp_info, &tmp_value_table);
1251       G_WRITE_LOCK (&type_rw_lock);
1252       if (node->data)
1253         INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1254
1255       check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (node), NODE_NAME (node), &tmp_info);
1256       type_data_make_W (node, &tmp_info,
1257                         check_value_table_I (NODE_NAME (node),
1258                                              &tmp_value_table) ? &tmp_value_table : NULL);
1259     }
1260   else
1261     {
1262       g_assert (NODE_REFCOUNT (node) > 0);
1263
1264       g_atomic_int_inc ((int *) &node->ref_count);
1265     }
1266 }
1267
1268 static inline gboolean
1269 type_data_ref_U (TypeNode *node)
1270 {
1271   guint current;
1272
1273   do {
1274     current = NODE_REFCOUNT (node);
1275
1276     if (current < 1)
1277       return FALSE;
1278   } while (!g_atomic_int_compare_and_exchange ((int *) &node->ref_count, current, current + 1));
1279
1280   return TRUE;
1281 }
1282
1283 static gboolean
1284 iface_node_has_available_offset_L (TypeNode *iface_node,
1285                                    int offset,
1286                                    int for_index)
1287 {
1288   guint8 *offsets;
1289
1290   offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->_prot.offsets, guint8);
1291   if (offsets == NULL)
1292     return TRUE;
1293
1294   if (G_ATOMIC_ARRAY_DATA_SIZE (offsets) <= offset)
1295     return TRUE;
1296
1297   if (offsets[offset] == 0 ||
1298       offsets[offset] == for_index+1)
1299     return TRUE;
1300
1301   return FALSE;
1302 }
1303
1304 static int
1305 find_free_iface_offset_L (IFaceEntries *entries)
1306 {
1307   IFaceEntry *entry;
1308   TypeNode *iface_node;
1309   int offset;
1310   int i;
1311   int n_entries;
1312
1313   n_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1314   offset = -1;
1315   do
1316     {
1317       offset++;
1318       for (i = 0; i < n_entries; i++)
1319         {
1320           entry = &entries->entry[i];
1321           iface_node = lookup_type_node_I (entry->iface_type);
1322
1323           if (!iface_node_has_available_offset_L (iface_node, offset, i))
1324             break;
1325         }
1326     }
1327   while (i != n_entries);
1328
1329   return offset;
1330 }
1331
1332 static void
1333 iface_node_set_offset_L (TypeNode *iface_node,
1334                          int offset,
1335                          int index)
1336 {
1337   guint8 *offsets, *old_offsets;
1338   int new_size, old_size;
1339   int i;
1340
1341   old_offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->_prot.offsets, guint8);
1342   if (old_offsets == NULL)
1343     old_size = 0;
1344   else
1345     {
1346       old_size = G_ATOMIC_ARRAY_DATA_SIZE (old_offsets);
1347       if (offset < old_size &&
1348           old_offsets[offset] == index + 1)
1349         return; /* Already set to this index, return */
1350     }
1351   new_size = MAX (old_size, offset + 1);
1352
1353   offsets = _g_atomic_array_copy (&iface_node->_prot.offsets,
1354                                   0, new_size - old_size);
1355
1356   /* Mark new area as unused */
1357   for (i = old_size; i < new_size; i++)
1358     offsets[i] = 0;
1359
1360   offsets[offset] = index + 1;
1361
1362   _g_atomic_array_update (&iface_node->_prot.offsets, offsets);
1363 }
1364
1365 static void
1366 type_node_add_iface_entry_W (TypeNode   *node,
1367                              GType       iface_type,
1368                              IFaceEntry *parent_entry)
1369 {
1370   IFaceEntries *entries;
1371   IFaceEntry *entry;
1372   TypeNode *iface_node;
1373   guint i, j;
1374   int num_entries;
1375
1376   g_assert (node->is_instantiatable);
1377
1378   entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
1379   if (entries != NULL)
1380     {
1381       num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1382
1383       g_assert (num_entries < MAX_N_INTERFACES);
1384
1385       for (i = 0; i < num_entries; i++)
1386         {
1387           entry = &entries->entry[i];
1388           if (entry->iface_type == iface_type)
1389             {
1390               /* this can happen in two cases:
1391                * - our parent type already conformed to iface_type and node
1392                *   got its own holder info. here, our children already have
1393                *   entries and NULL vtables, since this will only work for
1394                *   uninitialized classes.
1395                * - an interface type is added to an ancestor after it was
1396                *   added to a child type.
1397                */
1398               if (!parent_entry)
1399                 g_assert (entry->vtable == NULL && entry->init_state == UNINITIALIZED);
1400               else
1401                 {
1402                   /* sick, interface is added to ancestor *after* child type;
1403                    * nothing todo, the entry and our children were already setup correctly
1404                    */
1405                 }
1406               return;
1407             }
1408         }
1409     }
1410
1411   entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (node),
1412                                   IFACE_ENTRIES_HEADER_SIZE,
1413                                   sizeof (IFaceEntry));
1414   num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1415   i = num_entries - 1;
1416   if (i == 0)
1417     entries->offset_index = 0;
1418   entries->entry[i].iface_type = iface_type;
1419   entries->entry[i].vtable = NULL;
1420   entries->entry[i].init_state = UNINITIALIZED;
1421
1422   if (parent_entry)
1423     {
1424       if (node->data && node->data->class.init_state >= BASE_IFACE_INIT)
1425         {
1426           entries->entry[i].init_state = INITIALIZED;
1427           entries->entry[i].vtable = parent_entry->vtable;
1428         }
1429     }
1430
1431   /* Update offsets in iface */
1432   iface_node = lookup_type_node_I (iface_type);
1433
1434   if (iface_node_has_available_offset_L (iface_node,
1435                                          entries->offset_index,
1436                                          i))
1437     {
1438       iface_node_set_offset_L (iface_node,
1439                                entries->offset_index, i);
1440     }
1441   else
1442    {
1443       entries->offset_index =
1444         find_free_iface_offset_L (entries);
1445       for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
1446         {
1447           entry = &entries->entry[j];
1448           iface_node =
1449             lookup_type_node_I (entry->iface_type);
1450           iface_node_set_offset_L (iface_node,
1451                                    entries->offset_index, j);
1452         }
1453     }
1454
1455   _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node), entries);
1456
1457   if (parent_entry)
1458     {
1459       for (i = 0; i < node->n_children; i++)
1460         type_node_add_iface_entry_W (lookup_type_node_I (node->children[i]), iface_type, &entries->entry[i]);
1461     }
1462 }
1463
1464 static void
1465 type_add_interface_Wm (TypeNode             *node,
1466                        TypeNode             *iface,
1467                        const GInterfaceInfo *info,
1468                        GTypePlugin          *plugin)
1469 {
1470   IFaceHolder *iholder = g_new0 (IFaceHolder, 1);
1471   IFaceEntry *entry;
1472   guint i;
1473
1474   g_assert (node->is_instantiatable && NODE_IS_IFACE (iface) && ((info && !plugin) || (!info && plugin)));
1475
1476   iholder->next = iface_node_get_holders_L (iface);
1477   iface_node_set_holders_W (iface, iholder);
1478   iholder->instance_type = NODE_TYPE (node);
1479   iholder->info = info ? g_memdup (info, sizeof (*info)) : NULL;
1480   iholder->plugin = plugin;
1481
1482   /* create an iface entry for this type */
1483   type_node_add_iface_entry_W (node, NODE_TYPE (iface), NULL);
1484
1485   /* if the class is already (partly) initialized, we may need to base
1486    * initalize and/or initialize the new interface.
1487    */
1488   if (node->data)
1489     {
1490       InitState class_state = node->data->class.init_state;
1491
1492       if (class_state >= BASE_IFACE_INIT)
1493         type_iface_vtable_base_init_Wm (iface, node);
1494
1495       if (class_state >= IFACE_INIT)
1496         type_iface_vtable_iface_init_Wm (iface, node);
1497     }
1498
1499   /* create iface entries for children of this type */
1500   entry = type_lookup_iface_entry_L (node, iface);
1501   for (i = 0; i < node->n_children; i++)
1502     type_node_add_iface_entry_W (lookup_type_node_I (node->children[i]), NODE_TYPE (iface), entry);
1503 }
1504
1505 static void
1506 type_iface_add_prerequisite_W (TypeNode *iface,
1507                                TypeNode *prerequisite_node)
1508 {
1509   GType prerequisite_type = NODE_TYPE (prerequisite_node);
1510   GType *prerequisites, *dependants;
1511   guint n_dependants, i;
1512
1513   g_assert (NODE_IS_IFACE (iface) &&
1514             IFACE_NODE_N_PREREQUISITES (iface) < MAX_N_PREREQUISITES &&
1515             (prerequisite_node->is_instantiatable || NODE_IS_IFACE (prerequisite_node)));
1516
1517   prerequisites = IFACE_NODE_PREREQUISITES (iface);
1518   for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1519     if (prerequisites[i] == prerequisite_type)
1520       return;                   /* we already have that prerequisiste */
1521     else if (prerequisites[i] > prerequisite_type)
1522       break;
1523   IFACE_NODE_N_PREREQUISITES (iface) += 1;
1524   IFACE_NODE_PREREQUISITES (iface) = g_renew (GType,
1525                                               IFACE_NODE_PREREQUISITES (iface),
1526                                               IFACE_NODE_N_PREREQUISITES (iface));
1527   prerequisites = IFACE_NODE_PREREQUISITES (iface);
1528   memmove (prerequisites + i + 1, prerequisites + i,
1529            sizeof (prerequisites[0]) * (IFACE_NODE_N_PREREQUISITES (iface) - i - 1));
1530   prerequisites[i] = prerequisite_type;
1531
1532   /* we want to get notified when prerequisites get added to prerequisite_node */
1533   if (NODE_IS_IFACE (prerequisite_node))
1534     {
1535       dependants = iface_node_get_dependants_array_L (prerequisite_node);
1536       n_dependants = dependants ? dependants[0] : 0;
1537       n_dependants += 1;
1538       dependants = g_renew (GType, dependants, n_dependants + 1);
1539       dependants[n_dependants] = NODE_TYPE (iface);
1540       dependants[0] = n_dependants;
1541       iface_node_set_dependants_array_W (prerequisite_node, dependants);
1542     }
1543
1544   /* we need to notify all dependants */
1545   dependants = iface_node_get_dependants_array_L (iface);
1546   n_dependants = dependants ? dependants[0] : 0;
1547   for (i = 1; i <= n_dependants; i++)
1548     type_iface_add_prerequisite_W (lookup_type_node_I (dependants[i]), prerequisite_node);
1549 }
1550
1551 /**
1552  * g_type_interface_add_prerequisite:
1553  * @interface_type: #GType value of an interface type
1554  * @prerequisite_type: #GType value of an interface or instantiatable type
1555  *
1556  * Adds @prerequisite_type to the list of prerequisites of @interface_type.
1557  * This means that any type implementing @interface_type must also implement
1558  * @prerequisite_type. Prerequisites can be thought of as an alternative to
1559  * interface derivation (which GType doesn't support). An interface can have
1560  * at most one instantiatable prerequisite type.
1561  */
1562 void
1563 g_type_interface_add_prerequisite (GType interface_type,
1564                                    GType prerequisite_type)
1565 {
1566   TypeNode *iface, *prerequisite_node;
1567   IFaceHolder *holders;
1568
1569   g_return_if_fail (G_TYPE_IS_INTERFACE (interface_type));      /* G_TYPE_IS_INTERFACE() is an external call: _U */
1570   g_return_if_fail (!g_type_is_a (interface_type, prerequisite_type));
1571   g_return_if_fail (!g_type_is_a (prerequisite_type, interface_type));
1572
1573   iface = lookup_type_node_I (interface_type);
1574   prerequisite_node = lookup_type_node_I (prerequisite_type);
1575   if (!iface || !prerequisite_node || !NODE_IS_IFACE (iface))
1576     {
1577       g_warning ("interface type '%s' or prerequisite type '%s' invalid",
1578                  type_descriptive_name_I (interface_type),
1579                  type_descriptive_name_I (prerequisite_type));
1580       return;
1581     }
1582   G_WRITE_LOCK (&type_rw_lock);
1583   holders = iface_node_get_holders_L (iface);
1584   if (holders)
1585     {
1586       G_WRITE_UNLOCK (&type_rw_lock);
1587       g_warning ("unable to add prerequisite '%s' to interface '%s' which is already in use for '%s'",
1588                  type_descriptive_name_I (prerequisite_type),
1589                  type_descriptive_name_I (interface_type),
1590                  type_descriptive_name_I (holders->instance_type));
1591       return;
1592     }
1593   if (prerequisite_node->is_instantiatable)
1594     {
1595       guint i;
1596
1597       /* can have at most one publicly installable instantiatable prerequisite */
1598       for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1599         {
1600           TypeNode *prnode = lookup_type_node_I (IFACE_NODE_PREREQUISITES (iface)[i]);
1601
1602           if (prnode->is_instantiatable)
1603             {
1604               G_WRITE_UNLOCK (&type_rw_lock);
1605               g_warning ("adding prerequisite '%s' to interface '%s' conflicts with existing prerequisite '%s'",
1606                          type_descriptive_name_I (prerequisite_type),
1607                          type_descriptive_name_I (interface_type),
1608                          type_descriptive_name_I (NODE_TYPE (prnode)));
1609               return;
1610             }
1611         }
1612
1613       for (i = 0; i < prerequisite_node->n_supers + 1; i++)
1614         type_iface_add_prerequisite_W (iface, lookup_type_node_I (prerequisite_node->supers[i]));
1615       G_WRITE_UNLOCK (&type_rw_lock);
1616     }
1617   else if (NODE_IS_IFACE (prerequisite_node))
1618     {
1619       GType *prerequisites;
1620       guint i;
1621
1622       prerequisites = IFACE_NODE_PREREQUISITES (prerequisite_node);
1623       for (i = 0; i < IFACE_NODE_N_PREREQUISITES (prerequisite_node); i++)
1624         type_iface_add_prerequisite_W (iface, lookup_type_node_I (prerequisites[i]));
1625       type_iface_add_prerequisite_W (iface, prerequisite_node);
1626       G_WRITE_UNLOCK (&type_rw_lock);
1627     }
1628   else
1629     {
1630       G_WRITE_UNLOCK (&type_rw_lock);
1631       g_warning ("prerequisite '%s' for interface '%s' is neither instantiatable nor interface",
1632                  type_descriptive_name_I (prerequisite_type),
1633                  type_descriptive_name_I (interface_type));
1634     }
1635 }
1636
1637 /**
1638  * g_type_interface_prerequisites:
1639  * @interface_type: an interface type
1640  * @n_prerequisites: (out) (allow-none): location to return the number
1641  *     of prerequisites, or %NULL
1642  *
1643  * Returns the prerequisites of an interfaces type.
1644  *
1645  * Since: 2.2
1646  *
1647  * Returns: (array length=n_prerequisites) (transfer full): a
1648  *     newly-allocated zero-terminated array of #GType containing
1649  *     the prerequisites of @interface_type
1650  */
1651 GType*
1652 g_type_interface_prerequisites (GType  interface_type,
1653                                 guint *n_prerequisites)
1654 {
1655   TypeNode *iface;
1656
1657   g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL);
1658
1659   iface = lookup_type_node_I (interface_type);
1660   if (iface)
1661     {
1662       GType *types;
1663       TypeNode *inode = NULL;
1664       guint i, n = 0;
1665
1666       G_READ_LOCK (&type_rw_lock);
1667       types = g_new0 (GType, IFACE_NODE_N_PREREQUISITES (iface) + 1);
1668       for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1669         {
1670           GType prerequisite = IFACE_NODE_PREREQUISITES (iface)[i];
1671           TypeNode *node = lookup_type_node_I (prerequisite);
1672           if (node->is_instantiatable)
1673             {
1674               if (!inode || type_node_is_a_L (node, inode))
1675                 inode = node;
1676             }
1677           else
1678             types[n++] = NODE_TYPE (node);
1679         }
1680       if (inode)
1681         types[n++] = NODE_TYPE (inode);
1682
1683       if (n_prerequisites)
1684         *n_prerequisites = n;
1685       G_READ_UNLOCK (&type_rw_lock);
1686
1687       return types;
1688     }
1689   else
1690     {
1691       if (n_prerequisites)
1692         *n_prerequisites = 0;
1693
1694       return NULL;
1695     }
1696 }
1697
1698
1699 static IFaceHolder*
1700 type_iface_peek_holder_L (TypeNode *iface,
1701                           GType     instance_type)
1702 {
1703   IFaceHolder *iholder;
1704
1705   g_assert (NODE_IS_IFACE (iface));
1706
1707   iholder = iface_node_get_holders_L (iface);
1708   while (iholder && iholder->instance_type != instance_type)
1709     iholder = iholder->next;
1710   return iholder;
1711 }
1712
1713 static IFaceHolder*
1714 type_iface_retrieve_holder_info_Wm (TypeNode *iface,
1715                                     GType     instance_type,
1716                                     gboolean  need_info)
1717 {
1718   IFaceHolder *iholder = type_iface_peek_holder_L (iface, instance_type);
1719
1720   if (iholder && !iholder->info && need_info)
1721     {
1722       GInterfaceInfo tmp_info;
1723
1724       g_assert (iholder->plugin != NULL);
1725
1726       type_data_ref_Wm (iface);
1727       if (iholder->info)
1728         INVALID_RECURSION ("g_type_plugin_*", iface->plugin, NODE_NAME (iface));
1729
1730       memset (&tmp_info, 0, sizeof (tmp_info));
1731
1732       G_WRITE_UNLOCK (&type_rw_lock);
1733       g_type_plugin_use (iholder->plugin);
1734       g_type_plugin_complete_interface_info (iholder->plugin, instance_type, NODE_TYPE (iface), &tmp_info);
1735       G_WRITE_LOCK (&type_rw_lock);
1736       if (iholder->info)
1737         INVALID_RECURSION ("g_type_plugin_*", iholder->plugin, NODE_NAME (iface));
1738
1739       check_interface_info_I (iface, instance_type, &tmp_info);
1740       iholder->info = g_memdup (&tmp_info, sizeof (tmp_info));
1741     }
1742
1743   return iholder;       /* we don't modify write lock upon returning NULL */
1744 }
1745
1746 static void
1747 type_iface_blow_holder_info_Wm (TypeNode *iface,
1748                                 GType     instance_type)
1749 {
1750   IFaceHolder *iholder = iface_node_get_holders_L (iface);
1751
1752   g_assert (NODE_IS_IFACE (iface));
1753
1754   while (iholder->instance_type != instance_type)
1755     iholder = iholder->next;
1756
1757   if (iholder->info && iholder->plugin)
1758     {
1759       g_free (iholder->info);
1760       iholder->info = NULL;
1761
1762       G_WRITE_UNLOCK (&type_rw_lock);
1763       g_type_plugin_unuse (iholder->plugin);
1764       type_data_unref_U (iface, FALSE);
1765       G_WRITE_LOCK (&type_rw_lock);
1766     }
1767 }
1768
1769 /**
1770  * g_type_create_instance: (skip)
1771  * @type: an instantiatable type to create an instance for
1772  *
1773  * Creates and initializes an instance of @type if @type is valid and
1774  * can be instantiated. The type system only performs basic allocation
1775  * and structure setups for instances: actual instance creation should
1776  * happen through functions supplied by the type's fundamental type
1777  * implementation.  So use of g_type_create_instance() is reserved for
1778  * implementators of fundamental types only. E.g. instances of the
1779  * #GObject hierarchy should be created via g_object_new() and never
1780  * directly through g_type_create_instance() which doesn't handle things
1781  * like singleton objects or object construction.
1782  *
1783  * Note: Do not use this function, unless you're implementing a
1784  * fundamental type. Also language bindings should not use this
1785  * function, but g_object_new() instead.
1786  *
1787  * Returns: an allocated and initialized instance, subject to further
1788  *     treatment by the fundamental type implementation
1789  */
1790 GTypeInstance*
1791 g_type_create_instance (GType type)
1792 {
1793   TypeNode *node;
1794   GTypeInstance *instance;
1795   GTypeClass *class;
1796   gchar *allocated;
1797   gint private_size;
1798   gint ivar_size;
1799   guint i;
1800
1801   node = lookup_type_node_I (type);
1802   if (!node || !node->is_instantiatable)
1803     {
1804       g_error ("cannot create new instance of invalid (non-instantiatable) type '%s'",
1805                  type_descriptive_name_I (type));
1806     }
1807   /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1808   if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (type))
1809     {
1810       g_error ("cannot create instance of abstract (non-instantiatable) type '%s'",
1811                  type_descriptive_name_I (type));
1812     }
1813
1814   class = g_type_class_ref (type);
1815
1816   /* We allocate the 'private' areas before the normal instance data, in
1817    * reverse order.  This allows the private area of a particular class
1818    * to always be at a constant relative address to the instance data.
1819    * If we stored the private data after the instance data this would
1820    * not be the case (since a subclass that added more instance
1821    * variables would push the private data further along).
1822    *
1823    * This presents problems for valgrindability, of course, so we do a
1824    * workaround for that case.  We identify the start of the object to
1825    * valgrind as an allocated block (so that pointers to objects show up
1826    * as 'reachable' instead of 'possibly lost').  We then add an extra
1827    * pointer at the end of the object, after all instance data, back to
1828    * the start of the private area so that it is also recorded as
1829    * reachable.  We also add extra private space at the start because
1830    * valgrind doesn't seem to like us claiming to have allocated an
1831    * address that it saw allocated by malloc().
1832    */
1833   private_size = node->data->instance.private_size;
1834   ivar_size = node->data->instance.instance_size;
1835
1836   if (private_size && RUNNING_ON_VALGRIND)
1837     {
1838       private_size += ALIGN_STRUCT (1);
1839
1840       /* Allocate one extra pointer size... */
1841       allocated = g_slice_alloc0 (private_size + ivar_size + sizeof (gpointer));
1842       /* ... and point it back to the start of the private data. */
1843       *(gpointer *) (allocated + private_size + ivar_size) = allocated + ALIGN_STRUCT (1);
1844
1845       /* Tell valgrind that it should treat the object itself as such */
1846       VALGRIND_MALLOCLIKE_BLOCK (allocated + private_size, ivar_size + sizeof (gpointer), 0, TRUE);
1847       VALGRIND_MALLOCLIKE_BLOCK (allocated + ALIGN_STRUCT (1), private_size - ALIGN_STRUCT (1), 0, TRUE);
1848     }
1849   else
1850     allocated = g_slice_alloc0 (private_size + ivar_size);
1851
1852   instance = (GTypeInstance *) (allocated + private_size);
1853
1854   for (i = node->n_supers; i > 0; i--)
1855     {
1856       TypeNode *pnode;
1857
1858       pnode = lookup_type_node_I (node->supers[i]);
1859       if (pnode->data->instance.instance_init)
1860         {
1861           instance->g_class = pnode->data->instance.class;
1862           pnode->data->instance.instance_init (instance, class);
1863         }
1864     }
1865
1866   instance->g_class = class;
1867   if (node->data->instance.instance_init)
1868     node->data->instance.instance_init (instance, class);
1869
1870   TRACE(GOBJECT_OBJECT_NEW(instance, type));
1871
1872   return instance;
1873 }
1874
1875 /**
1876  * g_type_free_instance:
1877  * @instance: an instance of a type
1878  *
1879  * Frees an instance of a type, returning it to the instance pool for
1880  * the type, if there is one.
1881  *
1882  * Like g_type_create_instance(), this function is reserved for
1883  * implementors of fundamental types.
1884  */
1885 void
1886 g_type_free_instance (GTypeInstance *instance)
1887 {
1888   TypeNode *node;
1889   GTypeClass *class;
1890   gchar *allocated;
1891   gint private_size;
1892   gint ivar_size;
1893
1894   g_return_if_fail (instance != NULL && instance->g_class != NULL);
1895
1896   class = instance->g_class;
1897   node = lookup_type_node_I (class->g_type);
1898   if (!node || !node->is_instantiatable || !node->data || node->data->class.class != (gpointer) class)
1899     {
1900       g_warning ("cannot free instance of invalid (non-instantiatable) type '%s'",
1901                  type_descriptive_name_I (class->g_type));
1902       return;
1903     }
1904   /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1905   if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (NODE_TYPE (node)))
1906     {
1907       g_warning ("cannot free instance of abstract (non-instantiatable) type '%s'",
1908                  NODE_NAME (node));
1909       return;
1910     }
1911
1912   instance->g_class = NULL;
1913   private_size = node->data->instance.private_size;
1914   ivar_size = node->data->instance.instance_size;
1915   allocated = ((gchar *) instance) - private_size;
1916
1917 #ifdef G_ENABLE_DEBUG
1918   memset (allocated, 0xaa, ivar_size + private_size);
1919 #endif
1920
1921   /* See comment in g_type_create_instance() about what's going on here.
1922    * We're basically unwinding what we put into motion there.
1923    */
1924   if (private_size && RUNNING_ON_VALGRIND)
1925     {
1926       private_size += ALIGN_STRUCT (1);
1927       allocated -= ALIGN_STRUCT (1);
1928
1929       /* Clear out the extra pointer... */
1930       *(gpointer *) (allocated + private_size + ivar_size) = NULL;
1931       /* ... and ensure we include it in the size we free. */
1932       g_slice_free1 (private_size + ivar_size + sizeof (gpointer), allocated);
1933
1934       VALGRIND_FREELIKE_BLOCK (allocated + ALIGN_STRUCT (1), 0);
1935       VALGRIND_FREELIKE_BLOCK (instance, 0);
1936     }
1937   else
1938     g_slice_free1 (private_size + ivar_size, allocated);
1939
1940   g_type_class_unref (class);
1941 }
1942
1943 static void
1944 type_iface_ensure_dflt_vtable_Wm (TypeNode *iface)
1945 {
1946   g_assert (iface->data);
1947
1948   if (!iface->data->iface.dflt_vtable)
1949     {
1950       GTypeInterface *vtable = g_malloc0 (iface->data->iface.vtable_size);
1951       iface->data->iface.dflt_vtable = vtable;
1952       vtable->g_type = NODE_TYPE (iface);
1953       vtable->g_instance_type = 0;
1954       if (iface->data->iface.vtable_init_base ||
1955           iface->data->iface.dflt_init)
1956         {
1957           G_WRITE_UNLOCK (&type_rw_lock);
1958           if (iface->data->iface.vtable_init_base)
1959             iface->data->iface.vtable_init_base (vtable);
1960           if (iface->data->iface.dflt_init)
1961             iface->data->iface.dflt_init (vtable, (gpointer) iface->data->iface.dflt_data);
1962           G_WRITE_LOCK (&type_rw_lock);
1963         }
1964     }
1965 }
1966
1967
1968 /* This is called to allocate and do the first part of initializing
1969  * the interface vtable; type_iface_vtable_iface_init_Wm() does the remainder.
1970  *
1971  * A FALSE return indicates that we didn't find an init function for
1972  * this type/iface pair, so the vtable from the parent type should
1973  * be used. Note that the write lock is not modified upon a FALSE
1974  * return.
1975  */
1976 static gboolean
1977 type_iface_vtable_base_init_Wm (TypeNode *iface,
1978                                 TypeNode *node)
1979 {
1980   IFaceEntry *entry;
1981   IFaceHolder *iholder;
1982   GTypeInterface *vtable = NULL;
1983   TypeNode *pnode;
1984
1985   /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
1986   iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), TRUE);
1987   if (!iholder)
1988     return FALSE;       /* we don't modify write lock upon FALSE */
1989
1990   type_iface_ensure_dflt_vtable_Wm (iface);
1991
1992   entry = type_lookup_iface_entry_L (node, iface);
1993
1994   g_assert (iface->data && entry && entry->vtable == NULL && iholder && iholder->info);
1995
1996   entry->init_state = IFACE_INIT;
1997
1998   pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1999   if (pnode)    /* want to copy over parent iface contents */
2000     {
2001       IFaceEntry *pentry = type_lookup_iface_entry_L (pnode, iface);
2002
2003       if (pentry)
2004         vtable = g_memdup (pentry->vtable, iface->data->iface.vtable_size);
2005     }
2006   if (!vtable)
2007     vtable = g_memdup (iface->data->iface.dflt_vtable, iface->data->iface.vtable_size);
2008   entry->vtable = vtable;
2009   vtable->g_type = NODE_TYPE (iface);
2010   vtable->g_instance_type = NODE_TYPE (node);
2011
2012   if (iface->data->iface.vtable_init_base)
2013     {
2014       G_WRITE_UNLOCK (&type_rw_lock);
2015       iface->data->iface.vtable_init_base (vtable);
2016       G_WRITE_LOCK (&type_rw_lock);
2017     }
2018   return TRUE;  /* initialized the vtable */
2019 }
2020
2021 /* Finishes what type_iface_vtable_base_init_Wm started by
2022  * calling the interface init function.
2023  * this function may only be called for types with their
2024  * own interface holder info, i.e. types for which
2025  * g_type_add_interface*() was called and not children thereof.
2026  */
2027 static void
2028 type_iface_vtable_iface_init_Wm (TypeNode *iface,
2029                                  TypeNode *node)
2030 {
2031   IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2032   IFaceHolder *iholder = type_iface_peek_holder_L (iface, NODE_TYPE (node));
2033   GTypeInterface *vtable = NULL;
2034   guint i;
2035
2036   /* iholder->info should have been filled in by type_iface_vtable_base_init_Wm() */
2037   g_assert (iface->data && entry && iholder && iholder->info);
2038   g_assert (entry->init_state == IFACE_INIT); /* assert prior base_init() */
2039
2040   entry->init_state = INITIALIZED;
2041
2042   vtable = entry->vtable;
2043
2044   if (iholder->info->interface_init)
2045     {
2046       G_WRITE_UNLOCK (&type_rw_lock);
2047       if (iholder->info->interface_init)
2048         iholder->info->interface_init (vtable, iholder->info->interface_data);
2049       G_WRITE_LOCK (&type_rw_lock);
2050     }
2051
2052   for (i = 0; i < static_n_iface_check_funcs; i++)
2053     {
2054       GTypeInterfaceCheckFunc check_func = static_iface_check_funcs[i].check_func;
2055       gpointer check_data = static_iface_check_funcs[i].check_data;
2056
2057       G_WRITE_UNLOCK (&type_rw_lock);
2058       check_func (check_data, (gpointer)vtable);
2059       G_WRITE_LOCK (&type_rw_lock);
2060     }
2061 }
2062
2063 static gboolean
2064 type_iface_vtable_finalize_Wm (TypeNode       *iface,
2065                                TypeNode       *node,
2066                                GTypeInterface *vtable)
2067 {
2068   IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2069   IFaceHolder *iholder;
2070
2071   /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
2072   iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), FALSE);
2073   if (!iholder)
2074     return FALSE;       /* we don't modify write lock upon FALSE */
2075
2076   g_assert (entry && entry->vtable == vtable && iholder->info);
2077
2078   entry->vtable = NULL;
2079   entry->init_state = UNINITIALIZED;
2080   if (iholder->info->interface_finalize || iface->data->iface.vtable_finalize_base)
2081     {
2082       G_WRITE_UNLOCK (&type_rw_lock);
2083       if (iholder->info->interface_finalize)
2084         iholder->info->interface_finalize (vtable, iholder->info->interface_data);
2085       if (iface->data->iface.vtable_finalize_base)
2086         iface->data->iface.vtable_finalize_base (vtable);
2087       G_WRITE_LOCK (&type_rw_lock);
2088     }
2089   vtable->g_type = 0;
2090   vtable->g_instance_type = 0;
2091   g_free (vtable);
2092
2093   type_iface_blow_holder_info_Wm (iface, NODE_TYPE (node));
2094
2095   return TRUE;  /* write lock modified */
2096 }
2097
2098 static void
2099 type_class_init_Wm (TypeNode   *node,
2100                     GTypeClass *pclass)
2101 {
2102   GSList *slist, *init_slist = NULL;
2103   GTypeClass *class;
2104   IFaceEntries *entries;
2105   IFaceEntry *entry;
2106   TypeNode *bnode, *pnode;
2107   guint i;
2108
2109   /* Accessing data->class will work for instantiable types
2110    * too because ClassData is a subset of InstanceData
2111    */
2112   g_assert (node->is_classed && node->data &&
2113             node->data->class.class_size &&
2114             !node->data->class.class &&
2115             node->data->class.init_state == UNINITIALIZED);
2116   if (node->data->class.class_private_size)
2117     class = g_malloc0 (ALIGN_STRUCT (node->data->class.class_size) + node->data->class.class_private_size);
2118   else
2119     class = g_malloc0 (node->data->class.class_size);
2120   node->data->class.class = class;
2121   g_atomic_int_set (&node->data->class.init_state, BASE_CLASS_INIT);
2122
2123   if (pclass)
2124     {
2125       TypeNode *pnode = lookup_type_node_I (pclass->g_type);
2126
2127       memcpy (class, pclass, pnode->data->class.class_size);
2128       memcpy (G_STRUCT_MEMBER_P (class, ALIGN_STRUCT (node->data->class.class_size)), G_STRUCT_MEMBER_P (pclass, ALIGN_STRUCT (pnode->data->class.class_size)), pnode->data->class.class_private_size);
2129
2130       if (node->is_instantiatable)
2131         {
2132           /* We need to initialize the private_size here rather than in
2133            * type_data_make_W() since the class init for the parent
2134            * class may have changed pnode->data->instance.private_size.
2135            */
2136           node->data->instance.private_size = pnode->data->instance.private_size;
2137         }
2138     }
2139   class->g_type = NODE_TYPE (node);
2140
2141   G_WRITE_UNLOCK (&type_rw_lock);
2142
2143   /* stack all base class initialization functions, so we
2144    * call them in ascending order.
2145    */
2146   for (bnode = node; bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2147     if (bnode->data->class.class_init_base)
2148       init_slist = g_slist_prepend (init_slist, (gpointer) bnode->data->class.class_init_base);
2149   for (slist = init_slist; slist; slist = slist->next)
2150     {
2151       GBaseInitFunc class_init_base = (GBaseInitFunc) slist->data;
2152
2153       class_init_base (class);
2154     }
2155   g_slist_free (init_slist);
2156
2157   G_WRITE_LOCK (&type_rw_lock);
2158
2159   g_atomic_int_set (&node->data->class.init_state, BASE_IFACE_INIT);
2160
2161   /* Before we initialize the class, base initialize all interfaces, either
2162    * from parent, or through our holder info
2163    */
2164   pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
2165
2166   i = 0;
2167   while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL &&
2168           i < IFACE_ENTRIES_N_ENTRIES (entries))
2169     {
2170       entry = &entries->entry[i];
2171       while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2172              entry->init_state == IFACE_INIT)
2173         {
2174           entry++;
2175           i++;
2176         }
2177
2178       if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2179         break;
2180
2181       if (!type_iface_vtable_base_init_Wm (lookup_type_node_I (entry->iface_type), node))
2182         {
2183           guint j;
2184           IFaceEntries *pentries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (pnode);
2185
2186           /* need to get this interface from parent, type_iface_vtable_base_init_Wm()
2187            * doesn't modify write lock upon FALSE, so entry is still valid;
2188            */
2189           g_assert (pnode != NULL);
2190
2191           if (pentries)
2192             for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (pentries); j++)
2193               {
2194                 IFaceEntry *pentry = &pentries->entry[j];
2195
2196                 if (pentry->iface_type == entry->iface_type)
2197                   {
2198                     entry->vtable = pentry->vtable;
2199                     entry->init_state = INITIALIZED;
2200                     break;
2201                   }
2202               }
2203           g_assert (entry->vtable != NULL);
2204         }
2205
2206       /* If the write lock was released, additional interface entries might
2207        * have been inserted into CLASSED_NODE_IFACES_ENTRIES (node); they'll
2208        * be base-initialized when inserted, so we don't have to worry that
2209        * we might miss them. Uninitialized entries can only be moved higher
2210        * when new ones are inserted.
2211        */
2212       i++;
2213     }
2214
2215   g_atomic_int_set (&node->data->class.init_state, CLASS_INIT);
2216
2217   G_WRITE_UNLOCK (&type_rw_lock);
2218
2219   if (node->data->class.class_init)
2220     node->data->class.class_init (class, (gpointer) node->data->class.class_data);
2221
2222   G_WRITE_LOCK (&type_rw_lock);
2223
2224   g_atomic_int_set (&node->data->class.init_state, IFACE_INIT);
2225
2226   /* finish initializing the interfaces through our holder info.
2227    * inherited interfaces are already init_state == INITIALIZED, because
2228    * they either got setup in the above base_init loop, or during
2229    * class_init from within type_add_interface_Wm() for this or
2230    * an anchestor type.
2231    */
2232   i = 0;
2233   while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL)
2234     {
2235       entry = &entries->entry[i];
2236       while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2237              entry->init_state == INITIALIZED)
2238         {
2239           entry++;
2240           i++;
2241         }
2242
2243       if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2244         break;
2245
2246       type_iface_vtable_iface_init_Wm (lookup_type_node_I (entry->iface_type), node);
2247
2248       /* As in the loop above, additional initialized entries might be inserted
2249        * if the write lock is released, but that's harmless because the entries
2250        * we need to initialize only move higher in the list.
2251        */
2252       i++;
2253     }
2254
2255   g_atomic_int_set (&node->data->class.init_state, INITIALIZED);
2256 }
2257
2258 static void
2259 type_data_finalize_class_ifaces_Wm (TypeNode *node)
2260 {
2261   guint i;
2262   IFaceEntries *entries;
2263
2264   g_assert (node->is_instantiatable && node->data && node->data->class.class && NODE_REFCOUNT (node) == 0);
2265
2266  reiterate:
2267   entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
2268   for (i = 0; entries != NULL && i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
2269     {
2270       IFaceEntry *entry = &entries->entry[i];
2271       if (entry->vtable)
2272         {
2273           if (type_iface_vtable_finalize_Wm (lookup_type_node_I (entry->iface_type), node, entry->vtable))
2274             {
2275               /* refetch entries, IFACES_ENTRIES might be modified */
2276               goto reiterate;
2277             }
2278           else
2279             {
2280               /* type_iface_vtable_finalize_Wm() doesn't modify write lock upon FALSE,
2281                * iface vtable came from parent
2282                */
2283               entry->vtable = NULL;
2284               entry->init_state = UNINITIALIZED;
2285             }
2286         }
2287     }
2288 }
2289
2290 static void
2291 type_data_finalize_class_U (TypeNode  *node,
2292                             ClassData *cdata)
2293 {
2294   GTypeClass *class = cdata->class;
2295   TypeNode *bnode;
2296
2297   g_assert (cdata->class && NODE_REFCOUNT (node) == 0);
2298
2299   if (cdata->class_finalize)
2300     cdata->class_finalize (class, (gpointer) cdata->class_data);
2301
2302   /* call all base class destruction functions in descending order
2303    */
2304   if (cdata->class_finalize_base)
2305     cdata->class_finalize_base (class);
2306   for (bnode = lookup_type_node_I (NODE_PARENT_TYPE (node)); bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2307     if (bnode->data->class.class_finalize_base)
2308       bnode->data->class.class_finalize_base (class);
2309
2310   g_free (cdata->class);
2311 }
2312
2313 static void
2314 type_data_last_unref_Wm (TypeNode *node,
2315                          gboolean  uncached)
2316 {
2317   g_return_if_fail (node != NULL && node->plugin != NULL);
2318
2319   if (!node->data || NODE_REFCOUNT (node) == 0)
2320     {
2321       g_warning ("cannot drop last reference to unreferenced type '%s'",
2322                  NODE_NAME (node));
2323       return;
2324     }
2325
2326   /* call class cache hooks */
2327   if (node->is_classed && node->data && node->data->class.class && static_n_class_cache_funcs && !uncached)
2328     {
2329       guint i;
2330
2331       G_WRITE_UNLOCK (&type_rw_lock);
2332       G_READ_LOCK (&type_rw_lock);
2333       for (i = 0; i < static_n_class_cache_funcs; i++)
2334         {
2335           GTypeClassCacheFunc cache_func = static_class_cache_funcs[i].cache_func;
2336           gpointer cache_data = static_class_cache_funcs[i].cache_data;
2337           gboolean need_break;
2338
2339           G_READ_UNLOCK (&type_rw_lock);
2340           need_break = cache_func (cache_data, node->data->class.class);
2341           G_READ_LOCK (&type_rw_lock);
2342           if (!node->data || NODE_REFCOUNT (node) == 0)
2343             INVALID_RECURSION ("GType class cache function ", cache_func, NODE_NAME (node));
2344           if (need_break)
2345             break;
2346         }
2347       G_READ_UNLOCK (&type_rw_lock);
2348       G_WRITE_LOCK (&type_rw_lock);
2349     }
2350
2351   /* may have been re-referenced meanwhile */
2352   if (g_atomic_int_dec_and_test ((int *) &node->ref_count))
2353     {
2354       GType ptype = NODE_PARENT_TYPE (node);
2355       TypeData *tdata;
2356
2357       if (node->is_instantiatable)
2358         {
2359           /* destroy node->data->instance.mem_chunk */
2360         }
2361
2362       tdata = node->data;
2363       if (node->is_classed && tdata->class.class)
2364         {
2365           if (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node) != NULL)
2366             type_data_finalize_class_ifaces_Wm (node);
2367           node->mutatable_check_cache = FALSE;
2368           node->data = NULL;
2369           G_WRITE_UNLOCK (&type_rw_lock);
2370           type_data_finalize_class_U (node, &tdata->class);
2371           G_WRITE_LOCK (&type_rw_lock);
2372         }
2373       else if (NODE_IS_IFACE (node) && tdata->iface.dflt_vtable)
2374         {
2375           node->mutatable_check_cache = FALSE;
2376           node->data = NULL;
2377           if (tdata->iface.dflt_finalize || tdata->iface.vtable_finalize_base)
2378             {
2379               G_WRITE_UNLOCK (&type_rw_lock);
2380               if (tdata->iface.dflt_finalize)
2381                 tdata->iface.dflt_finalize (tdata->iface.dflt_vtable, (gpointer) tdata->iface.dflt_data);
2382               if (tdata->iface.vtable_finalize_base)
2383                 tdata->iface.vtable_finalize_base (tdata->iface.dflt_vtable);
2384               G_WRITE_LOCK (&type_rw_lock);
2385             }
2386           g_free (tdata->iface.dflt_vtable);
2387         }
2388       else
2389         {
2390           node->mutatable_check_cache = FALSE;
2391           node->data = NULL;
2392         }
2393
2394       /* freeing tdata->common.value_table and its contents is taken care of
2395        * by allocating it in one chunk with tdata
2396        */
2397       g_free (tdata);
2398
2399       G_WRITE_UNLOCK (&type_rw_lock);
2400       g_type_plugin_unuse (node->plugin);
2401       if (ptype)
2402         type_data_unref_U (lookup_type_node_I (ptype), FALSE);
2403       G_WRITE_LOCK (&type_rw_lock);
2404     }
2405 }
2406
2407 static inline void
2408 type_data_unref_U (TypeNode *node,
2409                    gboolean  uncached)
2410 {
2411   guint current;
2412
2413   do {
2414     current = NODE_REFCOUNT (node);
2415
2416     if (current <= 1)
2417     {
2418       if (!node->plugin)
2419         {
2420           g_warning ("static type '%s' unreferenced too often",
2421                      NODE_NAME (node));
2422           return;
2423         }
2424       else
2425         {
2426           /* This is the last reference of a type from a plugin.  We are
2427            * experimentally disabling support for unloading type
2428            * plugins, so don't allow the last ref to drop.
2429            */
2430           return;
2431         }
2432
2433       g_assert (current > 0);
2434
2435       g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2436       G_WRITE_LOCK (&type_rw_lock);
2437       type_data_last_unref_Wm (node, uncached);
2438       G_WRITE_UNLOCK (&type_rw_lock);
2439       g_rec_mutex_unlock (&class_init_rec_mutex);
2440       return;
2441     }
2442   } while (!g_atomic_int_compare_and_exchange ((int *) &node->ref_count, current, current - 1));
2443 }
2444
2445 /**
2446  * g_type_add_class_cache_func: (skip)
2447  * @cache_data: data to be passed to @cache_func
2448  * @cache_func: a #GTypeClassCacheFunc
2449  *
2450  * Adds a #GTypeClassCacheFunc to be called before the reference count of a
2451  * class goes from one to zero. This can be used to prevent premature class
2452  * destruction. All installed #GTypeClassCacheFunc functions will be chained
2453  * until one of them returns %TRUE. The functions have to check the class id
2454  * passed in to figure whether they actually want to cache the class of this
2455  * type, since all classes are routed through the same #GTypeClassCacheFunc
2456  * chain.
2457  */
2458 void
2459 g_type_add_class_cache_func (gpointer            cache_data,
2460                              GTypeClassCacheFunc cache_func)
2461 {
2462   guint i;
2463
2464   g_return_if_fail (cache_func != NULL);
2465
2466   G_WRITE_LOCK (&type_rw_lock);
2467   i = static_n_class_cache_funcs++;
2468   static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2469   static_class_cache_funcs[i].cache_data = cache_data;
2470   static_class_cache_funcs[i].cache_func = cache_func;
2471   G_WRITE_UNLOCK (&type_rw_lock);
2472 }
2473
2474 /**
2475  * g_type_remove_class_cache_func: (skip)
2476  * @cache_data: data that was given when adding @cache_func
2477  * @cache_func: a #GTypeClassCacheFunc
2478  *
2479  * Removes a previously installed #GTypeClassCacheFunc. The cache
2480  * maintained by @cache_func has to be empty when calling
2481  * g_type_remove_class_cache_func() to avoid leaks.
2482  */
2483 void
2484 g_type_remove_class_cache_func (gpointer            cache_data,
2485                                 GTypeClassCacheFunc cache_func)
2486 {
2487   gboolean found_it = FALSE;
2488   guint i;
2489
2490   g_return_if_fail (cache_func != NULL);
2491
2492   G_WRITE_LOCK (&type_rw_lock);
2493   for (i = 0; i < static_n_class_cache_funcs; i++)
2494     if (static_class_cache_funcs[i].cache_data == cache_data &&
2495         static_class_cache_funcs[i].cache_func == cache_func)
2496       {
2497         static_n_class_cache_funcs--;
2498         memmove (static_class_cache_funcs + i,
2499                  static_class_cache_funcs + i + 1,
2500                  sizeof (static_class_cache_funcs[0]) * (static_n_class_cache_funcs - i));
2501         static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2502         found_it = TRUE;
2503         break;
2504       }
2505   G_WRITE_UNLOCK (&type_rw_lock);
2506
2507   if (!found_it)
2508     g_warning (G_STRLOC ": cannot remove unregistered class cache func %p with data %p",
2509                cache_func, cache_data);
2510 }
2511
2512
2513 /**
2514  * g_type_add_interface_check: (skip)
2515  * @check_data: data to pass to @check_func
2516  * @check_func: function to be called after each interface
2517  *     is initialized
2518  *
2519  * Adds a function to be called after an interface vtable is
2520  * initialized for any class (i.e. after the @interface_init
2521  * member of #GInterfaceInfo has been called).
2522  *
2523  * This function is useful when you want to check an invariant
2524  * that depends on the interfaces of a class. For instance, the
2525  * implementation of #GObject uses this facility to check that an
2526  * object implements all of the properties that are defined on its
2527  * interfaces.
2528  *
2529  * Since: 2.4
2530  */
2531 void
2532 g_type_add_interface_check (gpointer                check_data,
2533                             GTypeInterfaceCheckFunc check_func)
2534 {
2535   guint i;
2536
2537   g_return_if_fail (check_func != NULL);
2538
2539   G_WRITE_LOCK (&type_rw_lock);
2540   i = static_n_iface_check_funcs++;
2541   static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2542   static_iface_check_funcs[i].check_data = check_data;
2543   static_iface_check_funcs[i].check_func = check_func;
2544   G_WRITE_UNLOCK (&type_rw_lock);
2545 }
2546
2547 /**
2548  * g_type_remove_interface_check: (skip)
2549  * @check_data: callback data passed to g_type_add_interface_check()
2550  * @check_func: callback function passed to g_type_add_interface_check()
2551  *
2552  * Removes an interface check function added with
2553  * g_type_add_interface_check().
2554  *
2555  * Since: 2.4
2556  */
2557 void
2558 g_type_remove_interface_check (gpointer                check_data,
2559                                GTypeInterfaceCheckFunc check_func)
2560 {
2561   gboolean found_it = FALSE;
2562   guint i;
2563
2564   g_return_if_fail (check_func != NULL);
2565
2566   G_WRITE_LOCK (&type_rw_lock);
2567   for (i = 0; i < static_n_iface_check_funcs; i++)
2568     if (static_iface_check_funcs[i].check_data == check_data &&
2569         static_iface_check_funcs[i].check_func == check_func)
2570       {
2571         static_n_iface_check_funcs--;
2572         memmove (static_iface_check_funcs + i,
2573                  static_iface_check_funcs + i + 1,
2574                  sizeof (static_iface_check_funcs[0]) * (static_n_iface_check_funcs - i));
2575         static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2576         found_it = TRUE;
2577         break;
2578       }
2579   G_WRITE_UNLOCK (&type_rw_lock);
2580
2581   if (!found_it)
2582     g_warning (G_STRLOC ": cannot remove unregistered class check func %p with data %p",
2583                check_func, check_data);
2584 }
2585
2586 /* --- type registration --- */
2587 /**
2588  * g_type_register_fundamental:
2589  * @type_id: a predefined type identifier
2590  * @type_name: 0-terminated string used as the name of the new type
2591  * @info: #GTypeInfo structure for this type
2592  * @finfo: #GTypeFundamentalInfo structure for this type
2593  * @flags: bitwise combination of #GTypeFlags values
2594  *
2595  * Registers @type_id as the predefined identifier and @type_name as the
2596  * name of a fundamental type. If @type_id is already registered, or a
2597  * type named @type_name is already registered, the behaviour is undefined.
2598  * The type system uses the information contained in the #GTypeInfo structure
2599  * pointed to by @info and the #GTypeFundamentalInfo structure pointed to by
2600  * @finfo to manage the type and its instances. The value of @flags determines
2601  * additional characteristics of the fundamental type.
2602  *
2603  * Returns: the predefined type identifier
2604  */
2605 GType
2606 g_type_register_fundamental (GType                       type_id,
2607                              const gchar                *type_name,
2608                              const GTypeInfo            *info,
2609                              const GTypeFundamentalInfo *finfo,
2610                              GTypeFlags                  flags)
2611 {
2612   TypeNode *node;
2613
2614   g_assert_type_system_initialized ();
2615   g_return_val_if_fail (type_id > 0, 0);
2616   g_return_val_if_fail (type_name != NULL, 0);
2617   g_return_val_if_fail (info != NULL, 0);
2618   g_return_val_if_fail (finfo != NULL, 0);
2619
2620   if (!check_type_name_I (type_name))
2621     return 0;
2622   if ((type_id & TYPE_ID_MASK) ||
2623       type_id > G_TYPE_FUNDAMENTAL_MAX)
2624     {
2625       g_warning ("attempt to register fundamental type '%s' with invalid type id (%" G_GSIZE_FORMAT ")",
2626                  type_name,
2627                  type_id);
2628       return 0;
2629     }
2630   if ((finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
2631       !(finfo->type_flags & G_TYPE_FLAG_CLASSED))
2632     {
2633       g_warning ("cannot register instantiatable fundamental type '%s' as non-classed",
2634                  type_name);
2635       return 0;
2636     }
2637   if (lookup_type_node_I (type_id))
2638     {
2639       g_warning ("cannot register existing fundamental type '%s' (as '%s')",
2640                  type_descriptive_name_I (type_id),
2641                  type_name);
2642       return 0;
2643     }
2644
2645   G_WRITE_LOCK (&type_rw_lock);
2646   node = type_node_fundamental_new_W (type_id, type_name, finfo->type_flags);
2647   type_add_flags_W (node, flags);
2648
2649   if (check_type_info_I (NULL, NODE_FUNDAMENTAL_TYPE (node), type_name, info))
2650     type_data_make_W (node, info,
2651                       check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2652   G_WRITE_UNLOCK (&type_rw_lock);
2653
2654   return NODE_TYPE (node);
2655 }
2656
2657 /**
2658  * g_type_register_static_simple: (skip)
2659  * @parent_type: type from which this type will be derived
2660  * @type_name: 0-terminated string used as the name of the new type
2661  * @class_size: size of the class structure (see #GTypeInfo)
2662  * @class_init: location of the class initialization function (see #GTypeInfo)
2663  * @instance_size: size of the instance structure (see #GTypeInfo)
2664  * @instance_init: location of the instance initialization function (see #GTypeInfo)
2665  * @flags: bitwise combination of #GTypeFlags values
2666  *
2667  * Registers @type_name as the name of a new static type derived from
2668  * @parent_type.  The value of @flags determines the nature (e.g.
2669  * abstract or not) of the type. It works by filling a #GTypeInfo
2670  * struct and calling g_type_register_static().
2671  *
2672  * Since: 2.12
2673  *
2674  * Returns: the new type identifier
2675  */
2676 GType
2677 g_type_register_static_simple (GType             parent_type,
2678                                const gchar      *type_name,
2679                                guint             class_size,
2680                                GClassInitFunc    class_init,
2681                                guint             instance_size,
2682                                GInstanceInitFunc instance_init,
2683                                GTypeFlags        flags)
2684 {
2685   GTypeInfo info;
2686
2687   /* Instances are not allowed to be larger than this. If you have a big
2688    * fixed-length array or something, point to it instead.
2689    */
2690   g_return_val_if_fail (class_size <= G_MAXUINT16, G_TYPE_INVALID);
2691   g_return_val_if_fail (instance_size <= G_MAXUINT16, G_TYPE_INVALID);
2692
2693   info.class_size = class_size;
2694   info.base_init = NULL;
2695   info.base_finalize = NULL;
2696   info.class_init = class_init;
2697   info.class_finalize = NULL;
2698   info.class_data = NULL;
2699   info.instance_size = instance_size;
2700   info.n_preallocs = 0;
2701   info.instance_init = instance_init;
2702   info.value_table = NULL;
2703
2704   return g_type_register_static (parent_type, type_name, &info, flags);
2705 }
2706
2707 /**
2708  * g_type_register_static:
2709  * @parent_type: type from which this type will be derived
2710  * @type_name: 0-terminated string used as the name of the new type
2711  * @info: #GTypeInfo structure for this type
2712  * @flags: bitwise combination of #GTypeFlags values
2713  *
2714  * Registers @type_name as the name of a new static type derived from
2715  * @parent_type. The type system uses the information contained in the
2716  * #GTypeInfo structure pointed to by @info to manage the type and its
2717  * instances (if not abstract). The value of @flags determines the nature
2718  * (e.g. abstract or not) of the type.
2719  *
2720  * Returns: the new type identifier
2721  */
2722 GType
2723 g_type_register_static (GType            parent_type,
2724                         const gchar     *type_name,
2725                         const GTypeInfo *info,
2726                         GTypeFlags       flags)
2727 {
2728   TypeNode *pnode, *node;
2729   GType type = 0;
2730
2731   g_assert_type_system_initialized ();
2732   g_return_val_if_fail (parent_type > 0, 0);
2733   g_return_val_if_fail (type_name != NULL, 0);
2734   g_return_val_if_fail (info != NULL, 0);
2735
2736   if (!check_type_name_I (type_name) ||
2737       !check_derivation_I (parent_type, type_name))
2738     return 0;
2739   if (info->class_finalize)
2740     {
2741       g_warning ("class finalizer specified for static type '%s'",
2742                  type_name);
2743       return 0;
2744     }
2745
2746   pnode = lookup_type_node_I (parent_type);
2747   G_WRITE_LOCK (&type_rw_lock);
2748   type_data_ref_Wm (pnode);
2749   if (check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (pnode), type_name, info))
2750     {
2751       node = type_node_new_W (pnode, type_name, NULL);
2752       type_add_flags_W (node, flags);
2753       type = NODE_TYPE (node);
2754       type_data_make_W (node, info,
2755                         check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2756     }
2757   G_WRITE_UNLOCK (&type_rw_lock);
2758
2759   return type;
2760 }
2761
2762 /**
2763  * g_type_register_dynamic:
2764  * @parent_type: type from which this type will be derived
2765  * @type_name: 0-terminated string used as the name of the new type
2766  * @plugin: #GTypePlugin structure to retrieve the #GTypeInfo from
2767  * @flags: bitwise combination of #GTypeFlags values
2768  *
2769  * Registers @type_name as the name of a new dynamic type derived from
2770  * @parent_type.  The type system uses the information contained in the
2771  * #GTypePlugin structure pointed to by @plugin to manage the type and its
2772  * instances (if not abstract).  The value of @flags determines the nature
2773  * (e.g. abstract or not) of the type.
2774  *
2775  * Returns: the new type identifier or #G_TYPE_INVALID if registration failed
2776  */
2777 GType
2778 g_type_register_dynamic (GType        parent_type,
2779                          const gchar *type_name,
2780                          GTypePlugin *plugin,
2781                          GTypeFlags   flags)
2782 {
2783   TypeNode *pnode, *node;
2784   GType type;
2785
2786   g_assert_type_system_initialized ();
2787   g_return_val_if_fail (parent_type > 0, 0);
2788   g_return_val_if_fail (type_name != NULL, 0);
2789   g_return_val_if_fail (plugin != NULL, 0);
2790
2791   if (!check_type_name_I (type_name) ||
2792       !check_derivation_I (parent_type, type_name) ||
2793       !check_plugin_U (plugin, TRUE, FALSE, type_name))
2794     return 0;
2795
2796   G_WRITE_LOCK (&type_rw_lock);
2797   pnode = lookup_type_node_I (parent_type);
2798   node = type_node_new_W (pnode, type_name, plugin);
2799   type_add_flags_W (node, flags);
2800   type = NODE_TYPE (node);
2801   G_WRITE_UNLOCK (&type_rw_lock);
2802
2803   return type;
2804 }
2805
2806 /**
2807  * g_type_add_interface_static:
2808  * @instance_type: #GType value of an instantiable type
2809  * @interface_type: #GType value of an interface type
2810  * @info: #GInterfaceInfo structure for this
2811  *        (@instance_type, @interface_type) combination
2812  *
2813  * Adds the static @interface_type to @instantiable_type.
2814  * The information contained in the #GInterfaceInfo structure
2815  * pointed to by @info is used to manage the relationship.
2816  */
2817 void
2818 g_type_add_interface_static (GType                 instance_type,
2819                              GType                 interface_type,
2820                              const GInterfaceInfo *info)
2821 {
2822   /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2823   g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2824   g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2825
2826   /* we only need to lock class_init_rec_mutex if instance_type already has its
2827    * class initialized, however this function is rarely enough called to take
2828    * the simple route and always acquire class_init_rec_mutex.
2829    */
2830   g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2831   G_WRITE_LOCK (&type_rw_lock);
2832   if (check_add_interface_L (instance_type, interface_type))
2833     {
2834       TypeNode *node = lookup_type_node_I (instance_type);
2835       TypeNode *iface = lookup_type_node_I (interface_type);
2836       if (check_interface_info_I (iface, NODE_TYPE (node), info))
2837         type_add_interface_Wm (node, iface, info, NULL);
2838     }
2839   G_WRITE_UNLOCK (&type_rw_lock);
2840   g_rec_mutex_unlock (&class_init_rec_mutex);
2841 }
2842
2843 /**
2844  * g_type_add_interface_dynamic:
2845  * @instance_type: #GType value of an instantiable type
2846  * @interface_type: #GType value of an interface type
2847  * @plugin: #GTypePlugin structure to retrieve the #GInterfaceInfo from
2848  *
2849  * Adds the dynamic @interface_type to @instantiable_type. The information
2850  * contained in the #GTypePlugin structure pointed to by @plugin
2851  * is used to manage the relationship.
2852  */
2853 void
2854 g_type_add_interface_dynamic (GType        instance_type,
2855                               GType        interface_type,
2856                               GTypePlugin *plugin)
2857 {
2858   TypeNode *node;
2859   /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2860   g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2861   g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2862
2863   node = lookup_type_node_I (instance_type);
2864   if (!check_plugin_U (plugin, FALSE, TRUE, NODE_NAME (node)))
2865     return;
2866
2867   /* see comment in g_type_add_interface_static() about class_init_rec_mutex */
2868   g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2869   G_WRITE_LOCK (&type_rw_lock);
2870   if (check_add_interface_L (instance_type, interface_type))
2871     {
2872       TypeNode *iface = lookup_type_node_I (interface_type);
2873       type_add_interface_Wm (node, iface, NULL, plugin);
2874     }
2875   G_WRITE_UNLOCK (&type_rw_lock);
2876   g_rec_mutex_unlock (&class_init_rec_mutex);
2877 }
2878
2879
2880 /* --- public API functions --- */
2881 /**
2882  * g_type_class_ref:
2883  * @type: type ID of a classed type
2884  *
2885  * Increments the reference count of the class structure belonging to
2886  * @type. This function will demand-create the class if it doesn't
2887  * exist already.
2888  *
2889  * Returns: (type GObject.TypeClass) (transfer none): the #GTypeClass
2890  *     structure for the given type ID
2891  */
2892 gpointer
2893 g_type_class_ref (GType type)
2894 {
2895   TypeNode *node;
2896   GType ptype;
2897   gboolean holds_ref;
2898   GTypeClass *pclass;
2899
2900   /* optimize for common code path */
2901   node = lookup_type_node_I (type);
2902   if (!node || !node->is_classed)
2903     {
2904       g_warning ("cannot retrieve class for invalid (unclassed) type '%s'",
2905                  type_descriptive_name_I (type));
2906       return NULL;
2907     }
2908
2909   if (G_LIKELY (type_data_ref_U (node)))
2910     {
2911       if (G_LIKELY (g_atomic_int_get (&node->data->class.init_state) == INITIALIZED))
2912         return node->data->class.class;
2913       holds_ref = TRUE;
2914     }
2915   else
2916     holds_ref = FALSE;
2917
2918   /* here, we either have node->data->class.class == NULL, or a recursive
2919    * call to g_type_class_ref() with a partly initialized class, or
2920    * node->data->class.init_state == INITIALIZED, because any
2921    * concurrently running initialization was guarded by class_init_rec_mutex.
2922    */
2923   g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2924
2925   /* we need an initialized parent class for initializing derived classes */
2926   ptype = NODE_PARENT_TYPE (node);
2927   pclass = ptype ? g_type_class_ref (ptype) : NULL;
2928
2929   G_WRITE_LOCK (&type_rw_lock);
2930
2931   if (!holds_ref)
2932     type_data_ref_Wm (node);
2933
2934   if (!node->data->class.class) /* class uninitialized */
2935     type_class_init_Wm (node, pclass);
2936
2937   G_WRITE_UNLOCK (&type_rw_lock);
2938
2939   if (pclass)
2940     g_type_class_unref (pclass);
2941
2942   g_rec_mutex_unlock (&class_init_rec_mutex);
2943
2944   return node->data->class.class;
2945 }
2946
2947 /**
2948  * g_type_class_unref:
2949  * @g_class: (type GObject.TypeClass): a #GTypeClass structure to unref
2950  *
2951  * Decrements the reference count of the class structure being passed in.
2952  * Once the last reference count of a class has been released, classes
2953  * may be finalized by the type system, so further dereferencing of a
2954  * class pointer after g_type_class_unref() are invalid.
2955  */
2956 void
2957 g_type_class_unref (gpointer g_class)
2958 {
2959   TypeNode *node;
2960   GTypeClass *class = g_class;
2961
2962   g_return_if_fail (g_class != NULL);
2963
2964   node = lookup_type_node_I (class->g_type);
2965   if (node && node->is_classed && NODE_REFCOUNT (node))
2966     type_data_unref_U (node, FALSE);
2967   else
2968     g_warning ("cannot unreference class of invalid (unclassed) type '%s'",
2969                type_descriptive_name_I (class->g_type));
2970 }
2971
2972 /**
2973  * g_type_class_unref_uncached: (skip)
2974  * @g_class: (type GObject.TypeClass): a #GTypeClass structure to unref
2975  *
2976  * A variant of g_type_class_unref() for use in #GTypeClassCacheFunc
2977  * implementations. It unreferences a class without consulting the chain
2978  * of #GTypeClassCacheFuncs, avoiding the recursion which would occur
2979  * otherwise.
2980  */
2981 void
2982 g_type_class_unref_uncached (gpointer g_class)
2983 {
2984   TypeNode *node;
2985   GTypeClass *class = g_class;
2986
2987   g_return_if_fail (g_class != NULL);
2988
2989   node = lookup_type_node_I (class->g_type);
2990   if (node && node->is_classed && NODE_REFCOUNT (node))
2991     type_data_unref_U (node, TRUE);
2992   else
2993     g_warning ("cannot unreference class of invalid (unclassed) type '%s'",
2994                type_descriptive_name_I (class->g_type));
2995 }
2996
2997 /**
2998  * g_type_class_peek:
2999  * @type: type ID of a classed type
3000  *
3001  * This function is essentially the same as g_type_class_ref(),
3002  * except that the classes reference count isn't incremented.
3003  * As a consequence, this function may return %NULL if the class
3004  * of the type passed in does not currently exist (hasn't been
3005  * referenced before).
3006  *
3007  * Returns: (type GObject.TypeClass) (transfer none): the #GTypeClass
3008  *     structure for the given type ID or %NULL if the class does not
3009  *     currently exist
3010  */
3011 gpointer
3012 g_type_class_peek (GType type)
3013 {
3014   TypeNode *node;
3015   gpointer class;
3016
3017   node = lookup_type_node_I (type);
3018   if (node && node->is_classed && NODE_REFCOUNT (node) &&
3019       g_atomic_int_get (&node->data->class.init_state) == INITIALIZED)
3020     /* ref_count _may_ be 0 */
3021     class = node->data->class.class;
3022   else
3023     class = NULL;
3024
3025   return class;
3026 }
3027
3028 /**
3029  * g_type_class_peek_static:
3030  * @type: type ID of a classed type
3031  *
3032  * A more efficient version of g_type_class_peek() which works only for
3033  * static types.
3034  *
3035  * Returns: (type GObject.TypeClass) (transfer none): the #GTypeClass
3036  *     structure for the given type ID or %NULL if the class does not
3037  *     currently exist or is dynamically loaded
3038  *
3039  * Since: 2.4
3040  */
3041 gpointer
3042 g_type_class_peek_static (GType type)
3043 {
3044   TypeNode *node;
3045   gpointer class;
3046
3047   node = lookup_type_node_I (type);
3048   if (node && node->is_classed && NODE_REFCOUNT (node) &&
3049       /* peek only static types: */ node->plugin == NULL &&
3050       g_atomic_int_get (&node->data->class.init_state) == INITIALIZED)
3051     /* ref_count _may_ be 0 */
3052     class = node->data->class.class;
3053   else
3054     class = NULL;
3055
3056   return class;
3057 }
3058
3059 /**
3060  * g_type_class_peek_parent:
3061  * @g_class: (type GObject.TypeClass): the #GTypeClass structure to
3062  *     retrieve the parent class for
3063  *
3064  * This is a convenience function often needed in class initializers.
3065  * It returns the class structure of the immediate parent type of the
3066  * class passed in.  Since derived classes hold a reference count on
3067  * their parent classes as long as they are instantiated, the returned
3068  * class will always exist.
3069  *
3070  * This function is essentially equivalent to:
3071  * g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)))
3072  *
3073  * Returns: (type GObject.TypeClass) (transfer none): the parent class
3074  *     of @g_class
3075  */
3076 gpointer
3077 g_type_class_peek_parent (gpointer g_class)
3078 {
3079   TypeNode *node;
3080   gpointer class = NULL;
3081
3082   g_return_val_if_fail (g_class != NULL, NULL);
3083
3084   node = lookup_type_node_I (G_TYPE_FROM_CLASS (g_class));
3085   /* We used to acquire a read lock here. That is not necessary, since
3086    * parent->data->class.class is constant as long as the derived class
3087    * exists.
3088    */
3089   if (node && node->is_classed && node->data && NODE_PARENT_TYPE (node))
3090     {
3091       node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3092       class = node->data->class.class;
3093     }
3094   else if (NODE_PARENT_TYPE (node))
3095     g_warning (G_STRLOC ": invalid class pointer '%p'", g_class);
3096
3097   return class;
3098 }
3099
3100 /**
3101  * g_type_interface_peek:
3102  * @instance_class: (type GObject.TypeClass): a #GTypeClass structure
3103  * @iface_type: an interface ID which this class conforms to
3104  *
3105  * Returns the #GTypeInterface structure of an interface to which the
3106  * passed in class conforms.
3107  *
3108  * Returns: (type GObject.TypeInterface) (transfer none): the #GTypeInterface
3109  *     structure of @iface_type if implemented by @instance_class, %NULL
3110  *     otherwise
3111  */
3112 gpointer
3113 g_type_interface_peek (gpointer instance_class,
3114                        GType    iface_type)
3115 {
3116   TypeNode *node;
3117   TypeNode *iface;
3118   gpointer vtable = NULL;
3119   GTypeClass *class = instance_class;
3120
3121   g_return_val_if_fail (instance_class != NULL, NULL);
3122
3123   node = lookup_type_node_I (class->g_type);
3124   iface = lookup_type_node_I (iface_type);
3125   if (node && node->is_instantiatable && iface)
3126     type_lookup_iface_vtable_I (node, iface, &vtable);
3127   else
3128     g_warning (G_STRLOC ": invalid class pointer '%p'", class);
3129
3130   return vtable;
3131 }
3132
3133 /**
3134  * g_type_interface_peek_parent:
3135  * @g_iface: (type GObject.TypeInterface): a #GTypeInterface structure
3136  *
3137  * Returns the corresponding #GTypeInterface structure of the parent type
3138  * of the instance type to which @g_iface belongs. This is useful when
3139  * deriving the implementation of an interface from the parent type and
3140  * then possibly overriding some methods.
3141  *
3142  * Returns: (transfer none) (type GObject.TypeInterface): the
3143  *     corresponding #GTypeInterface structure of the parent type of the
3144  *     instance type to which @g_iface belongs, or %NULL if the parent
3145  *     type doesn't conform to the interface
3146  */
3147 gpointer
3148 g_type_interface_peek_parent (gpointer g_iface)
3149 {
3150   TypeNode *node;
3151   TypeNode *iface;
3152   gpointer vtable = NULL;
3153   GTypeInterface *iface_class = g_iface;
3154
3155   g_return_val_if_fail (g_iface != NULL, NULL);
3156
3157   iface = lookup_type_node_I (iface_class->g_type);
3158   node = lookup_type_node_I (iface_class->g_instance_type);
3159   if (node)
3160     node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3161   if (node && node->is_instantiatable && iface)
3162     type_lookup_iface_vtable_I (node, iface, &vtable);
3163   else if (node)
3164     g_warning (G_STRLOC ": invalid interface pointer '%p'", g_iface);
3165
3166   return vtable;
3167 }
3168
3169 /**
3170  * g_type_default_interface_ref:
3171  * @g_type: an interface type
3172  *
3173  * Increments the reference count for the interface type @g_type,
3174  * and returns the default interface vtable for the type.
3175  *
3176  * If the type is not currently in use, then the default vtable
3177  * for the type will be created and initalized by calling
3178  * the base interface init and default vtable init functions for
3179  * the type (the @base_init and @class_init members of #GTypeInfo).
3180  * Calling g_type_default_interface_ref() is useful when you
3181  * want to make sure that signals and properties for an interface
3182  * have been installed.
3183  *
3184  * Since: 2.4
3185  *
3186  * Returns: (type GObject.TypeInterface) (transfer none): the default
3187  *     vtable for the interface; call g_type_default_interface_unref()
3188  *     when you are done using the interface.
3189  */
3190 gpointer
3191 g_type_default_interface_ref (GType g_type)
3192 {
3193   TypeNode *node;
3194   gpointer dflt_vtable;
3195
3196   G_WRITE_LOCK (&type_rw_lock);
3197
3198   node = lookup_type_node_I (g_type);
3199   if (!node || !NODE_IS_IFACE (node) ||
3200       (node->data && NODE_REFCOUNT (node) == 0))
3201     {
3202       G_WRITE_UNLOCK (&type_rw_lock);
3203       g_warning ("cannot retrieve default vtable for invalid or non-interface type '%s'",
3204                  type_descriptive_name_I (g_type));
3205       return NULL;
3206     }
3207
3208   if (!node->data || !node->data->iface.dflt_vtable)
3209     {
3210       G_WRITE_UNLOCK (&type_rw_lock);
3211       g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
3212       G_WRITE_LOCK (&type_rw_lock);
3213       node = lookup_type_node_I (g_type);
3214       type_data_ref_Wm (node);
3215       type_iface_ensure_dflt_vtable_Wm (node);
3216       g_rec_mutex_unlock (&class_init_rec_mutex);
3217     }
3218   else
3219     type_data_ref_Wm (node); /* ref_count >= 1 already */
3220
3221   dflt_vtable = node->data->iface.dflt_vtable;
3222   G_WRITE_UNLOCK (&type_rw_lock);
3223
3224   return dflt_vtable;
3225 }
3226
3227 /**
3228  * g_type_default_interface_peek:
3229  * @g_type: an interface type
3230  *
3231  * If the interface type @g_type is currently in use, returns its
3232  * default interface vtable.
3233  *
3234  * Since: 2.4
3235  *
3236  * Returns: (type GObject.TypeInterface) (transfer none): the default
3237  *     vtable for the interface, or %NULL if the type is not currently
3238  *     in use
3239  */
3240 gpointer
3241 g_type_default_interface_peek (GType g_type)
3242 {
3243   TypeNode *node;
3244   gpointer vtable;
3245
3246   node = lookup_type_node_I (g_type);
3247   if (node && NODE_IS_IFACE (node) && NODE_REFCOUNT (node))
3248     vtable = node->data->iface.dflt_vtable;
3249   else
3250     vtable = NULL;
3251
3252   return vtable;
3253 }
3254
3255 /**
3256  * g_type_default_interface_unref:
3257  * @g_iface: (type GObject.TypeInterface): the default vtable
3258  *     structure for a interface, as returned by g_type_default_interface_ref()
3259  *
3260  * Decrements the reference count for the type corresponding to the
3261  * interface default vtable @g_iface. If the type is dynamic, then
3262  * when no one is using the interface and all references have
3263  * been released, the finalize function for the interface's default
3264  * vtable (the @class_finalize member of #GTypeInfo) will be called.
3265  *
3266  * Since: 2.4
3267  */
3268 void
3269 g_type_default_interface_unref (gpointer g_iface)
3270 {
3271   TypeNode *node;
3272   GTypeInterface *vtable = g_iface;
3273
3274   g_return_if_fail (g_iface != NULL);
3275
3276   node = lookup_type_node_I (vtable->g_type);
3277   if (node && NODE_IS_IFACE (node))
3278     type_data_unref_U (node, FALSE);
3279   else
3280     g_warning ("cannot unreference invalid interface default vtable for '%s'",
3281                type_descriptive_name_I (vtable->g_type));
3282 }
3283
3284 /**
3285  * g_type_name:
3286  * @type: type to return name for
3287  *
3288  * Get the unique name that is assigned to a type ID.  Note that this
3289  * function (like all other GType API) cannot cope with invalid type
3290  * IDs. %G_TYPE_INVALID may be passed to this function, as may be any
3291  * other validly registered type ID, but randomized type IDs should
3292  * not be passed in and will most likely lead to a crash.
3293  *
3294  * Returns: static type name or %NULL
3295  */
3296 const gchar *
3297 g_type_name (GType type)
3298 {
3299   TypeNode *node;
3300
3301   g_assert_type_system_initialized ();
3302
3303   node = lookup_type_node_I (type);
3304
3305   return node ? NODE_NAME (node) : NULL;
3306 }
3307
3308 /**
3309  * g_type_qname:
3310  * @type: type to return quark of type name for
3311  *
3312  * Get the corresponding quark of the type IDs name.
3313  *
3314  * Returns: the type names quark or 0
3315  */
3316 GQuark
3317 g_type_qname (GType type)
3318 {
3319   TypeNode *node;
3320
3321   node = lookup_type_node_I (type);
3322
3323   return node ? node->qname : 0;
3324 }
3325
3326 /**
3327  * g_type_from_name:
3328  * @name: type name to lookup
3329  *
3330  * Lookup the type ID from a given type name, returning 0 if no type
3331  * has been registered under this name (this is the preferred method
3332  * to find out by name whether a specific type has been registered
3333  * yet).
3334  *
3335  * Returns: corresponding type ID or 0
3336  */
3337 GType
3338 g_type_from_name (const gchar *name)
3339 {
3340   GType type = 0;
3341
3342   g_return_val_if_fail (name != NULL, 0);
3343
3344   G_READ_LOCK (&type_rw_lock);
3345   type = (GType) g_hash_table_lookup (static_type_nodes_ht, name);
3346   G_READ_UNLOCK (&type_rw_lock);
3347
3348   return type;
3349 }
3350
3351 /**
3352  * g_type_parent:
3353  * @type: the derived type
3354  *
3355  * Return the direct parent type of the passed in type. If the passed
3356  * in type has no parent, i.e. is a fundamental type, 0 is returned.
3357  *
3358  * Returns: the parent type
3359  */
3360 GType
3361 g_type_parent (GType type)
3362 {
3363   TypeNode *node;
3364
3365   node = lookup_type_node_I (type);
3366
3367   return node ? NODE_PARENT_TYPE (node) : 0;
3368 }
3369
3370 /**
3371  * g_type_depth:
3372  * @type: a #GType
3373  *
3374  * Returns the length of the ancestry of the passed in type. This
3375  * includes the type itself, so that e.g. a fundamental type has depth 1.
3376  *
3377  * Returns: the depth of @type
3378  */
3379 guint
3380 g_type_depth (GType type)
3381 {
3382   TypeNode *node;
3383
3384   node = lookup_type_node_I (type);
3385
3386   return node ? node->n_supers + 1 : 0;
3387 }
3388
3389 /**
3390  * g_type_next_base:
3391  * @leaf_type: descendant of @root_type and the type to be returned
3392  * @root_type: immediate parent of the returned type
3393  *
3394  * Given a @leaf_type and a @root_type which is contained in its
3395  * anchestry, return the type that @root_type is the immediate parent
3396  * of. In other words, this function determines the type that is
3397  * derived directly from @root_type which is also a base class of
3398  * @leaf_type.  Given a root type and a leaf type, this function can
3399  * be used to determine the types and order in which the leaf type is
3400  * descended from the root type.
3401  *
3402  * Returns: immediate child of @root_type and anchestor of @leaf_type
3403  */
3404 GType
3405 g_type_next_base (GType type,
3406                   GType base_type)
3407 {
3408   GType atype = 0;
3409   TypeNode *node;
3410
3411   node = lookup_type_node_I (type);
3412   if (node)
3413     {
3414       TypeNode *base_node = lookup_type_node_I (base_type);
3415
3416       if (base_node && base_node->n_supers < node->n_supers)
3417         {
3418           guint n = node->n_supers - base_node->n_supers;
3419
3420           if (node->supers[n] == base_type)
3421             atype = node->supers[n - 1];
3422         }
3423     }
3424
3425   return atype;
3426 }
3427
3428 static inline gboolean
3429 type_node_check_conformities_UorL (TypeNode *node,
3430                                    TypeNode *iface_node,
3431                                    /*        support_inheritance */
3432                                    gboolean  support_interfaces,
3433                                    gboolean  support_prerequisites,
3434                                    gboolean  have_lock)
3435 {
3436   gboolean match;
3437
3438   if (/* support_inheritance && */
3439       NODE_IS_ANCESTOR (iface_node, node))
3440     return TRUE;
3441
3442   support_interfaces = support_interfaces && node->is_instantiatable && NODE_IS_IFACE (iface_node);
3443   support_prerequisites = support_prerequisites && NODE_IS_IFACE (node);
3444   match = FALSE;
3445   if (support_interfaces)
3446     {
3447       if (have_lock)
3448         {
3449           if (type_lookup_iface_entry_L (node, iface_node))
3450             match = TRUE;
3451         }
3452       else
3453         {
3454           if (type_lookup_iface_vtable_I (node, iface_node, NULL))
3455             match = TRUE;
3456         }
3457     }
3458   if (!match &&
3459       support_prerequisites)
3460     {
3461       if (!have_lock)
3462         G_READ_LOCK (&type_rw_lock);
3463       if (support_prerequisites && type_lookup_prerequisite_L (node, NODE_TYPE (iface_node)))
3464         match = TRUE;
3465       if (!have_lock)
3466         G_READ_UNLOCK (&type_rw_lock);
3467     }
3468   return match;
3469 }
3470
3471 static gboolean
3472 type_node_is_a_L (TypeNode *node,
3473                   TypeNode *iface_node)
3474 {
3475   return type_node_check_conformities_UorL (node, iface_node, TRUE, TRUE, TRUE);
3476 }
3477
3478 static inline gboolean
3479 type_node_conforms_to_U (TypeNode *node,
3480                          TypeNode *iface_node,
3481                          gboolean  support_interfaces,
3482                          gboolean  support_prerequisites)
3483 {
3484   return type_node_check_conformities_UorL (node, iface_node, support_interfaces, support_prerequisites, FALSE);
3485 }
3486
3487 /**
3488  * g_type_is_a:
3489  * @type: type to check anchestry for
3490  * @is_a_type: possible anchestor of @type or interface that @type
3491  *     could conform to
3492  *
3493  * If @is_a_type is a derivable type, check whether @type is a
3494  * descendant of @is_a_type. If @is_a_type is an interface, check
3495  * whether @type conforms to it.
3496  *
3497  * Returns: %TRUE if @type is a @is_a_type
3498  */
3499 gboolean
3500 g_type_is_a (GType type,
3501              GType iface_type)
3502 {
3503   TypeNode *node, *iface_node;
3504   gboolean is_a;
3505
3506   node = lookup_type_node_I (type);
3507   iface_node = lookup_type_node_I (iface_type);
3508   is_a = node && iface_node && type_node_conforms_to_U (node, iface_node, TRUE, TRUE);
3509
3510   return is_a;
3511 }
3512
3513 /**
3514  * g_type_children:
3515  * @type: the parent type
3516  * @n_children: (out) (allow-none): location to store the length of
3517  *     the returned array, or %NULL
3518  *
3519  * Return a newly allocated and 0-terminated array of type IDs, listing
3520  * the child types of @type.
3521  *
3522  * Returns: (array length=n_children) (transfer full): Newly allocated
3523  *     and 0-terminated array of child types, free with g_free()
3524  */
3525 GType*
3526 g_type_children (GType  type,
3527                  guint *n_children)
3528 {
3529   TypeNode *node;
3530
3531   node = lookup_type_node_I (type);
3532   if (node)
3533     {
3534       GType *children;
3535
3536       G_READ_LOCK (&type_rw_lock);      /* ->children is relocatable */
3537       children = g_new (GType, node->n_children + 1);
3538       memcpy (children, node->children, sizeof (GType) * node->n_children);
3539       children[node->n_children] = 0;
3540
3541       if (n_children)
3542         *n_children = node->n_children;
3543       G_READ_UNLOCK (&type_rw_lock);
3544
3545       return children;
3546     }
3547   else
3548     {
3549       if (n_children)
3550         *n_children = 0;
3551
3552       return NULL;
3553     }
3554 }
3555
3556 /**
3557  * g_type_interfaces:
3558  * @type: the type to list interface types for
3559  * @n_interfaces: (out) (allow-none): location to store the length of
3560  *     the returned array, or %NULL
3561  *
3562  * Return a newly allocated and 0-terminated array of type IDs, listing
3563  * the interface types that @type conforms to.
3564  *
3565  * Returns: (array length=n_interfaces) (transfer full): Newly allocated
3566  *     and 0-terminated array of interface types, free with g_free()
3567  */
3568 GType*
3569 g_type_interfaces (GType  type,
3570                    guint *n_interfaces)
3571 {
3572   TypeNode *node;
3573
3574   node = lookup_type_node_I (type);
3575   if (node && node->is_instantiatable)
3576     {
3577       IFaceEntries *entries;
3578       GType *ifaces;
3579       guint i;
3580
3581       G_READ_LOCK (&type_rw_lock);
3582       entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
3583       if (entries)
3584         {
3585           ifaces = g_new (GType, IFACE_ENTRIES_N_ENTRIES (entries) + 1);
3586           for (i = 0; i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
3587             ifaces[i] = entries->entry[i].iface_type;
3588         }
3589       else
3590         {
3591           ifaces = g_new (GType, 1);
3592           i = 0;
3593         }
3594       ifaces[i] = 0;
3595
3596       if (n_interfaces)
3597         *n_interfaces = i;
3598       G_READ_UNLOCK (&type_rw_lock);
3599
3600       return ifaces;
3601     }
3602   else
3603     {
3604       if (n_interfaces)
3605         *n_interfaces = 0;
3606
3607       return NULL;
3608     }
3609 }
3610
3611 typedef struct _QData QData;
3612 struct _GData
3613 {
3614   guint  n_qdatas;
3615   QData *qdatas;
3616 };
3617 struct _QData
3618 {
3619   GQuark   quark;
3620   gpointer data;
3621 };
3622
3623 static inline gpointer
3624 type_get_qdata_L (TypeNode *node,
3625                   GQuark    quark)
3626 {
3627   GData *gdata = node->global_gdata;
3628
3629   if (quark && gdata && gdata->n_qdatas)
3630     {
3631       QData *qdatas = gdata->qdatas - 1;
3632       guint n_qdatas = gdata->n_qdatas;
3633
3634       do
3635         {
3636           guint i;
3637           QData *check;
3638
3639           i = (n_qdatas + 1) / 2;
3640           check = qdatas + i;
3641           if (quark == check->quark)
3642             return check->data;
3643           else if (quark > check->quark)
3644             {
3645               n_qdatas -= i;
3646               qdatas = check;
3647             }
3648           else /* if (quark < check->quark) */
3649             n_qdatas = i - 1;
3650         }
3651       while (n_qdatas);
3652     }
3653   return NULL;
3654 }
3655
3656 /**
3657  * g_type_get_qdata:
3658  * @type: a #GType
3659  * @quark: a #GQuark id to identify the data
3660  *
3661  * Obtains data which has previously been attached to @type
3662  * with g_type_set_qdata().
3663  *
3664  * Note that this does not take subtyping into account; data
3665  * attached to one type with g_type_set_qdata() cannot
3666  * be retrieved from a subtype using g_type_get_qdata().
3667  *
3668  * Returns: (transfer none): the data, or %NULL if no data was found
3669  */
3670 gpointer
3671 g_type_get_qdata (GType  type,
3672                   GQuark quark)
3673 {
3674   TypeNode *node;
3675   gpointer data;
3676
3677   node = lookup_type_node_I (type);
3678   if (node)
3679     {
3680       G_READ_LOCK (&type_rw_lock);
3681       data = type_get_qdata_L (node, quark);
3682       G_READ_UNLOCK (&type_rw_lock);
3683     }
3684   else
3685     {
3686       g_return_val_if_fail (node != NULL, NULL);
3687       data = NULL;
3688     }
3689   return data;
3690 }
3691
3692 static inline void
3693 type_set_qdata_W (TypeNode *node,
3694                   GQuark    quark,
3695                   gpointer  data)
3696 {
3697   GData *gdata;
3698   QData *qdata;
3699   guint i;
3700
3701   /* setup qdata list if necessary */
3702   if (!node->global_gdata)
3703     node->global_gdata = g_new0 (GData, 1);
3704   gdata = node->global_gdata;
3705
3706   /* try resetting old data */
3707   qdata = gdata->qdatas;
3708   for (i = 0; i < gdata->n_qdatas; i++)
3709     if (qdata[i].quark == quark)
3710       {
3711         qdata[i].data = data;
3712         return;
3713       }
3714
3715   /* add new entry */
3716   gdata->n_qdatas++;
3717   gdata->qdatas = g_renew (QData, gdata->qdatas, gdata->n_qdatas);
3718   qdata = gdata->qdatas;
3719   for (i = 0; i < gdata->n_qdatas - 1; i++)
3720     if (qdata[i].quark > quark)
3721       break;
3722   memmove (qdata + i + 1, qdata + i, sizeof (qdata[0]) * (gdata->n_qdatas - i - 1));
3723   qdata[i].quark = quark;
3724   qdata[i].data = data;
3725 }
3726
3727 /**
3728  * g_type_set_qdata:
3729  * @type: a #GType
3730  * @quark: a #GQuark id to identify the data
3731  * @data: the data
3732  *
3733  * Attaches arbitrary data to a type.
3734  */
3735 void
3736 g_type_set_qdata (GType    type,
3737                   GQuark   quark,
3738                   gpointer data)
3739 {
3740   TypeNode *node;
3741
3742   g_return_if_fail (quark != 0);
3743
3744   node = lookup_type_node_I (type);
3745   if (node)
3746     {
3747       G_WRITE_LOCK (&type_rw_lock);
3748       type_set_qdata_W (node, quark, data);
3749       G_WRITE_UNLOCK (&type_rw_lock);
3750     }
3751   else
3752     g_return_if_fail (node != NULL);
3753 }
3754
3755 static void
3756 type_add_flags_W (TypeNode  *node,
3757                   GTypeFlags flags)
3758 {
3759   guint dflags;
3760
3761   g_return_if_fail ((flags & ~TYPE_FLAG_MASK) == 0);
3762   g_return_if_fail (node != NULL);
3763
3764   if ((flags & TYPE_FLAG_MASK) && node->is_classed && node->data && node->data->class.class)
3765     g_warning ("tagging type '%s' as abstract after class initialization", NODE_NAME (node));
3766   dflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
3767   dflags |= flags;
3768   type_set_qdata_W (node, static_quark_type_flags, GUINT_TO_POINTER (dflags));
3769 }
3770
3771 /**
3772  * g_type_query:
3773  * @type: #GType of a static, classed type
3774  * @query: (out caller-allocates): a user provided structure that is
3775  *     filled in with constant values upon success
3776  *
3777  * Queries the type system for information about a specific type.
3778  * This function will fill in a user-provided structure to hold
3779  * type-specific information. If an invalid #GType is passed in, the
3780  * @type member of the #GTypeQuery is 0. All members filled into the
3781  * #GTypeQuery structure should be considered constant and have to be
3782  * left untouched.
3783  */
3784 void
3785 g_type_query (GType       type,
3786               GTypeQuery *query)
3787 {
3788   TypeNode *node;
3789
3790   g_return_if_fail (query != NULL);
3791
3792   /* if node is not static and classed, we won't allow query */
3793   query->type = 0;
3794   node = lookup_type_node_I (type);
3795   if (node && node->is_classed && !node->plugin)
3796     {
3797       /* type is classed and probably even instantiatable */
3798       G_READ_LOCK (&type_rw_lock);
3799       if (node->data)   /* type is static or referenced */
3800         {
3801           query->type = NODE_TYPE (node);
3802           query->type_name = NODE_NAME (node);
3803           query->class_size = node->data->class.class_size;
3804           query->instance_size = node->is_instantiatable ? node->data->instance.instance_size : 0;
3805         }
3806       G_READ_UNLOCK (&type_rw_lock);
3807     }
3808 }
3809
3810
3811 /* --- implementation details --- */
3812 gboolean
3813 g_type_test_flags (GType type,
3814                    guint flags)
3815 {
3816   TypeNode *node;
3817   gboolean result = FALSE;
3818
3819   node = lookup_type_node_I (type);
3820   if (node)
3821     {
3822       guint fflags = flags & TYPE_FUNDAMENTAL_FLAG_MASK;
3823       guint tflags = flags & TYPE_FLAG_MASK;
3824
3825       if (fflags)
3826         {
3827           GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (node);
3828
3829           fflags = (finfo->type_flags & fflags) == fflags;
3830         }
3831       else
3832         fflags = TRUE;
3833
3834       if (tflags)
3835         {
3836           G_READ_LOCK (&type_rw_lock);
3837           tflags = (tflags & GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))) == tflags;
3838           G_READ_UNLOCK (&type_rw_lock);
3839         }
3840       else
3841         tflags = TRUE;
3842
3843       result = tflags && fflags;
3844     }
3845
3846   return result;
3847 }
3848
3849 /**
3850  * g_type_get_plugin:
3851  * @type: #GType to retrieve the plugin for
3852  *
3853  * Returns the #GTypePlugin structure for @type.
3854  *
3855  * Returns: (transfer none): the corresponding plugin
3856  *     if @type is a dynamic type, %NULL otherwise
3857  */
3858 GTypePlugin*
3859 g_type_get_plugin (GType type)
3860 {
3861   TypeNode *node;
3862
3863   node = lookup_type_node_I (type);
3864
3865   return node ? node->plugin : NULL;
3866 }
3867
3868 /**
3869  * g_type_interface_get_plugin:
3870  * @instance_type: #GType of an instantiatable type
3871  * @interface_type: #GType of an interface type
3872  *
3873  * Returns the #GTypePlugin structure for the dynamic interface
3874  * @interface_type which has been added to @instance_type, or %NULL
3875  * if @interface_type has not been added to @instance_type or does
3876  * not have a #GTypePlugin structure. See g_type_add_interface_dynamic().
3877  *
3878  * Returns: (transfer none): the #GTypePlugin for the dynamic
3879  *     interface @interface_type of @instance_type
3880  */
3881 GTypePlugin*
3882 g_type_interface_get_plugin (GType instance_type,
3883                              GType interface_type)
3884 {
3885   TypeNode *node;
3886   TypeNode *iface;
3887
3888   g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL);    /* G_TYPE_IS_INTERFACE() is an external call: _U */
3889
3890   node = lookup_type_node_I (instance_type);
3891   iface = lookup_type_node_I (interface_type);
3892   if (node && iface)
3893     {
3894       IFaceHolder *iholder;
3895       GTypePlugin *plugin;
3896
3897       G_READ_LOCK (&type_rw_lock);
3898
3899       iholder = iface_node_get_holders_L (iface);
3900       while (iholder && iholder->instance_type != instance_type)
3901         iholder = iholder->next;
3902       plugin = iholder ? iholder->plugin : NULL;
3903
3904       G_READ_UNLOCK (&type_rw_lock);
3905
3906       return plugin;
3907     }
3908
3909   g_return_val_if_fail (node == NULL, NULL);
3910   g_return_val_if_fail (iface == NULL, NULL);
3911
3912   g_warning (G_STRLOC ": attempt to look up plugin for invalid instance/interface type pair.");
3913
3914   return NULL;
3915 }
3916
3917 /**
3918  * g_type_fundamental_next:
3919  *
3920  * Returns the next free fundamental type id which can be used to
3921  * register a new fundamental type with g_type_register_fundamental().
3922  * The returned type ID represents the highest currently registered
3923  * fundamental type identifier.
3924  *
3925  * Returns: the next available fundamental type ID to be registered,
3926  *     or 0 if the type system ran out of fundamental type IDs
3927  */
3928 GType
3929 g_type_fundamental_next (void)
3930 {
3931   GType type;
3932
3933   G_READ_LOCK (&type_rw_lock);
3934   type = static_fundamental_next;
3935   G_READ_UNLOCK (&type_rw_lock);
3936   type = G_TYPE_MAKE_FUNDAMENTAL (type);
3937   return type <= G_TYPE_FUNDAMENTAL_MAX ? type : 0;
3938 }
3939
3940 /**
3941  * g_type_fundamental:
3942  * @type_id: valid type ID
3943  *
3944  * Internal function, used to extract the fundamental type ID portion.
3945  * Use G_TYPE_FUNDAMENTAL() instead.
3946  *
3947  * Returns: fundamental type ID
3948  */
3949 GType
3950 g_type_fundamental (GType type_id)
3951 {
3952   TypeNode *node = lookup_type_node_I (type_id);
3953
3954   return node ? NODE_FUNDAMENTAL_TYPE (node) : 0;
3955 }
3956
3957 gboolean
3958 g_type_check_instance_is_a (GTypeInstance *type_instance,
3959                             GType          iface_type)
3960 {
3961   TypeNode *node, *iface;
3962   gboolean check;
3963
3964   if (!type_instance || !type_instance->g_class)
3965     return FALSE;
3966
3967   node = lookup_type_node_I (type_instance->g_class->g_type);
3968   iface = lookup_type_node_I (iface_type);
3969   check = node && node->is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
3970
3971   return check;
3972 }
3973
3974 gboolean
3975 g_type_check_class_is_a (GTypeClass *type_class,
3976                          GType       is_a_type)
3977 {
3978   TypeNode *node, *iface;
3979   gboolean check;
3980
3981   if (!type_class)
3982     return FALSE;
3983
3984   node = lookup_type_node_I (type_class->g_type);
3985   iface = lookup_type_node_I (is_a_type);
3986   check = node && node->is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
3987
3988   return check;
3989 }
3990
3991 GTypeInstance*
3992 g_type_check_instance_cast (GTypeInstance *type_instance,
3993                             GType          iface_type)
3994 {
3995   if (type_instance)
3996     {
3997       if (type_instance->g_class)
3998         {
3999           TypeNode *node, *iface;
4000           gboolean is_instantiatable, check;
4001
4002           node = lookup_type_node_I (type_instance->g_class->g_type);
4003           is_instantiatable = node && node->is_instantiatable;
4004           iface = lookup_type_node_I (iface_type);
4005           check = is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
4006           if (check)
4007             return type_instance;
4008
4009           if (is_instantiatable)
4010             g_warning ("invalid cast from '%s' to '%s'",
4011                        type_descriptive_name_I (type_instance->g_class->g_type),
4012                        type_descriptive_name_I (iface_type));
4013           else
4014             g_warning ("invalid uninstantiatable type '%s' in cast to '%s'",
4015                        type_descriptive_name_I (type_instance->g_class->g_type),
4016                        type_descriptive_name_I (iface_type));
4017         }
4018       else
4019         g_warning ("invalid unclassed pointer in cast to '%s'",
4020                    type_descriptive_name_I (iface_type));
4021     }
4022
4023   return type_instance;
4024 }
4025
4026 GTypeClass*
4027 g_type_check_class_cast (GTypeClass *type_class,
4028                          GType       is_a_type)
4029 {
4030   if (type_class)
4031     {
4032       TypeNode *node, *iface;
4033       gboolean is_classed, check;
4034
4035       node = lookup_type_node_I (type_class->g_type);
4036       is_classed = node && node->is_classed;
4037       iface = lookup_type_node_I (is_a_type);
4038       check = is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
4039       if (check)
4040         return type_class;
4041
4042       if (is_classed)
4043         g_warning ("invalid class cast from '%s' to '%s'",
4044                    type_descriptive_name_I (type_class->g_type),
4045                    type_descriptive_name_I (is_a_type));
4046       else
4047         g_warning ("invalid unclassed type '%s' in class cast to '%s'",
4048                    type_descriptive_name_I (type_class->g_type),
4049                    type_descriptive_name_I (is_a_type));
4050     }
4051   else
4052     g_warning ("invalid class cast from (NULL) pointer to '%s'",
4053                type_descriptive_name_I (is_a_type));
4054   return type_class;
4055 }
4056
4057 /**
4058  * g_type_check_instance:
4059  * @instance: a valid #GTypeInstance structure
4060  *
4061  * Private helper function to aid implementation of the
4062  * G_TYPE_CHECK_INSTANCE() macro.
4063  *
4064  * Returns: %TRUE if @instance is valid, %FALSE otherwise
4065  */
4066 gboolean
4067 g_type_check_instance (GTypeInstance *type_instance)
4068 {
4069   /* this function is just here to make the signal system
4070    * conveniently elaborated on instance checks
4071    */
4072   if (type_instance)
4073     {
4074       if (type_instance->g_class)
4075         {
4076           TypeNode *node = lookup_type_node_I (type_instance->g_class->g_type);
4077
4078           if (node && node->is_instantiatable)
4079             return TRUE;
4080
4081           g_warning ("instance of invalid non-instantiatable type '%s'",
4082                      type_descriptive_name_I (type_instance->g_class->g_type));
4083         }
4084       else
4085         g_warning ("instance with invalid (NULL) class pointer");
4086     }
4087   else
4088     g_warning ("invalid (NULL) pointer instance");
4089
4090   return FALSE;
4091 }
4092
4093 static inline gboolean
4094 type_check_is_value_type_U (GType type)
4095 {
4096   GTypeFlags tflags = G_TYPE_FLAG_VALUE_ABSTRACT;
4097   TypeNode *node;
4098
4099   /* common path speed up */
4100   node = lookup_type_node_I (type);
4101   if (node && node->mutatable_check_cache)
4102     return TRUE;
4103
4104   G_READ_LOCK (&type_rw_lock);
4105  restart_check:
4106   if (node)
4107     {
4108       if (node->data && NODE_REFCOUNT (node) > 0 &&
4109           node->data->common.value_table->value_init)
4110         tflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
4111       else if (NODE_IS_IFACE (node))
4112         {
4113           guint i;
4114
4115           for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4116             {
4117               GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4118               TypeNode *prnode = lookup_type_node_I (prtype);
4119
4120               if (prnode->is_instantiatable)
4121                 {
4122                   type = prtype;
4123                   node = lookup_type_node_I (type);
4124                   goto restart_check;
4125                 }
4126             }
4127         }
4128     }
4129   G_READ_UNLOCK (&type_rw_lock);
4130
4131   return !(tflags & G_TYPE_FLAG_VALUE_ABSTRACT);
4132 }
4133
4134 gboolean
4135 g_type_check_is_value_type (GType type)
4136 {
4137   return type_check_is_value_type_U (type);
4138 }
4139
4140 gboolean
4141 g_type_check_value (GValue *value)
4142 {
4143   return value && type_check_is_value_type_U (value->g_type);
4144 }
4145
4146 gboolean
4147 g_type_check_value_holds (GValue *value,
4148                           GType   type)
4149 {
4150   return value && type_check_is_value_type_U (value->g_type) && g_type_is_a (value->g_type, type);
4151 }
4152
4153 /**
4154  * g_type_value_table_peek: (skip)
4155  * @type: a #GType
4156  *
4157  * Returns the location of the #GTypeValueTable associated with @type.
4158  *
4159  * Note that this function should only be used from source code
4160  * that implements or has internal knowledge of the implementation of
4161  * @type.
4162  *
4163  * Returns: location of the #GTypeValueTable associated with @type or
4164  *     %NULL if there is no #GTypeValueTable associated with @type
4165  */
4166 GTypeValueTable*
4167 g_type_value_table_peek (GType type)
4168 {
4169   GTypeValueTable *vtable = NULL;
4170   TypeNode *node = lookup_type_node_I (type);
4171   gboolean has_refed_data, has_table;
4172
4173   if (node && NODE_REFCOUNT (node) && node->mutatable_check_cache)
4174     return node->data->common.value_table;
4175
4176   G_READ_LOCK (&type_rw_lock);
4177
4178  restart_table_peek:
4179   has_refed_data = node && node->data && NODE_REFCOUNT (node) > 0;
4180   has_table = has_refed_data && node->data->common.value_table->value_init;
4181   if (has_refed_data)
4182     {
4183       if (has_table)
4184         vtable = node->data->common.value_table;
4185       else if (NODE_IS_IFACE (node))
4186         {
4187           guint i;
4188
4189           for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4190             {
4191               GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4192               TypeNode *prnode = lookup_type_node_I (prtype);
4193
4194               if (prnode->is_instantiatable)
4195                 {
4196                   type = prtype;
4197                   node = lookup_type_node_I (type);
4198                   goto restart_table_peek;
4199                 }
4200             }
4201         }
4202     }
4203
4204   G_READ_UNLOCK (&type_rw_lock);
4205
4206   if (vtable)
4207     return vtable;
4208
4209   if (!node)
4210     g_warning (G_STRLOC ": type id '%" G_GSIZE_FORMAT "' is invalid", type);
4211   if (!has_refed_data)
4212     g_warning ("can't peek value table for type '%s' which is not currently referenced",
4213                type_descriptive_name_I (type));
4214
4215   return NULL;
4216 }
4217
4218 const gchar *
4219 g_type_name_from_instance (GTypeInstance *instance)
4220 {
4221   if (!instance)
4222     return "<NULL-instance>";
4223   else
4224     return g_type_name_from_class (instance->g_class);
4225 }
4226
4227 const gchar *
4228 g_type_name_from_class (GTypeClass *g_class)
4229 {
4230   if (!g_class)
4231     return "<NULL-class>";
4232   else
4233     return g_type_name (g_class->g_type);
4234 }
4235
4236
4237 /* --- private api for gboxed.c --- */
4238 gpointer
4239 _g_type_boxed_copy (GType type, gpointer value)
4240 {
4241   TypeNode *node = lookup_type_node_I (type);
4242
4243   return node->data->boxed.copy_func (value);
4244 }
4245
4246 void
4247 _g_type_boxed_free (GType type, gpointer value)
4248 {
4249   TypeNode *node = lookup_type_node_I (type);
4250
4251   node->data->boxed.free_func (value);
4252 }
4253
4254 void
4255 _g_type_boxed_init (GType          type,
4256                     GBoxedCopyFunc copy_func,
4257                     GBoxedFreeFunc free_func)
4258 {
4259   TypeNode *node = lookup_type_node_I (type);
4260
4261   node->data->boxed.copy_func = copy_func;
4262   node->data->boxed.free_func = free_func;
4263 }
4264
4265 /* --- initialization --- */
4266 /**
4267  * g_type_init_with_debug_flags:
4268  * @debug_flags: bitwise combination of #GTypeDebugFlags values for
4269  *     debugging purposes
4270  *
4271  * This function used to initialise the type system with debugging
4272  * flags.  Since GLib 2.36, the type system is initialised automatically
4273  * and this function does nothing.
4274  *
4275  * If you need to enable debugging features, use the GOBJECT_DEBUG
4276  * environment variable.
4277  *
4278  * Deprecated: 2.36: the type system is now initialised automatically
4279  */
4280 void
4281 g_type_init_with_debug_flags (GTypeDebugFlags debug_flags)
4282 {
4283   g_assert_type_system_initialized ();
4284
4285   if (debug_flags)
4286     g_message ("g_type_init_with_debug_flags() is no longer supported.  Use the GOBJECT_DEBUG environment variable.");
4287 }
4288
4289 /**
4290  * g_type_init:
4291  *
4292  * This function used to initialise the type system.  Since GLib 2.36,
4293  * the type system is initialised automatically and this function does
4294  * nothing.
4295  *
4296  * Deprecated: 2.36: the type system is now initialised automatically
4297  */
4298 void
4299 g_type_init (void)
4300 {
4301   g_assert_type_system_initialized ();
4302 }
4303
4304 #if defined (G_HAS_CONSTRUCTORS)
4305 #ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA
4306 #pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(gobject_init_ctor)
4307 #endif
4308 G_DEFINE_CONSTRUCTOR(gobject_init_ctor)
4309 #else
4310 # error Your platform/compiler is missing constructor support
4311 #endif
4312
4313 static void
4314 gobject_init_ctor (void)
4315 {
4316   const gchar *env_string;
4317   GTypeInfo info;
4318   TypeNode *node;
4319   GType type;
4320
4321   G_WRITE_LOCK (&type_rw_lock);
4322
4323   /* setup GObject library wide debugging flags */
4324   env_string = g_getenv ("GOBJECT_DEBUG");
4325   if (env_string != NULL)
4326     {
4327       GDebugKey debug_keys[] = {
4328         { "objects", G_TYPE_DEBUG_OBJECTS },
4329         { "signals", G_TYPE_DEBUG_SIGNALS },
4330       };
4331
4332       _g_type_debug_flags = g_parse_debug_string (env_string, debug_keys, G_N_ELEMENTS (debug_keys));
4333     }
4334
4335   /* quarks */
4336   static_quark_type_flags = g_quark_from_static_string ("-g-type-private--GTypeFlags");
4337   static_quark_iface_holder = g_quark_from_static_string ("-g-type-private--IFaceHolder");
4338   static_quark_dependants_array = g_quark_from_static_string ("-g-type-private--dependants-array");
4339
4340   /* type qname hash table */
4341   static_type_nodes_ht = g_hash_table_new (g_str_hash, g_str_equal);
4342
4343   /* invalid type G_TYPE_INVALID (0)
4344    */
4345   static_fundamental_type_nodes[0] = NULL;
4346
4347   /* void type G_TYPE_NONE
4348    */
4349   node = type_node_fundamental_new_W (G_TYPE_NONE, g_intern_static_string ("void"), 0);
4350   type = NODE_TYPE (node);
4351   g_assert (type == G_TYPE_NONE);
4352
4353   /* interface fundamental type G_TYPE_INTERFACE (!classed)
4354    */
4355   memset (&info, 0, sizeof (info));
4356   node = type_node_fundamental_new_W (G_TYPE_INTERFACE, g_intern_static_string ("GInterface"), G_TYPE_FLAG_DERIVABLE);
4357   type = NODE_TYPE (node);
4358   type_data_make_W (node, &info, NULL);
4359   g_assert (type == G_TYPE_INTERFACE);
4360
4361   G_WRITE_UNLOCK (&type_rw_lock);
4362
4363   _g_value_c_init ();
4364
4365   /* G_TYPE_TYPE_PLUGIN
4366    */
4367   g_type_ensure (g_type_plugin_get_type ());
4368
4369   /* G_TYPE_* value types
4370    */
4371   _g_value_types_init ();
4372
4373   /* G_TYPE_ENUM & G_TYPE_FLAGS
4374    */
4375   _g_enum_types_init ();
4376
4377   /* G_TYPE_BOXED
4378    */
4379   _g_boxed_type_init ();
4380
4381   /* G_TYPE_PARAM
4382    */
4383   _g_param_type_init ();
4384
4385   /* G_TYPE_OBJECT
4386    */
4387   _g_object_type_init ();
4388
4389   /* G_TYPE_PARAM_* pspec types
4390    */
4391   _g_param_spec_types_init ();
4392
4393   /* Value Transformations
4394    */
4395   _g_value_transforms_init ();
4396
4397   /* Signal system
4398    */
4399   _g_signal_init ();
4400 }
4401
4402 /**
4403  * g_type_class_add_private:
4404  * @g_class: class structure for an instantiatable type
4405  * @private_size: size of private structure
4406  *
4407  * Registers a private structure for an instantiatable type.
4408  *
4409  * When an object is allocated, the private structures for
4410  * the type and all of its parent types are allocated
4411  * sequentially in the same memory block as the public
4412  * structures.
4413  *
4414  * Note that the accumulated size of the private structures of
4415  * a type and all its parent types cannot exceed 64 KiB.
4416  *
4417  * This function should be called in the type's class_init() function.
4418  * The private structure can be retrieved using the
4419  * G_TYPE_INSTANCE_GET_PRIVATE() macro.
4420  *
4421  * The following example shows attaching a private structure
4422  * MyObjectPrivate to an object MyObject defined in the standard
4423  * GObject fashion in the type's class_init() function.
4424  *
4425  * Note the use of a structure member "priv" to avoid the overhead
4426  * of repeatedly calling MY_OBJECT_GET_PRIVATE().
4427  *
4428  * |[<!-- language="C" -->
4429  * typedef struct _MyObject        MyObject;
4430  * typedef struct _MyObjectPrivate MyObjectPrivate;
4431  *
4432  * struct _MyObject {
4433  *  GObject parent;
4434  *
4435  *  MyObjectPrivate *priv;
4436  * };
4437  *
4438  * struct _MyObjectPrivate {
4439  *   int some_field;
4440  * };
4441  *
4442  * static void
4443  * my_object_class_init (MyObjectClass *klass)
4444  * {
4445  *   g_type_class_add_private (klass, sizeof (MyObjectPrivate));
4446  * }
4447  *
4448  * static void
4449  * my_object_init (MyObject *my_object)
4450  * {
4451  *   my_object->priv = G_TYPE_INSTANCE_GET_PRIVATE (my_object,
4452  *                                                  MY_TYPE_OBJECT,
4453  *                                                  MyObjectPrivate);
4454  * }
4455  *
4456  * static int
4457  * my_object_get_some_field (MyObject *my_object)
4458  * {
4459  *   MyObjectPrivate *priv;
4460  *
4461  *   g_return_val_if_fail (MY_IS_OBJECT (my_object), 0);
4462  *
4463  *   priv = my_object->priv;
4464  *
4465  *   return priv->some_field;
4466  * }
4467  * ]|
4468  *
4469  * Since: 2.4
4470  */
4471 void
4472 g_type_class_add_private (gpointer g_class,
4473                           gsize    private_size)
4474 {
4475   GType instance_type = ((GTypeClass *)g_class)->g_type;
4476   TypeNode *node = lookup_type_node_I (instance_type);
4477
4478   g_return_if_fail (private_size > 0);
4479   g_return_if_fail (private_size <= 0xffff);
4480
4481   if (!node || !node->is_instantiatable || !node->data || node->data->class.class != g_class)
4482     {
4483       g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4484                  type_descriptive_name_I (instance_type));
4485       return;
4486     }
4487
4488   if (NODE_PARENT_TYPE (node))
4489     {
4490       TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4491       if (node->data->instance.private_size != pnode->data->instance.private_size)
4492         {
4493           g_warning ("g_type_class_add_private() called multiple times for the same type");
4494           return;
4495         }
4496     }
4497
4498   G_WRITE_LOCK (&type_rw_lock);
4499
4500   private_size = ALIGN_STRUCT (node->data->instance.private_size + private_size);
4501   g_assert (private_size <= 0xffff);
4502   node->data->instance.private_size = private_size;
4503
4504   G_WRITE_UNLOCK (&type_rw_lock);
4505 }
4506
4507 /* semi-private, called only by the G_ADD_PRIVATE macro */
4508 gint
4509 g_type_add_instance_private (GType class_gtype,
4510                              gsize private_size)
4511 {
4512   TypeNode *node = lookup_type_node_I (class_gtype);
4513
4514   g_return_val_if_fail (private_size > 0, 0);
4515   g_return_val_if_fail (private_size <= 0xffff, 0);
4516
4517   if (!node || !node->is_classed || !node->is_instantiatable || !node->data)
4518     {
4519       g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4520                  type_descriptive_name_I (class_gtype));
4521       return 0;
4522     }
4523
4524   if (node->plugin != NULL)
4525     {
4526       g_warning ("cannot use g_type_add_instance_private() with dynamic type '%s'",
4527                  type_descriptive_name_I (class_gtype));
4528       return 0;
4529     }
4530
4531   /* in the future, we want to register the private data size of a type
4532    * directly from the get_type() implementation so that we can take full
4533    * advantage of the type definition macros that we already have.
4534    *
4535    * unfortunately, this does not behave correctly if a class in the middle
4536    * of the type hierarchy uses the "old style" of private data registration
4537    * from the class_init() implementation, as the private data offset is not
4538    * going to be known until the full class hierarchy is initialized.
4539    *
4540    * in order to transition our code to the Glorious New Future™, we proceed
4541    * with a two-step implementation: first, we provide this new function to
4542    * register the private data size in the get_type() implementation and we
4543    * hide it behind a macro. the function will return the private size, instead
4544    * of the offset, which will be stored inside a static variable defined by
4545    * the G_DEFINE_TYPE_EXTENDED macro. the G_DEFINE_TYPE_EXTENDED macro will
4546    * check the variable and call g_type_class_add_instance_private(), which
4547    * will use the data size and actually register the private data, then
4548    * return the computed offset of the private data, which will be stored
4549    * inside the static variable, so we can use it to retrieve the pointer
4550    * to the private data structure.
4551    *
4552    * once all our code has been migrated to the new idiomatic form of private
4553    * data registration, we will change the g_type_add_instance_private()
4554    * function to actually perform the registration and return the offset
4555    * of the private data; g_type_class_add_instance_private() already checks
4556    * if the passed argument is negative (meaning that it's an offset in the
4557    * GTypeInstance allocation) and becomes a no-op if that's the case. this
4558    * should make the migration fully transparent even if we're effectively
4559    * copying this macro into everybody's code.
4560    */
4561   return private_size;
4562 }
4563
4564 /* semi-private function, should only be used by G_DEFINE_TYPE_EXTENDED */
4565 void
4566 g_type_class_adjust_private_offset (gpointer  g_class,
4567                                     gint     *private_size_or_offset)
4568 {
4569   GType class_gtype = ((GTypeClass *) g_class)->g_type;
4570   TypeNode *node = lookup_type_node_I (class_gtype);
4571   gssize private_size;
4572
4573   g_return_if_fail (private_size_or_offset != NULL);
4574
4575   /* if we have been passed the offset instead of the private data size,
4576    * then we consider this as a no-op, and just return the value. see the
4577    * comment in g_type_add_instance_private() for the full explanation.
4578    */
4579   if (*private_size_or_offset > 0)
4580     g_return_if_fail (*private_size_or_offset <= 0xffff);
4581   else
4582     return;
4583
4584   if (!node || !node->is_classed || !node->is_instantiatable || !node->data)
4585     {
4586       g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4587                  type_descriptive_name_I (class_gtype));
4588       *private_size_or_offset = 0;
4589       return;
4590     }
4591
4592   if (NODE_PARENT_TYPE (node))
4593     {
4594       TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4595       if (node->data->instance.private_size != pnode->data->instance.private_size)
4596         {
4597           g_warning ("g_type_add_instance_private() called multiple times for the same type");
4598           *private_size_or_offset = 0;
4599           return;
4600         }
4601     }
4602
4603   G_WRITE_LOCK (&type_rw_lock);
4604
4605   private_size = ALIGN_STRUCT (node->data->instance.private_size + *private_size_or_offset);
4606   g_assert (private_size <= 0xffff);
4607   node->data->instance.private_size = private_size;
4608
4609   *private_size_or_offset = -(gint) node->data->instance.private_size;
4610
4611   G_WRITE_UNLOCK (&type_rw_lock);
4612 }
4613
4614 gpointer
4615 g_type_instance_get_private (GTypeInstance *instance,
4616                              GType          private_type)
4617 {
4618   TypeNode *node;
4619
4620   g_return_val_if_fail (instance != NULL && instance->g_class != NULL, NULL);
4621
4622   node = lookup_type_node_I (private_type);
4623   if (G_UNLIKELY (!node || !node->is_instantiatable))
4624     {
4625       g_warning ("instance of invalid non-instantiatable type '%s'",
4626                  type_descriptive_name_I (instance->g_class->g_type));
4627       return NULL;
4628     }
4629
4630   return ((gchar *) instance) - node->data->instance.private_size;
4631 }
4632
4633 /**
4634  * g_type_class_get_instance_private_offset: (skip)
4635  * @g_class: a #GTypeClass
4636  *
4637  * Gets the offset of the private data for instances of @g_class.
4638  *
4639  * This is how many bytes you should add to the instance pointer of a
4640  * class in order to get the private data for the type represented by
4641  * @g_class.
4642  *
4643  * You can only call this function after you have registered a private
4644  * data area for @g_class using g_type_class_add_private().
4645  *
4646  * Returns: the offset, in bytes
4647  *
4648  * Since: 2.38
4649  **/
4650 gint
4651 g_type_class_get_instance_private_offset (gpointer g_class)
4652 {
4653   GType instance_type;
4654   guint16 parent_size;
4655   TypeNode *node;
4656
4657   g_assert (g_class != NULL);
4658
4659   instance_type = ((GTypeClass *) g_class)->g_type;
4660   node = lookup_type_node_I (instance_type);
4661
4662   g_assert (node != NULL);
4663   g_assert (node->is_instantiatable);
4664
4665   if (NODE_PARENT_TYPE (node))
4666     {
4667       TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4668
4669       parent_size = pnode->data->instance.private_size;
4670     }
4671   else
4672     parent_size = 0;
4673
4674   if (node->data->instance.private_size == parent_size)
4675     g_error ("g_type_class_get_instance_private_offset() called on class %s but it has no private data",
4676              g_type_name (instance_type));
4677
4678   return -(gint) node->data->instance.private_size;
4679 }
4680
4681 /**
4682  * g_type_add_class_private:
4683  * @class_type: GType of an classed type
4684  * @private_size: size of private structure
4685  *
4686  * Registers a private class structure for a classed type;
4687  * when the class is allocated, the private structures for
4688  * the class and all of its parent types are allocated
4689  * sequentially in the same memory block as the public
4690  * structures. This function should be called in the
4691  * type's get_type() function after the type is registered.
4692  * The private structure can be retrieved using the
4693  * G_TYPE_CLASS_GET_PRIVATE() macro.
4694  *
4695  * Since: 2.24
4696  */
4697 void
4698 g_type_add_class_private (GType    class_type,
4699                           gsize    private_size)
4700 {
4701   TypeNode *node = lookup_type_node_I (class_type);
4702   gsize offset;
4703
4704   g_return_if_fail (private_size > 0);
4705
4706   if (!node || !node->is_classed || !node->data)
4707     {
4708       g_warning ("cannot add class private field to invalid type '%s'",
4709                  type_descriptive_name_I (class_type));
4710       return;
4711     }
4712
4713   if (NODE_PARENT_TYPE (node))
4714     {
4715       TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4716       if (node->data->class.class_private_size != pnode->data->class.class_private_size)
4717         {
4718           g_warning ("g_type_add_class_private() called multiple times for the same type");
4719           return;
4720         }
4721     }
4722
4723   G_WRITE_LOCK (&type_rw_lock);
4724
4725   offset = ALIGN_STRUCT (node->data->class.class_private_size);
4726   node->data->class.class_private_size = offset + private_size;
4727
4728   G_WRITE_UNLOCK (&type_rw_lock);
4729 }
4730
4731 gpointer
4732 g_type_class_get_private (GTypeClass *klass,
4733                           GType       private_type)
4734 {
4735   TypeNode *class_node;
4736   TypeNode *private_node;
4737   TypeNode *parent_node;
4738   gsize offset;
4739
4740   g_return_val_if_fail (klass != NULL, NULL);
4741
4742   class_node = lookup_type_node_I (klass->g_type);
4743   if (G_UNLIKELY (!class_node || !class_node->is_classed))
4744     {
4745       g_warning ("class of invalid type '%s'",
4746                  type_descriptive_name_I (klass->g_type));
4747       return NULL;
4748     }
4749
4750   private_node = lookup_type_node_I (private_type);
4751   if (G_UNLIKELY (!private_node || !NODE_IS_ANCESTOR (private_node, class_node)))
4752     {
4753       g_warning ("attempt to retrieve private data for invalid type '%s'",
4754                  type_descriptive_name_I (private_type));
4755       return NULL;
4756     }
4757
4758   offset = ALIGN_STRUCT (class_node->data->class.class_size);
4759
4760   if (NODE_PARENT_TYPE (private_node))
4761     {
4762       parent_node = lookup_type_node_I (NODE_PARENT_TYPE (private_node));
4763       g_assert (parent_node->data && NODE_REFCOUNT (parent_node) > 0);
4764
4765       if (G_UNLIKELY (private_node->data->class.class_private_size == parent_node->data->class.class_private_size))
4766         {
4767           g_warning ("g_type_instance_get_class_private() requires a prior call to g_type_add_class_private()");
4768           return NULL;
4769         }
4770
4771       offset += ALIGN_STRUCT (parent_node->data->class.class_private_size);
4772     }
4773
4774   return G_STRUCT_MEMBER_P (klass, offset);
4775 }
4776
4777 /**
4778  * g_type_ensure:
4779  * @type: a #GType
4780  *
4781  * Ensures that the indicated @type has been registered with the
4782  * type system, and its _class_init() method has been run.
4783  *
4784  * In theory, simply calling the type's _get_type() method (or using
4785  * the corresponding macro) is supposed take care of this. However,
4786  * _get_type() methods are often marked %G_GNUC_CONST for performance
4787  * reasons, even though this is technically incorrect (since
4788  * %G_GNUC_CONST requires that the function not have side effects,
4789  * which _get_type() methods do on the first call). As a result, if
4790  * you write a bare call to a _get_type() macro, it may get optimized
4791  * out by the compiler. Using g_type_ensure() guarantees that the
4792  * type's _get_type() method is called.
4793  *
4794  * Since: 2.34
4795  */
4796 void
4797 g_type_ensure (GType type)
4798 {
4799   /* In theory, @type has already been resolved and so there's nothing
4800    * to do here. But this protects us in the case where the function
4801    * gets inlined (as it might in gobject_init_ctor() above).
4802    */
4803   if (G_UNLIKELY (type == (GType)-1))
4804     g_error ("can't happen");
4805 }
4806
4807 gboolean
4808 g_type_is_in_init (GType type)
4809 {
4810   TypeNode *node;
4811
4812   node = lookup_type_node_I (type);
4813
4814   return node->data->class.init_state != INITIALIZED;
4815 }