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 "gtype-private.h"
30 #include "gtypeplugin.h"
31 #include "gvaluecollector.h"
32 #include "gbsearcharray.h"
33 #include "gatomicarray.h"
34 #include "gobject_trace.h"
39 * @short_description: The GLib Runtime type identification and
41 * @title:Type Information
43 * The GType API is the foundation of the GObject system. It provides the
44 * facilities for registering and managing all fundamental data types,
45 * user-defined object and interface types. Before using any GType
46 * or GObject functions, g_type_init() must be called to initialize the
49 * For type creation and registration purposes, all types fall into one of
50 * two categories: static or dynamic. Static types are never loaded or
51 * unloaded at run-time as dynamic types may be. Static types are created
52 * with g_type_register_static() that gets type specific information passed
53 * in via a #GTypeInfo structure.
54 * Dynamic types are created with g_type_register_dynamic() which takes a
55 * #GTypePlugin structure instead. The remaining type information (the
56 * #GTypeInfo structure) is retrieved during runtime through #GTypePlugin
57 * and the g_type_plugin_*() API.
58 * These registration functions are usually called only once from a
59 * function whose only purpose is to return the type identifier for a
60 * specific class. Once the type (or class or interface) is registered,
61 * it may be instantiated, inherited, or implemented depending on exactly
62 * what sort of type it is.
63 * There is also a third registration function for registering fundamental
64 * types called g_type_register_fundamental() which requires both a #GTypeInfo
65 * structure and a #GTypeFundamentalInfo structure but it is seldom used
66 * since most fundamental types are predefined rather than user-defined.
68 * A final word about type names.
69 * Such an identifier needs to be at least three characters long. There is no
70 * upper length limit. The first character needs to be a letter (a-z or A-Z)
71 * or an underscore '_'. Subsequent characters can be letters, numbers or
76 /* NOTE: some functions (some internal variants and exported ones)
77 * invalidate data portions of the TypeNodes. if external functions/callbacks
78 * are called, pointers to memory maintained by TypeNodes have to be looked up
79 * again. this affects most of the struct TypeNode fields, e.g. ->children or
80 * CLASSED_NODE_IFACES_ENTRIES() respectively IFACE_NODE_PREREQUISITES() (but
81 * not ->supers[]), as all those memory portions can get realloc()ed during
82 * callback invocation.
85 * lock handling issues when calling static functions are indicated by
86 * uppercase letter postfixes, all static functions have to have
87 * one of the below postfixes:
88 * - _I: [Indifferent about locking]
89 * function doesn't care about locks at all
90 * - _U: [Unlocked invocation]
91 * no read or write lock has to be held across function invocation
92 * (locks may be acquired and released during invocation though)
93 * - _L: [Locked invocation]
94 * a write lock or more than 0 read locks have to be held across
96 * - _W: [Write-locked invocation]
97 * a write lock has to be held across function invocation
98 * - _Wm: [Write-locked invocation, mutatable]
99 * like _W, but the write lock might be released and reacquired
100 * during invocation, watch your pointers
101 * - _WmREC: [Write-locked invocation, mutatable, recursive]
102 * like _Wm, but also acquires recursive mutex class_init_rec_mutex
106 #define G_READ_LOCK(rw_lock) do { g_printerr (G_STRLOC ": readL++\n"); g_rw_lock_reader_lock (rw_lock); } while (0)
107 #define G_READ_UNLOCK(rw_lock) do { g_printerr (G_STRLOC ": readL--\n"); g_rw_lock_reader_unlock (rw_lock); } while (0)
108 #define G_WRITE_LOCK(rw_lock) do { g_printerr (G_STRLOC ": writeL++\n"); g_rw_lock_writer_lock (rw_lock); } while (0)
109 #define G_WRITE_UNLOCK(rw_lock) do { g_printerr (G_STRLOC ": writeL--\n"); g_rw_lock_writer_unlock (rw_lock); } while (0)
111 #define G_READ_LOCK(rw_lock) g_rw_lock_reader_lock (rw_lock)
112 #define G_READ_UNLOCK(rw_lock) g_rw_lock_reader_unlock (rw_lock)
113 #define G_WRITE_LOCK(rw_lock) g_rw_lock_writer_lock (rw_lock)
114 #define G_WRITE_UNLOCK(rw_lock) g_rw_lock_writer_unlock (rw_lock)
116 #define INVALID_RECURSION(func, arg, type_name) G_STMT_START{ \
117 static const gchar _action[] = " invalidly modified type "; \
118 gpointer _arg = (gpointer) (arg); const gchar *_tname = (type_name), *_fname = (func); \
120 g_error ("%s(%p)%s`%s'", _fname, _arg, _action, _tname); \
122 g_error ("%s()%s`%s'", _fname, _action, _tname); \
124 #define g_return_val_if_type_system_uninitialized(return_value) G_STMT_START{ \
125 if (G_UNLIKELY (!static_quark_type_flags)) \
127 g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, \
128 "%s: You forgot to call g_type_init()", \
130 return (return_value); \
134 #ifdef G_ENABLE_DEBUG
135 #define DEBUG_CODE(debug_type, code_block) G_STMT_START { \
136 if (_g_type_debug_flags & G_TYPE_DEBUG_ ## debug_type) \
139 #else /* !G_ENABLE_DEBUG */
140 #define DEBUG_CODE(debug_type, code_block) /* code_block */
141 #endif /* G_ENABLE_DEBUG */
143 #define TYPE_FUNDAMENTAL_FLAG_MASK (G_TYPE_FLAG_CLASSED | \
144 G_TYPE_FLAG_INSTANTIATABLE | \
145 G_TYPE_FLAG_DERIVABLE | \
146 G_TYPE_FLAG_DEEP_DERIVABLE)
147 #define TYPE_FLAG_MASK (G_TYPE_FLAG_ABSTRACT | G_TYPE_FLAG_VALUE_ABSTRACT)
148 #define SIZEOF_FUNDAMENTAL_INFO ((gssize) MAX (MAX (sizeof (GTypeFundamentalInfo), \
149 sizeof (gpointer)), \
152 /* The 2*sizeof(size_t) alignment here is borrowed from
153 * GNU libc, so it should be good most everywhere.
154 * It is more conservative than is needed on some 64-bit
155 * platforms, but ia64 does require a 16-byte alignment.
156 * The SIMD extensions for x86 and ppc32 would want a
157 * larger alignment than this, but we don't need to
158 * do better than malloc.
160 #define STRUCT_ALIGNMENT (2 * sizeof (gsize))
161 #define ALIGN_STRUCT(offset) \
162 ((offset + (STRUCT_ALIGNMENT - 1)) & -STRUCT_ALIGNMENT)
165 /* --- typedefs --- */
166 typedef struct _TypeNode TypeNode;
167 typedef struct _CommonData CommonData;
168 typedef struct _BoxedData BoxedData;
169 typedef struct _IFaceData IFaceData;
170 typedef struct _ClassData ClassData;
171 typedef struct _InstanceData InstanceData;
172 typedef union _TypeData TypeData;
173 typedef struct _IFaceEntries IFaceEntries;
174 typedef struct _IFaceEntry IFaceEntry;
175 typedef struct _IFaceHolder IFaceHolder;
178 /* --- prototypes --- */
179 static inline GTypeFundamentalInfo* type_node_fundamental_info_I (TypeNode *node);
180 static void type_add_flags_W (TypeNode *node,
182 static void type_data_make_W (TypeNode *node,
183 const GTypeInfo *info,
184 const GTypeValueTable *value_table);
185 static inline void type_data_ref_Wm (TypeNode *node);
186 static inline void type_data_unref_U (TypeNode *node,
188 static void type_data_last_unref_Wm (TypeNode * node,
190 static inline gpointer type_get_qdata_L (TypeNode *node,
192 static inline void type_set_qdata_W (TypeNode *node,
195 static IFaceHolder* type_iface_peek_holder_L (TypeNode *iface,
196 GType instance_type);
197 static gboolean type_iface_vtable_base_init_Wm (TypeNode *iface,
199 static void type_iface_vtable_iface_init_Wm (TypeNode *iface,
201 static gboolean type_node_is_a_L (TypeNode *node,
202 TypeNode *iface_node);
205 /* --- enumeration --- */
207 /* The InitState enumeration is used to track the progress of initializing
208 * both classes and interface vtables. Keeping the state of initialization
209 * is necessary to handle new interfaces being added while we are initializing
210 * the class or other interfaces.
222 /* --- structures --- */
225 guint volatile ref_count;
227 guint n_children; /* writable with lock */
229 guint n_prerequisites : 9;
230 guint is_classed : 1;
231 guint is_instantiatable : 1;
232 guint mutatable_check_cache : 1; /* combines some common path checks */
233 GType *children; /* writable with lock */
234 TypeData * volatile data;
238 GAtomicArray iface_entries; /* for !iface types */
239 GAtomicArray offsets;
241 GType *prerequisites;
242 GType supers[1]; /* flexible array */
245 #define SIZEOF_BASE_TYPE_NODE() (G_STRUCT_OFFSET (TypeNode, supers))
246 #define MAX_N_SUPERS (255)
247 #define MAX_N_CHILDREN (4095)
248 #define MAX_N_INTERFACES (255) /* Limited by offsets being 8 bits */
249 #define MAX_N_PREREQUISITES (511)
250 #define NODE_TYPE(node) (node->supers[0])
251 #define NODE_PARENT_TYPE(node) (node->supers[1])
252 #define NODE_FUNDAMENTAL_TYPE(node) (node->supers[node->n_supers])
253 #define NODE_NAME(node) (g_quark_to_string (node->qname))
254 #define NODE_REFCOUNT(node) ((guint) g_atomic_int_get ((int *) &(node)->ref_count))
255 #define NODE_IS_BOXED(node) (NODE_FUNDAMENTAL_TYPE (node) == G_TYPE_BOXED)
256 #define NODE_IS_IFACE(node) (NODE_FUNDAMENTAL_TYPE (node) == G_TYPE_INTERFACE)
257 #define CLASSED_NODE_IFACES_ENTRIES(node) (&(node)->_prot.iface_entries)
258 #define CLASSED_NODE_IFACES_ENTRIES_LOCKED(node)(G_ATOMIC_ARRAY_GET_LOCKED(CLASSED_NODE_IFACES_ENTRIES((node)), IFaceEntries))
259 #define IFACE_NODE_N_PREREQUISITES(node) ((node)->n_prerequisites)
260 #define IFACE_NODE_PREREQUISITES(node) ((node)->prerequisites)
261 #define iface_node_get_holders_L(node) ((IFaceHolder*) type_get_qdata_L ((node), static_quark_iface_holder))
262 #define iface_node_set_holders_W(node, holders) (type_set_qdata_W ((node), static_quark_iface_holder, (holders)))
263 #define iface_node_get_dependants_array_L(n) ((GType*) type_get_qdata_L ((n), static_quark_dependants_array))
264 #define iface_node_set_dependants_array_W(n,d) (type_set_qdata_W ((n), static_quark_dependants_array, (d)))
265 #define TYPE_ID_MASK ((GType) ((1 << G_TYPE_FUNDAMENTAL_SHIFT) - 1))
267 #define NODE_IS_ANCESTOR(ancestor, node) \
268 ((ancestor)->n_supers <= (node)->n_supers && \
269 (node)->supers[(node)->n_supers - (ancestor)->n_supers] == NODE_TYPE (ancestor))
274 GInterfaceInfo *info;
282 GTypeInterface *vtable;
283 InitState init_state;
286 struct _IFaceEntries {
291 #define IFACE_ENTRIES_HEADER_SIZE (sizeof(IFaceEntries) - sizeof(IFaceEntry))
292 #define IFACE_ENTRIES_N_ENTRIES(_entries) ( (G_ATOMIC_ARRAY_DATA_SIZE((_entries)) - IFACE_ENTRIES_HEADER_SIZE) / sizeof(IFaceEntry) )
296 GTypeValueTable *value_table;
302 GBoxedCopyFunc copy_func;
303 GBoxedFreeFunc free_func;
310 GBaseInitFunc vtable_init_base;
311 GBaseFinalizeFunc vtable_finalize_base;
312 GClassInitFunc dflt_init;
313 GClassFinalizeFunc dflt_finalize;
314 gconstpointer dflt_data;
315 gpointer dflt_vtable;
322 guint16 class_private_size;
323 int volatile init_state; /* atomic - g_type_class_ref reads it unlocked */
324 GBaseInitFunc class_init_base;
325 GBaseFinalizeFunc class_finalize_base;
326 GClassInitFunc class_init;
327 GClassFinalizeFunc class_finalize;
328 gconstpointer class_data;
336 guint16 class_private_size;
337 int volatile init_state; /* atomic - g_type_class_ref reads it unlocked */
338 GBaseInitFunc class_init_base;
339 GBaseFinalizeFunc class_finalize_base;
340 GClassInitFunc class_init;
341 GClassFinalizeFunc class_finalize;
342 gconstpointer class_data;
344 guint16 instance_size;
345 guint16 private_size;
347 GInstanceInitFunc instance_init;
356 InstanceData instance;
361 GTypeClassCacheFunc cache_func;
366 GTypeInterfaceCheckFunc check_func;
370 /* --- variables --- */
371 static GRWLock type_rw_lock = G_RW_LOCK_INIT;
372 static GRecMutex class_init_rec_mutex = G_REC_MUTEX_INIT;
373 static guint static_n_class_cache_funcs = 0;
374 static ClassCacheFunc *static_class_cache_funcs = NULL;
375 static guint static_n_iface_check_funcs = 0;
376 static IFaceCheckFunc *static_iface_check_funcs = NULL;
377 static GQuark static_quark_type_flags = 0;
378 static GQuark static_quark_iface_holder = 0;
379 static GQuark static_quark_dependants_array = 0;
380 GTypeDebugFlags _g_type_debug_flags = 0;
382 /* --- type nodes --- */
383 static GHashTable *static_type_nodes_ht = NULL;
384 static TypeNode *static_fundamental_type_nodes[(G_TYPE_FUNDAMENTAL_MAX >> G_TYPE_FUNDAMENTAL_SHIFT) + 1] = { NULL, };
385 static GType static_fundamental_next = G_TYPE_RESERVED_USER_FIRST;
387 static inline TypeNode*
388 lookup_type_node_I (register GType utype)
390 if (utype > G_TYPE_FUNDAMENTAL_MAX)
391 return (TypeNode*) (utype & ~TYPE_ID_MASK);
393 return static_fundamental_type_nodes[utype >> G_TYPE_FUNDAMENTAL_SHIFT];
397 type_node_any_new_W (TypeNode *pnode,
401 GTypeFundamentalFlags type_flags)
406 guint i, node_size = 0;
408 n_supers = pnode ? pnode->n_supers + 1 : 0;
411 node_size += SIZEOF_FUNDAMENTAL_INFO; /* fundamental type info */
412 node_size += SIZEOF_BASE_TYPE_NODE (); /* TypeNode structure */
413 node_size += (sizeof (GType) * (1 + n_supers + 1)); /* self + ancestors + (0) for ->supers[] */
414 node = g_malloc0 (node_size);
415 if (!pnode) /* offset fundamental types */
417 node = G_STRUCT_MEMBER_P (node, SIZEOF_FUNDAMENTAL_INFO);
418 static_fundamental_type_nodes[ftype >> G_TYPE_FUNDAMENTAL_SHIFT] = node;
424 g_assert ((type & TYPE_ID_MASK) == 0);
426 node->n_supers = n_supers;
429 node->supers[0] = type;
432 node->is_classed = (type_flags & G_TYPE_FLAG_CLASSED) != 0;
433 node->is_instantiatable = (type_flags & G_TYPE_FLAG_INSTANTIATABLE) != 0;
435 if (NODE_IS_IFACE (node))
437 IFACE_NODE_N_PREREQUISITES (node) = 0;
438 IFACE_NODE_PREREQUISITES (node) = NULL;
441 _g_atomic_array_init (CLASSED_NODE_IFACES_ENTRIES (node));
445 node->supers[0] = type;
446 memcpy (node->supers + 1, pnode->supers, sizeof (GType) * (1 + pnode->n_supers + 1));
448 node->is_classed = pnode->is_classed;
449 node->is_instantiatable = pnode->is_instantiatable;
451 if (NODE_IS_IFACE (node))
453 IFACE_NODE_N_PREREQUISITES (node) = 0;
454 IFACE_NODE_PREREQUISITES (node) = NULL;
459 IFaceEntries *entries;
461 entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (pnode),
462 IFACE_ENTRIES_HEADER_SIZE,
466 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
468 entries->entry[j].vtable = NULL;
469 entries->entry[j].init_state = UNINITIALIZED;
471 _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node),
476 i = pnode->n_children++;
477 pnode->children = g_renew (GType, pnode->children, pnode->n_children);
478 pnode->children[i] = type;
481 TRACE(GOBJECT_TYPE_NEW(name, node->supers[1], type));
483 node->plugin = plugin;
484 node->n_children = 0;
485 node->children = NULL;
487 node->qname = g_quark_from_string (name);
488 node->global_gdata = NULL;
490 g_hash_table_insert (static_type_nodes_ht,
491 (gpointer) g_quark_to_string (node->qname),
496 static inline GTypeFundamentalInfo*
497 type_node_fundamental_info_I (TypeNode *node)
499 GType ftype = NODE_FUNDAMENTAL_TYPE (node);
501 if (ftype != NODE_TYPE (node))
502 node = lookup_type_node_I (ftype);
504 return node ? G_STRUCT_MEMBER_P (node, -SIZEOF_FUNDAMENTAL_INFO) : NULL;
508 type_node_fundamental_new_W (GType ftype,
510 GTypeFundamentalFlags type_flags)
512 GTypeFundamentalInfo *finfo;
515 g_assert ((ftype & TYPE_ID_MASK) == 0);
516 g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX);
518 if (ftype >> G_TYPE_FUNDAMENTAL_SHIFT == static_fundamental_next)
519 static_fundamental_next++;
521 type_flags &= TYPE_FUNDAMENTAL_FLAG_MASK;
523 node = type_node_any_new_W (NULL, ftype, name, NULL, type_flags);
525 finfo = type_node_fundamental_info_I (node);
526 finfo->type_flags = type_flags;
532 type_node_new_W (TypeNode *pnode,
538 g_assert (pnode->n_supers < MAX_N_SUPERS);
539 g_assert (pnode->n_children < MAX_N_CHILDREN);
541 return type_node_any_new_W (pnode, NODE_FUNDAMENTAL_TYPE (pnode), name, plugin, 0);
544 static inline IFaceEntry*
545 lookup_iface_entry_I (volatile IFaceEntries *entries,
546 TypeNode *iface_node)
557 G_ATOMIC_ARRAY_DO_TRANSACTION
558 (&iface_node->_prot.offsets, guint8,
561 offsets = transaction_data;
562 offset_index = entries->offset_index;
563 if (offsets != NULL &&
564 offset_index < G_ATOMIC_ARRAY_DATA_SIZE(offsets))
566 index = offsets[offset_index];
569 /* zero means unset, subtract one to get real index */
572 if (index < IFACE_ENTRIES_N_ENTRIES (entries))
574 check = (IFaceEntry *)&entries->entry[index];
575 if (check->iface_type == NODE_TYPE (iface_node))
585 static inline IFaceEntry*
586 type_lookup_iface_entry_L (TypeNode *node,
587 TypeNode *iface_node)
589 if (!NODE_IS_IFACE (iface_node))
592 return lookup_iface_entry_I (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node),
597 static inline gboolean
598 type_lookup_iface_vtable_I (TypeNode *node,
599 TypeNode *iface_node,
600 gpointer *vtable_ptr)
605 if (!NODE_IS_IFACE (iface_node))
612 G_ATOMIC_ARRAY_DO_TRANSACTION
613 (CLASSED_NODE_IFACES_ENTRIES (node), IFaceEntries,
615 entry = lookup_iface_entry_I (transaction_data, iface_node);
620 *vtable_ptr = entry->vtable;
629 static inline gboolean
630 type_lookup_prerequisite_L (TypeNode *iface,
631 GType prerequisite_type)
633 if (NODE_IS_IFACE (iface) && IFACE_NODE_N_PREREQUISITES (iface))
635 GType *prerequisites = IFACE_NODE_PREREQUISITES (iface) - 1;
636 guint n_prerequisites = IFACE_NODE_N_PREREQUISITES (iface);
643 i = (n_prerequisites + 1) >> 1;
644 check = prerequisites + i;
645 if (prerequisite_type == *check)
647 else if (prerequisite_type > *check)
649 n_prerequisites -= i;
650 prerequisites = check;
652 else /* if (prerequisite_type < *check) */
653 n_prerequisites = i - 1;
655 while (n_prerequisites);
661 type_descriptive_name_I (GType type)
665 TypeNode *node = lookup_type_node_I (type);
667 return node ? NODE_NAME (node) : "<unknown>";
674 /* --- type consistency checks --- */
676 check_plugin_U (GTypePlugin *plugin,
677 gboolean need_complete_type_info,
678 gboolean need_complete_interface_info,
679 const gchar *type_name)
681 /* G_IS_TYPE_PLUGIN() and G_TYPE_PLUGIN_GET_CLASS() are external calls: _U
685 g_warning ("plugin handle for type `%s' is NULL",
689 if (!G_IS_TYPE_PLUGIN (plugin))
691 g_warning ("plugin pointer (%p) for type `%s' is invalid",
695 if (need_complete_type_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_type_info)
697 g_warning ("plugin for type `%s' has no complete_type_info() implementation",
701 if (need_complete_interface_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_interface_info)
703 g_warning ("plugin for type `%s' has no complete_interface_info() implementation",
711 check_type_name_I (const gchar *type_name)
713 static const gchar extra_chars[] = "-_+";
714 const gchar *p = type_name;
717 if (!type_name[0] || !type_name[1] || !type_name[2])
719 g_warning ("type name `%s' is too short", type_name);
722 /* check the first letter */
723 name_valid = (p[0] >= 'A' && p[0] <= 'Z') || (p[0] >= 'a' && p[0] <= 'z') || p[0] == '_';
724 for (p = type_name + 1; *p; p++)
725 name_valid &= ((p[0] >= 'A' && p[0] <= 'Z') ||
726 (p[0] >= 'a' && p[0] <= 'z') ||
727 (p[0] >= '0' && p[0] <= '9') ||
728 strchr (extra_chars, p[0]));
731 g_warning ("type name `%s' contains invalid characters", type_name);
734 if (g_type_from_name (type_name))
736 g_warning ("cannot register existing type `%s'", type_name);
744 check_derivation_I (GType parent_type,
745 const gchar *type_name)
748 GTypeFundamentalInfo* finfo;
750 pnode = lookup_type_node_I (parent_type);
753 g_warning ("cannot derive type `%s' from invalid parent type `%s'",
755 type_descriptive_name_I (parent_type));
758 finfo = type_node_fundamental_info_I (pnode);
759 /* ensure flat derivability */
760 if (!(finfo->type_flags & G_TYPE_FLAG_DERIVABLE))
762 g_warning ("cannot derive `%s' from non-derivable parent type `%s'",
767 /* ensure deep derivability */
768 if (parent_type != NODE_FUNDAMENTAL_TYPE (pnode) &&
769 !(finfo->type_flags & G_TYPE_FLAG_DEEP_DERIVABLE))
771 g_warning ("cannot derive `%s' from non-fundamental parent type `%s'",
781 check_collect_format_I (const gchar *collect_format)
783 const gchar *p = collect_format;
784 gchar valid_format[] = { G_VALUE_COLLECT_INT, G_VALUE_COLLECT_LONG,
785 G_VALUE_COLLECT_INT64, G_VALUE_COLLECT_DOUBLE,
786 G_VALUE_COLLECT_POINTER, 0 };
789 if (!strchr (valid_format, *p++))
791 return p - collect_format <= G_VALUE_COLLECT_FORMAT_MAX_LENGTH;
795 check_value_table_I (const gchar *type_name,
796 const GTypeValueTable *value_table)
800 else if (value_table->value_init == NULL)
802 if (value_table->value_free || value_table->value_copy ||
803 value_table->value_peek_pointer ||
804 value_table->collect_format || value_table->collect_value ||
805 value_table->lcopy_format || value_table->lcopy_value)
806 g_warning ("cannot handle uninitializable values of type `%s'",
810 else /* value_table->value_init != NULL */
812 if (!value_table->value_free)
815 * g_warning ("missing `value_free()' for type `%s'", type_name);
819 if (!value_table->value_copy)
821 g_warning ("missing `value_copy()' for type `%s'", type_name);
824 if ((value_table->collect_format || value_table->collect_value) &&
825 (!value_table->collect_format || !value_table->collect_value))
827 g_warning ("one of `collect_format' and `collect_value()' is unspecified for type `%s'",
831 if (value_table->collect_format && !check_collect_format_I (value_table->collect_format))
833 g_warning ("the `%s' specification for type `%s' is too long or invalid",
838 if ((value_table->lcopy_format || value_table->lcopy_value) &&
839 (!value_table->lcopy_format || !value_table->lcopy_value))
841 g_warning ("one of `lcopy_format' and `lcopy_value()' is unspecified for type `%s'",
845 if (value_table->lcopy_format && !check_collect_format_I (value_table->lcopy_format))
847 g_warning ("the `%s' specification for type `%s' is too long or invalid",
857 check_type_info_I (TypeNode *pnode,
859 const gchar *type_name,
860 const GTypeInfo *info)
862 GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (lookup_type_node_I (ftype));
863 gboolean is_interface = ftype == G_TYPE_INTERFACE;
865 g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX && !(ftype & TYPE_ID_MASK));
867 /* check instance members */
868 if (!(finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
869 (info->instance_size || info->n_preallocs || info->instance_init))
872 g_warning ("cannot instantiate `%s', derived from non-instantiatable parent type `%s'",
876 g_warning ("cannot instantiate `%s' as non-instantiatable fundamental",
880 /* check class & interface members */
881 if (!((finfo->type_flags & G_TYPE_FLAG_CLASSED) || is_interface) &&
882 (info->class_init || info->class_finalize || info->class_data ||
883 info->class_size || info->base_init || info->base_finalize))
886 g_warning ("cannot create class for `%s', derived from non-classed parent type `%s'",
890 g_warning ("cannot create class for `%s' as non-classed fundamental",
894 /* check interface size */
895 if (is_interface && info->class_size < sizeof (GTypeInterface))
897 g_warning ("specified interface size for type `%s' is smaller than `GTypeInterface' size",
901 /* check class size */
902 if (finfo->type_flags & G_TYPE_FLAG_CLASSED)
904 if (info->class_size < sizeof (GTypeClass))
906 g_warning ("specified class size for type `%s' is smaller than `GTypeClass' size",
910 if (pnode && info->class_size < pnode->data->class.class_size)
912 g_warning ("specified class size for type `%s' is smaller "
913 "than the parent type's `%s' class size",
919 /* check instance size */
920 if (finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE)
922 if (info->instance_size < sizeof (GTypeInstance))
924 g_warning ("specified instance size for type `%s' is smaller than `GTypeInstance' size",
928 if (pnode && info->instance_size < pnode->data->instance.instance_size)
930 g_warning ("specified instance size for type `%s' is smaller "
931 "than the parent type's `%s' instance size",
942 find_conforming_child_type_L (TypeNode *pnode,
945 TypeNode *node = NULL;
948 if (type_lookup_iface_entry_L (pnode, iface))
951 for (i = 0; i < pnode->n_children && !node; i++)
952 node = find_conforming_child_type_L (lookup_type_node_I (pnode->children[i]), iface);
958 check_add_interface_L (GType instance_type,
961 TypeNode *node = lookup_type_node_I (instance_type);
962 TypeNode *iface = lookup_type_node_I (iface_type);
965 GType *prerequisites;
969 if (!node || !node->is_instantiatable)
971 g_warning ("cannot add interfaces to invalid (non-instantiatable) type `%s'",
972 type_descriptive_name_I (instance_type));
975 if (!iface || !NODE_IS_IFACE (iface))
977 g_warning ("cannot add invalid (non-interface) type `%s' to type `%s'",
978 type_descriptive_name_I (iface_type),
982 tnode = lookup_type_node_I (NODE_PARENT_TYPE (iface));
983 if (NODE_PARENT_TYPE (tnode) && !type_lookup_iface_entry_L (node, tnode))
985 /* 2001/7/31:timj: erk, i guess this warning is junk as interface derivation is flat */
986 g_warning ("cannot add sub-interface `%s' to type `%s' which does not conform to super-interface `%s'",
992 /* allow overriding of interface type introduced for parent type */
993 entry = type_lookup_iface_entry_L (node, iface);
994 if (entry && entry->vtable == NULL && !type_iface_peek_holder_L (iface, NODE_TYPE (node)))
996 /* ok, we do conform to this interface already, but the interface vtable was not
997 * yet intialized, and we just conform to the interface because it got added to
998 * one of our parents. so we allow overriding of holder info here.
1002 /* check whether one of our children already conforms (or whether the interface
1003 * got added to this node already)
1005 tnode = find_conforming_child_type_L (node, iface); /* tnode is_a node */
1008 g_warning ("cannot add interface type `%s' to type `%s', since type `%s' already conforms to interface",
1014 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1015 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1017 tnode = lookup_type_node_I (prerequisites[i]);
1018 if (!type_node_is_a_L (node, tnode))
1020 g_warning ("cannot add interface type `%s' to type `%s' which does not conform to prerequisite `%s'",
1031 check_interface_info_I (TypeNode *iface,
1032 GType instance_type,
1033 const GInterfaceInfo *info)
1035 if ((info->interface_finalize || info->interface_data) && !info->interface_init)
1037 g_warning ("interface type `%s' for type `%s' comes without initializer",
1039 type_descriptive_name_I (instance_type));
1046 /* --- type info (type node data) --- */
1048 type_data_make_W (TypeNode *node,
1049 const GTypeInfo *info,
1050 const GTypeValueTable *value_table)
1053 GTypeValueTable *vtable = NULL;
1054 guint vtable_size = 0;
1056 g_assert (node->data == NULL && info != NULL);
1060 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1063 vtable = pnode->data->common.value_table;
1066 static const GTypeValueTable zero_vtable = { NULL, };
1068 value_table = &zero_vtable;
1073 /* need to setup vtable_size since we have to allocate it with data in one chunk */
1074 vtable_size = sizeof (GTypeValueTable);
1075 if (value_table->collect_format)
1076 vtable_size += strlen (value_table->collect_format);
1077 if (value_table->lcopy_format)
1078 vtable_size += strlen (value_table->lcopy_format);
1082 if (node->is_instantiatable) /* careful, is_instantiatable is also is_classed */
1084 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1086 data = g_malloc0 (sizeof (InstanceData) + vtable_size);
1088 vtable = G_STRUCT_MEMBER_P (data, sizeof (InstanceData));
1089 data->instance.class_size = info->class_size;
1090 data->instance.class_init_base = info->base_init;
1091 data->instance.class_finalize_base = info->base_finalize;
1092 data->instance.class_init = info->class_init;
1093 data->instance.class_finalize = info->class_finalize;
1094 data->instance.class_data = info->class_data;
1095 data->instance.class = NULL;
1096 data->instance.init_state = UNINITIALIZED;
1097 data->instance.instance_size = info->instance_size;
1098 /* We'll set the final value for data->instance.private size
1099 * after the parent class has been initialized
1101 data->instance.private_size = 0;
1102 data->instance.class_private_size = 0;
1104 data->instance.class_private_size = pnode->data->instance.class_private_size;
1105 #ifdef DISABLE_MEM_POOLS
1106 data->instance.n_preallocs = 0;
1107 #else /* !DISABLE_MEM_POOLS */
1108 data->instance.n_preallocs = MIN (info->n_preallocs, 1024);
1109 #endif /* !DISABLE_MEM_POOLS */
1110 data->instance.instance_init = info->instance_init;
1112 else if (node->is_classed) /* only classed */
1114 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1116 data = g_malloc0 (sizeof (ClassData) + vtable_size);
1118 vtable = G_STRUCT_MEMBER_P (data, sizeof (ClassData));
1119 data->class.class_size = info->class_size;
1120 data->class.class_init_base = info->base_init;
1121 data->class.class_finalize_base = info->base_finalize;
1122 data->class.class_init = info->class_init;
1123 data->class.class_finalize = info->class_finalize;
1124 data->class.class_data = info->class_data;
1125 data->class.class = NULL;
1126 data->class.class_private_size = 0;
1128 data->class.class_private_size = pnode->data->class.class_private_size;
1129 data->class.init_state = UNINITIALIZED;
1131 else if (NODE_IS_IFACE (node))
1133 data = g_malloc0 (sizeof (IFaceData) + vtable_size);
1135 vtable = G_STRUCT_MEMBER_P (data, sizeof (IFaceData));
1136 data->iface.vtable_size = info->class_size;
1137 data->iface.vtable_init_base = info->base_init;
1138 data->iface.vtable_finalize_base = info->base_finalize;
1139 data->iface.dflt_init = info->class_init;
1140 data->iface.dflt_finalize = info->class_finalize;
1141 data->iface.dflt_data = info->class_data;
1142 data->iface.dflt_vtable = NULL;
1144 else if (NODE_IS_BOXED (node))
1146 data = g_malloc0 (sizeof (BoxedData) + vtable_size);
1148 vtable = G_STRUCT_MEMBER_P (data, sizeof (BoxedData));
1152 data = g_malloc0 (sizeof (CommonData) + vtable_size);
1154 vtable = G_STRUCT_MEMBER_P (data, sizeof (CommonData));
1163 /* we allocate the vtable and its strings together with the type data, so
1164 * children can take over their parent's vtable pointer, and we don't
1165 * need to worry freeing it or not when the child data is destroyed
1167 *vtable = *value_table;
1168 p = G_STRUCT_MEMBER_P (vtable, sizeof (*vtable));
1170 vtable->collect_format = p;
1171 if (value_table->collect_format)
1173 strcat (p, value_table->collect_format);
1174 p += strlen (value_table->collect_format);
1178 vtable->lcopy_format = p;
1179 if (value_table->lcopy_format)
1180 strcat (p, value_table->lcopy_format);
1182 node->data->common.value_table = vtable;
1183 node->mutatable_check_cache = (node->data->common.value_table->value_init != NULL &&
1184 !((G_TYPE_FLAG_VALUE_ABSTRACT | G_TYPE_FLAG_ABSTRACT) &
1185 GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))));
1187 g_assert (node->data->common.value_table != NULL); /* paranoid */
1189 g_atomic_int_set ((int *) &node->ref_count, 1);
1193 type_data_ref_Wm (TypeNode *node)
1197 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1199 GTypeValueTable tmp_value_table;
1201 g_assert (node->plugin != NULL);
1205 type_data_ref_Wm (pnode);
1207 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1210 memset (&tmp_info, 0, sizeof (tmp_info));
1211 memset (&tmp_value_table, 0, sizeof (tmp_value_table));
1213 G_WRITE_UNLOCK (&type_rw_lock);
1214 g_type_plugin_use (node->plugin);
1215 g_type_plugin_complete_type_info (node->plugin, NODE_TYPE (node), &tmp_info, &tmp_value_table);
1216 G_WRITE_LOCK (&type_rw_lock);
1218 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1220 check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (node), NODE_NAME (node), &tmp_info);
1221 type_data_make_W (node, &tmp_info,
1222 check_value_table_I (NODE_NAME (node),
1223 &tmp_value_table) ? &tmp_value_table : NULL);
1227 g_assert (NODE_REFCOUNT (node) > 0);
1229 g_atomic_int_inc ((int *) &node->ref_count);
1233 static inline gboolean
1234 type_data_ref_U (TypeNode *node)
1239 current = NODE_REFCOUNT (node);
1243 } while (!g_atomic_int_compare_and_exchange ((int *) &node->ref_count, current, current + 1));
1249 iface_node_has_available_offset_L (TypeNode *iface_node,
1255 offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->_prot.offsets, guint8);
1256 if (offsets == NULL)
1259 if (G_ATOMIC_ARRAY_DATA_SIZE (offsets) <= offset)
1262 if (offsets[offset] == 0 ||
1263 offsets[offset] == for_index+1)
1270 find_free_iface_offset_L (IFaceEntries *entries)
1273 TypeNode *iface_node;
1278 n_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1283 for (i = 0; i < n_entries; i++)
1285 entry = &entries->entry[i];
1286 iface_node = lookup_type_node_I (entry->iface_type);
1288 if (!iface_node_has_available_offset_L (iface_node, offset, i))
1292 while (i != n_entries);
1298 iface_node_set_offset_L (TypeNode *iface_node,
1302 guint8 *offsets, *old_offsets;
1303 int new_size, old_size;
1306 old_offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->_prot.offsets, guint8);
1307 if (old_offsets == NULL)
1311 old_size = G_ATOMIC_ARRAY_DATA_SIZE (old_offsets);
1312 if (offset < old_size &&
1313 old_offsets[offset] == index + 1)
1314 return; /* Already set to this index, return */
1316 new_size = MAX (old_size, offset + 1);
1318 offsets = _g_atomic_array_copy (&iface_node->_prot.offsets,
1319 0, new_size - old_size);
1321 /* Mark new area as unused */
1322 for (i = old_size; i < new_size; i++)
1325 offsets[offset] = index + 1;
1327 _g_atomic_array_update (&iface_node->_prot.offsets, offsets);
1331 type_node_add_iface_entry_W (TypeNode *node,
1333 IFaceEntry *parent_entry)
1335 IFaceEntries *entries;
1337 TypeNode *iface_node;
1341 g_assert (node->is_instantiatable);
1343 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
1344 if (entries != NULL)
1346 num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1348 g_assert (num_entries < MAX_N_INTERFACES);
1350 for (i = 0; i < num_entries; i++)
1352 entry = &entries->entry[i];
1353 if (entry->iface_type == iface_type)
1355 /* this can happen in two cases:
1356 * - our parent type already conformed to iface_type and node
1357 * got its own holder info. here, our children already have
1358 * entries and NULL vtables, since this will only work for
1359 * uninitialized classes.
1360 * - an interface type is added to an ancestor after it was
1361 * added to a child type.
1364 g_assert (entry->vtable == NULL && entry->init_state == UNINITIALIZED);
1367 /* sick, interface is added to ancestor *after* child type;
1368 * nothing todo, the entry and our children were already setup correctly
1376 entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (node),
1377 IFACE_ENTRIES_HEADER_SIZE,
1378 sizeof (IFaceEntry));
1379 num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1380 i = num_entries - 1;
1382 entries->offset_index = 0;
1383 entries->entry[i].iface_type = iface_type;
1384 entries->entry[i].vtable = NULL;
1385 entries->entry[i].init_state = UNINITIALIZED;
1389 if (node->data && node->data->class.init_state >= BASE_IFACE_INIT)
1391 entries->entry[i].init_state = INITIALIZED;
1392 entries->entry[i].vtable = parent_entry->vtable;
1396 /* Update offsets in iface */
1397 iface_node = lookup_type_node_I (iface_type);
1399 if (iface_node_has_available_offset_L (iface_node,
1400 entries->offset_index,
1403 iface_node_set_offset_L (iface_node,
1404 entries->offset_index, i);
1408 entries->offset_index =
1409 find_free_iface_offset_L (entries);
1410 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
1412 entry = &entries->entry[j];
1414 lookup_type_node_I (entry->iface_type);
1415 iface_node_set_offset_L (iface_node,
1416 entries->offset_index, j);
1420 _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node), entries);
1424 for (i = 0; i < node->n_children; i++)
1425 type_node_add_iface_entry_W (lookup_type_node_I (node->children[i]), iface_type, &entries->entry[i]);
1430 type_add_interface_Wm (TypeNode *node,
1432 const GInterfaceInfo *info,
1433 GTypePlugin *plugin)
1435 IFaceHolder *iholder = g_new0 (IFaceHolder, 1);
1439 g_assert (node->is_instantiatable && NODE_IS_IFACE (iface) && ((info && !plugin) || (!info && plugin)));
1441 iholder->next = iface_node_get_holders_L (iface);
1442 iface_node_set_holders_W (iface, iholder);
1443 iholder->instance_type = NODE_TYPE (node);
1444 iholder->info = info ? g_memdup (info, sizeof (*info)) : NULL;
1445 iholder->plugin = plugin;
1447 /* create an iface entry for this type */
1448 type_node_add_iface_entry_W (node, NODE_TYPE (iface), NULL);
1450 /* if the class is already (partly) initialized, we may need to base
1451 * initalize and/or initialize the new interface.
1455 InitState class_state = node->data->class.init_state;
1457 if (class_state >= BASE_IFACE_INIT)
1458 type_iface_vtable_base_init_Wm (iface, node);
1460 if (class_state >= IFACE_INIT)
1461 type_iface_vtable_iface_init_Wm (iface, node);
1464 /* create iface entries for children of this type */
1465 entry = type_lookup_iface_entry_L (node, iface);
1466 for (i = 0; i < node->n_children; i++)
1467 type_node_add_iface_entry_W (lookup_type_node_I (node->children[i]), NODE_TYPE (iface), entry);
1471 type_iface_add_prerequisite_W (TypeNode *iface,
1472 TypeNode *prerequisite_node)
1474 GType prerequisite_type = NODE_TYPE (prerequisite_node);
1475 GType *prerequisites, *dependants;
1476 guint n_dependants, i;
1478 g_assert (NODE_IS_IFACE (iface) &&
1479 IFACE_NODE_N_PREREQUISITES (iface) < MAX_N_PREREQUISITES &&
1480 (prerequisite_node->is_instantiatable || NODE_IS_IFACE (prerequisite_node)));
1482 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1483 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1484 if (prerequisites[i] == prerequisite_type)
1485 return; /* we already have that prerequisiste */
1486 else if (prerequisites[i] > prerequisite_type)
1488 IFACE_NODE_N_PREREQUISITES (iface) += 1;
1489 IFACE_NODE_PREREQUISITES (iface) = g_renew (GType,
1490 IFACE_NODE_PREREQUISITES (iface),
1491 IFACE_NODE_N_PREREQUISITES (iface));
1492 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1493 g_memmove (prerequisites + i + 1, prerequisites + i,
1494 sizeof (prerequisites[0]) * (IFACE_NODE_N_PREREQUISITES (iface) - i - 1));
1495 prerequisites[i] = prerequisite_type;
1497 /* we want to get notified when prerequisites get added to prerequisite_node */
1498 if (NODE_IS_IFACE (prerequisite_node))
1500 dependants = iface_node_get_dependants_array_L (prerequisite_node);
1501 n_dependants = dependants ? dependants[0] : 0;
1503 dependants = g_renew (GType, dependants, n_dependants + 1);
1504 dependants[n_dependants] = NODE_TYPE (iface);
1505 dependants[0] = n_dependants;
1506 iface_node_set_dependants_array_W (prerequisite_node, dependants);
1509 /* we need to notify all dependants */
1510 dependants = iface_node_get_dependants_array_L (iface);
1511 n_dependants = dependants ? dependants[0] : 0;
1512 for (i = 1; i <= n_dependants; i++)
1513 type_iface_add_prerequisite_W (lookup_type_node_I (dependants[i]), prerequisite_node);
1517 * g_type_interface_add_prerequisite:
1518 * @interface_type: #GType value of an interface type.
1519 * @prerequisite_type: #GType value of an interface or instantiatable type.
1521 * Adds @prerequisite_type to the list of prerequisites of @interface_type.
1522 * This means that any type implementing @interface_type must also implement
1523 * @prerequisite_type. Prerequisites can be thought of as an alternative to
1524 * interface derivation (which GType doesn't support). An interface can have
1525 * at most one instantiatable prerequisite type.
1528 g_type_interface_add_prerequisite (GType interface_type,
1529 GType prerequisite_type)
1531 TypeNode *iface, *prerequisite_node;
1532 IFaceHolder *holders;
1534 g_return_if_fail (G_TYPE_IS_INTERFACE (interface_type)); /* G_TYPE_IS_INTERFACE() is an external call: _U */
1535 g_return_if_fail (!g_type_is_a (interface_type, prerequisite_type));
1536 g_return_if_fail (!g_type_is_a (prerequisite_type, interface_type));
1538 iface = lookup_type_node_I (interface_type);
1539 prerequisite_node = lookup_type_node_I (prerequisite_type);
1540 if (!iface || !prerequisite_node || !NODE_IS_IFACE (iface))
1542 g_warning ("interface type `%s' or prerequisite type `%s' invalid",
1543 type_descriptive_name_I (interface_type),
1544 type_descriptive_name_I (prerequisite_type));
1547 G_WRITE_LOCK (&type_rw_lock);
1548 holders = iface_node_get_holders_L (iface);
1551 G_WRITE_UNLOCK (&type_rw_lock);
1552 g_warning ("unable to add prerequisite `%s' to interface `%s' which is already in use for `%s'",
1553 type_descriptive_name_I (prerequisite_type),
1554 type_descriptive_name_I (interface_type),
1555 type_descriptive_name_I (holders->instance_type));
1558 if (prerequisite_node->is_instantiatable)
1562 /* can have at most one publicly installable instantiatable prerequisite */
1563 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1565 TypeNode *prnode = lookup_type_node_I (IFACE_NODE_PREREQUISITES (iface)[i]);
1567 if (prnode->is_instantiatable)
1569 G_WRITE_UNLOCK (&type_rw_lock);
1570 g_warning ("adding prerequisite `%s' to interface `%s' conflicts with existing prerequisite `%s'",
1571 type_descriptive_name_I (prerequisite_type),
1572 type_descriptive_name_I (interface_type),
1573 type_descriptive_name_I (NODE_TYPE (prnode)));
1578 for (i = 0; i < prerequisite_node->n_supers + 1; i++)
1579 type_iface_add_prerequisite_W (iface, lookup_type_node_I (prerequisite_node->supers[i]));
1580 G_WRITE_UNLOCK (&type_rw_lock);
1582 else if (NODE_IS_IFACE (prerequisite_node))
1584 GType *prerequisites;
1587 prerequisites = IFACE_NODE_PREREQUISITES (prerequisite_node);
1588 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (prerequisite_node); i++)
1589 type_iface_add_prerequisite_W (iface, lookup_type_node_I (prerequisites[i]));
1590 type_iface_add_prerequisite_W (iface, prerequisite_node);
1591 G_WRITE_UNLOCK (&type_rw_lock);
1595 G_WRITE_UNLOCK (&type_rw_lock);
1596 g_warning ("prerequisite `%s' for interface `%s' is neither instantiatable nor interface",
1597 type_descriptive_name_I (prerequisite_type),
1598 type_descriptive_name_I (interface_type));
1603 * g_type_interface_prerequisites:
1604 * @interface_type: an interface type
1605 * @n_prerequisites: (out) (allow-none): location to return the number
1606 * of prerequisites, or %NULL
1608 * Returns the prerequisites of an interfaces type.
1612 * Returns: (array length=n_prerequisites) (transfer full): a
1613 * newly-allocated zero-terminated array of #GType containing
1614 * the prerequisites of @interface_type
1617 g_type_interface_prerequisites (GType interface_type,
1618 guint *n_prerequisites)
1622 g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL);
1624 iface = lookup_type_node_I (interface_type);
1628 TypeNode *inode = NULL;
1631 G_READ_LOCK (&type_rw_lock);
1632 types = g_new0 (GType, IFACE_NODE_N_PREREQUISITES (iface) + 1);
1633 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1635 GType prerequisite = IFACE_NODE_PREREQUISITES (iface)[i];
1636 TypeNode *node = lookup_type_node_I (prerequisite);
1637 if (node->is_instantiatable)
1639 if (!inode || type_node_is_a_L (node, inode))
1643 types[n++] = NODE_TYPE (node);
1646 types[n++] = NODE_TYPE (inode);
1648 if (n_prerequisites)
1649 *n_prerequisites = n;
1650 G_READ_UNLOCK (&type_rw_lock);
1656 if (n_prerequisites)
1657 *n_prerequisites = 0;
1665 type_iface_peek_holder_L (TypeNode *iface,
1666 GType instance_type)
1668 IFaceHolder *iholder;
1670 g_assert (NODE_IS_IFACE (iface));
1672 iholder = iface_node_get_holders_L (iface);
1673 while (iholder && iholder->instance_type != instance_type)
1674 iholder = iholder->next;
1679 type_iface_retrieve_holder_info_Wm (TypeNode *iface,
1680 GType instance_type,
1683 IFaceHolder *iholder = type_iface_peek_holder_L (iface, instance_type);
1685 if (iholder && !iholder->info && need_info)
1687 GInterfaceInfo tmp_info;
1689 g_assert (iholder->plugin != NULL);
1691 type_data_ref_Wm (iface);
1693 INVALID_RECURSION ("g_type_plugin_*", iface->plugin, NODE_NAME (iface));
1695 memset (&tmp_info, 0, sizeof (tmp_info));
1697 G_WRITE_UNLOCK (&type_rw_lock);
1698 g_type_plugin_use (iholder->plugin);
1699 g_type_plugin_complete_interface_info (iholder->plugin, instance_type, NODE_TYPE (iface), &tmp_info);
1700 G_WRITE_LOCK (&type_rw_lock);
1702 INVALID_RECURSION ("g_type_plugin_*", iholder->plugin, NODE_NAME (iface));
1704 check_interface_info_I (iface, instance_type, &tmp_info);
1705 iholder->info = g_memdup (&tmp_info, sizeof (tmp_info));
1708 return iholder; /* we don't modify write lock upon returning NULL */
1712 type_iface_blow_holder_info_Wm (TypeNode *iface,
1713 GType instance_type)
1715 IFaceHolder *iholder = iface_node_get_holders_L (iface);
1717 g_assert (NODE_IS_IFACE (iface));
1719 while (iholder->instance_type != instance_type)
1720 iholder = iholder->next;
1722 if (iholder->info && iholder->plugin)
1724 g_free (iholder->info);
1725 iholder->info = NULL;
1727 G_WRITE_UNLOCK (&type_rw_lock);
1728 g_type_plugin_unuse (iholder->plugin);
1729 type_data_unref_U (iface, FALSE);
1730 G_WRITE_LOCK (&type_rw_lock);
1734 /* Assumes type's class already exists
1736 static inline size_t
1737 type_total_instance_size_I (TypeNode *node)
1739 gsize total_instance_size;
1741 total_instance_size = node->data->instance.instance_size;
1742 if (node->data->instance.private_size != 0)
1743 total_instance_size = ALIGN_STRUCT (total_instance_size) + node->data->instance.private_size;
1745 return total_instance_size;
1748 /* --- type structure creation/destruction --- */
1752 } InstanceRealClass;
1755 instance_real_class_cmp (gconstpointer p1,
1758 const InstanceRealClass *irc1 = p1;
1759 const InstanceRealClass *irc2 = p2;
1760 guint8 *i1 = irc1->instance;
1761 guint8 *i2 = irc2->instance;
1762 return G_BSEARCH_ARRAY_CMP (i1, i2);
1765 G_LOCK_DEFINE_STATIC (instance_real_class);
1766 static GBSearchArray *instance_real_class_bsa = NULL;
1767 static GBSearchConfig instance_real_class_bconfig = {
1768 sizeof (InstanceRealClass),
1769 instance_real_class_cmp,
1774 instance_real_class_set (gpointer instance,
1777 InstanceRealClass key;
1778 key.instance = instance;
1780 G_LOCK (instance_real_class);
1781 if (!instance_real_class_bsa)
1782 instance_real_class_bsa = g_bsearch_array_create (&instance_real_class_bconfig);
1783 instance_real_class_bsa = g_bsearch_array_replace (instance_real_class_bsa, &instance_real_class_bconfig, &key);
1784 G_UNLOCK (instance_real_class);
1788 instance_real_class_remove (gpointer instance)
1790 InstanceRealClass key, *node;
1792 key.instance = instance;
1793 G_LOCK (instance_real_class);
1794 node = g_bsearch_array_lookup (instance_real_class_bsa, &instance_real_class_bconfig, &key);
1795 index = g_bsearch_array_get_index (instance_real_class_bsa, &instance_real_class_bconfig, node);
1796 instance_real_class_bsa = g_bsearch_array_remove (instance_real_class_bsa, &instance_real_class_bconfig, index);
1797 if (!g_bsearch_array_get_n_nodes (instance_real_class_bsa))
1799 g_bsearch_array_free (instance_real_class_bsa, &instance_real_class_bconfig);
1800 instance_real_class_bsa = NULL;
1802 G_UNLOCK (instance_real_class);
1805 static inline GTypeClass*
1806 instance_real_class_get (gpointer instance)
1808 InstanceRealClass key, *node;
1810 key.instance = instance;
1811 G_LOCK (instance_real_class);
1812 node = instance_real_class_bsa ? g_bsearch_array_lookup (instance_real_class_bsa, &instance_real_class_bconfig, &key) : NULL;
1813 class = node ? node->class : NULL;
1814 G_UNLOCK (instance_real_class);
1819 * g_type_create_instance: (skip)
1820 * @type: An instantiatable type to create an instance for.
1822 * Creates and initializes an instance of @type if @type is valid and
1823 * can be instantiated. The type system only performs basic allocation
1824 * and structure setups for instances: actual instance creation should
1825 * happen through functions supplied by the type's fundamental type
1826 * implementation. So use of g_type_create_instance() is reserved for
1827 * implementators of fundamental types only. E.g. instances of the
1828 * #GObject hierarchy should be created via g_object_new() and
1829 * <emphasis>never</emphasis> directly through
1830 * g_type_create_instance() which doesn't handle things like singleton
1831 * objects or object construction. Note: Do <emphasis>not</emphasis>
1832 * use this function, unless you're implementing a fundamental
1833 * type. Also language bindings should <emphasis>not</emphasis> use
1834 * this function but g_object_new() instead.
1836 * Returns: An allocated and initialized instance, subject to further
1837 * treatment by the fundamental type implementation.
1840 g_type_create_instance (GType type)
1843 GTypeInstance *instance;
1845 guint i, total_size;
1847 node = lookup_type_node_I (type);
1848 if (!node || !node->is_instantiatable)
1850 g_warning ("cannot create new instance of invalid (non-instantiatable) type `%s'",
1851 type_descriptive_name_I (type));
1854 /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1855 if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (type))
1857 g_warning ("cannot create instance of abstract (non-instantiatable) type `%s'",
1858 type_descriptive_name_I (type));
1862 class = g_type_class_ref (type);
1863 total_size = type_total_instance_size_I (node);
1865 instance = g_slice_alloc0 (total_size);
1867 if (node->data->instance.private_size)
1868 instance_real_class_set (instance, class);
1869 for (i = node->n_supers; i > 0; i--)
1873 pnode = lookup_type_node_I (node->supers[i]);
1874 if (pnode->data->instance.instance_init)
1876 instance->g_class = pnode->data->instance.class;
1877 pnode->data->instance.instance_init (instance, class);
1880 if (node->data->instance.private_size)
1881 instance_real_class_remove (instance);
1883 instance->g_class = class;
1884 if (node->data->instance.instance_init)
1885 node->data->instance.instance_init (instance, class);
1887 TRACE(GOBJECT_OBJECT_NEW(instance, type));
1893 * g_type_free_instance:
1894 * @instance: an instance of a type.
1896 * Frees an instance of a type, returning it to the instance pool for
1897 * the type, if there is one.
1899 * Like g_type_create_instance(), this function is reserved for
1900 * implementors of fundamental types.
1903 g_type_free_instance (GTypeInstance *instance)
1908 g_return_if_fail (instance != NULL && instance->g_class != NULL);
1910 class = instance->g_class;
1911 node = lookup_type_node_I (class->g_type);
1912 if (!node || !node->is_instantiatable || !node->data || node->data->class.class != (gpointer) class)
1914 g_warning ("cannot free instance of invalid (non-instantiatable) type `%s'",
1915 type_descriptive_name_I (class->g_type));
1918 /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1919 if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (NODE_TYPE (node)))
1921 g_warning ("cannot free instance of abstract (non-instantiatable) type `%s'",
1926 instance->g_class = NULL;
1927 #ifdef G_ENABLE_DEBUG
1928 memset (instance, 0xaa, type_total_instance_size_I (node));
1930 g_slice_free1 (type_total_instance_size_I (node), instance);
1932 g_type_class_unref (class);
1936 type_iface_ensure_dflt_vtable_Wm (TypeNode *iface)
1938 g_assert (iface->data);
1940 if (!iface->data->iface.dflt_vtable)
1942 GTypeInterface *vtable = g_malloc0 (iface->data->iface.vtable_size);
1943 iface->data->iface.dflt_vtable = vtable;
1944 vtable->g_type = NODE_TYPE (iface);
1945 vtable->g_instance_type = 0;
1946 if (iface->data->iface.vtable_init_base ||
1947 iface->data->iface.dflt_init)
1949 G_WRITE_UNLOCK (&type_rw_lock);
1950 if (iface->data->iface.vtable_init_base)
1951 iface->data->iface.vtable_init_base (vtable);
1952 if (iface->data->iface.dflt_init)
1953 iface->data->iface.dflt_init (vtable, (gpointer) iface->data->iface.dflt_data);
1954 G_WRITE_LOCK (&type_rw_lock);
1960 /* This is called to allocate and do the first part of initializing
1961 * the interface vtable; type_iface_vtable_iface_init_Wm() does the remainder.
1963 * A FALSE return indicates that we didn't find an init function for
1964 * this type/iface pair, so the vtable from the parent type should
1965 * be used. Note that the write lock is not modified upon a FALSE
1969 type_iface_vtable_base_init_Wm (TypeNode *iface,
1973 IFaceHolder *iholder;
1974 GTypeInterface *vtable = NULL;
1977 /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
1978 iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), TRUE);
1980 return FALSE; /* we don't modify write lock upon FALSE */
1982 type_iface_ensure_dflt_vtable_Wm (iface);
1984 entry = type_lookup_iface_entry_L (node, iface);
1986 g_assert (iface->data && entry && entry->vtable == NULL && iholder && iholder->info);
1988 entry->init_state = IFACE_INIT;
1990 pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1991 if (pnode) /* want to copy over parent iface contents */
1993 IFaceEntry *pentry = type_lookup_iface_entry_L (pnode, iface);
1996 vtable = g_memdup (pentry->vtable, iface->data->iface.vtable_size);
1999 vtable = g_memdup (iface->data->iface.dflt_vtable, iface->data->iface.vtable_size);
2000 entry->vtable = vtable;
2001 vtable->g_type = NODE_TYPE (iface);
2002 vtable->g_instance_type = NODE_TYPE (node);
2004 if (iface->data->iface.vtable_init_base)
2006 G_WRITE_UNLOCK (&type_rw_lock);
2007 iface->data->iface.vtable_init_base (vtable);
2008 G_WRITE_LOCK (&type_rw_lock);
2010 return TRUE; /* initialized the vtable */
2013 /* Finishes what type_iface_vtable_base_init_Wm started by
2014 * calling the interface init function.
2015 * this function may only be called for types with their
2016 * own interface holder info, i.e. types for which
2017 * g_type_add_interface*() was called and not children thereof.
2020 type_iface_vtable_iface_init_Wm (TypeNode *iface,
2023 IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2024 IFaceHolder *iholder = type_iface_peek_holder_L (iface, NODE_TYPE (node));
2025 GTypeInterface *vtable = NULL;
2028 /* iholder->info should have been filled in by type_iface_vtable_base_init_Wm() */
2029 g_assert (iface->data && entry && iholder && iholder->info);
2030 g_assert (entry->init_state == IFACE_INIT); /* assert prior base_init() */
2032 entry->init_state = INITIALIZED;
2034 vtable = entry->vtable;
2036 if (iholder->info->interface_init)
2038 G_WRITE_UNLOCK (&type_rw_lock);
2039 if (iholder->info->interface_init)
2040 iholder->info->interface_init (vtable, iholder->info->interface_data);
2041 G_WRITE_LOCK (&type_rw_lock);
2044 for (i = 0; i < static_n_iface_check_funcs; i++)
2046 GTypeInterfaceCheckFunc check_func = static_iface_check_funcs[i].check_func;
2047 gpointer check_data = static_iface_check_funcs[i].check_data;
2049 G_WRITE_UNLOCK (&type_rw_lock);
2050 check_func (check_data, (gpointer)vtable);
2051 G_WRITE_LOCK (&type_rw_lock);
2056 type_iface_vtable_finalize_Wm (TypeNode *iface,
2058 GTypeInterface *vtable)
2060 IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2061 IFaceHolder *iholder;
2063 /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
2064 iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), FALSE);
2066 return FALSE; /* we don't modify write lock upon FALSE */
2068 g_assert (entry && entry->vtable == vtable && iholder->info);
2070 entry->vtable = NULL;
2071 entry->init_state = UNINITIALIZED;
2072 if (iholder->info->interface_finalize || iface->data->iface.vtable_finalize_base)
2074 G_WRITE_UNLOCK (&type_rw_lock);
2075 if (iholder->info->interface_finalize)
2076 iholder->info->interface_finalize (vtable, iholder->info->interface_data);
2077 if (iface->data->iface.vtable_finalize_base)
2078 iface->data->iface.vtable_finalize_base (vtable);
2079 G_WRITE_LOCK (&type_rw_lock);
2082 vtable->g_instance_type = 0;
2085 type_iface_blow_holder_info_Wm (iface, NODE_TYPE (node));
2087 return TRUE; /* write lock modified */
2091 type_class_init_Wm (TypeNode *node,
2094 GSList *slist, *init_slist = NULL;
2096 IFaceEntries *entries;
2098 TypeNode *bnode, *pnode;
2101 /* Accessing data->class will work for instantiable types
2102 * too because ClassData is a subset of InstanceData
2104 g_assert (node->is_classed && node->data &&
2105 node->data->class.class_size &&
2106 !node->data->class.class &&
2107 node->data->class.init_state == UNINITIALIZED);
2108 if (node->data->class.class_private_size)
2109 class = g_malloc0 (ALIGN_STRUCT (node->data->class.class_size) + node->data->class.class_private_size);
2111 class = g_malloc0 (node->data->class.class_size);
2112 node->data->class.class = class;
2113 g_atomic_int_set (&node->data->class.init_state, BASE_CLASS_INIT);
2117 TypeNode *pnode = lookup_type_node_I (pclass->g_type);
2119 memcpy (class, pclass, pnode->data->class.class_size);
2120 memcpy (G_STRUCT_MEMBER_P (class, ALIGN_STRUCT (node->data->class.class_size)), G_STRUCT_MEMBER_P (pclass, ALIGN_STRUCT (pnode->data->class.class_size)), pnode->data->class.class_private_size);
2122 if (node->is_instantiatable)
2124 /* We need to initialize the private_size here rather than in
2125 * type_data_make_W() since the class init for the parent
2126 * class may have changed pnode->data->instance.private_size.
2128 node->data->instance.private_size = pnode->data->instance.private_size;
2131 class->g_type = NODE_TYPE (node);
2133 G_WRITE_UNLOCK (&type_rw_lock);
2135 /* stack all base class initialization functions, so we
2136 * call them in ascending order.
2138 for (bnode = node; bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2139 if (bnode->data->class.class_init_base)
2140 init_slist = g_slist_prepend (init_slist, (gpointer) bnode->data->class.class_init_base);
2141 for (slist = init_slist; slist; slist = slist->next)
2143 GBaseInitFunc class_init_base = (GBaseInitFunc) slist->data;
2145 class_init_base (class);
2147 g_slist_free (init_slist);
2149 G_WRITE_LOCK (&type_rw_lock);
2151 g_atomic_int_set (&node->data->class.init_state, BASE_IFACE_INIT);
2153 /* Before we initialize the class, base initialize all interfaces, either
2154 * from parent, or through our holder info
2156 pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
2159 while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL &&
2160 i < IFACE_ENTRIES_N_ENTRIES (entries))
2162 entry = &entries->entry[i];
2163 while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2164 entry->init_state == IFACE_INIT)
2170 if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2173 if (!type_iface_vtable_base_init_Wm (lookup_type_node_I (entry->iface_type), node))
2176 IFaceEntries *pentries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (pnode);
2178 /* need to get this interface from parent, type_iface_vtable_base_init_Wm()
2179 * doesn't modify write lock upon FALSE, so entry is still valid;
2181 g_assert (pnode != NULL);
2184 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (pentries); j++)
2186 IFaceEntry *pentry = &pentries->entry[j];
2188 if (pentry->iface_type == entry->iface_type)
2190 entry->vtable = pentry->vtable;
2191 entry->init_state = INITIALIZED;
2195 g_assert (entry->vtable != NULL);
2198 /* If the write lock was released, additional interface entries might
2199 * have been inserted into CLASSED_NODE_IFACES_ENTRIES (node); they'll
2200 * be base-initialized when inserted, so we don't have to worry that
2201 * we might miss them. Uninitialized entries can only be moved higher
2202 * when new ones are inserted.
2207 g_atomic_int_set (&node->data->class.init_state, CLASS_INIT);
2209 G_WRITE_UNLOCK (&type_rw_lock);
2211 if (node->data->class.class_init)
2212 node->data->class.class_init (class, (gpointer) node->data->class.class_data);
2214 G_WRITE_LOCK (&type_rw_lock);
2216 g_atomic_int_set (&node->data->class.init_state, IFACE_INIT);
2218 /* finish initializing the interfaces through our holder info.
2219 * inherited interfaces are already init_state == INITIALIZED, because
2220 * they either got setup in the above base_init loop, or during
2221 * class_init from within type_add_interface_Wm() for this or
2222 * an anchestor type.
2225 while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL)
2227 entry = &entries->entry[i];
2228 while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2229 entry->init_state == INITIALIZED)
2235 if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2238 type_iface_vtable_iface_init_Wm (lookup_type_node_I (entry->iface_type), node);
2240 /* As in the loop above, additional initialized entries might be inserted
2241 * if the write lock is released, but that's harmless because the entries
2242 * we need to initialize only move higher in the list.
2247 g_atomic_int_set (&node->data->class.init_state, INITIALIZED);
2251 type_data_finalize_class_ifaces_Wm (TypeNode *node)
2254 IFaceEntries *entries;
2256 g_assert (node->is_instantiatable && node->data && node->data->class.class && NODE_REFCOUNT (node) == 0);
2259 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
2260 for (i = 0; entries != NULL && i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
2262 IFaceEntry *entry = &entries->entry[i];
2265 if (type_iface_vtable_finalize_Wm (lookup_type_node_I (entry->iface_type), node, entry->vtable))
2267 /* refetch entries, IFACES_ENTRIES might be modified */
2272 /* type_iface_vtable_finalize_Wm() doesn't modify write lock upon FALSE,
2273 * iface vtable came from parent
2275 entry->vtable = NULL;
2276 entry->init_state = UNINITIALIZED;
2283 type_data_finalize_class_U (TypeNode *node,
2286 GTypeClass *class = cdata->class;
2289 g_assert (cdata->class && NODE_REFCOUNT (node) == 0);
2291 if (cdata->class_finalize)
2292 cdata->class_finalize (class, (gpointer) cdata->class_data);
2294 /* call all base class destruction functions in descending order
2296 if (cdata->class_finalize_base)
2297 cdata->class_finalize_base (class);
2298 for (bnode = lookup_type_node_I (NODE_PARENT_TYPE (node)); bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2299 if (bnode->data->class.class_finalize_base)
2300 bnode->data->class.class_finalize_base (class);
2302 g_free (cdata->class);
2306 type_data_last_unref_Wm (TypeNode *node,
2309 g_return_if_fail (node != NULL && node->plugin != NULL);
2311 if (!node->data || NODE_REFCOUNT (node) == 0)
2313 g_warning ("cannot drop last reference to unreferenced type `%s'",
2318 /* call class cache hooks */
2319 if (node->is_classed && node->data && node->data->class.class && static_n_class_cache_funcs && !uncached)
2323 G_WRITE_UNLOCK (&type_rw_lock);
2324 G_READ_LOCK (&type_rw_lock);
2325 for (i = 0; i < static_n_class_cache_funcs; i++)
2327 GTypeClassCacheFunc cache_func = static_class_cache_funcs[i].cache_func;
2328 gpointer cache_data = static_class_cache_funcs[i].cache_data;
2329 gboolean need_break;
2331 G_READ_UNLOCK (&type_rw_lock);
2332 need_break = cache_func (cache_data, node->data->class.class);
2333 G_READ_LOCK (&type_rw_lock);
2334 if (!node->data || NODE_REFCOUNT (node) == 0)
2335 INVALID_RECURSION ("GType class cache function ", cache_func, NODE_NAME (node));
2339 G_READ_UNLOCK (&type_rw_lock);
2340 G_WRITE_LOCK (&type_rw_lock);
2343 /* may have been re-referenced meanwhile */
2344 if (g_atomic_int_dec_and_test ((int *) &node->ref_count))
2346 GType ptype = NODE_PARENT_TYPE (node);
2349 if (node->is_instantiatable)
2351 /* destroy node->data->instance.mem_chunk */
2355 if (node->is_classed && tdata->class.class)
2357 if (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node) != NULL)
2358 type_data_finalize_class_ifaces_Wm (node);
2359 node->mutatable_check_cache = FALSE;
2361 G_WRITE_UNLOCK (&type_rw_lock);
2362 type_data_finalize_class_U (node, &tdata->class);
2363 G_WRITE_LOCK (&type_rw_lock);
2365 else if (NODE_IS_IFACE (node) && tdata->iface.dflt_vtable)
2367 node->mutatable_check_cache = FALSE;
2369 if (tdata->iface.dflt_finalize || tdata->iface.vtable_finalize_base)
2371 G_WRITE_UNLOCK (&type_rw_lock);
2372 if (tdata->iface.dflt_finalize)
2373 tdata->iface.dflt_finalize (tdata->iface.dflt_vtable, (gpointer) tdata->iface.dflt_data);
2374 if (tdata->iface.vtable_finalize_base)
2375 tdata->iface.vtable_finalize_base (tdata->iface.dflt_vtable);
2376 G_WRITE_LOCK (&type_rw_lock);
2378 g_free (tdata->iface.dflt_vtable);
2382 node->mutatable_check_cache = FALSE;
2386 /* freeing tdata->common.value_table and its contents is taken care of
2387 * by allocating it in one chunk with tdata
2391 G_WRITE_UNLOCK (&type_rw_lock);
2392 g_type_plugin_unuse (node->plugin);
2394 type_data_unref_U (lookup_type_node_I (ptype), FALSE);
2395 G_WRITE_LOCK (&type_rw_lock);
2400 type_data_unref_U (TypeNode *node,
2406 current = NODE_REFCOUNT (node);
2412 g_warning ("static type `%s' unreferenced too often",
2417 g_assert (current > 0);
2419 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2420 G_WRITE_LOCK (&type_rw_lock);
2421 type_data_last_unref_Wm (node, uncached);
2422 G_WRITE_UNLOCK (&type_rw_lock);
2423 g_rec_mutex_unlock (&class_init_rec_mutex);
2426 } while (!g_atomic_int_compare_and_exchange ((int *) &node->ref_count, current, current - 1));
2430 * g_type_add_class_cache_func: (skip)
2431 * @cache_data: data to be passed to @cache_func
2432 * @cache_func: a #GTypeClassCacheFunc
2434 * Adds a #GTypeClassCacheFunc to be called before the reference count of a
2435 * class goes from one to zero. This can be used to prevent premature class
2436 * destruction. All installed #GTypeClassCacheFunc functions will be chained
2437 * until one of them returns %TRUE. The functions have to check the class id
2438 * passed in to figure whether they actually want to cache the class of this
2439 * type, since all classes are routed through the same #GTypeClassCacheFunc
2443 g_type_add_class_cache_func (gpointer cache_data,
2444 GTypeClassCacheFunc cache_func)
2448 g_return_if_fail (cache_func != NULL);
2450 G_WRITE_LOCK (&type_rw_lock);
2451 i = static_n_class_cache_funcs++;
2452 static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2453 static_class_cache_funcs[i].cache_data = cache_data;
2454 static_class_cache_funcs[i].cache_func = cache_func;
2455 G_WRITE_UNLOCK (&type_rw_lock);
2459 * g_type_remove_class_cache_func: (skip)
2460 * @cache_data: data that was given when adding @cache_func
2461 * @cache_func: a #GTypeClassCacheFunc
2463 * Removes a previously installed #GTypeClassCacheFunc. The cache
2464 * maintained by @cache_func has to be empty when calling
2465 * g_type_remove_class_cache_func() to avoid leaks.
2468 g_type_remove_class_cache_func (gpointer cache_data,
2469 GTypeClassCacheFunc cache_func)
2471 gboolean found_it = FALSE;
2474 g_return_if_fail (cache_func != NULL);
2476 G_WRITE_LOCK (&type_rw_lock);
2477 for (i = 0; i < static_n_class_cache_funcs; i++)
2478 if (static_class_cache_funcs[i].cache_data == cache_data &&
2479 static_class_cache_funcs[i].cache_func == cache_func)
2481 static_n_class_cache_funcs--;
2482 g_memmove (static_class_cache_funcs + i,
2483 static_class_cache_funcs + i + 1,
2484 sizeof (static_class_cache_funcs[0]) * (static_n_class_cache_funcs - i));
2485 static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2489 G_WRITE_UNLOCK (&type_rw_lock);
2492 g_warning (G_STRLOC ": cannot remove unregistered class cache func %p with data %p",
2493 cache_func, cache_data);
2498 * g_type_add_interface_check: (skip)
2499 * @check_data: data to pass to @check_func
2500 * @check_func: function to be called after each interface
2503 * Adds a function to be called after an interface vtable is
2504 * initialized for any class (i.e. after the @interface_init member of
2505 * #GInterfaceInfo has been called).
2507 * This function is useful when you want to check an invariant that
2508 * depends on the interfaces of a class. For instance, the
2509 * implementation of #GObject uses this facility to check that an
2510 * object implements all of the properties that are defined on its
2516 g_type_add_interface_check (gpointer check_data,
2517 GTypeInterfaceCheckFunc check_func)
2521 g_return_if_fail (check_func != NULL);
2523 G_WRITE_LOCK (&type_rw_lock);
2524 i = static_n_iface_check_funcs++;
2525 static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2526 static_iface_check_funcs[i].check_data = check_data;
2527 static_iface_check_funcs[i].check_func = check_func;
2528 G_WRITE_UNLOCK (&type_rw_lock);
2532 * g_type_remove_interface_check: (skip)
2533 * @check_data: callback data passed to g_type_add_interface_check()
2534 * @check_func: callback function passed to g_type_add_interface_check()
2536 * Removes an interface check function added with
2537 * g_type_add_interface_check().
2542 g_type_remove_interface_check (gpointer check_data,
2543 GTypeInterfaceCheckFunc check_func)
2545 gboolean found_it = FALSE;
2548 g_return_if_fail (check_func != NULL);
2550 G_WRITE_LOCK (&type_rw_lock);
2551 for (i = 0; i < static_n_iface_check_funcs; i++)
2552 if (static_iface_check_funcs[i].check_data == check_data &&
2553 static_iface_check_funcs[i].check_func == check_func)
2555 static_n_iface_check_funcs--;
2556 g_memmove (static_iface_check_funcs + i,
2557 static_iface_check_funcs + i + 1,
2558 sizeof (static_iface_check_funcs[0]) * (static_n_iface_check_funcs - i));
2559 static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2563 G_WRITE_UNLOCK (&type_rw_lock);
2566 g_warning (G_STRLOC ": cannot remove unregistered class check func %p with data %p",
2567 check_func, check_data);
2570 /* --- type registration --- */
2572 * g_type_register_fundamental:
2573 * @type_id: A predefined type identifier.
2574 * @type_name: 0-terminated string used as the name of the new type.
2575 * @info: The #GTypeInfo structure for this type.
2576 * @finfo: The #GTypeFundamentalInfo structure for this type.
2577 * @flags: Bitwise combination of #GTypeFlags values.
2579 * Registers @type_id as the predefined identifier and @type_name as the
2580 * name of a fundamental type. The type system uses the information
2581 * contained in the #GTypeInfo structure pointed to by @info and the
2582 * #GTypeFundamentalInfo structure pointed to by @finfo to manage the
2583 * type and its instances. The value of @flags determines additional
2584 * characteristics of the fundamental type.
2586 * Returns: The predefined type identifier.
2589 g_type_register_fundamental (GType type_id,
2590 const gchar *type_name,
2591 const GTypeInfo *info,
2592 const GTypeFundamentalInfo *finfo,
2597 g_return_val_if_type_system_uninitialized (0);
2598 g_return_val_if_fail (type_id > 0, 0);
2599 g_return_val_if_fail (type_name != NULL, 0);
2600 g_return_val_if_fail (info != NULL, 0);
2601 g_return_val_if_fail (finfo != NULL, 0);
2603 if (!check_type_name_I (type_name))
2605 if ((type_id & TYPE_ID_MASK) ||
2606 type_id > G_TYPE_FUNDAMENTAL_MAX)
2608 g_warning ("attempt to register fundamental type `%s' with invalid type id (%" G_GSIZE_FORMAT ")",
2613 if ((finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
2614 !(finfo->type_flags & G_TYPE_FLAG_CLASSED))
2616 g_warning ("cannot register instantiatable fundamental type `%s' as non-classed",
2620 if (lookup_type_node_I (type_id))
2622 g_warning ("cannot register existing fundamental type `%s' (as `%s')",
2623 type_descriptive_name_I (type_id),
2628 G_WRITE_LOCK (&type_rw_lock);
2629 node = type_node_fundamental_new_W (type_id, type_name, finfo->type_flags);
2630 type_add_flags_W (node, flags);
2632 if (check_type_info_I (NULL, NODE_FUNDAMENTAL_TYPE (node), type_name, info))
2633 type_data_make_W (node, info,
2634 check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2635 G_WRITE_UNLOCK (&type_rw_lock);
2637 return NODE_TYPE (node);
2641 * g_type_register_static_simple: (skip)
2642 * @parent_type: Type from which this type will be derived.
2643 * @type_name: 0-terminated string used as the name of the new type.
2644 * @class_size: Size of the class structure (see #GTypeInfo)
2645 * @class_init: Location of the class initialization function (see #GTypeInfo)
2646 * @instance_size: Size of the instance structure (see #GTypeInfo)
2647 * @instance_init: Location of the instance initialization function (see #GTypeInfo)
2648 * @flags: Bitwise combination of #GTypeFlags values.
2650 * Registers @type_name as the name of a new static type derived from
2651 * @parent_type. The value of @flags determines the nature (e.g.
2652 * abstract or not) of the type. It works by filling a #GTypeInfo
2653 * struct and calling g_type_register_static().
2657 * Returns: The new type identifier.
2660 g_type_register_static_simple (GType parent_type,
2661 const gchar *type_name,
2663 GClassInitFunc class_init,
2664 guint instance_size,
2665 GInstanceInitFunc instance_init,
2670 info.class_size = class_size;
2671 info.base_init = NULL;
2672 info.base_finalize = NULL;
2673 info.class_init = class_init;
2674 info.class_finalize = NULL;
2675 info.class_data = NULL;
2676 info.instance_size = instance_size;
2677 info.n_preallocs = 0;
2678 info.instance_init = instance_init;
2679 info.value_table = NULL;
2681 return g_type_register_static (parent_type, type_name, &info, flags);
2685 * g_type_register_static:
2686 * @parent_type: Type from which this type will be derived.
2687 * @type_name: 0-terminated string used as the name of the new type.
2688 * @info: The #GTypeInfo structure for this type.
2689 * @flags: Bitwise combination of #GTypeFlags values.
2691 * Registers @type_name as the name of a new static type derived from
2692 * @parent_type. The type system uses the information contained in the
2693 * #GTypeInfo structure pointed to by @info to manage the type and its
2694 * instances (if not abstract). The value of @flags determines the nature
2695 * (e.g. abstract or not) of the type.
2697 * Returns: The new type identifier.
2700 g_type_register_static (GType parent_type,
2701 const gchar *type_name,
2702 const GTypeInfo *info,
2705 TypeNode *pnode, *node;
2708 g_return_val_if_type_system_uninitialized (0);
2709 g_return_val_if_fail (parent_type > 0, 0);
2710 g_return_val_if_fail (type_name != NULL, 0);
2711 g_return_val_if_fail (info != NULL, 0);
2713 if (!check_type_name_I (type_name) ||
2714 !check_derivation_I (parent_type, type_name))
2716 if (info->class_finalize)
2718 g_warning ("class finalizer specified for static type `%s'",
2723 pnode = lookup_type_node_I (parent_type);
2724 G_WRITE_LOCK (&type_rw_lock);
2725 type_data_ref_Wm (pnode);
2726 if (check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (pnode), type_name, info))
2728 node = type_node_new_W (pnode, type_name, NULL);
2729 type_add_flags_W (node, flags);
2730 type = NODE_TYPE (node);
2731 type_data_make_W (node, info,
2732 check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2734 G_WRITE_UNLOCK (&type_rw_lock);
2740 * g_type_register_dynamic:
2741 * @parent_type: Type from which this type will be derived.
2742 * @type_name: 0-terminated string used as the name of the new type.
2743 * @plugin: The #GTypePlugin structure to retrieve the #GTypeInfo from.
2744 * @flags: Bitwise combination of #GTypeFlags values.
2746 * Registers @type_name as the name of a new dynamic type derived from
2747 * @parent_type. The type system uses the information contained in the
2748 * #GTypePlugin structure pointed to by @plugin to manage the type and its
2749 * instances (if not abstract). The value of @flags determines the nature
2750 * (e.g. abstract or not) of the type.
2752 * Returns: The new type identifier or #G_TYPE_INVALID if registration failed.
2755 g_type_register_dynamic (GType parent_type,
2756 const gchar *type_name,
2757 GTypePlugin *plugin,
2760 TypeNode *pnode, *node;
2763 g_return_val_if_type_system_uninitialized (0);
2764 g_return_val_if_fail (parent_type > 0, 0);
2765 g_return_val_if_fail (type_name != NULL, 0);
2766 g_return_val_if_fail (plugin != NULL, 0);
2768 if (!check_type_name_I (type_name) ||
2769 !check_derivation_I (parent_type, type_name) ||
2770 !check_plugin_U (plugin, TRUE, FALSE, type_name))
2773 G_WRITE_LOCK (&type_rw_lock);
2774 pnode = lookup_type_node_I (parent_type);
2775 node = type_node_new_W (pnode, type_name, plugin);
2776 type_add_flags_W (node, flags);
2777 type = NODE_TYPE (node);
2778 G_WRITE_UNLOCK (&type_rw_lock);
2784 * g_type_add_interface_static:
2785 * @instance_type: #GType value of an instantiable type.
2786 * @interface_type: #GType value of an interface type.
2787 * @info: The #GInterfaceInfo structure for this
2788 * (@instance_type, @interface_type) combination.
2790 * Adds the static @interface_type to @instantiable_type. The
2791 * information contained in the #GInterfaceInfo structure pointed to by
2792 * @info is used to manage the relationship.
2795 g_type_add_interface_static (GType instance_type,
2796 GType interface_type,
2797 const GInterfaceInfo *info)
2799 /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2800 g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2801 g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2803 /* we only need to lock class_init_rec_mutex if instance_type already has its
2804 * class initialized, however this function is rarely enough called to take
2805 * the simple route and always acquire class_init_rec_mutex.
2807 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2808 G_WRITE_LOCK (&type_rw_lock);
2809 if (check_add_interface_L (instance_type, interface_type))
2811 TypeNode *node = lookup_type_node_I (instance_type);
2812 TypeNode *iface = lookup_type_node_I (interface_type);
2813 if (check_interface_info_I (iface, NODE_TYPE (node), info))
2814 type_add_interface_Wm (node, iface, info, NULL);
2816 G_WRITE_UNLOCK (&type_rw_lock);
2817 g_rec_mutex_unlock (&class_init_rec_mutex);
2821 * g_type_add_interface_dynamic:
2822 * @instance_type: the #GType value of an instantiable type.
2823 * @interface_type: the #GType value of an interface type.
2824 * @plugin: the #GTypePlugin structure to retrieve the #GInterfaceInfo from.
2826 * Adds the dynamic @interface_type to @instantiable_type. The information
2827 * contained in the #GTypePlugin structure pointed to by @plugin
2828 * is used to manage the relationship.
2831 g_type_add_interface_dynamic (GType instance_type,
2832 GType interface_type,
2833 GTypePlugin *plugin)
2836 /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2837 g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2838 g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2840 node = lookup_type_node_I (instance_type);
2841 if (!check_plugin_U (plugin, FALSE, TRUE, NODE_NAME (node)))
2844 /* see comment in g_type_add_interface_static() about class_init_rec_mutex */
2845 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2846 G_WRITE_LOCK (&type_rw_lock);
2847 if (check_add_interface_L (instance_type, interface_type))
2849 TypeNode *iface = lookup_type_node_I (interface_type);
2850 type_add_interface_Wm (node, iface, NULL, plugin);
2852 G_WRITE_UNLOCK (&type_rw_lock);
2853 g_rec_mutex_unlock (&class_init_rec_mutex);
2857 /* --- public API functions --- */
2860 * @type: Type ID of a classed type.
2862 * Increments the reference count of the class structure belonging to
2863 * @type. This function will demand-create the class if it doesn't
2866 * Returns: (type GObject.TypeClass) (transfer none): The #GTypeClass
2867 * structure for the given type ID.
2870 g_type_class_ref (GType type)
2877 /* optimize for common code path */
2878 node = lookup_type_node_I (type);
2879 if (!node || !node->is_classed)
2881 g_warning ("cannot retrieve class for invalid (unclassed) type `%s'",
2882 type_descriptive_name_I (type));
2886 if (G_LIKELY (type_data_ref_U (node)))
2888 if (G_LIKELY (g_atomic_int_get (&node->data->class.init_state) == INITIALIZED))
2889 return node->data->class.class;
2895 /* here, we either have node->data->class.class == NULL, or a recursive
2896 * call to g_type_class_ref() with a partly initialized class, or
2897 * node->data->class.init_state == INITIALIZED, because any
2898 * concurrently running initialization was guarded by class_init_rec_mutex.
2900 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2902 /* we need an initialized parent class for initializing derived classes */
2903 ptype = NODE_PARENT_TYPE (node);
2904 pclass = ptype ? g_type_class_ref (ptype) : NULL;
2906 G_WRITE_LOCK (&type_rw_lock);
2909 type_data_ref_Wm (node);
2911 if (!node->data->class.class) /* class uninitialized */
2912 type_class_init_Wm (node, pclass);
2914 G_WRITE_UNLOCK (&type_rw_lock);
2917 g_type_class_unref (pclass);
2919 g_rec_mutex_unlock (&class_init_rec_mutex);
2921 return node->data->class.class;
2925 * g_type_class_unref:
2926 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to
2929 * Decrements the reference count of the class structure being passed in.
2930 * Once the last reference count of a class has been released, classes
2931 * may be finalized by the type system, so further dereferencing of a
2932 * class pointer after g_type_class_unref() are invalid.
2935 g_type_class_unref (gpointer g_class)
2938 GTypeClass *class = g_class;
2940 g_return_if_fail (g_class != NULL);
2942 node = lookup_type_node_I (class->g_type);
2943 if (node && node->is_classed && NODE_REFCOUNT (node))
2944 type_data_unref_U (node, FALSE);
2946 g_warning ("cannot unreference class of invalid (unclassed) type `%s'",
2947 type_descriptive_name_I (class->g_type));
2951 * g_type_class_unref_uncached: (skip)
2952 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to
2955 * A variant of g_type_class_unref() for use in #GTypeClassCacheFunc
2956 * implementations. It unreferences a class without consulting the chain
2957 * of #GTypeClassCacheFunc<!-- -->s, avoiding the recursion which would occur
2961 g_type_class_unref_uncached (gpointer g_class)
2964 GTypeClass *class = g_class;
2966 g_return_if_fail (g_class != NULL);
2968 node = lookup_type_node_I (class->g_type);
2969 if (node && node->is_classed && NODE_REFCOUNT (node))
2970 type_data_unref_U (node, TRUE);
2972 g_warning ("cannot unreference class of invalid (unclassed) type `%s'",
2973 type_descriptive_name_I (class->g_type));
2977 * g_type_class_peek:
2978 * @type: Type ID of a classed type.
2980 * This function is essentially the same as g_type_class_ref(), except that
2981 * the classes reference count isn't incremented. As a consequence, this function
2982 * may return %NULL if the class of the type passed in does not currently
2983 * exist (hasn't been referenced before).
2985 * Returns: (type GObject.TypeClass) (transfer none): The #GTypeClass
2986 * structure for the given type ID or %NULL if the class does not
2990 g_type_class_peek (GType type)
2995 node = lookup_type_node_I (type);
2996 if (node && node->is_classed && NODE_REFCOUNT (node) &&
2997 g_atomic_int_get (&node->data->class.init_state) == INITIALIZED)
2998 /* ref_count _may_ be 0 */
2999 class = node->data->class.class;
3007 * g_type_class_peek_static:
3008 * @type: Type ID of a classed type.
3010 * A more efficient version of g_type_class_peek() which works only for
3014 * Returns: (type GObject.TypeClass) (transfer none): The #GTypeClass
3015 * structure for the given type ID or %NULL if the class does not
3016 * currently exist or is dynamically loaded.
3019 g_type_class_peek_static (GType type)
3024 node = lookup_type_node_I (type);
3025 if (node && node->is_classed && NODE_REFCOUNT (node) &&
3026 /* peek only static types: */ node->plugin == NULL &&
3027 g_atomic_int_get (&node->data->class.init_state) == INITIALIZED)
3028 /* ref_count _may_ be 0 */
3029 class = node->data->class.class;
3037 * g_type_class_peek_parent:
3038 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to
3039 * retrieve the parent class for.
3041 * This is a convenience function often needed in class initializers.
3042 * It returns the class structure of the immediate parent type of the
3043 * class passed in. Since derived classes hold a reference count on
3044 * their parent classes as long as they are instantiated, the returned
3045 * class will always exist. This function is essentially equivalent
3049 * g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)));
3052 * Returns: (type GObject.TypeClass) (transfer none): The parent class
3056 g_type_class_peek_parent (gpointer g_class)
3059 gpointer class = NULL;
3061 g_return_val_if_fail (g_class != NULL, NULL);
3063 node = lookup_type_node_I (G_TYPE_FROM_CLASS (g_class));
3064 /* We used to acquire a read lock here. That is not necessary, since
3065 * parent->data->class.class is constant as long as the derived class
3068 if (node && node->is_classed && node->data && NODE_PARENT_TYPE (node))
3070 node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3071 class = node->data->class.class;
3073 else if (NODE_PARENT_TYPE (node))
3074 g_warning (G_STRLOC ": invalid class pointer `%p'", g_class);
3080 * g_type_interface_peek:
3081 * @instance_class: (type GObject.TypeClass): A #GTypeClass structure.
3082 * @iface_type: An interface ID which this class conforms to.
3084 * Returns the #GTypeInterface structure of an interface to which the
3085 * passed in class conforms.
3087 * Returns: (type GObject.TypeInterface) (transfer none): The GTypeInterface
3088 * structure of iface_type if implemented by @instance_class, %NULL
3092 g_type_interface_peek (gpointer instance_class,
3097 gpointer vtable = NULL;
3098 GTypeClass *class = instance_class;
3100 g_return_val_if_fail (instance_class != NULL, NULL);
3102 node = lookup_type_node_I (class->g_type);
3103 iface = lookup_type_node_I (iface_type);
3104 if (node && node->is_instantiatable && iface)
3105 type_lookup_iface_vtable_I (node, iface, &vtable);
3107 g_warning (G_STRLOC ": invalid class pointer `%p'", class);
3113 * g_type_interface_peek_parent:
3114 * @g_iface: (type GObject.TypeInterface): A #GTypeInterface structure.
3116 * Returns the corresponding #GTypeInterface structure of the parent type
3117 * of the instance type to which @g_iface belongs. This is useful when
3118 * deriving the implementation of an interface from the parent type and
3119 * then possibly overriding some methods.
3121 * Returns: (transfer none) (type GObject.TypeInterface): The
3122 * corresponding #GTypeInterface structure of the parent type of the
3123 * instance type to which @g_iface belongs, or %NULL if the parent
3124 * type doesn't conform to the interface.
3127 g_type_interface_peek_parent (gpointer g_iface)
3131 gpointer vtable = NULL;
3132 GTypeInterface *iface_class = g_iface;
3134 g_return_val_if_fail (g_iface != NULL, NULL);
3136 iface = lookup_type_node_I (iface_class->g_type);
3137 node = lookup_type_node_I (iface_class->g_instance_type);
3139 node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3140 if (node && node->is_instantiatable && iface)
3141 type_lookup_iface_vtable_I (node, iface, &vtable);
3143 g_warning (G_STRLOC ": invalid interface pointer `%p'", g_iface);
3149 * g_type_default_interface_ref:
3150 * @g_type: an interface type
3152 * Increments the reference count for the interface type @g_type,
3153 * and returns the default interface vtable for the type.
3155 * If the type is not currently in use, then the default vtable
3156 * for the type will be created and initalized by calling
3157 * the base interface init and default vtable init functions for
3158 * the type (the @<structfield>base_init</structfield>
3159 * and <structfield>class_init</structfield> members of #GTypeInfo).
3160 * Calling g_type_default_interface_ref() is useful when you
3161 * want to make sure that signals and properties for an interface
3162 * have been installed.
3166 * Returns: (type GObject.TypeInterface) (transfer none): the default
3167 * vtable for the interface; call g_type_default_interface_unref()
3168 * when you are done using the interface.
3171 g_type_default_interface_ref (GType g_type)
3174 gpointer dflt_vtable;
3176 G_WRITE_LOCK (&type_rw_lock);
3178 node = lookup_type_node_I (g_type);
3179 if (!node || !NODE_IS_IFACE (node) ||
3180 (node->data && NODE_REFCOUNT (node) == 0))
3182 G_WRITE_UNLOCK (&type_rw_lock);
3183 g_warning ("cannot retrieve default vtable for invalid or non-interface type '%s'",
3184 type_descriptive_name_I (g_type));
3188 if (!node->data || !node->data->iface.dflt_vtable)
3190 G_WRITE_UNLOCK (&type_rw_lock);
3191 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
3192 G_WRITE_LOCK (&type_rw_lock);
3193 node = lookup_type_node_I (g_type);
3194 type_data_ref_Wm (node);
3195 type_iface_ensure_dflt_vtable_Wm (node);
3196 g_rec_mutex_unlock (&class_init_rec_mutex);
3199 type_data_ref_Wm (node); /* ref_count >= 1 already */
3201 dflt_vtable = node->data->iface.dflt_vtable;
3202 G_WRITE_UNLOCK (&type_rw_lock);
3208 * g_type_default_interface_peek:
3209 * @g_type: an interface type
3211 * If the interface type @g_type is currently in use, returns its
3212 * default interface vtable.
3216 * Returns: (type GObject.TypeInterface) (transfer none): the default
3217 * vtable for the interface, or %NULL if the type is not currently in
3221 g_type_default_interface_peek (GType g_type)
3226 node = lookup_type_node_I (g_type);
3227 if (node && NODE_IS_IFACE (node) && NODE_REFCOUNT (node))
3228 vtable = node->data->iface.dflt_vtable;
3236 * g_type_default_interface_unref:
3237 * @g_iface: (type GObject.TypeInterface): the default vtable
3238 * structure for a interface, as returned by
3239 * g_type_default_interface_ref()
3241 * Decrements the reference count for the type corresponding to the
3242 * interface default vtable @g_iface. If the type is dynamic, then
3243 * when no one is using the interface and all references have
3244 * been released, the finalize function for the interface's default
3245 * vtable (the <structfield>class_finalize</structfield> member of
3246 * #GTypeInfo) will be called.
3251 g_type_default_interface_unref (gpointer g_iface)
3254 GTypeInterface *vtable = g_iface;
3256 g_return_if_fail (g_iface != NULL);
3258 node = lookup_type_node_I (vtable->g_type);
3259 if (node && NODE_IS_IFACE (node))
3260 type_data_unref_U (node, FALSE);
3262 g_warning ("cannot unreference invalid interface default vtable for '%s'",
3263 type_descriptive_name_I (vtable->g_type));
3268 * @type: Type to return name for.
3270 * Get the unique name that is assigned to a type ID. Note that this
3271 * function (like all other GType API) cannot cope with invalid type
3272 * IDs. %G_TYPE_INVALID may be passed to this function, as may be any
3273 * other validly registered type ID, but randomized type IDs should
3274 * not be passed in and will most likely lead to a crash.
3276 * Returns: Static type name or %NULL.
3279 g_type_name (GType type)
3283 g_return_val_if_type_system_uninitialized (NULL);
3285 node = lookup_type_node_I (type);
3287 return node ? NODE_NAME (node) : NULL;
3292 * @type: Type to return quark of type name for.
3294 * Get the corresponding quark of the type IDs name.
3296 * Returns: The type names quark or 0.
3299 g_type_qname (GType type)
3303 node = lookup_type_node_I (type);
3305 return node ? node->qname : 0;
3310 * @name: Type name to lookup.
3312 * Lookup the type ID from a given type name, returning 0 if no type
3313 * has been registered under this name (this is the preferred method
3314 * to find out by name whether a specific type has been registered
3317 * Returns: Corresponding type ID or 0.
3320 g_type_from_name (const gchar *name)
3324 g_return_val_if_fail (name != NULL, 0);
3326 G_READ_LOCK (&type_rw_lock);
3327 type = (GType) g_hash_table_lookup (static_type_nodes_ht, name);
3328 G_READ_UNLOCK (&type_rw_lock);
3335 * @type: The derived type.
3337 * Return the direct parent type of the passed in type. If the passed
3338 * in type has no parent, i.e. is a fundamental type, 0 is returned.
3340 * Returns: The parent type.
3343 g_type_parent (GType type)
3347 node = lookup_type_node_I (type);
3349 return node ? NODE_PARENT_TYPE (node) : 0;
3354 * @type: A #GType value.
3356 * Returns the length of the ancestry of the passed in type. This
3357 * includes the type itself, so that e.g. a fundamental type has depth 1.
3359 * Returns: The depth of @type.
3362 g_type_depth (GType type)
3366 node = lookup_type_node_I (type);
3368 return node ? node->n_supers + 1 : 0;
3373 * @leaf_type: Descendant of @root_type and the type to be returned.
3374 * @root_type: Immediate parent of the returned type.
3376 * Given a @leaf_type and a @root_type which is contained in its
3377 * anchestry, return the type that @root_type is the immediate parent
3378 * of. In other words, this function determines the type that is
3379 * derived directly from @root_type which is also a base class of
3380 * @leaf_type. Given a root type and a leaf type, this function can
3381 * be used to determine the types and order in which the leaf type is
3382 * descended from the root type.
3384 * Returns: Immediate child of @root_type and anchestor of @leaf_type.
3387 g_type_next_base (GType type,
3393 node = lookup_type_node_I (type);
3396 TypeNode *base_node = lookup_type_node_I (base_type);
3398 if (base_node && base_node->n_supers < node->n_supers)
3400 guint n = node->n_supers - base_node->n_supers;
3402 if (node->supers[n] == base_type)
3403 atype = node->supers[n - 1];
3410 static inline gboolean
3411 type_node_check_conformities_UorL (TypeNode *node,
3412 TypeNode *iface_node,
3413 /* support_inheritance */
3414 gboolean support_interfaces,
3415 gboolean support_prerequisites,
3420 if (/* support_inheritance && */
3421 NODE_IS_ANCESTOR (iface_node, node))
3424 support_interfaces = support_interfaces && node->is_instantiatable && NODE_IS_IFACE (iface_node);
3425 support_prerequisites = support_prerequisites && NODE_IS_IFACE (node);
3427 if (support_interfaces)
3431 if (type_lookup_iface_entry_L (node, iface_node))
3436 if (type_lookup_iface_vtable_I (node, iface_node, NULL))
3441 support_prerequisites)
3444 G_READ_LOCK (&type_rw_lock);
3445 if (support_prerequisites && type_lookup_prerequisite_L (node, NODE_TYPE (iface_node)))
3448 G_READ_UNLOCK (&type_rw_lock);
3454 type_node_is_a_L (TypeNode *node,
3455 TypeNode *iface_node)
3457 return type_node_check_conformities_UorL (node, iface_node, TRUE, TRUE, TRUE);
3460 static inline gboolean
3461 type_node_conforms_to_U (TypeNode *node,
3462 TypeNode *iface_node,
3463 gboolean support_interfaces,
3464 gboolean support_prerequisites)
3466 return type_node_check_conformities_UorL (node, iface_node, support_interfaces, support_prerequisites, FALSE);
3471 * @type: Type to check anchestry for.
3472 * @is_a_type: Possible anchestor of @type or interface @type could conform to.
3474 * If @is_a_type is a derivable type, check whether @type is a
3475 * descendant of @is_a_type. If @is_a_type is an interface, check
3476 * whether @type conforms to it.
3478 * Returns: %TRUE if @type is_a @is_a_type holds true.
3481 g_type_is_a (GType type,
3484 TypeNode *node, *iface_node;
3487 node = lookup_type_node_I (type);
3488 iface_node = lookup_type_node_I (iface_type);
3489 is_a = node && iface_node && type_node_conforms_to_U (node, iface_node, TRUE, TRUE);
3496 * @type: The parent type.
3497 * @n_children: (out) (allow-none): Optional #guint pointer to contain
3498 * the number of child types.
3500 * Return a newly allocated and 0-terminated array of type IDs, listing the
3501 * child types of @type. The return value has to be g_free()ed after use.
3503 * Returns: (array length=n_children) (transfer full): Newly allocated
3504 * and 0-terminated array of child types.
3507 g_type_children (GType type,
3512 node = lookup_type_node_I (type);
3517 G_READ_LOCK (&type_rw_lock); /* ->children is relocatable */
3518 children = g_new (GType, node->n_children + 1);
3519 memcpy (children, node->children, sizeof (GType) * node->n_children);
3520 children[node->n_children] = 0;
3523 *n_children = node->n_children;
3524 G_READ_UNLOCK (&type_rw_lock);
3538 * g_type_interfaces:
3539 * @type: The type to list interface types for.
3540 * @n_interfaces: (out) (allow-none): Optional #guint pointer to
3541 * contain the number of interface types.
3543 * Return a newly allocated and 0-terminated array of type IDs, listing the
3544 * interface types that @type conforms to. The return value has to be
3545 * g_free()ed after use.
3547 * Returns: (array length=n_interfaces) (transfer full): Newly
3548 * allocated and 0-terminated array of interface types.
3551 g_type_interfaces (GType type,
3552 guint *n_interfaces)
3556 node = lookup_type_node_I (type);
3557 if (node && node->is_instantiatable)
3559 IFaceEntries *entries;
3563 G_READ_LOCK (&type_rw_lock);
3564 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
3567 ifaces = g_new (GType, IFACE_ENTRIES_N_ENTRIES (entries) + 1);
3568 for (i = 0; i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
3569 ifaces[i] = entries->entry[i].iface_type;
3573 ifaces = g_new (GType, 1);
3580 G_READ_UNLOCK (&type_rw_lock);
3593 typedef struct _QData QData;
3605 static inline gpointer
3606 type_get_qdata_L (TypeNode *node,
3609 GData *gdata = node->global_gdata;
3611 if (quark && gdata && gdata->n_qdatas)
3613 QData *qdatas = gdata->qdatas - 1;
3614 guint n_qdatas = gdata->n_qdatas;
3621 i = (n_qdatas + 1) / 2;
3623 if (quark == check->quark)
3625 else if (quark > check->quark)
3630 else /* if (quark < check->quark) */
3641 * @quark: a #GQuark id to identify the data
3643 * Obtains data which has previously been attached to @type
3644 * with g_type_set_qdata().
3646 * Note that this does not take subtyping into account; data
3647 * attached to one type with g_type_set_qdata() cannot
3648 * be retrieved from a subtype using g_type_get_qdata().
3650 * Returns: (transfer none): the data, or %NULL if no data was found
3653 g_type_get_qdata (GType type,
3659 node = lookup_type_node_I (type);
3662 G_READ_LOCK (&type_rw_lock);
3663 data = type_get_qdata_L (node, quark);
3664 G_READ_UNLOCK (&type_rw_lock);
3668 g_return_val_if_fail (node != NULL, NULL);
3675 type_set_qdata_W (TypeNode *node,
3683 /* setup qdata list if necessary */
3684 if (!node->global_gdata)
3685 node->global_gdata = g_new0 (GData, 1);
3686 gdata = node->global_gdata;
3688 /* try resetting old data */
3689 qdata = gdata->qdatas;
3690 for (i = 0; i < gdata->n_qdatas; i++)
3691 if (qdata[i].quark == quark)
3693 qdata[i].data = data;
3699 gdata->qdatas = g_renew (QData, gdata->qdatas, gdata->n_qdatas);
3700 qdata = gdata->qdatas;
3701 for (i = 0; i < gdata->n_qdatas - 1; i++)
3702 if (qdata[i].quark > quark)
3704 g_memmove (qdata + i + 1, qdata + i, sizeof (qdata[0]) * (gdata->n_qdatas - i - 1));
3705 qdata[i].quark = quark;
3706 qdata[i].data = data;
3712 * @quark: a #GQuark id to identify the data
3715 * Attaches arbitrary data to a type.
3718 g_type_set_qdata (GType type,
3724 g_return_if_fail (quark != 0);
3726 node = lookup_type_node_I (type);
3729 G_WRITE_LOCK (&type_rw_lock);
3730 type_set_qdata_W (node, quark, data);
3731 G_WRITE_UNLOCK (&type_rw_lock);
3734 g_return_if_fail (node != NULL);
3738 type_add_flags_W (TypeNode *node,
3743 g_return_if_fail ((flags & ~TYPE_FLAG_MASK) == 0);
3744 g_return_if_fail (node != NULL);
3746 if ((flags & TYPE_FLAG_MASK) && node->is_classed && node->data && node->data->class.class)
3747 g_warning ("tagging type `%s' as abstract after class initialization", NODE_NAME (node));
3748 dflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
3750 type_set_qdata_W (node, static_quark_type_flags, GUINT_TO_POINTER (dflags));
3755 * @type: the #GType value of a static, classed type.
3756 * @query: (out caller-allocates): A user provided structure that is
3757 * filled in with constant values upon success.
3759 * Queries the type system for information about a specific type.
3760 * This function will fill in a user-provided structure to hold
3761 * type-specific information. If an invalid #GType is passed in, the
3762 * @type member of the #GTypeQuery is 0. All members filled into the
3763 * #GTypeQuery structure should be considered constant and have to be
3767 g_type_query (GType type,
3772 g_return_if_fail (query != NULL);
3774 /* if node is not static and classed, we won't allow query */
3776 node = lookup_type_node_I (type);
3777 if (node && node->is_classed && !node->plugin)
3779 /* type is classed and probably even instantiatable */
3780 G_READ_LOCK (&type_rw_lock);
3781 if (node->data) /* type is static or referenced */
3783 query->type = NODE_TYPE (node);
3784 query->type_name = NODE_NAME (node);
3785 query->class_size = node->data->class.class_size;
3786 query->instance_size = node->is_instantiatable ? node->data->instance.instance_size : 0;
3788 G_READ_UNLOCK (&type_rw_lock);
3793 /* --- implementation details --- */
3795 g_type_test_flags (GType type,
3799 gboolean result = FALSE;
3801 node = lookup_type_node_I (type);
3804 guint fflags = flags & TYPE_FUNDAMENTAL_FLAG_MASK;
3805 guint tflags = flags & TYPE_FLAG_MASK;
3809 GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (node);
3811 fflags = (finfo->type_flags & fflags) == fflags;
3818 G_READ_LOCK (&type_rw_lock);
3819 tflags = (tflags & GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))) == tflags;
3820 G_READ_UNLOCK (&type_rw_lock);
3825 result = tflags && fflags;
3832 * g_type_get_plugin:
3833 * @type: The #GType to retrieve the plugin for.
3835 * Returns the #GTypePlugin structure for @type or
3836 * %NULL if @type does not have a #GTypePlugin structure.
3838 * Returns: (transfer none): The corresponding plugin if @type is a
3839 * dynamic type, %NULL otherwise.
3842 g_type_get_plugin (GType type)
3846 node = lookup_type_node_I (type);
3848 return node ? node->plugin : NULL;
3852 * g_type_interface_get_plugin:
3853 * @instance_type: the #GType value of an instantiatable type.
3854 * @interface_type: the #GType value of an interface type.
3856 * Returns the #GTypePlugin structure for the dynamic interface
3857 * @interface_type which has been added to @instance_type, or %NULL if
3858 * @interface_type has not been added to @instance_type or does not
3859 * have a #GTypePlugin structure. See g_type_add_interface_dynamic().
3861 * Returns: (transfer none): the #GTypePlugin for the dynamic
3862 * interface @interface_type of @instance_type.
3865 g_type_interface_get_plugin (GType instance_type,
3866 GType interface_type)
3871 g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL); /* G_TYPE_IS_INTERFACE() is an external call: _U */
3873 node = lookup_type_node_I (instance_type);
3874 iface = lookup_type_node_I (interface_type);
3877 IFaceHolder *iholder;
3878 GTypePlugin *plugin;
3880 G_READ_LOCK (&type_rw_lock);
3882 iholder = iface_node_get_holders_L (iface);
3883 while (iholder && iholder->instance_type != instance_type)
3884 iholder = iholder->next;
3885 plugin = iholder ? iholder->plugin : NULL;
3887 G_READ_UNLOCK (&type_rw_lock);
3892 g_return_val_if_fail (node == NULL, NULL);
3893 g_return_val_if_fail (iface == NULL, NULL);
3895 g_warning (G_STRLOC ": attempt to look up plugin for invalid instance/interface type pair.");
3901 * g_type_fundamental_next:
3903 * Returns the next free fundamental type id which can be used to
3904 * register a new fundamental type with g_type_register_fundamental().
3905 * The returned type ID represents the highest currently registered
3906 * fundamental type identifier.
3908 * Returns: The nextmost fundamental type ID to be registered,
3909 * or 0 if the type system ran out of fundamental type IDs.
3912 g_type_fundamental_next (void)
3916 G_READ_LOCK (&type_rw_lock);
3917 type = static_fundamental_next;
3918 G_READ_UNLOCK (&type_rw_lock);
3919 type = G_TYPE_MAKE_FUNDAMENTAL (type);
3920 return type <= G_TYPE_FUNDAMENTAL_MAX ? type : 0;
3924 * g_type_fundamental:
3925 * @type_id: valid type ID
3927 * Internal function, used to extract the fundamental type ID portion.
3928 * use G_TYPE_FUNDAMENTAL() instead.
3930 * Returns: fundamental type ID
3933 g_type_fundamental (GType type_id)
3935 TypeNode *node = lookup_type_node_I (type_id);
3937 return node ? NODE_FUNDAMENTAL_TYPE (node) : 0;
3941 g_type_check_instance_is_a (GTypeInstance *type_instance,
3944 TypeNode *node, *iface;
3947 if (!type_instance || !type_instance->g_class)
3950 node = lookup_type_node_I (type_instance->g_class->g_type);
3951 iface = lookup_type_node_I (iface_type);
3952 check = node && node->is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
3958 g_type_check_class_is_a (GTypeClass *type_class,
3961 TypeNode *node, *iface;
3967 node = lookup_type_node_I (type_class->g_type);
3968 iface = lookup_type_node_I (is_a_type);
3969 check = node && node->is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
3975 g_type_check_instance_cast (GTypeInstance *type_instance,
3980 if (type_instance->g_class)
3982 TypeNode *node, *iface;
3983 gboolean is_instantiatable, check;
3985 node = lookup_type_node_I (type_instance->g_class->g_type);
3986 is_instantiatable = node && node->is_instantiatable;
3987 iface = lookup_type_node_I (iface_type);
3988 check = is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
3990 return type_instance;
3992 if (is_instantiatable)
3993 g_warning ("invalid cast from `%s' to `%s'",
3994 type_descriptive_name_I (type_instance->g_class->g_type),
3995 type_descriptive_name_I (iface_type));
3997 g_warning ("invalid uninstantiatable type `%s' in cast to `%s'",
3998 type_descriptive_name_I (type_instance->g_class->g_type),
3999 type_descriptive_name_I (iface_type));
4002 g_warning ("invalid unclassed pointer in cast to `%s'",
4003 type_descriptive_name_I (iface_type));
4006 return type_instance;
4010 g_type_check_class_cast (GTypeClass *type_class,
4015 TypeNode *node, *iface;
4016 gboolean is_classed, check;
4018 node = lookup_type_node_I (type_class->g_type);
4019 is_classed = node && node->is_classed;
4020 iface = lookup_type_node_I (is_a_type);
4021 check = is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
4026 g_warning ("invalid class cast from `%s' to `%s'",
4027 type_descriptive_name_I (type_class->g_type),
4028 type_descriptive_name_I (is_a_type));
4030 g_warning ("invalid unclassed type `%s' in class cast to `%s'",
4031 type_descriptive_name_I (type_class->g_type),
4032 type_descriptive_name_I (is_a_type));
4035 g_warning ("invalid class cast from (NULL) pointer to `%s'",
4036 type_descriptive_name_I (is_a_type));
4041 * g_type_check_instance:
4042 * @instance: A valid #GTypeInstance structure.
4044 * Private helper function to aid implementation of the G_TYPE_CHECK_INSTANCE()
4047 * @Returns: #TRUE if @instance is valid, #FALSE otherwise.
4050 g_type_check_instance (GTypeInstance *type_instance)
4052 /* this function is just here to make the signal system
4053 * conveniently elaborated on instance checks
4057 if (type_instance->g_class)
4059 TypeNode *node = lookup_type_node_I (type_instance->g_class->g_type);
4061 if (node && node->is_instantiatable)
4064 g_warning ("instance of invalid non-instantiatable type `%s'",
4065 type_descriptive_name_I (type_instance->g_class->g_type));
4068 g_warning ("instance with invalid (NULL) class pointer");
4071 g_warning ("invalid (NULL) pointer instance");
4076 static inline gboolean
4077 type_check_is_value_type_U (GType type)
4079 GTypeFlags tflags = G_TYPE_FLAG_VALUE_ABSTRACT;
4082 /* common path speed up */
4083 node = lookup_type_node_I (type);
4084 if (node && node->mutatable_check_cache)
4087 G_READ_LOCK (&type_rw_lock);
4091 if (node->data && NODE_REFCOUNT (node) > 0 &&
4092 node->data->common.value_table->value_init)
4093 tflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
4094 else if (NODE_IS_IFACE (node))
4098 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4100 GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4101 TypeNode *prnode = lookup_type_node_I (prtype);
4103 if (prnode->is_instantiatable)
4106 node = lookup_type_node_I (type);
4112 G_READ_UNLOCK (&type_rw_lock);
4114 return !(tflags & G_TYPE_FLAG_VALUE_ABSTRACT);
4118 g_type_check_is_value_type (GType type)
4120 return type_check_is_value_type_U (type);
4124 g_type_check_value (GValue *value)
4126 return value && type_check_is_value_type_U (value->g_type);
4130 g_type_check_value_holds (GValue *value,
4133 return value && type_check_is_value_type_U (value->g_type) && g_type_is_a (value->g_type, type);
4137 * g_type_value_table_peek: (skip)
4138 * @type: A #GType value.
4140 * Returns the location of the #GTypeValueTable associated with @type.
4141 * <emphasis>Note that this function should only be used from source code
4142 * that implements or has internal knowledge of the implementation of
4145 * Returns: Location of the #GTypeValueTable associated with @type or
4146 * %NULL if there is no #GTypeValueTable associated with @type.
4149 g_type_value_table_peek (GType type)
4151 GTypeValueTable *vtable = NULL;
4152 TypeNode *node = lookup_type_node_I (type);
4153 gboolean has_refed_data, has_table;
4155 if (node && NODE_REFCOUNT (node) && node->mutatable_check_cache)
4156 return node->data->common.value_table;
4158 G_READ_LOCK (&type_rw_lock);
4161 has_refed_data = node && node->data && NODE_REFCOUNT (node) > 0;
4162 has_table = has_refed_data && node->data->common.value_table->value_init;
4166 vtable = node->data->common.value_table;
4167 else if (NODE_IS_IFACE (node))
4171 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4173 GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4174 TypeNode *prnode = lookup_type_node_I (prtype);
4176 if (prnode->is_instantiatable)
4179 node = lookup_type_node_I (type);
4180 goto restart_table_peek;
4186 G_READ_UNLOCK (&type_rw_lock);
4192 g_warning (G_STRLOC ": type id `%" G_GSIZE_FORMAT "' is invalid", type);
4193 if (!has_refed_data)
4194 g_warning ("can't peek value table for type `%s' which is not currently referenced",
4195 type_descriptive_name_I (type));
4201 g_type_name_from_instance (GTypeInstance *instance)
4204 return "<NULL-instance>";
4206 return g_type_name_from_class (instance->g_class);
4210 g_type_name_from_class (GTypeClass *g_class)
4213 return "<NULL-class>";
4215 return g_type_name (g_class->g_type);
4219 /* --- private api for gboxed.c --- */
4221 _g_type_boxed_copy (GType type, gpointer value)
4223 TypeNode *node = lookup_type_node_I (type);
4225 return node->data->boxed.copy_func (value);
4229 _g_type_boxed_free (GType type, gpointer value)
4231 TypeNode *node = lookup_type_node_I (type);
4233 node->data->boxed.free_func (value);
4237 _g_type_boxed_init (GType type,
4238 GBoxedCopyFunc copy_func,
4239 GBoxedFreeFunc free_func)
4241 TypeNode *node = lookup_type_node_I (type);
4243 node->data->boxed.copy_func = copy_func;
4244 node->data->boxed.free_func = free_func;
4247 /* --- initialization --- */
4249 * g_type_init_with_debug_flags:
4250 * @debug_flags: Bitwise combination of #GTypeDebugFlags values for
4251 * debugging purposes.
4253 * Similar to g_type_init(), but additionally sets debug flags.
4256 g_type_init_with_debug_flags (GTypeDebugFlags debug_flags)
4258 G_LOCK_DEFINE_STATIC (type_init_lock);
4259 const gchar *env_string;
4262 volatile GType votype;
4264 if (!g_thread_get_initialized())
4265 g_thread_init (NULL);
4267 G_LOCK (type_init_lock);
4269 G_WRITE_LOCK (&type_rw_lock);
4271 if (static_quark_type_flags)
4273 G_WRITE_UNLOCK (&type_rw_lock);
4274 G_UNLOCK (type_init_lock);
4278 /* setup GObject library wide debugging flags */
4279 _g_type_debug_flags = debug_flags & G_TYPE_DEBUG_MASK;
4280 env_string = g_getenv ("GOBJECT_DEBUG");
4281 if (env_string != NULL)
4283 static GDebugKey debug_keys[] = {
4284 { "objects", G_TYPE_DEBUG_OBJECTS },
4285 { "signals", G_TYPE_DEBUG_SIGNALS },
4288 _g_type_debug_flags |= g_parse_debug_string (env_string,
4290 sizeof (debug_keys) / sizeof (debug_keys[0]));
4295 static_quark_type_flags = g_quark_from_static_string ("-g-type-private--GTypeFlags");
4296 static_quark_iface_holder = g_quark_from_static_string ("-g-type-private--IFaceHolder");
4297 static_quark_dependants_array = g_quark_from_static_string ("-g-type-private--dependants-array");
4299 /* type qname hash table */
4300 static_type_nodes_ht = g_hash_table_new (g_str_hash, g_str_equal);
4302 /* invalid type G_TYPE_INVALID (0)
4304 static_fundamental_type_nodes[0] = NULL;
4306 /* void type G_TYPE_NONE
4308 node = type_node_fundamental_new_W (G_TYPE_NONE, g_intern_static_string ("void"), 0);
4309 votype = NODE_TYPE (node);
4310 g_assert (votype == G_TYPE_NONE);
4312 /* interface fundamental type G_TYPE_INTERFACE (!classed)
4314 memset (&info, 0, sizeof (info));
4315 node = type_node_fundamental_new_W (G_TYPE_INTERFACE, g_intern_static_string ("GInterface"), G_TYPE_FLAG_DERIVABLE);
4316 votype = NODE_TYPE (node);
4317 type_data_make_W (node, &info, NULL);
4318 g_assert (votype == G_TYPE_INTERFACE);
4320 G_WRITE_UNLOCK (&type_rw_lock);
4324 /* G_TYPE_TYPE_PLUGIN
4326 votype = g_type_plugin_get_type ();
4328 /* G_TYPE_* value types
4330 _g_value_types_init ();
4332 /* G_TYPE_ENUM & G_TYPE_FLAGS
4334 _g_enum_types_init ();
4338 _g_boxed_type_init ();
4342 _g_param_type_init ();
4346 _g_object_type_init ();
4348 /* G_TYPE_PARAM_* pspec types
4350 _g_param_spec_types_init ();
4352 /* Value Transformations
4354 _g_value_transforms_init ();
4360 G_UNLOCK (type_init_lock);
4366 * Prior to any use of the type system, g_type_init() has to be called
4367 * to initialize the type system and assorted other code portions
4368 * (such as the various fundamental type implementations or the signal
4371 * Since version 2.24 this also initializes the thread system
4376 g_type_init_with_debug_flags (0);
4380 * g_type_class_add_private:
4381 * @g_class: class structure for an instantiatable type
4382 * @private_size: size of private structure.
4384 * Registers a private structure for an instantiatable type.
4386 * When an object is allocated, the private structures for
4387 * the type and all of its parent types are allocated
4388 * sequentially in the same memory block as the public
4391 * Note that the accumulated size of the private structures of
4392 * a type and all its parent types cannot excced 64kB.
4394 * This function should be called in the type's class_init() function.
4395 * The private structure can be retrieved using the
4396 * G_TYPE_INSTANCE_GET_PRIVATE() macro.
4398 * The following example shows attaching a private structure
4399 * <structname>MyObjectPrivate</structname> to an object
4400 * <structname>MyObject</structname> defined in the standard GObject
4402 * type's class_init() function.
4405 * typedef struct _MyObject MyObject;
4406 * typedef struct _MyObjectPrivate MyObjectPrivate;
4408 * struct _MyObject {
4411 * MyObjectPrivate *priv;
4414 * struct _MyObjectPrivate {
4419 * my_object_class_init (MyObjectClass *klass)
4421 * g_type_class_add_private (klass, sizeof (MyObjectPrivate));
4425 * my_object_init (MyObject *my_object)
4427 * my_object->priv = G_TYPE_INSTANCE_GET_PRIVATE (my_object,
4433 * my_object_get_some_field (MyObject *my_object)
4435 * MyObjectPrivate *priv = my_object->priv;
4437 * return priv->some_field;
4444 g_type_class_add_private (gpointer g_class,
4447 GType instance_type = ((GTypeClass *)g_class)->g_type;
4448 TypeNode *node = lookup_type_node_I (instance_type);
4451 g_return_if_fail (private_size > 0);
4452 g_return_if_fail (private_size <= 0xffff);
4454 if (!node || !node->is_instantiatable || !node->data || node->data->class.class != g_class)
4456 g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4457 type_descriptive_name_I (instance_type));
4461 if (NODE_PARENT_TYPE (node))
4463 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4464 if (node->data->instance.private_size != pnode->data->instance.private_size)
4466 g_warning ("g_type_add_private() called multiple times for the same type");
4471 G_WRITE_LOCK (&type_rw_lock);
4473 offset = ALIGN_STRUCT (node->data->instance.private_size);
4475 g_assert (offset + private_size <= 0xffff);
4477 node->data->instance.private_size = offset + private_size;
4479 G_WRITE_UNLOCK (&type_rw_lock);
4483 g_type_instance_get_private (GTypeInstance *instance,
4486 TypeNode *instance_node;
4487 TypeNode *private_node;
4488 TypeNode *parent_node;
4492 g_return_val_if_fail (instance != NULL && instance->g_class != NULL, NULL);
4494 /* while instances are initialized, their class pointers change,
4495 * so figure the instances real class first
4497 class = instance_real_class_get (instance);
4499 class = instance->g_class;
4501 instance_node = lookup_type_node_I (class->g_type);
4502 if (G_UNLIKELY (!instance_node || !instance_node->is_instantiatable))
4504 g_warning ("instance of invalid non-instantiatable type `%s'",
4505 type_descriptive_name_I (instance->g_class->g_type));
4509 private_node = lookup_type_node_I (private_type);
4510 if (G_UNLIKELY (!private_node || !NODE_IS_ANCESTOR (private_node, instance_node)))
4512 g_warning ("attempt to retrieve private data for invalid type '%s'",
4513 type_descriptive_name_I (private_type));
4517 /* Note that we don't need a read lock, since instance existing
4518 * means that the instance class and all parent classes
4519 * exist, so the node->data, node->data->instance.instance_size,
4520 * and node->data->instance.private_size are not going to be changed.
4521 * for any of the relevant types.
4524 offset = ALIGN_STRUCT (instance_node->data->instance.instance_size);
4526 if (NODE_PARENT_TYPE (private_node))
4528 parent_node = lookup_type_node_I (NODE_PARENT_TYPE (private_node));
4529 g_assert (parent_node->data && NODE_REFCOUNT (parent_node) > 0);
4531 if (G_UNLIKELY (private_node->data->instance.private_size == parent_node->data->instance.private_size))
4533 g_warning ("g_type_instance_get_private() requires a prior call to g_type_class_add_private()");
4537 offset += ALIGN_STRUCT (parent_node->data->instance.private_size);
4540 return G_STRUCT_MEMBER_P (instance, offset);
4544 * g_type_add_class_private:
4545 * @class_type: GType of an classed type.
4546 * @private_size: size of private structure.
4548 * Registers a private class structure for a classed type;
4549 * when the class is allocated, the private structures for
4550 * the class and all of its parent types are allocated
4551 * sequentially in the same memory block as the public
4552 * structures. This function should be called in the
4553 * type's get_type() function after the type is registered.
4554 * The private structure can be retrieved using the
4555 * G_TYPE_CLASS_GET_PRIVATE() macro.
4560 g_type_add_class_private (GType class_type,
4563 TypeNode *node = lookup_type_node_I (class_type);
4566 g_return_if_fail (private_size > 0);
4568 if (!node || !node->is_classed || !node->data)
4570 g_warning ("cannot add class private field to invalid type '%s'",
4571 type_descriptive_name_I (class_type));
4575 if (NODE_PARENT_TYPE (node))
4577 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4578 if (node->data->class.class_private_size != pnode->data->class.class_private_size)
4580 g_warning ("g_type_add_class_private() called multiple times for the same type");
4585 G_WRITE_LOCK (&type_rw_lock);
4587 offset = ALIGN_STRUCT (node->data->class.class_private_size);
4588 node->data->class.class_private_size = offset + private_size;
4590 G_WRITE_UNLOCK (&type_rw_lock);
4594 g_type_class_get_private (GTypeClass *klass,
4597 TypeNode *class_node;
4598 TypeNode *private_node;
4599 TypeNode *parent_node;
4602 g_return_val_if_fail (klass != NULL, NULL);
4604 class_node = lookup_type_node_I (klass->g_type);
4605 if (G_UNLIKELY (!class_node || !class_node->is_classed))
4607 g_warning ("class of invalid type `%s'",
4608 type_descriptive_name_I (klass->g_type));
4612 private_node = lookup_type_node_I (private_type);
4613 if (G_UNLIKELY (!private_node || !NODE_IS_ANCESTOR (private_node, class_node)))
4615 g_warning ("attempt to retrieve private data for invalid type '%s'",
4616 type_descriptive_name_I (private_type));
4620 offset = ALIGN_STRUCT (class_node->data->class.class_size);
4622 if (NODE_PARENT_TYPE (private_node))
4624 parent_node = lookup_type_node_I (NODE_PARENT_TYPE (private_node));
4625 g_assert (parent_node->data && NODE_REFCOUNT (parent_node) > 0);
4627 if (G_UNLIKELY (private_node->data->class.class_private_size == parent_node->data->class.class_private_size))
4629 g_warning ("g_type_instance_get_class_private() requires a prior call to g_type_class_add_class_private()");
4633 offset += ALIGN_STRUCT (parent_node->data->class.class_private_size);
4636 return G_STRUCT_MEMBER_P (klass, offset);