gobject/gtype.c

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