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, see <http://www.gnu.org/licenses/>.
24 #include "../glib/valgrind.h"
28 #include "gtype-private.h"
29 #include "gtypeplugin.h"
30 #include "gvaluecollector.h"
31 #include "gatomicarray.h"
32 #include "gobject_trace.h"
34 #include "gconstructor.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.
47 * For type creation and registration purposes, all types fall into one of
48 * two categories: static or dynamic. Static types are never loaded or
49 * unloaded at run-time as dynamic types may be. Static types are created
50 * with g_type_register_static() that gets type specific information passed
51 * in via a #GTypeInfo structure.
53 * Dynamic types are created with g_type_register_dynamic() which takes a
54 * #GTypePlugin structure instead. The remaining type information (the
55 * #GTypeInfo structure) is retrieved during runtime through #GTypePlugin
56 * and the g_type_plugin_*() API.
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.
64 * There is also a third registration function for registering fundamental
65 * types called g_type_register_fundamental() which requires both a #GTypeInfo
66 * structure and a #GTypeFundamentalInfo structure but it is seldom used
67 * since most fundamental types are predefined rather than user-defined.
69 * Type instance and class structs are limited to a total of 64 KiB,
70 * including all parent types. Similarly, type instances' private data
71 * (as created by g_type_class_add_private()) are limited to a total of
72 * 64 KiB. If a type instance needs a large static buffer, allocate it
73 * separately (typically by using #GArray or #GPtrArray) and put a pointer
74 * to the buffer in the structure.
76 * A final word about type names: Such an identifier needs to be at least
77 * three characters long. There is no upper length limit. The first character
78 * needs to be a letter (a-z or A-Z) or an underscore '_'. Subsequent
79 * characters can be letters, numbers or any of '-_+'.
83 /* NOTE: some functions (some internal variants and exported ones)
84 * invalidate data portions of the TypeNodes. if external functions/callbacks
85 * are called, pointers to memory maintained by TypeNodes have to be looked up
86 * again. this affects most of the struct TypeNode fields, e.g. ->children or
87 * CLASSED_NODE_IFACES_ENTRIES() respectively IFACE_NODE_PREREQUISITES() (but
88 * not ->supers[]), as all those memory portions can get realloc()ed during
89 * callback invocation.
92 * lock handling issues when calling static functions are indicated by
93 * uppercase letter postfixes, all static functions have to have
94 * one of the below postfixes:
95 * - _I: [Indifferent about locking]
96 * function doesn't care about locks at all
97 * - _U: [Unlocked invocation]
98 * no read or write lock has to be held across function invocation
99 * (locks may be acquired and released during invocation though)
100 * - _L: [Locked invocation]
101 * a write lock or more than 0 read locks have to be held across
102 * function invocation
103 * - _W: [Write-locked invocation]
104 * a write lock has to be held across function invocation
105 * - _Wm: [Write-locked invocation, mutatable]
106 * like _W, but the write lock might be released and reacquired
107 * during invocation, watch your pointers
108 * - _WmREC: [Write-locked invocation, mutatable, recursive]
109 * like _Wm, but also acquires recursive mutex class_init_rec_mutex
113 #define G_READ_LOCK(rw_lock) do { g_printerr (G_STRLOC ": readL++\n"); g_rw_lock_reader_lock (rw_lock); } while (0)
114 #define G_READ_UNLOCK(rw_lock) do { g_printerr (G_STRLOC ": readL--\n"); g_rw_lock_reader_unlock (rw_lock); } while (0)
115 #define G_WRITE_LOCK(rw_lock) do { g_printerr (G_STRLOC ": writeL++\n"); g_rw_lock_writer_lock (rw_lock); } while (0)
116 #define G_WRITE_UNLOCK(rw_lock) do { g_printerr (G_STRLOC ": writeL--\n"); g_rw_lock_writer_unlock (rw_lock); } while (0)
118 #define G_READ_LOCK(rw_lock) g_rw_lock_reader_lock (rw_lock)
119 #define G_READ_UNLOCK(rw_lock) g_rw_lock_reader_unlock (rw_lock)
120 #define G_WRITE_LOCK(rw_lock) g_rw_lock_writer_lock (rw_lock)
121 #define G_WRITE_UNLOCK(rw_lock) g_rw_lock_writer_unlock (rw_lock)
123 #define INVALID_RECURSION(func, arg, type_name) G_STMT_START{ \
124 static const gchar _action[] = " invalidly modified type "; \
125 gpointer _arg = (gpointer) (arg); const gchar *_tname = (type_name), *_fname = (func); \
127 g_error ("%s(%p)%s'%s'", _fname, _arg, _action, _tname); \
129 g_error ("%s()%s'%s'", _fname, _action, _tname); \
131 #define g_assert_type_system_initialized() \
132 g_assert (static_quark_type_flags)
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;
372 static GRecMutex class_init_rec_mutex;
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 static guint type_registration_serial = 0;
381 GTypeDebugFlags _g_type_debug_flags = 0;
383 /* --- type nodes --- */
384 static GHashTable *static_type_nodes_ht = NULL;
385 static TypeNode *static_fundamental_type_nodes[(G_TYPE_FUNDAMENTAL_MAX >> G_TYPE_FUNDAMENTAL_SHIFT) + 1] = { NULL, };
386 static GType static_fundamental_next = G_TYPE_RESERVED_USER_FIRST;
388 static inline TypeNode*
389 lookup_type_node_I (GType utype)
391 if (utype > G_TYPE_FUNDAMENTAL_MAX)
392 return (TypeNode*) (utype & ~TYPE_ID_MASK);
394 return static_fundamental_type_nodes[utype >> G_TYPE_FUNDAMENTAL_SHIFT];
398 * g_type_get_type_registration_serial:
400 * Returns an opaque serial number that represents the state of the set
401 * of registered types. Any time a type is registered this serial changes,
402 * which means you can cache information based on type lookups (such as
403 * g_type_from_name()) and know if the cache is still valid at a later
404 * time by comparing the current serial with the one at the type lookup.
408 * Returns: An unsigned int, representing the state of type registrations
411 g_type_get_type_registration_serial (void)
413 return (guint)g_atomic_int_get ((gint *)&type_registration_serial);
417 type_node_any_new_W (TypeNode *pnode,
421 GTypeFundamentalFlags type_flags)
426 guint i, node_size = 0;
428 n_supers = pnode ? pnode->n_supers + 1 : 0;
431 node_size += SIZEOF_FUNDAMENTAL_INFO; /* fundamental type info */
432 node_size += SIZEOF_BASE_TYPE_NODE (); /* TypeNode structure */
433 node_size += (sizeof (GType) * (1 + n_supers + 1)); /* self + ancestors + (0) for ->supers[] */
434 node = g_malloc0 (node_size);
435 if (!pnode) /* offset fundamental types */
437 node = G_STRUCT_MEMBER_P (node, SIZEOF_FUNDAMENTAL_INFO);
438 static_fundamental_type_nodes[ftype >> G_TYPE_FUNDAMENTAL_SHIFT] = node;
444 g_assert ((type & TYPE_ID_MASK) == 0);
446 node->n_supers = n_supers;
449 node->supers[0] = type;
452 node->is_classed = (type_flags & G_TYPE_FLAG_CLASSED) != 0;
453 node->is_instantiatable = (type_flags & G_TYPE_FLAG_INSTANTIATABLE) != 0;
455 if (NODE_IS_IFACE (node))
457 IFACE_NODE_N_PREREQUISITES (node) = 0;
458 IFACE_NODE_PREREQUISITES (node) = NULL;
461 _g_atomic_array_init (CLASSED_NODE_IFACES_ENTRIES (node));
465 node->supers[0] = type;
466 memcpy (node->supers + 1, pnode->supers, sizeof (GType) * (1 + pnode->n_supers + 1));
468 node->is_classed = pnode->is_classed;
469 node->is_instantiatable = pnode->is_instantiatable;
471 if (NODE_IS_IFACE (node))
473 IFACE_NODE_N_PREREQUISITES (node) = 0;
474 IFACE_NODE_PREREQUISITES (node) = NULL;
479 IFaceEntries *entries;
481 entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (pnode),
482 IFACE_ENTRIES_HEADER_SIZE,
486 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
488 entries->entry[j].vtable = NULL;
489 entries->entry[j].init_state = UNINITIALIZED;
491 _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node),
496 i = pnode->n_children++;
497 pnode->children = g_renew (GType, pnode->children, pnode->n_children);
498 pnode->children[i] = type;
501 TRACE(GOBJECT_TYPE_NEW(name, node->supers[1], type));
503 node->plugin = plugin;
504 node->n_children = 0;
505 node->children = NULL;
507 node->qname = g_quark_from_string (name);
508 node->global_gdata = NULL;
510 g_hash_table_insert (static_type_nodes_ht,
511 (gpointer) g_quark_to_string (node->qname),
514 g_atomic_int_inc ((gint *)&type_registration_serial);
519 static inline GTypeFundamentalInfo*
520 type_node_fundamental_info_I (TypeNode *node)
522 GType ftype = NODE_FUNDAMENTAL_TYPE (node);
524 if (ftype != NODE_TYPE (node))
525 node = lookup_type_node_I (ftype);
527 return node ? G_STRUCT_MEMBER_P (node, -SIZEOF_FUNDAMENTAL_INFO) : NULL;
531 type_node_fundamental_new_W (GType ftype,
533 GTypeFundamentalFlags type_flags)
535 GTypeFundamentalInfo *finfo;
538 g_assert ((ftype & TYPE_ID_MASK) == 0);
539 g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX);
541 if (ftype >> G_TYPE_FUNDAMENTAL_SHIFT == static_fundamental_next)
542 static_fundamental_next++;
544 type_flags &= TYPE_FUNDAMENTAL_FLAG_MASK;
546 node = type_node_any_new_W (NULL, ftype, name, NULL, type_flags);
548 finfo = type_node_fundamental_info_I (node);
549 finfo->type_flags = type_flags;
555 type_node_new_W (TypeNode *pnode,
561 g_assert (pnode->n_supers < MAX_N_SUPERS);
562 g_assert (pnode->n_children < MAX_N_CHILDREN);
564 return type_node_any_new_W (pnode, NODE_FUNDAMENTAL_TYPE (pnode), name, plugin, 0);
567 static inline IFaceEntry*
568 lookup_iface_entry_I (volatile IFaceEntries *entries,
569 TypeNode *iface_node)
580 G_ATOMIC_ARRAY_DO_TRANSACTION
581 (&iface_node->_prot.offsets, guint8,
584 offsets = transaction_data;
585 offset_index = entries->offset_index;
586 if (offsets != NULL &&
587 offset_index < G_ATOMIC_ARRAY_DATA_SIZE(offsets))
589 index = offsets[offset_index];
592 /* zero means unset, subtract one to get real index */
595 if (index < IFACE_ENTRIES_N_ENTRIES (entries))
597 check = (IFaceEntry *)&entries->entry[index];
598 if (check->iface_type == NODE_TYPE (iface_node))
608 static inline IFaceEntry*
609 type_lookup_iface_entry_L (TypeNode *node,
610 TypeNode *iface_node)
612 if (!NODE_IS_IFACE (iface_node))
615 return lookup_iface_entry_I (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node),
620 static inline gboolean
621 type_lookup_iface_vtable_I (TypeNode *node,
622 TypeNode *iface_node,
623 gpointer *vtable_ptr)
628 if (!NODE_IS_IFACE (iface_node))
635 G_ATOMIC_ARRAY_DO_TRANSACTION
636 (CLASSED_NODE_IFACES_ENTRIES (node), IFaceEntries,
638 entry = lookup_iface_entry_I (transaction_data, iface_node);
643 *vtable_ptr = entry->vtable;
652 static inline gboolean
653 type_lookup_prerequisite_L (TypeNode *iface,
654 GType prerequisite_type)
656 if (NODE_IS_IFACE (iface) && IFACE_NODE_N_PREREQUISITES (iface))
658 GType *prerequisites = IFACE_NODE_PREREQUISITES (iface) - 1;
659 guint n_prerequisites = IFACE_NODE_N_PREREQUISITES (iface);
666 i = (n_prerequisites + 1) >> 1;
667 check = prerequisites + i;
668 if (prerequisite_type == *check)
670 else if (prerequisite_type > *check)
672 n_prerequisites -= i;
673 prerequisites = check;
675 else /* if (prerequisite_type < *check) */
676 n_prerequisites = i - 1;
678 while (n_prerequisites);
684 type_descriptive_name_I (GType type)
688 TypeNode *node = lookup_type_node_I (type);
690 return node ? NODE_NAME (node) : "<unknown>";
697 /* --- type consistency checks --- */
699 check_plugin_U (GTypePlugin *plugin,
700 gboolean need_complete_type_info,
701 gboolean need_complete_interface_info,
702 const gchar *type_name)
704 /* G_IS_TYPE_PLUGIN() and G_TYPE_PLUGIN_GET_CLASS() are external calls: _U
708 g_warning ("plugin handle for type '%s' is NULL",
712 if (!G_IS_TYPE_PLUGIN (plugin))
714 g_warning ("plugin pointer (%p) for type '%s' is invalid",
718 if (need_complete_type_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_type_info)
720 g_warning ("plugin for type '%s' has no complete_type_info() implementation",
724 if (need_complete_interface_info && !G_TYPE_PLUGIN_GET_CLASS (plugin)->complete_interface_info)
726 g_warning ("plugin for type '%s' has no complete_interface_info() implementation",
734 check_type_name_I (const gchar *type_name)
736 static const gchar extra_chars[] = "-_+";
737 const gchar *p = type_name;
740 if (!type_name[0] || !type_name[1] || !type_name[2])
742 g_warning ("type name '%s' is too short", type_name);
745 /* check the first letter */
746 name_valid = (p[0] >= 'A' && p[0] <= 'Z') || (p[0] >= 'a' && p[0] <= 'z') || p[0] == '_';
747 for (p = type_name + 1; *p; p++)
748 name_valid &= ((p[0] >= 'A' && p[0] <= 'Z') ||
749 (p[0] >= 'a' && p[0] <= 'z') ||
750 (p[0] >= '0' && p[0] <= '9') ||
751 strchr (extra_chars, p[0]));
754 g_warning ("type name '%s' contains invalid characters", type_name);
757 if (g_type_from_name (type_name))
759 g_warning ("cannot register existing type '%s'", type_name);
767 check_derivation_I (GType parent_type,
768 const gchar *type_name)
771 GTypeFundamentalInfo* finfo;
773 pnode = lookup_type_node_I (parent_type);
776 g_warning ("cannot derive type '%s' from invalid parent type '%s'",
778 type_descriptive_name_I (parent_type));
781 finfo = type_node_fundamental_info_I (pnode);
782 /* ensure flat derivability */
783 if (!(finfo->type_flags & G_TYPE_FLAG_DERIVABLE))
785 g_warning ("cannot derive '%s' from non-derivable parent type '%s'",
790 /* ensure deep derivability */
791 if (parent_type != NODE_FUNDAMENTAL_TYPE (pnode) &&
792 !(finfo->type_flags & G_TYPE_FLAG_DEEP_DERIVABLE))
794 g_warning ("cannot derive '%s' from non-fundamental parent type '%s'",
804 check_collect_format_I (const gchar *collect_format)
806 const gchar *p = collect_format;
807 gchar valid_format[] = { G_VALUE_COLLECT_INT, G_VALUE_COLLECT_LONG,
808 G_VALUE_COLLECT_INT64, G_VALUE_COLLECT_DOUBLE,
809 G_VALUE_COLLECT_POINTER, 0 };
812 if (!strchr (valid_format, *p++))
814 return p - collect_format <= G_VALUE_COLLECT_FORMAT_MAX_LENGTH;
818 check_value_table_I (const gchar *type_name,
819 const GTypeValueTable *value_table)
823 else if (value_table->value_init == NULL)
825 if (value_table->value_free || value_table->value_copy ||
826 value_table->value_peek_pointer ||
827 value_table->collect_format || value_table->collect_value ||
828 value_table->lcopy_format || value_table->lcopy_value)
829 g_warning ("cannot handle uninitializable values of type '%s'",
833 else /* value_table->value_init != NULL */
835 if (!value_table->value_free)
838 * g_warning ("missing 'value_free()' for type '%s'", type_name);
842 if (!value_table->value_copy)
844 g_warning ("missing 'value_copy()' for type '%s'", type_name);
847 if ((value_table->collect_format || value_table->collect_value) &&
848 (!value_table->collect_format || !value_table->collect_value))
850 g_warning ("one of 'collect_format' and 'collect_value()' is unspecified for type '%s'",
854 if (value_table->collect_format && !check_collect_format_I (value_table->collect_format))
856 g_warning ("the '%s' specification for type '%s' is too long or invalid",
861 if ((value_table->lcopy_format || value_table->lcopy_value) &&
862 (!value_table->lcopy_format || !value_table->lcopy_value))
864 g_warning ("one of 'lcopy_format' and 'lcopy_value()' is unspecified for type '%s'",
868 if (value_table->lcopy_format && !check_collect_format_I (value_table->lcopy_format))
870 g_warning ("the '%s' specification for type '%s' is too long or invalid",
880 check_type_info_I (TypeNode *pnode,
882 const gchar *type_name,
883 const GTypeInfo *info)
885 GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (lookup_type_node_I (ftype));
886 gboolean is_interface = ftype == G_TYPE_INTERFACE;
888 g_assert (ftype <= G_TYPE_FUNDAMENTAL_MAX && !(ftype & TYPE_ID_MASK));
890 /* check instance members */
891 if (!(finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
892 (info->instance_size || info->n_preallocs || info->instance_init))
895 g_warning ("cannot instantiate '%s', derived from non-instantiatable parent type '%s'",
899 g_warning ("cannot instantiate '%s' as non-instantiatable fundamental",
903 /* check class & interface members */
904 if (!((finfo->type_flags & G_TYPE_FLAG_CLASSED) || is_interface) &&
905 (info->class_init || info->class_finalize || info->class_data ||
906 info->class_size || info->base_init || info->base_finalize))
909 g_warning ("cannot create class for '%s', derived from non-classed parent type '%s'",
913 g_warning ("cannot create class for '%s' as non-classed fundamental",
917 /* check interface size */
918 if (is_interface && info->class_size < sizeof (GTypeInterface))
920 g_warning ("specified interface size for type '%s' is smaller than 'GTypeInterface' size",
924 /* check class size */
925 if (finfo->type_flags & G_TYPE_FLAG_CLASSED)
927 if (info->class_size < sizeof (GTypeClass))
929 g_warning ("specified class size for type '%s' is smaller than 'GTypeClass' size",
933 if (pnode && info->class_size < pnode->data->class.class_size)
935 g_warning ("specified class size for type '%s' is smaller "
936 "than the parent type's '%s' class size",
942 /* check instance size */
943 if (finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE)
945 if (info->instance_size < sizeof (GTypeInstance))
947 g_warning ("specified instance size for type '%s' is smaller than 'GTypeInstance' size",
951 if (pnode && info->instance_size < pnode->data->instance.instance_size)
953 g_warning ("specified instance size for type '%s' is smaller "
954 "than the parent type's '%s' instance size",
965 find_conforming_child_type_L (TypeNode *pnode,
968 TypeNode *node = NULL;
971 if (type_lookup_iface_entry_L (pnode, iface))
974 for (i = 0; i < pnode->n_children && !node; i++)
975 node = find_conforming_child_type_L (lookup_type_node_I (pnode->children[i]), iface);
981 check_add_interface_L (GType instance_type,
984 TypeNode *node = lookup_type_node_I (instance_type);
985 TypeNode *iface = lookup_type_node_I (iface_type);
988 GType *prerequisites;
992 if (!node || !node->is_instantiatable)
994 g_warning ("cannot add interfaces to invalid (non-instantiatable) type '%s'",
995 type_descriptive_name_I (instance_type));
998 if (!iface || !NODE_IS_IFACE (iface))
1000 g_warning ("cannot add invalid (non-interface) type '%s' to type '%s'",
1001 type_descriptive_name_I (iface_type),
1005 if (node->data && node->data->class.class)
1007 g_warning ("attempting to add an interface (%s) to class (%s) after class_init",
1008 NODE_NAME (iface), NODE_NAME (node));
1011 tnode = lookup_type_node_I (NODE_PARENT_TYPE (iface));
1012 if (NODE_PARENT_TYPE (tnode) && !type_lookup_iface_entry_L (node, tnode))
1014 /* 2001/7/31:timj: erk, i guess this warning is junk as interface derivation is flat */
1015 g_warning ("cannot add sub-interface '%s' to type '%s' which does not conform to super-interface '%s'",
1021 /* allow overriding of interface type introduced for parent type */
1022 entry = type_lookup_iface_entry_L (node, iface);
1023 if (entry && entry->vtable == NULL && !type_iface_peek_holder_L (iface, NODE_TYPE (node)))
1025 /* ok, we do conform to this interface already, but the interface vtable was not
1026 * yet intialized, and we just conform to the interface because it got added to
1027 * one of our parents. so we allow overriding of holder info here.
1031 /* check whether one of our children already conforms (or whether the interface
1032 * got added to this node already)
1034 tnode = find_conforming_child_type_L (node, iface); /* tnode is_a node */
1037 g_warning ("cannot add interface type '%s' to type '%s', since type '%s' already conforms to interface",
1043 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1044 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1046 tnode = lookup_type_node_I (prerequisites[i]);
1047 if (!type_node_is_a_L (node, tnode))
1049 g_warning ("cannot add interface type '%s' to type '%s' which does not conform to prerequisite '%s'",
1060 check_interface_info_I (TypeNode *iface,
1061 GType instance_type,
1062 const GInterfaceInfo *info)
1064 if ((info->interface_finalize || info->interface_data) && !info->interface_init)
1066 g_warning ("interface type '%s' for type '%s' comes without initializer",
1068 type_descriptive_name_I (instance_type));
1075 /* --- type info (type node data) --- */
1077 type_data_make_W (TypeNode *node,
1078 const GTypeInfo *info,
1079 const GTypeValueTable *value_table)
1082 GTypeValueTable *vtable = NULL;
1083 guint vtable_size = 0;
1085 g_assert (node->data == NULL && info != NULL);
1089 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1092 vtable = pnode->data->common.value_table;
1095 static const GTypeValueTable zero_vtable = { NULL, };
1097 value_table = &zero_vtable;
1102 /* need to setup vtable_size since we have to allocate it with data in one chunk */
1103 vtable_size = sizeof (GTypeValueTable);
1104 if (value_table->collect_format)
1105 vtable_size += strlen (value_table->collect_format);
1106 if (value_table->lcopy_format)
1107 vtable_size += strlen (value_table->lcopy_format);
1111 if (node->is_instantiatable) /* careful, is_instantiatable is also is_classed */
1113 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1115 data = g_malloc0 (sizeof (InstanceData) + vtable_size);
1117 vtable = G_STRUCT_MEMBER_P (data, sizeof (InstanceData));
1118 data->instance.class_size = info->class_size;
1119 data->instance.class_init_base = info->base_init;
1120 data->instance.class_finalize_base = info->base_finalize;
1121 data->instance.class_init = info->class_init;
1122 data->instance.class_finalize = info->class_finalize;
1123 data->instance.class_data = info->class_data;
1124 data->instance.class = NULL;
1125 data->instance.init_state = UNINITIALIZED;
1126 data->instance.instance_size = info->instance_size;
1127 /* We'll set the final value for data->instance.private size
1128 * after the parent class has been initialized
1130 data->instance.private_size = 0;
1131 data->instance.class_private_size = 0;
1133 data->instance.class_private_size = pnode->data->instance.class_private_size;
1134 #ifdef DISABLE_MEM_POOLS
1135 data->instance.n_preallocs = 0;
1136 #else /* !DISABLE_MEM_POOLS */
1137 data->instance.n_preallocs = MIN (info->n_preallocs, 1024);
1138 #endif /* !DISABLE_MEM_POOLS */
1139 data->instance.instance_init = info->instance_init;
1141 else if (node->is_classed) /* only classed */
1143 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1145 data = g_malloc0 (sizeof (ClassData) + vtable_size);
1147 vtable = G_STRUCT_MEMBER_P (data, sizeof (ClassData));
1148 data->class.class_size = info->class_size;
1149 data->class.class_init_base = info->base_init;
1150 data->class.class_finalize_base = info->base_finalize;
1151 data->class.class_init = info->class_init;
1152 data->class.class_finalize = info->class_finalize;
1153 data->class.class_data = info->class_data;
1154 data->class.class = NULL;
1155 data->class.class_private_size = 0;
1157 data->class.class_private_size = pnode->data->class.class_private_size;
1158 data->class.init_state = UNINITIALIZED;
1160 else if (NODE_IS_IFACE (node))
1162 data = g_malloc0 (sizeof (IFaceData) + vtable_size);
1164 vtable = G_STRUCT_MEMBER_P (data, sizeof (IFaceData));
1165 data->iface.vtable_size = info->class_size;
1166 data->iface.vtable_init_base = info->base_init;
1167 data->iface.vtable_finalize_base = info->base_finalize;
1168 data->iface.dflt_init = info->class_init;
1169 data->iface.dflt_finalize = info->class_finalize;
1170 data->iface.dflt_data = info->class_data;
1171 data->iface.dflt_vtable = NULL;
1173 else if (NODE_IS_BOXED (node))
1175 data = g_malloc0 (sizeof (BoxedData) + vtable_size);
1177 vtable = G_STRUCT_MEMBER_P (data, sizeof (BoxedData));
1181 data = g_malloc0 (sizeof (CommonData) + vtable_size);
1183 vtable = G_STRUCT_MEMBER_P (data, sizeof (CommonData));
1192 /* we allocate the vtable and its strings together with the type data, so
1193 * children can take over their parent's vtable pointer, and we don't
1194 * need to worry freeing it or not when the child data is destroyed
1196 *vtable = *value_table;
1197 p = G_STRUCT_MEMBER_P (vtable, sizeof (*vtable));
1199 vtable->collect_format = p;
1200 if (value_table->collect_format)
1202 strcat (p, value_table->collect_format);
1203 p += strlen (value_table->collect_format);
1207 vtable->lcopy_format = p;
1208 if (value_table->lcopy_format)
1209 strcat (p, value_table->lcopy_format);
1211 node->data->common.value_table = vtable;
1212 node->mutatable_check_cache = (node->data->common.value_table->value_init != NULL &&
1213 !((G_TYPE_FLAG_VALUE_ABSTRACT | G_TYPE_FLAG_ABSTRACT) &
1214 GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))));
1216 g_assert (node->data->common.value_table != NULL); /* paranoid */
1218 g_atomic_int_set ((int *) &node->ref_count, 1);
1222 type_data_ref_Wm (TypeNode *node)
1226 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1228 GTypeValueTable tmp_value_table;
1230 g_assert (node->plugin != NULL);
1234 type_data_ref_Wm (pnode);
1236 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1239 memset (&tmp_info, 0, sizeof (tmp_info));
1240 memset (&tmp_value_table, 0, sizeof (tmp_value_table));
1242 G_WRITE_UNLOCK (&type_rw_lock);
1243 g_type_plugin_use (node->plugin);
1244 g_type_plugin_complete_type_info (node->plugin, NODE_TYPE (node), &tmp_info, &tmp_value_table);
1245 G_WRITE_LOCK (&type_rw_lock);
1247 INVALID_RECURSION ("g_type_plugin_*", node->plugin, NODE_NAME (node));
1249 check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (node), NODE_NAME (node), &tmp_info);
1250 type_data_make_W (node, &tmp_info,
1251 check_value_table_I (NODE_NAME (node),
1252 &tmp_value_table) ? &tmp_value_table : NULL);
1256 g_assert (NODE_REFCOUNT (node) > 0);
1258 g_atomic_int_inc ((int *) &node->ref_count);
1262 static inline gboolean
1263 type_data_ref_U (TypeNode *node)
1268 current = NODE_REFCOUNT (node);
1272 } while (!g_atomic_int_compare_and_exchange ((int *) &node->ref_count, current, current + 1));
1278 iface_node_has_available_offset_L (TypeNode *iface_node,
1284 offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->_prot.offsets, guint8);
1285 if (offsets == NULL)
1288 if (G_ATOMIC_ARRAY_DATA_SIZE (offsets) <= offset)
1291 if (offsets[offset] == 0 ||
1292 offsets[offset] == for_index+1)
1299 find_free_iface_offset_L (IFaceEntries *entries)
1302 TypeNode *iface_node;
1307 n_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1312 for (i = 0; i < n_entries; i++)
1314 entry = &entries->entry[i];
1315 iface_node = lookup_type_node_I (entry->iface_type);
1317 if (!iface_node_has_available_offset_L (iface_node, offset, i))
1321 while (i != n_entries);
1327 iface_node_set_offset_L (TypeNode *iface_node,
1331 guint8 *offsets, *old_offsets;
1332 int new_size, old_size;
1335 old_offsets = G_ATOMIC_ARRAY_GET_LOCKED (&iface_node->_prot.offsets, guint8);
1336 if (old_offsets == NULL)
1340 old_size = G_ATOMIC_ARRAY_DATA_SIZE (old_offsets);
1341 if (offset < old_size &&
1342 old_offsets[offset] == index + 1)
1343 return; /* Already set to this index, return */
1345 new_size = MAX (old_size, offset + 1);
1347 offsets = _g_atomic_array_copy (&iface_node->_prot.offsets,
1348 0, new_size - old_size);
1350 /* Mark new area as unused */
1351 for (i = old_size; i < new_size; i++)
1354 offsets[offset] = index + 1;
1356 _g_atomic_array_update (&iface_node->_prot.offsets, offsets);
1360 type_node_add_iface_entry_W (TypeNode *node,
1362 IFaceEntry *parent_entry)
1364 IFaceEntries *entries;
1366 TypeNode *iface_node;
1370 g_assert (node->is_instantiatable);
1372 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
1373 if (entries != NULL)
1375 num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1377 g_assert (num_entries < MAX_N_INTERFACES);
1379 for (i = 0; i < num_entries; i++)
1381 entry = &entries->entry[i];
1382 if (entry->iface_type == iface_type)
1384 /* this can happen in two cases:
1385 * - our parent type already conformed to iface_type and node
1386 * got its own holder info. here, our children already have
1387 * entries and NULL vtables, since this will only work for
1388 * uninitialized classes.
1389 * - an interface type is added to an ancestor after it was
1390 * added to a child type.
1393 g_assert (entry->vtable == NULL && entry->init_state == UNINITIALIZED);
1396 /* sick, interface is added to ancestor *after* child type;
1397 * nothing todo, the entry and our children were already setup correctly
1405 entries = _g_atomic_array_copy (CLASSED_NODE_IFACES_ENTRIES (node),
1406 IFACE_ENTRIES_HEADER_SIZE,
1407 sizeof (IFaceEntry));
1408 num_entries = IFACE_ENTRIES_N_ENTRIES (entries);
1409 i = num_entries - 1;
1411 entries->offset_index = 0;
1412 entries->entry[i].iface_type = iface_type;
1413 entries->entry[i].vtable = NULL;
1414 entries->entry[i].init_state = UNINITIALIZED;
1418 if (node->data && node->data->class.init_state >= BASE_IFACE_INIT)
1420 entries->entry[i].init_state = INITIALIZED;
1421 entries->entry[i].vtable = parent_entry->vtable;
1425 /* Update offsets in iface */
1426 iface_node = lookup_type_node_I (iface_type);
1428 if (iface_node_has_available_offset_L (iface_node,
1429 entries->offset_index,
1432 iface_node_set_offset_L (iface_node,
1433 entries->offset_index, i);
1437 entries->offset_index =
1438 find_free_iface_offset_L (entries);
1439 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (entries); j++)
1441 entry = &entries->entry[j];
1443 lookup_type_node_I (entry->iface_type);
1444 iface_node_set_offset_L (iface_node,
1445 entries->offset_index, j);
1449 _g_atomic_array_update (CLASSED_NODE_IFACES_ENTRIES (node), entries);
1453 for (i = 0; i < node->n_children; i++)
1454 type_node_add_iface_entry_W (lookup_type_node_I (node->children[i]), iface_type, &entries->entry[i]);
1459 type_add_interface_Wm (TypeNode *node,
1461 const GInterfaceInfo *info,
1462 GTypePlugin *plugin)
1464 IFaceHolder *iholder = g_new0 (IFaceHolder, 1);
1468 g_assert (node->is_instantiatable && NODE_IS_IFACE (iface) && ((info && !plugin) || (!info && plugin)));
1470 iholder->next = iface_node_get_holders_L (iface);
1471 iface_node_set_holders_W (iface, iholder);
1472 iholder->instance_type = NODE_TYPE (node);
1473 iholder->info = info ? g_memdup (info, sizeof (*info)) : NULL;
1474 iholder->plugin = plugin;
1476 /* create an iface entry for this type */
1477 type_node_add_iface_entry_W (node, NODE_TYPE (iface), NULL);
1479 /* if the class is already (partly) initialized, we may need to base
1480 * initalize and/or initialize the new interface.
1484 InitState class_state = node->data->class.init_state;
1486 if (class_state >= BASE_IFACE_INIT)
1487 type_iface_vtable_base_init_Wm (iface, node);
1489 if (class_state >= IFACE_INIT)
1490 type_iface_vtable_iface_init_Wm (iface, node);
1493 /* create iface entries for children of this type */
1494 entry = type_lookup_iface_entry_L (node, iface);
1495 for (i = 0; i < node->n_children; i++)
1496 type_node_add_iface_entry_W (lookup_type_node_I (node->children[i]), NODE_TYPE (iface), entry);
1500 type_iface_add_prerequisite_W (TypeNode *iface,
1501 TypeNode *prerequisite_node)
1503 GType prerequisite_type = NODE_TYPE (prerequisite_node);
1504 GType *prerequisites, *dependants;
1505 guint n_dependants, i;
1507 g_assert (NODE_IS_IFACE (iface) &&
1508 IFACE_NODE_N_PREREQUISITES (iface) < MAX_N_PREREQUISITES &&
1509 (prerequisite_node->is_instantiatable || NODE_IS_IFACE (prerequisite_node)));
1511 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1512 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1513 if (prerequisites[i] == prerequisite_type)
1514 return; /* we already have that prerequisiste */
1515 else if (prerequisites[i] > prerequisite_type)
1517 IFACE_NODE_N_PREREQUISITES (iface) += 1;
1518 IFACE_NODE_PREREQUISITES (iface) = g_renew (GType,
1519 IFACE_NODE_PREREQUISITES (iface),
1520 IFACE_NODE_N_PREREQUISITES (iface));
1521 prerequisites = IFACE_NODE_PREREQUISITES (iface);
1522 memmove (prerequisites + i + 1, prerequisites + i,
1523 sizeof (prerequisites[0]) * (IFACE_NODE_N_PREREQUISITES (iface) - i - 1));
1524 prerequisites[i] = prerequisite_type;
1526 /* we want to get notified when prerequisites get added to prerequisite_node */
1527 if (NODE_IS_IFACE (prerequisite_node))
1529 dependants = iface_node_get_dependants_array_L (prerequisite_node);
1530 n_dependants = dependants ? dependants[0] : 0;
1532 dependants = g_renew (GType, dependants, n_dependants + 1);
1533 dependants[n_dependants] = NODE_TYPE (iface);
1534 dependants[0] = n_dependants;
1535 iface_node_set_dependants_array_W (prerequisite_node, dependants);
1538 /* we need to notify all dependants */
1539 dependants = iface_node_get_dependants_array_L (iface);
1540 n_dependants = dependants ? dependants[0] : 0;
1541 for (i = 1; i <= n_dependants; i++)
1542 type_iface_add_prerequisite_W (lookup_type_node_I (dependants[i]), prerequisite_node);
1546 * g_type_interface_add_prerequisite:
1547 * @interface_type: #GType value of an interface type
1548 * @prerequisite_type: #GType value of an interface or instantiatable type
1550 * Adds @prerequisite_type to the list of prerequisites of @interface_type.
1551 * This means that any type implementing @interface_type must also implement
1552 * @prerequisite_type. Prerequisites can be thought of as an alternative to
1553 * interface derivation (which GType doesn't support). An interface can have
1554 * at most one instantiatable prerequisite type.
1557 g_type_interface_add_prerequisite (GType interface_type,
1558 GType prerequisite_type)
1560 TypeNode *iface, *prerequisite_node;
1561 IFaceHolder *holders;
1563 g_return_if_fail (G_TYPE_IS_INTERFACE (interface_type)); /* G_TYPE_IS_INTERFACE() is an external call: _U */
1564 g_return_if_fail (!g_type_is_a (interface_type, prerequisite_type));
1565 g_return_if_fail (!g_type_is_a (prerequisite_type, interface_type));
1567 iface = lookup_type_node_I (interface_type);
1568 prerequisite_node = lookup_type_node_I (prerequisite_type);
1569 if (!iface || !prerequisite_node || !NODE_IS_IFACE (iface))
1571 g_warning ("interface type '%s' or prerequisite type '%s' invalid",
1572 type_descriptive_name_I (interface_type),
1573 type_descriptive_name_I (prerequisite_type));
1576 G_WRITE_LOCK (&type_rw_lock);
1577 holders = iface_node_get_holders_L (iface);
1580 G_WRITE_UNLOCK (&type_rw_lock);
1581 g_warning ("unable to add prerequisite '%s' to interface '%s' which is already in use for '%s'",
1582 type_descriptive_name_I (prerequisite_type),
1583 type_descriptive_name_I (interface_type),
1584 type_descriptive_name_I (holders->instance_type));
1587 if (prerequisite_node->is_instantiatable)
1591 /* can have at most one publicly installable instantiatable prerequisite */
1592 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1594 TypeNode *prnode = lookup_type_node_I (IFACE_NODE_PREREQUISITES (iface)[i]);
1596 if (prnode->is_instantiatable)
1598 G_WRITE_UNLOCK (&type_rw_lock);
1599 g_warning ("adding prerequisite '%s' to interface '%s' conflicts with existing prerequisite '%s'",
1600 type_descriptive_name_I (prerequisite_type),
1601 type_descriptive_name_I (interface_type),
1602 type_descriptive_name_I (NODE_TYPE (prnode)));
1607 for (i = 0; i < prerequisite_node->n_supers + 1; i++)
1608 type_iface_add_prerequisite_W (iface, lookup_type_node_I (prerequisite_node->supers[i]));
1609 G_WRITE_UNLOCK (&type_rw_lock);
1611 else if (NODE_IS_IFACE (prerequisite_node))
1613 GType *prerequisites;
1616 prerequisites = IFACE_NODE_PREREQUISITES (prerequisite_node);
1617 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (prerequisite_node); i++)
1618 type_iface_add_prerequisite_W (iface, lookup_type_node_I (prerequisites[i]));
1619 type_iface_add_prerequisite_W (iface, prerequisite_node);
1620 G_WRITE_UNLOCK (&type_rw_lock);
1624 G_WRITE_UNLOCK (&type_rw_lock);
1625 g_warning ("prerequisite '%s' for interface '%s' is neither instantiatable nor interface",
1626 type_descriptive_name_I (prerequisite_type),
1627 type_descriptive_name_I (interface_type));
1632 * g_type_interface_prerequisites:
1633 * @interface_type: an interface type
1634 * @n_prerequisites: (out) (allow-none): location to return the number
1635 * of prerequisites, or %NULL
1637 * Returns the prerequisites of an interfaces type.
1641 * Returns: (array length=n_prerequisites) (transfer full): a
1642 * newly-allocated zero-terminated array of #GType containing
1643 * the prerequisites of @interface_type
1646 g_type_interface_prerequisites (GType interface_type,
1647 guint *n_prerequisites)
1651 g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL);
1653 iface = lookup_type_node_I (interface_type);
1657 TypeNode *inode = NULL;
1660 G_READ_LOCK (&type_rw_lock);
1661 types = g_new0 (GType, IFACE_NODE_N_PREREQUISITES (iface) + 1);
1662 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (iface); i++)
1664 GType prerequisite = IFACE_NODE_PREREQUISITES (iface)[i];
1665 TypeNode *node = lookup_type_node_I (prerequisite);
1666 if (node->is_instantiatable)
1668 if (!inode || type_node_is_a_L (node, inode))
1672 types[n++] = NODE_TYPE (node);
1675 types[n++] = NODE_TYPE (inode);
1677 if (n_prerequisites)
1678 *n_prerequisites = n;
1679 G_READ_UNLOCK (&type_rw_lock);
1685 if (n_prerequisites)
1686 *n_prerequisites = 0;
1694 type_iface_peek_holder_L (TypeNode *iface,
1695 GType instance_type)
1697 IFaceHolder *iholder;
1699 g_assert (NODE_IS_IFACE (iface));
1701 iholder = iface_node_get_holders_L (iface);
1702 while (iholder && iholder->instance_type != instance_type)
1703 iholder = iholder->next;
1708 type_iface_retrieve_holder_info_Wm (TypeNode *iface,
1709 GType instance_type,
1712 IFaceHolder *iholder = type_iface_peek_holder_L (iface, instance_type);
1714 if (iholder && !iholder->info && need_info)
1716 GInterfaceInfo tmp_info;
1718 g_assert (iholder->plugin != NULL);
1720 type_data_ref_Wm (iface);
1722 INVALID_RECURSION ("g_type_plugin_*", iface->plugin, NODE_NAME (iface));
1724 memset (&tmp_info, 0, sizeof (tmp_info));
1726 G_WRITE_UNLOCK (&type_rw_lock);
1727 g_type_plugin_use (iholder->plugin);
1728 g_type_plugin_complete_interface_info (iholder->plugin, instance_type, NODE_TYPE (iface), &tmp_info);
1729 G_WRITE_LOCK (&type_rw_lock);
1731 INVALID_RECURSION ("g_type_plugin_*", iholder->plugin, NODE_NAME (iface));
1733 check_interface_info_I (iface, instance_type, &tmp_info);
1734 iholder->info = g_memdup (&tmp_info, sizeof (tmp_info));
1737 return iholder; /* we don't modify write lock upon returning NULL */
1741 type_iface_blow_holder_info_Wm (TypeNode *iface,
1742 GType instance_type)
1744 IFaceHolder *iholder = iface_node_get_holders_L (iface);
1746 g_assert (NODE_IS_IFACE (iface));
1748 while (iholder->instance_type != instance_type)
1749 iholder = iholder->next;
1751 if (iholder->info && iholder->plugin)
1753 g_free (iholder->info);
1754 iholder->info = NULL;
1756 G_WRITE_UNLOCK (&type_rw_lock);
1757 g_type_plugin_unuse (iholder->plugin);
1758 type_data_unref_U (iface, FALSE);
1759 G_WRITE_LOCK (&type_rw_lock);
1764 * g_type_create_instance: (skip)
1765 * @type: an instantiatable type to create an instance for
1767 * Creates and initializes an instance of @type if @type is valid and
1768 * can be instantiated. The type system only performs basic allocation
1769 * and structure setups for instances: actual instance creation should
1770 * happen through functions supplied by the type's fundamental type
1771 * implementation. So use of g_type_create_instance() is reserved for
1772 * implementators of fundamental types only. E.g. instances of the
1773 * #GObject hierarchy should be created via g_object_new() and never
1774 * directly through g_type_create_instance() which doesn't handle things
1775 * like singleton objects or object construction.
1777 * The extended members of the returned instance are guaranteed to be filled
1780 * Note: Do not use this function, unless you're implementing a
1781 * fundamental type. Also language bindings should not use this
1782 * function, but g_object_new() instead.
1784 * Returns: an allocated and initialized instance, subject to further
1785 * treatment by the fundamental type implementation
1788 g_type_create_instance (GType type)
1791 GTypeInstance *instance;
1798 node = lookup_type_node_I (type);
1799 if (!node || !node->is_instantiatable)
1801 g_error ("cannot create new instance of invalid (non-instantiatable) type '%s'",
1802 type_descriptive_name_I (type));
1804 /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1805 if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (type))
1807 g_error ("cannot create instance of abstract (non-instantiatable) type '%s'",
1808 type_descriptive_name_I (type));
1811 class = g_type_class_ref (type);
1813 /* We allocate the 'private' areas before the normal instance data, in
1814 * reverse order. This allows the private area of a particular class
1815 * to always be at a constant relative address to the instance data.
1816 * If we stored the private data after the instance data this would
1817 * not be the case (since a subclass that added more instance
1818 * variables would push the private data further along).
1820 * This presents problems for valgrindability, of course, so we do a
1821 * workaround for that case. We identify the start of the object to
1822 * valgrind as an allocated block (so that pointers to objects show up
1823 * as 'reachable' instead of 'possibly lost'). We then add an extra
1824 * pointer at the end of the object, after all instance data, back to
1825 * the start of the private area so that it is also recorded as
1826 * reachable. We also add extra private space at the start because
1827 * valgrind doesn't seem to like us claiming to have allocated an
1828 * address that it saw allocated by malloc().
1830 private_size = node->data->instance.private_size;
1831 ivar_size = node->data->instance.instance_size;
1833 if (private_size && RUNNING_ON_VALGRIND)
1835 private_size += ALIGN_STRUCT (1);
1837 /* Allocate one extra pointer size... */
1838 allocated = g_slice_alloc0 (private_size + ivar_size + sizeof (gpointer));
1839 /* ... and point it back to the start of the private data. */
1840 *(gpointer *) (allocated + private_size + ivar_size) = allocated + ALIGN_STRUCT (1);
1842 /* Tell valgrind that it should treat the object itself as such */
1843 VALGRIND_MALLOCLIKE_BLOCK (allocated + private_size, ivar_size + sizeof (gpointer), 0, TRUE);
1844 VALGRIND_MALLOCLIKE_BLOCK (allocated + ALIGN_STRUCT (1), private_size - ALIGN_STRUCT (1), 0, TRUE);
1847 allocated = g_slice_alloc0 (private_size + ivar_size);
1849 instance = (GTypeInstance *) (allocated + private_size);
1851 for (i = node->n_supers; i > 0; i--)
1855 pnode = lookup_type_node_I (node->supers[i]);
1856 if (pnode->data->instance.instance_init)
1858 instance->g_class = pnode->data->instance.class;
1859 pnode->data->instance.instance_init (instance, class);
1863 instance->g_class = class;
1864 if (node->data->instance.instance_init)
1865 node->data->instance.instance_init (instance, class);
1867 TRACE(GOBJECT_OBJECT_NEW(instance, type));
1873 * g_type_free_instance:
1874 * @instance: an instance of a type
1876 * Frees an instance of a type, returning it to the instance pool for
1877 * the type, if there is one.
1879 * Like g_type_create_instance(), this function is reserved for
1880 * implementors of fundamental types.
1883 g_type_free_instance (GTypeInstance *instance)
1891 g_return_if_fail (instance != NULL && instance->g_class != NULL);
1893 class = instance->g_class;
1894 node = lookup_type_node_I (class->g_type);
1895 if (!node || !node->is_instantiatable || !node->data || node->data->class.class != (gpointer) class)
1897 g_warning ("cannot free instance of invalid (non-instantiatable) type '%s'",
1898 type_descriptive_name_I (class->g_type));
1901 /* G_TYPE_IS_ABSTRACT() is an external call: _U */
1902 if (!node->mutatable_check_cache && G_TYPE_IS_ABSTRACT (NODE_TYPE (node)))
1904 g_warning ("cannot free instance of abstract (non-instantiatable) type '%s'",
1909 instance->g_class = NULL;
1910 private_size = node->data->instance.private_size;
1911 ivar_size = node->data->instance.instance_size;
1912 allocated = ((gchar *) instance) - private_size;
1914 #ifdef G_ENABLE_DEBUG
1915 memset (allocated, 0xaa, ivar_size + private_size);
1918 /* See comment in g_type_create_instance() about what's going on here.
1919 * We're basically unwinding what we put into motion there.
1921 if (private_size && RUNNING_ON_VALGRIND)
1923 private_size += ALIGN_STRUCT (1);
1924 allocated -= ALIGN_STRUCT (1);
1926 /* Clear out the extra pointer... */
1927 *(gpointer *) (allocated + private_size + ivar_size) = NULL;
1928 /* ... and ensure we include it in the size we free. */
1929 g_slice_free1 (private_size + ivar_size + sizeof (gpointer), allocated);
1931 VALGRIND_FREELIKE_BLOCK (allocated + ALIGN_STRUCT (1), 0);
1932 VALGRIND_FREELIKE_BLOCK (instance, 0);
1935 g_slice_free1 (private_size + ivar_size, allocated);
1937 g_type_class_unref (class);
1941 type_iface_ensure_dflt_vtable_Wm (TypeNode *iface)
1943 g_assert (iface->data);
1945 if (!iface->data->iface.dflt_vtable)
1947 GTypeInterface *vtable = g_malloc0 (iface->data->iface.vtable_size);
1948 iface->data->iface.dflt_vtable = vtable;
1949 vtable->g_type = NODE_TYPE (iface);
1950 vtable->g_instance_type = 0;
1951 if (iface->data->iface.vtable_init_base ||
1952 iface->data->iface.dflt_init)
1954 G_WRITE_UNLOCK (&type_rw_lock);
1955 if (iface->data->iface.vtable_init_base)
1956 iface->data->iface.vtable_init_base (vtable);
1957 if (iface->data->iface.dflt_init)
1958 iface->data->iface.dflt_init (vtable, (gpointer) iface->data->iface.dflt_data);
1959 G_WRITE_LOCK (&type_rw_lock);
1965 /* This is called to allocate and do the first part of initializing
1966 * the interface vtable; type_iface_vtable_iface_init_Wm() does the remainder.
1968 * A FALSE return indicates that we didn't find an init function for
1969 * this type/iface pair, so the vtable from the parent type should
1970 * be used. Note that the write lock is not modified upon a FALSE
1974 type_iface_vtable_base_init_Wm (TypeNode *iface,
1978 IFaceHolder *iholder;
1979 GTypeInterface *vtable = NULL;
1982 /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
1983 iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), TRUE);
1985 return FALSE; /* we don't modify write lock upon FALSE */
1987 type_iface_ensure_dflt_vtable_Wm (iface);
1989 entry = type_lookup_iface_entry_L (node, iface);
1991 g_assert (iface->data && entry && entry->vtable == NULL && iholder && iholder->info);
1993 entry->init_state = IFACE_INIT;
1995 pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
1996 if (pnode) /* want to copy over parent iface contents */
1998 IFaceEntry *pentry = type_lookup_iface_entry_L (pnode, iface);
2001 vtable = g_memdup (pentry->vtable, iface->data->iface.vtable_size);
2004 vtable = g_memdup (iface->data->iface.dflt_vtable, iface->data->iface.vtable_size);
2005 entry->vtable = vtable;
2006 vtable->g_type = NODE_TYPE (iface);
2007 vtable->g_instance_type = NODE_TYPE (node);
2009 if (iface->data->iface.vtable_init_base)
2011 G_WRITE_UNLOCK (&type_rw_lock);
2012 iface->data->iface.vtable_init_base (vtable);
2013 G_WRITE_LOCK (&type_rw_lock);
2015 return TRUE; /* initialized the vtable */
2018 /* Finishes what type_iface_vtable_base_init_Wm started by
2019 * calling the interface init function.
2020 * this function may only be called for types with their
2021 * own interface holder info, i.e. types for which
2022 * g_type_add_interface*() was called and not children thereof.
2025 type_iface_vtable_iface_init_Wm (TypeNode *iface,
2028 IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2029 IFaceHolder *iholder = type_iface_peek_holder_L (iface, NODE_TYPE (node));
2030 GTypeInterface *vtable = NULL;
2033 /* iholder->info should have been filled in by type_iface_vtable_base_init_Wm() */
2034 g_assert (iface->data && entry && iholder && iholder->info);
2035 g_assert (entry->init_state == IFACE_INIT); /* assert prior base_init() */
2037 entry->init_state = INITIALIZED;
2039 vtable = entry->vtable;
2041 if (iholder->info->interface_init)
2043 G_WRITE_UNLOCK (&type_rw_lock);
2044 if (iholder->info->interface_init)
2045 iholder->info->interface_init (vtable, iholder->info->interface_data);
2046 G_WRITE_LOCK (&type_rw_lock);
2049 for (i = 0; i < static_n_iface_check_funcs; i++)
2051 GTypeInterfaceCheckFunc check_func = static_iface_check_funcs[i].check_func;
2052 gpointer check_data = static_iface_check_funcs[i].check_data;
2054 G_WRITE_UNLOCK (&type_rw_lock);
2055 check_func (check_data, (gpointer)vtable);
2056 G_WRITE_LOCK (&type_rw_lock);
2061 type_iface_vtable_finalize_Wm (TypeNode *iface,
2063 GTypeInterface *vtable)
2065 IFaceEntry *entry = type_lookup_iface_entry_L (node, iface);
2066 IFaceHolder *iholder;
2068 /* type_iface_retrieve_holder_info_Wm() doesn't modify write lock for returning NULL */
2069 iholder = type_iface_retrieve_holder_info_Wm (iface, NODE_TYPE (node), FALSE);
2071 return FALSE; /* we don't modify write lock upon FALSE */
2073 g_assert (entry && entry->vtable == vtable && iholder->info);
2075 entry->vtable = NULL;
2076 entry->init_state = UNINITIALIZED;
2077 if (iholder->info->interface_finalize || iface->data->iface.vtable_finalize_base)
2079 G_WRITE_UNLOCK (&type_rw_lock);
2080 if (iholder->info->interface_finalize)
2081 iholder->info->interface_finalize (vtable, iholder->info->interface_data);
2082 if (iface->data->iface.vtable_finalize_base)
2083 iface->data->iface.vtable_finalize_base (vtable);
2084 G_WRITE_LOCK (&type_rw_lock);
2087 vtable->g_instance_type = 0;
2090 type_iface_blow_holder_info_Wm (iface, NODE_TYPE (node));
2092 return TRUE; /* write lock modified */
2096 type_class_init_Wm (TypeNode *node,
2099 GSList *slist, *init_slist = NULL;
2101 IFaceEntries *entries;
2103 TypeNode *bnode, *pnode;
2106 /* Accessing data->class will work for instantiable types
2107 * too because ClassData is a subset of InstanceData
2109 g_assert (node->is_classed && node->data &&
2110 node->data->class.class_size &&
2111 !node->data->class.class &&
2112 node->data->class.init_state == UNINITIALIZED);
2113 if (node->data->class.class_private_size)
2114 class = g_malloc0 (ALIGN_STRUCT (node->data->class.class_size) + node->data->class.class_private_size);
2116 class = g_malloc0 (node->data->class.class_size);
2117 node->data->class.class = class;
2118 g_atomic_int_set (&node->data->class.init_state, BASE_CLASS_INIT);
2122 TypeNode *pnode = lookup_type_node_I (pclass->g_type);
2124 memcpy (class, pclass, pnode->data->class.class_size);
2125 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);
2127 if (node->is_instantiatable)
2129 /* We need to initialize the private_size here rather than in
2130 * type_data_make_W() since the class init for the parent
2131 * class may have changed pnode->data->instance.private_size.
2133 node->data->instance.private_size = pnode->data->instance.private_size;
2136 class->g_type = NODE_TYPE (node);
2138 G_WRITE_UNLOCK (&type_rw_lock);
2140 /* stack all base class initialization functions, so we
2141 * call them in ascending order.
2143 for (bnode = node; bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2144 if (bnode->data->class.class_init_base)
2145 init_slist = g_slist_prepend (init_slist, (gpointer) bnode->data->class.class_init_base);
2146 for (slist = init_slist; slist; slist = slist->next)
2148 GBaseInitFunc class_init_base = (GBaseInitFunc) slist->data;
2150 class_init_base (class);
2152 g_slist_free (init_slist);
2154 G_WRITE_LOCK (&type_rw_lock);
2156 g_atomic_int_set (&node->data->class.init_state, BASE_IFACE_INIT);
2158 /* Before we initialize the class, base initialize all interfaces, either
2159 * from parent, or through our holder info
2161 pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
2164 while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL &&
2165 i < IFACE_ENTRIES_N_ENTRIES (entries))
2167 entry = &entries->entry[i];
2168 while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2169 entry->init_state == IFACE_INIT)
2175 if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2178 if (!type_iface_vtable_base_init_Wm (lookup_type_node_I (entry->iface_type), node))
2181 IFaceEntries *pentries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (pnode);
2183 /* need to get this interface from parent, type_iface_vtable_base_init_Wm()
2184 * doesn't modify write lock upon FALSE, so entry is still valid;
2186 g_assert (pnode != NULL);
2189 for (j = 0; j < IFACE_ENTRIES_N_ENTRIES (pentries); j++)
2191 IFaceEntry *pentry = &pentries->entry[j];
2193 if (pentry->iface_type == entry->iface_type)
2195 entry->vtable = pentry->vtable;
2196 entry->init_state = INITIALIZED;
2200 g_assert (entry->vtable != NULL);
2203 /* If the write lock was released, additional interface entries might
2204 * have been inserted into CLASSED_NODE_IFACES_ENTRIES (node); they'll
2205 * be base-initialized when inserted, so we don't have to worry that
2206 * we might miss them. Uninitialized entries can only be moved higher
2207 * when new ones are inserted.
2212 g_atomic_int_set (&node->data->class.init_state, CLASS_INIT);
2214 G_WRITE_UNLOCK (&type_rw_lock);
2216 if (node->data->class.class_init)
2217 node->data->class.class_init (class, (gpointer) node->data->class.class_data);
2219 G_WRITE_LOCK (&type_rw_lock);
2221 g_atomic_int_set (&node->data->class.init_state, IFACE_INIT);
2223 /* finish initializing the interfaces through our holder info.
2224 * inherited interfaces are already init_state == INITIALIZED, because
2225 * they either got setup in the above base_init loop, or during
2226 * class_init from within type_add_interface_Wm() for this or
2227 * an anchestor type.
2230 while ((entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node)) != NULL)
2232 entry = &entries->entry[i];
2233 while (i < IFACE_ENTRIES_N_ENTRIES (entries) &&
2234 entry->init_state == INITIALIZED)
2240 if (i == IFACE_ENTRIES_N_ENTRIES (entries))
2243 type_iface_vtable_iface_init_Wm (lookup_type_node_I (entry->iface_type), node);
2245 /* As in the loop above, additional initialized entries might be inserted
2246 * if the write lock is released, but that's harmless because the entries
2247 * we need to initialize only move higher in the list.
2252 g_atomic_int_set (&node->data->class.init_state, INITIALIZED);
2256 type_data_finalize_class_ifaces_Wm (TypeNode *node)
2259 IFaceEntries *entries;
2261 g_assert (node->is_instantiatable && node->data && node->data->class.class && NODE_REFCOUNT (node) == 0);
2264 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
2265 for (i = 0; entries != NULL && i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
2267 IFaceEntry *entry = &entries->entry[i];
2270 if (type_iface_vtable_finalize_Wm (lookup_type_node_I (entry->iface_type), node, entry->vtable))
2272 /* refetch entries, IFACES_ENTRIES might be modified */
2277 /* type_iface_vtable_finalize_Wm() doesn't modify write lock upon FALSE,
2278 * iface vtable came from parent
2280 entry->vtable = NULL;
2281 entry->init_state = UNINITIALIZED;
2288 type_data_finalize_class_U (TypeNode *node,
2291 GTypeClass *class = cdata->class;
2294 g_assert (cdata->class && NODE_REFCOUNT (node) == 0);
2296 if (cdata->class_finalize)
2297 cdata->class_finalize (class, (gpointer) cdata->class_data);
2299 /* call all base class destruction functions in descending order
2301 if (cdata->class_finalize_base)
2302 cdata->class_finalize_base (class);
2303 for (bnode = lookup_type_node_I (NODE_PARENT_TYPE (node)); bnode; bnode = lookup_type_node_I (NODE_PARENT_TYPE (bnode)))
2304 if (bnode->data->class.class_finalize_base)
2305 bnode->data->class.class_finalize_base (class);
2307 g_free (cdata->class);
2311 type_data_last_unref_Wm (TypeNode *node,
2314 g_return_if_fail (node != NULL && node->plugin != NULL);
2316 if (!node->data || NODE_REFCOUNT (node) == 0)
2318 g_warning ("cannot drop last reference to unreferenced type '%s'",
2323 /* call class cache hooks */
2324 if (node->is_classed && node->data && node->data->class.class && static_n_class_cache_funcs && !uncached)
2328 G_WRITE_UNLOCK (&type_rw_lock);
2329 G_READ_LOCK (&type_rw_lock);
2330 for (i = 0; i < static_n_class_cache_funcs; i++)
2332 GTypeClassCacheFunc cache_func = static_class_cache_funcs[i].cache_func;
2333 gpointer cache_data = static_class_cache_funcs[i].cache_data;
2334 gboolean need_break;
2336 G_READ_UNLOCK (&type_rw_lock);
2337 need_break = cache_func (cache_data, node->data->class.class);
2338 G_READ_LOCK (&type_rw_lock);
2339 if (!node->data || NODE_REFCOUNT (node) == 0)
2340 INVALID_RECURSION ("GType class cache function ", cache_func, NODE_NAME (node));
2344 G_READ_UNLOCK (&type_rw_lock);
2345 G_WRITE_LOCK (&type_rw_lock);
2348 /* may have been re-referenced meanwhile */
2349 if (g_atomic_int_dec_and_test ((int *) &node->ref_count))
2351 GType ptype = NODE_PARENT_TYPE (node);
2354 if (node->is_instantiatable)
2356 /* destroy node->data->instance.mem_chunk */
2360 if (node->is_classed && tdata->class.class)
2362 if (CLASSED_NODE_IFACES_ENTRIES_LOCKED (node) != NULL)
2363 type_data_finalize_class_ifaces_Wm (node);
2364 node->mutatable_check_cache = FALSE;
2366 G_WRITE_UNLOCK (&type_rw_lock);
2367 type_data_finalize_class_U (node, &tdata->class);
2368 G_WRITE_LOCK (&type_rw_lock);
2370 else if (NODE_IS_IFACE (node) && tdata->iface.dflt_vtable)
2372 node->mutatable_check_cache = FALSE;
2374 if (tdata->iface.dflt_finalize || tdata->iface.vtable_finalize_base)
2376 G_WRITE_UNLOCK (&type_rw_lock);
2377 if (tdata->iface.dflt_finalize)
2378 tdata->iface.dflt_finalize (tdata->iface.dflt_vtable, (gpointer) tdata->iface.dflt_data);
2379 if (tdata->iface.vtable_finalize_base)
2380 tdata->iface.vtable_finalize_base (tdata->iface.dflt_vtable);
2381 G_WRITE_LOCK (&type_rw_lock);
2383 g_free (tdata->iface.dflt_vtable);
2387 node->mutatable_check_cache = FALSE;
2391 /* freeing tdata->common.value_table and its contents is taken care of
2392 * by allocating it in one chunk with tdata
2396 G_WRITE_UNLOCK (&type_rw_lock);
2397 g_type_plugin_unuse (node->plugin);
2399 type_data_unref_U (lookup_type_node_I (ptype), FALSE);
2400 G_WRITE_LOCK (&type_rw_lock);
2405 type_data_unref_U (TypeNode *node,
2411 current = NODE_REFCOUNT (node);
2417 g_warning ("static type '%s' unreferenced too often",
2423 /* This is the last reference of a type from a plugin. We are
2424 * experimentally disabling support for unloading type
2425 * plugins, so don't allow the last ref to drop.
2430 g_assert (current > 0);
2432 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2433 G_WRITE_LOCK (&type_rw_lock);
2434 type_data_last_unref_Wm (node, uncached);
2435 G_WRITE_UNLOCK (&type_rw_lock);
2436 g_rec_mutex_unlock (&class_init_rec_mutex);
2439 } while (!g_atomic_int_compare_and_exchange ((int *) &node->ref_count, current, current - 1));
2443 * g_type_add_class_cache_func: (skip)
2444 * @cache_data: data to be passed to @cache_func
2445 * @cache_func: a #GTypeClassCacheFunc
2447 * Adds a #GTypeClassCacheFunc to be called before the reference count of a
2448 * class goes from one to zero. This can be used to prevent premature class
2449 * destruction. All installed #GTypeClassCacheFunc functions will be chained
2450 * until one of them returns %TRUE. The functions have to check the class id
2451 * passed in to figure whether they actually want to cache the class of this
2452 * type, since all classes are routed through the same #GTypeClassCacheFunc
2456 g_type_add_class_cache_func (gpointer cache_data,
2457 GTypeClassCacheFunc cache_func)
2461 g_return_if_fail (cache_func != NULL);
2463 G_WRITE_LOCK (&type_rw_lock);
2464 i = static_n_class_cache_funcs++;
2465 static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2466 static_class_cache_funcs[i].cache_data = cache_data;
2467 static_class_cache_funcs[i].cache_func = cache_func;
2468 G_WRITE_UNLOCK (&type_rw_lock);
2472 * g_type_remove_class_cache_func: (skip)
2473 * @cache_data: data that was given when adding @cache_func
2474 * @cache_func: a #GTypeClassCacheFunc
2476 * Removes a previously installed #GTypeClassCacheFunc. The cache
2477 * maintained by @cache_func has to be empty when calling
2478 * g_type_remove_class_cache_func() to avoid leaks.
2481 g_type_remove_class_cache_func (gpointer cache_data,
2482 GTypeClassCacheFunc cache_func)
2484 gboolean found_it = FALSE;
2487 g_return_if_fail (cache_func != NULL);
2489 G_WRITE_LOCK (&type_rw_lock);
2490 for (i = 0; i < static_n_class_cache_funcs; i++)
2491 if (static_class_cache_funcs[i].cache_data == cache_data &&
2492 static_class_cache_funcs[i].cache_func == cache_func)
2494 static_n_class_cache_funcs--;
2495 memmove (static_class_cache_funcs + i,
2496 static_class_cache_funcs + i + 1,
2497 sizeof (static_class_cache_funcs[0]) * (static_n_class_cache_funcs - i));
2498 static_class_cache_funcs = g_renew (ClassCacheFunc, static_class_cache_funcs, static_n_class_cache_funcs);
2502 G_WRITE_UNLOCK (&type_rw_lock);
2505 g_warning (G_STRLOC ": cannot remove unregistered class cache func %p with data %p",
2506 cache_func, cache_data);
2511 * g_type_add_interface_check: (skip)
2512 * @check_data: data to pass to @check_func
2513 * @check_func: function to be called after each interface
2516 * Adds a function to be called after an interface vtable is
2517 * initialized for any class (i.e. after the @interface_init
2518 * member of #GInterfaceInfo has been called).
2520 * This function is useful when you want to check an invariant
2521 * that depends on the interfaces of a class. For instance, the
2522 * implementation of #GObject uses this facility to check that an
2523 * object implements all of the properties that are defined on its
2529 g_type_add_interface_check (gpointer check_data,
2530 GTypeInterfaceCheckFunc check_func)
2534 g_return_if_fail (check_func != NULL);
2536 G_WRITE_LOCK (&type_rw_lock);
2537 i = static_n_iface_check_funcs++;
2538 static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2539 static_iface_check_funcs[i].check_data = check_data;
2540 static_iface_check_funcs[i].check_func = check_func;
2541 G_WRITE_UNLOCK (&type_rw_lock);
2545 * g_type_remove_interface_check: (skip)
2546 * @check_data: callback data passed to g_type_add_interface_check()
2547 * @check_func: callback function passed to g_type_add_interface_check()
2549 * Removes an interface check function added with
2550 * g_type_add_interface_check().
2555 g_type_remove_interface_check (gpointer check_data,
2556 GTypeInterfaceCheckFunc check_func)
2558 gboolean found_it = FALSE;
2561 g_return_if_fail (check_func != NULL);
2563 G_WRITE_LOCK (&type_rw_lock);
2564 for (i = 0; i < static_n_iface_check_funcs; i++)
2565 if (static_iface_check_funcs[i].check_data == check_data &&
2566 static_iface_check_funcs[i].check_func == check_func)
2568 static_n_iface_check_funcs--;
2569 memmove (static_iface_check_funcs + i,
2570 static_iface_check_funcs + i + 1,
2571 sizeof (static_iface_check_funcs[0]) * (static_n_iface_check_funcs - i));
2572 static_iface_check_funcs = g_renew (IFaceCheckFunc, static_iface_check_funcs, static_n_iface_check_funcs);
2576 G_WRITE_UNLOCK (&type_rw_lock);
2579 g_warning (G_STRLOC ": cannot remove unregistered class check func %p with data %p",
2580 check_func, check_data);
2583 /* --- type registration --- */
2585 * g_type_register_fundamental:
2586 * @type_id: a predefined type identifier
2587 * @type_name: 0-terminated string used as the name of the new type
2588 * @info: #GTypeInfo structure for this type
2589 * @finfo: #GTypeFundamentalInfo structure for this type
2590 * @flags: bitwise combination of #GTypeFlags values
2592 * Registers @type_id as the predefined identifier and @type_name as the
2593 * name of a fundamental type. If @type_id is already registered, or a
2594 * type named @type_name is already registered, the behaviour is undefined.
2595 * The type system uses the information contained in the #GTypeInfo structure
2596 * pointed to by @info and the #GTypeFundamentalInfo structure pointed to by
2597 * @finfo to manage the type and its instances. The value of @flags determines
2598 * additional characteristics of the fundamental type.
2600 * Returns: the predefined type identifier
2603 g_type_register_fundamental (GType type_id,
2604 const gchar *type_name,
2605 const GTypeInfo *info,
2606 const GTypeFundamentalInfo *finfo,
2611 g_assert_type_system_initialized ();
2612 g_return_val_if_fail (type_id > 0, 0);
2613 g_return_val_if_fail (type_name != NULL, 0);
2614 g_return_val_if_fail (info != NULL, 0);
2615 g_return_val_if_fail (finfo != NULL, 0);
2617 if (!check_type_name_I (type_name))
2619 if ((type_id & TYPE_ID_MASK) ||
2620 type_id > G_TYPE_FUNDAMENTAL_MAX)
2622 g_warning ("attempt to register fundamental type '%s' with invalid type id (%" G_GSIZE_FORMAT ")",
2627 if ((finfo->type_flags & G_TYPE_FLAG_INSTANTIATABLE) &&
2628 !(finfo->type_flags & G_TYPE_FLAG_CLASSED))
2630 g_warning ("cannot register instantiatable fundamental type '%s' as non-classed",
2634 if (lookup_type_node_I (type_id))
2636 g_warning ("cannot register existing fundamental type '%s' (as '%s')",
2637 type_descriptive_name_I (type_id),
2642 G_WRITE_LOCK (&type_rw_lock);
2643 node = type_node_fundamental_new_W (type_id, type_name, finfo->type_flags);
2644 type_add_flags_W (node, flags);
2646 if (check_type_info_I (NULL, NODE_FUNDAMENTAL_TYPE (node), type_name, info))
2647 type_data_make_W (node, info,
2648 check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2649 G_WRITE_UNLOCK (&type_rw_lock);
2651 return NODE_TYPE (node);
2655 * g_type_register_static_simple: (skip)
2656 * @parent_type: type from which this type will be derived
2657 * @type_name: 0-terminated string used as the name of the new type
2658 * @class_size: size of the class structure (see #GTypeInfo)
2659 * @class_init: location of the class initialization function (see #GTypeInfo)
2660 * @instance_size: size of the instance structure (see #GTypeInfo)
2661 * @instance_init: location of the instance initialization function (see #GTypeInfo)
2662 * @flags: bitwise combination of #GTypeFlags values
2664 * Registers @type_name as the name of a new static type derived from
2665 * @parent_type. The value of @flags determines the nature (e.g.
2666 * abstract or not) of the type. It works by filling a #GTypeInfo
2667 * struct and calling g_type_register_static().
2671 * Returns: the new type identifier
2674 g_type_register_static_simple (GType parent_type,
2675 const gchar *type_name,
2677 GClassInitFunc class_init,
2678 guint instance_size,
2679 GInstanceInitFunc instance_init,
2684 /* Instances are not allowed to be larger than this. If you have a big
2685 * fixed-length array or something, point to it instead.
2687 g_return_val_if_fail (class_size <= G_MAXUINT16, G_TYPE_INVALID);
2688 g_return_val_if_fail (instance_size <= G_MAXUINT16, G_TYPE_INVALID);
2690 info.class_size = class_size;
2691 info.base_init = NULL;
2692 info.base_finalize = NULL;
2693 info.class_init = class_init;
2694 info.class_finalize = NULL;
2695 info.class_data = NULL;
2696 info.instance_size = instance_size;
2697 info.n_preallocs = 0;
2698 info.instance_init = instance_init;
2699 info.value_table = NULL;
2701 return g_type_register_static (parent_type, type_name, &info, flags);
2705 * g_type_register_static:
2706 * @parent_type: type from which this type will be derived
2707 * @type_name: 0-terminated string used as the name of the new type
2708 * @info: #GTypeInfo structure for this type
2709 * @flags: bitwise combination of #GTypeFlags values
2711 * Registers @type_name as the name of a new static type derived from
2712 * @parent_type. The type system uses the information contained in the
2713 * #GTypeInfo structure pointed to by @info to manage the type and its
2714 * instances (if not abstract). The value of @flags determines the nature
2715 * (e.g. abstract or not) of the type.
2717 * Returns: the new type identifier
2720 g_type_register_static (GType parent_type,
2721 const gchar *type_name,
2722 const GTypeInfo *info,
2725 TypeNode *pnode, *node;
2728 g_assert_type_system_initialized ();
2729 g_return_val_if_fail (parent_type > 0, 0);
2730 g_return_val_if_fail (type_name != NULL, 0);
2731 g_return_val_if_fail (info != NULL, 0);
2733 if (!check_type_name_I (type_name) ||
2734 !check_derivation_I (parent_type, type_name))
2736 if (info->class_finalize)
2738 g_warning ("class finalizer specified for static type '%s'",
2743 pnode = lookup_type_node_I (parent_type);
2744 G_WRITE_LOCK (&type_rw_lock);
2745 type_data_ref_Wm (pnode);
2746 if (check_type_info_I (pnode, NODE_FUNDAMENTAL_TYPE (pnode), type_name, info))
2748 node = type_node_new_W (pnode, type_name, NULL);
2749 type_add_flags_W (node, flags);
2750 type = NODE_TYPE (node);
2751 type_data_make_W (node, info,
2752 check_value_table_I (type_name, info->value_table) ? info->value_table : NULL);
2754 G_WRITE_UNLOCK (&type_rw_lock);
2760 * g_type_register_dynamic:
2761 * @parent_type: type from which this type will be derived
2762 * @type_name: 0-terminated string used as the name of the new type
2763 * @plugin: #GTypePlugin structure to retrieve the #GTypeInfo from
2764 * @flags: bitwise combination of #GTypeFlags values
2766 * Registers @type_name as the name of a new dynamic type derived from
2767 * @parent_type. The type system uses the information contained in the
2768 * #GTypePlugin structure pointed to by @plugin to manage the type and its
2769 * instances (if not abstract). The value of @flags determines the nature
2770 * (e.g. abstract or not) of the type.
2772 * Returns: the new type identifier or #G_TYPE_INVALID if registration failed
2775 g_type_register_dynamic (GType parent_type,
2776 const gchar *type_name,
2777 GTypePlugin *plugin,
2780 TypeNode *pnode, *node;
2783 g_assert_type_system_initialized ();
2784 g_return_val_if_fail (parent_type > 0, 0);
2785 g_return_val_if_fail (type_name != NULL, 0);
2786 g_return_val_if_fail (plugin != NULL, 0);
2788 if (!check_type_name_I (type_name) ||
2789 !check_derivation_I (parent_type, type_name) ||
2790 !check_plugin_U (plugin, TRUE, FALSE, type_name))
2793 G_WRITE_LOCK (&type_rw_lock);
2794 pnode = lookup_type_node_I (parent_type);
2795 node = type_node_new_W (pnode, type_name, plugin);
2796 type_add_flags_W (node, flags);
2797 type = NODE_TYPE (node);
2798 G_WRITE_UNLOCK (&type_rw_lock);
2804 * g_type_add_interface_static:
2805 * @instance_type: #GType value of an instantiable type
2806 * @interface_type: #GType value of an interface type
2807 * @info: #GInterfaceInfo structure for this
2808 * (@instance_type, @interface_type) combination
2810 * Adds the static @interface_type to @instantiable_type.
2811 * The information contained in the #GInterfaceInfo structure
2812 * pointed to by @info is used to manage the relationship.
2815 g_type_add_interface_static (GType instance_type,
2816 GType interface_type,
2817 const GInterfaceInfo *info)
2819 /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2820 g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2821 g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2823 /* we only need to lock class_init_rec_mutex if instance_type already has its
2824 * class initialized, however this function is rarely enough called to take
2825 * the simple route and always acquire class_init_rec_mutex.
2827 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2828 G_WRITE_LOCK (&type_rw_lock);
2829 if (check_add_interface_L (instance_type, interface_type))
2831 TypeNode *node = lookup_type_node_I (instance_type);
2832 TypeNode *iface = lookup_type_node_I (interface_type);
2833 if (check_interface_info_I (iface, NODE_TYPE (node), info))
2834 type_add_interface_Wm (node, iface, info, NULL);
2836 G_WRITE_UNLOCK (&type_rw_lock);
2837 g_rec_mutex_unlock (&class_init_rec_mutex);
2841 * g_type_add_interface_dynamic:
2842 * @instance_type: #GType value of an instantiable type
2843 * @interface_type: #GType value of an interface type
2844 * @plugin: #GTypePlugin structure to retrieve the #GInterfaceInfo from
2846 * Adds the dynamic @interface_type to @instantiable_type. The information
2847 * contained in the #GTypePlugin structure pointed to by @plugin
2848 * is used to manage the relationship.
2851 g_type_add_interface_dynamic (GType instance_type,
2852 GType interface_type,
2853 GTypePlugin *plugin)
2856 /* G_TYPE_IS_INSTANTIATABLE() is an external call: _U */
2857 g_return_if_fail (G_TYPE_IS_INSTANTIATABLE (instance_type));
2858 g_return_if_fail (g_type_parent (interface_type) == G_TYPE_INTERFACE);
2860 node = lookup_type_node_I (instance_type);
2861 if (!check_plugin_U (plugin, FALSE, TRUE, NODE_NAME (node)))
2864 /* see comment in g_type_add_interface_static() about class_init_rec_mutex */
2865 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2866 G_WRITE_LOCK (&type_rw_lock);
2867 if (check_add_interface_L (instance_type, interface_type))
2869 TypeNode *iface = lookup_type_node_I (interface_type);
2870 type_add_interface_Wm (node, iface, NULL, plugin);
2872 G_WRITE_UNLOCK (&type_rw_lock);
2873 g_rec_mutex_unlock (&class_init_rec_mutex);
2877 /* --- public API functions --- */
2880 * @type: type ID of a classed type
2882 * Increments the reference count of the class structure belonging to
2883 * @type. This function will demand-create the class if it doesn't
2886 * Returns: (type GObject.TypeClass) (transfer none): the #GTypeClass
2887 * structure for the given type ID
2890 g_type_class_ref (GType type)
2897 /* optimize for common code path */
2898 node = lookup_type_node_I (type);
2899 if (!node || !node->is_classed)
2901 g_warning ("cannot retrieve class for invalid (unclassed) type '%s'",
2902 type_descriptive_name_I (type));
2906 if (G_LIKELY (type_data_ref_U (node)))
2908 if (G_LIKELY (g_atomic_int_get (&node->data->class.init_state) == INITIALIZED))
2909 return node->data->class.class;
2915 /* here, we either have node->data->class.class == NULL, or a recursive
2916 * call to g_type_class_ref() with a partly initialized class, or
2917 * node->data->class.init_state == INITIALIZED, because any
2918 * concurrently running initialization was guarded by class_init_rec_mutex.
2920 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
2922 /* we need an initialized parent class for initializing derived classes */
2923 ptype = NODE_PARENT_TYPE (node);
2924 pclass = ptype ? g_type_class_ref (ptype) : NULL;
2926 G_WRITE_LOCK (&type_rw_lock);
2929 type_data_ref_Wm (node);
2931 if (!node->data->class.class) /* class uninitialized */
2932 type_class_init_Wm (node, pclass);
2934 G_WRITE_UNLOCK (&type_rw_lock);
2937 g_type_class_unref (pclass);
2939 g_rec_mutex_unlock (&class_init_rec_mutex);
2941 return node->data->class.class;
2945 * g_type_class_unref:
2946 * @g_class: (type GObject.TypeClass): a #GTypeClass structure to unref
2948 * Decrements the reference count of the class structure being passed in.
2949 * Once the last reference count of a class has been released, classes
2950 * may be finalized by the type system, so further dereferencing of a
2951 * class pointer after g_type_class_unref() are invalid.
2954 g_type_class_unref (gpointer g_class)
2957 GTypeClass *class = g_class;
2959 g_return_if_fail (g_class != NULL);
2961 node = lookup_type_node_I (class->g_type);
2962 if (node && node->is_classed && NODE_REFCOUNT (node))
2963 type_data_unref_U (node, FALSE);
2965 g_warning ("cannot unreference class of invalid (unclassed) type '%s'",
2966 type_descriptive_name_I (class->g_type));
2970 * g_type_class_unref_uncached: (skip)
2971 * @g_class: (type GObject.TypeClass): a #GTypeClass structure to unref
2973 * A variant of g_type_class_unref() for use in #GTypeClassCacheFunc
2974 * implementations. It unreferences a class without consulting the chain
2975 * of #GTypeClassCacheFuncs, avoiding the recursion which would occur
2979 g_type_class_unref_uncached (gpointer g_class)
2982 GTypeClass *class = g_class;
2984 g_return_if_fail (g_class != NULL);
2986 node = lookup_type_node_I (class->g_type);
2987 if (node && node->is_classed && NODE_REFCOUNT (node))
2988 type_data_unref_U (node, TRUE);
2990 g_warning ("cannot unreference class of invalid (unclassed) type '%s'",
2991 type_descriptive_name_I (class->g_type));
2995 * g_type_class_peek:
2996 * @type: type ID of a classed type
2998 * This function is essentially the same as g_type_class_ref(),
2999 * except that the classes reference count isn't incremented.
3000 * As a consequence, this function may return %NULL if the class
3001 * of the type passed in does not currently exist (hasn't been
3002 * referenced before).
3004 * Returns: (type GObject.TypeClass) (transfer none): the #GTypeClass
3005 * structure for the given type ID or %NULL if the class does not
3009 g_type_class_peek (GType type)
3014 node = lookup_type_node_I (type);
3015 if (node && node->is_classed && NODE_REFCOUNT (node) &&
3016 g_atomic_int_get (&node->data->class.init_state) == INITIALIZED)
3017 /* ref_count _may_ be 0 */
3018 class = node->data->class.class;
3026 * g_type_class_peek_static:
3027 * @type: type ID of a classed type
3029 * A more efficient version of g_type_class_peek() which works only for
3032 * Returns: (type GObject.TypeClass) (transfer none): the #GTypeClass
3033 * structure for the given type ID or %NULL if the class does not
3034 * currently exist or is dynamically loaded
3039 g_type_class_peek_static (GType type)
3044 node = lookup_type_node_I (type);
3045 if (node && node->is_classed && NODE_REFCOUNT (node) &&
3046 /* peek only static types: */ node->plugin == NULL &&
3047 g_atomic_int_get (&node->data->class.init_state) == INITIALIZED)
3048 /* ref_count _may_ be 0 */
3049 class = node->data->class.class;
3057 * g_type_class_peek_parent:
3058 * @g_class: (type GObject.TypeClass): the #GTypeClass structure to
3059 * retrieve the parent class for
3061 * This is a convenience function often needed in class initializers.
3062 * It returns the class structure of the immediate parent type of the
3063 * class passed in. Since derived classes hold a reference count on
3064 * their parent classes as long as they are instantiated, the returned
3065 * class will always exist.
3067 * This function is essentially equivalent to:
3068 * g_type_class_peek (g_type_parent (G_TYPE_FROM_CLASS (g_class)))
3070 * Returns: (type GObject.TypeClass) (transfer none): the parent class
3074 g_type_class_peek_parent (gpointer g_class)
3077 gpointer class = NULL;
3079 g_return_val_if_fail (g_class != NULL, NULL);
3081 node = lookup_type_node_I (G_TYPE_FROM_CLASS (g_class));
3082 /* We used to acquire a read lock here. That is not necessary, since
3083 * parent->data->class.class is constant as long as the derived class
3086 if (node && node->is_classed && node->data && NODE_PARENT_TYPE (node))
3088 node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3089 class = node->data->class.class;
3091 else if (NODE_PARENT_TYPE (node))
3092 g_warning (G_STRLOC ": invalid class pointer '%p'", g_class);
3098 * g_type_interface_peek:
3099 * @instance_class: (type GObject.TypeClass): a #GTypeClass structure
3100 * @iface_type: an interface ID which this class conforms to
3102 * Returns the #GTypeInterface structure of an interface to which the
3103 * passed in class conforms.
3105 * Returns: (type GObject.TypeInterface) (transfer none): the #GTypeInterface
3106 * structure of @iface_type if implemented by @instance_class, %NULL
3110 g_type_interface_peek (gpointer instance_class,
3115 gpointer vtable = NULL;
3116 GTypeClass *class = instance_class;
3118 g_return_val_if_fail (instance_class != NULL, NULL);
3120 node = lookup_type_node_I (class->g_type);
3121 iface = lookup_type_node_I (iface_type);
3122 if (node && node->is_instantiatable && iface)
3123 type_lookup_iface_vtable_I (node, iface, &vtable);
3125 g_warning (G_STRLOC ": invalid class pointer '%p'", class);
3131 * g_type_interface_peek_parent:
3132 * @g_iface: (type GObject.TypeInterface): a #GTypeInterface structure
3134 * Returns the corresponding #GTypeInterface structure of the parent type
3135 * of the instance type to which @g_iface belongs. This is useful when
3136 * deriving the implementation of an interface from the parent type and
3137 * then possibly overriding some methods.
3139 * Returns: (transfer none) (type GObject.TypeInterface): the
3140 * corresponding #GTypeInterface structure of the parent type of the
3141 * instance type to which @g_iface belongs, or %NULL if the parent
3142 * type doesn't conform to the interface
3145 g_type_interface_peek_parent (gpointer g_iface)
3149 gpointer vtable = NULL;
3150 GTypeInterface *iface_class = g_iface;
3152 g_return_val_if_fail (g_iface != NULL, NULL);
3154 iface = lookup_type_node_I (iface_class->g_type);
3155 node = lookup_type_node_I (iface_class->g_instance_type);
3157 node = lookup_type_node_I (NODE_PARENT_TYPE (node));
3158 if (node && node->is_instantiatable && iface)
3159 type_lookup_iface_vtable_I (node, iface, &vtable);
3161 g_warning (G_STRLOC ": invalid interface pointer '%p'", g_iface);
3167 * g_type_default_interface_ref:
3168 * @g_type: an interface type
3170 * Increments the reference count for the interface type @g_type,
3171 * and returns the default interface vtable for the type.
3173 * If the type is not currently in use, then the default vtable
3174 * for the type will be created and initalized by calling
3175 * the base interface init and default vtable init functions for
3176 * the type (the @base_init and @class_init members of #GTypeInfo).
3177 * Calling g_type_default_interface_ref() is useful when you
3178 * want to make sure that signals and properties for an interface
3179 * have been installed.
3183 * Returns: (type GObject.TypeInterface) (transfer none): the default
3184 * vtable for the interface; call g_type_default_interface_unref()
3185 * when you are done using the interface.
3188 g_type_default_interface_ref (GType g_type)
3191 gpointer dflt_vtable;
3193 G_WRITE_LOCK (&type_rw_lock);
3195 node = lookup_type_node_I (g_type);
3196 if (!node || !NODE_IS_IFACE (node) ||
3197 (node->data && NODE_REFCOUNT (node) == 0))
3199 G_WRITE_UNLOCK (&type_rw_lock);
3200 g_warning ("cannot retrieve default vtable for invalid or non-interface type '%s'",
3201 type_descriptive_name_I (g_type));
3205 if (!node->data || !node->data->iface.dflt_vtable)
3207 G_WRITE_UNLOCK (&type_rw_lock);
3208 g_rec_mutex_lock (&class_init_rec_mutex); /* required locking order: 1) class_init_rec_mutex, 2) type_rw_lock */
3209 G_WRITE_LOCK (&type_rw_lock);
3210 node = lookup_type_node_I (g_type);
3211 type_data_ref_Wm (node);
3212 type_iface_ensure_dflt_vtable_Wm (node);
3213 g_rec_mutex_unlock (&class_init_rec_mutex);
3216 type_data_ref_Wm (node); /* ref_count >= 1 already */
3218 dflt_vtable = node->data->iface.dflt_vtable;
3219 G_WRITE_UNLOCK (&type_rw_lock);
3225 * g_type_default_interface_peek:
3226 * @g_type: an interface type
3228 * If the interface type @g_type is currently in use, returns its
3229 * default interface vtable.
3233 * Returns: (type GObject.TypeInterface) (transfer none): the default
3234 * vtable for the interface, or %NULL if the type is not currently
3238 g_type_default_interface_peek (GType g_type)
3243 node = lookup_type_node_I (g_type);
3244 if (node && NODE_IS_IFACE (node) && NODE_REFCOUNT (node))
3245 vtable = node->data->iface.dflt_vtable;
3253 * g_type_default_interface_unref:
3254 * @g_iface: (type GObject.TypeInterface): the default vtable
3255 * structure for a interface, as returned by g_type_default_interface_ref()
3257 * Decrements the reference count for the type corresponding to the
3258 * interface default vtable @g_iface. If the type is dynamic, then
3259 * when no one is using the interface and all references have
3260 * been released, the finalize function for the interface's default
3261 * vtable (the @class_finalize member of #GTypeInfo) will be called.
3266 g_type_default_interface_unref (gpointer g_iface)
3269 GTypeInterface *vtable = g_iface;
3271 g_return_if_fail (g_iface != NULL);
3273 node = lookup_type_node_I (vtable->g_type);
3274 if (node && NODE_IS_IFACE (node))
3275 type_data_unref_U (node, FALSE);
3277 g_warning ("cannot unreference invalid interface default vtable for '%s'",
3278 type_descriptive_name_I (vtable->g_type));
3283 * @type: type to return name for
3285 * Get the unique name that is assigned to a type ID. Note that this
3286 * function (like all other GType API) cannot cope with invalid type
3287 * IDs. %G_TYPE_INVALID may be passed to this function, as may be any
3288 * other validly registered type ID, but randomized type IDs should
3289 * not be passed in and will most likely lead to a crash.
3291 * Returns: static type name or %NULL
3294 g_type_name (GType type)
3298 g_assert_type_system_initialized ();
3300 node = lookup_type_node_I (type);
3302 return node ? NODE_NAME (node) : NULL;
3307 * @type: type to return quark of type name for
3309 * Get the corresponding quark of the type IDs name.
3311 * Returns: the type names quark or 0
3314 g_type_qname (GType type)
3318 node = lookup_type_node_I (type);
3320 return node ? node->qname : 0;
3325 * @name: type name to lookup
3327 * Lookup the type ID from a given type name, returning 0 if no type
3328 * has been registered under this name (this is the preferred method
3329 * to find out by name whether a specific type has been registered
3332 * Returns: corresponding type ID or 0
3335 g_type_from_name (const gchar *name)
3339 g_return_val_if_fail (name != NULL, 0);
3341 G_READ_LOCK (&type_rw_lock);
3342 type = (GType) g_hash_table_lookup (static_type_nodes_ht, name);
3343 G_READ_UNLOCK (&type_rw_lock);
3350 * @type: the derived type
3352 * Return the direct parent type of the passed in type. If the passed
3353 * in type has no parent, i.e. is a fundamental type, 0 is returned.
3355 * Returns: the parent type
3358 g_type_parent (GType type)
3362 node = lookup_type_node_I (type);
3364 return node ? NODE_PARENT_TYPE (node) : 0;
3371 * Returns the length of the ancestry of the passed in type. This
3372 * includes the type itself, so that e.g. a fundamental type has depth 1.
3374 * Returns: the depth of @type
3377 g_type_depth (GType type)
3381 node = lookup_type_node_I (type);
3383 return node ? node->n_supers + 1 : 0;
3388 * @leaf_type: descendant of @root_type and the type to be returned
3389 * @root_type: immediate parent of the returned type
3391 * Given a @leaf_type and a @root_type which is contained in its
3392 * anchestry, return the type that @root_type is the immediate parent
3393 * of. In other words, this function determines the type that is
3394 * derived directly from @root_type which is also a base class of
3395 * @leaf_type. Given a root type and a leaf type, this function can
3396 * be used to determine the types and order in which the leaf type is
3397 * descended from the root type.
3399 * Returns: immediate child of @root_type and anchestor of @leaf_type
3402 g_type_next_base (GType type,
3408 node = lookup_type_node_I (type);
3411 TypeNode *base_node = lookup_type_node_I (base_type);
3413 if (base_node && base_node->n_supers < node->n_supers)
3415 guint n = node->n_supers - base_node->n_supers;
3417 if (node->supers[n] == base_type)
3418 atype = node->supers[n - 1];
3425 static inline gboolean
3426 type_node_check_conformities_UorL (TypeNode *node,
3427 TypeNode *iface_node,
3428 /* support_inheritance */
3429 gboolean support_interfaces,
3430 gboolean support_prerequisites,
3435 if (/* support_inheritance && */
3436 NODE_IS_ANCESTOR (iface_node, node))
3439 support_interfaces = support_interfaces && node->is_instantiatable && NODE_IS_IFACE (iface_node);
3440 support_prerequisites = support_prerequisites && NODE_IS_IFACE (node);
3442 if (support_interfaces)
3446 if (type_lookup_iface_entry_L (node, iface_node))
3451 if (type_lookup_iface_vtable_I (node, iface_node, NULL))
3456 support_prerequisites)
3459 G_READ_LOCK (&type_rw_lock);
3460 if (support_prerequisites && type_lookup_prerequisite_L (node, NODE_TYPE (iface_node)))
3463 G_READ_UNLOCK (&type_rw_lock);
3469 type_node_is_a_L (TypeNode *node,
3470 TypeNode *iface_node)
3472 return type_node_check_conformities_UorL (node, iface_node, TRUE, TRUE, TRUE);
3475 static inline gboolean
3476 type_node_conforms_to_U (TypeNode *node,
3477 TypeNode *iface_node,
3478 gboolean support_interfaces,
3479 gboolean support_prerequisites)
3481 return type_node_check_conformities_UorL (node, iface_node, support_interfaces, support_prerequisites, FALSE);
3486 * @type: type to check anchestry for
3487 * @is_a_type: possible anchestor of @type or interface that @type
3490 * If @is_a_type is a derivable type, check whether @type is a
3491 * descendant of @is_a_type. If @is_a_type is an interface, check
3492 * whether @type conforms to it.
3494 * Returns: %TRUE if @type is a @is_a_type
3497 g_type_is_a (GType type,
3500 TypeNode *node, *iface_node;
3503 node = lookup_type_node_I (type);
3504 iface_node = lookup_type_node_I (iface_type);
3505 is_a = node && iface_node && type_node_conforms_to_U (node, iface_node, TRUE, TRUE);
3512 * @type: the parent type
3513 * @n_children: (out) (allow-none): location to store the length of
3514 * the returned array, or %NULL
3516 * Return a newly allocated and 0-terminated array of type IDs, listing
3517 * the child types of @type.
3519 * Returns: (array length=n_children) (transfer full): Newly allocated
3520 * and 0-terminated array of child types, free with g_free()
3523 g_type_children (GType type,
3528 node = lookup_type_node_I (type);
3533 G_READ_LOCK (&type_rw_lock); /* ->children is relocatable */
3534 children = g_new (GType, node->n_children + 1);
3535 memcpy (children, node->children, sizeof (GType) * node->n_children);
3536 children[node->n_children] = 0;
3539 *n_children = node->n_children;
3540 G_READ_UNLOCK (&type_rw_lock);
3554 * g_type_interfaces:
3555 * @type: the type to list interface types for
3556 * @n_interfaces: (out) (allow-none): location to store the length of
3557 * the returned array, or %NULL
3559 * Return a newly allocated and 0-terminated array of type IDs, listing
3560 * the interface types that @type conforms to.
3562 * Returns: (array length=n_interfaces) (transfer full): Newly allocated
3563 * and 0-terminated array of interface types, free with g_free()
3566 g_type_interfaces (GType type,
3567 guint *n_interfaces)
3571 node = lookup_type_node_I (type);
3572 if (node && node->is_instantiatable)
3574 IFaceEntries *entries;
3578 G_READ_LOCK (&type_rw_lock);
3579 entries = CLASSED_NODE_IFACES_ENTRIES_LOCKED (node);
3582 ifaces = g_new (GType, IFACE_ENTRIES_N_ENTRIES (entries) + 1);
3583 for (i = 0; i < IFACE_ENTRIES_N_ENTRIES (entries); i++)
3584 ifaces[i] = entries->entry[i].iface_type;
3588 ifaces = g_new (GType, 1);
3595 G_READ_UNLOCK (&type_rw_lock);
3608 typedef struct _QData QData;
3620 static inline gpointer
3621 type_get_qdata_L (TypeNode *node,
3624 GData *gdata = node->global_gdata;
3626 if (quark && gdata && gdata->n_qdatas)
3628 QData *qdatas = gdata->qdatas - 1;
3629 guint n_qdatas = gdata->n_qdatas;
3636 i = (n_qdatas + 1) / 2;
3638 if (quark == check->quark)
3640 else if (quark > check->quark)
3645 else /* if (quark < check->quark) */
3656 * @quark: a #GQuark id to identify the data
3658 * Obtains data which has previously been attached to @type
3659 * with g_type_set_qdata().
3661 * Note that this does not take subtyping into account; data
3662 * attached to one type with g_type_set_qdata() cannot
3663 * be retrieved from a subtype using g_type_get_qdata().
3665 * Returns: (transfer none): the data, or %NULL if no data was found
3668 g_type_get_qdata (GType type,
3674 node = lookup_type_node_I (type);
3677 G_READ_LOCK (&type_rw_lock);
3678 data = type_get_qdata_L (node, quark);
3679 G_READ_UNLOCK (&type_rw_lock);
3683 g_return_val_if_fail (node != NULL, NULL);
3690 type_set_qdata_W (TypeNode *node,
3698 /* setup qdata list if necessary */
3699 if (!node->global_gdata)
3700 node->global_gdata = g_new0 (GData, 1);
3701 gdata = node->global_gdata;
3703 /* try resetting old data */
3704 qdata = gdata->qdatas;
3705 for (i = 0; i < gdata->n_qdatas; i++)
3706 if (qdata[i].quark == quark)
3708 qdata[i].data = data;
3714 gdata->qdatas = g_renew (QData, gdata->qdatas, gdata->n_qdatas);
3715 qdata = gdata->qdatas;
3716 for (i = 0; i < gdata->n_qdatas - 1; i++)
3717 if (qdata[i].quark > quark)
3719 memmove (qdata + i + 1, qdata + i, sizeof (qdata[0]) * (gdata->n_qdatas - i - 1));
3720 qdata[i].quark = quark;
3721 qdata[i].data = data;
3727 * @quark: a #GQuark id to identify the data
3730 * Attaches arbitrary data to a type.
3733 g_type_set_qdata (GType type,
3739 g_return_if_fail (quark != 0);
3741 node = lookup_type_node_I (type);
3744 G_WRITE_LOCK (&type_rw_lock);
3745 type_set_qdata_W (node, quark, data);
3746 G_WRITE_UNLOCK (&type_rw_lock);
3749 g_return_if_fail (node != NULL);
3753 type_add_flags_W (TypeNode *node,
3758 g_return_if_fail ((flags & ~TYPE_FLAG_MASK) == 0);
3759 g_return_if_fail (node != NULL);
3761 if ((flags & TYPE_FLAG_MASK) && node->is_classed && node->data && node->data->class.class)
3762 g_warning ("tagging type '%s' as abstract after class initialization", NODE_NAME (node));
3763 dflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
3765 type_set_qdata_W (node, static_quark_type_flags, GUINT_TO_POINTER (dflags));
3770 * @type: #GType of a static, classed type
3771 * @query: (out caller-allocates): a user provided structure that is
3772 * filled in with constant values upon success
3774 * Queries the type system for information about a specific type.
3775 * This function will fill in a user-provided structure to hold
3776 * type-specific information. If an invalid #GType is passed in, the
3777 * @type member of the #GTypeQuery is 0. All members filled into the
3778 * #GTypeQuery structure should be considered constant and have to be
3782 g_type_query (GType type,
3787 g_return_if_fail (query != NULL);
3789 /* if node is not static and classed, we won't allow query */
3791 node = lookup_type_node_I (type);
3792 if (node && node->is_classed && !node->plugin)
3794 /* type is classed and probably even instantiatable */
3795 G_READ_LOCK (&type_rw_lock);
3796 if (node->data) /* type is static or referenced */
3798 query->type = NODE_TYPE (node);
3799 query->type_name = NODE_NAME (node);
3800 query->class_size = node->data->class.class_size;
3801 query->instance_size = node->is_instantiatable ? node->data->instance.instance_size : 0;
3803 G_READ_UNLOCK (&type_rw_lock);
3808 /* --- implementation details --- */
3810 g_type_test_flags (GType type,
3814 gboolean result = FALSE;
3816 node = lookup_type_node_I (type);
3819 guint fflags = flags & TYPE_FUNDAMENTAL_FLAG_MASK;
3820 guint tflags = flags & TYPE_FLAG_MASK;
3824 GTypeFundamentalInfo *finfo = type_node_fundamental_info_I (node);
3826 fflags = (finfo->type_flags & fflags) == fflags;
3833 G_READ_LOCK (&type_rw_lock);
3834 tflags = (tflags & GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags))) == tflags;
3835 G_READ_UNLOCK (&type_rw_lock);
3840 result = tflags && fflags;
3847 * g_type_get_plugin:
3848 * @type: #GType to retrieve the plugin for
3850 * Returns the #GTypePlugin structure for @type.
3852 * Returns: (transfer none): the corresponding plugin
3853 * if @type is a dynamic type, %NULL otherwise
3856 g_type_get_plugin (GType type)
3860 node = lookup_type_node_I (type);
3862 return node ? node->plugin : NULL;
3866 * g_type_interface_get_plugin:
3867 * @instance_type: #GType of an instantiatable type
3868 * @interface_type: #GType of an interface type
3870 * Returns the #GTypePlugin structure for the dynamic interface
3871 * @interface_type which has been added to @instance_type, or %NULL
3872 * if @interface_type has not been added to @instance_type or does
3873 * not have a #GTypePlugin structure. See g_type_add_interface_dynamic().
3875 * Returns: (transfer none): the #GTypePlugin for the dynamic
3876 * interface @interface_type of @instance_type
3879 g_type_interface_get_plugin (GType instance_type,
3880 GType interface_type)
3885 g_return_val_if_fail (G_TYPE_IS_INTERFACE (interface_type), NULL); /* G_TYPE_IS_INTERFACE() is an external call: _U */
3887 node = lookup_type_node_I (instance_type);
3888 iface = lookup_type_node_I (interface_type);
3891 IFaceHolder *iholder;
3892 GTypePlugin *plugin;
3894 G_READ_LOCK (&type_rw_lock);
3896 iholder = iface_node_get_holders_L (iface);
3897 while (iholder && iholder->instance_type != instance_type)
3898 iholder = iholder->next;
3899 plugin = iholder ? iholder->plugin : NULL;
3901 G_READ_UNLOCK (&type_rw_lock);
3906 g_return_val_if_fail (node == NULL, NULL);
3907 g_return_val_if_fail (iface == NULL, NULL);
3909 g_warning (G_STRLOC ": attempt to look up plugin for invalid instance/interface type pair.");
3915 * g_type_fundamental_next:
3917 * Returns the next free fundamental type id which can be used to
3918 * register a new fundamental type with g_type_register_fundamental().
3919 * The returned type ID represents the highest currently registered
3920 * fundamental type identifier.
3922 * Returns: the next available fundamental type ID to be registered,
3923 * or 0 if the type system ran out of fundamental type IDs
3926 g_type_fundamental_next (void)
3930 G_READ_LOCK (&type_rw_lock);
3931 type = static_fundamental_next;
3932 G_READ_UNLOCK (&type_rw_lock);
3933 type = G_TYPE_MAKE_FUNDAMENTAL (type);
3934 return type <= G_TYPE_FUNDAMENTAL_MAX ? type : 0;
3938 * g_type_fundamental:
3939 * @type_id: valid type ID
3941 * Internal function, used to extract the fundamental type ID portion.
3942 * Use G_TYPE_FUNDAMENTAL() instead.
3944 * Returns: fundamental type ID
3947 g_type_fundamental (GType type_id)
3949 TypeNode *node = lookup_type_node_I (type_id);
3951 return node ? NODE_FUNDAMENTAL_TYPE (node) : 0;
3955 g_type_check_instance_is_a (GTypeInstance *type_instance,
3958 TypeNode *node, *iface;
3961 if (!type_instance || !type_instance->g_class)
3964 node = lookup_type_node_I (type_instance->g_class->g_type);
3965 iface = lookup_type_node_I (iface_type);
3966 check = node && node->is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
3972 g_type_check_instance_is_fundamentally_a (GTypeInstance *type_instance,
3973 GType fundamental_type)
3975 if (!type_instance || !type_instance->g_class)
3977 return NODE_FUNDAMENTAL_TYPE(lookup_type_node_I (type_instance->g_class->g_type)) == fundamental_type;
3981 g_type_check_class_is_a (GTypeClass *type_class,
3984 TypeNode *node, *iface;
3990 node = lookup_type_node_I (type_class->g_type);
3991 iface = lookup_type_node_I (is_a_type);
3992 check = node && node->is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
3998 g_type_check_instance_cast (GTypeInstance *type_instance,
4003 if (type_instance->g_class)
4005 TypeNode *node, *iface;
4006 gboolean is_instantiatable, check;
4008 node = lookup_type_node_I (type_instance->g_class->g_type);
4009 is_instantiatable = node && node->is_instantiatable;
4010 iface = lookup_type_node_I (iface_type);
4011 check = is_instantiatable && iface && type_node_conforms_to_U (node, iface, TRUE, FALSE);
4013 return type_instance;
4015 if (is_instantiatable)
4016 g_warning ("invalid cast from '%s' to '%s'",
4017 type_descriptive_name_I (type_instance->g_class->g_type),
4018 type_descriptive_name_I (iface_type));
4020 g_warning ("invalid uninstantiatable type '%s' in cast to '%s'",
4021 type_descriptive_name_I (type_instance->g_class->g_type),
4022 type_descriptive_name_I (iface_type));
4025 g_warning ("invalid unclassed pointer in cast to '%s'",
4026 type_descriptive_name_I (iface_type));
4029 return type_instance;
4033 g_type_check_class_cast (GTypeClass *type_class,
4038 TypeNode *node, *iface;
4039 gboolean is_classed, check;
4041 node = lookup_type_node_I (type_class->g_type);
4042 is_classed = node && node->is_classed;
4043 iface = lookup_type_node_I (is_a_type);
4044 check = is_classed && iface && type_node_conforms_to_U (node, iface, FALSE, FALSE);
4049 g_warning ("invalid class cast from '%s' to '%s'",
4050 type_descriptive_name_I (type_class->g_type),
4051 type_descriptive_name_I (is_a_type));
4053 g_warning ("invalid unclassed type '%s' in class cast to '%s'",
4054 type_descriptive_name_I (type_class->g_type),
4055 type_descriptive_name_I (is_a_type));
4058 g_warning ("invalid class cast from (NULL) pointer to '%s'",
4059 type_descriptive_name_I (is_a_type));
4064 * g_type_check_instance:
4065 * @instance: a valid #GTypeInstance structure
4067 * Private helper function to aid implementation of the
4068 * G_TYPE_CHECK_INSTANCE() macro.
4070 * Returns: %TRUE if @instance is valid, %FALSE otherwise
4073 g_type_check_instance (GTypeInstance *type_instance)
4075 /* this function is just here to make the signal system
4076 * conveniently elaborated on instance checks
4080 if (type_instance->g_class)
4082 TypeNode *node = lookup_type_node_I (type_instance->g_class->g_type);
4084 if (node && node->is_instantiatable)
4087 g_warning ("instance of invalid non-instantiatable type '%s'",
4088 type_descriptive_name_I (type_instance->g_class->g_type));
4091 g_warning ("instance with invalid (NULL) class pointer");
4094 g_warning ("invalid (NULL) pointer instance");
4099 static inline gboolean
4100 type_check_is_value_type_U (GType type)
4102 GTypeFlags tflags = G_TYPE_FLAG_VALUE_ABSTRACT;
4105 /* common path speed up */
4106 node = lookup_type_node_I (type);
4107 if (node && node->mutatable_check_cache)
4110 G_READ_LOCK (&type_rw_lock);
4114 if (node->data && NODE_REFCOUNT (node) > 0 &&
4115 node->data->common.value_table->value_init)
4116 tflags = GPOINTER_TO_UINT (type_get_qdata_L (node, static_quark_type_flags));
4117 else if (NODE_IS_IFACE (node))
4121 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4123 GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4124 TypeNode *prnode = lookup_type_node_I (prtype);
4126 if (prnode->is_instantiatable)
4129 node = lookup_type_node_I (type);
4135 G_READ_UNLOCK (&type_rw_lock);
4137 return !(tflags & G_TYPE_FLAG_VALUE_ABSTRACT);
4141 g_type_check_is_value_type (GType type)
4143 return type_check_is_value_type_U (type);
4147 g_type_check_value (GValue *value)
4149 return value && type_check_is_value_type_U (value->g_type);
4153 g_type_check_value_holds (GValue *value,
4156 return value && type_check_is_value_type_U (value->g_type) && g_type_is_a (value->g_type, type);
4160 * g_type_value_table_peek: (skip)
4163 * Returns the location of the #GTypeValueTable associated with @type.
4165 * Note that this function should only be used from source code
4166 * that implements or has internal knowledge of the implementation of
4169 * Returns: location of the #GTypeValueTable associated with @type or
4170 * %NULL if there is no #GTypeValueTable associated with @type
4173 g_type_value_table_peek (GType type)
4175 GTypeValueTable *vtable = NULL;
4176 TypeNode *node = lookup_type_node_I (type);
4177 gboolean has_refed_data, has_table;
4179 if (node && NODE_REFCOUNT (node) && node->mutatable_check_cache)
4180 return node->data->common.value_table;
4182 G_READ_LOCK (&type_rw_lock);
4185 has_refed_data = node && node->data && NODE_REFCOUNT (node) > 0;
4186 has_table = has_refed_data && node->data->common.value_table->value_init;
4190 vtable = node->data->common.value_table;
4191 else if (NODE_IS_IFACE (node))
4195 for (i = 0; i < IFACE_NODE_N_PREREQUISITES (node); i++)
4197 GType prtype = IFACE_NODE_PREREQUISITES (node)[i];
4198 TypeNode *prnode = lookup_type_node_I (prtype);
4200 if (prnode->is_instantiatable)
4203 node = lookup_type_node_I (type);
4204 goto restart_table_peek;
4210 G_READ_UNLOCK (&type_rw_lock);
4216 g_warning (G_STRLOC ": type id '%" G_GSIZE_FORMAT "' is invalid", type);
4217 if (!has_refed_data)
4218 g_warning ("can't peek value table for type '%s' which is not currently referenced",
4219 type_descriptive_name_I (type));
4225 g_type_name_from_instance (GTypeInstance *instance)
4228 return "<NULL-instance>";
4230 return g_type_name_from_class (instance->g_class);
4234 g_type_name_from_class (GTypeClass *g_class)
4237 return "<NULL-class>";
4239 return g_type_name (g_class->g_type);
4243 /* --- private api for gboxed.c --- */
4245 _g_type_boxed_copy (GType type, gpointer value)
4247 TypeNode *node = lookup_type_node_I (type);
4249 return node->data->boxed.copy_func (value);
4253 _g_type_boxed_free (GType type, gpointer value)
4255 TypeNode *node = lookup_type_node_I (type);
4257 node->data->boxed.free_func (value);
4261 _g_type_boxed_init (GType type,
4262 GBoxedCopyFunc copy_func,
4263 GBoxedFreeFunc free_func)
4265 TypeNode *node = lookup_type_node_I (type);
4267 node->data->boxed.copy_func = copy_func;
4268 node->data->boxed.free_func = free_func;
4271 /* --- initialization --- */
4273 * g_type_init_with_debug_flags:
4274 * @debug_flags: bitwise combination of #GTypeDebugFlags values for
4275 * debugging purposes
4277 * This function used to initialise the type system with debugging
4278 * flags. Since GLib 2.36, the type system is initialised automatically
4279 * and this function does nothing.
4281 * If you need to enable debugging features, use the GOBJECT_DEBUG
4282 * environment variable.
4284 * Deprecated: 2.36: the type system is now initialised automatically
4287 g_type_init_with_debug_flags (GTypeDebugFlags debug_flags)
4289 g_assert_type_system_initialized ();
4292 g_message ("g_type_init_with_debug_flags() is no longer supported. Use the GOBJECT_DEBUG environment variable.");
4298 * This function used to initialise the type system. Since GLib 2.36,
4299 * the type system is initialised automatically and this function does
4302 * Deprecated: 2.36: the type system is now initialised automatically
4307 g_assert_type_system_initialized ();
4310 #if defined (G_HAS_CONSTRUCTORS)
4311 #ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA
4312 #pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(gobject_init_ctor)
4314 G_DEFINE_CONSTRUCTOR(gobject_init_ctor)
4316 # error Your platform/compiler is missing constructor support
4320 gobject_init_ctor (void)
4322 const gchar *env_string;
4327 G_WRITE_LOCK (&type_rw_lock);
4329 /* setup GObject library wide debugging flags */
4330 env_string = g_getenv ("GOBJECT_DEBUG");
4331 if (env_string != NULL)
4333 GDebugKey debug_keys[] = {
4334 { "objects", G_TYPE_DEBUG_OBJECTS },
4335 { "signals", G_TYPE_DEBUG_SIGNALS },
4338 _g_type_debug_flags = g_parse_debug_string (env_string, debug_keys, G_N_ELEMENTS (debug_keys));
4342 static_quark_type_flags = g_quark_from_static_string ("-g-type-private--GTypeFlags");
4343 static_quark_iface_holder = g_quark_from_static_string ("-g-type-private--IFaceHolder");
4344 static_quark_dependants_array = g_quark_from_static_string ("-g-type-private--dependants-array");
4346 /* type qname hash table */
4347 static_type_nodes_ht = g_hash_table_new (g_str_hash, g_str_equal);
4349 /* invalid type G_TYPE_INVALID (0)
4351 static_fundamental_type_nodes[0] = NULL;
4353 /* void type G_TYPE_NONE
4355 node = type_node_fundamental_new_W (G_TYPE_NONE, g_intern_static_string ("void"), 0);
4356 type = NODE_TYPE (node);
4357 g_assert (type == G_TYPE_NONE);
4359 /* interface fundamental type G_TYPE_INTERFACE (!classed)
4361 memset (&info, 0, sizeof (info));
4362 node = type_node_fundamental_new_W (G_TYPE_INTERFACE, g_intern_static_string ("GInterface"), G_TYPE_FLAG_DERIVABLE);
4363 type = NODE_TYPE (node);
4364 type_data_make_W (node, &info, NULL);
4365 g_assert (type == G_TYPE_INTERFACE);
4367 G_WRITE_UNLOCK (&type_rw_lock);
4371 /* G_TYPE_TYPE_PLUGIN
4373 g_type_ensure (g_type_plugin_get_type ());
4375 /* G_TYPE_* value types
4377 _g_value_types_init ();
4379 /* G_TYPE_ENUM & G_TYPE_FLAGS
4381 _g_enum_types_init ();
4385 _g_boxed_type_init ();
4389 _g_param_type_init ();
4393 _g_object_type_init ();
4395 /* G_TYPE_PARAM_* pspec types
4397 _g_param_spec_types_init ();
4399 /* Value Transformations
4401 _g_value_transforms_init ();
4409 * g_type_class_add_private:
4410 * @g_class: class structure for an instantiatable type
4411 * @private_size: size of private structure
4413 * Registers a private structure for an instantiatable type.
4415 * When an object is allocated, the private structures for
4416 * the type and all of its parent types are allocated
4417 * sequentially in the same memory block as the public
4418 * structures, and are zero-filled.
4420 * Note that the accumulated size of the private structures of
4421 * a type and all its parent types cannot exceed 64 KiB.
4423 * This function should be called in the type's class_init() function.
4424 * The private structure can be retrieved using the
4425 * G_TYPE_INSTANCE_GET_PRIVATE() macro.
4427 * The following example shows attaching a private structure
4428 * MyObjectPrivate to an object MyObject defined in the standard
4429 * GObject fashion in the type's class_init() function.
4431 * Note the use of a structure member "priv" to avoid the overhead
4432 * of repeatedly calling MY_OBJECT_GET_PRIVATE().
4434 * |[<!-- language="C" -->
4435 * typedef struct _MyObject MyObject;
4436 * typedef struct _MyObjectPrivate MyObjectPrivate;
4438 * struct _MyObject {
4441 * MyObjectPrivate *priv;
4444 * struct _MyObjectPrivate {
4449 * my_object_class_init (MyObjectClass *klass)
4451 * g_type_class_add_private (klass, sizeof (MyObjectPrivate));
4455 * my_object_init (MyObject *my_object)
4457 * my_object->priv = G_TYPE_INSTANCE_GET_PRIVATE (my_object,
4460 * // my_object->priv->some_field will be automatically initialised to 0
4464 * my_object_get_some_field (MyObject *my_object)
4466 * MyObjectPrivate *priv;
4468 * g_return_val_if_fail (MY_IS_OBJECT (my_object), 0);
4470 * priv = my_object->priv;
4472 * return priv->some_field;
4479 g_type_class_add_private (gpointer g_class,
4482 GType instance_type = ((GTypeClass *)g_class)->g_type;
4483 TypeNode *node = lookup_type_node_I (instance_type);
4485 g_return_if_fail (private_size > 0);
4486 g_return_if_fail (private_size <= 0xffff);
4488 if (!node || !node->is_instantiatable || !node->data || node->data->class.class != g_class)
4490 g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4491 type_descriptive_name_I (instance_type));
4495 if (NODE_PARENT_TYPE (node))
4497 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4498 if (node->data->instance.private_size != pnode->data->instance.private_size)
4500 g_warning ("g_type_class_add_private() called multiple times for the same type");
4505 G_WRITE_LOCK (&type_rw_lock);
4507 private_size = ALIGN_STRUCT (node->data->instance.private_size + private_size);
4508 g_assert (private_size <= 0xffff);
4509 node->data->instance.private_size = private_size;
4511 G_WRITE_UNLOCK (&type_rw_lock);
4514 /* semi-private, called only by the G_ADD_PRIVATE macro */
4516 g_type_add_instance_private (GType class_gtype,
4519 TypeNode *node = lookup_type_node_I (class_gtype);
4521 g_return_val_if_fail (private_size > 0, 0);
4522 g_return_val_if_fail (private_size <= 0xffff, 0);
4524 if (!node || !node->is_classed || !node->is_instantiatable || !node->data)
4526 g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4527 type_descriptive_name_I (class_gtype));
4531 if (node->plugin != NULL)
4533 g_warning ("cannot use g_type_add_instance_private() with dynamic type '%s'",
4534 type_descriptive_name_I (class_gtype));
4538 /* in the future, we want to register the private data size of a type
4539 * directly from the get_type() implementation so that we can take full
4540 * advantage of the type definition macros that we already have.
4542 * unfortunately, this does not behave correctly if a class in the middle
4543 * of the type hierarchy uses the "old style" of private data registration
4544 * from the class_init() implementation, as the private data offset is not
4545 * going to be known until the full class hierarchy is initialized.
4547 * in order to transition our code to the Glorious New Futureâ„¢, we proceed
4548 * with a two-step implementation: first, we provide this new function to
4549 * register the private data size in the get_type() implementation and we
4550 * hide it behind a macro. the function will return the private size, instead
4551 * of the offset, which will be stored inside a static variable defined by
4552 * the G_DEFINE_TYPE_EXTENDED macro. the G_DEFINE_TYPE_EXTENDED macro will
4553 * check the variable and call g_type_class_add_instance_private(), which
4554 * will use the data size and actually register the private data, then
4555 * return the computed offset of the private data, which will be stored
4556 * inside the static variable, so we can use it to retrieve the pointer
4557 * to the private data structure.
4559 * once all our code has been migrated to the new idiomatic form of private
4560 * data registration, we will change the g_type_add_instance_private()
4561 * function to actually perform the registration and return the offset
4562 * of the private data; g_type_class_add_instance_private() already checks
4563 * if the passed argument is negative (meaning that it's an offset in the
4564 * GTypeInstance allocation) and becomes a no-op if that's the case. this
4565 * should make the migration fully transparent even if we're effectively
4566 * copying this macro into everybody's code.
4568 return private_size;
4571 /* semi-private function, should only be used by G_DEFINE_TYPE_EXTENDED */
4573 g_type_class_adjust_private_offset (gpointer g_class,
4574 gint *private_size_or_offset)
4576 GType class_gtype = ((GTypeClass *) g_class)->g_type;
4577 TypeNode *node = lookup_type_node_I (class_gtype);
4578 gssize private_size;
4580 g_return_if_fail (private_size_or_offset != NULL);
4582 /* if we have been passed the offset instead of the private data size,
4583 * then we consider this as a no-op, and just return the value. see the
4584 * comment in g_type_add_instance_private() for the full explanation.
4586 if (*private_size_or_offset > 0)
4587 g_return_if_fail (*private_size_or_offset <= 0xffff);
4591 if (!node || !node->is_classed || !node->is_instantiatable || !node->data)
4593 g_warning ("cannot add private field to invalid (non-instantiatable) type '%s'",
4594 type_descriptive_name_I (class_gtype));
4595 *private_size_or_offset = 0;
4599 if (NODE_PARENT_TYPE (node))
4601 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4602 if (node->data->instance.private_size != pnode->data->instance.private_size)
4604 g_warning ("g_type_add_instance_private() called multiple times for the same type");
4605 *private_size_or_offset = 0;
4610 G_WRITE_LOCK (&type_rw_lock);
4612 private_size = ALIGN_STRUCT (node->data->instance.private_size + *private_size_or_offset);
4613 g_assert (private_size <= 0xffff);
4614 node->data->instance.private_size = private_size;
4616 *private_size_or_offset = -(gint) node->data->instance.private_size;
4618 G_WRITE_UNLOCK (&type_rw_lock);
4622 g_type_instance_get_private (GTypeInstance *instance,
4627 g_return_val_if_fail (instance != NULL && instance->g_class != NULL, NULL);
4629 node = lookup_type_node_I (private_type);
4630 if (G_UNLIKELY (!node || !node->is_instantiatable))
4632 g_warning ("instance of invalid non-instantiatable type '%s'",
4633 type_descriptive_name_I (instance->g_class->g_type));
4637 return ((gchar *) instance) - node->data->instance.private_size;
4641 * g_type_class_get_instance_private_offset: (skip)
4642 * @g_class: a #GTypeClass
4644 * Gets the offset of the private data for instances of @g_class.
4646 * This is how many bytes you should add to the instance pointer of a
4647 * class in order to get the private data for the type represented by
4650 * You can only call this function after you have registered a private
4651 * data area for @g_class using g_type_class_add_private().
4653 * Returns: the offset, in bytes
4658 g_type_class_get_instance_private_offset (gpointer g_class)
4660 GType instance_type;
4661 guint16 parent_size;
4664 g_assert (g_class != NULL);
4666 instance_type = ((GTypeClass *) g_class)->g_type;
4667 node = lookup_type_node_I (instance_type);
4669 g_assert (node != NULL);
4670 g_assert (node->is_instantiatable);
4672 if (NODE_PARENT_TYPE (node))
4674 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4676 parent_size = pnode->data->instance.private_size;
4681 if (node->data->instance.private_size == parent_size)
4682 g_error ("g_type_class_get_instance_private_offset() called on class %s but it has no private data",
4683 g_type_name (instance_type));
4685 return -(gint) node->data->instance.private_size;
4689 * g_type_add_class_private:
4690 * @class_type: GType of an classed type
4691 * @private_size: size of private structure
4693 * Registers a private class structure for a classed type;
4694 * when the class is allocated, the private structures for
4695 * the class and all of its parent types are allocated
4696 * sequentially in the same memory block as the public
4697 * structures, and are zero-filled.
4699 * This function should be called in the
4700 * type's get_type() function after the type is registered.
4701 * The private structure can be retrieved using the
4702 * G_TYPE_CLASS_GET_PRIVATE() macro.
4707 g_type_add_class_private (GType class_type,
4710 TypeNode *node = lookup_type_node_I (class_type);
4713 g_return_if_fail (private_size > 0);
4715 if (!node || !node->is_classed || !node->data)
4717 g_warning ("cannot add class private field to invalid type '%s'",
4718 type_descriptive_name_I (class_type));
4722 if (NODE_PARENT_TYPE (node))
4724 TypeNode *pnode = lookup_type_node_I (NODE_PARENT_TYPE (node));
4725 if (node->data->class.class_private_size != pnode->data->class.class_private_size)
4727 g_warning ("g_type_add_class_private() called multiple times for the same type");
4732 G_WRITE_LOCK (&type_rw_lock);
4734 offset = ALIGN_STRUCT (node->data->class.class_private_size);
4735 node->data->class.class_private_size = offset + private_size;
4737 G_WRITE_UNLOCK (&type_rw_lock);
4741 g_type_class_get_private (GTypeClass *klass,
4744 TypeNode *class_node;
4745 TypeNode *private_node;
4746 TypeNode *parent_node;
4749 g_return_val_if_fail (klass != NULL, NULL);
4751 class_node = lookup_type_node_I (klass->g_type);
4752 if (G_UNLIKELY (!class_node || !class_node->is_classed))
4754 g_warning ("class of invalid type '%s'",
4755 type_descriptive_name_I (klass->g_type));
4759 private_node = lookup_type_node_I (private_type);
4760 if (G_UNLIKELY (!private_node || !NODE_IS_ANCESTOR (private_node, class_node)))
4762 g_warning ("attempt to retrieve private data for invalid type '%s'",
4763 type_descriptive_name_I (private_type));
4767 offset = ALIGN_STRUCT (class_node->data->class.class_size);
4769 if (NODE_PARENT_TYPE (private_node))
4771 parent_node = lookup_type_node_I (NODE_PARENT_TYPE (private_node));
4772 g_assert (parent_node->data && NODE_REFCOUNT (parent_node) > 0);
4774 if (G_UNLIKELY (private_node->data->class.class_private_size == parent_node->data->class.class_private_size))
4776 g_warning ("g_type_instance_get_class_private() requires a prior call to g_type_add_class_private()");
4780 offset += ALIGN_STRUCT (parent_node->data->class.class_private_size);
4783 return G_STRUCT_MEMBER_P (klass, offset);
4790 * Ensures that the indicated @type has been registered with the
4791 * type system, and its _class_init() method has been run.
4793 * In theory, simply calling the type's _get_type() method (or using
4794 * the corresponding macro) is supposed take care of this. However,
4795 * _get_type() methods are often marked %G_GNUC_CONST for performance
4796 * reasons, even though this is technically incorrect (since
4797 * %G_GNUC_CONST requires that the function not have side effects,
4798 * which _get_type() methods do on the first call). As a result, if
4799 * you write a bare call to a _get_type() macro, it may get optimized
4800 * out by the compiler. Using g_type_ensure() guarantees that the
4801 * type's _get_type() method is called.
4806 g_type_ensure (GType type)
4808 /* In theory, @type has already been resolved and so there's nothing
4809 * to do here. But this protects us in the case where the function
4810 * gets inlined (as it might in gobject_init_ctor() above).
4812 if (G_UNLIKELY (type == (GType)-1))
4813 g_error ("can't happen");