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