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