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/>.
20 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
21 #error "Only <glib-object.h> can be included directly."
32 * @type: A #GType value.
34 * The fundamental type which is the ancestor of @type.
35 * Fundamental types are types that serve as ultimate bases for the derived types,
36 * thus they are the roots of distinct inheritance hierarchies.
38 #define G_TYPE_FUNDAMENTAL(type) (g_type_fundamental (type))
40 * G_TYPE_FUNDAMENTAL_MAX:
42 * An integer constant that represents the number of identifiers reserved
43 * for types that are assigned at compile-time.
45 #define G_TYPE_FUNDAMENTAL_MAX (255 << G_TYPE_FUNDAMENTAL_SHIFT)
47 /* Constant fundamental types,
52 * An invalid #GType used as error return value in some functions which return
55 #define G_TYPE_INVALID G_TYPE_MAKE_FUNDAMENTAL (0)
59 * A fundamental type which is used as a replacement for the C
62 #define G_TYPE_NONE G_TYPE_MAKE_FUNDAMENTAL (1)
66 * The fundamental type from which all interfaces are derived.
68 #define G_TYPE_INTERFACE G_TYPE_MAKE_FUNDAMENTAL (2)
72 * The fundamental type corresponding to #gchar.
73 * The type designated by G_TYPE_CHAR is unconditionally an 8-bit signed integer.
74 * This may or may not be the same type a the C type "gchar".
76 #define G_TYPE_CHAR G_TYPE_MAKE_FUNDAMENTAL (3)
80 * The fundamental type corresponding to #guchar.
82 #define G_TYPE_UCHAR G_TYPE_MAKE_FUNDAMENTAL (4)
86 * The fundamental type corresponding to #gboolean.
88 #define G_TYPE_BOOLEAN G_TYPE_MAKE_FUNDAMENTAL (5)
92 * The fundamental type corresponding to #gint.
94 #define G_TYPE_INT G_TYPE_MAKE_FUNDAMENTAL (6)
98 * The fundamental type corresponding to #guint.
100 #define G_TYPE_UINT G_TYPE_MAKE_FUNDAMENTAL (7)
104 * The fundamental type corresponding to #glong.
106 #define G_TYPE_LONG G_TYPE_MAKE_FUNDAMENTAL (8)
110 * The fundamental type corresponding to #gulong.
112 #define G_TYPE_ULONG G_TYPE_MAKE_FUNDAMENTAL (9)
116 * The fundamental type corresponding to #gint64.
118 #define G_TYPE_INT64 G_TYPE_MAKE_FUNDAMENTAL (10)
122 * The fundamental type corresponding to #guint64.
124 #define G_TYPE_UINT64 G_TYPE_MAKE_FUNDAMENTAL (11)
128 * The fundamental type from which all enumeration types are derived.
130 #define G_TYPE_ENUM G_TYPE_MAKE_FUNDAMENTAL (12)
134 * The fundamental type from which all flags types are derived.
136 #define G_TYPE_FLAGS G_TYPE_MAKE_FUNDAMENTAL (13)
140 * The fundamental type corresponding to #gfloat.
142 #define G_TYPE_FLOAT G_TYPE_MAKE_FUNDAMENTAL (14)
146 * The fundamental type corresponding to #gdouble.
148 #define G_TYPE_DOUBLE G_TYPE_MAKE_FUNDAMENTAL (15)
152 * The fundamental type corresponding to nul-terminated C strings.
154 #define G_TYPE_STRING G_TYPE_MAKE_FUNDAMENTAL (16)
158 * The fundamental type corresponding to #gpointer.
160 #define G_TYPE_POINTER G_TYPE_MAKE_FUNDAMENTAL (17)
164 * The fundamental type from which all boxed types are derived.
166 #define G_TYPE_BOXED G_TYPE_MAKE_FUNDAMENTAL (18)
170 * The fundamental type from which all #GParamSpec types are derived.
172 #define G_TYPE_PARAM G_TYPE_MAKE_FUNDAMENTAL (19)
176 * The fundamental type for #GObject.
178 #define G_TYPE_OBJECT G_TYPE_MAKE_FUNDAMENTAL (20)
182 * The fundamental type corresponding to #GVariant.
184 * All floating #GVariant instances passed through the #GType system are
187 * Note that callbacks in closures, and signal handlers
188 * for signals of return type %G_TYPE_VARIANT, must never return floating
191 * Note: GLib 2.24 did include a boxed type with this name. It was replaced
192 * with this fundamental type in 2.26.
196 #define G_TYPE_VARIANT G_TYPE_MAKE_FUNDAMENTAL (21)
199 /* Reserved fundamental type numbers to create new fundamental
200 * type IDs with G_TYPE_MAKE_FUNDAMENTAL().
201 * Send email to gtk-devel-list@gnome.org for reservations.
204 * G_TYPE_FUNDAMENTAL_SHIFT:
206 * Shift value used in converting numbers to type IDs.
208 #define G_TYPE_FUNDAMENTAL_SHIFT (2)
210 * G_TYPE_MAKE_FUNDAMENTAL:
211 * @x: the fundamental type number.
213 * Get the type ID for the fundamental type number @x.
214 * Use g_type_fundamental_next() instead of this macro to create new fundamental
219 #define G_TYPE_MAKE_FUNDAMENTAL(x) ((GType) ((x) << G_TYPE_FUNDAMENTAL_SHIFT))
221 * G_TYPE_RESERVED_GLIB_FIRST:
223 * First fundamental type number to create a new fundamental type id with
224 * G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib.
226 #define G_TYPE_RESERVED_GLIB_FIRST (22)
228 * G_TYPE_RESERVED_GLIB_LAST:
230 * Last fundamental type number reserved for GLib.
232 #define G_TYPE_RESERVED_GLIB_LAST (31)
234 * G_TYPE_RESERVED_BSE_FIRST:
236 * First fundamental type number to create a new fundamental type id with
237 * G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE.
239 #define G_TYPE_RESERVED_BSE_FIRST (32)
241 * G_TYPE_RESERVED_BSE_LAST:
243 * Last fundamental type number reserved for BSE.
245 #define G_TYPE_RESERVED_BSE_LAST (48)
247 * G_TYPE_RESERVED_USER_FIRST:
249 * First available fundamental type number to create new fundamental
250 * type id with G_TYPE_MAKE_FUNDAMENTAL().
252 #define G_TYPE_RESERVED_USER_FIRST (49)
255 /* Type Checking Macros
258 * G_TYPE_IS_FUNDAMENTAL:
259 * @type: A #GType value
261 * Checks if @type is a fundamental type.
263 * Returns: %TRUE on success
265 #define G_TYPE_IS_FUNDAMENTAL(type) ((type) <= G_TYPE_FUNDAMENTAL_MAX)
268 * @type: A #GType value
270 * Checks if @type is derived (or in object-oriented terminology:
271 * inherited) from another type (this holds true for all non-fundamental
274 * Returns: %TRUE on success
276 #define G_TYPE_IS_DERIVED(type) ((type) > G_TYPE_FUNDAMENTAL_MAX)
278 * G_TYPE_IS_INTERFACE:
279 * @type: A #GType value
281 * Checks if @type is an interface type.
282 * An interface type provides a pure API, the implementation
283 * of which is provided by another type (which is then said to conform
284 * to the interface). GLib interfaces are somewhat analogous to Java
285 * interfaces and C++ classes containing only pure virtual functions,
286 * with the difference that GType interfaces are not derivable (but see
287 * g_type_interface_add_prerequisite() for an alternative).
289 * Returns: %TRUE on success
291 #define G_TYPE_IS_INTERFACE(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_INTERFACE)
294 * @type: A #GType value
296 * Checks if @type is a classed type.
298 * Returns: %TRUE on success
300 #define G_TYPE_IS_CLASSED(type) (g_type_test_flags ((type), G_TYPE_FLAG_CLASSED))
302 * G_TYPE_IS_INSTANTIATABLE:
303 * @type: A #GType value
305 * Checks if @type can be instantiated. Instantiation is the
306 * process of creating an instance (object) of this type.
308 * Returns: %TRUE on success
310 #define G_TYPE_IS_INSTANTIATABLE(type) (g_type_test_flags ((type), G_TYPE_FLAG_INSTANTIATABLE))
312 * G_TYPE_IS_DERIVABLE:
313 * @type: A #GType value
315 * Checks if @type is a derivable type. A derivable type can
316 * be used as the base class of a flat (single-level) class hierarchy.
318 * Returns: %TRUE on success
320 #define G_TYPE_IS_DERIVABLE(type) (g_type_test_flags ((type), G_TYPE_FLAG_DERIVABLE))
322 * G_TYPE_IS_DEEP_DERIVABLE:
323 * @type: A #GType value
325 * Checks if @type is a deep derivable type. A deep derivable type
326 * can be used as the base class of a deep (multi-level) class hierarchy.
328 * Returns: %TRUE on success
330 #define G_TYPE_IS_DEEP_DERIVABLE(type) (g_type_test_flags ((type), G_TYPE_FLAG_DEEP_DERIVABLE))
332 * G_TYPE_IS_ABSTRACT:
333 * @type: A #GType value
335 * Checks if @type is an abstract type. An abstract type cannot be
336 * instantiated and is normally used as an abstract base class for
339 * Returns: %TRUE on success
341 #define G_TYPE_IS_ABSTRACT(type) (g_type_test_flags ((type), G_TYPE_FLAG_ABSTRACT))
343 * G_TYPE_IS_VALUE_ABSTRACT:
344 * @type: A #GType value
346 * Checks if @type is an abstract value type. An abstract value type introduces
347 * a value table, but can't be used for g_value_init() and is normally used as
348 * an abstract base type for derived value types.
350 * Returns: %TRUE on success
352 #define G_TYPE_IS_VALUE_ABSTRACT(type) (g_type_test_flags ((type), G_TYPE_FLAG_VALUE_ABSTRACT))
354 * G_TYPE_IS_VALUE_TYPE:
355 * @type: A #GType value
357 * Checks if @type is a value type and can be used with g_value_init().
359 * Returns: %TRUE on success
361 #define G_TYPE_IS_VALUE_TYPE(type) (g_type_check_is_value_type (type))
363 * G_TYPE_HAS_VALUE_TABLE:
364 * @type: A #GType value
366 * Checks if @type has a #GTypeValueTable.
368 * Returns: %TRUE on success
370 #define G_TYPE_HAS_VALUE_TABLE(type) (g_type_value_table_peek (type) != NULL)
378 * A numerical value which represents the unique identifier of a registered
381 #if GLIB_SIZEOF_SIZE_T != GLIB_SIZEOF_LONG || !defined __cplusplus
383 #else /* for historic reasons, C++ links against gulong GTypes */
384 typedef gulong GType;
386 typedef struct _GValue GValue;
387 typedef union _GTypeCValue GTypeCValue;
388 typedef struct _GTypePlugin GTypePlugin;
389 typedef struct _GTypeClass GTypeClass;
390 typedef struct _GTypeInterface GTypeInterface;
391 typedef struct _GTypeInstance GTypeInstance;
392 typedef struct _GTypeInfo GTypeInfo;
393 typedef struct _GTypeFundamentalInfo GTypeFundamentalInfo;
394 typedef struct _GInterfaceInfo GInterfaceInfo;
395 typedef struct _GTypeValueTable GTypeValueTable;
396 typedef struct _GTypeQuery GTypeQuery;
399 /* Basic Type Structures
404 * An opaque structure used as the base of all classes.
414 * An opaque structure used as the base of all type instances.
416 struct _GTypeInstance
424 * An opaque structure used as the base of all interface types.
426 struct _GTypeInterface
429 GType g_type; /* iface type */
430 GType g_instance_type;
434 * @type: the #GType value of the type
435 * @type_name: the name of the type
436 * @class_size: the size of the class structure
437 * @instance_size: the size of the instance structure
439 * A structure holding information for a specific type.
440 * It is filled in by the g_type_query() function.
445 const gchar *type_name;
451 /* Casts, checks and accessors for structured types
452 * usage of these macros is reserved to type implementations only
456 * G_TYPE_CHECK_INSTANCE:
457 * @instance: Location of a #GTypeInstance structure
459 * Checks if @instance is a valid #GTypeInstance structure,
460 * otherwise issues a warning and returns %FALSE.
462 * This macro should only be used in type implementations.
464 * Returns: %TRUE on success
466 #define G_TYPE_CHECK_INSTANCE(instance) (_G_TYPE_CHI ((GTypeInstance*) (instance)))
468 * G_TYPE_CHECK_INSTANCE_CAST:
469 * @instance: Location of a #GTypeInstance structure
470 * @g_type: The type to be returned
471 * @c_type: The corresponding C type of @g_type
473 * Checks that @instance is an instance of the type identified by @g_type
474 * and issues a warning if this is not the case. Returns @instance casted
475 * to a pointer to @c_type.
477 * This macro should only be used in type implementations.
479 #define G_TYPE_CHECK_INSTANCE_CAST(instance, g_type, c_type) (_G_TYPE_CIC ((instance), (g_type), c_type))
481 * G_TYPE_CHECK_INSTANCE_TYPE:
482 * @instance: Location of a #GTypeInstance structure.
483 * @g_type: The type to be checked
485 * Checks if @instance is an instance of the type identified by @g_type.
487 * This macro should only be used in type implementations.
489 * Returns: %TRUE on success
491 #define G_TYPE_CHECK_INSTANCE_TYPE(instance, g_type) (_G_TYPE_CIT ((instance), (g_type)))
493 * G_TYPE_CHECK_INSTANCE_FUNDAMENTAL_TYPE:
494 * @instance: Location of a #GTypeInstance structure.
495 * @g_type: The fundamental type to be checked
497 * Checks if @instance is an instance of the fundamental type identified by @g_type.
499 * This macro should only be used in type implementations.
501 * Returns: %TRUE on success
503 #define G_TYPE_CHECK_INSTANCE_FUNDAMENTAL_TYPE(instance, g_type) (_G_TYPE_CIFT ((instance), (g_type)))
505 * G_TYPE_INSTANCE_GET_CLASS:
506 * @instance: Location of the #GTypeInstance structure
507 * @g_type: The #GType of the class to be returned
508 * @c_type: The C type of the class structure
510 * Get the class structure of a given @instance, casted
511 * to a specified ancestor type @g_type of the instance.
513 * Note that while calling a GInstanceInitFunc(), the class pointer
514 * gets modified, so it might not always return the expected pointer.
516 * This macro should only be used in type implementations.
518 * Returns: a pointer to the class structure
520 #define G_TYPE_INSTANCE_GET_CLASS(instance, g_type, c_type) (_G_TYPE_IGC ((instance), (g_type), c_type))
522 * G_TYPE_INSTANCE_GET_INTERFACE:
523 * @instance: Location of the #GTypeInstance structure
524 * @g_type: The #GType of the interface to be returned
525 * @c_type: The C type of the interface structure
527 * Get the interface structure for interface @g_type of a given @instance.
529 * This macro should only be used in type implementations.
531 * Returns: a pointer to the interface structure
533 #define G_TYPE_INSTANCE_GET_INTERFACE(instance, g_type, c_type) (_G_TYPE_IGI ((instance), (g_type), c_type))
535 * G_TYPE_CHECK_CLASS_CAST:
536 * @g_class: Location of a #GTypeClass structure
537 * @g_type: The type to be returned
538 * @c_type: The corresponding C type of class structure of @g_type
540 * Checks that @g_class is a class structure of the type identified by @g_type
541 * and issues a warning if this is not the case. Returns @g_class casted
542 * to a pointer to @c_type.
544 * This macro should only be used in type implementations.
546 #define G_TYPE_CHECK_CLASS_CAST(g_class, g_type, c_type) (_G_TYPE_CCC ((g_class), (g_type), c_type))
548 * G_TYPE_CHECK_CLASS_TYPE:
549 * @g_class: Location of a #GTypeClass structure
550 * @g_type: The type to be checked
552 * Checks if @g_class is a class structure of the type identified by
555 * This macro should only be used in type implementations.
557 * Returns: %TRUE on success
559 #define G_TYPE_CHECK_CLASS_TYPE(g_class, g_type) (_G_TYPE_CCT ((g_class), (g_type)))
561 * G_TYPE_CHECK_VALUE:
564 * Checks if @value has been initialized to hold values
567 * This macro should only be used in type implementations.
569 * Returns: %TRUE on success
571 #define G_TYPE_CHECK_VALUE(value) (_G_TYPE_CHV ((value)))
573 * G_TYPE_CHECK_VALUE_TYPE:
575 * @g_type: The type to be checked
577 * Checks if @value has been initialized to hold values
580 * This macro should only be used in type implementations.
582 * Returns: %TRUE on success
584 #define G_TYPE_CHECK_VALUE_TYPE(value, g_type) (_G_TYPE_CVH ((value), (g_type)))
586 * G_TYPE_FROM_INSTANCE:
587 * @instance: Location of a valid #GTypeInstance structure
589 * Get the type identifier from a given @instance structure.
591 * This macro should only be used in type implementations.
593 * Returns: the #GType
595 #define G_TYPE_FROM_INSTANCE(instance) (G_TYPE_FROM_CLASS (((GTypeInstance*) (instance))->g_class))
598 * @g_class: Location of a valid #GTypeClass structure
600 * Get the type identifier from a given @class structure.
602 * This macro should only be used in type implementations.
604 * Returns: the #GType
606 #define G_TYPE_FROM_CLASS(g_class) (((GTypeClass*) (g_class))->g_type)
608 * G_TYPE_FROM_INTERFACE:
609 * @g_iface: Location of a valid #GTypeInterface structure
611 * Get the type identifier from a given @interface structure.
613 * This macro should only be used in type implementations.
615 * Returns: the #GType
617 #define G_TYPE_FROM_INTERFACE(g_iface) (((GTypeInterface*) (g_iface))->g_type)
620 * G_TYPE_INSTANCE_GET_PRIVATE:
621 * @instance: the instance of a type deriving from @private_type
622 * @g_type: the type identifying which private data to retrieve
623 * @c_type: The C type for the private structure
625 * Gets the private structure for a particular type.
626 * The private structure must have been registered in the
627 * class_init function with g_type_class_add_private().
629 * This macro should only be used in type implementations.
632 * Returns: a pointer to the private data structure
634 #define G_TYPE_INSTANCE_GET_PRIVATE(instance, g_type, c_type) ((c_type*) g_type_instance_get_private ((GTypeInstance*) (instance), (g_type)))
637 * G_TYPE_CLASS_GET_PRIVATE:
638 * @klass: the class of a type deriving from @private_type
639 * @g_type: the type identifying which private data to retrieve
640 * @c_type: The C type for the private structure
642 * Gets the private class structure for a particular type.
643 * The private structure must have been registered in the
644 * get_type() function with g_type_add_class_private().
646 * This macro should only be used in type implementations.
649 * Returns: a pointer to the private data structure
651 #define G_TYPE_CLASS_GET_PRIVATE(klass, g_type, c_type) ((c_type*) g_type_class_get_private ((GTypeClass*) (klass), (g_type)))
655 * @G_TYPE_DEBUG_NONE: Print no messages
656 * @G_TYPE_DEBUG_OBJECTS: Print messages about object bookkeeping
657 * @G_TYPE_DEBUG_SIGNALS: Print messages about signal emissions
658 * @G_TYPE_DEBUG_MASK: Mask covering all debug flags
660 * These flags used to be passed to g_type_init_with_debug_flags() which
663 * If you need to enable debugging features, use the GOBJECT_DEBUG
664 * environment variable.
666 * Deprecated: 2.36: g_type_init() is now done automatically
668 typedef enum /*< skip >*/
670 G_TYPE_DEBUG_NONE = 0,
671 G_TYPE_DEBUG_OBJECTS = 1 << 0,
672 G_TYPE_DEBUG_SIGNALS = 1 << 1,
673 G_TYPE_DEBUG_MASK = 0x03
677 /* --- prototypes --- */
678 GLIB_DEPRECATED_IN_2_36
679 void g_type_init (void);
680 GLIB_DEPRECATED_IN_2_36
681 void g_type_init_with_debug_flags (GTypeDebugFlags debug_flags);
682 GLIB_AVAILABLE_IN_ALL
683 const gchar * g_type_name (GType type);
684 GLIB_AVAILABLE_IN_ALL
685 GQuark g_type_qname (GType type);
686 GLIB_AVAILABLE_IN_ALL
687 GType g_type_from_name (const gchar *name);
688 GLIB_AVAILABLE_IN_ALL
689 GType g_type_parent (GType type);
690 GLIB_AVAILABLE_IN_ALL
691 guint g_type_depth (GType type);
692 GLIB_AVAILABLE_IN_ALL
693 GType g_type_next_base (GType leaf_type,
695 GLIB_AVAILABLE_IN_ALL
696 gboolean g_type_is_a (GType type,
698 GLIB_AVAILABLE_IN_ALL
699 gpointer g_type_class_ref (GType type);
700 GLIB_AVAILABLE_IN_ALL
701 gpointer g_type_class_peek (GType type);
702 GLIB_AVAILABLE_IN_ALL
703 gpointer g_type_class_peek_static (GType type);
704 GLIB_AVAILABLE_IN_ALL
705 void g_type_class_unref (gpointer g_class);
706 GLIB_AVAILABLE_IN_ALL
707 gpointer g_type_class_peek_parent (gpointer g_class);
708 GLIB_AVAILABLE_IN_ALL
709 gpointer g_type_interface_peek (gpointer instance_class,
711 GLIB_AVAILABLE_IN_ALL
712 gpointer g_type_interface_peek_parent (gpointer g_iface);
714 GLIB_AVAILABLE_IN_ALL
715 gpointer g_type_default_interface_ref (GType g_type);
716 GLIB_AVAILABLE_IN_ALL
717 gpointer g_type_default_interface_peek (GType g_type);
718 GLIB_AVAILABLE_IN_ALL
719 void g_type_default_interface_unref (gpointer g_iface);
721 /* g_free() the returned arrays */
722 GLIB_AVAILABLE_IN_ALL
723 GType* g_type_children (GType type,
725 GLIB_AVAILABLE_IN_ALL
726 GType* g_type_interfaces (GType type,
727 guint *n_interfaces);
729 /* per-type _static_ data */
730 GLIB_AVAILABLE_IN_ALL
731 void g_type_set_qdata (GType type,
734 GLIB_AVAILABLE_IN_ALL
735 gpointer g_type_get_qdata (GType type,
737 GLIB_AVAILABLE_IN_ALL
738 void g_type_query (GType type,
742 /* --- type registration --- */
745 * @g_class: The #GTypeClass structure to initialize
747 * A callback function used by the type system to do base initialization
748 * of the class structures of derived types. It is called as part of the
749 * initialization process of all derived classes and should reallocate
750 * or reset all dynamic class members copied over from the parent class.
751 * For example, class members (such as strings) that are not sufficiently
752 * handled by a plain memory copy of the parent class into the derived class
753 * have to be altered. See GClassInitFunc() for a discussion of the class
754 * intialization process.
756 typedef void (*GBaseInitFunc) (gpointer g_class);
759 * @g_class: The #GTypeClass structure to finalize
761 * A callback function used by the type system to finalize those portions
762 * of a derived types class structure that were setup from the corresponding
763 * GBaseInitFunc() function. Class finalization basically works the inverse
764 * way in which class intialization is performed.
765 * See GClassInitFunc() for a discussion of the class intialization process.
767 typedef void (*GBaseFinalizeFunc) (gpointer g_class);
770 * @g_class: The #GTypeClass structure to initialize.
771 * @class_data: The @class_data member supplied via the #GTypeInfo structure.
773 * A callback function used by the type system to initialize the class
774 * of a specific type. This function should initialize all static class
777 * The initialization process of a class involves:
779 * - Copying common members from the parent class over to the
780 * derived class structure.
781 * - Zero initialization of the remaining members not copied
782 * over from the parent class.
783 * - Invocation of the GBaseInitFunc() initializers of all parent
784 * types and the class' type.
785 * - Invocation of the class' GClassInitFunc() initializer.
787 * Since derived classes are partially initialized through a memory copy
788 * of the parent class, the general rule is that GBaseInitFunc() and
789 * GBaseFinalizeFunc() should take care of necessary reinitialization
790 * and release of those class members that were introduced by the type
791 * that specified these GBaseInitFunc()/GBaseFinalizeFunc().
792 * GClassInitFunc() should only care about initializing static
793 * class members, while dynamic class members (such as allocated strings
794 * or reference counted resources) are better handled by a GBaseInitFunc()
795 * for this type, so proper initialization of the dynamic class members
796 * is performed for class initialization of derived types as well.
798 * An example may help to correspond the intend of the different class
801 * |[<!-- language="C" -->
803 * GObjectClass parent_class;
804 * gint static_integer;
805 * gchar *dynamic_string;
808 * type_a_base_class_init (TypeAClass *class)
810 * class->dynamic_string = g_strdup ("some string");
813 * type_a_base_class_finalize (TypeAClass *class)
815 * g_free (class->dynamic_string);
818 * type_a_class_init (TypeAClass *class)
820 * class->static_integer = 42;
824 * TypeAClass parent_class;
825 * gfloat static_float;
826 * GString *dynamic_gstring;
829 * type_b_base_class_init (TypeBClass *class)
831 * class->dynamic_gstring = g_string_new ("some other string");
834 * type_b_base_class_finalize (TypeBClass *class)
836 * g_string_free (class->dynamic_gstring);
839 * type_b_class_init (TypeBClass *class)
841 * class->static_float = 3.14159265358979323846;
844 * Initialization of TypeBClass will first cause initialization of
845 * TypeAClass (derived classes reference their parent classes, see
846 * g_type_class_ref() on this).
848 * Initialization of TypeAClass roughly involves zero-initializing its fields,
849 * then calling its GBaseInitFunc() type_a_base_class_init() to allocate
850 * its dynamic members (dynamic_string), and finally calling its GClassInitFunc()
851 * type_a_class_init() to initialize its static members (static_integer).
852 * The first step in the initialization process of TypeBClass is then
853 * a plain memory copy of the contents of TypeAClass into TypeBClass and
854 * zero-initialization of the remaining fields in TypeBClass.
855 * The dynamic members of TypeAClass within TypeBClass now need
856 * reinitialization which is performed by calling type_a_base_class_init()
857 * with an argument of TypeBClass.
859 * After that, the GBaseInitFunc() of TypeBClass, type_b_base_class_init()
860 * is called to allocate the dynamic members of TypeBClass (dynamic_gstring),
861 * and finally the GClassInitFunc() of TypeBClass, type_b_class_init(),
862 * is called to complete the initialization process with the static members
865 * Corresponding finalization counter parts to the GBaseInitFunc() functions
866 * have to be provided to release allocated resources at class finalization
869 typedef void (*GClassInitFunc) (gpointer g_class,
870 gpointer class_data);
872 * GClassFinalizeFunc:
873 * @g_class: The #GTypeClass structure to finalize
874 * @class_data: The @class_data member supplied via the #GTypeInfo structure
876 * A callback function used by the type system to finalize a class.
877 * This function is rarely needed, as dynamically allocated class resources
878 * should be handled by GBaseInitFunc() and GBaseFinalizeFunc().
879 * Also, specification of a GClassFinalizeFunc() in the #GTypeInfo
880 * structure of a static type is invalid, because classes of static types
881 * will never be finalized (they are artificially kept alive when their
882 * reference count drops to zero).
884 typedef void (*GClassFinalizeFunc) (gpointer g_class,
885 gpointer class_data);
888 * @instance: The instance to initialize
889 * @g_class: The class of the type the instance is created for
891 * A callback function used by the type system to initialize a new
892 * instance of a type. This function initializes all instance members and
893 * allocates any resources required by it.
895 * Initialization of a derived instance involves calling all its parent
896 * types instance initializers, so the class member of the instance
897 * is altered during its initialization to always point to the class that
898 * belongs to the type the current initializer was introduced for.
900 * The extended members of @instance are guaranteed to have been filled with
901 * zeros before this function is called.
903 typedef void (*GInstanceInitFunc) (GTypeInstance *instance,
906 * GInterfaceInitFunc:
907 * @g_iface: The interface structure to initialize
908 * @iface_data: The @interface_data supplied via the #GInterfaceInfo structure
910 * A callback function used by the type system to initialize a new
911 * interface. This function should initialize all internal data and
912 * allocate any resources required by the interface.
914 * The members of @iface_data are guaranteed to have been filled with
915 * zeros before this function is called.
917 typedef void (*GInterfaceInitFunc) (gpointer g_iface,
918 gpointer iface_data);
920 * GInterfaceFinalizeFunc:
921 * @g_iface: The interface structure to finalize
922 * @iface_data: The @interface_data supplied via the #GInterfaceInfo structure
924 * A callback function used by the type system to finalize an interface.
925 * This function should destroy any internal data and release any resources
926 * allocated by the corresponding GInterfaceInitFunc() function.
928 typedef void (*GInterfaceFinalizeFunc) (gpointer g_iface,
929 gpointer iface_data);
931 * GTypeClassCacheFunc:
932 * @cache_data: data that was given to the g_type_add_class_cache_func() call
933 * @g_class: The #GTypeClass structure which is unreferenced
935 * A callback function which is called when the reference count of a class
936 * drops to zero. It may use g_type_class_ref() to prevent the class from
937 * being freed. You should not call g_type_class_unref() from a
938 * #GTypeClassCacheFunc function to prevent infinite recursion, use
939 * g_type_class_unref_uncached() instead.
941 * The functions have to check the class id passed in to figure
942 * whether they actually want to cache the class of this type, since all
943 * classes are routed through the same #GTypeClassCacheFunc chain.
945 * Returns: %TRUE to stop further #GTypeClassCacheFuncs from being
946 * called, %FALSE to continue
948 typedef gboolean (*GTypeClassCacheFunc) (gpointer cache_data,
949 GTypeClass *g_class);
951 * GTypeInterfaceCheckFunc:
952 * @check_data: data passed to g_type_add_interface_check()
953 * @g_iface: the interface that has been initialized
955 * A callback called after an interface vtable is initialized.
956 * See g_type_add_interface_check().
960 typedef void (*GTypeInterfaceCheckFunc) (gpointer check_data,
963 * GTypeFundamentalFlags:
964 * @G_TYPE_FLAG_CLASSED: Indicates a classed type
965 * @G_TYPE_FLAG_INSTANTIATABLE: Indicates an instantiable type (implies classed)
966 * @G_TYPE_FLAG_DERIVABLE: Indicates a flat derivable type
967 * @G_TYPE_FLAG_DEEP_DERIVABLE: Indicates a deep derivable type (implies derivable)
969 * Bit masks used to check or determine specific characteristics of a
972 typedef enum /*< skip >*/
974 G_TYPE_FLAG_CLASSED = (1 << 0),
975 G_TYPE_FLAG_INSTANTIATABLE = (1 << 1),
976 G_TYPE_FLAG_DERIVABLE = (1 << 2),
977 G_TYPE_FLAG_DEEP_DERIVABLE = (1 << 3)
978 } GTypeFundamentalFlags;
981 * @G_TYPE_FLAG_ABSTRACT: Indicates an abstract type. No instances can be
982 * created for an abstract type
983 * @G_TYPE_FLAG_VALUE_ABSTRACT: Indicates an abstract value type, i.e. a type
984 * that introduces a value table, but can't be used for
987 * Bit masks used to check or determine characteristics of a type.
989 typedef enum /*< skip >*/
991 G_TYPE_FLAG_ABSTRACT = (1 << 4),
992 G_TYPE_FLAG_VALUE_ABSTRACT = (1 << 5)
996 * @class_size: Size of the class structure (required for interface, classed and instantiatable types)
997 * @base_init: Location of the base initialization function (optional)
998 * @base_finalize: Location of the base finalization function (optional)
999 * @class_init: Location of the class initialization function for
1000 * classed and instantiatable types. Location of the default vtable
1001 * inititalization function for interface types. (optional) This function
1002 * is used both to fill in virtual functions in the class or default vtable,
1003 * and to do type-specific setup such as registering signals and object
1005 * @class_finalize: Location of the class finalization function for
1006 * classed and instantiatable types. Location of the default vtable
1007 * finalization function for interface types. (optional)
1008 * @class_data: User-supplied data passed to the class init/finalize functions
1009 * @instance_size: Size of the instance (object) structure (required for instantiatable types only)
1010 * @n_preallocs: Prior to GLib 2.10, it specified the number of pre-allocated (cached) instances to reserve memory for (0 indicates no caching). Since GLib 2.10, it is ignored, since instances are allocated with the [slice allocator][glib-Memory-Slices] now.
1011 * @instance_init: Location of the instance initialization function (optional, for instantiatable types only)
1012 * @value_table: A #GTypeValueTable function table for generic handling of GValues
1013 * of this type (usually only useful for fundamental types)
1015 * This structure is used to provide the type system with the information
1016 * required to initialize and destruct (finalize) a type's class and
1019 * The initialized structure is passed to the g_type_register_static() function
1020 * (or is copied into the provided #GTypeInfo structure in the
1021 * g_type_plugin_complete_type_info()). The type system will perform a deep
1022 * copy of this structure, so its memory does not need to be persistent
1023 * across invocation of g_type_register_static().
1027 /* interface types, classed types, instantiated types */
1030 GBaseInitFunc base_init;
1031 GBaseFinalizeFunc base_finalize;
1033 /* interface types, classed types, instantiated types */
1034 GClassInitFunc class_init;
1035 GClassFinalizeFunc class_finalize;
1036 gconstpointer class_data;
1038 /* instantiated types */
1039 guint16 instance_size;
1040 guint16 n_preallocs;
1041 GInstanceInitFunc instance_init;
1043 /* value handling */
1044 const GTypeValueTable *value_table;
1047 * GTypeFundamentalInfo:
1048 * @type_flags: #GTypeFundamentalFlags describing the characteristics of the fundamental type
1050 * A structure that provides information to the type system which is
1051 * used specifically for managing fundamental types.
1053 struct _GTypeFundamentalInfo
1055 GTypeFundamentalFlags type_flags;
1059 * @interface_init: location of the interface initialization function
1060 * @interface_finalize: location of the interface finalization function
1061 * @interface_data: user-supplied data passed to the interface init/finalize functions
1063 * A structure that provides information to the type system which is
1064 * used specifically for managing interface types.
1066 struct _GInterfaceInfo
1068 GInterfaceInitFunc interface_init;
1069 GInterfaceFinalizeFunc interface_finalize;
1070 gpointer interface_data;
1074 * @value_init: Default initialize @values contents by poking values
1075 * directly into the value->data array. The data array of
1076 * the #GValue passed into this function was zero-filled
1077 * with `memset()`, so no care has to be taken to free any
1078 * old contents. E.g. for the implementation of a string
1079 * value that may never be %NULL, the implementation might
1081 * |[<!-- language="C" -->
1082 * value->data[0].v_pointer = g_strdup ("");
1084 * @value_free: Free any old contents that might be left in the
1085 * data array of the passed in @value. No resources may
1086 * remain allocated through the #GValue contents after
1087 * this function returns. E.g. for our above string type:
1088 * |[<!-- language="C" -->
1089 * // only free strings without a specific flag for static storage
1090 * if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
1091 * g_free (value->data[0].v_pointer);
1093 * @value_copy: @dest_value is a #GValue with zero-filled data section
1094 * and @src_value is a properly setup #GValue of same or
1096 * The purpose of this function is to copy the contents of
1097 * @src_value into @dest_value in a way, that even after
1098 * @src_value has been freed, the contents of @dest_value
1099 * remain valid. String type example:
1100 * |[<!-- language="C" -->
1101 * dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer);
1103 * @value_peek_pointer: If the value contents fit into a pointer, such as objects
1104 * or strings, return this pointer, so the caller can peek at
1105 * the current contents. To extend on our above string example:
1106 * |[<!-- language="C" -->
1107 * return value->data[0].v_pointer;
1109 * @collect_format: A string format describing how to collect the contents of
1110 * this value bit-by-bit. Each character in the format represents
1111 * an argument to be collected, and the characters themselves indicate
1112 * the type of the argument. Currently supported arguments are:
1114 * - 'i' - Integers. passed as collect_values[].v_int.
1115 * - 'l' - Longs. passed as collect_values[].v_long.
1116 * - 'd' - Doubles. passed as collect_values[].v_double.
1117 * - 'p' - Pointers. passed as collect_values[].v_pointer.
1119 * It should be noted that for variable argument list construction,
1120 * ANSI C promotes every type smaller than an integer to an int, and
1121 * floats to doubles. So for collection of short int or char, 'i'
1122 * needs to be used, and for collection of floats 'd'.
1123 * @collect_value: The collect_value() function is responsible for converting the
1124 * values collected from a variable argument list into contents
1125 * suitable for storage in a GValue. This function should setup
1126 * @value similar to value_init(); e.g. for a string value that
1127 * does not allow %NULL pointers, it needs to either spew an error,
1128 * or do an implicit conversion by storing an empty string.
1129 * The @value passed in to this function has a zero-filled data
1130 * array, so just like for value_init() it is guaranteed to not
1131 * contain any old contents that might need freeing.
1132 * @n_collect_values is exactly the string length of @collect_format,
1133 * and @collect_values is an array of unions #GTypeCValue with
1134 * length @n_collect_values, containing the collected values
1135 * according to @collect_format.
1136 * @collect_flags is an argument provided as a hint by the caller.
1137 * It may contain the flag %G_VALUE_NOCOPY_CONTENTS indicating,
1138 * that the collected value contents may be considered "static"
1139 * for the duration of the @value lifetime.
1140 * Thus an extra copy of the contents stored in @collect_values is
1141 * not required for assignment to @value.
1142 * For our above string example, we continue with:
1143 * |[<!-- language="C" -->
1144 * if (!collect_values[0].v_pointer)
1145 * value->data[0].v_pointer = g_strdup ("");
1146 * else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
1148 * value->data[0].v_pointer = collect_values[0].v_pointer;
1149 * // keep a flag for the value_free() implementation to not free this string
1150 * value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
1153 * value->data[0].v_pointer = g_strdup (collect_values[0].v_pointer);
1156 * It should be noted, that it is generally a bad idea to follow the
1157 * #G_VALUE_NOCOPY_CONTENTS hint for reference counted types. Due to
1158 * reentrancy requirements and reference count assertions performed
1159 * by the signal emission code, reference counts should always be
1160 * incremented for reference counted contents stored in the value->data
1161 * array. To deviate from our string example for a moment, and taking
1162 * a look at an exemplary implementation for collect_value() of
1164 * |[<!-- language="C" -->
1165 * if (collect_values[0].v_pointer)
1167 * GObject *object = G_OBJECT (collect_values[0].v_pointer);
1168 * // never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types
1169 * value->data[0].v_pointer = g_object_ref (object);
1173 * return g_strdup_printf ("Object passed as invalid NULL pointer");
1176 * The reference count for valid objects is always incremented,
1177 * regardless of @collect_flags. For invalid objects, the example
1178 * returns a newly allocated string without altering @value.
1179 * Upon success, collect_value() needs to return %NULL. If, however,
1180 * an error condition occurred, collect_value() may spew an
1181 * error by returning a newly allocated non-%NULL string, giving
1182 * a suitable description of the error condition.
1183 * The calling code makes no assumptions about the @value
1184 * contents being valid upon error returns, @value
1185 * is simply thrown away without further freeing. As such, it is
1186 * a good idea to not allocate #GValue contents, prior to returning
1187 * an error, however, collect_values() is not obliged to return
1188 * a correctly setup @value for error returns, simply because
1189 * any non-%NULL return is considered a fatal condition so further
1190 * program behaviour is undefined.
1191 * @lcopy_format: Format description of the arguments to collect for @lcopy_value,
1192 * analogous to @collect_format. Usually, @lcopy_format string consists
1193 * only of 'p's to provide lcopy_value() with pointers to storage locations.
1194 * @lcopy_value: This function is responsible for storing the @value contents into
1195 * arguments passed through a variable argument list which got
1196 * collected into @collect_values according to @lcopy_format.
1197 * @n_collect_values equals the string length of @lcopy_format,
1198 * and @collect_flags may contain %G_VALUE_NOCOPY_CONTENTS.
1199 * In contrast to collect_value(), lcopy_value() is obliged to
1200 * always properly support %G_VALUE_NOCOPY_CONTENTS.
1201 * Similar to collect_value() the function may prematurely abort
1202 * by returning a newly allocated string describing an error condition.
1203 * To complete the string example:
1204 * |[<!-- language="C" -->
1205 * gchar **string_p = collect_values[0].v_pointer;
1207 * return g_strdup_printf ("string location passed as NULL");
1208 * if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
1209 * *string_p = value->data[0].v_pointer;
1211 * *string_p = g_strdup (value->data[0].v_pointer);
1213 * And an illustrative version of lcopy_value() for
1214 * reference-counted types:
1215 * |[<!-- language="C" -->
1216 * GObject **object_p = collect_values[0].v_pointer;
1218 * return g_strdup_printf ("object location passed as NULL");
1219 * if (!value->data[0].v_pointer)
1221 * else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) // always honour
1222 * *object_p = value->data[0].v_pointer;
1224 * *object_p = g_object_ref (value->data[0].v_pointer);
1228 * The #GTypeValueTable provides the functions required by the #GValue
1229 * implementation, to serve as a container for values of a type.
1232 struct _GTypeValueTable
1234 void (*value_init) (GValue *value);
1235 void (*value_free) (GValue *value);
1236 void (*value_copy) (const GValue *src_value,
1237 GValue *dest_value);
1238 /* varargs functionality (optional) */
1239 gpointer (*value_peek_pointer) (const GValue *value);
1240 const gchar *collect_format;
1241 gchar* (*collect_value) (GValue *value,
1242 guint n_collect_values,
1243 GTypeCValue *collect_values,
1244 guint collect_flags);
1245 const gchar *lcopy_format;
1246 gchar* (*lcopy_value) (const GValue *value,
1247 guint n_collect_values,
1248 GTypeCValue *collect_values,
1249 guint collect_flags);
1251 GLIB_AVAILABLE_IN_ALL
1252 GType g_type_register_static (GType parent_type,
1253 const gchar *type_name,
1254 const GTypeInfo *info,
1256 GLIB_AVAILABLE_IN_ALL
1257 GType g_type_register_static_simple (GType parent_type,
1258 const gchar *type_name,
1260 GClassInitFunc class_init,
1261 guint instance_size,
1262 GInstanceInitFunc instance_init,
1265 GLIB_AVAILABLE_IN_ALL
1266 GType g_type_register_dynamic (GType parent_type,
1267 const gchar *type_name,
1268 GTypePlugin *plugin,
1270 GLIB_AVAILABLE_IN_ALL
1271 GType g_type_register_fundamental (GType type_id,
1272 const gchar *type_name,
1273 const GTypeInfo *info,
1274 const GTypeFundamentalInfo *finfo,
1276 GLIB_AVAILABLE_IN_ALL
1277 void g_type_add_interface_static (GType instance_type,
1278 GType interface_type,
1279 const GInterfaceInfo *info);
1280 GLIB_AVAILABLE_IN_ALL
1281 void g_type_add_interface_dynamic (GType instance_type,
1282 GType interface_type,
1283 GTypePlugin *plugin);
1284 GLIB_AVAILABLE_IN_ALL
1285 void g_type_interface_add_prerequisite (GType interface_type,
1286 GType prerequisite_type);
1287 GLIB_AVAILABLE_IN_ALL
1288 GType*g_type_interface_prerequisites (GType interface_type,
1289 guint *n_prerequisites);
1290 GLIB_AVAILABLE_IN_ALL
1291 void g_type_class_add_private (gpointer g_class,
1292 gsize private_size);
1293 GLIB_AVAILABLE_IN_2_38
1294 gint g_type_add_instance_private (GType class_type,
1295 gsize private_size);
1296 GLIB_AVAILABLE_IN_ALL
1297 gpointer g_type_instance_get_private (GTypeInstance *instance,
1298 GType private_type);
1299 GLIB_AVAILABLE_IN_2_38
1300 void g_type_class_adjust_private_offset (gpointer g_class,
1301 gint *private_size_or_offset);
1303 GLIB_AVAILABLE_IN_ALL
1304 void g_type_add_class_private (GType class_type,
1305 gsize private_size);
1306 GLIB_AVAILABLE_IN_ALL
1307 gpointer g_type_class_get_private (GTypeClass *klass,
1308 GType private_type);
1309 GLIB_AVAILABLE_IN_2_38
1310 gint g_type_class_get_instance_private_offset (gpointer g_class);
1312 GLIB_AVAILABLE_IN_2_34
1313 void g_type_ensure (GType type);
1314 GLIB_AVAILABLE_IN_2_36
1315 guint g_type_get_type_registration_serial (void);
1318 /* --- GType boilerplate --- */
1321 * @TN: The name of the new type, in Camel case.
1322 * @t_n: The name of the new type, in lowercase, with words
1324 * @T_P: The #GType of the parent type.
1326 * A convenience macro for type implementations, which declares a class
1327 * initialization function, an instance initialization function (see #GTypeInfo
1328 * for information about these) and a static variable named `t_n_parent_class`
1329 * pointing to the parent class. Furthermore, it defines a *_get_type() function.
1330 * See G_DEFINE_TYPE_EXTENDED() for an example.
1334 #define G_DEFINE_TYPE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
1336 * G_DEFINE_TYPE_WITH_CODE:
1337 * @TN: The name of the new type, in Camel case.
1338 * @t_n: The name of the new type in lowercase, with words separated by '_'.
1339 * @T_P: The #GType of the parent type.
1340 * @_C_: Custom code that gets inserted in the *_get_type() function.
1342 * A convenience macro for type implementations.
1343 * Similar to G_DEFINE_TYPE(), but allows you to insert custom code into the
1344 * *_get_type() function, e.g. interface implementations via G_IMPLEMENT_INTERFACE().
1345 * See G_DEFINE_TYPE_EXTENDED() for an example.
1349 #define G_DEFINE_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _G_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, 0) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1351 * G_DEFINE_TYPE_WITH_PRIVATE:
1352 * @TN: The name of the new type, in Camel case.
1353 * @t_n: The name of the new type, in lowercase, with words
1355 * @T_P: The #GType of the parent type.
1357 * A convenience macro for type implementations, which declares a class
1358 * initialization function, an instance initialization function (see #GTypeInfo
1359 * for information about these), a static variable named `t_n_parent_class`
1360 * pointing to the parent class, and adds private instance data to the type.
1361 * Furthermore, it defines a *_get_type() function. See G_DEFINE_TYPE_EXTENDED()
1364 * Note that private structs added with this macros must have a struct
1365 * name of the form @TN Private.
1369 #define G_DEFINE_TYPE_WITH_PRIVATE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, G_ADD_PRIVATE (TN))
1371 * G_DEFINE_ABSTRACT_TYPE:
1372 * @TN: The name of the new type, in Camel case.
1373 * @t_n: The name of the new type, in lowercase, with words
1375 * @T_P: The #GType of the parent type.
1377 * A convenience macro for type implementations.
1378 * Similar to G_DEFINE_TYPE(), but defines an abstract type.
1379 * See G_DEFINE_TYPE_EXTENDED() for an example.
1383 #define G_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
1385 * G_DEFINE_ABSTRACT_TYPE_WITH_CODE:
1386 * @TN: The name of the new type, in Camel case.
1387 * @t_n: The name of the new type, in lowercase, with words
1389 * @T_P: The #GType of the parent type.
1390 * @_C_: Custom code that gets inserted in the @type_name_get_type() function.
1392 * A convenience macro for type implementations.
1393 * Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and
1394 * allows you to insert custom code into the *_get_type() function, e.g.
1395 * interface implementations via G_IMPLEMENT_INTERFACE().
1396 * See G_DEFINE_TYPE_EXTENDED() for an example.
1400 #define G_DEFINE_ABSTRACT_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _G_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1402 * G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE:
1403 * @TN: The name of the new type, in Camel case.
1404 * @t_n: The name of the new type, in lowercase, with words
1406 * @T_P: The #GType of the parent type.
1408 * Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type.
1409 * See G_DEFINE_TYPE_EXTENDED() for an example.
1413 #define G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, G_ADD_PRIVATE (TN))
1415 * G_DEFINE_TYPE_EXTENDED:
1416 * @TN: The name of the new type, in Camel case.
1417 * @t_n: The name of the new type, in lowercase, with words
1419 * @T_P: The #GType of the parent type.
1420 * @_f_: #GTypeFlags to pass to g_type_register_static()
1421 * @_C_: Custom code that gets inserted in the *_get_type() function.
1423 * The most general convenience macro for type implementations, on which
1424 * G_DEFINE_TYPE(), etc are based.
1426 * |[<!-- language="C" -->
1427 * G_DEFINE_TYPE_EXTENDED (GtkGadget,
1431 * G_IMPLEMENT_INTERFACE (TYPE_GIZMO,
1432 * gtk_gadget_gizmo_init));
1435 * |[<!-- language="C" -->
1436 * static void gtk_gadget_init (GtkGadget *self);
1437 * static void gtk_gadget_class_init (GtkGadgetClass *klass);
1438 * static gpointer gtk_gadget_parent_class = NULL;
1439 * static void gtk_gadget_class_intern_init (gpointer klass)
1441 * gtk_gadget_parent_class = g_type_class_peek_parent (klass);
1442 * gtk_gadget_class_init ((GtkGadgetClass*) klass);
1446 * gtk_gadget_get_type (void)
1448 * static volatile gsize g_define_type_id__volatile = 0;
1449 * if (g_once_init_enter (&g_define_type_id__volatile))
1451 * GType g_define_type_id =
1452 * g_type_register_static_simple (GTK_TYPE_WIDGET,
1453 * g_intern_static_string ("GtkGadget"),
1454 * sizeof (GtkGadgetClass),
1455 * (GClassInitFunc) gtk_gadget_class_intern_init,
1456 * sizeof (GtkGadget),
1457 * (GInstanceInitFunc) gtk_gadget_init,
1460 * const GInterfaceInfo g_implement_interface_info = {
1461 * (GInterfaceInitFunc) gtk_gadget_gizmo_init
1463 * g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info);
1465 * g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
1467 * return g_define_type_id__volatile;
1470 * The only pieces which have to be manually provided are the definitions of
1471 * the instance and class structure and the definitions of the instance and
1472 * class init functions.
1476 #define G_DEFINE_TYPE_EXTENDED(TN, t_n, T_P, _f_, _C_) _G_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, _f_) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1479 * G_DEFINE_INTERFACE:
1480 * @TN: The name of the new type, in Camel case.
1481 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
1482 * @T_P: The #GType of the prerequisite type for the interface, or 0
1483 * (%G_TYPE_INVALID) for no prerequisite type.
1485 * A convenience macro for #GTypeInterface definitions, which declares
1486 * a default vtable initialization function and defines a *_get_type()
1489 * The macro expects the interface initialization function to have the
1490 * name `t_n ## _default_init`, and the interface structure to have the
1491 * name `TN ## Interface`.
1495 #define G_DEFINE_INTERFACE(TN, t_n, T_P) G_DEFINE_INTERFACE_WITH_CODE(TN, t_n, T_P, ;)
1498 * G_DEFINE_INTERFACE_WITH_CODE:
1499 * @TN: The name of the new type, in Camel case.
1500 * @t_n: The name of the new type, in lowercase, with words separated by '_'.
1501 * @T_P: The #GType of the prerequisite type for the interface, or 0
1502 * (%G_TYPE_INVALID) for no prerequisite type.
1503 * @_C_: Custom code that gets inserted in the *_get_type() function.
1505 * A convenience macro for #GTypeInterface definitions. Similar to
1506 * G_DEFINE_INTERFACE(), but allows you to insert custom code into the
1507 * *_get_type() function, e.g. additional interface implementations
1508 * via G_IMPLEMENT_INTERFACE(), or additional prerequisite types. See
1509 * G_DEFINE_TYPE_EXTENDED() for a similar example using
1510 * G_DEFINE_TYPE_WITH_CODE().
1514 #define G_DEFINE_INTERFACE_WITH_CODE(TN, t_n, T_P, _C_) _G_DEFINE_INTERFACE_EXTENDED_BEGIN(TN, t_n, T_P) {_C_;} _G_DEFINE_INTERFACE_EXTENDED_END()
1517 * G_IMPLEMENT_INTERFACE:
1518 * @TYPE_IFACE: The #GType of the interface to add
1519 * @iface_init: The interface init function
1521 * A convenience macro to ease interface addition in the `_C_` section
1522 * of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
1523 * See G_DEFINE_TYPE_EXTENDED() for an example.
1525 * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1526 * macros, since it depends on variable names from those macros.
1530 #define G_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) { \
1531 const GInterfaceInfo g_implement_interface_info = { \
1532 (GInterfaceInitFunc) iface_init, NULL, NULL \
1534 g_type_add_interface_static (g_define_type_id, TYPE_IFACE, &g_implement_interface_info); \
1539 * @TypeName: the name of the type in CamelCase
1541 * A convenience macro to ease adding private data to instances of a new type
1542 * in the @_C_ section of G_DEFINE_TYPE_WITH_CODE() or
1543 * G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
1547 * |[<!-- language="C" -->
1548 * typedef struct _MyObject MyObject;
1549 * typedef struct _MyObjectClass MyObjectClass;
1554 * } MyObjectPrivate;
1556 * G_DEFINE_TYPE_WITH_CODE (MyObject, my_object, G_TYPE_OBJECT,
1557 * G_ADD_PRIVATE (MyObject))
1560 * Will add MyObjectPrivate as the private data to any instance of the MyObject
1563 * G_DEFINE_TYPE_* macros will automatically create a private function
1564 * based on the arguments to this macro, which can be used to safely
1565 * retrieve the private data from an instance of the type; for instance:
1567 * |[<!-- language="C" -->
1569 * my_object_get_foo (MyObject *obj)
1571 * MyObjectPrivate *priv = my_object_get_instance_private (obj);
1577 * my_object_set_bar (MyObject *obj,
1580 * MyObjectPrivate *priv = my_object_get_instance_private (obj);
1582 * if (priv->bar != bar)
1587 * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1588 * macros, since it depends on variable names from those macros.
1590 * Also note that private structs added with these macros must have a struct
1591 * name of the form `TypeNamePrivate`.
1595 #define G_ADD_PRIVATE(TypeName) { \
1596 TypeName##_private_offset = \
1597 g_type_add_instance_private (g_define_type_id, sizeof (TypeName##Private)); \
1602 * @TypeName: the name of the type in CamelCase
1603 * @field: the name of the field in the private data structure
1605 * Evaluates to the offset of the @field inside the instance private data
1606 * structure for @TypeName.
1608 * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1609 * and G_ADD_PRIVATE() macros, since it depends on variable names from
1614 #define G_PRIVATE_OFFSET(TypeName, field) \
1615 (TypeName##_private_offset + (G_STRUCT_OFFSET (TypeName##Private, field)))
1618 * G_PRIVATE_FIELD_P:
1619 * @TypeName: the name of the type in CamelCase
1620 * @inst: the instance of @TypeName you wish to access
1621 * @field_name: the name of the field in the private data structure
1623 * Evaluates to a pointer to the @field_name inside the @inst private data
1624 * structure for @TypeName.
1626 * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1627 * and G_ADD_PRIVATE() macros, since it depends on variable names from
1632 #define G_PRIVATE_FIELD_P(TypeName, inst, field_name) \
1633 G_STRUCT_MEMBER_P (inst, G_PRIVATE_OFFSET (TypeName, field_name))
1637 * @TypeName: the name of the type in CamelCase
1638 * @inst: the instance of @TypeName you wish to access
1639 * @field_type: the type of the field in the private data structure
1640 * @field_name: the name of the field in the private data structure
1642 * Evaluates to the @field_name inside the @inst private data
1643 * structure for @TypeName.
1645 * Note that this macro can only be used together with the G_DEFINE_TYPE_*
1646 * and G_ADD_PRIVATE() macros, since it depends on variable names from
1651 #define G_PRIVATE_FIELD(TypeName, inst, field_type, field_name) \
1652 G_STRUCT_MEMBER (field_type, inst, G_PRIVATE_OFFSET (TypeName, field_name))
1654 /* we need to have this macro under conditional expansion, as it references
1655 * a function that has been added in 2.38. see bug:
1656 * https://bugzilla.gnome.org/show_bug.cgi?id=703191
1658 #if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38
1659 #define _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
1660 static void type_name##_class_intern_init (gpointer klass) \
1662 type_name##_parent_class = g_type_class_peek_parent (klass); \
1663 if (TypeName##_private_offset != 0) \
1664 g_type_class_adjust_private_offset (klass, &TypeName##_private_offset); \
1665 type_name##_class_init ((TypeName##Class*) klass); \
1669 #define _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
1670 static void type_name##_class_intern_init (gpointer klass) \
1672 type_name##_parent_class = g_type_class_peek_parent (klass); \
1673 type_name##_class_init ((TypeName##Class*) klass); \
1675 #endif /* GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38 */
1677 #define _G_DEFINE_TYPE_EXTENDED_BEGIN(TypeName, type_name, TYPE_PARENT, flags) \
1679 static void type_name##_init (TypeName *self); \
1680 static void type_name##_class_init (TypeName##Class *klass); \
1681 static gpointer type_name##_parent_class = NULL; \
1682 static gint TypeName##_private_offset; \
1684 _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
1687 static inline gpointer \
1688 type_name##_get_instance_private (TypeName *self) \
1690 return (G_STRUCT_MEMBER_P (self, TypeName##_private_offset)); \
1694 type_name##_get_type (void) \
1696 static volatile gsize g_define_type_id__volatile = 0; \
1697 if (g_once_init_enter (&g_define_type_id__volatile)) \
1699 GType g_define_type_id = \
1700 g_type_register_static_simple (TYPE_PARENT, \
1701 g_intern_static_string (#TypeName), \
1702 sizeof (TypeName##Class), \
1703 (GClassInitFunc) type_name##_class_intern_init, \
1704 sizeof (TypeName), \
1705 (GInstanceInitFunc) type_name##_init, \
1706 (GTypeFlags) flags); \
1707 { /* custom code follows */
1708 #define _G_DEFINE_TYPE_EXTENDED_END() \
1709 /* following custom code */ \
1711 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
1713 return g_define_type_id__volatile; \
1714 } /* closes type_name##_get_type() */
1716 #define _G_DEFINE_INTERFACE_EXTENDED_BEGIN(TypeName, type_name, TYPE_PREREQ) \
1718 static void type_name##_default_init (TypeName##Interface *klass); \
1721 type_name##_get_type (void) \
1723 static volatile gsize g_define_type_id__volatile = 0; \
1724 if (g_once_init_enter (&g_define_type_id__volatile)) \
1726 GType g_define_type_id = \
1727 g_type_register_static_simple (G_TYPE_INTERFACE, \
1728 g_intern_static_string (#TypeName), \
1729 sizeof (TypeName##Interface), \
1730 (GClassInitFunc)type_name##_default_init, \
1732 (GInstanceInitFunc)NULL, \
1735 g_type_interface_add_prerequisite (g_define_type_id, TYPE_PREREQ); \
1736 { /* custom code follows */
1737 #define _G_DEFINE_INTERFACE_EXTENDED_END() \
1738 /* following custom code */ \
1740 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id); \
1742 return g_define_type_id__volatile; \
1743 } /* closes type_name##_get_type() */
1746 * G_DEFINE_BOXED_TYPE:
1747 * @TypeName: The name of the new type, in Camel case
1748 * @type_name: The name of the new type, in lowercase, with words
1750 * @copy_func: the #GBoxedCopyFunc for the new type
1751 * @free_func: the #GBoxedFreeFunc for the new type
1753 * A convenience macro for boxed type implementations, which defines a
1754 * type_name_get_type() function registering the boxed type.
1758 #define G_DEFINE_BOXED_TYPE(TypeName, type_name, copy_func, free_func) G_DEFINE_BOXED_TYPE_WITH_CODE (TypeName, type_name, copy_func, free_func, {})
1760 * G_DEFINE_BOXED_TYPE_WITH_CODE:
1761 * @TypeName: The name of the new type, in Camel case
1762 * @type_name: The name of the new type, in lowercase, with words
1764 * @copy_func: the #GBoxedCopyFunc for the new type
1765 * @free_func: the #GBoxedFreeFunc for the new type
1766 * @_C_: Custom code that gets inserted in the *_get_type() function
1768 * A convenience macro for boxed type implementations.
1769 * Similar to G_DEFINE_BOXED_TYPE(), but allows to insert custom code into the
1770 * type_name_get_type() function, e.g. to register value transformations with
1771 * g_value_register_transform_func().
1775 #define G_DEFINE_BOXED_TYPE_WITH_CODE(TypeName, type_name, copy_func, free_func, _C_) _G_DEFINE_BOXED_TYPE_BEGIN (TypeName, type_name, copy_func, free_func) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1777 /* Only use this in non-C++ on GCC >= 2.7, except for Darwin/ppc64.
1778 * See https://bugzilla.gnome.org/show_bug.cgi?id=647145
1780 #if !defined (__cplusplus) && (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)) && !(defined (__APPLE__) && defined (__ppc64__))
1781 #define _G_DEFINE_BOXED_TYPE_BEGIN(TypeName, type_name, copy_func, free_func) \
1783 type_name##_get_type (void) \
1785 static volatile gsize g_define_type_id__volatile = 0; \
1786 if (g_once_init_enter (&g_define_type_id__volatile)) \
1788 GType (* _g_register_boxed) \
1792 TypeName * (*do_copy_type) (TypeName *); \
1793 TypeName * (*do_const_copy_type) (const TypeName *); \
1794 GBoxedCopyFunc do_copy_boxed; \
1795 } __attribute__((__transparent_union__)), \
1798 void (* do_free_type) (TypeName *); \
1799 GBoxedFreeFunc do_free_boxed; \
1800 } __attribute__((__transparent_union__)) \
1801 ) = g_boxed_type_register_static; \
1802 GType g_define_type_id = \
1803 _g_register_boxed (g_intern_static_string (#TypeName), copy_func, free_func); \
1804 { /* custom code follows */
1806 #define _G_DEFINE_BOXED_TYPE_BEGIN(TypeName, type_name, copy_func, free_func) \
1808 type_name##_get_type (void) \
1810 static volatile gsize g_define_type_id__volatile = 0; \
1811 if (g_once_init_enter (&g_define_type_id__volatile)) \
1813 GType g_define_type_id = \
1814 g_boxed_type_register_static (g_intern_static_string (#TypeName), \
1815 (GBoxedCopyFunc) copy_func, \
1816 (GBoxedFreeFunc) free_func); \
1817 { /* custom code follows */
1818 #endif /* __GNUC__ */
1821 * G_DEFINE_POINTER_TYPE:
1822 * @TypeName: The name of the new type, in Camel case
1823 * @type_name: The name of the new type, in lowercase, with words
1826 * A convenience macro for pointer type implementations, which defines a
1827 * type_name_get_type() function registering the pointer type.
1831 #define G_DEFINE_POINTER_TYPE(TypeName, type_name) G_DEFINE_POINTER_TYPE_WITH_CODE (TypeName, type_name, {})
1833 * G_DEFINE_POINTER_TYPE_WITH_CODE:
1834 * @TypeName: The name of the new type, in Camel case
1835 * @type_name: The name of the new type, in lowercase, with words
1837 * @_C_: Custom code that gets inserted in the *_get_type() function
1839 * A convenience macro for pointer type implementations.
1840 * Similar to G_DEFINE_POINTER_TYPE(), but allows to insert
1841 * custom code into the type_name_get_type() function.
1845 #define G_DEFINE_POINTER_TYPE_WITH_CODE(TypeName, type_name, _C_) _G_DEFINE_POINTER_TYPE_BEGIN (TypeName, type_name) {_C_;} _G_DEFINE_TYPE_EXTENDED_END()
1847 #define _G_DEFINE_POINTER_TYPE_BEGIN(TypeName, type_name) \
1849 type_name##_get_type (void) \
1851 static volatile gsize g_define_type_id__volatile = 0; \
1852 if (g_once_init_enter (&g_define_type_id__volatile)) \
1854 GType g_define_type_id = \
1855 g_pointer_type_register_static (g_intern_static_string (#TypeName)); \
1856 { /* custom code follows */
1858 /* --- protected (for fundamental type implementations) --- */
1859 GLIB_AVAILABLE_IN_ALL
1860 GTypePlugin* g_type_get_plugin (GType type);
1861 GLIB_AVAILABLE_IN_ALL
1862 GTypePlugin* g_type_interface_get_plugin (GType instance_type,
1863 GType interface_type);
1864 GLIB_AVAILABLE_IN_ALL
1865 GType g_type_fundamental_next (void);
1866 GLIB_AVAILABLE_IN_ALL
1867 GType g_type_fundamental (GType type_id);
1868 GLIB_AVAILABLE_IN_ALL
1869 GTypeInstance* g_type_create_instance (GType type);
1870 GLIB_AVAILABLE_IN_ALL
1871 void g_type_free_instance (GTypeInstance *instance);
1873 GLIB_AVAILABLE_IN_ALL
1874 void g_type_add_class_cache_func (gpointer cache_data,
1875 GTypeClassCacheFunc cache_func);
1876 GLIB_AVAILABLE_IN_ALL
1877 void g_type_remove_class_cache_func (gpointer cache_data,
1878 GTypeClassCacheFunc cache_func);
1879 GLIB_AVAILABLE_IN_ALL
1880 void g_type_class_unref_uncached (gpointer g_class);
1882 GLIB_AVAILABLE_IN_ALL
1883 void g_type_add_interface_check (gpointer check_data,
1884 GTypeInterfaceCheckFunc check_func);
1885 GLIB_AVAILABLE_IN_ALL
1886 void g_type_remove_interface_check (gpointer check_data,
1887 GTypeInterfaceCheckFunc check_func);
1889 GLIB_AVAILABLE_IN_ALL
1890 GTypeValueTable* g_type_value_table_peek (GType type);
1894 GLIB_AVAILABLE_IN_ALL
1895 gboolean g_type_check_instance (GTypeInstance *instance) G_GNUC_PURE;
1896 GLIB_AVAILABLE_IN_ALL
1897 GTypeInstance* g_type_check_instance_cast (GTypeInstance *instance,
1899 GLIB_AVAILABLE_IN_ALL
1900 gboolean g_type_check_instance_is_a (GTypeInstance *instance,
1901 GType iface_type) G_GNUC_PURE;
1902 GLIB_AVAILABLE_IN_2_42
1903 gboolean g_type_check_instance_is_fundamentally_a (GTypeInstance *instance,
1904 GType fundamental_type) G_GNUC_PURE;
1905 GLIB_AVAILABLE_IN_ALL
1906 GTypeClass* g_type_check_class_cast (GTypeClass *g_class,
1908 GLIB_AVAILABLE_IN_ALL
1909 gboolean g_type_check_class_is_a (GTypeClass *g_class,
1910 GType is_a_type) G_GNUC_PURE;
1911 GLIB_AVAILABLE_IN_ALL
1912 gboolean g_type_check_is_value_type (GType type) G_GNUC_CONST;
1913 GLIB_AVAILABLE_IN_ALL
1914 gboolean g_type_check_value (GValue *value) G_GNUC_PURE;
1915 GLIB_AVAILABLE_IN_ALL
1916 gboolean g_type_check_value_holds (GValue *value,
1917 GType type) G_GNUC_PURE;
1918 GLIB_AVAILABLE_IN_ALL
1919 gboolean g_type_test_flags (GType type,
1920 guint flags) G_GNUC_CONST;
1923 /* --- debugging functions --- */
1924 GLIB_AVAILABLE_IN_ALL
1925 const gchar * g_type_name_from_instance (GTypeInstance *instance);
1926 GLIB_AVAILABLE_IN_ALL
1927 const gchar * g_type_name_from_class (GTypeClass *g_class);
1930 /* --- implementation bits --- */
1931 #ifndef G_DISABLE_CAST_CHECKS
1932 # define _G_TYPE_CIC(ip, gt, ct) \
1933 ((ct*) g_type_check_instance_cast ((GTypeInstance*) ip, gt))
1934 # define _G_TYPE_CCC(cp, gt, ct) \
1935 ((ct*) g_type_check_class_cast ((GTypeClass*) cp, gt))
1936 #else /* G_DISABLE_CAST_CHECKS */
1937 # define _G_TYPE_CIC(ip, gt, ct) ((ct*) ip)
1938 # define _G_TYPE_CCC(cp, gt, ct) ((ct*) cp)
1939 #endif /* G_DISABLE_CAST_CHECKS */
1940 #define _G_TYPE_CHI(ip) (g_type_check_instance ((GTypeInstance*) ip))
1941 #define _G_TYPE_CHV(vl) (g_type_check_value ((GValue*) vl))
1942 #define _G_TYPE_IGC(ip, gt, ct) ((ct*) (((GTypeInstance*) ip)->g_class))
1943 #define _G_TYPE_IGI(ip, gt, ct) ((ct*) g_type_interface_peek (((GTypeInstance*) ip)->g_class, gt))
1944 #define _G_TYPE_CIFT(ip, ft) (g_type_check_instance_is_fundamentally_a ((GTypeInstance*) ip, ft))
1946 # define _G_TYPE_CIT(ip, gt) (G_GNUC_EXTENSION ({ \
1947 GTypeInstance *__inst = (GTypeInstance*) ip; GType __t = gt; gboolean __r; \
1950 else if (__inst->g_class && __inst->g_class->g_type == __t) \
1953 __r = g_type_check_instance_is_a (__inst, __t); \
1956 # define _G_TYPE_CCT(cp, gt) (G_GNUC_EXTENSION ({ \
1957 GTypeClass *__class = (GTypeClass*) cp; GType __t = gt; gboolean __r; \
1960 else if (__class->g_type == __t) \
1963 __r = g_type_check_class_is_a (__class, __t); \
1966 # define _G_TYPE_CVH(vl, gt) (G_GNUC_EXTENSION ({ \
1967 GValue *__val = (GValue*) vl; GType __t = gt; gboolean __r; \
1970 else if (__val->g_type == __t) \
1973 __r = g_type_check_value_holds (__val, __t); \
1976 #else /* !__GNUC__ */
1977 # define _G_TYPE_CIT(ip, gt) (g_type_check_instance_is_a ((GTypeInstance*) ip, gt))
1978 # define _G_TYPE_CCT(cp, gt) (g_type_check_class_is_a ((GTypeClass*) cp, gt))
1979 # define _G_TYPE_CVH(vl, gt) (g_type_check_value_holds ((GValue*) vl, gt))
1980 #endif /* !__GNUC__ */
1982 * G_TYPE_FLAG_RESERVED_ID_BIT:
1984 * A bit in the type number that's supposed to be left untouched.
1986 #define G_TYPE_FLAG_RESERVED_ID_BIT ((GType) (1 << 0))
1987 extern GTypeDebugFlags _g_type_debug_flags;
1991 #endif /* __G_TYPE_H__ */