1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
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.
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.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
26 #include "../glib/valgrind.h"
30 #include "gtype-private.h"
31 #include "gtypeplugin.h"
32 #include "gvaluecollector.h"
33 #include "gbsearcharray.h"
34 #include "gatomicarray.h"
35 #include "gobject_trace.h"
37 #include "gconstructor.h"
42 * @short_description: The GLib Runtime type identification and
44 * @title:Type Information
46 * The GType API is the foundation of the GObject system. It provides the
47 * facilities for registering and managing all fundamental data types,
48 * user-defined object and interface types.
50 * For type creation and registration purposes, all types fall into one of
51 * two categories: static or dynamic. Static types are never loaded or
52 * unloaded at run-time as dynamic types may be. Static types are created
53 * with g_type_register_static() that gets type specific information passed
54 * in via a #GTypeInfo structure.
55 * Dynamic types are created with g_type_register_dynamic() which takes a
56 * #GTypePlugin structure instead. The remaining type information (the
57 * #GTypeInfo structure) is retrieved during runtime through #GTypePlugin
58 * and the g_type_plugin_*() API.
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 * There is also a third registration function for registering fundamental
65 * types called g_type_register_fundamental() which requires both a #GTypeInfo
66 * structure and a #GTypeFundamentalInfo structure but it is seldom used
67 * since most fundamental types are predefined rather than user-defined.
69 * Type instance and class structs are limited to a total of 64 KiB,
70 * including all parent types. Similarly, type instances' private data
71 * (as created by g_type_class_add_private()) are limited to a total of
72 * 64 KiB. If a type instance needs a large static buffer, allocate it
73 * separately (typically by using #GArray or #GPtrArray) and put a pointer
74 * to the buffer in the structure.
76 * A final word about type names.
77 * Such an identifier needs to be at least three characters long. There is no
78 * upper length limit. The first character needs to be a letter (a-z or A-Z)
79 * or an underscore '_'. Subsequent characters can be letters, numbers or
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.
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
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)
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)
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); \
128 g_error ("%s(%p)%s`%s'", _fname, _arg, _action, _tname); \
130 g_error ("%s()%s`%s'", _fname, _action, _tname); \
132 #define g_assert_type_system_initialized() \
133 g_assert (static_quark_type_flags)
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) \
140 #else /* !G_ENABLE_DEBUG */
141 #define DEBUG_CODE(debug_type, code_block) /* code_block */
142 #endif /* G_ENABLE_DEBUG */
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)), \
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.
161 #define STRUCT_ALIGNMENT (2 * sizeof (gsize))
162 #define ALIGN_STRUCT(offset) \
163 ((offset + (STRUCT_ALIGNMENT - 1)) & -STRUCT_ALIGNMENT)
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;
179 /* --- prototypes --- */
180 static inline GTypeFundamentalInfo* type_node_fundamental_info_I (TypeNode *node);
181 static void type_add_flags_W (TypeNode *node,
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,
189 static void type_data_last_unref_Wm (TypeNode * node,
191 static inline gpointer type_get_qdata_L (TypeNode *node,
193 static inline void type_set_qdata_W (TypeNode *node,
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,
200 static void type_iface_vtable_iface_init_Wm (TypeNode *iface,
202 static gboolean type_node_is_a_L (TypeNode *node,
203 TypeNode *iface_node);
206 /* --- enumeration --- */
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.
223 /* --- structures --- */
226 guint volatile ref_count;
228 guint n_children; /* writable with lock */
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;
239 GAtomicArray iface_entries; /* for !iface types */
240 GAtomicArray offsets;
242 GType *prerequisites;
243 GType supers[1]; /* flexible array */
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))
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))
275 GInterfaceInfo *info;
283 GTypeInterface *vtable;
284 InitState init_state;
287 struct _IFaceEntries {
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) )
297 GTypeValueTable *value_table;
303 GBoxedCopyFunc copy_func;
304 GBoxedFreeFunc free_func;
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;
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;
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;
345 guint16 instance_size;
346 guint16 private_size;
348 GInstanceInitFunc instance_init;
357 InstanceData instance;
362 GTypeClassCacheFunc cache_func;
367 GTypeInterfaceCheckFunc check_func;
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;
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;
389 static inline TypeNode*
390 lookup_type_node_I (register GType utype)
392 if (utype > G_TYPE_FUNDAMENTAL_MAX)
393 return (TypeNode*) (utype & ~TYPE_ID_MASK);
395 return static_fundamental_type_nodes[utype >> G_TYPE_FUNDAMENTAL_SHIFT];
399 * g_type_get_type_registration_serial:
401 * Returns an opaque serial number that represents the state of the set of registered
402 * types. Any time a type is registred this serial changes, which means you can
403 * cache information based on type lookups (such as g_type_from_name) and know if
404 * the cache is still valid at a later time by comparing the current serial with
405 * the one at the type lookup.
409 * Returns: An unsigned int, representing the state of type registrations.
412 g_type_get_type_registration_serial (void)
414 return (guint)g_atomic_int_get ((gint *)&type_registration_serial);
418 type_node_any_new_W (TypeNode *pnode,
422 GTypeFundamentalFlags type_flags)
427 guint i, node_size = 0;
429 n_supers = pnode ? pnode->n_supers + 1 : 0;
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 */
438 node = G_STRUCT_MEMBER_P (node, SIZEOF_FUNDAMENTAL_INFO);
439 static_fundamental_type_nodes[ftype >> G_TYPE_FUNDAMENTAL_SHIFT] = node;
445 g_assert ((type & TYPE_ID_MASK) == 0);
447 node->n_supers = n_supers;
450 node->supers[0] = type;
453 node->is_classed = (type_flags & G_TYPE_FLAG_CLASSED) != 0;
454 node->is_instantiatable = (type_flags & G_TYPE_FLAG_INSTANTIATABLE) != 0;
456 if (NODE_IS_IFACE (node))
458 IFACE_NODE_N_PREREQUISITES (node) = 0;
459 IFACE_NODE_PREREQUISITES (node) = NULL;
462 _g_atomic_array_init (CLASSED_NODE_IFACES_ENTRIES (node));
466 node->supers[0] = type;
467 memcpy (node->supers + 1, pnode->supers, sizeof (GType) * (1 + pnode->n_supers + 1));
469 node->is_classed = pnode->is_classed;
470 node->is_instantiatable = pnode->is_instantiatable;
472 if (NODE_IS_IFACE (node))
474 IFACE_NODE_N_PREREQUISITES (node) = 0;
475 IFACE_NODE_PREREQUISITES (node) = NULL;
480 IFaceEntries *entries;
482 entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (pnode),
483 IFACE_ENTRIES_HEADER_SIZE,
487 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
489 entries->entry[j].vtable = NULL;
490 entries->entry[j].init_state = UNINITIALIZED;
492 _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node),
497 i = pnode->n_children++;
498 pnode->children = g_renew (GType, pnode->children, pnode->n_children);
499 pnode->children[i] = type;
502 TRACE(GOBJECT_TYPE_NEW(name, node->supers[1], type));
504 node->plugin = plugin;
505 node->n_children = 0;
506 node->children = NULL;
508 node->qname = g_quark_from_string (name);
509 node->global_gdata = NULL;
511 g_hash_table_insert (static_type_nodes_ht,
512 (gpointer) g_quark_to_string (node->qname),
515 g_atomic_int_inc ((gint *)&type_registration_serial);
520 static inline GTypeFundamentalInfo*
521 type_node_fundamental_info_I (TypeNode *node)
523 GType ftype = NODE_FUNDAMENTAL_TYPE (node);
525 if (ftype != NODE_TYPE (node))
526 node = lookup_type_node_I (ftype);
528 return node ? G_STRUCT_MEMBER_P (node, -SIZEOF_FUNDAMENTAL_INFO) : NULL;
532 type_node_fundamental_new_W (GType ftype,
534 GTypeFundamentalFlags type_flags)
536 GTypeFundamentalInfo *finfo;
539 g_assert ((ftype & TYPE_ID_MASK) == 0);
540 g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX);
542 if (ftype >> G_TYPE_FUNDAMENTAL_SHIFT == static_fundamental_next)
543 static_fundamental_next++;
545 type_flags &= TYPE_FUNDAMENTAL_FLAG_MASK;
547 node = type_node_any_new_W (NULL, ftype, name, NULL, type_flags);
549 finfo = type_node_fundamental_info_I (node);
550 finfo->type_flags = type_flags;
556 type_node_new_W (TypeNode *pnode,
562 g_assert (pnode->n_supers < MAX_N_SUPERS);
563 g_assert (pnode->n_children < MAX_N_CHILDREN);
565 return type_node_any_new_W (pnode, NODE_FUNDAMENTAL_TYPE (pnode), name, plugin, 0);
568 static inline IFaceEntry*
569 lookup_iface_entry_I (volatile IFaceEntries *entries,
570 TypeNode *iface_node)
581 G_ATOMIC_ARRAY_DO_TRANSACTION
582 (&iface_node->_prot.offsets, guint8,
585 offsets = transaction_data;
586 offset_index = entries->offset_index;
587 if (offsets != NULL &&
588 offset_index < G_ATOMIC_ARRAY_DATA_SIZE(offsets))
590 index = offsets[offset_index];
593 /* zero means unset, subtract one to get real index */
596 if (index < IFACE_ENTRIES_N_ENTRIES (entries))
598 check = (IFaceEntry *)&entries->entry[index];
599 if (check->iface_type == NODE_TYPE (iface_node))
609 static inline IFaceEntry*
610 type_lookup_iface_entry_L (TypeNode *node,
611 TypeNode *iface_node)
613 if (!NODE_IS_IFACE (iface_node))
616 return lookup_iface_entry_I (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node),
621 static inline gboolean
622 type_lookup_iface_vtable_I (TypeNode *node,
623 TypeNode *iface_node,
624 gpointer *vtable_ptr)
629 if (!NODE_IS_IFACE (iface_node))
636 G_ATOMIC_ARRAY_DO_TRANSACTION
637 (CLASSED_NODE_IFACES_ENTRIES (node), IFaceEntries,
639 entry = lookup_iface_entry_I (transaction_data, iface_node);
644 *vtable_ptr = entry->vtable;
653 static inline gboolean
654 type_lookup_prerequisite_L (TypeNode *iface,
655 GType prerequisite_type)
657 if (NODE_IS_IFACE (iface) && IFACE_NODE_N_PREREQUISITES (iface))
659 GType *prerequisites = IFACE_NODE_PREREQUISITES (iface) - 1;
660 guint n_prerequisites = IFACE_NODE_N_PREREQUISITES (iface);
667 i = (n_prerequisites + 1) >> 1;
668 check = prerequisites + i;
669 if (prerequisite_type == *check)
671 else if (prerequisite_type > *check)
673 n_prerequisites -= i;
674 prerequisites = check;
676 else /* if (prerequisite_type < *check) */
677 n_prerequisites = i - 1;
679 while (n_prerequisites);
685 type_descriptive_name_I (GType type)
689 TypeNode *node = lookup_type_node_I (type);
691 return node ? NODE_NAME (node) : "<unknown>";
698 /* --- type consistency checks --- */
700 check_plugin_U (GTypePlugin *plugin,
701 gboolean need_complete_type_info,
702 gboolean need_complete_interface_info,
703 const gchar *type_name)
705 /* G_IS_TYPE_PLUGIN() and G_TYPE_PLUGIN_GET_CLASS() are external calls: _U
709 g_warning ("plugin handle for type `%s' is NULL",
713 if (!G_IS_TYPE_PLUGIN (plugin))
715 g_warning ("plugin pointer (%p) for type `%s' is invalid",
719 if (need_complete_type_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_type_info)
721 g_warning ("plugin for type `%s' has no complete_type_info() implementation",
725 if (need_complete_interface_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_interface_info)
727 g_warning ("plugin for type `%s' has no complete_interface_info() implementation",
735 check_type_name_I (const gchar *type_name)
737 static const gchar extra_chars[] = "-_+";
738 const gchar *p = type_name;
741 if (!type_name[0] || !type_name[1] || !type_name[2])
743 g_warning ("type name `%s' is too short", type_name);
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]));
755 g_warning ("type name `%s' contains invalid characters", type_name);
758 if (g_type_from_name (type_name))
760 g_warning ("cannot register existing type `%s'", type_name);
768 check_derivation_I (GType parent_type,
769 const gchar *type_name)
772 GTypeFundamentalInfo* finfo;
774 pnode = lookup_type_node_I (parent_type);
777 g_warning ("cannot derive type `%s' from invalid parent type `%s'",
779 type_descriptive_name_I (parent_type));
782 finfo = type_node_fundamental_info_I (pnode);
783 /* ensure flat derivability */
784 if (!(finfo->type_flags & G_TYPE_FLAG_DERIVABLE))
786 g_warning ("cannot derive `%s' from non-derivable parent type `%s'",
791 /* ensure deep derivability */
792 if (parent_type != NODE_FUNDAMENTAL_TYPE (pnode) &&
793 !(finfo->type_flags & G_TYPE_FLAG_DEEP_DERIVABLE))
795 g_warning ("cannot derive `%s' from non-fundamental parent type `%s'",
805 check_collect_format_I (const gchar *collect_format)
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 };
813 if (!strchr (valid_format, *p++))
815 return p - collect_format <= G_VALUE_COLLECT_FORMAT_MAX_LENGTH;
819 check_value_table_I (const gchar *type_name,
820 const GTypeValueTable *value_table)
824 else if (value_table->value_init == NULL)
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'",
834 else /* value_table->value_init != NULL */
836 if (!value_table->value_free)
839 * g_warning ("missing `value_free()' for type `%s'", type_name);
843 if (!value_table->value_copy)
845 g_warning ("missing `value_copy()' for type `%s'", type_name);
848 if ((value_table->collect_format || value_table->collect_value) &&
849 (!value_table->collect_format || !value_table->collect_value))
851 g_warning ("one of `collect_format' and `collect_value()' is unspecified for type `%s'",
855 if (value_table->collect_format && !check_collect_format_I (value_table->collect_format))
857 g_warning ("the `%s' specification for type `%s' is too long or invalid",
862 if ((value_table->lcopy_format || value_table->lcopy_value) &&
863 (!value_table->lcopy_format || !value_table->lcopy_value))
865 g_warning ("one of `lcopy_format' and `lcopy_value()' is unspecified for type `%s'",
869 if (value_table->lcopy_format && !check_collect_format_I (value_table->lcopy_format))
871 g_warning ("the `%s' specification for type `%s' is too long or invalid",
881 check_type_info_I (TypeNode *pnode,
883 const gchar *type_name,
884 const GTypeInfo *info)
886 GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (lookup_type_node_I (ftype));
887 gboolean is_interface = ftype == G_TYPE_INTERFACE;
889 g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX && !(ftype & TYPE_ID_MASK));
891 /* check instance members */
892 if (!(finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
893 (info->instance_size || info->n_preallocs || info->instance_init))
896 g_warning ("cannot instantiate `%s', derived from non-instantiatable parent type `%s'",
900 g_warning ("cannot instantiate `%s' as non-instantiatable fundamental",
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))
910 g_warning ("cannot create class for `%s', derived from non-classed parent type `%s'",
914 g_warning ("cannot create class for `%s' as non-classed fundamental",
918 /* check interface size */
919 if (is_interface && info->class_size < sizeof (GTypeInterface))
921 g_warning ("specified interface size for type `%s' is smaller than `GTypeInterface' size",
925 /* check class size */
926 if (finfo->type_flags & G_TYPE_FLAG_CLASSED)
928 if (info->class_size < sizeof (GTypeClass))
930 g_warning ("specified class size for type `%s' is smaller than `GTypeClass' size",
934 if (pnode && info->class_size < pnode->data->class.class_size)
936 g_warning ("specified class size for type `%s' is smaller "
937 "than the parent type's `%s' class size",
943 /* check instance size */
944 if (finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE)
946 if (info->instance_size < sizeof (GTypeInstance))
948 g_warning ("specified instance size for type `%s' is smaller than `GTypeInstance' size",
952 if (pnode && info->instance_size < pnode->data->instance.instance_size)
954 g_warning ("specified instance size for type `%s' is smaller "
955 "than the parent type's `%s' instance size",
966 find_conforming_child_type_L (TypeNode *pnode,
969 TypeNode *node = NULL;
972 if (type_lookup_iface_entry_L (pnode, iface))
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);
982 check_add_interface_L (GType instance_type,
985 TypeNode *node = lookup_type_node_I (instance_type);
986 TypeNode *iface = lookup_type_node_I (iface_type);
989 GType *prerequisites;
993 if (!node || !node->is_instantiatable)
995 g_warning ("cannot add interfaces to invalid (non-instantiatable) type `%s'",
996 type_descriptive_name_I (instance_type));
999 if (!iface || !NODE_IS_IFACE (iface))
1001 g_warning ("cannot add invalid (non-interface) type `%s' to type `%s'",
1002 type_descriptive_name_I (iface_type),
1006 if (node->data && node->data->class.class)
1008 g_warning ("attempting to add an interface (%s) to class (%s) after class_init",
1009 NODE_NAME (iface), NODE_NAME (node));
1011 /* See https://bugzilla.gnome.org/show_bug.cgi?id=697229,
1012 * https://bugzilla.gnome.org/show_bug.cgi?id=687659
1014 if (!g_str_has_prefix (NODE_NAME (node), "gtkmm__CustomObject_") && !strstr (NODE_NAME (node), "_gtksharp_"))
1017 tnode = lookup_type_node_I (NODE_PARENT_TYPE (iface));
1018 if (NODE_PARENT_TYPE (tnode) && !type_lookup_iface_entry_L (node, tnode))
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'",
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)))
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.
1037 /* check whether one of our children already conforms (or whether the interface
1038 * got added to this node already)
1040 tnode = find_conforming_child_type_L (node, iface); /* tnode is_a node */
1043 g_warning ("cannot add interface type `%s' to type `%s', since type `%s' already conforms to interface",
1049 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1050 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1052 tnode = lookup_type_node_I (prerequisites[i]);
1053 if (!type_node_is_a_L (node, tnode))
1055 g_warning ("cannot add interface type `%s' to type `%s' which does not conform to prerequisite `%s'",
1066 check_interface_info_I (TypeNode *iface,
1067 GType instance_type,
1068 const GInterfaceInfo *info)
1070 if ((info->interface_finalize || info->interface_data) && !info->interface_init)
1072 g_warning ("interface type `%s' for type `%s' comes without initializer",
1074 type_descriptive_name_I (instance_type));
1081 /* --- type info (type node data) --- */
1083 type_data_make_W (TypeNode *node,
1084 const GTypeInfo *info,
1085 const GTypeValueTable *value_table)
1088 GTypeValueTable *vtable = NULL;
1089 guint vtable_size = 0;
1091 g_assert (node->data == NULL && info != NULL);
1095 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1098 vtable = pnode->data->common.value_table;
1101 static const GTypeValueTable zero_vtable = { NULL, };
1103 value_table = &zero_vtable;
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);
1117 if (node->is_instantiatable) /* careful, is_instantiatable is also is_classed */
1119 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1121 data = g_malloc0 (sizeof (InstanceData) + 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
1136 data->instance.private_size = 0;
1137 data->instance.class_private_size = 0;
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;
1147 else if (node->is_classed) /* only classed */
1149 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1151 data = g_malloc0 (sizeof (ClassData) + 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;
1163 data->class.class_private_size = pnode->data->class.class_private_size;
1164 data->class.init_state = UNINITIALIZED;
1166 else if (NODE_IS_IFACE (node))
1168 data = g_malloc0 (sizeof (IFaceData) + 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;
1179 else if (NODE_IS_BOXED (node))
1181 data = g_malloc0 (sizeof (BoxedData) + vtable_size);
1183 vtable = G_STRUCT_MEMBER_P (data, sizeof (BoxedData));
1187 data = g_malloc0 (sizeof (CommonData) + vtable_size);
1189 vtable = G_STRUCT_MEMBER_P (data, sizeof (CommonData));
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
1202 *vtable = *value_table;
1203 p = G_STRUCT_MEMBER_P (vtable, sizeof (*vtable));
1205 vtable->collect_format = p;
1206 if (value_table->collect_format)
1208 strcat (p, value_table->collect_format);
1209 p += strlen (value_table->collect_format);
1213 vtable->lcopy_format = p;
1214 if (value_table->lcopy_format)
1215 strcat (p, value_table->lcopy_format);
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))));
1222 g_assert (node->data->common.value_table != NULL); /* paranoid */
1224 g_atomic_int_set ((int *) &node->ref_count, 1);
1228 type_data_ref_Wm (TypeNode *node)
1232 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1234 GTypeValueTable tmp_value_table;
1236 g_assert (node->plugin != NULL);
1240 type_data_ref_Wm (pnode);
1242 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1245 memset (&tmp_info, 0, sizeof (tmp_info));
1246 memset (&tmp_value_table, 0, sizeof (tmp_value_table));
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);
1253 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
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);
1262 g_assert (NODE_REFCOUNT (node) > 0);
1264 g_atomic_int_inc ((int *) &node->ref_count);
1268 static inline gboolean
1269 type_data_ref_U (TypeNode *node)
1274 current = NODE_REFCOUNT (node);
1278 } while (!g_atomic_int_compare_and_exchange ((int *) &node->ref_count, current, current + 1));
1284 iface_node_has_available_offset_L (TypeNode *iface_node,
1290 offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->_prot.offsets, guint8);
1291 if (offsets == NULL)
1294 if (G_ATOMIC_ARRAY_DATA_SIZE (offsets) <= offset)
1297 if (offsets[offset] == 0 ||
1298 offsets[offset] == for_index+1)
1305 find_free_iface_offset_L (IFaceEntries *entries)
1308 TypeNode *iface_node;
1313 n_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1318 for (i = 0; i < n_entries; i++)
1320 entry = &entries->entry[i];
1321 iface_node = lookup_type_node_I (entry->iface_type);
1323 if (!iface_node_has_available_offset_L (iface_node, offset, i))
1327 while (i != n_entries);
1333 iface_node_set_offset_L (TypeNode *iface_node,
1337 guint8 *offsets, *old_offsets;
1338 int new_size, old_size;
1341 old_offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->_prot.offsets, guint8);
1342 if (old_offsets == NULL)
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 */
1351 new_size = MAX (old_size, offset + 1);
1353 offsets = _g_atomic_array_copy (&iface_node->_prot.offsets,
1354 0, new_size - old_size);
1356 /* Mark new area as unused */
1357 for (i = old_size; i < new_size; i++)
1360 offsets[offset] = index + 1;
1362 _g_atomic_array_update (&iface_node->_prot.offsets, offsets);
1366 type_node_add_iface_entry_W (TypeNode *node,
1368 IFaceEntry *parent_entry)
1370 IFaceEntries *entries;
1372 TypeNode *iface_node;
1376 g_assert (node->is_instantiatable);
1378 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
1379 if (entries != NULL)
1381 num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1383 g_assert (num_entries < MAX_N_INTERFACES);
1385 for (i = 0; i < num_entries; i++)
1387 entry = &entries->entry[i];
1388 if (entry->iface_type == iface_type)
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.
1399 g_assert (entry->vtable == NULL && entry->init_state == UNINITIALIZED);
1402 /* sick, interface is added to ancestor *after* child type;
1403 * nothing todo, the entry and our children were already setup correctly
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;
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;
1424 if (node->data && node->data->class.init_state >= BASE_IFACE_INIT)
1426 entries->entry[i].init_state = INITIALIZED;
1427 entries->entry[i].vtable = parent_entry->vtable;
1431 /* Update offsets in iface */
1432 iface_node = lookup_type_node_I (iface_type);
1434 if (iface_node_has_available_offset_L (iface_node,
1435 entries->offset_index,
1438 iface_node_set_offset_L (iface_node,
1439 entries->offset_index, i);
1443 entries->offset_index =
1444 find_free_iface_offset_L (entries);
1445 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
1447 entry = &entries->entry[j];
1449 lookup_type_node_I (entry->iface_type);
1450 iface_node_set_offset_L (iface_node,
1451 entries->offset_index, j);
1455 _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node), entries);
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]);
1465 type_add_interface_Wm (TypeNode *node,
1467 const GInterfaceInfo *info,
1468 GTypePlugin *plugin)
1470 IFaceHolder *iholder = g_new0 (IFaceHolder, 1);
1474 g_assert (node->is_instantiatable && NODE_IS_IFACE (iface) && ((info && !plugin) || (!info && plugin)));
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;
1482 /* create an iface entry for this type */
1483 type_node_add_iface_entry_W (node, NODE_TYPE (iface), NULL);
1485 /* if the class is already (partly) initialized, we may need to base
1486 * initalize and/or initialize the new interface.
1490 InitState class_state = node->data->class.init_state;
1492 if (class_state >= BASE_IFACE_INIT)
1493 type_iface_vtable_base_init_Wm (iface, node);
1495 if (class_state >= IFACE_INIT)
1496 type_iface_vtable_iface_init_Wm (iface, node);
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);
1506 type_iface_add_prerequisite_W (TypeNode *iface,
1507 TypeNode *prerequisite_node)
1509 GType prerequisite_type = NODE_TYPE (prerequisite_node);
1510 GType *prerequisites, *dependants;
1511 guint n_dependants, i;
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)));
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)
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 g_memmove (prerequisites + i + 1, prerequisites + i,
1529 sizeof (prerequisites[0]) * (IFACE_NODE_N_PREREQUISITES (iface) - i - 1));
1530 prerequisites[i] = prerequisite_type;
1532 /* we want to get notified when prerequisites get added to prerequisite_node */
1533 if (NODE_IS_IFACE (prerequisite_node))
1535 dependants = iface_node_get_dependants_array_L (prerequisite_node);
1536 n_dependants = dependants ? dependants[0] : 0;
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);
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);
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.
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.
1563 g_type_interface_add_prerequisite (GType interface_type,
1564 GType prerequisite_type)
1566 TypeNode *iface, *prerequisite_node;
1567 IFaceHolder *holders;
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));
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))
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));
1582 G_WRITE_LOCK (&type_rw_lock);
1583 holders = iface_node_get_holders_L (iface);
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));
1593 if (prerequisite_node->is_instantiatable)
1597 /* can have at most one publicly installable instantiatable prerequisite */
1598 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1600 TypeNode *prnode = lookup_type_node_I (IFACE_NODE_PREREQUISITES (iface)[i]);
1602 if (prnode->is_instantiatable)
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)));
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);
1617 else if (NODE_IS_IFACE (prerequisite_node))
1619 GType *prerequisites;
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);
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));
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
1643 * Returns the prerequisites of an interfaces type.
1647 * Returns: (array length=n_prerequisites) (transfer full): a
1648 * newly-allocated zero-terminated array of #GType containing
1649 * the prerequisites of @interface_type
1652 g_type_interface_prerequisites (GType interface_type,
1653 guint *n_prerequisites)
1657 g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL);
1659 iface = lookup_type_node_I (interface_type);
1663 TypeNode *inode = NULL;
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++)
1670 GType prerequisite = IFACE_NODE_PREREQUISITES (iface)[i];
1671 TypeNode *node = lookup_type_node_I (prerequisite);
1672 if (node->is_instantiatable)
1674 if (!inode || type_node_is_a_L (node, inode))
1678 types[n++] = NODE_TYPE (node);
1681 types[n++] = NODE_TYPE (inode);
1683 if (n_prerequisites)
1684 *n_prerequisites = n;
1685 G_READ_UNLOCK (&type_rw_lock);
1691 if (n_prerequisites)
1692 *n_prerequisites = 0;
1700 type_iface_peek_holder_L (TypeNode *iface,
1701 GType instance_type)
1703 IFaceHolder *iholder;
1705 g_assert (NODE_IS_IFACE (iface));
1707 iholder = iface_node_get_holders_L (iface);
1708 while (iholder && iholder->instance_type != instance_type)
1709 iholder = iholder->next;
1714 type_iface_retrieve_holder_info_Wm (TypeNode *iface,
1715 GType instance_type,
1718 IFaceHolder *iholder = type_iface_peek_holder_L (iface, instance_type);
1720 if (iholder && !iholder->info && need_info)
1722 GInterfaceInfo tmp_info;
1724 g_assert (iholder->plugin != NULL);
1726 type_data_ref_Wm (iface);
1728 INVALID_RECURSION ("g_type_plugin_*", iface->plugin, NODE_NAME (iface));
1730 memset (&tmp_info, 0, sizeof (tmp_info));
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);
1737 INVALID_RECURSION ("g_type_plugin_*", iholder->plugin, NODE_NAME (iface));
1739 check_interface_info_I (iface, instance_type, &tmp_info);
1740 iholder->info = g_memdup (&tmp_info, sizeof (tmp_info));
1743 return iholder; /* we don't modify write lock upon returning NULL */
1747 type_iface_blow_holder_info_Wm (TypeNode *iface,
1748 GType instance_type)
1750 IFaceHolder *iholder = iface_node_get_holders_L (iface);
1752 g_assert (NODE_IS_IFACE (iface));
1754 while (iholder->instance_type != instance_type)
1755 iholder = iholder->next;
1757 if (iholder->info && iholder->plugin)
1759 g_free (iholder->info);
1760 iholder->info = NULL;
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);
1770 * g_type_create_instance: (skip)
1771 * @type: An instantiatable type to create an instance for.
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
1780 * <emphasis>never</emphasis> directly through
1781 * g_type_create_instance() which doesn't handle things like singleton
1782 * objects or object construction. Note: Do <emphasis>not</emphasis>
1783 * use this function, unless you're implementing a fundamental
1784 * type. Also language bindings should <emphasis>not</emphasis> use
1785 * this function but g_object_new() instead.
1787 * Returns: An allocated and initialized instance, subject to further
1788 * treatment by the fundamental type implementation.
1791 g_type_create_instance (GType type)
1794 GTypeInstance *instance;
1801 node = lookup_type_node_I (type);
1802 if (!node || !node->is_instantiatable)
1804 g_error ("cannot create new instance of invalid (non-instantiatable) type `%s'",
1805 type_descriptive_name_I (type));
1807 /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1808 if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (type))
1810 g_error ("cannot create instance of abstract (non-instantiatable) type `%s'",
1811 type_descriptive_name_I (type));
1814 class = g_type_class_ref (type);
1816 /* We allocate the 'private' areas before the normal instance data, in
1817 * reverse order. This allows the private area of a particular class
1818 * to always be at a constant relative address to the instance data.
1819 * If we stored the private data after the instance data this would
1820 * not be the case (since a subclass that added more instance
1821 * variables would push the private data further along).
1823 * This presents problems for valgrindability, of course, so we do a
1824 * workaround for that case. We identify the start of the object to
1825 * valgrind as an allocated block (so that pointers to objects show up
1826 * as 'reachable' instead of 'possibly lost'). We then add an extra
1827 * pointer at the end of the object, after all instance data, back to
1828 * the start of the private area so that it is also recorded as
1829 * reachable. We also add extra private space at the start because
1830 * valgrind doesn't seem to like us claiming to have allocated an
1831 * address that it saw allocated by malloc().
1833 private_size = node->data->instance.private_size;
1834 ivar_size = node->data->instance.instance_size;
1836 if (private_size && RUNNING_ON_VALGRIND)
1838 private_size += ALIGN_STRUCT (1);
1840 /* Allocate one extra pointer size... */
1841 allocated = g_slice_alloc0 (private_size + ivar_size + sizeof (gpointer));
1842 /* ... and point it back to the start of the private data. */
1843 *(gpointer *) (allocated + private_size + ivar_size) = allocated + ALIGN_STRUCT (1);
1845 /* Tell valgrind that it should treat the object itself as such */
1846 VALGRIND_MALLOCLIKE_BLOCK (allocated + private_size, ivar_size + sizeof (gpointer), 0, TRUE);
1847 VALGRIND_MALLOCLIKE_BLOCK (allocated + ALIGN_STRUCT (1), private_size - ALIGN_STRUCT (1), 0, TRUE);
1850 allocated = g_slice_alloc0 (private_size + ivar_size);
1852 instance = (GTypeInstance *) (allocated + private_size);
1854 for (i = node->n_supers; i > 0; i--)
1858 pnode = lookup_type_node_I (node->supers[i]);
1859 if (pnode->data->instance.instance_init)
1861 instance->g_class = pnode->data->instance.class;
1862 pnode->data->instance.instance_init (instance, class);
1866 instance->g_class = class;
1867 if (node->data->instance.instance_init)
1868 node->data->instance.instance_init (instance, class);
1870 TRACE(GOBJECT_OBJECT_NEW(instance, type));
1876 * g_type_free_instance:
1877 * @instance: an instance of a type.
1879 * Frees an instance of a type, returning it to the instance pool for
1880 * the type, if there is one.
1882 * Like g_type_create_instance(), this function is reserved for
1883 * implementors of fundamental types.
1886 g_type_free_instance (GTypeInstance *instance)
1894 g_return_if_fail (instance != NULL && instance->g_class != NULL);
1896 class = instance->g_class;
1897 node = lookup_type_node_I (class->g_type);
1898 if (!node || !node->is_instantiatable || !node->data || node->data->class.class != (gpointer) class)
1900 g_warning ("cannot free instance of invalid (non-instantiatable) type `%s'",
1901 type_descriptive_name_I (class->g_type));
1904 /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1905 if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (NODE_TYPE (node)))
1907 g_warning ("cannot free instance of abstract (non-instantiatable) type `%s'",
1912 instance->g_class = NULL;
1913 private_size = node->data->instance.private_size;
1914 ivar_size = node->data->instance.instance_size;
1915 allocated = ((gchar *) instance) - private_size;
1917 #ifdef G_ENABLE_DEBUG
1918 memset (allocated, 0xaa, ivar_size + private_size);
1921 /* See comment in g_type_create_instance() about what's going on here.
1922 * We're basically unwinding what we put into motion there.
1924 if (private_size && RUNNING_ON_VALGRIND)
1926 private_size += ALIGN_STRUCT (1);
1927 allocated -= ALIGN_STRUCT (1);
1929 /* Clear out the extra pointer... */
1930 *(gpointer *) (allocated + private_size + ivar_size) = NULL;
1931 /* ... and ensure we include it in the size we free. */
1932 g_slice_free1 (private_size + ivar_size + sizeof (gpointer), allocated);
1934 VALGRIND_FREELIKE_BLOCK (allocated + ALIGN_STRUCT (1), 0);
1935 VALGRIND_FREELIKE_BLOCK (instance, 0);
1938 g_slice_free1 (private_size + ivar_size, allocated);
1940 g_type_class_unref (class);
1944 type_iface_ensure_dflt_vtable_Wm (TypeNode *iface)
1946 g_assert (iface->data);
1948 if (!iface->data->iface.dflt_vtable)
1950 GTypeInterface *vtable = g_malloc0 (iface->data->iface.vtable_size);
1951 iface->data->iface.dflt_vtable = vtable;
1952 vtable->g_type = NODE_TYPE (iface);
1953 vtable->g_instance_type = 0;
1954 if (iface->data->iface.vtable_init_base ||
1955 iface->data->iface.dflt_init)
1957 G_WRITE_UNLOCK (&type_rw_lock);
1958 if (iface->data->iface.vtable_init_base)
1959 iface->data->iface.vtable_init_base (vtable);
1960 if (iface->data->iface.dflt_init)
1961 iface->data->iface.dflt_init (vtable, (gpointer) iface->data->iface.dflt_data);
1962 G_WRITE_LOCK (&type_rw_lock);
1968 /* This is called to allocate and do the first part of initializing
1969 * the interface vtable; type_iface_vtable_iface_init_Wm() does the remainder.
1971 * A FALSE return indicates that we didn't find an init function for
1972 * this type/iface pair, so the vtable from the parent type should
1973 * be used. Note that the write lock is not modified upon a FALSE
1977 type_iface_vtable_base_init_Wm (TypeNode *iface,
1981 IFaceHolder *iholder;
1982 GTypeInterface *vtable = NULL;
1985 /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
1986 iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), TRUE);
1988 return FALSE; /* we don't modify write lock upon FALSE */
1990 type_iface_ensure_dflt_vtable_Wm (iface);
1992 entry = type_lookup_iface_entry_L (node, iface);
1994 g_assert (iface->data && entry && entry->vtable == NULL && iholder && iholder->info);
1996 entry->init_state = IFACE_INIT;
1998 pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1999 if (pnode) /* want to copy over parent iface contents */
2001 IFaceEntry *pentry = type_lookup_iface_entry_L (pnode, iface);
2004 vtable = g_memdup (pentry->vtable, iface->data->iface.vtable_size);
2007 vtable = g_memdup (iface->data->iface.dflt_vtable, iface->data->iface.vtable_size);
2008 entry->vtable = vtable;
2009 vtable->g_type = NODE_TYPE (iface);
2010 vtable->g_instance_type = NODE_TYPE (node);
2012 if (iface->data->iface.vtable_init_base)
2014 G_WRITE_UNLOCK (&type_rw_lock);
2015 iface->data->iface.vtable_init_base (vtable);
2016 G_WRITE_LOCK (&type_rw_lock);
2018 return TRUE; /* initialized the vtable */
2021 /* Finishes what type_iface_vtable_base_init_Wm started by
2022 * calling the interface init function.
2023 * this function may only be called for types with their
2024 * own interface holder info, i.e. types for which
2025 * g_type_add_interface*() was called and not children thereof.
2028 type_iface_vtable_iface_init_Wm (TypeNode *iface,
2031 IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2032 IFaceHolder *iholder = type_iface_peek_holder_L (iface, NODE_TYPE (node));
2033 GTypeInterface *vtable = NULL;
2036 /* iholder->info should have been filled in by type_iface_vtable_base_init_Wm() */
2037 g_assert (iface->data && entry && iholder && iholder->info);
2038 g_assert (entry->init_state == IFACE_INIT); /* assert prior base_init() */
2040 entry->init_state = INITIALIZED;
2042 vtable = entry->vtable;
2044 if (iholder->info->interface_init)
2046 G_WRITE_UNLOCK (&type_rw_lock);
2047 if (iholder->info->interface_init)
2048 iholder->info->interface_init (vtable, iholder->info->interface_data);
2049 G_WRITE_LOCK (&type_rw_lock);
2052 for (i = 0; i < static_n_iface_check_funcs; i++)
2054 GTypeInterfaceCheckFunc check_func = static_iface_check_funcs[i].check_func;
2055 gpointer check_data = static_iface_check_funcs[i].check_data;
2057 G_WRITE_UNLOCK (&type_rw_lock);
2058 check_func (check_data, (gpointer)vtable);
2059 G_WRITE_LOCK (&type_rw_lock);
2064 type_iface_vtable_finalize_Wm (TypeNode *iface,
2066 GTypeInterface *vtable)
2068 IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2069 IFaceHolder *iholder;
2071 /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
2072 iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), FALSE);
2074 return FALSE; /* we don't modify write lock upon FALSE */
2076 g_assert (entry && entry->vtable == vtable && iholder->info);
2078 entry->vtable = NULL;
2079 entry->init_state = UNINITIALIZED;
2080 if (iholder->info->interface_finalize || iface->data->iface.vtable_finalize_base)
2082 G_WRITE_UNLOCK (&type_rw_lock);
2083 if (iholder->info->interface_finalize)
2084 iholder->info->interface_finalize (vtable, iholder->info->interface_data);
2085 if (iface->data->iface.vtable_finalize_base)
2086 iface->data->iface.vtable_finalize_base (vtable);
2087 G_WRITE_LOCK (&type_rw_lock);
2090 vtable->g_instance_type = 0;
2093 type_iface_blow_holder_info_Wm (iface, NODE_TYPE (node));
2095 return TRUE; /* write lock modified */
2099 type_class_init_Wm (TypeNode *node,
2102 GSList *slist, *init_slist = NULL;
2104 IFaceEntries *entries;
2106 TypeNode *bnode, *pnode;
2109 /* Accessing data->class will work for instantiable types
2110 * too because ClassData is a subset of InstanceData
2112 g_assert (node->is_classed && node->data &&
2113 node->data->class.class_size &&
2114 !node->data->class.class &&
2115 node->data->class.init_state == UNINITIALIZED);
2116 if (node->data->class.class_private_size)
2117 class = g_malloc0 (ALIGN_STRUCT (node->data->class.class_size) + node->data->class.class_private_size);
2119 class = g_malloc0 (node->data->class.class_size);
2120 node->data->class.class = class;
2121 g_atomic_int_set (&node->data->class.init_state, BASE_CLASS_INIT);
2125 TypeNode *pnode = lookup_type_node_I (pclass->g_type);
2127 memcpy (class, pclass, pnode->data->class.class_size);
2128 memcpy (G_STRUCT_MEMBER_P (class, ALIGN_STRUCT (node->data->class.class_size)), G_STRUCT_MEMBER_P (pclass, ALIGN_STRUCT (pnode->data->class.class_size)), pnode->data->class.class_private_size);
2130 if (node->is_instantiatable)
2132 /* We need to initialize the private_size here rather than in
2133 * type_data_make_W() since the class init for the parent
2134 * class may have changed pnode->data->instance.private_size.
2136 node->data->instance.private_size = pnode->data->instance.private_size;
2139 class->g_type = NODE_TYPE (node);
2141 G_WRITE_UNLOCK (&type_rw_lock);
2143 /* stack all base class initialization functions, so we
2144 * call them in ascending order.
2146 for (bnode = node; bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2147 if (bnode->data->class.class_init_base)
2148 init_slist = g_slist_prepend (init_slist, (gpointer) bnode->data->class.class_init_base);
2149 for (slist = init_slist; slist; slist = slist->next)
2151 GBaseInitFunc class_init_base = (GBaseInitFunc) slist->data;
2153 class_init_base (class);
2155 g_slist_free (init_slist);
2157 G_WRITE_LOCK (&type_rw_lock);
2159 g_atomic_int_set (&node->data->class.init_state, BASE_IFACE_INIT);
2161 /* Before we initialize the class, base initialize all interfaces, either
2162 * from parent, or through our holder info
2164 pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
2167 while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL &&
2168 i < IFACE_ENTRIES_N_ENTRIES (entries))
2170 entry = &entries->entry[i];
2171 while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2172 entry->init_state == IFACE_INIT)
2178 if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2181 if (!type_iface_vtable_base_init_Wm (lookup_type_node_I (entry->iface_type), node))
2184 IFaceEntries *pentries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (pnode);
2186 /* need to get this interface from parent, type_iface_vtable_base_init_Wm()
2187 * doesn't modify write lock upon FALSE, so entry is still valid;
2189 g_assert (pnode != NULL);
2192 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (pentries); j++)
2194 IFaceEntry *pentry = &pentries->entry[j];
2196 if (pentry->iface_type == entry->iface_type)
2198 entry->vtable = pentry->vtable;
2199 entry->init_state = INITIALIZED;
2203 g_assert (entry->vtable != NULL);
2206 /* If the write lock was released, additional interface entries might
2207 * have been inserted into CLASSED_NODE_IFACES_ENTRIES (node); they'll
2208 * be base-initialized when inserted, so we don't have to worry that
2209 * we might miss them. Uninitialized entries can only be moved higher
2210 * when new ones are inserted.
2215 g_atomic_int_set (&node->data->class.init_state, CLASS_INIT);
2217 G_WRITE_UNLOCK (&type_rw_lock);
2219 if (node->data->class.class_init)
2220 node->data->class.class_init (class, (gpointer) node->data->class.class_data);
2222 G_WRITE_LOCK (&type_rw_lock);
2224 g_atomic_int_set (&node->data->class.init_state, IFACE_INIT);
2226 /* finish initializing the interfaces through our holder info.
2227 * inherited interfaces are already init_state == INITIALIZED, because
2228 * they either got setup in the above base_init loop, or during
2229 * class_init from within type_add_interface_Wm() for this or
2230 * an anchestor type.
2233 while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL)
2235 entry = &entries->entry[i];
2236 while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2237 entry->init_state == INITIALIZED)
2243 if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2246 type_iface_vtable_iface_init_Wm (lookup_type_node_I (entry->iface_type), node);
2248 /* As in the loop above, additional initialized entries might be inserted
2249 * if the write lock is released, but that's harmless because the entries
2250 * we need to initialize only move higher in the list.
2255 g_atomic_int_set (&node->data->class.init_state, INITIALIZED);
2259 type_data_finalize_class_ifaces_Wm (TypeNode *node)
2262 IFaceEntries *entries;
2264 g_assert (node->is_instantiatable && node->data && node->data->class.class && NODE_REFCOUNT (node) == 0);
2267 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
2268 for (i = 0; entries != NULL && i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
2270 IFaceEntry *entry = &entries->entry[i];
2273 if (type_iface_vtable_finalize_Wm (lookup_type_node_I (entry->iface_type), node, entry->vtable))
2275 /* refetch entries, IFACES_ENTRIES might be modified */
2280 /* type_iface_vtable_finalize_Wm() doesn't modify write lock upon FALSE,
2281 * iface vtable came from parent
2283 entry->vtable = NULL;
2284 entry->init_state = UNINITIALIZED;
2291 type_data_finalize_class_U (TypeNode *node,
2294 GTypeClass *class = cdata->class;
2297 g_assert (cdata->class && NODE_REFCOUNT (node) == 0);
2299 if (cdata->class_finalize)
2300 cdata->class_finalize (class, (gpointer) cdata->class_data);
2302 /* call all base class destruction functions in descending order
2304 if (cdata->class_finalize_base)
2305 cdata->class_finalize_base (class);
2306 for (bnode = lookup_type_node_I (NODE_PARENT_TYPE (node)); bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2307 if (bnode->data->class.class_finalize_base)
2308 bnode->data->class.class_finalize_base (class);
2310 g_free (cdata->class);
2314 type_data_last_unref_Wm (TypeNode *node,
2317 g_return_if_fail (node != NULL && node->plugin != NULL);
2319 if (!node->data || NODE_REFCOUNT (node) == 0)
2321 g_warning ("cannot drop last reference to unreferenced type `%s'",
2326 /* call class cache hooks */
2327 if (node->is_classed && node->data && node->data->class.class && static_n_class_cache_funcs && !uncached)
2331 G_WRITE_UNLOCK (&type_rw_lock);
2332 G_READ_LOCK (&type_rw_lock);
2333 for (i = 0; i < static_n_class_cache_funcs; i++)
2335 GTypeClassCacheFunc cache_func = static_class_cache_funcs[i].cache_func;
2336 gpointer cache_data = static_class_cache_funcs[i].cache_data;
2337 gboolean need_break;
2339 G_READ_UNLOCK (&type_rw_lock);
2340 need_break = cache_func (cache_data, node->data->class.class);
2341 G_READ_LOCK (&type_rw_lock);
2342 if (!node->data || NODE_REFCOUNT (node) == 0)
2343 INVALID_RECURSION ("GType class cache function ", cache_func, NODE_NAME (node));
2347 G_READ_UNLOCK (&type_rw_lock);
2348 G_WRITE_LOCK (&type_rw_lock);
2351 /* may have been re-referenced meanwhile */
2352 if (g_atomic_int_dec_and_test ((int *) &node->ref_count))
2354 GType ptype = NODE_PARENT_TYPE (node);
2357 if (node->is_instantiatable)
2359 /* destroy node->data->instance.mem_chunk */
2363 if (node->is_classed && tdata->class.class)
2365 if (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node) != NULL)
2366 type_data_finalize_class_ifaces_Wm (node);
2367 node->mutatable_check_cache = FALSE;
2369 G_WRITE_UNLOCK (&type_rw_lock);
2370 type_data_finalize_class_U (node, &tdata->class);
2371 G_WRITE_LOCK (&type_rw_lock);
2373 else if (NODE_IS_IFACE (node) && tdata->iface.dflt_vtable)
2375 node->mutatable_check_cache = FALSE;
2377 if (tdata->iface.dflt_finalize || tdata->iface.vtable_finalize_base)
2379 G_WRITE_UNLOCK (&type_rw_lock);
2380 if (tdata->iface.dflt_finalize)
2381 tdata->iface.dflt_finalize (tdata->iface.dflt_vtable, (gpointer) tdata->iface.dflt_data);
2382 if (tdata->iface.vtable_finalize_base)
2383 tdata->iface.vtable_finalize_base (tdata->iface.dflt_vtable);
2384 G_WRITE_LOCK (&type_rw_lock);
2386 g_free (tdata->iface.dflt_vtable);
2390 node->mutatable_check_cache = FALSE;
2394 /* freeing tdata->common.value_table and its contents is taken care of
2395 * by allocating it in one chunk with tdata
2399 G_WRITE_UNLOCK (&type_rw_lock);
2400 g_type_plugin_unuse (node->plugin);
2402 type_data_unref_U (lookup_type_node_I (ptype), FALSE);
2403 G_WRITE_LOCK (&type_rw_lock);
2408 type_data_unref_U (TypeNode *node,
2414 current = NODE_REFCOUNT (node);
2420 g_warning ("static type `%s' unreferenced too often",
2426 /* This is the last reference of a type from a plugin. We are
2427 * experimentally disabling support for unloading type
2428 * plugins, so don't allow the last ref to drop.
2433 g_assert (current > 0);
2435 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2436 G_WRITE_LOCK (&type_rw_lock);
2437 type_data_last_unref_Wm (node, uncached);
2438 G_WRITE_UNLOCK (&type_rw_lock);
2439 g_rec_mutex_unlock (&class_init_rec_mutex);
2442 } while (!g_atomic_int_compare_and_exchange ((int *) &node->ref_count, current, current - 1));
2446 * g_type_add_class_cache_func: (skip)
2447 * @cache_data: data to be passed to @cache_func
2448 * @cache_func: a #GTypeClassCacheFunc
2450 * Adds a #GTypeClassCacheFunc to be called before the reference count of a
2451 * class goes from one to zero. This can be used to prevent premature class
2452 * destruction. All installed #GTypeClassCacheFunc functions will be chained
2453 * until one of them returns %TRUE. The functions have to check the class id
2454 * passed in to figure whether they actually want to cache the class of this
2455 * type, since all classes are routed through the same #GTypeClassCacheFunc
2459 g_type_add_class_cache_func (gpointer cache_data,
2460 GTypeClassCacheFunc cache_func)
2464 g_return_if_fail (cache_func != NULL);
2466 G_WRITE_LOCK (&type_rw_lock);
2467 i = static_n_class_cache_funcs++;
2468 static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2469 static_class_cache_funcs[i].cache_data = cache_data;
2470 static_class_cache_funcs[i].cache_func = cache_func;
2471 G_WRITE_UNLOCK (&type_rw_lock);
2475 * g_type_remove_class_cache_func: (skip)
2476 * @cache_data: data that was given when adding @cache_func
2477 * @cache_func: a #GTypeClassCacheFunc
2479 * Removes a previously installed #GTypeClassCacheFunc. The cache
2480 * maintained by @cache_func has to be empty when calling
2481 * g_type_remove_class_cache_func() to avoid leaks.
2484 g_type_remove_class_cache_func (gpointer cache_data,
2485 GTypeClassCacheFunc cache_func)
2487 gboolean found_it = FALSE;
2490 g_return_if_fail (cache_func != NULL);
2492 G_WRITE_LOCK (&type_rw_lock);
2493 for (i = 0; i < static_n_class_cache_funcs; i++)
2494 if (static_class_cache_funcs[i].cache_data == cache_data &&
2495 static_class_cache_funcs[i].cache_func == cache_func)
2497 static_n_class_cache_funcs--;
2498 g_memmove (static_class_cache_funcs + i,
2499 static_class_cache_funcs + i + 1,
2500 sizeof (static_class_cache_funcs[0]) * (static_n_class_cache_funcs - i));
2501 static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2505 G_WRITE_UNLOCK (&type_rw_lock);
2508 g_warning (G_STRLOC ": cannot remove unregistered class cache func %p with data %p",
2509 cache_func, cache_data);
2514 * g_type_add_interface_check: (skip)
2515 * @check_data: data to pass to @check_func
2516 * @check_func: function to be called after each interface
2519 * Adds a function to be called after an interface vtable is
2520 * initialized for any class (i.e. after the @interface_init member of
2521 * #GInterfaceInfo has been called).
2523 * This function is useful when you want to check an invariant that
2524 * depends on the interfaces of a class. For instance, the
2525 * implementation of #GObject uses this facility to check that an
2526 * object implements all of the properties that are defined on its
2532 g_type_add_interface_check (gpointer check_data,
2533 GTypeInterfaceCheckFunc check_func)
2537 g_return_if_fail (check_func != NULL);
2539 G_WRITE_LOCK (&type_rw_lock);
2540 i = static_n_iface_check_funcs++;
2541 static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2542 static_iface_check_funcs[i].check_data = check_data;
2543 static_iface_check_funcs[i].check_func = check_func;
2544 G_WRITE_UNLOCK (&type_rw_lock);
2548 * g_type_remove_interface_check: (skip)
2549 * @check_data: callback data passed to g_type_add_interface_check()
2550 * @check_func: callback function passed to g_type_add_interface_check()
2552 * Removes an interface check function added with
2553 * g_type_add_interface_check().
2558 g_type_remove_interface_check (gpointer check_data,
2559 GTypeInterfaceCheckFunc check_func)
2561 gboolean found_it = FALSE;
2564 g_return_if_fail (check_func != NULL);
2566 G_WRITE_LOCK (&type_rw_lock);
2567 for (i = 0; i < static_n_iface_check_funcs; i++)
2568 if (static_iface_check_funcs[i].check_data == check_data &&
2569 static_iface_check_funcs[i].check_func == check_func)
2571 static_n_iface_check_funcs--;
2572 g_memmove (static_iface_check_funcs + i,
2573 static_iface_check_funcs + i + 1,
2574 sizeof (static_iface_check_funcs[0]) * (static_n_iface_check_funcs - i));
2575 static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2579 G_WRITE_UNLOCK (&type_rw_lock);
2582 g_warning (G_STRLOC ": cannot remove unregistered class check func %p with data %p",
2583 check_func, check_data);
2586 /* --- type registration --- */
2588 * g_type_register_fundamental:
2589 * @type_id: A predefined type identifier.
2590 * @type_name: 0-terminated string used as the name of the new type.
2591 * @info: The #GTypeInfo structure for this type.
2592 * @finfo: The #GTypeFundamentalInfo structure for this type.
2593 * @flags: Bitwise combination of #GTypeFlags values.
2595 * Registers @type_id as the predefined identifier and @type_name as the
2596 * name of a fundamental type. If @type_id is already registered, or a type
2597 * named @type_name is already registered, the behaviour is undefined. The type
2598 * system uses the information contained in the #GTypeInfo structure pointed to
2599 * by @info and the #GTypeFundamentalInfo structure pointed to by @finfo to
2600 * manage the type and its instances. The value of @flags determines additional
2601 * characteristics of the fundamental type.
2603 * Returns: The predefined type identifier.
2606 g_type_register_fundamental (GType type_id,
2607 const gchar *type_name,
2608 const GTypeInfo *info,
2609 const GTypeFundamentalInfo *finfo,
2614 g_assert_type_system_initialized ();
2615 g_return_val_if_fail (type_id > 0, 0);
2616 g_return_val_if_fail (type_name != NULL, 0);
2617 g_return_val_if_fail (info != NULL, 0);
2618 g_return_val_if_fail (finfo != NULL, 0);
2620 if (!check_type_name_I (type_name))
2622 if ((type_id & TYPE_ID_MASK) ||
2623 type_id > G_TYPE_FUNDAMENTAL_MAX)
2625 g_warning ("attempt to register fundamental type `%s' with invalid type id (%" G_GSIZE_FORMAT ")",
2630 if ((finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
2631 !(finfo->type_flags & G_TYPE_FLAG_CLASSED))
2633 g_warning ("cannot register instantiatable fundamental type `%s' as non-classed",
2637 if (lookup_type_node_I (type_id))
2639 g_warning ("cannot register existing fundamental type `%s' (as `%s')",
2640 type_descriptive_name_I (type_id),
2645 G_WRITE_LOCK (&type_rw_lock);
2646 node = type_node_fundamental_new_W (type_id, type_name, finfo->type_flags);
2647 type_add_flags_W (node, flags);
2649 if (check_type_info_I (NULL, NODE_FUNDAMENTAL_TYPE (node), type_name, info))
2650 type_data_make_W (node, info,
2651 check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2652 G_WRITE_UNLOCK (&type_rw_lock);
2654 return NODE_TYPE (node);
2658 * g_type_register_static_simple: (skip)
2659 * @parent_type: Type from which this type will be derived.
2660 * @type_name: 0-terminated string used as the name of the new type.
2661 * @class_size: Size of the class structure (see #GTypeInfo)
2662 * @class_init: Location of the class initialization function (see #GTypeInfo)
2663 * @instance_size: Size of the instance structure (see #GTypeInfo)
2664 * @instance_init: Location of the instance initialization function (see #GTypeInfo)
2665 * @flags: Bitwise combination of #GTypeFlags values.
2667 * Registers @type_name as the name of a new static type derived from
2668 * @parent_type. The value of @flags determines the nature (e.g.
2669 * abstract or not) of the type. It works by filling a #GTypeInfo
2670 * struct and calling g_type_register_static().
2674 * Returns: The new type identifier.
2677 g_type_register_static_simple (GType parent_type,
2678 const gchar *type_name,
2680 GClassInitFunc class_init,
2681 guint instance_size,
2682 GInstanceInitFunc instance_init,
2687 /* Instances are not allowed to be larger than this. If you have a big
2688 * fixed-length array or something, point to it instead.
2690 g_return_val_if_fail (class_size <= G_MAXUINT16, G_TYPE_INVALID);
2691 g_return_val_if_fail (instance_size <= G_MAXUINT16, G_TYPE_INVALID);
2693 info.class_size = class_size;
2694 info.base_init = NULL;
2695 info.base_finalize = NULL;
2696 info.class_init = class_init;
2697 info.class_finalize = NULL;
2698 info.class_data = NULL;
2699 info.instance_size = instance_size;
2700 info.n_preallocs = 0;
2701 info.instance_init = instance_init;
2702 info.value_table = NULL;
2704 return g_type_register_static (parent_type, type_name, &info, flags);
2708 * g_type_register_static:
2709 * @parent_type: Type from which this type will be derived.
2710 * @type_name: 0-terminated string used as the name of the new type.
2711 * @info: The #GTypeInfo structure for this type.
2712 * @flags: Bitwise combination of #GTypeFlags values.
2714 * Registers @type_name as the name of a new static type derived from
2715 * @parent_type. The type system uses the information contained in the
2716 * #GTypeInfo structure pointed to by @info to manage the type and its
2717 * instances (if not abstract). The value of @flags determines the nature
2718 * (e.g. abstract or not) of the type.
2720 * Returns: The new type identifier.
2723 g_type_register_static (GType parent_type,
2724 const gchar *type_name,
2725 const GTypeInfo *info,
2728 TypeNode *pnode, *node;
2731 g_assert_type_system_initialized ();
2732 g_return_val_if_fail (parent_type > 0, 0);
2733 g_return_val_if_fail (type_name != NULL, 0);
2734 g_return_val_if_fail (info != NULL, 0);
2736 if (!check_type_name_I (type_name) ||
2737 !check_derivation_I (parent_type, type_name))
2739 if (info->class_finalize)
2741 g_warning ("class finalizer specified for static type `%s'",
2746 pnode = lookup_type_node_I (parent_type);
2747 G_WRITE_LOCK (&type_rw_lock);
2748 type_data_ref_Wm (pnode);
2749 if (check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (pnode), type_name, info))
2751 node = type_node_new_W (pnode, type_name, NULL);
2752 type_add_flags_W (node, flags);
2753 type = NODE_TYPE (node);
2754 type_data_make_W (node, info,
2755 check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2757 G_WRITE_UNLOCK (&type_rw_lock);
2763 * g_type_register_dynamic:
2764 * @parent_type: Type from which this type will be derived.
2765 * @type_name: 0-terminated string used as the name of the new type.
2766 * @plugin: The #GTypePlugin structure to retrieve the #GTypeInfo from.
2767 * @flags: Bitwise combination of #GTypeFlags values.
2769 * Registers @type_name as the name of a new dynamic type derived from
2770 * @parent_type. The type system uses the information contained in the
2771 * #GTypePlugin structure pointed to by @plugin to manage the type and its
2772 * instances (if not abstract). The value of @flags determines the nature
2773 * (e.g. abstract or not) of the type.
2775 * Returns: The new type identifier or #G_TYPE_INVALID if registration failed.
2778 g_type_register_dynamic (GType parent_type,
2779 const gchar *type_name,
2780 GTypePlugin *plugin,
2783 TypeNode *pnode, *node;
2786 g_assert_type_system_initialized ();
2787 g_return_val_if_fail (parent_type > 0, 0);
2788 g_return_val_if_fail (type_name != NULL, 0);
2789 g_return_val_if_fail (plugin != NULL, 0);
2791 if (!check_type_name_I (type_name) ||
2792 !check_derivation_I (parent_type, type_name) ||
2793 !check_plugin_U (plugin, TRUE, FALSE, type_name))
2796 G_WRITE_LOCK (&type_rw_lock);
2797 pnode = lookup_type_node_I (parent_type);
2798 node = type_node_new_W (pnode, type_name, plugin);
2799 type_add_flags_W (node, flags);
2800 type = NODE_TYPE (node);
2801 G_WRITE_UNLOCK (&type_rw_lock);
2807 * g_type_add_interface_static:
2808 * @instance_type: #GType value of an instantiable type.
2809 * @interface_type: #GType value of an interface type.
2810 * @info: The #GInterfaceInfo structure for this
2811 * (@instance_type, @interface_type) combination.
2813 * Adds the static @interface_type to @instantiable_type. The
2814 * information contained in the #GInterfaceInfo structure pointed to by
2815 * @info is used to manage the relationship.
2818 g_type_add_interface_static (GType instance_type,
2819 GType interface_type,
2820 const GInterfaceInfo *info)
2822 /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2823 g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2824 g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2826 /* we only need to lock class_init_rec_mutex if instance_type already has its
2827 * class initialized, however this function is rarely enough called to take
2828 * the simple route and always acquire class_init_rec_mutex.
2830 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2831 G_WRITE_LOCK (&type_rw_lock);
2832 if (check_add_interface_L (instance_type, interface_type))
2834 TypeNode *node = lookup_type_node_I (instance_type);
2835 TypeNode *iface = lookup_type_node_I (interface_type);
2836 if (check_interface_info_I (iface, NODE_TYPE (node), info))
2837 type_add_interface_Wm (node, iface, info, NULL);
2839 G_WRITE_UNLOCK (&type_rw_lock);
2840 g_rec_mutex_unlock (&class_init_rec_mutex);
2844 * g_type_add_interface_dynamic:
2845 * @instance_type: the #GType value of an instantiable type.
2846 * @interface_type: the #GType value of an interface type.
2847 * @plugin: the #GTypePlugin structure to retrieve the #GInterfaceInfo from.
2849 * Adds the dynamic @interface_type to @instantiable_type. The information
2850 * contained in the #GTypePlugin structure pointed to by @plugin
2851 * is used to manage the relationship.
2854 g_type_add_interface_dynamic (GType instance_type,
2855 GType interface_type,
2856 GTypePlugin *plugin)
2859 /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2860 g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2861 g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2863 node = lookup_type_node_I (instance_type);
2864 if (!check_plugin_U (plugin, FALSE, TRUE, NODE_NAME (node)))
2867 /* see comment in g_type_add_interface_static() about class_init_rec_mutex */
2868 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2869 G_WRITE_LOCK (&type_rw_lock);
2870 if (check_add_interface_L (instance_type, interface_type))
2872 TypeNode *iface = lookup_type_node_I (interface_type);
2873 type_add_interface_Wm (node, iface, NULL, plugin);
2875 G_WRITE_UNLOCK (&type_rw_lock);
2876 g_rec_mutex_unlock (&class_init_rec_mutex);
2880 /* --- public API functions --- */
2883 * @type: Type ID of a classed type.
2885 * Increments the reference count of the class structure belonging to
2886 * @type. This function will demand-create the class if it doesn't
2889 * Returns: (type GObject.TypeClass) (transfer none): The #GTypeClass
2890 * structure for the given type ID.
2893 g_type_class_ref (GType type)
2900 /* optimize for common code path */
2901 node = lookup_type_node_I (type);
2902 if (!node || !node->is_classed)
2904 g_warning ("cannot retrieve class for invalid (unclassed) type `%s'",
2905 type_descriptive_name_I (type));
2909 if (G_LIKELY (type_data_ref_U (node)))
2911 if (G_LIKELY (g_atomic_int_get (&node->data->class.init_state) == INITIALIZED))
2912 return node->data->class.class;
2918 /* here, we either have node->data->class.class == NULL, or a recursive
2919 * call to g_type_class_ref() with a partly initialized class, or
2920 * node->data->class.init_state == INITIALIZED, because any
2921 * concurrently running initialization was guarded by class_init_rec_mutex.
2923 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2925 /* we need an initialized parent class for initializing derived classes */
2926 ptype = NODE_PARENT_TYPE (node);
2927 pclass = ptype ? g_type_class_ref (ptype) : NULL;
2929 G_WRITE_LOCK (&type_rw_lock);
2932 type_data_ref_Wm (node);
2934 if (!node->data->class.class) /* class uninitialized */
2935 type_class_init_Wm (node, pclass);
2937 G_WRITE_UNLOCK (&type_rw_lock);
2940 g_type_class_unref (pclass);
2942 g_rec_mutex_unlock (&class_init_rec_mutex);
2944 return node->data->class.class;
2948 * g_type_class_unref:
2949 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to
2952 * Decrements the reference count of the class structure being passed in.
2953 * Once the last reference count of a class has been released, classes
2954 * may be finalized by the type system, so further dereferencing of a
2955 * class pointer after g_type_class_unref() are invalid.
2958 g_type_class_unref (gpointer g_class)
2961 GTypeClass *class = g_class;
2963 g_return_if_fail (g_class != NULL);
2965 node = lookup_type_node_I (class->g_type);
2966 if (node && node->is_classed && NODE_REFCOUNT (node))
2967 type_data_unref_U (node, FALSE);
2969 g_warning ("cannot unreference class of invalid (unclassed) type `%s'",
2970 type_descriptive_name_I (class->g_type));
2974 * g_type_class_unref_uncached: (skip)
2975 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to
2978 * A variant of g_type_class_unref() for use in #GTypeClassCacheFunc
2979 * implementations. It unreferences a class without consulting the chain
2980 * of #GTypeClassCacheFunc<!-- -->s, avoiding the recursion which would occur
2984 g_type_class_unref_uncached (gpointer g_class)
2987 GTypeClass *class = g_class;
2989 g_return_if_fail (g_class != NULL);
2991 node = lookup_type_node_I (class->g_type);
2992 if (node && node->is_classed && NODE_REFCOUNT (node))
2993 type_data_unref_U (node, TRUE);
2995 g_warning ("cannot unreference class of invalid (unclassed) type `%s'",
2996 type_descriptive_name_I (class->g_type));
3000 * g_type_class_peek:
3001 * @type: Type ID of a classed type.
3003 * This function is essentially the same as g_type_class_ref(), except that
3004 * the classes reference count isn't incremented. As a consequence, this function
3005 * may return %NULL if the class of the type passed in does not currently
3006 * exist (hasn't been referenced before).
3008 * Returns: (type GObject.TypeClass) (transfer none): The #GTypeClass
3009 * structure for the given type ID or %NULL if the class does not
3013 g_type_class_peek (GType type)
3018 node = lookup_type_node_I (type);
3019 if (node && node->is_classed && NODE_REFCOUNT (node) &&
3020 g_atomic_int_get (&node->data->class.init_state) == INITIALIZED)
3021 /* ref_count _may_ be 0 */
3022 class = node->data->class.class;
3030 * g_type_class_peek_static:
3031 * @type: Type ID of a classed type.
3033 * A more efficient version of g_type_class_peek() which works only for
3037 * Returns: (type GObject.TypeClass) (transfer none): The #GTypeClass
3038 * structure for the given type ID or %NULL if the class does not
3039 * currently exist or is dynamically loaded.
3042 g_type_class_peek_static (GType type)
3047 node = lookup_type_node_I (type);
3048 if (node && node->is_classed && NODE_REFCOUNT (node) &&
3049 /* peek only static types: */ node->plugin == NULL &&
3050 g_atomic_int_get (&node->data->class.init_state) == INITIALIZED)
3051 /* ref_count _may_ be 0 */
3052 class = node->data->class.class;
3060 * g_type_class_peek_parent:
3061 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to
3062 * retrieve the parent class for.
3064 * This is a convenience function often needed in class initializers.
3065 * It returns the class structure of the immediate parent type of the
3066 * class passed in. Since derived classes hold a reference count on
3067 * their parent classes as long as they are instantiated, the returned
3068 * class will always exist. This function is essentially equivalent
3072 * g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)));
3075 * Returns: (type GObject.TypeClass) (transfer none): The parent class
3079 g_type_class_peek_parent (gpointer g_class)
3082 gpointer class = NULL;
3084 g_return_val_if_fail (g_class != NULL, NULL);
3086 node = lookup_type_node_I (G_TYPE_FROM_CLASS (g_class));
3087 /* We used to acquire a read lock here. That is not necessary, since
3088 * parent->data->class.class is constant as long as the derived class
3091 if (node && node->is_classed && node->data && NODE_PARENT_TYPE (node))
3093 node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3094 class = node->data->class.class;
3096 else if (NODE_PARENT_TYPE (node))
3097 g_warning (G_STRLOC ": invalid class pointer `%p'", g_class);
3103 * g_type_interface_peek:
3104 * @instance_class: (type GObject.TypeClass): A #GTypeClass structure.
3105 * @iface_type: An interface ID which this class conforms to.
3107 * Returns the #GTypeInterface structure of an interface to which the
3108 * passed in class conforms.
3110 * Returns: (type GObject.TypeInterface) (transfer none): The GTypeInterface
3111 * structure of iface_type if implemented by @instance_class, %NULL
3115 g_type_interface_peek (gpointer instance_class,
3120 gpointer vtable = NULL;
3121 GTypeClass *class = instance_class;
3123 g_return_val_if_fail (instance_class != NULL, NULL);
3125 node = lookup_type_node_I (class->g_type);
3126 iface = lookup_type_node_I (iface_type);
3127 if (node && node->is_instantiatable && iface)
3128 type_lookup_iface_vtable_I (node, iface, &vtable);
3130 g_warning (G_STRLOC ": invalid class pointer `%p'", class);
3136 * g_type_interface_peek_parent:
3137 * @g_iface: (type GObject.TypeInterface): A #GTypeInterface structure.
3139 * Returns the corresponding #GTypeInterface structure of the parent type
3140 * of the instance type to which @g_iface belongs. This is useful when
3141 * deriving the implementation of an interface from the parent type and
3142 * then possibly overriding some methods.
3144 * Returns: (transfer none) (type GObject.TypeInterface): The
3145 * corresponding #GTypeInterface structure of the parent type of the
3146 * instance type to which @g_iface belongs, or %NULL if the parent
3147 * type doesn't conform to the interface.
3150 g_type_interface_peek_parent (gpointer g_iface)
3154 gpointer vtable = NULL;
3155 GTypeInterface *iface_class = g_iface;
3157 g_return_val_if_fail (g_iface != NULL, NULL);
3159 iface = lookup_type_node_I (iface_class->g_type);
3160 node = lookup_type_node_I (iface_class->g_instance_type);
3162 node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3163 if (node && node->is_instantiatable && iface)
3164 type_lookup_iface_vtable_I (node, iface, &vtable);
3166 g_warning (G_STRLOC ": invalid interface pointer `%p'", g_iface);
3172 * g_type_default_interface_ref:
3173 * @g_type: an interface type
3175 * Increments the reference count for the interface type @g_type,
3176 * and returns the default interface vtable for the type.
3178 * If the type is not currently in use, then the default vtable
3179 * for the type will be created and initalized by calling
3180 * the base interface init and default vtable init functions for
3181 * the type (the @<structfield>base_init</structfield>
3182 * and <structfield>class_init</structfield> 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.
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.
3194 g_type_default_interface_ref (GType g_type)
3197 gpointer dflt_vtable;
3199 G_WRITE_LOCK (&type_rw_lock);
3201 node = lookup_type_node_I (g_type);
3202 if (!node || !NODE_IS_IFACE (node) ||
3203 (node->data && NODE_REFCOUNT (node) == 0))
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));
3211 if (!node->data || !node->data->iface.dflt_vtable)
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);
3222 type_data_ref_Wm (node); /* ref_count >= 1 already */
3224 dflt_vtable = node->data->iface.dflt_vtable;
3225 G_WRITE_UNLOCK (&type_rw_lock);
3231 * g_type_default_interface_peek:
3232 * @g_type: an interface type
3234 * If the interface type @g_type is currently in use, returns its
3235 * default interface vtable.
3239 * Returns: (type GObject.TypeInterface) (transfer none): the default
3240 * vtable for the interface, or %NULL if the type is not currently in
3244 g_type_default_interface_peek (GType g_type)
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;
3259 * g_type_default_interface_unref:
3260 * @g_iface: (type GObject.TypeInterface): the default vtable
3261 * structure for a interface, as returned by
3262 * g_type_default_interface_ref()
3264 * Decrements the reference count for the type corresponding to the
3265 * interface default vtable @g_iface. If the type is dynamic, then
3266 * when no one is using the interface and all references have
3267 * been released, the finalize function for the interface's default
3268 * vtable (the <structfield>class_finalize</structfield> member of
3269 * #GTypeInfo) will be called.
3274 g_type_default_interface_unref (gpointer g_iface)
3277 GTypeInterface *vtable = g_iface;
3279 g_return_if_fail (g_iface != NULL);
3281 node = lookup_type_node_I (vtable->g_type);
3282 if (node && NODE_IS_IFACE (node))
3283 type_data_unref_U (node, FALSE);
3285 g_warning ("cannot unreference invalid interface default vtable for '%s'",
3286 type_descriptive_name_I (vtable->g_type));
3291 * @type: Type to return name for.
3293 * Get the unique name that is assigned to a type ID. Note that this
3294 * function (like all other GType API) cannot cope with invalid type
3295 * IDs. %G_TYPE_INVALID may be passed to this function, as may be any
3296 * other validly registered type ID, but randomized type IDs should
3297 * not be passed in and will most likely lead to a crash.
3299 * Returns: Static type name or %NULL.
3302 g_type_name (GType type)
3306 g_assert_type_system_initialized ();
3308 node = lookup_type_node_I (type);
3310 return node ? NODE_NAME (node) : NULL;
3315 * @type: Type to return quark of type name for.
3317 * Get the corresponding quark of the type IDs name.
3319 * Returns: The type names quark or 0.
3322 g_type_qname (GType type)
3326 node = lookup_type_node_I (type);
3328 return node ? node->qname : 0;
3333 * @name: Type name to lookup.
3335 * Lookup the type ID from a given type name, returning 0 if no type
3336 * has been registered under this name (this is the preferred method
3337 * to find out by name whether a specific type has been registered
3340 * Returns: Corresponding type ID or 0.
3343 g_type_from_name (const gchar *name)
3347 g_return_val_if_fail (name != NULL, 0);
3349 G_READ_LOCK (&type_rw_lock);
3350 type = (GType) g_hash_table_lookup (static_type_nodes_ht, name);
3351 G_READ_UNLOCK (&type_rw_lock);
3358 * @type: The derived type.
3360 * Return the direct parent type of the passed in type. If the passed
3361 * in type has no parent, i.e. is a fundamental type, 0 is returned.
3363 * Returns: The parent type.
3366 g_type_parent (GType type)
3370 node = lookup_type_node_I (type);
3372 return node ? NODE_PARENT_TYPE (node) : 0;
3377 * @type: A #GType value.
3379 * Returns the length of the ancestry of the passed in type. This
3380 * includes the type itself, so that e.g. a fundamental type has depth 1.
3382 * Returns: The depth of @type.
3385 g_type_depth (GType type)
3389 node = lookup_type_node_I (type);
3391 return node ? node->n_supers + 1 : 0;
3396 * @leaf_type: Descendant of @root_type and the type to be returned.
3397 * @root_type: Immediate parent of the returned type.
3399 * Given a @leaf_type and a @root_type which is contained in its
3400 * anchestry, return the type that @root_type is the immediate parent
3401 * of. In other words, this function determines the type that is
3402 * derived directly from @root_type which is also a base class of
3403 * @leaf_type. Given a root type and a leaf type, this function can
3404 * be used to determine the types and order in which the leaf type is
3405 * descended from the root type.
3407 * Returns: Immediate child of @root_type and anchestor of @leaf_type.
3410 g_type_next_base (GType type,
3416 node = lookup_type_node_I (type);
3419 TypeNode *base_node = lookup_type_node_I (base_type);
3421 if (base_node && base_node->n_supers < node->n_supers)
3423 guint n = node->n_supers - base_node->n_supers;
3425 if (node->supers[n] == base_type)
3426 atype = node->supers[n - 1];
3433 static inline gboolean
3434 type_node_check_conformities_UorL (TypeNode *node,
3435 TypeNode *iface_node,
3436 /* support_inheritance */
3437 gboolean support_interfaces,
3438 gboolean support_prerequisites,
3443 if (/* support_inheritance && */
3444 NODE_IS_ANCESTOR (iface_node, node))
3447 support_interfaces = support_interfaces && node->is_instantiatable && NODE_IS_IFACE (iface_node);
3448 support_prerequisites = support_prerequisites && NODE_IS_IFACE (node);
3450 if (support_interfaces)
3454 if (type_lookup_iface_entry_L (node, iface_node))
3459 if (type_lookup_iface_vtable_I (node, iface_node, NULL))
3464 support_prerequisites)
3467 G_READ_LOCK (&type_rw_lock);
3468 if (support_prerequisites && type_lookup_prerequisite_L (node, NODE_TYPE (iface_node)))
3471 G_READ_UNLOCK (&type_rw_lock);
3477 type_node_is_a_L (TypeNode *node,
3478 TypeNode *iface_node)
3480 return type_node_check_conformities_UorL (node, iface_node, TRUE, TRUE, TRUE);
3483 static inline gboolean
3484 type_node_conforms_to_U (TypeNode *node,
3485 TypeNode *iface_node,
3486 gboolean support_interfaces,
3487 gboolean support_prerequisites)
3489 return type_node_check_conformities_UorL (node, iface_node, support_interfaces, support_prerequisites, FALSE);
3494 * @type: Type to check anchestry for.
3495 * @is_a_type: Possible anchestor of @type or interface @type could conform to.
3497 * If @is_a_type is a derivable type, check whether @type is a
3498 * descendant of @is_a_type. If @is_a_type is an interface, check
3499 * whether @type conforms to it.
3501 * Returns: %TRUE if @type is_a @is_a_type holds true.
3504 g_type_is_a (GType type,
3507 TypeNode *node, *iface_node;
3510 node = lookup_type_node_I (type);
3511 iface_node = lookup_type_node_I (iface_type);
3512 is_a = node && iface_node && type_node_conforms_to_U (node, iface_node, TRUE, TRUE);
3519 * @type: The parent type.
3520 * @n_children: (out) (allow-none): Optional #guint pointer to contain
3521 * the number of child types.
3523 * Return a newly allocated and 0-terminated array of type IDs, listing the
3524 * child types of @type. The return value has to be g_free()ed after use.
3526 * Returns: (array length=n_children) (transfer full): Newly allocated
3527 * and 0-terminated array of child types.
3530 g_type_children (GType type,
3535 node = lookup_type_node_I (type);
3540 G_READ_LOCK (&type_rw_lock); /* ->children is relocatable */
3541 children = g_new (GType, node->n_children + 1);
3542 memcpy (children, node->children, sizeof (GType) * node->n_children);
3543 children[node->n_children] = 0;
3546 *n_children = node->n_children;
3547 G_READ_UNLOCK (&type_rw_lock);
3561 * g_type_interfaces:
3562 * @type: The type to list interface types for.
3563 * @n_interfaces: (out) (allow-none): Optional #guint pointer to
3564 * contain the number of interface types.
3566 * Return a newly allocated and 0-terminated array of type IDs, listing the
3567 * interface types that @type conforms to. The return value has to be
3568 * g_free()ed after use.
3570 * Returns: (array length=n_interfaces) (transfer full): Newly
3571 * allocated and 0-terminated array of interface types.
3574 g_type_interfaces (GType type,
3575 guint *n_interfaces)
3579 node = lookup_type_node_I (type);
3580 if (node && node->is_instantiatable)
3582 IFaceEntries *entries;
3586 G_READ_LOCK (&type_rw_lock);
3587 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
3590 ifaces = g_new (GType, IFACE_ENTRIES_N_ENTRIES (entries) + 1);
3591 for (i = 0; i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
3592 ifaces[i] = entries->entry[i].iface_type;
3596 ifaces = g_new (GType, 1);
3603 G_READ_UNLOCK (&type_rw_lock);
3616 typedef struct _QData QData;
3628 static inline gpointer
3629 type_get_qdata_L (TypeNode *node,
3632 GData *gdata = node->global_gdata;
3634 if (quark && gdata && gdata->n_qdatas)
3636 QData *qdatas = gdata->qdatas - 1;
3637 guint n_qdatas = gdata->n_qdatas;
3644 i = (n_qdatas + 1) / 2;
3646 if (quark == check->quark)
3648 else if (quark > check->quark)
3653 else /* if (quark < check->quark) */
3664 * @quark: a #GQuark id to identify the data
3666 * Obtains data which has previously been attached to @type
3667 * with g_type_set_qdata().
3669 * Note that this does not take subtyping into account; data
3670 * attached to one type with g_type_set_qdata() cannot
3671 * be retrieved from a subtype using g_type_get_qdata().
3673 * Returns: (transfer none): the data, or %NULL if no data was found
3676 g_type_get_qdata (GType type,
3682 node = lookup_type_node_I (type);
3685 G_READ_LOCK (&type_rw_lock);
3686 data = type_get_qdata_L (node, quark);
3687 G_READ_UNLOCK (&type_rw_lock);
3691 g_return_val_if_fail (node != NULL, NULL);
3698 type_set_qdata_W (TypeNode *node,
3706 /* setup qdata list if necessary */
3707 if (!node->global_gdata)
3708 node->global_gdata = g_new0 (GData, 1);
3709 gdata = node->global_gdata;
3711 /* try resetting old data */
3712 qdata = gdata->qdatas;
3713 for (i = 0; i < gdata->n_qdatas; i++)
3714 if (qdata[i].quark == quark)
3716 qdata[i].data = data;
3722 gdata->qdatas = g_renew (QData, gdata->qdatas, gdata->n_qdatas);
3723 qdata = gdata->qdatas;
3724 for (i = 0; i < gdata->n_qdatas - 1; i++)
3725 if (qdata[i].quark > quark)
3727 g_memmove (qdata + i + 1, qdata + i, sizeof (qdata[0]) * (gdata->n_qdatas - i - 1));
3728 qdata[i].quark = quark;
3729 qdata[i].data = data;
3735 * @quark: a #GQuark id to identify the data
3738 * Attaches arbitrary data to a type.
3741 g_type_set_qdata (GType type,
3747 g_return_if_fail (quark != 0);
3749 node = lookup_type_node_I (type);
3752 G_WRITE_LOCK (&type_rw_lock);
3753 type_set_qdata_W (node, quark, data);
3754 G_WRITE_UNLOCK (&type_rw_lock);
3757 g_return_if_fail (node != NULL);
3761 type_add_flags_W (TypeNode *node,
3766 g_return_if_fail ((flags & ~TYPE_FLAG_MASK) == 0);
3767 g_return_if_fail (node != NULL);
3769 if ((flags & TYPE_FLAG_MASK) && node->is_classed && node->data && node->data->class.class)
3770 g_warning ("tagging type `%s' as abstract after class initialization", NODE_NAME (node));
3771 dflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
3773 type_set_qdata_W (node, static_quark_type_flags, GUINT_TO_POINTER (dflags));
3778 * @type: the #GType value of a static, classed type.
3779 * @query: (out caller-allocates): A user provided structure that is
3780 * filled in with constant values upon success.
3782 * Queries the type system for information about a specific type.
3783 * This function will fill in a user-provided structure to hold
3784 * type-specific information. If an invalid #GType is passed in, the
3785 * @type member of the #GTypeQuery is 0. All members filled into the
3786 * #GTypeQuery structure should be considered constant and have to be
3790 g_type_query (GType type,
3795 g_return_if_fail (query != NULL);
3797 /* if node is not static and classed, we won't allow query */
3799 node = lookup_type_node_I (type);
3800 if (node && node->is_classed && !node->plugin)
3802 /* type is classed and probably even instantiatable */
3803 G_READ_LOCK (&type_rw_lock);
3804 if (node->data) /* type is static or referenced */
3806 query->type = NODE_TYPE (node);
3807 query->type_name = NODE_NAME (node);
3808 query->class_size = node->data->class.class_size;
3809 query->instance_size = node->is_instantiatable ? node->data->instance.instance_size : 0;
3811 G_READ_UNLOCK (&type_rw_lock);
3816 /* --- implementation details --- */
3818 g_type_test_flags (GType type,
3822 gboolean result = FALSE;
3824 node = lookup_type_node_I (type);
3827 guint fflags = flags & TYPE_FUNDAMENTAL_FLAG_MASK;
3828 guint tflags = flags & TYPE_FLAG_MASK;
3832 GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (node);
3834 fflags = (finfo->type_flags & fflags) == fflags;
3841 G_READ_LOCK (&type_rw_lock);
3842 tflags = (tflags & GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))) == tflags;
3843 G_READ_UNLOCK (&type_rw_lock);
3848 result = tflags && fflags;
3855 * g_type_get_plugin:
3856 * @type: The #GType to retrieve the plugin for.
3858 * Returns the #GTypePlugin structure for @type or
3859 * %NULL if @type does not have a #GTypePlugin structure.
3861 * Returns: (transfer none): The corresponding plugin if @type is a
3862 * dynamic type, %NULL otherwise.
3865 g_type_get_plugin (GType type)
3869 node = lookup_type_node_I (type);
3871 return node ? node->plugin : NULL;
3875 * g_type_interface_get_plugin:
3876 * @instance_type: the #GType value of an instantiatable type.
3877 * @interface_type: the #GType value of an interface type.
3879 * Returns the #GTypePlugin structure for the dynamic interface
3880 * @interface_type which has been added to @instance_type, or %NULL if
3881 * @interface_type has not been added to @instance_type or does not
3882 * have a #GTypePlugin structure. See g_type_add_interface_dynamic().
3884 * Returns: (transfer none): the #GTypePlugin for the dynamic
3885 * interface @interface_type of @instance_type.
3888 g_type_interface_get_plugin (GType instance_type,
3889 GType interface_type)
3894 g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL); /* G_TYPE_IS_INTERFACE() is an external call: _U */
3896 node = lookup_type_node_I (instance_type);
3897 iface = lookup_type_node_I (interface_type);
3900 IFaceHolder *iholder;
3901 GTypePlugin *plugin;
3903 G_READ_LOCK (&type_rw_lock);
3905 iholder = iface_node_get_holders_L (iface);
3906 while (iholder && iholder->instance_type != instance_type)
3907 iholder = iholder->next;
3908 plugin = iholder ? iholder->plugin : NULL;
3910 G_READ_UNLOCK (&type_rw_lock);
3915 g_return_val_if_fail (node == NULL, NULL);
3916 g_return_val_if_fail (iface == NULL, NULL);
3918 g_warning (G_STRLOC ": attempt to look up plugin for invalid instance/interface type pair.");
3924 * g_type_fundamental_next:
3926 * Returns the next free fundamental type id which can be used to
3927 * register a new fundamental type with g_type_register_fundamental().
3928 * The returned type ID represents the highest currently registered
3929 * fundamental type identifier.
3931 * Returns: The nextmost fundamental type ID to be registered,
3932 * or 0 if the type system ran out of fundamental type IDs.
3935 g_type_fundamental_next (void)
3939 G_READ_LOCK (&type_rw_lock);
3940 type = static_fundamental_next;
3941 G_READ_UNLOCK (&type_rw_lock);
3942 type = G_TYPE_MAKE_FUNDAMENTAL (type);
3943 return type <= G_TYPE_FUNDAMENTAL_MAX ? type : 0;
3947 * g_type_fundamental:
3948 * @type_id: valid type ID
3950 * Internal function, used to extract the fundamental type ID portion.
3951 * use G_TYPE_FUNDAMENTAL() instead.
3953 * Returns: fundamental type ID
3956 g_type_fundamental (GType type_id)
3958 TypeNode *node = lookup_type_node_I (type_id);
3960 return node ? NODE_FUNDAMENTAL_TYPE (node) : 0;
3964 g_type_check_instance_is_a (GTypeInstance *type_instance,
3967 TypeNode *node, *iface;
3970 if (!type_instance || !type_instance->g_class)
3973 node = lookup_type_node_I (type_instance->g_class->g_type);
3974 iface = lookup_type_node_I (iface_type);
3975 check = node && node->is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
3981 g_type_check_class_is_a (GTypeClass *type_class,
3984 TypeNode *node, *iface;
3990 node = lookup_type_node_I (type_class->g_type);
3991 iface = lookup_type_node_I (is_a_type);
3992 check = node && node->is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
3998 g_type_check_instance_cast (GTypeInstance *type_instance,
4003 if (type_instance->g_class)
4005 TypeNode *node, *iface;
4006 gboolean is_instantiatable, check;
4008 node = lookup_type_node_I (type_instance->g_class->g_type);
4009 is_instantiatable = node && node->is_instantiatable;
4010 iface = lookup_type_node_I (iface_type);
4011 check = is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
4013 return type_instance;
4015 if (is_instantiatable)
4016 g_warning ("invalid cast from `%s' to `%s'",
4017 type_descriptive_name_I (type_instance->g_class->g_type),
4018 type_descriptive_name_I (iface_type));
4020 g_warning ("invalid uninstantiatable type `%s' in cast to `%s'",
4021 type_descriptive_name_I (type_instance->g_class->g_type),
4022 type_descriptive_name_I (iface_type));
4025 g_warning ("invalid unclassed pointer in cast to `%s'",
4026 type_descriptive_name_I (iface_type));
4029 return type_instance;
4033 g_type_check_class_cast (GTypeClass *type_class,
4038 TypeNode *node, *iface;
4039 gboolean is_classed, check;
4041 node = lookup_type_node_I (type_class->g_type);
4042 is_classed = node && node->is_classed;
4043 iface = lookup_type_node_I (is_a_type);
4044 check = is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
4049 g_warning ("invalid class cast from `%s' to `%s'",
4050 type_descriptive_name_I (type_class->g_type),
4051 type_descriptive_name_I (is_a_type));
4053 g_warning ("invalid unclassed type `%s' in class cast to `%s'",
4054 type_descriptive_name_I (type_class->g_type),
4055 type_descriptive_name_I (is_a_type));
4058 g_warning ("invalid class cast from (NULL) pointer to `%s'",
4059 type_descriptive_name_I (is_a_type));
4064 * g_type_check_instance:
4065 * @instance: A valid #GTypeInstance structure.
4067 * Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
4070 * Returns: %TRUE if @instance is valid, %FALSE otherwise.
4073 g_type_check_instance (GTypeInstance *type_instance)
4075 /* this function is just here to make the signal system
4076 * conveniently elaborated on instance checks
4080 if (type_instance->g_class)
4082 TypeNode *node = lookup_type_node_I (type_instance->g_class->g_type);
4084 if (node && node->is_instantiatable)
4087 g_warning ("instance of invalid non-instantiatable type `%s'",
4088 type_descriptive_name_I (type_instance->g_class->g_type));
4091 g_warning ("instance with invalid (NULL) class pointer");
4094 g_warning ("invalid (NULL) pointer instance");
4099 static inline gboolean
4100 type_check_is_value_type_U (GType type)
4102 GTypeFlags tflags = G_TYPE_FLAG_VALUE_ABSTRACT;
4105 /* common path speed up */
4106 node = lookup_type_node_I (type);
4107 if (node && node->mutatable_check_cache)
4110 G_READ_LOCK (&type_rw_lock);
4114 if (node->data && NODE_REFCOUNT (node) > 0 &&
4115 node->data->common.value_table->value_init)
4116 tflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
4117 else if (NODE_IS_IFACE (node))
4121 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4123 GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4124 TypeNode *prnode = lookup_type_node_I (prtype);
4126 if (prnode->is_instantiatable)
4129 node = lookup_type_node_I (type);
4135 G_READ_UNLOCK (&type_rw_lock);
4137 return !(tflags & G_TYPE_FLAG_VALUE_ABSTRACT);
4141 g_type_check_is_value_type (GType type)
4143 return type_check_is_value_type_U (type);
4147 g_type_check_value (GValue *value)
4149 return value && type_check_is_value_type_U (value->g_type);
4153 g_type_check_value_holds (GValue *value,
4156 return value && type_check_is_value_type_U (value->g_type) && g_type_is_a (value->g_type, type);
4160 * g_type_value_table_peek: (skip)
4161 * @type: A #GType value.
4163 * Returns the location of the #GTypeValueTable associated with @type.
4164 * <emphasis>Note that this function should only be used from source code
4165 * that implements or has internal knowledge of the implementation of
4168 * Returns: Location of the #GTypeValueTable associated with @type or
4169 * %NULL if there is no #GTypeValueTable associated with @type.
4172 g_type_value_table_peek (GType type)
4174 GTypeValueTable *vtable = NULL;
4175 TypeNode *node = lookup_type_node_I (type);
4176 gboolean has_refed_data, has_table;
4178 if (node && NODE_REFCOUNT (node) && node->mutatable_check_cache)
4179 return node->data->common.value_table;
4181 G_READ_LOCK (&type_rw_lock);
4184 has_refed_data = node && node->data && NODE_REFCOUNT (node) > 0;
4185 has_table = has_refed_data && node->data->common.value_table->value_init;
4189 vtable = node->data->common.value_table;
4190 else if (NODE_IS_IFACE (node))
4194 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4196 GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4197 TypeNode *prnode = lookup_type_node_I (prtype);
4199 if (prnode->is_instantiatable)
4202 node = lookup_type_node_I (type);
4203 goto restart_table_peek;
4209 G_READ_UNLOCK (&type_rw_lock);
4215 g_warning (G_STRLOC ": type id `%" G_GSIZE_FORMAT "' is invalid", type);
4216 if (!has_refed_data)
4217 g_warning ("can't peek value table for type `%s' which is not currently referenced",
4218 type_descriptive_name_I (type));
4224 g_type_name_from_instance (GTypeInstance *instance)
4227 return "<NULL-instance>";
4229 return g_type_name_from_class (instance->g_class);
4233 g_type_name_from_class (GTypeClass *g_class)
4236 return "<NULL-class>";
4238 return g_type_name (g_class->g_type);
4242 /* --- private api for gboxed.c --- */
4244 _g_type_boxed_copy (GType type, gpointer value)
4246 TypeNode *node = lookup_type_node_I (type);
4248 return node->data->boxed.copy_func (value);
4252 _g_type_boxed_free (GType type, gpointer value)
4254 TypeNode *node = lookup_type_node_I (type);
4256 node->data->boxed.free_func (value);
4260 _g_type_boxed_init (GType type,
4261 GBoxedCopyFunc copy_func,
4262 GBoxedFreeFunc free_func)
4264 TypeNode *node = lookup_type_node_I (type);
4266 node->data->boxed.copy_func = copy_func;
4267 node->data->boxed.free_func = free_func;
4270 /* --- initialization --- */
4272 * g_type_init_with_debug_flags:
4273 * @debug_flags: Bitwise combination of #GTypeDebugFlags values for
4274 * debugging purposes.
4276 * This function used to initialise the type system with debugging
4277 * flags. Since GLib 2.36, the type system is initialised automatically
4278 * and this function does nothing.
4280 * If you need to enable debugging features, use the GOBJECT_DEBUG
4281 * environment variable.
4283 * Deprecated: 2.36: the type system is now initialised automatically
4286 g_type_init_with_debug_flags (GTypeDebugFlags debug_flags)
4288 g_assert_type_system_initialized ();
4291 g_message ("g_type_init_with_debug_flags() is no longer supported. Use the GOBJECT_DEBUG environment variable.");
4297 * This function used to initialise the type system. Since GLib 2.36,
4298 * the type system is initialised automatically and this function does
4301 * Deprecated: 2.36: the type system is now initialised automatically
4306 g_assert_type_system_initialized ();
4309 #if defined (G_HAS_CONSTRUCTORS)
4310 #ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA
4311 #pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(gobject_init_ctor)
4313 G_DEFINE_CONSTRUCTOR(gobject_init_ctor)
4315 # error Your platform/compiler is missing constructor support
4319 gobject_init_ctor (void)
4321 const gchar *env_string;
4326 G_WRITE_LOCK (&type_rw_lock);
4328 /* setup GObject library wide debugging flags */
4329 env_string = g_getenv ("GOBJECT_DEBUG");
4330 if (env_string != NULL)
4332 GDebugKey debug_keys[] = {
4333 { "objects", G_TYPE_DEBUG_OBJECTS },
4334 { "signals", G_TYPE_DEBUG_SIGNALS },
4337 _g_type_debug_flags = g_parse_debug_string (env_string, debug_keys, G_N_ELEMENTS (debug_keys));
4341 static_quark_type_flags = g_quark_from_static_string ("-g-type-private--GTypeFlags");
4342 static_quark_iface_holder = g_quark_from_static_string ("-g-type-private--IFaceHolder");
4343 static_quark_dependants_array = g_quark_from_static_string ("-g-type-private--dependants-array");
4345 /* type qname hash table */
4346 static_type_nodes_ht = g_hash_table_new (g_str_hash, g_str_equal);
4348 /* invalid type G_TYPE_INVALID (0)
4350 static_fundamental_type_nodes[0] = NULL;
4352 /* void type G_TYPE_NONE
4354 node = type_node_fundamental_new_W (G_TYPE_NONE, g_intern_static_string ("void"), 0);
4355 type = NODE_TYPE (node);
4356 g_assert (type == G_TYPE_NONE);
4358 /* interface fundamental type G_TYPE_INTERFACE (!classed)
4360 memset (&info, 0, sizeof (info));
4361 node = type_node_fundamental_new_W (G_TYPE_INTERFACE, g_intern_static_string ("GInterface"), G_TYPE_FLAG_DERIVABLE);
4362 type = NODE_TYPE (node);
4363 type_data_make_W (node, &info, NULL);
4364 g_assert (type == G_TYPE_INTERFACE);
4366 G_WRITE_UNLOCK (&type_rw_lock);
4370 /* G_TYPE_TYPE_PLUGIN
4372 g_type_ensure (g_type_plugin_get_type ());
4374 /* G_TYPE_* value types
4376 _g_value_types_init ();
4378 /* G_TYPE_ENUM & G_TYPE_FLAGS
4380 _g_enum_types_init ();
4384 _g_boxed_type_init ();
4388 _g_param_type_init ();
4392 _g_object_type_init ();
4394 /* G_TYPE_PARAM_* pspec types
4396 _g_param_spec_types_init ();
4398 /* Value Transformations
4400 _g_value_transforms_init ();
4408 * g_type_class_add_private:
4409 * @g_class: class structure for an instantiatable type
4410 * @private_size: size of private structure.
4412 * Registers a private structure for an instantiatable type.
4414 * When an object is allocated, the private structures for
4415 * the type and all of its parent types are allocated
4416 * sequentially in the same memory block as the public
4419 * Note that the accumulated size of the private structures of
4420 * a type and all its parent types cannot exceed 64 KiB.
4422 * This function should be called in the type's class_init() function.
4423 * The private structure can be retrieved using the
4424 * G_TYPE_INSTANCE_GET_PRIVATE() macro.
4426 * The following example shows attaching a private structure
4427 * <structname>MyObjectPrivate</structname> to an object
4428 * <structname>MyObject</structname> defined in the standard GObject
4430 * type's class_init() function.
4431 * Note the use of a structure member "priv" to avoid the overhead
4432 * of repeatedly calling MY_OBJECT_GET_PRIVATE().
4435 * typedef struct _MyObject MyObject;
4436 * typedef struct _MyObjectPrivate MyObjectPrivate;
4438 * struct _MyObject {
4441 * MyObjectPrivate *priv;
4444 * struct _MyObjectPrivate {
4449 * my_object_class_init (MyObjectClass *klass)
4451 * g_type_class_add_private (klass, sizeof (MyObjectPrivate));
4455 * my_object_init (MyObject *my_object)
4457 * my_object->priv = G_TYPE_INSTANCE_GET_PRIVATE (my_object,
4463 * my_object_get_some_field (MyObject *my_object)
4465 * MyObjectPrivate *priv;
4467 * g_return_val_if_fail (MY_IS_OBJECT (my_object), 0);
4469 * priv = my_object->priv;
4471 * return priv->some_field;
4478 g_type_class_add_private (gpointer g_class,
4481 GType instance_type = ((GTypeClass *)g_class)->g_type;
4482 TypeNode *node = lookup_type_node_I (instance_type);
4484 g_return_if_fail (private_size > 0);
4485 g_return_if_fail (private_size <= 0xffff);
4487 if (!node || !node->is_instantiatable || !node->data || node->data->class.class != g_class)
4489 g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4490 type_descriptive_name_I (instance_type));
4494 if (NODE_PARENT_TYPE (node))
4496 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4497 if (node->data->instance.private_size != pnode->data->instance.private_size)
4499 g_warning ("g_type_add_private() called multiple times for the same type");
4504 G_WRITE_LOCK (&type_rw_lock);
4506 node->data->instance.private_size = ALIGN_STRUCT (node->data->instance.private_size + private_size);
4507 g_assert (node->data->instance.private_size <= 0xffff);
4509 G_WRITE_UNLOCK (&type_rw_lock);
4513 g_type_instance_get_private (GTypeInstance *instance,
4518 g_return_val_if_fail (instance != NULL && instance->g_class != NULL, NULL);
4520 node = lookup_type_node_I (private_type);
4521 if (G_UNLIKELY (!node || !node->is_instantiatable))
4523 g_warning ("instance of invalid non-instantiatable type `%s'",
4524 type_descriptive_name_I (instance->g_class->g_type));
4528 return ((gchar *) instance) - node->data->instance.private_size;
4532 * g_type_class_get_instance_private_offset: (skip)
4533 * @g_class: a #GTypeClass
4535 * Gets the offset of the private data for instances of @g_class.
4537 * This is how many bytes you should add to the instance pointer of a
4538 * class in order to get the private data for the type represented by
4541 * You can only call this function after you have registered a private
4542 * data area for @g_class using g_type_class_add_private().
4544 * Returns: the offset, in bytes
4549 g_type_class_get_instance_private_offset (gpointer g_class)
4551 GType instance_type;
4552 guint16 parent_size;
4555 g_assert (g_class != NULL);
4557 instance_type = ((GTypeClass *) g_class)->g_type;
4558 node = lookup_type_node_I (instance_type);
4560 g_assert (node != NULL);
4561 g_assert (node->is_instantiatable);
4563 if (NODE_PARENT_TYPE (node))
4565 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4567 parent_size = pnode->data->instance.private_size;
4572 if (node->data->instance.private_size == parent_size)
4573 g_error ("g_type_class_get_instance_private_offset() called on class %s but it has no private data",
4574 g_type_name (instance_type));
4576 return -(gint) node->data->instance.private_size;
4580 * g_type_add_class_private:
4581 * @class_type: GType of an classed type.
4582 * @private_size: size of private structure.
4584 * Registers a private class structure for a classed type;
4585 * when the class is allocated, the private structures for
4586 * the class and all of its parent types are allocated
4587 * sequentially in the same memory block as the public
4588 * structures. This function should be called in the
4589 * type's get_type() function after the type is registered.
4590 * The private structure can be retrieved using the
4591 * G_TYPE_CLASS_GET_PRIVATE() macro.
4596 g_type_add_class_private (GType class_type,
4599 TypeNode *node = lookup_type_node_I (class_type);
4602 g_return_if_fail (private_size > 0);
4604 if (!node || !node->is_classed || !node->data)
4606 g_warning ("cannot add class private field to invalid type '%s'",
4607 type_descriptive_name_I (class_type));
4611 if (NODE_PARENT_TYPE (node))
4613 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4614 if (node->data->class.class_private_size != pnode->data->class.class_private_size)
4616 g_warning ("g_type_add_class_private() called multiple times for the same type");
4621 G_WRITE_LOCK (&type_rw_lock);
4623 offset = ALIGN_STRUCT (node->data->class.class_private_size);
4624 node->data->class.class_private_size = offset + private_size;
4626 G_WRITE_UNLOCK (&type_rw_lock);
4630 g_type_class_get_private (GTypeClass *klass,
4633 TypeNode *class_node;
4634 TypeNode *private_node;
4635 TypeNode *parent_node;
4638 g_return_val_if_fail (klass != NULL, NULL);
4640 class_node = lookup_type_node_I (klass->g_type);
4641 if (G_UNLIKELY (!class_node || !class_node->is_classed))
4643 g_warning ("class of invalid type `%s'",
4644 type_descriptive_name_I (klass->g_type));
4648 private_node = lookup_type_node_I (private_type);
4649 if (G_UNLIKELY (!private_node || !NODE_IS_ANCESTOR (private_node, class_node)))
4651 g_warning ("attempt to retrieve private data for invalid type '%s'",
4652 type_descriptive_name_I (private_type));
4656 offset = ALIGN_STRUCT (class_node->data->class.class_size);
4658 if (NODE_PARENT_TYPE (private_node))
4660 parent_node = lookup_type_node_I (NODE_PARENT_TYPE (private_node));
4661 g_assert (parent_node->data && NODE_REFCOUNT (parent_node) > 0);
4663 if (G_UNLIKELY (private_node->data->class.class_private_size == parent_node->data->class.class_private_size))
4665 g_warning ("g_type_instance_get_class_private() requires a prior call to g_type_add_class_private()");
4669 offset += ALIGN_STRUCT (parent_node->data->class.class_private_size);
4672 return G_STRUCT_MEMBER_P (klass, offset);
4679 * Ensures that the indicated @type has been registered with the
4680 * type system, and its _class_init() method has been run.
4682 * In theory, simply calling the type's _get_type() method (or using
4683 * the corresponding macro) is supposed take care of this. However,
4684 * _get_type() methods are often marked %G_GNUC_CONST for performance
4685 * reasons, even though this is technically incorrect (since
4686 * %G_GNUC_CONST requires that the function not have side effects,
4687 * which _get_type() methods do on the first call). As a result, if
4688 * you write a bare call to a _get_type() macro, it may get optimized
4689 * out by the compiler. Using g_type_ensure() guarantees that the
4690 * type's _get_type() method is called.
4695 g_type_ensure (GType type)
4697 /* In theory, @type has already been resolved and so there's nothing
4698 * to do here. But this protects us in the case where the function
4699 * gets inlined (as it might in gobject_init_ctor() above).
4701 if (G_UNLIKELY (type == (GType)-1))
4702 g_error ("can't happen");