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.
29 #include "gtypeplugin.h"
30 #include "gvaluecollector.h"
31 #include "gbsearcharray.h"
32 #include "gobjectalias.h"
33 #include "gatomicarray.h"
38 * @short_description: The GLib Runtime type identification and
40 * @title:Type Information
42 * The GType API is the foundation of the GObject system. It provides the
43 * facilities for registering and managing all fundamental data types,
44 * user-defined object and interface types. Before using any GType
45 * or GObject functions, g_type_init() must be called to initialize the
48 * For type creation and registration purposes, all types fall into one of
49 * two categories: static or dynamic. Static types are never loaded or
50 * unloaded at run-time as dynamic types may be. Static types are created
51 * with g_type_register_static() that gets type specific information passed
52 * in via a #GTypeInfo structure.
53 * Dynamic types are created with g_type_register_dynamic() which takes a
54 * #GTypePlugin structure instead. The remaining type information (the
55 * #GTypeInfo structure) is retrieved during runtime through #GTypePlugin
56 * and the g_type_plugin_*() API.
57 * These registration functions are usually called only once from a
58 * function whose only purpose is to return the type identifier for a
59 * specific class. Once the type (or class or interface) is registered,
60 * it may be instantiated, inherited, or implemented depending on exactly
61 * what sort of type it is.
62 * There is also a third registration function for registering fundamental
63 * types called g_type_register_fundamental() which requires both a #GTypeInfo
64 * structure and a #GTypeFundamentalInfo structure but it is seldom used
65 * since most fundamental types are predefined rather than user-defined.
67 * A final word about type names.
68 * Such an identifier needs to be at least three characters long. There is no
69 * upper length limit. The first character needs to be a letter (a-z or A-Z)
70 * or an underscore '_'. Subsequent characters can be letters, numbers or
75 /* NOTE: some functions (some internal variants and exported ones)
76 * invalidate data portions of the TypeNodes. if external functions/callbacks
77 * are called, pointers to memory maintained by TypeNodes have to be looked up
78 * again. this affects most of the struct TypeNode fields, e.g. ->children or
79 * CLASSED_NODE_IFACES_ENTRIES() respectively IFACE_NODE_PREREQUISITES() (but
80 * not ->supers[]), as all those memory portions can get realloc()ed during
81 * callback invocation.
84 * - g_type_from_name() should do an ordered array lookup after fetching the
85 * the quark, instead of a second hashtable lookup.
88 * lock handling issues when calling static functions are indicated by
89 * uppercase letter postfixes, all static functions have to have
90 * one of the below postfixes:
91 * - _I: [Indifferent about locking]
92 * function doesn't care about locks at all
93 * - _U: [Unlocked invocation]
94 * no read or write lock has to be held across function invocation
95 * (locks may be acquired and released during invocation though)
96 * - _L: [Locked invocation]
97 * a write lock or more than 0 read locks have to be held across
99 * - _W: [Write-locked invocation]
100 * a write lock has to be held across function invocation
101 * - _Wm: [Write-locked invocation, mutatable]
102 * like _W, but the write lock might be released and reacquired
103 * during invocation, watch your pointers
104 * - _WmREC: [Write-locked invocation, mutatable, recursive]
105 * like _Wm, but also acquires recursive mutex class_init_rec_mutex
109 #define G_READ_LOCK(rw_lock) do { g_printerr (G_STRLOC ": readL++\n"); g_static_rw_lock_reader_lock (rw_lock); } while (0)
110 #define G_READ_UNLOCK(rw_lock) do { g_printerr (G_STRLOC ": readL--\n"); g_static_rw_lock_reader_unlock (rw_lock); } while (0)
111 #define G_WRITE_LOCK(rw_lock) do { g_printerr (G_STRLOC ": writeL++\n"); g_static_rw_lock_writer_lock (rw_lock); } while (0)
112 #define G_WRITE_UNLOCK(rw_lock) do { g_printerr (G_STRLOC ": writeL--\n"); g_static_rw_lock_writer_unlock (rw_lock); } while (0)
114 #define G_READ_LOCK(rw_lock) g_static_rw_lock_reader_lock (rw_lock)
115 #define G_READ_UNLOCK(rw_lock) g_static_rw_lock_reader_unlock (rw_lock)
116 #define G_WRITE_LOCK(rw_lock) g_static_rw_lock_writer_lock (rw_lock)
117 #define G_WRITE_UNLOCK(rw_lock) g_static_rw_lock_writer_unlock (rw_lock)
119 #define INVALID_RECURSION(func, arg, type_name) G_STMT_START{ \
120 static const gchar _action[] = " invalidly modified type "; \
121 gpointer _arg = (gpointer) (arg); const gchar *_tname = (type_name), *_fname = (func); \
123 g_error ("%s(%p)%s`%s'", _fname, _arg, _action, _tname); \
125 g_error ("%s()%s`%s'", _fname, _action, _tname); \
127 #define g_return_val_if_uninitialized(condition, init_function, return_value) G_STMT_START{ \
130 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, \
131 "%s: initialization assertion failed, use %s() prior to this function", \
132 G_STRLOC, G_STRINGIFY (init_function)); \
133 return (return_value); \
137 #ifdef G_ENABLE_DEBUG
138 #define DEBUG_CODE(debug_type, code_block) G_STMT_START { \
139 if (_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type) \
142 #else /* !G_ENABLE_DEBUG */
143 #define DEBUG_CODE(debug_type, code_block) /* code_block */
144 #endif /* G_ENABLE_DEBUG */
146 #define TYPE_FUNDAMENTAL_FLAG_MASK (G_TYPE_FLAG_CLASSED | \
147 G_TYPE_FLAG_INSTANTIATABLE | \
148 G_TYPE_FLAG_DERIVABLE | \
149 G_TYPE_FLAG_DEEP_DERIVABLE)
150 #define TYPE_FLAG_MASK (G_TYPE_FLAG_ABSTRACT | G_TYPE_FLAG_VALUE_ABSTRACT)
151 #define SIZEOF_FUNDAMENTAL_INFO ((gssize) MAX (MAX (sizeof (GTypeFundamentalInfo), \
152 sizeof (gpointer)), \
155 /* The 2*sizeof(size_t) alignment here is borrowed from
156 * GNU libc, so it should be good most everywhere.
157 * It is more conservative than is needed on some 64-bit
158 * platforms, but ia64 does require a 16-byte alignment.
159 * The SIMD extensions for x86 and ppc32 would want a
160 * larger alignment than this, but we don't need to
161 * do better than malloc.
163 #define STRUCT_ALIGNMENT (2 * sizeof (gsize))
164 #define ALIGN_STRUCT(offset) \
165 ((offset + (STRUCT_ALIGNMENT - 1)) & -STRUCT_ALIGNMENT)
168 /* --- typedefs --- */
169 typedef struct _TypeNode TypeNode;
170 typedef struct _CommonData CommonData;
171 typedef struct _IFaceData IFaceData;
172 typedef struct _ClassData ClassData;
173 typedef struct _InstanceData InstanceData;
174 typedef union _TypeData TypeData;
175 typedef struct _IFaceEntries IFaceEntries;
176 typedef struct _IFaceEntry IFaceEntry;
177 typedef struct _IFaceHolder IFaceHolder;
180 /* --- prototypes --- */
181 static inline GTypeFundamentalInfo* type_node_fundamental_info_I (TypeNode *node);
182 static void type_add_flags_W (TypeNode *node,
184 static void type_data_make_W (TypeNode *node,
185 const GTypeInfo *info,
186 const GTypeValueTable *value_table);
187 static inline void type_data_ref_Wm (TypeNode *node);
188 static inline void type_data_unref_WmREC (TypeNode *node,
190 static void type_data_last_unref_Wm (TypeNode * node,
192 static inline gpointer type_get_qdata_L (TypeNode *node,
194 static inline void type_set_qdata_W (TypeNode *node,
197 static IFaceHolder* type_iface_peek_holder_L (TypeNode *iface,
198 GType instance_type);
199 static gboolean type_iface_vtable_base_init_Wm (TypeNode *iface,
201 static void type_iface_vtable_iface_init_Wm (TypeNode *iface,
203 static gboolean type_node_is_a_L (TypeNode *node,
204 TypeNode *iface_node);
207 /* --- enumeration --- */
209 /* The InitState enumeration is used to track the progress of initializing
210 * both classes and interface vtables. Keeping the state of initialization
211 * is necessary to handle new interfaces being added while we are initializing
212 * the class or other interfaces.
224 /* --- structures --- */
227 guint volatile ref_count;
229 guint n_children; /* writable with lock */
231 guint _prot_n_prerequisites : 9;
232 guint is_classed : 1;
233 guint is_instantiatable : 1;
234 guint mutatable_check_cache : 1; /* combines some common path checks */
235 GType *children; /* writable with lock */
236 TypeData * volatile data;
240 GAtomicArray iface_entries; /* for !iface types */
241 GType *prerequisistes;
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_IS_IFACE(node) (NODE_FUNDAMENTAL_TYPE (node) == G_TYPE_INTERFACE)
256 #define CLASSED_NODE_IFACES_ENTRIES(node) (&(node)->_prot.iface_entries)
257 #define CLASSED_NODE_IFACES_ENTRIES_LOCKED(node)(G_ATOMIC_ARRAY_GET_LOCKED(CLASSED_NODE_IFACES_ENTRIES((node)), IFaceEntries))
258 #define IFACE_NODE_N_PREREQUISITES(node) ((node)->_prot_n_prerequisites)
259 #define IFACE_NODE_PREREQUISITES(node) ((node)->_prot.prerequisistes)
260 #define iface_node_get_holders_L(node) ((IFaceHolder*) type_get_qdata_L ((node), static_quark_iface_holder))
261 #define iface_node_set_holders_W(node, holders) (type_set_qdata_W ((node), static_quark_iface_holder, (holders)))
262 #define iface_node_get_dependants_array_L(n) ((GType*) type_get_qdata_L ((n), static_quark_dependants_array))
263 #define iface_node_set_dependants_array_W(n,d) (type_set_qdata_W ((n), static_quark_dependants_array, (d)))
264 #define TYPE_ID_MASK ((GType) ((1 << G_TYPE_FUNDAMENTAL_SHIFT) - 1))
266 #define NODE_IS_ANCESTOR(ancestor, node) \
267 ((ancestor)->n_supers <= (node)->n_supers && \
268 (node)->supers[(node)->n_supers - (ancestor)->n_supers] == NODE_TYPE (ancestor))
273 GInterfaceInfo *info;
281 GTypeInterface *vtable;
282 InitState init_state;
285 struct _IFaceEntries {
290 #define IFACE_ENTRIES_HEADER_SIZE (sizeof(IFaceEntries) - sizeof(IFaceEntry))
291 #define IFACE_ENTRIES_N_ENTRIES(_entries) ( (G_ATOMIC_ARRAY_DATA_SIZE((_entries)) - IFACE_ENTRIES_HEADER_SIZE) / sizeof(IFaceEntry) )
295 GTypeValueTable *value_table;
302 GBaseInitFunc vtable_init_base;
303 GBaseFinalizeFunc vtable_finalize_base;
304 GClassInitFunc dflt_init;
305 GClassFinalizeFunc dflt_finalize;
306 gconstpointer dflt_data;
307 gpointer dflt_vtable;
308 GAtomicArray offsets;
315 guint init_state : 4;
316 GBaseInitFunc class_init_base;
317 GBaseFinalizeFunc class_finalize_base;
318 GClassInitFunc class_init;
319 GClassFinalizeFunc class_finalize;
320 gconstpointer class_data;
328 guint init_state : 4;
329 GBaseInitFunc class_init_base;
330 GBaseFinalizeFunc class_finalize_base;
331 GClassInitFunc class_init;
332 GClassFinalizeFunc class_finalize;
333 gconstpointer class_data;
335 guint16 instance_size;
336 guint16 private_size;
338 GInstanceInitFunc instance_init;
346 InstanceData instance;
351 GTypeClassCacheFunc cache_func;
356 GTypeInterfaceCheckFunc check_func;
360 /* --- variables --- */
361 static GStaticRWLock type_rw_lock = G_STATIC_RW_LOCK_INIT;
362 static GStaticRecMutex class_init_rec_mutex = G_STATIC_REC_MUTEX_INIT;
363 static guint static_n_class_cache_funcs = 0;
364 static ClassCacheFunc *static_class_cache_funcs = NULL;
365 static guint static_n_iface_check_funcs = 0;
366 static IFaceCheckFunc *static_iface_check_funcs = NULL;
367 static GQuark static_quark_type_flags = 0;
368 static GQuark static_quark_iface_holder = 0;
369 static GQuark static_quark_dependants_array = 0;
370 GTypeDebugFlags _g_type_debug_flags = 0;
372 /* --- type nodes --- */
373 static GHashTable *static_type_nodes_ht = NULL;
374 static TypeNode *static_fundamental_type_nodes[(G_TYPE_FUNDAMENTAL_MAX >> G_TYPE_FUNDAMENTAL_SHIFT) + 1] = { NULL, };
375 static GType static_fundamental_next = G_TYPE_RESERVED_USER_FIRST;
377 static inline TypeNode*
378 lookup_type_node_I (register GType utype)
380 if (utype > G_TYPE_FUNDAMENTAL_MAX)
381 return (TypeNode*) (utype & ~TYPE_ID_MASK);
383 return static_fundamental_type_nodes[utype >> G_TYPE_FUNDAMENTAL_SHIFT];
387 type_node_any_new_W (TypeNode *pnode,
391 GTypeFundamentalFlags type_flags)
396 guint i, node_size = 0;
398 n_supers = pnode ? pnode->n_supers + 1 : 0;
401 node_size += SIZEOF_FUNDAMENTAL_INFO; /* fundamental type info */
402 node_size += SIZEOF_BASE_TYPE_NODE (); /* TypeNode structure */
403 node_size += (sizeof (GType) * (1 + n_supers + 1)); /* self + ancestors + (0) for ->supers[] */
404 node = g_malloc0 (node_size);
405 if (!pnode) /* offset fundamental types */
407 node = G_STRUCT_MEMBER_P (node, SIZEOF_FUNDAMENTAL_INFO);
408 static_fundamental_type_nodes[ftype >> G_TYPE_FUNDAMENTAL_SHIFT] = node;
414 g_assert ((type & TYPE_ID_MASK) == 0);
416 node->n_supers = n_supers;
419 node->supers[0] = type;
422 node->is_classed = (type_flags & G_TYPE_FLAG_CLASSED) != 0;
423 node->is_instantiatable = (type_flags & G_TYPE_FLAG_INSTANTIATABLE) != 0;
425 if (NODE_IS_IFACE (node))
427 IFACE_NODE_N_PREREQUISITES (node) = 0;
428 IFACE_NODE_PREREQUISITES (node) = NULL;
431 _g_atomic_array_init (CLASSED_NODE_IFACES_ENTRIES (node));
435 node->supers[0] = type;
436 memcpy (node->supers + 1, pnode->supers, sizeof (GType) * (1 + pnode->n_supers + 1));
438 node->is_classed = pnode->is_classed;
439 node->is_instantiatable = pnode->is_instantiatable;
441 if (NODE_IS_IFACE (node))
443 IFACE_NODE_N_PREREQUISITES (node) = 0;
444 IFACE_NODE_PREREQUISITES (node) = NULL;
449 IFaceEntries *entries;
451 entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (pnode),
452 IFACE_ENTRIES_HEADER_SIZE,
456 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
458 entries->entry[j].vtable = NULL;
459 entries->entry[j].init_state = UNINITIALIZED;
461 _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node),
466 i = pnode->n_children++;
467 pnode->children = g_renew (GType, pnode->children, pnode->n_children);
468 pnode->children[i] = type;
471 node->plugin = plugin;
472 node->n_children = 0;
473 node->children = NULL;
475 node->qname = g_quark_from_string (name);
476 node->global_gdata = NULL;
478 g_hash_table_insert (static_type_nodes_ht,
479 GUINT_TO_POINTER (node->qname),
484 static inline GTypeFundamentalInfo*
485 type_node_fundamental_info_I (TypeNode *node)
487 GType ftype = NODE_FUNDAMENTAL_TYPE (node);
489 if (ftype != NODE_TYPE (node))
490 node = lookup_type_node_I (ftype);
492 return node ? G_STRUCT_MEMBER_P (node, -SIZEOF_FUNDAMENTAL_INFO) : NULL;
496 type_node_fundamental_new_W (GType ftype,
498 GTypeFundamentalFlags type_flags)
500 GTypeFundamentalInfo *finfo;
503 g_assert ((ftype & TYPE_ID_MASK) == 0);
504 g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX);
506 if (ftype >> G_TYPE_FUNDAMENTAL_SHIFT == static_fundamental_next)
507 static_fundamental_next++;
509 type_flags &= TYPE_FUNDAMENTAL_FLAG_MASK;
511 node = type_node_any_new_W (NULL, ftype, name, NULL, type_flags);
513 finfo = type_node_fundamental_info_I (node);
514 finfo->type_flags = type_flags;
520 type_node_new_W (TypeNode *pnode,
526 g_assert (pnode->n_supers < MAX_N_SUPERS);
527 g_assert (pnode->n_children < MAX_N_CHILDREN);
529 return type_node_any_new_W (pnode, NODE_FUNDAMENTAL_TYPE (pnode), name, plugin, 0);
532 static inline IFaceEntry*
533 lookup_iface_entry_I (volatile IFaceEntries *entries,
534 TypeNode *iface_node)
545 G_ATOMIC_ARRAY_DO_TRANSACTION
546 (&iface_node->data->iface.offsets, guint8,
549 offsets = transaction_data;
550 offset_index = entries->offset_index;
551 if (offsets != NULL &&
552 offset_index < G_ATOMIC_ARRAY_DATA_SIZE(offsets))
554 index = offsets[offset_index];
557 /* zero means unset, subtract one to get real index */
560 if (index < IFACE_ENTRIES_N_ENTRIES (entries))
562 check = (IFaceEntry *)&entries->entry[index];
563 if (check->iface_type == NODE_TYPE (iface_node))
573 static inline IFaceEntry*
574 type_lookup_iface_entry_L (TypeNode *node,
575 TypeNode *iface_node)
577 if (!NODE_IS_IFACE (iface_node))
580 return lookup_iface_entry_I (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node),
585 static inline gboolean
586 type_lookup_iface_vtable_I (TypeNode *node,
587 TypeNode *iface_node,
588 gpointer *vtable_ptr)
593 if (!NODE_IS_IFACE (iface_node))
600 G_ATOMIC_ARRAY_DO_TRANSACTION
601 (CLASSED_NODE_IFACES_ENTRIES (node), IFaceEntries,
603 entry = lookup_iface_entry_I (transaction_data, iface_node);
608 *vtable_ptr = entry->vtable;
617 static inline gboolean
618 type_lookup_prerequisite_L (TypeNode *iface,
619 GType prerequisite_type)
621 if (NODE_IS_IFACE (iface) && IFACE_NODE_N_PREREQUISITES (iface))
623 GType *prerequisites = IFACE_NODE_PREREQUISITES (iface) - 1;
624 guint n_prerequisites = IFACE_NODE_N_PREREQUISITES (iface);
631 i = (n_prerequisites + 1) >> 1;
632 check = prerequisites + i;
633 if (prerequisite_type == *check)
635 else if (prerequisite_type > *check)
637 n_prerequisites -= i;
638 prerequisites = check;
640 else /* if (prerequisite_type < *check) */
641 n_prerequisites = i - 1;
643 while (n_prerequisites);
649 type_descriptive_name_I (GType type)
653 TypeNode *node = lookup_type_node_I (type);
655 return node ? NODE_NAME (node) : "<unknown>";
662 /* --- type consistency checks --- */
664 check_plugin_U (GTypePlugin *plugin,
665 gboolean need_complete_type_info,
666 gboolean need_complete_interface_info,
667 const gchar *type_name)
669 /* G_IS_TYPE_PLUGIN() and G_TYPE_PLUGIN_GET_CLASS() are external calls: _U
673 g_warning ("plugin handle for type `%s' is NULL",
677 if (!G_IS_TYPE_PLUGIN (plugin))
679 g_warning ("plugin pointer (%p) for type `%s' is invalid",
683 if (need_complete_type_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_type_info)
685 g_warning ("plugin for type `%s' has no complete_type_info() implementation",
689 if (need_complete_interface_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_interface_info)
691 g_warning ("plugin for type `%s' has no complete_interface_info() implementation",
699 check_type_name_I (const gchar *type_name)
701 static const gchar extra_chars[] = "-_+";
702 const gchar *p = type_name;
705 if (!type_name[0] || !type_name[1] || !type_name[2])
707 g_warning ("type name `%s' is too short", type_name);
710 /* check the first letter */
711 name_valid = (p[0] >= 'A' && p[0] <= 'Z') || (p[0] >= 'a' && p[0] <= 'z') || p[0] == '_';
712 for (p = type_name + 1; *p; p++)
713 name_valid &= ((p[0] >= 'A' && p[0] <= 'Z') ||
714 (p[0] >= 'a' && p[0] <= 'z') ||
715 (p[0] >= '0' && p[0] <= '9') ||
716 strchr (extra_chars, p[0]));
719 g_warning ("type name `%s' contains invalid characters", type_name);
722 if (g_type_from_name (type_name))
724 g_warning ("cannot register existing type `%s'", type_name);
732 check_derivation_I (GType parent_type,
733 const gchar *type_name)
736 GTypeFundamentalInfo* finfo;
738 pnode = lookup_type_node_I (parent_type);
741 g_warning ("cannot derive type `%s' from invalid parent type `%s'",
743 type_descriptive_name_I (parent_type));
746 finfo = type_node_fundamental_info_I (pnode);
747 /* ensure flat derivability */
748 if (!(finfo->type_flags & G_TYPE_FLAG_DERIVABLE))
750 g_warning ("cannot derive `%s' from non-derivable parent type `%s'",
755 /* ensure deep derivability */
756 if (parent_type != NODE_FUNDAMENTAL_TYPE (pnode) &&
757 !(finfo->type_flags & G_TYPE_FLAG_DEEP_DERIVABLE))
759 g_warning ("cannot derive `%s' from non-fundamental parent type `%s'",
769 check_collect_format_I (const gchar *collect_format)
771 const gchar *p = collect_format;
772 gchar valid_format[] = { G_VALUE_COLLECT_INT, G_VALUE_COLLECT_LONG,
773 G_VALUE_COLLECT_INT64, G_VALUE_COLLECT_DOUBLE,
774 G_VALUE_COLLECT_POINTER, 0 };
777 if (!strchr (valid_format, *p++))
779 return p - collect_format <= G_VALUE_COLLECT_FORMAT_MAX_LENGTH;
783 check_value_table_I (const gchar *type_name,
784 const GTypeValueTable *value_table)
788 else if (value_table->value_init == NULL)
790 if (value_table->value_free || value_table->value_copy ||
791 value_table->value_peek_pointer ||
792 value_table->collect_format || value_table->collect_value ||
793 value_table->lcopy_format || value_table->lcopy_value)
794 g_warning ("cannot handle uninitializable values of type `%s'",
798 else /* value_table->value_init != NULL */
800 if (!value_table->value_free)
803 * g_warning ("missing `value_free()' for type `%s'", type_name);
807 if (!value_table->value_copy)
809 g_warning ("missing `value_copy()' for type `%s'", type_name);
812 if ((value_table->collect_format || value_table->collect_value) &&
813 (!value_table->collect_format || !value_table->collect_value))
815 g_warning ("one of `collect_format' and `collect_value()' is unspecified for type `%s'",
819 if (value_table->collect_format && !check_collect_format_I (value_table->collect_format))
821 g_warning ("the `%s' specification for type `%s' is too long or invalid",
826 if ((value_table->lcopy_format || value_table->lcopy_value) &&
827 (!value_table->lcopy_format || !value_table->lcopy_value))
829 g_warning ("one of `lcopy_format' and `lcopy_value()' is unspecified for type `%s'",
833 if (value_table->lcopy_format && !check_collect_format_I (value_table->lcopy_format))
835 g_warning ("the `%s' specification for type `%s' is too long or invalid",
845 check_type_info_I (TypeNode *pnode,
847 const gchar *type_name,
848 const GTypeInfo *info)
850 GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (lookup_type_node_I (ftype));
851 gboolean is_interface = ftype == G_TYPE_INTERFACE;
853 g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX && !(ftype & TYPE_ID_MASK));
855 /* check instance members */
856 if (!(finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
857 (info->instance_size || info->n_preallocs || info->instance_init))
860 g_warning ("cannot instantiate `%s', derived from non-instantiatable parent type `%s'",
864 g_warning ("cannot instantiate `%s' as non-instantiatable fundamental",
868 /* check class & interface members */
869 if (!((finfo->type_flags & G_TYPE_FLAG_CLASSED) || is_interface) &&
870 (info->class_init || info->class_finalize || info->class_data ||
871 info->class_size || info->base_init || info->base_finalize))
874 g_warning ("cannot create class for `%s', derived from non-classed parent type `%s'",
878 g_warning ("cannot create class for `%s' as non-classed fundamental",
882 /* check interface size */
883 if (is_interface && info->class_size < sizeof (GTypeInterface))
885 g_warning ("specified interface size for type `%s' is smaller than `GTypeInterface' size",
889 /* check class size */
890 if (finfo->type_flags & G_TYPE_FLAG_CLASSED)
892 if (info->class_size < sizeof (GTypeClass))
894 g_warning ("specified class size for type `%s' is smaller than `GTypeClass' size",
898 if (pnode && info->class_size < pnode->data->class.class_size)
900 g_warning ("specified class size for type `%s' is smaller "
901 "than the parent type's `%s' class size",
907 /* check instance size */
908 if (finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE)
910 if (info->instance_size < sizeof (GTypeInstance))
912 g_warning ("specified instance size for type `%s' is smaller than `GTypeInstance' size",
916 if (pnode && info->instance_size < pnode->data->instance.instance_size)
918 g_warning ("specified instance size for type `%s' is smaller "
919 "than the parent type's `%s' instance size",
930 find_conforming_child_type_L (TypeNode *pnode,
933 TypeNode *node = NULL;
936 if (type_lookup_iface_entry_L (pnode, iface))
939 for (i = 0; i < pnode->n_children && !node; i++)
940 node = find_conforming_child_type_L (lookup_type_node_I (pnode->children[i]), iface);
946 check_add_interface_L (GType instance_type,
949 TypeNode *node = lookup_type_node_I (instance_type);
950 TypeNode *iface = lookup_type_node_I (iface_type);
953 GType *prerequisites;
957 if (!node || !node->is_instantiatable)
959 g_warning ("cannot add interfaces to invalid (non-instantiatable) type `%s'",
960 type_descriptive_name_I (instance_type));
963 if (!iface || !NODE_IS_IFACE (iface))
965 g_warning ("cannot add invalid (non-interface) type `%s' to type `%s'",
966 type_descriptive_name_I (iface_type),
970 tnode = lookup_type_node_I (NODE_PARENT_TYPE (iface));
971 if (NODE_PARENT_TYPE (tnode) && !type_lookup_iface_entry_L (node, tnode))
973 /* 2001/7/31:timj: erk, i guess this warning is junk as interface derivation is flat */
974 g_warning ("cannot add sub-interface `%s' to type `%s' which does not conform to super-interface `%s'",
980 /* allow overriding of interface type introduced for parent type */
981 entry = type_lookup_iface_entry_L (node, iface);
982 if (entry && entry->vtable == NULL && !type_iface_peek_holder_L (iface, NODE_TYPE (node)))
984 /* ok, we do conform to this interface already, but the interface vtable was not
985 * yet intialized, and we just conform to the interface because it got added to
986 * one of our parents. so we allow overriding of holder info here.
990 /* check whether one of our children already conforms (or whether the interface
991 * got added to this node already)
993 tnode = find_conforming_child_type_L (node, iface); /* tnode is_a node */
996 g_warning ("cannot add interface type `%s' to type `%s', since type `%s' already conforms to interface",
1002 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1003 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1005 tnode = lookup_type_node_I (prerequisites[i]);
1006 if (!type_node_is_a_L (node, tnode))
1008 g_warning ("cannot add interface type `%s' to type `%s' which does not conform to prerequisite `%s'",
1019 check_interface_info_I (TypeNode *iface,
1020 GType instance_type,
1021 const GInterfaceInfo *info)
1023 if ((info->interface_finalize || info->interface_data) && !info->interface_init)
1025 g_warning ("interface type `%s' for type `%s' comes without initializer",
1027 type_descriptive_name_I (instance_type));
1034 /* --- type info (type node data) --- */
1036 type_data_make_W (TypeNode *node,
1037 const GTypeInfo *info,
1038 const GTypeValueTable *value_table)
1041 GTypeValueTable *vtable = NULL;
1042 guint vtable_size = 0;
1044 g_assert (node->data == NULL && info != NULL);
1048 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1051 vtable = pnode->data->common.value_table;
1054 static const GTypeValueTable zero_vtable = { NULL, };
1056 value_table = &zero_vtable;
1061 /* need to setup vtable_size since we have to allocate it with data in one chunk */
1062 vtable_size = sizeof (GTypeValueTable);
1063 if (value_table->collect_format)
1064 vtable_size += strlen (value_table->collect_format);
1065 if (value_table->lcopy_format)
1066 vtable_size += strlen (value_table->lcopy_format);
1070 if (node->is_instantiatable) /* carefull, is_instantiatable is also is_classed */
1072 data = g_malloc0 (sizeof (InstanceData) + vtable_size);
1074 vtable = G_STRUCT_MEMBER_P (data, sizeof (InstanceData));
1075 data->instance.class_size = info->class_size;
1076 data->instance.class_init_base = info->base_init;
1077 data->instance.class_finalize_base = info->base_finalize;
1078 data->instance.class_init = info->class_init;
1079 data->instance.class_finalize = info->class_finalize;
1080 data->instance.class_data = info->class_data;
1081 data->instance.class = NULL;
1082 data->instance.init_state = UNINITIALIZED;
1083 data->instance.instance_size = info->instance_size;
1084 /* We'll set the final value for data->instance.private size
1085 * after the parent class has been initialized
1087 data->instance.private_size = 0;
1088 #ifdef DISABLE_MEM_POOLS
1089 data->instance.n_preallocs = 0;
1090 #else /* !DISABLE_MEM_POOLS */
1091 data->instance.n_preallocs = MIN (info->n_preallocs, 1024);
1092 #endif /* !DISABLE_MEM_POOLS */
1093 data->instance.instance_init = info->instance_init;
1095 else if (node->is_classed) /* only classed */
1097 data = g_malloc0 (sizeof (ClassData) + vtable_size);
1099 vtable = G_STRUCT_MEMBER_P (data, sizeof (ClassData));
1100 data->class.class_size = info->class_size;
1101 data->class.class_init_base = info->base_init;
1102 data->class.class_finalize_base = info->base_finalize;
1103 data->class.class_init = info->class_init;
1104 data->class.class_finalize = info->class_finalize;
1105 data->class.class_data = info->class_data;
1106 data->class.class = NULL;
1107 data->class.init_state = UNINITIALIZED;
1109 else if (NODE_IS_IFACE (node))
1111 data = g_malloc0 (sizeof (IFaceData) + vtable_size);
1113 vtable = G_STRUCT_MEMBER_P (data, sizeof (IFaceData));
1114 data->iface.vtable_size = info->class_size;
1115 data->iface.vtable_init_base = info->base_init;
1116 data->iface.vtable_finalize_base = info->base_finalize;
1117 data->iface.dflt_init = info->class_init;
1118 data->iface.dflt_finalize = info->class_finalize;
1119 data->iface.dflt_data = info->class_data;
1120 data->iface.dflt_vtable = NULL;
1124 data = g_malloc0 (sizeof (CommonData) + vtable_size);
1126 vtable = G_STRUCT_MEMBER_P (data, sizeof (CommonData));
1135 /* we allocate the vtable and its strings together with the type data, so
1136 * children can take over their parent's vtable pointer, and we don't
1137 * need to worry freeing it or not when the child data is destroyed
1139 *vtable = *value_table;
1140 p = G_STRUCT_MEMBER_P (vtable, sizeof (*vtable));
1142 vtable->collect_format = p;
1143 if (value_table->collect_format)
1145 strcat (p, value_table->collect_format);
1146 p += strlen (value_table->collect_format);
1150 vtable->lcopy_format = p;
1151 if (value_table->lcopy_format)
1152 strcat (p, value_table->lcopy_format);
1154 node->data->common.value_table = vtable;
1155 node->mutatable_check_cache = (node->data->common.value_table->value_init != NULL &&
1156 !((G_TYPE_FLAG_VALUE_ABSTRACT | G_TYPE_FLAG_ABSTRACT) &
1157 GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))));
1159 g_assert (node->data->common.value_table != NULL); /* paranoid */
1161 node->ref_count = 1;
1165 type_data_ref_Wm (TypeNode *node)
1169 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1171 GTypeValueTable tmp_value_table;
1173 g_assert (node->plugin != NULL);
1177 type_data_ref_Wm (pnode);
1179 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1182 memset (&tmp_info, 0, sizeof (tmp_info));
1183 memset (&tmp_value_table, 0, sizeof (tmp_value_table));
1185 G_WRITE_UNLOCK (&type_rw_lock);
1186 g_type_plugin_use (node->plugin);
1187 g_type_plugin_complete_type_info (node->plugin, NODE_TYPE (node), &tmp_info, &tmp_value_table);
1188 G_WRITE_LOCK (&type_rw_lock);
1190 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1192 check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (node), NODE_NAME (node), &tmp_info);
1193 type_data_make_W (node, &tmp_info,
1194 check_value_table_I (NODE_NAME (node),
1195 &tmp_value_table) ? &tmp_value_table : NULL);
1199 g_assert (node->ref_count > 0);
1201 node->ref_count += 1;
1206 iface_node_has_available_offset_L (TypeNode *iface_node,
1212 offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->data->iface.offsets, guint8);
1213 if (offsets == NULL)
1216 if (G_ATOMIC_ARRAY_DATA_SIZE (offsets) <= offset)
1219 if (offsets[offset] == 0 ||
1220 offsets[offset] == for_index+1)
1227 find_free_iface_offset_L (IFaceEntries *entries)
1230 TypeNode *iface_node;
1235 n_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1240 for (i = 0; i < n_entries; i++)
1242 entry = &entries->entry[i];
1243 iface_node = lookup_type_node_I (entry->iface_type);
1245 if (!iface_node_has_available_offset_L (iface_node, offset, i))
1249 while (i != n_entries);
1255 iface_node_set_offset_L (TypeNode *iface_node,
1259 guint8 *offsets, *old_offsets;
1260 int new_size, old_size;
1263 old_offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->data->iface.offsets, guint8);
1264 if (old_offsets == NULL)
1268 old_size = G_ATOMIC_ARRAY_DATA_SIZE (old_offsets);
1269 if (offset < old_size &&
1270 old_offsets[offset] == index + 1)
1271 return; /* Already set to this index, return */
1273 new_size = MAX (old_size, offset + 1);
1275 offsets = _g_atomic_array_copy (&iface_node->data->iface.offsets,
1276 0, new_size - old_size);
1278 /* Mark new area as unused */
1279 for (i = old_size; i < new_size; i++)
1282 offsets[offset] = index + 1;
1284 _g_atomic_array_update (&iface_node->data->iface.offsets, offsets);
1288 type_node_add_iface_entry_W (TypeNode *node,
1290 IFaceEntry *parent_entry)
1292 IFaceEntries *entries;
1294 TypeNode *iface_node;
1298 g_assert (node->is_instantiatable);
1300 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
1301 if (entries != NULL)
1303 num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1305 g_assert (num_entries < MAX_N_INTERFACES);
1307 for (i = 0; i < num_entries; i++)
1309 entry = &entries->entry[i];
1310 if (entry->iface_type == iface_type)
1312 /* this can happen in two cases:
1313 * - our parent type already conformed to iface_type and node
1314 * got its own holder info. here, our children already have
1315 * entries and NULL vtables, since this will only work for
1316 * uninitialized classes.
1317 * - an interface type is added to an ancestor after it was
1318 * added to a child type.
1321 g_assert (entry->vtable == NULL && entry->init_state == UNINITIALIZED);
1324 /* sick, interface is added to ancestor *after* child type;
1325 * nothing todo, the entry and our children were already setup correctly
1333 entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (node),
1334 IFACE_ENTRIES_HEADER_SIZE,
1335 sizeof (IFaceEntry));
1336 num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1337 i = num_entries - 1;
1339 entries->offset_index = 0;
1340 entries->entry[i].iface_type = iface_type;
1341 entries->entry[i].vtable = NULL;
1342 entries->entry[i].init_state = UNINITIALIZED;
1346 if (node->data && node->data->class.init_state >= BASE_IFACE_INIT)
1348 entries->entry[i].init_state = INITIALIZED;
1349 entries->entry[i].vtable = parent_entry->vtable;
1353 /* Update offsets in iface */
1354 iface_node = lookup_type_node_I (iface_type);
1356 if (iface_node_has_available_offset_L (iface_node,
1357 entries->offset_index,
1360 iface_node_set_offset_L (iface_node,
1361 entries->offset_index, i);
1365 entries->offset_index =
1366 find_free_iface_offset_L (entries);
1367 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
1369 entry = &entries->entry[j];
1371 lookup_type_node_I (entry->iface_type);
1372 iface_node_set_offset_L (iface_node,
1373 entries->offset_index, j);
1377 _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node), entries);
1381 for (i = 0; i < node->n_children; i++)
1382 type_node_add_iface_entry_W (lookup_type_node_I (node->children[i]), iface_type, &entries->entry[i]);
1387 type_add_interface_Wm (TypeNode *node,
1389 const GInterfaceInfo *info,
1390 GTypePlugin *plugin)
1392 IFaceHolder *iholder = g_new0 (IFaceHolder, 1);
1396 g_assert (node->is_instantiatable && NODE_IS_IFACE (iface) && ((info && !plugin) || (!info && plugin)));
1398 iholder->next = iface_node_get_holders_L (iface);
1399 iface_node_set_holders_W (iface, iholder);
1400 iholder->instance_type = NODE_TYPE (node);
1401 iholder->info = info ? g_memdup (info, sizeof (*info)) : NULL;
1402 iholder->plugin = plugin;
1404 /* create an iface entry for this type */
1405 type_node_add_iface_entry_W (node, NODE_TYPE (iface), NULL);
1407 /* if the class is already (partly) initialized, we may need to base
1408 * initalize and/or initialize the new interface.
1412 InitState class_state = node->data->class.init_state;
1414 if (class_state >= BASE_IFACE_INIT)
1415 type_iface_vtable_base_init_Wm (iface, node);
1417 if (class_state >= IFACE_INIT)
1418 type_iface_vtable_iface_init_Wm (iface, node);
1421 /* create iface entries for children of this type */
1422 entry = type_lookup_iface_entry_L (node, iface);
1423 for (i = 0; i < node->n_children; i++)
1424 type_node_add_iface_entry_W (lookup_type_node_I (node->children[i]), NODE_TYPE (iface), entry);
1428 type_iface_add_prerequisite_W (TypeNode *iface,
1429 TypeNode *prerequisite_node)
1431 GType prerequisite_type = NODE_TYPE (prerequisite_node);
1432 GType *prerequisites, *dependants;
1433 guint n_dependants, i;
1435 g_assert (NODE_IS_IFACE (iface) &&
1436 IFACE_NODE_N_PREREQUISITES (iface) < MAX_N_PREREQUISITES &&
1437 (prerequisite_node->is_instantiatable || NODE_IS_IFACE (prerequisite_node)));
1439 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1440 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1441 if (prerequisites[i] == prerequisite_type)
1442 return; /* we already have that prerequisiste */
1443 else if (prerequisites[i] > prerequisite_type)
1445 IFACE_NODE_N_PREREQUISITES (iface) += 1;
1446 IFACE_NODE_PREREQUISITES (iface) = g_renew (GType,
1447 IFACE_NODE_PREREQUISITES (iface),
1448 IFACE_NODE_N_PREREQUISITES (iface));
1449 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1450 g_memmove (prerequisites + i + 1, prerequisites + i,
1451 sizeof (prerequisites[0]) * (IFACE_NODE_N_PREREQUISITES (iface) - i - 1));
1452 prerequisites[i] = prerequisite_type;
1454 /* we want to get notified when prerequisites get added to prerequisite_node */
1455 if (NODE_IS_IFACE (prerequisite_node))
1457 dependants = iface_node_get_dependants_array_L (prerequisite_node);
1458 n_dependants = dependants ? dependants[0] : 0;
1460 dependants = g_renew (GType, dependants, n_dependants + 1);
1461 dependants[n_dependants] = NODE_TYPE (iface);
1462 dependants[0] = n_dependants;
1463 iface_node_set_dependants_array_W (prerequisite_node, dependants);
1466 /* we need to notify all dependants */
1467 dependants = iface_node_get_dependants_array_L (iface);
1468 n_dependants = dependants ? dependants[0] : 0;
1469 for (i = 1; i <= n_dependants; i++)
1470 type_iface_add_prerequisite_W (lookup_type_node_I (dependants[i]), prerequisite_node);
1474 * g_type_interface_add_prerequisite:
1475 * @interface_type: #GType value of an interface type.
1476 * @prerequisite_type: #GType value of an interface or instantiatable type.
1478 * Adds @prerequisite_type to the list of prerequisites of @interface_type.
1479 * This means that any type implementing @interface_type must also implement
1480 * @prerequisite_type. Prerequisites can be thought of as an alternative to
1481 * interface derivation (which GType doesn't support). An interface can have
1482 * at most one instantiatable prerequisite type.
1485 g_type_interface_add_prerequisite (GType interface_type,
1486 GType prerequisite_type)
1488 TypeNode *iface, *prerequisite_node;
1489 IFaceHolder *holders;
1491 g_return_if_fail (G_TYPE_IS_INTERFACE (interface_type)); /* G_TYPE_IS_INTERFACE() is an external call: _U */
1492 g_return_if_fail (!g_type_is_a (interface_type, prerequisite_type));
1493 g_return_if_fail (!g_type_is_a (prerequisite_type, interface_type));
1495 iface = lookup_type_node_I (interface_type);
1496 prerequisite_node = lookup_type_node_I (prerequisite_type);
1497 if (!iface || !prerequisite_node || !NODE_IS_IFACE (iface))
1499 g_warning ("interface type `%s' or prerequisite type `%s' invalid",
1500 type_descriptive_name_I (interface_type),
1501 type_descriptive_name_I (prerequisite_type));
1504 G_WRITE_LOCK (&type_rw_lock);
1505 holders = iface_node_get_holders_L (iface);
1508 G_WRITE_UNLOCK (&type_rw_lock);
1509 g_warning ("unable to add prerequisite `%s' to interface `%s' which is already in use for `%s'",
1510 type_descriptive_name_I (prerequisite_type),
1511 type_descriptive_name_I (interface_type),
1512 type_descriptive_name_I (holders->instance_type));
1515 if (prerequisite_node->is_instantiatable)
1519 /* can have at most one publically installable instantiatable prerequisite */
1520 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1522 TypeNode *prnode = lookup_type_node_I (IFACE_NODE_PREREQUISITES (iface)[i]);
1524 if (prnode->is_instantiatable)
1526 G_WRITE_UNLOCK (&type_rw_lock);
1527 g_warning ("adding prerequisite `%s' to interface `%s' conflicts with existing prerequisite `%s'",
1528 type_descriptive_name_I (prerequisite_type),
1529 type_descriptive_name_I (interface_type),
1530 type_descriptive_name_I (NODE_TYPE (prnode)));
1535 for (i = 0; i < prerequisite_node->n_supers + 1; i++)
1536 type_iface_add_prerequisite_W (iface, lookup_type_node_I (prerequisite_node->supers[i]));
1537 G_WRITE_UNLOCK (&type_rw_lock);
1539 else if (NODE_IS_IFACE (prerequisite_node))
1541 GType *prerequisites;
1544 prerequisites = IFACE_NODE_PREREQUISITES (prerequisite_node);
1545 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (prerequisite_node); i++)
1546 type_iface_add_prerequisite_W (iface, lookup_type_node_I (prerequisites[i]));
1547 type_iface_add_prerequisite_W (iface, prerequisite_node);
1548 G_WRITE_UNLOCK (&type_rw_lock);
1552 G_WRITE_UNLOCK (&type_rw_lock);
1553 g_warning ("prerequisite `%s' for interface `%s' is neither instantiatable nor interface",
1554 type_descriptive_name_I (prerequisite_type),
1555 type_descriptive_name_I (interface_type));
1560 * g_type_interface_prerequisites:
1561 * @interface_type: an interface type
1562 * @n_prerequisites: location to return the number of prerequisites, or %NULL
1564 * Returns the prerequisites of an interfaces type.
1568 * Returns: a newly-allocated zero-terminated array of #GType containing
1569 * the prerequisites of @interface_type
1572 g_type_interface_prerequisites (GType interface_type,
1573 guint *n_prerequisites)
1577 g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL);
1579 iface = lookup_type_node_I (interface_type);
1583 TypeNode *inode = NULL;
1586 G_READ_LOCK (&type_rw_lock);
1587 types = g_new0 (GType, IFACE_NODE_N_PREREQUISITES (iface) + 1);
1588 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1590 GType prerequisite = IFACE_NODE_PREREQUISITES (iface)[i];
1591 TypeNode *node = lookup_type_node_I (prerequisite);
1592 if (node->is_instantiatable &&
1593 (!inode || type_node_is_a_L (node, inode)))
1596 types[n++] = NODE_TYPE (node);
1599 types[n++] = NODE_TYPE (inode);
1601 if (n_prerequisites)
1602 *n_prerequisites = n;
1603 G_READ_UNLOCK (&type_rw_lock);
1609 if (n_prerequisites)
1610 *n_prerequisites = 0;
1618 type_iface_peek_holder_L (TypeNode *iface,
1619 GType instance_type)
1621 IFaceHolder *iholder;
1623 g_assert (NODE_IS_IFACE (iface));
1625 iholder = iface_node_get_holders_L (iface);
1626 while (iholder && iholder->instance_type != instance_type)
1627 iholder = iholder->next;
1632 type_iface_retrieve_holder_info_Wm (TypeNode *iface,
1633 GType instance_type,
1636 IFaceHolder *iholder = type_iface_peek_holder_L (iface, instance_type);
1638 if (iholder && !iholder->info && need_info)
1640 GInterfaceInfo tmp_info;
1642 g_assert (iholder->plugin != NULL);
1644 type_data_ref_Wm (iface);
1646 INVALID_RECURSION ("g_type_plugin_*", iface->plugin, NODE_NAME (iface));
1648 memset (&tmp_info, 0, sizeof (tmp_info));
1650 G_WRITE_UNLOCK (&type_rw_lock);
1651 g_type_plugin_use (iholder->plugin);
1652 g_type_plugin_complete_interface_info (iholder->plugin, instance_type, NODE_TYPE (iface), &tmp_info);
1653 G_WRITE_LOCK (&type_rw_lock);
1655 INVALID_RECURSION ("g_type_plugin_*", iholder->plugin, NODE_NAME (iface));
1657 check_interface_info_I (iface, instance_type, &tmp_info);
1658 iholder->info = g_memdup (&tmp_info, sizeof (tmp_info));
1661 return iholder; /* we don't modify write lock upon returning NULL */
1665 type_iface_blow_holder_info_Wm (TypeNode *iface,
1666 GType instance_type)
1668 IFaceHolder *iholder = iface_node_get_holders_L (iface);
1670 g_assert (NODE_IS_IFACE (iface));
1672 while (iholder->instance_type != instance_type)
1673 iholder = iholder->next;
1675 if (iholder->info && iholder->plugin)
1677 g_free (iholder->info);
1678 iholder->info = NULL;
1680 G_WRITE_UNLOCK (&type_rw_lock);
1681 g_type_plugin_unuse (iholder->plugin);
1682 G_WRITE_LOCK (&type_rw_lock);
1684 type_data_unref_WmREC (iface, FALSE);
1688 /* Assumes type's class already exists
1690 static inline size_t
1691 type_total_instance_size_I (TypeNode *node)
1693 gsize total_instance_size;
1695 total_instance_size = node->data->instance.instance_size;
1696 if (node->data->instance.private_size != 0)
1697 total_instance_size = ALIGN_STRUCT (total_instance_size) + node->data->instance.private_size;
1699 return total_instance_size;
1702 /* --- type structure creation/destruction --- */
1706 } InstanceRealClass;
1709 instance_real_class_cmp (gconstpointer p1,
1712 const InstanceRealClass *irc1 = p1;
1713 const InstanceRealClass *irc2 = p2;
1714 guint8 *i1 = irc1->instance;
1715 guint8 *i2 = irc2->instance;
1716 return G_BSEARCH_ARRAY_CMP (i1, i2);
1719 G_LOCK_DEFINE_STATIC (instance_real_class);
1720 static GBSearchArray *instance_real_class_bsa = NULL;
1721 static GBSearchConfig instance_real_class_bconfig = {
1722 sizeof (InstanceRealClass),
1723 instance_real_class_cmp,
1728 instance_real_class_set (gpointer instance,
1731 InstanceRealClass key;
1732 key.instance = instance;
1734 G_LOCK (instance_real_class);
1735 if (!instance_real_class_bsa)
1736 instance_real_class_bsa = g_bsearch_array_create (&instance_real_class_bconfig);
1737 instance_real_class_bsa = g_bsearch_array_replace (instance_real_class_bsa, &instance_real_class_bconfig, &key);
1738 G_UNLOCK (instance_real_class);
1742 instance_real_class_remove (gpointer instance)
1744 InstanceRealClass key, *node;
1746 key.instance = instance;
1747 G_LOCK (instance_real_class);
1748 node = g_bsearch_array_lookup (instance_real_class_bsa, &instance_real_class_bconfig, &key);
1749 index = g_bsearch_array_get_index (instance_real_class_bsa, &instance_real_class_bconfig, node);
1750 instance_real_class_bsa = g_bsearch_array_remove (instance_real_class_bsa, &instance_real_class_bconfig, index);
1751 if (!g_bsearch_array_get_n_nodes (instance_real_class_bsa))
1753 g_bsearch_array_free (instance_real_class_bsa, &instance_real_class_bconfig);
1754 instance_real_class_bsa = NULL;
1756 G_UNLOCK (instance_real_class);
1759 static inline GTypeClass*
1760 instance_real_class_get (gpointer instance)
1762 InstanceRealClass key, *node;
1764 key.instance = instance;
1765 G_LOCK (instance_real_class);
1766 node = instance_real_class_bsa ? g_bsearch_array_lookup (instance_real_class_bsa, &instance_real_class_bconfig, &key) : NULL;
1767 class = node ? node->class : NULL;
1768 G_UNLOCK (instance_real_class);
1773 * g_type_create_instance:
1774 * @type: An instantiatable type to create an instance for.
1776 * Creates and initializes an instance of @type if @type is valid and
1777 * can be instantiated. The type system only performs basic allocation
1778 * and structure setups for instances: actual instance creation should
1779 * happen through functions supplied by the type's fundamental type
1780 * implementation. So use of g_type_create_instance() is reserved for
1781 * implementators of fundamental types only. E.g. instances of the
1782 * #GObject hierarchy should be created via g_object_new() and
1783 * <emphasis>never</emphasis> directly through
1784 * g_type_create_instance() which doesn't handle things like singleton
1785 * objects or object construction. Note: Do <emphasis>not</emphasis>
1786 * use this function, unless you're implementing a fundamental
1787 * type. Also language bindings should <emphasis>not</emphasis> use
1788 * this function but g_object_new() instead.
1790 * Returns: An allocated and initialized instance, subject to further
1791 * treatment by the fundamental type implementation.
1794 g_type_create_instance (GType type)
1797 GTypeInstance *instance;
1799 guint i, total_size;
1801 node = lookup_type_node_I (type);
1802 if (!node || !node->is_instantiatable)
1804 g_warning ("cannot create new instance of invalid (non-instantiatable) type `%s'",
1805 type_descriptive_name_I (type));
1808 /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1809 if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (type))
1811 g_warning ("cannot create instance of abstract (non-instantiatable) type `%s'",
1812 type_descriptive_name_I (type));
1816 class = g_type_class_ref (type);
1817 total_size = type_total_instance_size_I (node);
1819 instance = g_slice_alloc0 (total_size);
1821 if (node->data->instance.private_size)
1822 instance_real_class_set (instance, class);
1823 for (i = node->n_supers; i > 0; i--)
1827 pnode = lookup_type_node_I (node->supers[i]);
1828 if (pnode->data->instance.instance_init)
1830 instance->g_class = pnode->data->instance.class;
1831 pnode->data->instance.instance_init (instance, class);
1834 if (node->data->instance.private_size)
1835 instance_real_class_remove (instance);
1837 instance->g_class = class;
1838 if (node->data->instance.instance_init)
1839 node->data->instance.instance_init (instance, class);
1845 * g_type_free_instance:
1846 * @instance: an instance of a type.
1848 * Frees an instance of a type, returning it to the instance pool for
1849 * the type, if there is one.
1851 * Like g_type_create_instance(), this function is reserved for
1852 * implementors of fundamental types.
1855 g_type_free_instance (GTypeInstance *instance)
1860 g_return_if_fail (instance != NULL && instance->g_class != NULL);
1862 class = instance->g_class;
1863 node = lookup_type_node_I (class->g_type);
1864 if (!node || !node->is_instantiatable || !node->data || node->data->class.class != (gpointer) class)
1866 g_warning ("cannot free instance of invalid (non-instantiatable) type `%s'",
1867 type_descriptive_name_I (class->g_type));
1870 /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1871 if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (NODE_TYPE (node)))
1873 g_warning ("cannot free instance of abstract (non-instantiatable) type `%s'",
1878 instance->g_class = NULL;
1879 #ifdef G_ENABLE_DEBUG
1880 memset (instance, 0xaa, type_total_instance_size_I (node));
1882 g_slice_free1 (type_total_instance_size_I (node), instance);
1884 g_type_class_unref (class);
1888 type_iface_ensure_dflt_vtable_Wm (TypeNode *iface)
1890 g_assert (iface->data);
1892 if (!iface->data->iface.dflt_vtable)
1894 GTypeInterface *vtable = g_malloc0 (iface->data->iface.vtable_size);
1895 iface->data->iface.dflt_vtable = vtable;
1896 vtable->g_type = NODE_TYPE (iface);
1897 vtable->g_instance_type = 0;
1898 if (iface->data->iface.vtable_init_base ||
1899 iface->data->iface.dflt_init)
1901 G_WRITE_UNLOCK (&type_rw_lock);
1902 if (iface->data->iface.vtable_init_base)
1903 iface->data->iface.vtable_init_base (vtable);
1904 if (iface->data->iface.dflt_init)
1905 iface->data->iface.dflt_init (vtable, (gpointer) iface->data->iface.dflt_data);
1906 G_WRITE_LOCK (&type_rw_lock);
1912 /* This is called to allocate and do the first part of initializing
1913 * the interface vtable; type_iface_vtable_iface_init_Wm() does the remainder.
1915 * A FALSE return indicates that we didn't find an init function for
1916 * this type/iface pair, so the vtable from the parent type should
1917 * be used. Note that the write lock is not modified upon a FALSE
1921 type_iface_vtable_base_init_Wm (TypeNode *iface,
1925 IFaceHolder *iholder;
1926 GTypeInterface *vtable = NULL;
1929 /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
1930 iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), TRUE);
1932 return FALSE; /* we don't modify write lock upon FALSE */
1934 type_iface_ensure_dflt_vtable_Wm (iface);
1936 entry = type_lookup_iface_entry_L (node, iface);
1938 g_assert (iface->data && entry && entry->vtable == NULL && iholder && iholder->info);
1940 entry->init_state = IFACE_INIT;
1942 pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1943 if (pnode) /* want to copy over parent iface contents */
1945 IFaceEntry *pentry = type_lookup_iface_entry_L (pnode, iface);
1948 vtable = g_memdup (pentry->vtable, iface->data->iface.vtable_size);
1951 vtable = g_memdup (iface->data->iface.dflt_vtable, iface->data->iface.vtable_size);
1952 entry->vtable = vtable;
1953 vtable->g_type = NODE_TYPE (iface);
1954 vtable->g_instance_type = NODE_TYPE (node);
1956 if (iface->data->iface.vtable_init_base)
1958 G_WRITE_UNLOCK (&type_rw_lock);
1959 iface->data->iface.vtable_init_base (vtable);
1960 G_WRITE_LOCK (&type_rw_lock);
1962 return TRUE; /* initialized the vtable */
1965 /* Finishes what type_iface_vtable_base_init_Wm started by
1966 * calling the interface init function.
1967 * this function may only be called for types with their
1968 * own interface holder info, i.e. types for which
1969 * g_type_add_interface*() was called and not children thereof.
1972 type_iface_vtable_iface_init_Wm (TypeNode *iface,
1975 IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
1976 IFaceHolder *iholder = type_iface_peek_holder_L (iface, NODE_TYPE (node));
1977 GTypeInterface *vtable = NULL;
1980 /* iholder->info should have been filled in by type_iface_vtable_base_init_Wm() */
1981 g_assert (iface->data && entry && iholder && iholder->info);
1982 g_assert (entry->init_state == IFACE_INIT); /* assert prior base_init() */
1984 entry->init_state = INITIALIZED;
1986 vtable = entry->vtable;
1988 if (iholder->info->interface_init)
1990 G_WRITE_UNLOCK (&type_rw_lock);
1991 if (iholder->info->interface_init)
1992 iholder->info->interface_init (vtable, iholder->info->interface_data);
1993 G_WRITE_LOCK (&type_rw_lock);
1996 for (i = 0; i < static_n_iface_check_funcs; i++)
1998 GTypeInterfaceCheckFunc check_func = static_iface_check_funcs[i].check_func;
1999 gpointer check_data = static_iface_check_funcs[i].check_data;
2001 G_WRITE_UNLOCK (&type_rw_lock);
2002 check_func (check_data, (gpointer)vtable);
2003 G_WRITE_LOCK (&type_rw_lock);
2008 type_iface_vtable_finalize_Wm (TypeNode *iface,
2010 GTypeInterface *vtable)
2012 IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2013 IFaceHolder *iholder;
2015 /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
2016 iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), FALSE);
2018 return FALSE; /* we don't modify write lock upon FALSE */
2020 g_assert (entry && entry->vtable == vtable && iholder->info);
2022 entry->vtable = NULL;
2023 entry->init_state = UNINITIALIZED;
2024 if (iholder->info->interface_finalize || iface->data->iface.vtable_finalize_base)
2026 G_WRITE_UNLOCK (&type_rw_lock);
2027 if (iholder->info->interface_finalize)
2028 iholder->info->interface_finalize (vtable, iholder->info->interface_data);
2029 if (iface->data->iface.vtable_finalize_base)
2030 iface->data->iface.vtable_finalize_base (vtable);
2031 G_WRITE_LOCK (&type_rw_lock);
2034 vtable->g_instance_type = 0;
2037 type_iface_blow_holder_info_Wm (iface, NODE_TYPE (node));
2039 return TRUE; /* write lock modified */
2043 type_class_init_Wm (TypeNode *node,
2046 GSList *slist, *init_slist = NULL;
2048 IFaceEntries *entries;
2050 TypeNode *bnode, *pnode;
2053 g_assert (node->is_classed && node->data &&
2054 node->data->class.class_size &&
2055 !node->data->class.class &&
2056 node->data->class.init_state == UNINITIALIZED);
2058 class = g_malloc0 (node->data->class.class_size);
2059 node->data->class.class = class;
2060 node->data->class.init_state = BASE_CLASS_INIT;
2064 TypeNode *pnode = lookup_type_node_I (pclass->g_type);
2066 memcpy (class, pclass, pnode->data->class.class_size);
2068 if (node->is_instantiatable)
2070 /* We need to initialize the private_size here rather than in
2071 * type_data_make_W() since the class init for the parent
2072 * class may have changed pnode->data->instance.private_size.
2074 node->data->instance.private_size = pnode->data->instance.private_size;
2077 class->g_type = NODE_TYPE (node);
2079 G_WRITE_UNLOCK (&type_rw_lock);
2081 /* stack all base class initialization functions, so we
2082 * call them in ascending order.
2084 for (bnode = node; bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2085 if (bnode->data->class.class_init_base)
2086 init_slist = g_slist_prepend (init_slist, (gpointer) bnode->data->class.class_init_base);
2087 for (slist = init_slist; slist; slist = slist->next)
2089 GBaseInitFunc class_init_base = (GBaseInitFunc) slist->data;
2091 class_init_base (class);
2093 g_slist_free (init_slist);
2095 G_WRITE_LOCK (&type_rw_lock);
2097 node->data->class.init_state = BASE_IFACE_INIT;
2099 /* Before we initialize the class, base initialize all interfaces, either
2100 * from parent, or through our holder info
2102 pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
2105 while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL &&
2106 i < IFACE_ENTRIES_N_ENTRIES (entries))
2108 entry = &entries->entry[i];
2109 while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2110 entry->init_state == IFACE_INIT)
2116 if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2119 if (!type_iface_vtable_base_init_Wm (lookup_type_node_I (entry->iface_type), node))
2122 IFaceEntries *pentries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (pnode);
2124 /* need to get this interface from parent, type_iface_vtable_base_init_Wm()
2125 * doesn't modify write lock upon FALSE, so entry is still valid;
2127 g_assert (pnode != NULL);
2130 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (pentries); j++)
2132 IFaceEntry *pentry = &pentries->entry[j];
2134 if (pentry->iface_type == entry->iface_type)
2136 entry->vtable = pentry->vtable;
2137 entry->init_state = INITIALIZED;
2141 g_assert (entry->vtable != NULL);
2144 /* If the write lock was released, additional interface entries might
2145 * have been inserted into CLASSED_NODE_IFACES_ENTRIES (node); they'll
2146 * be base-initialized when inserted, so we don't have to worry that
2147 * we might miss them. Uninitialized entries can only be moved higher
2148 * when new ones are inserted.
2153 node->data->class.init_state = CLASS_INIT;
2155 G_WRITE_UNLOCK (&type_rw_lock);
2157 if (node->data->class.class_init)
2158 node->data->class.class_init (class, (gpointer) node->data->class.class_data);
2160 G_WRITE_LOCK (&type_rw_lock);
2162 node->data->class.init_state = IFACE_INIT;
2164 /* finish initializing the interfaces through our holder info.
2165 * inherited interfaces are already init_state == INITIALIZED, because
2166 * they either got setup in the above base_init loop, or during
2167 * class_init from within type_add_interface_Wm() for this or
2168 * an anchestor type.
2171 while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL)
2173 entry = &entries->entry[i];
2174 while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2175 entry->init_state == INITIALIZED)
2181 if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2184 type_iface_vtable_iface_init_Wm (lookup_type_node_I (entry->iface_type), node);
2186 /* As in the loop above, additional initialized entries might be inserted
2187 * if the write lock is released, but that's harmless because the entries
2188 * we need to initialize only move higher in the list.
2193 node->data->class.init_state = INITIALIZED;
2197 type_data_finalize_class_ifaces_Wm (TypeNode *node)
2200 IFaceEntries *entries;
2202 g_assert (node->is_instantiatable && node->data && node->data->class.class && node->ref_count == 0);
2205 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
2206 for (i = 0; entries != NULL && i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
2208 IFaceEntry *entry = &entries->entry[i];
2211 if (type_iface_vtable_finalize_Wm (lookup_type_node_I (entry->iface_type), node, entry->vtable))
2213 /* refetch entries, IFACES_ENTRIES might be modified */
2218 /* type_iface_vtable_finalize_Wm() doesn't modify write lock upon FALSE,
2219 * iface vtable came from parent
2221 entry->vtable = NULL;
2222 entry->init_state = UNINITIALIZED;
2229 type_data_finalize_class_U (TypeNode *node,
2232 GTypeClass *class = cdata->class;
2235 g_assert (cdata->class && node->ref_count == 0);
2237 if (cdata->class_finalize)
2238 cdata->class_finalize (class, (gpointer) cdata->class_data);
2240 /* call all base class destruction functions in descending order
2242 if (cdata->class_finalize_base)
2243 cdata->class_finalize_base (class);
2244 for (bnode = lookup_type_node_I (NODE_PARENT_TYPE (node)); bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2245 if (bnode->data->class.class_finalize_base)
2246 bnode->data->class.class_finalize_base (class);
2248 g_free (cdata->class);
2252 type_data_last_unref_Wm (TypeNode *node,
2255 g_return_if_fail (node != NULL && node->plugin != NULL);
2257 if (!node->data || node->ref_count == 0)
2259 g_warning ("cannot drop last reference to unreferenced type `%s'",
2264 /* call class cache hooks */
2265 if (node->is_classed && node->data && node->data->class.class && static_n_class_cache_funcs && !uncached)
2269 G_WRITE_UNLOCK (&type_rw_lock);
2270 G_READ_LOCK (&type_rw_lock);
2271 for (i = 0; i < static_n_class_cache_funcs; i++)
2273 GTypeClassCacheFunc cache_func = static_class_cache_funcs[i].cache_func;
2274 gpointer cache_data = static_class_cache_funcs[i].cache_data;
2275 gboolean need_break;
2277 G_READ_UNLOCK (&type_rw_lock);
2278 need_break = cache_func (cache_data, node->data->class.class);
2279 G_READ_LOCK (&type_rw_lock);
2280 if (!node->data || node->ref_count == 0)
2281 INVALID_RECURSION ("GType class cache function ", cache_func, NODE_NAME (node));
2285 G_READ_UNLOCK (&type_rw_lock);
2286 G_WRITE_LOCK (&type_rw_lock);
2289 if (node->ref_count > 1) /* may have been re-referenced meanwhile */
2290 node->ref_count -= 1;
2293 GType ptype = NODE_PARENT_TYPE (node);
2296 node->ref_count = 0;
2298 if (node->is_instantiatable)
2300 /* destroy node->data->instance.mem_chunk */
2304 if (node->is_classed && tdata->class.class)
2306 if (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node) != NULL)
2307 type_data_finalize_class_ifaces_Wm (node);
2308 node->mutatable_check_cache = FALSE;
2310 G_WRITE_UNLOCK (&type_rw_lock);
2311 type_data_finalize_class_U (node, &tdata->class);
2312 G_WRITE_LOCK (&type_rw_lock);
2314 else if (NODE_IS_IFACE (node) && tdata->iface.dflt_vtable)
2316 node->mutatable_check_cache = FALSE;
2318 if (tdata->iface.dflt_finalize || tdata->iface.vtable_finalize_base)
2320 G_WRITE_UNLOCK (&type_rw_lock);
2321 if (tdata->iface.dflt_finalize)
2322 tdata->iface.dflt_finalize (tdata->iface.dflt_vtable, (gpointer) tdata->iface.dflt_data);
2323 if (tdata->iface.vtable_finalize_base)
2324 tdata->iface.vtable_finalize_base (tdata->iface.dflt_vtable);
2325 G_WRITE_LOCK (&type_rw_lock);
2327 g_free (tdata->iface.dflt_vtable);
2331 node->mutatable_check_cache = FALSE;
2335 /* freeing tdata->common.value_table and its contents is taken care of
2336 * by allocating it in one chunk with tdata
2340 G_WRITE_UNLOCK (&type_rw_lock);
2341 g_type_plugin_unuse (node->plugin);
2342 G_WRITE_LOCK (&type_rw_lock);
2344 type_data_unref_WmREC (lookup_type_node_I (ptype), FALSE);
2349 type_data_unref_WmREC (TypeNode *node,
2352 g_assert (node->data && node->ref_count);
2353 if (node->ref_count > 1)
2354 node->ref_count -= 1;
2359 g_warning ("static type `%s' unreferenced too often",
2363 G_WRITE_UNLOCK (&type_rw_lock);
2364 g_static_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2365 G_WRITE_LOCK (&type_rw_lock);
2366 type_data_last_unref_Wm (node, uncached);
2367 g_static_rec_mutex_unlock (&class_init_rec_mutex);
2372 * g_type_add_class_cache_func:
2373 * @cache_data: data to be passed to @cache_func
2374 * @cache_func: a #GTypeClassCacheFunc
2376 * Adds a #GTypeClassCacheFunc to be called before the reference count of a
2377 * class goes from one to zero. This can be used to prevent premature class
2378 * destruction. All installed #GTypeClassCacheFunc functions will be chained
2379 * until one of them returns %TRUE. The functions have to check the class id
2380 * passed in to figure whether they actually want to cache the class of this
2381 * type, since all classes are routed through the same #GTypeClassCacheFunc
2385 g_type_add_class_cache_func (gpointer cache_data,
2386 GTypeClassCacheFunc cache_func)
2390 g_return_if_fail (cache_func != NULL);
2392 G_WRITE_LOCK (&type_rw_lock);
2393 i = static_n_class_cache_funcs++;
2394 static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2395 static_class_cache_funcs[i].cache_data = cache_data;
2396 static_class_cache_funcs[i].cache_func = cache_func;
2397 G_WRITE_UNLOCK (&type_rw_lock);
2401 * g_type_remove_class_cache_func:
2402 * @cache_data: data that was given when adding @cache_func
2403 * @cache_func: a #GTypeClassCacheFunc
2405 * Removes a previously installed #GTypeClassCacheFunc. The cache
2406 * maintained by @cache_func has to be empty when calling
2407 * g_type_remove_class_cache_func() to avoid leaks.
2410 g_type_remove_class_cache_func (gpointer cache_data,
2411 GTypeClassCacheFunc cache_func)
2413 gboolean found_it = FALSE;
2416 g_return_if_fail (cache_func != NULL);
2418 G_WRITE_LOCK (&type_rw_lock);
2419 for (i = 0; i < static_n_class_cache_funcs; i++)
2420 if (static_class_cache_funcs[i].cache_data == cache_data &&
2421 static_class_cache_funcs[i].cache_func == cache_func)
2423 static_n_class_cache_funcs--;
2424 g_memmove (static_class_cache_funcs + i,
2425 static_class_cache_funcs + i + 1,
2426 sizeof (static_class_cache_funcs[0]) * (static_n_class_cache_funcs - i));
2427 static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2431 G_WRITE_UNLOCK (&type_rw_lock);
2434 g_warning (G_STRLOC ": cannot remove unregistered class cache func %p with data %p",
2435 cache_func, cache_data);
2440 * g_type_add_interface_check:
2441 * @check_data: data to pass to @check_func
2442 * @check_func: function to be called after each interface
2445 * Adds a function to be called after an interface vtable is
2446 * initialized for any class (i.e. after the @interface_init member of
2447 * #GInterfaceInfo has been called).
2449 * This function is useful when you want to check an invariant that
2450 * depends on the interfaces of a class. For instance, the
2451 * implementation of #GObject uses this facility to check that an
2452 * object implements all of the properties that are defined on its
2458 g_type_add_interface_check (gpointer check_data,
2459 GTypeInterfaceCheckFunc check_func)
2463 g_return_if_fail (check_func != NULL);
2465 G_WRITE_LOCK (&type_rw_lock);
2466 i = static_n_iface_check_funcs++;
2467 static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2468 static_iface_check_funcs[i].check_data = check_data;
2469 static_iface_check_funcs[i].check_func = check_func;
2470 G_WRITE_UNLOCK (&type_rw_lock);
2474 * g_type_remove_interface_check:
2475 * @check_data: callback data passed to g_type_add_interface_check()
2476 * @check_func: callback function passed to g_type_add_interface_check()
2478 * Removes an interface check function added with
2479 * g_type_add_interface_check().
2484 g_type_remove_interface_check (gpointer check_data,
2485 GTypeInterfaceCheckFunc check_func)
2487 gboolean found_it = FALSE;
2490 g_return_if_fail (check_func != NULL);
2492 G_WRITE_LOCK (&type_rw_lock);
2493 for (i = 0; i < static_n_iface_check_funcs; i++)
2494 if (static_iface_check_funcs[i].check_data == check_data &&
2495 static_iface_check_funcs[i].check_func == check_func)
2497 static_n_iface_check_funcs--;
2498 g_memmove (static_iface_check_funcs + i,
2499 static_iface_check_funcs + i + 1,
2500 sizeof (static_iface_check_funcs[0]) * (static_n_iface_check_funcs - i));
2501 static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2505 G_WRITE_UNLOCK (&type_rw_lock);
2508 g_warning (G_STRLOC ": cannot remove unregistered class check func %p with data %p",
2509 check_func, check_data);
2512 /* --- type registration --- */
2514 * g_type_register_fundamental:
2515 * @type_id: A predefined type identifier.
2516 * @type_name: 0-terminated string used as the name of the new type.
2517 * @info: The #GTypeInfo structure for this type.
2518 * @finfo: The #GTypeFundamentalInfo structure for this type.
2519 * @flags: Bitwise combination of #GTypeFlags values.
2521 * Registers @type_id as the predefined identifier and @type_name as the
2522 * name of a fundamental type. The type system uses the information
2523 * contained in the #GTypeInfo structure pointed to by @info and the
2524 * #GTypeFundamentalInfo structure pointed to by @finfo to manage the
2525 * type and its instances. The value of @flags determines additional
2526 * characteristics of the fundamental type.
2528 * Returns: The predefined type identifier.
2531 g_type_register_fundamental (GType type_id,
2532 const gchar *type_name,
2533 const GTypeInfo *info,
2534 const GTypeFundamentalInfo *finfo,
2539 g_return_val_if_uninitialized (static_quark_type_flags, g_type_init, 0);
2540 g_return_val_if_fail (type_id > 0, 0);
2541 g_return_val_if_fail (type_name != NULL, 0);
2542 g_return_val_if_fail (info != NULL, 0);
2543 g_return_val_if_fail (finfo != NULL, 0);
2545 if (!check_type_name_I (type_name))
2547 if ((type_id & TYPE_ID_MASK) ||
2548 type_id > G_TYPE_FUNDAMENTAL_MAX)
2550 g_warning ("attempt to register fundamental type `%s' with invalid type id (%" G_GSIZE_FORMAT ")",
2555 if ((finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
2556 !(finfo->type_flags & G_TYPE_FLAG_CLASSED))
2558 g_warning ("cannot register instantiatable fundamental type `%s' as non-classed",
2562 if (lookup_type_node_I (type_id))
2564 g_warning ("cannot register existing fundamental type `%s' (as `%s')",
2565 type_descriptive_name_I (type_id),
2570 G_WRITE_LOCK (&type_rw_lock);
2571 node = type_node_fundamental_new_W (type_id, type_name, finfo->type_flags);
2572 type_add_flags_W (node, flags);
2574 if (check_type_info_I (NULL, NODE_FUNDAMENTAL_TYPE (node), type_name, info))
2575 type_data_make_W (node, info,
2576 check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2577 G_WRITE_UNLOCK (&type_rw_lock);
2579 return NODE_TYPE (node);
2583 * g_type_register_static_simple:
2584 * @parent_type: Type from which this type will be derived.
2585 * @type_name: 0-terminated string used as the name of the new type.
2586 * @class_size: Size of the class structure (see #GTypeInfo)
2587 * @class_init: Location of the class initialization function (see #GTypeInfo)
2588 * @instance_size: Size of the instance structure (see #GTypeInfo)
2589 * @instance_init: Location of the instance initialization function (see #GTypeInfo)
2590 * @flags: Bitwise combination of #GTypeFlags values.
2592 * Registers @type_name as the name of a new static type derived from
2593 * @parent_type. The value of @flags determines the nature (e.g.
2594 * abstract or not) of the type. It works by filling a #GTypeInfo
2595 * struct and calling g_type_register_static().
2599 * Returns: The new type identifier.
2602 g_type_register_static_simple (GType parent_type,
2603 const gchar *type_name,
2605 GClassInitFunc class_init,
2606 guint instance_size,
2607 GInstanceInitFunc instance_init,
2612 info.class_size = class_size;
2613 info.base_init = NULL;
2614 info.base_finalize = NULL;
2615 info.class_init = class_init;
2616 info.class_finalize = NULL;
2617 info.class_data = NULL;
2618 info.instance_size = instance_size;
2619 info.n_preallocs = 0;
2620 info.instance_init = instance_init;
2621 info.value_table = NULL;
2623 return g_type_register_static (parent_type, type_name, &info, flags);
2627 * g_type_register_static:
2628 * @parent_type: Type from which this type will be derived.
2629 * @type_name: 0-terminated string used as the name of the new type.
2630 * @info: The #GTypeInfo structure for this type.
2631 * @flags: Bitwise combination of #GTypeFlags values.
2633 * Registers @type_name as the name of a new static type derived from
2634 * @parent_type. The type system uses the information contained in the
2635 * #GTypeInfo structure pointed to by @info to manage the type and its
2636 * instances (if not abstract). The value of @flags determines the nature
2637 * (e.g. abstract or not) of the type.
2639 * Returns: The new type identifier.
2642 g_type_register_static (GType parent_type,
2643 const gchar *type_name,
2644 const GTypeInfo *info,
2647 TypeNode *pnode, *node;
2650 g_return_val_if_uninitialized (static_quark_type_flags, g_type_init, 0);
2651 g_return_val_if_fail (parent_type > 0, 0);
2652 g_return_val_if_fail (type_name != NULL, 0);
2653 g_return_val_if_fail (info != NULL, 0);
2655 if (!check_type_name_I (type_name) ||
2656 !check_derivation_I (parent_type, type_name))
2658 if (info->class_finalize)
2660 g_warning ("class finalizer specified for static type `%s'",
2665 pnode = lookup_type_node_I (parent_type);
2666 G_WRITE_LOCK (&type_rw_lock);
2667 type_data_ref_Wm (pnode);
2668 if (check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (pnode), type_name, info))
2670 node = type_node_new_W (pnode, type_name, NULL);
2671 type_add_flags_W (node, flags);
2672 type = NODE_TYPE (node);
2673 type_data_make_W (node, info,
2674 check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2676 G_WRITE_UNLOCK (&type_rw_lock);
2682 * g_type_register_dynamic:
2683 * @parent_type: Type from which this type will be derived.
2684 * @type_name: 0-terminated string used as the name of the new type.
2685 * @plugin: The #GTypePlugin structure to retrieve the #GTypeInfo from.
2686 * @flags: Bitwise combination of #GTypeFlags values.
2688 * Registers @type_name as the name of a new dynamic type derived from
2689 * @parent_type. The type system uses the information contained in the
2690 * #GTypePlugin structure pointed to by @plugin to manage the type and its
2691 * instances (if not abstract). The value of @flags determines the nature
2692 * (e.g. abstract or not) of the type.
2694 * Returns: The new type identifier or #G_TYPE_INVALID if registration failed.
2697 g_type_register_dynamic (GType parent_type,
2698 const gchar *type_name,
2699 GTypePlugin *plugin,
2702 TypeNode *pnode, *node;
2705 g_return_val_if_uninitialized (static_quark_type_flags, g_type_init, 0);
2706 g_return_val_if_fail (parent_type > 0, 0);
2707 g_return_val_if_fail (type_name != NULL, 0);
2708 g_return_val_if_fail (plugin != NULL, 0);
2710 if (!check_type_name_I (type_name) ||
2711 !check_derivation_I (parent_type, type_name) ||
2712 !check_plugin_U (plugin, TRUE, FALSE, type_name))
2715 G_WRITE_LOCK (&type_rw_lock);
2716 pnode = lookup_type_node_I (parent_type);
2717 node = type_node_new_W (pnode, type_name, plugin);
2718 type_add_flags_W (node, flags);
2719 type = NODE_TYPE (node);
2720 G_WRITE_UNLOCK (&type_rw_lock);
2726 * g_type_add_interface_static:
2727 * @instance_type: #GType value of an instantiable type.
2728 * @interface_type: #GType value of an interface type.
2729 * @info: The #GInterfaceInfo structure for this
2730 * (@instance_type, @interface_type) combination.
2732 * Adds the static @interface_type to @instantiable_type. The information
2733 * contained in the #GTypeInterfaceInfo structure pointed to by @info
2734 * is used to manage the relationship.
2737 g_type_add_interface_static (GType instance_type,
2738 GType interface_type,
2739 const GInterfaceInfo *info)
2741 /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2742 g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2743 g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2745 /* we only need to lock class_init_rec_mutex if instance_type already has its
2746 * class initialized, however this function is rarely enough called to take
2747 * the simple route and always acquire class_init_rec_mutex.
2749 g_static_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2750 G_WRITE_LOCK (&type_rw_lock);
2751 if (check_add_interface_L (instance_type, interface_type))
2753 TypeNode *node = lookup_type_node_I (instance_type);
2754 TypeNode *iface = lookup_type_node_I (interface_type);
2755 if (check_interface_info_I (iface, NODE_TYPE (node), info))
2756 type_add_interface_Wm (node, iface, info, NULL);
2758 G_WRITE_UNLOCK (&type_rw_lock);
2759 g_static_rec_mutex_unlock (&class_init_rec_mutex);
2763 * g_type_add_interface_dynamic:
2764 * @instance_type: the #GType value of an instantiable type.
2765 * @interface_type: the #GType value of an interface type.
2766 * @plugin: the #GTypePlugin structure to retrieve the #GInterfaceInfo from.
2768 * Adds the dynamic @interface_type to @instantiable_type. The information
2769 * contained in the #GTypePlugin structure pointed to by @plugin
2770 * is used to manage the relationship.
2773 g_type_add_interface_dynamic (GType instance_type,
2774 GType interface_type,
2775 GTypePlugin *plugin)
2778 /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2779 g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2780 g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2782 node = lookup_type_node_I (instance_type);
2783 if (!check_plugin_U (plugin, FALSE, TRUE, NODE_NAME (node)))
2786 /* see comment in g_type_add_interface_static() about class_init_rec_mutex */
2787 g_static_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2788 G_WRITE_LOCK (&type_rw_lock);
2789 if (check_add_interface_L (instance_type, interface_type))
2791 TypeNode *iface = lookup_type_node_I (interface_type);
2792 type_add_interface_Wm (node, iface, NULL, plugin);
2794 G_WRITE_UNLOCK (&type_rw_lock);
2795 g_static_rec_mutex_unlock (&class_init_rec_mutex);
2799 /* --- public API functions --- */
2802 * @type: Type ID of a classed type.
2804 * Increments the reference count of the class structure belonging to
2805 * @type. This function will demand-create the class if it doesn't
2808 * Returns: The #GTypeClass structure for the given type ID.
2811 g_type_class_ref (GType type)
2816 /* optimize for common code path */
2817 G_WRITE_LOCK (&type_rw_lock);
2818 node = lookup_type_node_I (type);
2819 if (node && node->is_classed && node->data &&
2820 node->data->class.class &&
2821 node->data->class.init_state == INITIALIZED)
2823 type_data_ref_Wm (node);
2824 G_WRITE_UNLOCK (&type_rw_lock);
2825 return node->data->class.class;
2827 if (!node || !node->is_classed ||
2828 (node->data && node->ref_count < 1))
2830 G_WRITE_UNLOCK (&type_rw_lock);
2831 g_warning ("cannot retrieve class for invalid (unclassed) type `%s'",
2832 type_descriptive_name_I (type));
2835 type_data_ref_Wm (node);
2836 ptype = NODE_PARENT_TYPE (node);
2837 G_WRITE_UNLOCK (&type_rw_lock);
2839 g_static_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2840 /* here, we either have node->data->class.class == NULL, or a recursive
2841 * call to g_type_class_ref() with a partly initialized class, or
2842 * node->data->class.init_state == INITIALIZED, because any
2843 * concurrently running initialization was guarded by class_init_rec_mutex.
2845 if (!node->data->class.class) /* class uninitialized */
2847 /* we need an initialized parent class for initializing derived classes */
2848 GTypeClass *pclass = ptype ? g_type_class_ref (ptype) : NULL;
2849 G_WRITE_LOCK (&type_rw_lock);
2850 if (node->data->class.class) /* class was initialized during parent class initialization? */
2851 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
2852 type_class_init_Wm (node, pclass);
2853 G_WRITE_UNLOCK (&type_rw_lock);
2855 g_type_class_unref (pclass);
2857 g_static_rec_mutex_unlock (&class_init_rec_mutex);
2859 return node->data->class.class;
2863 * g_type_class_unref:
2864 * @g_class: The #GTypeClass structure to unreference.
2866 * Decrements the reference count of the class structure being passed in.
2867 * Once the last reference count of a class has been released, classes
2868 * may be finalized by the type system, so further dereferencing of a
2869 * class pointer after g_type_class_unref() are invalid.
2872 g_type_class_unref (gpointer g_class)
2875 GTypeClass *class = g_class;
2877 g_return_if_fail (g_class != NULL);
2879 node = lookup_type_node_I (class->g_type);
2880 G_WRITE_LOCK (&type_rw_lock);
2881 if (node && node->is_classed && node->data &&
2882 node->data->class.class == class && node->ref_count > 0)
2883 type_data_unref_WmREC (node, FALSE);
2885 g_warning ("cannot unreference class of invalid (unclassed) type `%s'",
2886 type_descriptive_name_I (class->g_type));
2887 G_WRITE_UNLOCK (&type_rw_lock);
2891 * g_type_class_unref_uncached:
2892 * @g_class: The #GTypeClass structure to unreference.
2894 * A variant of g_type_class_unref() for use in #GTypeClassCacheFunc
2895 * implementations. It unreferences a class without consulting the chain
2896 * of #GTypeClassCacheFunc<!-- -->s, avoiding the recursion which would occur
2900 g_type_class_unref_uncached (gpointer g_class)
2903 GTypeClass *class = g_class;
2905 g_return_if_fail (g_class != NULL);
2907 G_WRITE_LOCK (&type_rw_lock);
2908 node = lookup_type_node_I (class->g_type);
2909 if (node && node->is_classed && node->data &&
2910 node->data->class.class == class && node->ref_count > 0)
2911 type_data_unref_WmREC (node, TRUE);
2913 g_warning ("cannot unreference class of invalid (unclassed) type `%s'",
2914 type_descriptive_name_I (class->g_type));
2915 G_WRITE_UNLOCK (&type_rw_lock);
2919 * g_type_class_peek:
2920 * @type: Type ID of a classed type.
2922 * This function is essentially the same as g_type_class_ref(), except that
2923 * the classes reference count isn't incremented. As a consequence, this function
2924 * may return %NULL if the class of the type passed in does not currently
2925 * exist (hasn't been referenced before).
2927 * Returns: The #GTypeClass structure for the given type ID or %NULL
2928 * if the class does not currently exist.
2931 g_type_class_peek (GType type)
2936 node = lookup_type_node_I (type);
2937 G_READ_LOCK (&type_rw_lock);
2938 if (node && node->is_classed && node->data && node->data->class.class) /* ref_count _may_ be 0 */
2939 class = node->data->class.class;
2942 G_READ_UNLOCK (&type_rw_lock);
2948 * g_type_class_peek_static:
2949 * @type: Type ID of a classed type.
2951 * A more efficient version of g_type_class_peek() which works only for
2955 * Returns: The #GTypeClass structure for the given type ID or %NULL
2956 * if the class does not currently exist or is dynamically loaded.
2959 g_type_class_peek_static (GType type)
2964 node = lookup_type_node_I (type);
2965 G_READ_LOCK (&type_rw_lock);
2966 if (node && node->is_classed && node->data &&
2967 /* peek only static types: */ node->plugin == NULL &&
2968 node->data->class.class) /* ref_count _may_ be 0 */
2969 class = node->data->class.class;
2972 G_READ_UNLOCK (&type_rw_lock);
2978 * g_type_class_peek_parent:
2979 * @g_class: The #GTypeClass structure to retrieve the parent class for.
2981 * This is a convenience function often needed in class initializers.
2982 * It returns the class structure of the immediate parent type of the
2983 * class passed in. Since derived classes hold a reference count on
2984 * their parent classes as long as they are instantiated, the returned
2985 * class will always exist. This function is essentially equivalent
2989 * g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)));
2992 * Returns: The parent class of @g_class.
2995 g_type_class_peek_parent (gpointer g_class)
2998 gpointer class = NULL;
3000 g_return_val_if_fail (g_class != NULL, NULL);
3002 node = lookup_type_node_I (G_TYPE_FROM_CLASS (g_class));
3003 /* We used to acquire a read lock here. That is not necessary, since
3004 * parent->data->class.class is constant as long as the derived class
3007 if (node && node->is_classed && node->data && NODE_PARENT_TYPE (node))
3009 node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3010 class = node->data->class.class;
3012 else if (NODE_PARENT_TYPE (node))
3013 g_warning (G_STRLOC ": invalid class pointer `%p'", g_class);
3019 * g_type_interface_peek:
3020 * @instance_class: A #GTypeClass structure.
3021 * @iface_type: An interface ID which this class conforms to.
3023 * Returns the #GTypeInterface structure of an interface to which the
3024 * passed in class conforms.
3026 * Returns: The GTypeInterface structure of iface_type if implemented
3027 * by @instance_class, %NULL otherwise
3030 g_type_interface_peek (gpointer instance_class,
3035 gpointer vtable = NULL;
3036 GTypeClass *class = instance_class;
3038 g_return_val_if_fail (instance_class != NULL, NULL);
3040 node = lookup_type_node_I (class->g_type);
3041 iface = lookup_type_node_I (iface_type);
3042 if (node && node->is_instantiatable && iface)
3043 type_lookup_iface_vtable_I (node, iface, &vtable);
3045 g_warning (G_STRLOC ": invalid class pointer `%p'", class);
3051 * g_type_interface_peek_parent:
3052 * @g_iface: A #GTypeInterface structure.
3054 * Returns the corresponding #GTypeInterface structure of the parent type
3055 * of the instance type to which @g_iface belongs. This is useful when
3056 * deriving the implementation of an interface from the parent type and
3057 * then possibly overriding some methods.
3059 * Returns: The corresponding #GTypeInterface structure of the parent
3060 * type of the instance type to which @g_iface belongs, or
3061 * %NULL if the parent type doesn't conform to the interface.
3064 g_type_interface_peek_parent (gpointer g_iface)
3068 gpointer vtable = NULL;
3069 GTypeInterface *iface_class = g_iface;
3071 g_return_val_if_fail (g_iface != NULL, NULL);
3073 iface = lookup_type_node_I (iface_class->g_type);
3074 node = lookup_type_node_I (iface_class->g_instance_type);
3076 node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3077 if (node && node->is_instantiatable && iface)
3078 type_lookup_iface_vtable_I (node, iface, &vtable);
3080 g_warning (G_STRLOC ": invalid interface pointer `%p'", g_iface);
3086 * g_type_default_interface_ref:
3087 * @g_type: an interface type
3089 * Increments the reference count for the interface type @g_type,
3090 * and returns the default interface vtable for the type.
3092 * If the type is not currently in use, then the default vtable
3093 * for the type will be created and initalized by calling
3094 * the base interface init and default vtable init functions for
3095 * the type (the @<structfield>base_init</structfield>
3096 * and <structfield>class_init</structfield> members of #GTypeInfo).
3097 * Calling g_type_default_interface_ref() is useful when you
3098 * want to make sure that signals and properties for an interface
3099 * have been installed.
3103 * Returns: the default vtable for the interface; call
3104 * g_type_default_interface_unref() when you are done using
3108 g_type_default_interface_ref (GType g_type)
3111 gpointer dflt_vtable;
3113 G_WRITE_LOCK (&type_rw_lock);
3115 node = lookup_type_node_I (g_type);
3116 if (!node || !NODE_IS_IFACE (node) ||
3117 (node->data && node->ref_count < 1))
3119 G_WRITE_UNLOCK (&type_rw_lock);
3120 g_warning ("cannot retrieve default vtable for invalid or non-interface type '%s'",
3121 type_descriptive_name_I (g_type));
3125 if (!node->data || !node->data->iface.dflt_vtable)
3127 G_WRITE_UNLOCK (&type_rw_lock);
3128 g_static_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
3129 G_WRITE_LOCK (&type_rw_lock);
3130 node = lookup_type_node_I (g_type);
3131 type_data_ref_Wm (node);
3132 type_iface_ensure_dflt_vtable_Wm (node);
3133 g_static_rec_mutex_unlock (&class_init_rec_mutex);
3136 type_data_ref_Wm (node); /* ref_count >= 1 already */
3138 dflt_vtable = node->data->iface.dflt_vtable;
3139 G_WRITE_UNLOCK (&type_rw_lock);
3145 * g_type_default_interface_peek:
3146 * @g_type: an interface type
3148 * If the interface type @g_type is currently in use, returns its
3149 * default interface vtable.
3153 * Returns: the default vtable for the interface, or %NULL
3154 * if the type is not currently in use.
3157 g_type_default_interface_peek (GType g_type)
3162 node = lookup_type_node_I (g_type);
3163 G_READ_LOCK (&type_rw_lock);
3164 if (node && NODE_IS_IFACE (node) && node->data && node->data->iface.dflt_vtable)
3165 vtable = node->data->iface.dflt_vtable;
3168 G_READ_UNLOCK (&type_rw_lock);
3174 * g_type_default_interface_unref:
3175 * @g_iface: the default vtable structure for a interface, as
3176 * returned by g_type_default_interface_ref()
3178 * Decrements the reference count for the type corresponding to the
3179 * interface default vtable @g_iface. If the type is dynamic, then
3180 * when no one is using the interface and all references have
3181 * been released, the finalize function for the interface's default
3182 * vtable (the <structfield>class_finalize</structfield> member of
3183 * #GTypeInfo) will be called.
3188 g_type_default_interface_unref (gpointer g_iface)
3191 GTypeInterface *vtable = g_iface;
3193 g_return_if_fail (g_iface != NULL);
3195 node = lookup_type_node_I (vtable->g_type);
3196 G_WRITE_LOCK (&type_rw_lock);
3197 if (node && NODE_IS_IFACE (node) &&
3198 node->data->iface.dflt_vtable == g_iface &&
3199 node->ref_count > 0)
3200 type_data_unref_WmREC (node, FALSE);
3202 g_warning ("cannot unreference invalid interface default vtable for '%s'",
3203 type_descriptive_name_I (vtable->g_type));
3204 G_WRITE_UNLOCK (&type_rw_lock);
3209 * @type: Type to return name for.
3211 * Get the unique name that is assigned to a type ID. Note that this
3212 * function (like all other GType API) cannot cope with invalid type
3213 * IDs. %G_TYPE_INVALID may be passed to this function, as may be any
3214 * other validly registered type ID, but randomized type IDs should
3215 * not be passed in and will most likely lead to a crash.
3217 * Returns: Static type name or %NULL.
3219 G_CONST_RETURN gchar*
3220 g_type_name (GType type)
3224 g_return_val_if_uninitialized (static_quark_type_flags, g_type_init, NULL);
3226 node = lookup_type_node_I (type);
3228 return node ? NODE_NAME (node) : NULL;
3233 * @type: Type to return quark of type name for.
3235 * Get the corresponding quark of the type IDs name.
3237 * Returns: The type names quark or 0.
3240 g_type_qname (GType type)
3244 node = lookup_type_node_I (type);
3246 return node ? node->qname : 0;
3251 * @name: Type name to lookup.
3253 * Lookup the type ID from a given type name, returning 0 if no type
3254 * has been registered under this name (this is the preferred method
3255 * to find out by name whether a specific type has been registered
3258 * Returns: Corresponding type ID or 0.
3261 g_type_from_name (const gchar *name)
3266 g_return_val_if_fail (name != NULL, 0);
3268 quark = g_quark_try_string (name);
3271 G_READ_LOCK (&type_rw_lock);
3272 type = (GType) g_hash_table_lookup (static_type_nodes_ht, GUINT_TO_POINTER (quark));
3273 G_READ_UNLOCK (&type_rw_lock);
3281 * @type: The derived type.
3283 * Return the direct parent type of the passed in type. If the passed
3284 * in type has no parent, i.e. is a fundamental type, 0 is returned.
3286 * Returns: The parent type.
3289 g_type_parent (GType type)
3293 node = lookup_type_node_I (type);
3295 return node ? NODE_PARENT_TYPE (node) : 0;
3300 * @type: A #GType value.
3302 * Returns the length of the ancestry of the passed in type. This
3303 * includes the type itself, so that e.g. a fundamental type has depth 1.
3305 * Returns: The depth of @type.
3308 g_type_depth (GType type)
3312 node = lookup_type_node_I (type);
3314 return node ? node->n_supers + 1 : 0;
3319 * @leaf_type: Descendant of @root_type and the type to be returned.
3320 * @root_type: Immediate parent of the returned type.
3322 * Given a @leaf_type and a @root_type which is contained in its
3323 * anchestry, return the type that @root_type is the immediate parent
3324 * of. In other words, this function determines the type that is
3325 * derived directly from @root_type which is also a base class of
3326 * @leaf_type. Given a root type and a leaf type, this function can
3327 * be used to determine the types and order in which the leaf type is
3328 * descended from the root type.
3330 * Returns: Immediate child of @root_type and anchestor of @leaf_type.
3333 g_type_next_base (GType type,
3339 node = lookup_type_node_I (type);
3342 TypeNode *base_node = lookup_type_node_I (base_type);
3344 if (base_node && base_node->n_supers < node->n_supers)
3346 guint n = node->n_supers - base_node->n_supers;
3348 if (node->supers[n] == base_type)
3349 atype = node->supers[n - 1];
3356 static inline gboolean
3357 type_node_check_conformities_UorL (TypeNode *node,
3358 TypeNode *iface_node,
3359 /* support_inheritance */
3360 gboolean support_interfaces,
3361 gboolean support_prerequisites,
3366 if (/* support_inheritance && */
3367 NODE_IS_ANCESTOR (iface_node, node))
3370 support_interfaces = support_interfaces && node->is_instantiatable && NODE_IS_IFACE (iface_node);
3371 support_prerequisites = support_prerequisites && NODE_IS_IFACE (node);
3373 if (support_interfaces)
3377 if (type_lookup_iface_entry_L (node, iface_node))
3382 if (type_lookup_iface_vtable_I (node, iface_node, NULL))
3387 support_prerequisites)
3390 G_READ_LOCK (&type_rw_lock);
3391 if (support_prerequisites && type_lookup_prerequisite_L (node, NODE_TYPE (iface_node)))
3394 G_READ_UNLOCK (&type_rw_lock);
3400 type_node_is_a_L (TypeNode *node,
3401 TypeNode *iface_node)
3403 return type_node_check_conformities_UorL (node, iface_node, TRUE, TRUE, TRUE);
3406 static inline gboolean
3407 type_node_conforms_to_U (TypeNode *node,
3408 TypeNode *iface_node,
3409 gboolean support_interfaces,
3410 gboolean support_prerequisites)
3412 return type_node_check_conformities_UorL (node, iface_node, support_interfaces, support_prerequisites, FALSE);
3417 * @type: Type to check anchestry for.
3418 * @is_a_type: Possible anchestor of @type or interface @type could conform to.
3420 * If @is_a_type is a derivable type, check whether @type is a
3421 * descendant of @is_a_type. If @is_a_type is an interface, check
3422 * whether @type conforms to it.
3424 * Returns: %TRUE if @type is_a @is_a_type holds true.
3427 g_type_is_a (GType type,
3430 TypeNode *node, *iface_node;
3433 node = lookup_type_node_I (type);
3434 iface_node = lookup_type_node_I (iface_type);
3435 is_a = node && iface_node && type_node_conforms_to_U (node, iface_node, TRUE, TRUE);
3442 * @type: The parent type.
3443 * @n_children: Optional #guint pointer to contain the number of child types.
3445 * Return a newly allocated and 0-terminated array of type IDs, listing the
3446 * child types of @type. The return value has to be g_free()ed after use.
3448 * Returns: Newly allocated and 0-terminated array of child types.
3451 g_type_children (GType type,
3456 node = lookup_type_node_I (type);
3461 G_READ_LOCK (&type_rw_lock); /* ->children is relocatable */
3462 children = g_new (GType, node->n_children + 1);
3463 memcpy (children, node->children, sizeof (GType) * node->n_children);
3464 children[node->n_children] = 0;
3467 *n_children = node->n_children;
3468 G_READ_UNLOCK (&type_rw_lock);
3482 * g_type_interfaces:
3483 * @type: The type to list interface types for.
3484 * @n_interfaces: Optional #guint pointer to contain the number of
3487 * Return a newly allocated and 0-terminated array of type IDs, listing the
3488 * interface types that @type conforms to. The return value has to be
3489 * g_free()ed after use.
3491 * Returns: Newly allocated and 0-terminated array of interface types.
3494 g_type_interfaces (GType type,
3495 guint *n_interfaces)
3499 node = lookup_type_node_I (type);
3500 if (node && node->is_instantiatable)
3502 IFaceEntries *entries;
3506 G_READ_LOCK (&type_rw_lock);
3507 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
3510 ifaces = g_new (GType, IFACE_ENTRIES_N_ENTRIES (entries) + 1);
3511 for (i = 0; i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
3512 ifaces[i] = entries->entry[i].iface_type;
3516 ifaces = g_new (GType, 1);
3523 G_READ_UNLOCK (&type_rw_lock);
3536 typedef struct _QData QData;
3548 static inline gpointer
3549 type_get_qdata_L (TypeNode *node,
3552 GData *gdata = node->global_gdata;
3554 if (quark && gdata && gdata->n_qdatas)
3556 QData *qdatas = gdata->qdatas - 1;
3557 guint n_qdatas = gdata->n_qdatas;
3564 i = (n_qdatas + 1) / 2;
3566 if (quark == check->quark)
3568 else if (quark > check->quark)
3573 else /* if (quark < check->quark) */
3584 * @quark: a #GQuark id to identify the data
3586 * Obtains data which has previously been attached to @type
3587 * with g_type_set_qdata().
3589 * Returns: the data, or %NULL if no data was found
3592 g_type_get_qdata (GType type,
3598 node = lookup_type_node_I (type);
3601 G_READ_LOCK (&type_rw_lock);
3602 data = type_get_qdata_L (node, quark);
3603 G_READ_UNLOCK (&type_rw_lock);
3607 g_return_val_if_fail (node != NULL, NULL);
3614 type_set_qdata_W (TypeNode *node,
3622 /* setup qdata list if necessary */
3623 if (!node->global_gdata)
3624 node->global_gdata = g_new0 (GData, 1);
3625 gdata = node->global_gdata;
3627 /* try resetting old data */
3628 qdata = gdata->qdatas;
3629 for (i = 0; i < gdata->n_qdatas; i++)
3630 if (qdata[i].quark == quark)
3632 qdata[i].data = data;
3638 gdata->qdatas = g_renew (QData, gdata->qdatas, gdata->n_qdatas);
3639 qdata = gdata->qdatas;
3640 for (i = 0; i < gdata->n_qdatas - 1; i++)
3641 if (qdata[i].quark > quark)
3643 g_memmove (qdata + i + 1, qdata + i, sizeof (qdata[0]) * (gdata->n_qdatas - i - 1));
3644 qdata[i].quark = quark;
3645 qdata[i].data = data;
3651 * @quark: a #GQuark id to identify the data
3654 * Attaches arbitrary data to a type.
3657 g_type_set_qdata (GType type,
3663 g_return_if_fail (quark != 0);
3665 node = lookup_type_node_I (type);
3668 G_WRITE_LOCK (&type_rw_lock);
3669 type_set_qdata_W (node, quark, data);
3670 G_WRITE_UNLOCK (&type_rw_lock);
3673 g_return_if_fail (node != NULL);
3677 type_add_flags_W (TypeNode *node,
3682 g_return_if_fail ((flags & ~TYPE_FLAG_MASK) == 0);
3683 g_return_if_fail (node != NULL);
3685 if ((flags & TYPE_FLAG_MASK) && node->is_classed && node->data && node->data->class.class)
3686 g_warning ("tagging type `%s' as abstract after class initialization", NODE_NAME (node));
3687 dflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
3689 type_set_qdata_W (node, static_quark_type_flags, GUINT_TO_POINTER (dflags));
3694 * @type: the #GType value of a static, classed type.
3695 * @query: A user provided structure that is filled in with constant values
3698 * Queries the type system for information about a specific type.
3699 * This function will fill in a user-provided structure to hold
3700 * type-specific information. If an invalid #GType is passed in, the
3701 * @type member of the #GTypeQuery is 0. All members filled into the
3702 * #GTypeQuery structure should be considered constant and have to be
3706 g_type_query (GType type,
3711 g_return_if_fail (query != NULL);
3713 /* if node is not static and classed, we won't allow query */
3715 node = lookup_type_node_I (type);
3716 if (node && node->is_classed && !node->plugin)
3718 /* type is classed and probably even instantiatable */
3719 G_READ_LOCK (&type_rw_lock);
3720 if (node->data) /* type is static or referenced */
3722 query->type = NODE_TYPE (node);
3723 query->type_name = NODE_NAME (node);
3724 query->class_size = node->data->class.class_size;
3725 query->instance_size = node->is_instantiatable ? node->data->instance.instance_size : 0;
3727 G_READ_UNLOCK (&type_rw_lock);
3732 /* --- implementation details --- */
3734 g_type_test_flags (GType type,
3738 gboolean result = FALSE;
3740 node = lookup_type_node_I (type);
3743 guint fflags = flags & TYPE_FUNDAMENTAL_FLAG_MASK;
3744 guint tflags = flags & TYPE_FLAG_MASK;
3748 GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (node);
3750 fflags = (finfo->type_flags & fflags) == fflags;
3757 G_READ_LOCK (&type_rw_lock);
3758 tflags = (tflags & GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))) == tflags;
3759 G_READ_UNLOCK (&type_rw_lock);
3764 result = tflags && fflags;
3771 * g_type_get_plugin:
3772 * @type: The #GType to retrieve the plugin for.
3774 * Returns the #GTypePlugin structure for @type or
3775 * %NULL if @type does not have a #GTypePlugin structure.
3777 * Returns: The corresponding plugin if @type is a dynamic type,
3781 g_type_get_plugin (GType type)
3785 node = lookup_type_node_I (type);
3787 return node ? node->plugin : NULL;
3791 * g_type_interface_get_plugin:
3792 * @instance_type: the #GType value of an instantiatable type.
3793 * @interface_type: the #GType value of an interface type.
3795 * Returns the #GTypePlugin structure for the dynamic interface
3796 * @interface_type which has been added to @instance_type, or %NULL if
3797 * @interface_type has not been added to @instance_type or does not
3798 * have a #GTypePlugin structure. See g_type_add_interface_dynamic().
3800 * Returns: the #GTypePlugin for the dynamic interface @interface_type
3801 * of @instance_type.
3804 g_type_interface_get_plugin (GType instance_type,
3805 GType interface_type)
3810 g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL); /* G_TYPE_IS_INTERFACE() is an external call: _U */
3812 node = lookup_type_node_I (instance_type);
3813 iface = lookup_type_node_I (interface_type);
3816 IFaceHolder *iholder;
3817 GTypePlugin *plugin;
3819 G_READ_LOCK (&type_rw_lock);
3821 iholder = iface_node_get_holders_L (iface);
3822 while (iholder && iholder->instance_type != instance_type)
3823 iholder = iholder->next;
3824 plugin = iholder ? iholder->plugin : NULL;
3826 G_READ_UNLOCK (&type_rw_lock);
3831 g_return_val_if_fail (node == NULL, NULL);
3832 g_return_val_if_fail (iface == NULL, NULL);
3834 g_warning (G_STRLOC ": attempt to look up plugin for invalid instance/interface type pair.");
3840 * g_type_fundamental_next:
3842 * Returns the next free fundamental type id which can be used to
3843 * register a new fundamental type with g_type_register_fundamental().
3844 * The returned type ID represents the highest currently registered
3845 * fundamental type identifier.
3847 * Returns: The nextmost fundamental type ID to be registered,
3848 * or 0 if the type system ran out of fundamental type IDs.
3851 g_type_fundamental_next (void)
3855 G_READ_LOCK (&type_rw_lock);
3856 type = static_fundamental_next;
3857 G_READ_UNLOCK (&type_rw_lock);
3858 type = G_TYPE_MAKE_FUNDAMENTAL (type);
3859 return type <= G_TYPE_FUNDAMENTAL_MAX ? type : 0;
3863 * g_type_fundamental:
3864 * @type_id: valid type ID
3866 * Internal function, used to extract the fundamental type ID portion.
3867 * use G_TYPE_FUNDAMENTAL() instead.
3869 * Returns: fundamental type ID
3872 g_type_fundamental (GType type_id)
3874 TypeNode *node = lookup_type_node_I (type_id);
3876 return node ? NODE_FUNDAMENTAL_TYPE (node) : 0;
3880 g_type_check_instance_is_a (GTypeInstance *type_instance,
3883 TypeNode *node, *iface;
3886 if (!type_instance || !type_instance->g_class)
3889 node = lookup_type_node_I (type_instance->g_class->g_type);
3890 iface = lookup_type_node_I (iface_type);
3891 check = node && node->is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
3897 g_type_check_class_is_a (GTypeClass *type_class,
3900 TypeNode *node, *iface;
3906 node = lookup_type_node_I (type_class->g_type);
3907 iface = lookup_type_node_I (is_a_type);
3908 check = node && node->is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
3914 g_type_check_instance_cast (GTypeInstance *type_instance,
3919 if (type_instance->g_class)
3921 TypeNode *node, *iface;
3922 gboolean is_instantiatable, check;
3924 node = lookup_type_node_I (type_instance->g_class->g_type);
3925 is_instantiatable = node && node->is_instantiatable;
3926 iface = lookup_type_node_I (iface_type);
3927 check = is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
3929 return type_instance;
3931 if (is_instantiatable)
3932 g_warning ("invalid cast from `%s' to `%s'",
3933 type_descriptive_name_I (type_instance->g_class->g_type),
3934 type_descriptive_name_I (iface_type));
3936 g_warning ("invalid uninstantiatable type `%s' in cast to `%s'",
3937 type_descriptive_name_I (type_instance->g_class->g_type),
3938 type_descriptive_name_I (iface_type));
3941 g_warning ("invalid unclassed pointer in cast to `%s'",
3942 type_descriptive_name_I (iface_type));
3945 return type_instance;
3949 g_type_check_class_cast (GTypeClass *type_class,
3954 TypeNode *node, *iface;
3955 gboolean is_classed, check;
3957 node = lookup_type_node_I (type_class->g_type);
3958 is_classed = node && node->is_classed;
3959 iface = lookup_type_node_I (is_a_type);
3960 check = is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
3965 g_warning ("invalid class cast from `%s' to `%s'",
3966 type_descriptive_name_I (type_class->g_type),
3967 type_descriptive_name_I (is_a_type));
3969 g_warning ("invalid unclassed type `%s' in class cast to `%s'",
3970 type_descriptive_name_I (type_class->g_type),
3971 type_descriptive_name_I (is_a_type));
3974 g_warning ("invalid class cast from (NULL) pointer to `%s'",
3975 type_descriptive_name_I (is_a_type));
3980 * g_type_check_instance:
3981 * @instance: A valid #GTypeInstance structure.
3983 * Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
3986 * @Returns: #TRUE if @instance is valid, #FALSE otherwise.
3989 g_type_check_instance (GTypeInstance *type_instance)
3991 /* this function is just here to make the signal system
3992 * conveniently elaborated on instance checks
3996 if (type_instance->g_class)
3998 TypeNode *node = lookup_type_node_I (type_instance->g_class->g_type);
4000 if (node && node->is_instantiatable)
4003 g_warning ("instance of invalid non-instantiatable type `%s'",
4004 type_descriptive_name_I (type_instance->g_class->g_type));
4007 g_warning ("instance with invalid (NULL) class pointer");
4010 g_warning ("invalid (NULL) pointer instance");
4015 static inline gboolean
4016 type_check_is_value_type_U (GType type)
4018 GTypeFlags tflags = G_TYPE_FLAG_VALUE_ABSTRACT;
4021 /* common path speed up */
4022 node = lookup_type_node_I (type);
4023 if (node && node->mutatable_check_cache)
4026 G_READ_LOCK (&type_rw_lock);
4030 if (node->data && node->ref_count > 0 &&
4031 node->data->common.value_table->value_init)
4032 tflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
4033 else if (NODE_IS_IFACE (node))
4037 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4039 GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4040 TypeNode *prnode = lookup_type_node_I (prtype);
4042 if (prnode->is_instantiatable)
4045 node = lookup_type_node_I (type);
4051 G_READ_UNLOCK (&type_rw_lock);
4053 return !(tflags & G_TYPE_FLAG_VALUE_ABSTRACT);
4057 g_type_check_is_value_type (GType type)
4059 return type_check_is_value_type_U (type);
4063 g_type_check_value (GValue *value)
4065 return value && type_check_is_value_type_U (value->g_type);
4069 g_type_check_value_holds (GValue *value,
4072 return value && type_check_is_value_type_U (value->g_type) && g_type_is_a (value->g_type, type);
4076 * g_type_value_table_peek:
4077 * @type: A #GType value.
4079 * Returns the location of the #GTypeValueTable associated with @type.
4080 * <emphasis>Note that this function should only be used from source code
4081 * that implements or has internal knowledge of the implementation of
4084 * Returns: Location of the #GTypeValueTable associated with @type or
4085 * %NULL if there is no #GTypeValueTable associated with @type.
4088 g_type_value_table_peek (GType type)
4090 GTypeValueTable *vtable = NULL;
4091 TypeNode *node = lookup_type_node_I (type);
4092 gboolean has_refed_data, has_table;
4095 /* speed up common code path, we're not 100% safe here,
4096 * but we should only get called with referenced types anyway
4098 data = node ? node->data : NULL;
4099 if (node && node->mutatable_check_cache)
4100 return data->common.value_table;
4102 G_READ_LOCK (&type_rw_lock);
4105 has_refed_data = node && node->data && node->ref_count;
4106 has_table = has_refed_data && node->data->common.value_table->value_init;
4110 vtable = node->data->common.value_table;
4111 else if (NODE_IS_IFACE (node))
4115 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4117 GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4118 TypeNode *prnode = lookup_type_node_I (prtype);
4120 if (prnode->is_instantiatable)
4123 node = lookup_type_node_I (type);
4124 goto restart_table_peek;
4130 G_READ_UNLOCK (&type_rw_lock);
4136 g_warning (G_STRLOC ": type id `%" G_GSIZE_FORMAT "' is invalid", type);
4137 if (!has_refed_data)
4138 g_warning ("can't peek value table for type `%s' which is not currently referenced",
4139 type_descriptive_name_I (type));
4144 G_CONST_RETURN gchar*
4145 g_type_name_from_instance (GTypeInstance *instance)
4148 return "<NULL-instance>";
4150 return g_type_name_from_class (instance->g_class);
4153 G_CONST_RETURN gchar*
4154 g_type_name_from_class (GTypeClass *g_class)
4157 return "<NULL-class>";
4159 return g_type_name (g_class->g_type);
4163 /* --- initialization --- */
4165 * g_type_init_with_debug_flags:
4166 * @debug_flags: Bitwise combination of #GTypeDebugFlags values for
4167 * debugging purposes.
4169 * Similar to g_type_init(), but additionally sets debug flags.
4172 g_type_init_with_debug_flags (GTypeDebugFlags debug_flags)
4174 G_LOCK_DEFINE_STATIC (type_init_lock);
4175 const gchar *env_string;
4178 volatile GType votype;
4180 G_LOCK (type_init_lock);
4182 G_WRITE_LOCK (&type_rw_lock);
4184 if (static_quark_type_flags)
4186 G_WRITE_UNLOCK (&type_rw_lock);
4187 G_UNLOCK (type_init_lock);
4191 /* setup GObject library wide debugging flags */
4192 _g_type_debug_flags = debug_flags & G_TYPE_DEBUG_MASK;
4193 env_string = g_getenv ("GOBJECT_DEBUG");
4194 if (env_string != NULL)
4196 static GDebugKey debug_keys[] = {
4197 { "objects", G_TYPE_DEBUG_OBJECTS },
4198 { "signals", G_TYPE_DEBUG_SIGNALS },
4201 _g_type_debug_flags |= g_parse_debug_string (env_string,
4203 sizeof (debug_keys) / sizeof (debug_keys[0]));
4208 static_quark_type_flags = g_quark_from_static_string ("-g-type-private--GTypeFlags");
4209 static_quark_iface_holder = g_quark_from_static_string ("-g-type-private--IFaceHolder");
4210 static_quark_dependants_array = g_quark_from_static_string ("-g-type-private--dependants-array");
4212 /* type qname hash table */
4213 static_type_nodes_ht = g_hash_table_new (g_direct_hash, g_direct_equal);
4215 /* invalid type G_TYPE_INVALID (0)
4217 static_fundamental_type_nodes[0] = NULL;
4219 /* void type G_TYPE_NONE
4221 node = type_node_fundamental_new_W (G_TYPE_NONE, g_intern_static_string ("void"), 0);
4222 votype = NODE_TYPE (node);
4223 g_assert (votype == G_TYPE_NONE);
4225 /* interface fundamental type G_TYPE_INTERFACE (!classed)
4227 memset (&info, 0, sizeof (info));
4228 node = type_node_fundamental_new_W (G_TYPE_INTERFACE, g_intern_static_string ("GInterface"), G_TYPE_FLAG_DERIVABLE);
4229 votype = NODE_TYPE (node);
4230 type_data_make_W (node, &info, NULL);
4231 g_assert (votype == G_TYPE_INTERFACE);
4233 G_WRITE_UNLOCK (&type_rw_lock);
4237 /* G_TYPE_TYPE_PLUGIN
4239 votype = g_type_plugin_get_type ();
4241 /* G_TYPE_* value types
4243 g_value_types_init ();
4245 /* G_TYPE_ENUM & G_TYPE_FLAGS
4247 g_enum_types_init ();
4251 g_boxed_type_init ();
4255 g_param_type_init ();
4259 g_object_type_init ();
4261 /* G_TYPE_PARAM_* pspec types
4263 g_param_spec_types_init ();
4265 /* Value Transformations
4267 g_value_transforms_init ();
4273 G_UNLOCK (type_init_lock);
4279 * Prior to any use of the type system, g_type_init() has to be called
4280 * to initialize the type system and assorted other code portions
4281 * (such as the various fundamental type implementations or the signal
4287 g_type_init_with_debug_flags (0);
4291 * g_type_class_add_private:
4292 * @g_class: class structure for an instantiatable type
4293 * @private_size: size of private structure.
4295 * Registers a private structure for an instantiatable type;
4296 * when an object is allocated, the private structures for
4297 * the type and all of its parent types are allocated
4298 * sequentially in the same memory block as the public
4299 * structures. This function should be called in the
4300 * type's class_init() function. The private structure can
4301 * be retrieved using the G_TYPE_INSTANCE_GET_PRIVATE() macro.
4302 * The following example shows attaching a private structure
4303 * <structname>MyObjectPrivate</structname> to an object
4304 * <structname>MyObject</structname> defined in the standard GObject
4308 * typedef struct _MyObjectPrivate MyObjectPrivate;
4310 * struct _MyObjectPrivate {
4314 * #define MY_OBJECT_GET_PRIVATE(o) \
4315 * (G_TYPE_INSTANCE_GET_PRIVATE ((o), MY_TYPE_OBJECT, MyObjectPrivate))
4318 * my_object_class_init (MyObjectClass *klass)
4320 * g_type_class_add_private (klass, sizeof (MyObjectPrivate));
4324 * my_object_get_some_field (MyObject *my_object)
4326 * MyObjectPrivate *priv = MY_OBJECT_GET_PRIVATE (my_object);
4328 * return priv->some_field;
4335 g_type_class_add_private (gpointer g_class,
4338 GType instance_type = ((GTypeClass *)g_class)->g_type;
4339 TypeNode *node = lookup_type_node_I (instance_type);
4342 g_return_if_fail (private_size > 0);
4344 if (!node || !node->is_instantiatable || !node->data || node->data->class.class != g_class)
4346 g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4347 type_descriptive_name_I (instance_type));
4351 if (NODE_PARENT_TYPE (node))
4353 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4354 if (node->data->instance.private_size != pnode->data->instance.private_size)
4356 g_warning ("g_type_add_private() called multiple times for the same type");
4361 G_WRITE_LOCK (&type_rw_lock);
4363 offset = ALIGN_STRUCT (node->data->instance.private_size);
4364 node->data->instance.private_size = offset + private_size;
4366 G_WRITE_UNLOCK (&type_rw_lock);
4370 g_type_instance_get_private (GTypeInstance *instance,
4373 TypeNode *instance_node;
4374 TypeNode *private_node;
4375 TypeNode *parent_node;
4379 g_return_val_if_fail (instance != NULL && instance->g_class != NULL, NULL);
4381 /* while instances are initialized, their class pointers change,
4382 * so figure the instances real class first
4384 class = instance_real_class_get (instance);
4386 class = instance->g_class;
4388 instance_node = lookup_type_node_I (class->g_type);
4389 if (G_UNLIKELY (!instance_node || !instance_node->is_instantiatable))
4391 g_warning ("instance of invalid non-instantiatable type `%s'",
4392 type_descriptive_name_I (instance->g_class->g_type));
4396 private_node = lookup_type_node_I (private_type);
4397 if (G_UNLIKELY (!private_node || !NODE_IS_ANCESTOR (private_node, instance_node)))
4399 g_warning ("attempt to retrieve private data for invalid type '%s'",
4400 type_descriptive_name_I (private_type));
4404 /* Note that we don't need a read lock, since instance existing
4405 * means that the instance class and all parent classes
4406 * exist, so the node->data, node->data->instance.instance_size,
4407 * and node->data->instance.private_size are not going to be changed.
4408 * for any of the relevant types.
4411 offset = ALIGN_STRUCT (instance_node->data->instance.instance_size);
4413 if (NODE_PARENT_TYPE (private_node))
4415 parent_node = lookup_type_node_I (NODE_PARENT_TYPE (private_node));
4416 g_assert (parent_node->data && parent_node->ref_count);
4418 if (G_UNLIKELY (private_node->data->instance.private_size == parent_node->data->instance.private_size))
4420 g_warning ("g_type_instance_get_private() requires a prior call to g_type_class_add_private()");
4424 offset += ALIGN_STRUCT (parent_node->data->instance.private_size);
4427 return G_STRUCT_MEMBER_P (instance, offset);
4430 #define __G_TYPE_C__
4431 #include "gobjectaliasdef.c"