1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
4 * SPDX-License-Identifier: LGPL-2.1-or-later
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General
17 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
22 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
23 #error "Only <glib-object.h> can be included directly."
27 #include <gobject/gobject-visibility.h>
35 * @type: A #GType value.
37 * The fundamental type which is the ancestor of @type.
39 * Fundamental types are types that serve as ultimate bases for the derived types,
40 * thus they are the roots of distinct inheritance hierarchies.
42 #define G_TYPE_FUNDAMENTAL(type) (g_type_fundamental (type))
44 * G_TYPE_FUNDAMENTAL_SHIFT:
46 * Shift value used in converting numbers to type IDs.
48 #define G_TYPE_FUNDAMENTAL_SHIFT (2)
50 * G_TYPE_FUNDAMENTAL_MAX: (value 1020)
52 * An integer constant that represents the number of identifiers reserved
53 * for types that are assigned at compile-time.
55 #define G_TYPE_FUNDAMENTAL_MAX (255 << G_TYPE_FUNDAMENTAL_SHIFT)
57 /* Constant fundamental types,
62 * An invalid #GType used as error return value in some functions which return
65 #define G_TYPE_INVALID G_TYPE_MAKE_FUNDAMENTAL (0)
69 * A fundamental type which is used as a replacement for the C
72 #define G_TYPE_NONE G_TYPE_MAKE_FUNDAMENTAL (1)
76 * The fundamental type from which all interfaces are derived.
78 #define G_TYPE_INTERFACE G_TYPE_MAKE_FUNDAMENTAL (2)
82 * The fundamental type corresponding to #gchar.
84 * The type designated by %G_TYPE_CHAR is unconditionally an 8-bit signed integer.
85 * This may or may not be the same type a the C type "gchar".
87 #define G_TYPE_CHAR G_TYPE_MAKE_FUNDAMENTAL (3)
91 * The fundamental type corresponding to #guchar.
93 #define G_TYPE_UCHAR G_TYPE_MAKE_FUNDAMENTAL (4)
97 * The fundamental type corresponding to #gboolean.
99 #define G_TYPE_BOOLEAN G_TYPE_MAKE_FUNDAMENTAL (5)
103 * The fundamental type corresponding to #gint.
105 #define G_TYPE_INT G_TYPE_MAKE_FUNDAMENTAL (6)
109 * The fundamental type corresponding to #guint.
111 #define G_TYPE_UINT G_TYPE_MAKE_FUNDAMENTAL (7)
115 * The fundamental type corresponding to #glong.
117 #define G_TYPE_LONG G_TYPE_MAKE_FUNDAMENTAL (8)
121 * The fundamental type corresponding to #gulong.
123 #define G_TYPE_ULONG G_TYPE_MAKE_FUNDAMENTAL (9)
127 * The fundamental type corresponding to #gint64.
129 #define G_TYPE_INT64 G_TYPE_MAKE_FUNDAMENTAL (10)
133 * The fundamental type corresponding to #guint64.
135 #define G_TYPE_UINT64 G_TYPE_MAKE_FUNDAMENTAL (11)
139 * The fundamental type from which all enumeration types are derived.
141 #define G_TYPE_ENUM G_TYPE_MAKE_FUNDAMENTAL (12)
145 * The fundamental type from which all flags types are derived.
147 #define G_TYPE_FLAGS G_TYPE_MAKE_FUNDAMENTAL (13)
151 * The fundamental type corresponding to #gfloat.
153 #define G_TYPE_FLOAT G_TYPE_MAKE_FUNDAMENTAL (14)
157 * The fundamental type corresponding to #gdouble.
159 #define G_TYPE_DOUBLE G_TYPE_MAKE_FUNDAMENTAL (15)
163 * The fundamental type corresponding to nul-terminated C strings.
165 #define G_TYPE_STRING G_TYPE_MAKE_FUNDAMENTAL (16)
169 * The fundamental type corresponding to #gpointer.
171 #define G_TYPE_POINTER G_TYPE_MAKE_FUNDAMENTAL (17)
175 * The fundamental type from which all boxed types are derived.
177 #define G_TYPE_BOXED G_TYPE_MAKE_FUNDAMENTAL (18)
181 * The fundamental type from which all #GParamSpec types are derived.
183 #define G_TYPE_PARAM G_TYPE_MAKE_FUNDAMENTAL (19)
187 * The fundamental type for #GObject.
189 #define G_TYPE_OBJECT G_TYPE_MAKE_FUNDAMENTAL (20)
193 * The fundamental type corresponding to #GVariant.
195 * All floating #GVariant instances passed through the #GType system are
198 * Note that callbacks in closures, and signal handlers
199 * for signals of return type %G_TYPE_VARIANT, must never return floating
202 * Note: GLib 2.24 did include a boxed type with this name. It was replaced
203 * with this fundamental type in 2.26.
207 #define G_TYPE_VARIANT G_TYPE_MAKE_FUNDAMENTAL (21)
210 /* Reserved fundamental type numbers to create new fundamental
211 * type IDs with G_TYPE_MAKE_FUNDAMENTAL().
213 * Open an issue on https://gitlab.gnome.org/GNOME/glib/issues/new for
217 * G_TYPE_MAKE_FUNDAMENTAL:
218 * @x: the fundamental type number.
220 * Get the type ID for the fundamental type number @x.
222 * Use g_type_fundamental_next() instead of this macro to create new fundamental
227 #define G_TYPE_MAKE_FUNDAMENTAL(x) ((GType) ((x) << G_TYPE_FUNDAMENTAL_SHIFT))
229 * G_TYPE_RESERVED_GLIB_FIRST:
231 * First fundamental type number to create a new fundamental type id with
232 * G_TYPE_MAKE_FUNDAMENTAL() reserved for GLib.
234 #define G_TYPE_RESERVED_GLIB_FIRST (22)
236 * G_TYPE_RESERVED_GLIB_LAST:
238 * Last fundamental type number reserved for GLib.
240 #define G_TYPE_RESERVED_GLIB_LAST (31)
242 * G_TYPE_RESERVED_BSE_FIRST:
244 * First fundamental type number to create a new fundamental type id with
245 * G_TYPE_MAKE_FUNDAMENTAL() reserved for BSE.
247 #define G_TYPE_RESERVED_BSE_FIRST (32)
249 * G_TYPE_RESERVED_BSE_LAST:
251 * Last fundamental type number reserved for BSE.
253 #define G_TYPE_RESERVED_BSE_LAST (48)
255 * G_TYPE_RESERVED_USER_FIRST:
257 * First available fundamental type number to create new fundamental
258 * type id with G_TYPE_MAKE_FUNDAMENTAL().
260 #define G_TYPE_RESERVED_USER_FIRST (49)
263 /* Type Checking Macros
266 * G_TYPE_IS_FUNDAMENTAL:
267 * @type: A #GType value
269 * Checks if @type is a fundamental type.
271 * Returns: %TRUE is @type is fundamental
273 #define G_TYPE_IS_FUNDAMENTAL(type) ((type) <= G_TYPE_FUNDAMENTAL_MAX)
276 * @type: A #GType value
278 * Checks if @type is derived (or in object-oriented terminology:
279 * inherited) from another type (this holds true for all non-fundamental
282 * Returns: %TRUE if @type is derived
284 #define G_TYPE_IS_DERIVED(type) ((type) > G_TYPE_FUNDAMENTAL_MAX)
286 * G_TYPE_IS_INTERFACE:
287 * @type: A #GType value
289 * Checks if @type is an interface type.
291 * An interface type provides a pure API, the implementation
292 * of which is provided by another type (which is then said to conform
293 * to the interface). GLib interfaces are somewhat analogous to Java
294 * interfaces and C++ classes containing only pure virtual functions,
295 * with the difference that GType interfaces are not derivable (but see
296 * g_type_interface_add_prerequisite() for an alternative).
298 * Returns: %TRUE if @type is an interface
300 #define G_TYPE_IS_INTERFACE(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_INTERFACE)
303 * @type: A #GType value
305 * Checks if @type is a classed type.
307 * A classed type has an associated #GTypeClass which can be derived to store
308 * class-wide virtual function pointers and data for all instances of the type.
309 * This allows for subclassing. All #GObjects are classed; none of the scalar
310 * fundamental types built into GLib are classed.
312 * Interfaces are not classed: while their #GTypeInterface struct could be
313 * considered similar to #GTypeClass, and classes can derive interfaces,
314 * #GTypeInterface doesn’t allow for subclassing.
316 * Returns: %TRUE if @type is classed
318 #define G_TYPE_IS_CLASSED(type) (g_type_test_flags ((type), G_TYPE_FLAG_CLASSED))
320 * G_TYPE_IS_INSTANTIATABLE:
321 * @type: A #GType value
323 * Checks if @type can be instantiated. Instantiation is the
324 * process of creating an instance (object) of this type.
326 * Returns: %TRUE if @type is instantiatable
328 #define G_TYPE_IS_INSTANTIATABLE(type) (g_type_test_flags ((type), G_TYPE_FLAG_INSTANTIATABLE))
330 * G_TYPE_IS_DERIVABLE:
331 * @type: A #GType value
333 * Checks if @type is a derivable type. A derivable type can
334 * be used as the base class of a flat (single-level) class hierarchy.
336 * Returns: %TRUE if @type is derivable
338 #define G_TYPE_IS_DERIVABLE(type) (g_type_test_flags ((type), G_TYPE_FLAG_DERIVABLE))
340 * G_TYPE_IS_DEEP_DERIVABLE:
341 * @type: A #GType value
343 * Checks if @type is a deep derivable type. A deep derivable type
344 * can be used as the base class of a deep (multi-level) class hierarchy.
346 * Returns: %TRUE if @type is deep derivable
348 #define G_TYPE_IS_DEEP_DERIVABLE(type) (g_type_test_flags ((type), G_TYPE_FLAG_DEEP_DERIVABLE))
350 * G_TYPE_IS_ABSTRACT:
351 * @type: A #GType value
353 * Checks if @type is an abstract type. An abstract type cannot be
354 * instantiated and is normally used as an abstract base class for
357 * Returns: %TRUE if @type is abstract
359 #define G_TYPE_IS_ABSTRACT(type) (g_type_test_flags ((type), G_TYPE_FLAG_ABSTRACT))
361 * G_TYPE_IS_VALUE_ABSTRACT:
362 * @type: A #GType value
364 * Checks if @type is an abstract value type. An abstract value type introduces
365 * a value table, but can't be used for g_value_init() and is normally used as
366 * an abstract base type for derived value types.
368 * Returns: %TRUE if @type is an abstract value type
370 #define G_TYPE_IS_VALUE_ABSTRACT(type) (g_type_test_flags ((type), G_TYPE_FLAG_VALUE_ABSTRACT))
372 * G_TYPE_IS_VALUE_TYPE:
373 * @type: A #GType value
375 * Checks if @type is a value type and can be used with g_value_init().
377 * Returns: %TRUE if @type is a value type
379 #define G_TYPE_IS_VALUE_TYPE(type) (g_type_check_is_value_type (type))
381 * G_TYPE_HAS_VALUE_TABLE:
382 * @type: A #GType value
384 * Checks if @type has a #GTypeValueTable.
386 * Returns: %TRUE if @type has a value table
388 #define G_TYPE_HAS_VALUE_TABLE(type) (g_type_value_table_peek (type) != NULL)
391 * @type: a #GType value
393 * Checks if @type is a final type. A final type cannot be derived any
396 * Returns: %TRUE if @type is final
400 #define G_TYPE_IS_FINAL(type) (g_type_test_flags ((type), G_TYPE_FLAG_FINAL)) GOBJECT_AVAILABLE_MACRO_IN_2_70
403 * G_TYPE_IS_DEPRECATED:
404 * @type: a #GType value
406 * Checks if @type is deprecated. Instantiating a deprecated type will
407 * trigger a warning if running with `G_ENABLE_DIAGNOSTIC=1`.
409 * Returns: %TRUE if the type is deprecated
413 #define G_TYPE_IS_DEPRECATED(type) (g_type_test_flags ((type), G_TYPE_FLAG_DEPRECATED)) GOBJECT_AVAILABLE_MACRO_IN_2_76
421 * A numerical value which represents the unique identifier of a registered
424 #if GLIB_SIZEOF_SIZE_T != GLIB_SIZEOF_LONG || !defined (G_CXX_STD_VERSION)
426 #else /* for historic reasons, C++ links against gulong GTypes */
427 typedef gulong GType;
429 typedef struct _GValue GValue;
430 typedef union _GTypeCValue GTypeCValue;
431 typedef struct _GTypePlugin GTypePlugin;
432 typedef struct _GTypeClass GTypeClass;
433 typedef struct _GTypeInterface GTypeInterface;
434 typedef struct _GTypeInstance GTypeInstance;
435 typedef struct _GTypeInfo GTypeInfo;
436 typedef struct _GTypeFundamentalInfo GTypeFundamentalInfo;
437 typedef struct _GInterfaceInfo GInterfaceInfo;
438 typedef struct _GTypeValueTable GTypeValueTable;
439 typedef struct _GTypeQuery GTypeQuery;
442 /* Basic Type Structures
447 * An opaque structure used as the base of all classes.
457 * An opaque structure used as the base of all type instances.
459 struct _GTypeInstance
467 * An opaque structure used as the base of all interface types.
469 struct _GTypeInterface
472 GType g_type; /* iface type */
473 GType g_instance_type;
477 * @type: the #GType value of the type
478 * @type_name: the name of the type
479 * @class_size: the size of the class structure
480 * @instance_size: the size of the instance structure
482 * A structure holding information for a specific type.
484 * See also: g_type_query()
489 const gchar *type_name;
495 /* Casts, checks and accessors for structured types
496 * usage of these macros is reserved to type implementations only
500 * G_TYPE_CHECK_INSTANCE:
501 * @instance: Location of a #GTypeInstance structure
503 * Checks if @instance is a valid #GTypeInstance structure,
504 * otherwise issues a warning and returns %FALSE. %NULL is not a valid
507 * This macro should only be used in type implementations.
509 * Returns: %TRUE if @instance is valid
511 #define G_TYPE_CHECK_INSTANCE(instance) (_G_TYPE_CHI ((GTypeInstance*) (instance)))
513 * G_TYPE_CHECK_INSTANCE_CAST:
514 * @instance: (nullable): Location of a #GTypeInstance structure
515 * @g_type: The type to be returned
516 * @c_type: The corresponding C type of @g_type
518 * Checks that @instance is an instance of the type identified by @g_type
519 * and issues a warning if this is not the case. Returns @instance casted
520 * to a pointer to @c_type.
522 * No warning will be issued if @instance is %NULL, and %NULL will be returned.
524 * This macro should only be used in type implementations.
526 #define G_TYPE_CHECK_INSTANCE_CAST(instance, g_type, c_type) (_G_TYPE_CIC ((instance), (g_type), c_type))
528 * G_TYPE_CHECK_INSTANCE_TYPE:
529 * @instance: (nullable): Location of a #GTypeInstance structure.
530 * @g_type: The type to be checked
532 * Checks if @instance is an instance of the type identified by @g_type. If
533 * @instance is %NULL, %FALSE will be returned.
535 * This macro should only be used in type implementations.
537 * Returns: %TRUE if @instance is an instance of @g_type
539 #define G_TYPE_CHECK_INSTANCE_TYPE(instance, g_type) (_G_TYPE_CIT ((instance), (g_type)))
541 * G_TYPE_CHECK_INSTANCE_FUNDAMENTAL_TYPE:
542 * @instance: (nullable): Location of a #GTypeInstance structure.
543 * @g_type: The fundamental type to be checked
545 * Checks if @instance is an instance of the fundamental type identified by @g_type.
546 * If @instance is %NULL, %FALSE will be returned.
548 * This macro should only be used in type implementations.
550 * Returns: %TRUE if @instance is an instance of @g_type
552 #define G_TYPE_CHECK_INSTANCE_FUNDAMENTAL_TYPE(instance, g_type) (_G_TYPE_CIFT ((instance), (g_type)))
554 * G_TYPE_INSTANCE_GET_CLASS:
555 * @instance: Location of the #GTypeInstance structure
556 * @g_type: The #GType of the class to be returned
557 * @c_type: The C type of the class structure
559 * Get the class structure of a given @instance, casted
560 * to a specified ancestor type @g_type of the instance.
562 * Note that while calling a GInstanceInitFunc(), the class pointer
563 * gets modified, so it might not always return the expected pointer.
565 * This macro should only be used in type implementations.
567 * Returns: a pointer to the class structure
569 #define G_TYPE_INSTANCE_GET_CLASS(instance, g_type, c_type) (_G_TYPE_IGC ((instance), (g_type), c_type))
571 * G_TYPE_INSTANCE_GET_INTERFACE:
572 * @instance: Location of the #GTypeInstance structure
573 * @g_type: The #GType of the interface to be returned
574 * @c_type: The C type of the interface structure
576 * Get the interface structure for interface @g_type of a given @instance.
578 * This macro should only be used in type implementations.
580 * Returns: a pointer to the interface structure
582 #define G_TYPE_INSTANCE_GET_INTERFACE(instance, g_type, c_type) (_G_TYPE_IGI ((instance), (g_type), c_type))
584 * G_TYPE_CHECK_CLASS_CAST:
585 * @g_class: Location of a #GTypeClass structure
586 * @g_type: The type to be returned
587 * @c_type: The corresponding C type of class structure of @g_type
589 * Checks that @g_class is a class structure of the type identified by @g_type
590 * and issues a warning if this is not the case. Returns @g_class casted
591 * to a pointer to @c_type. %NULL is not a valid class structure.
593 * This macro should only be used in type implementations.
595 #define G_TYPE_CHECK_CLASS_CAST(g_class, g_type, c_type) (_G_TYPE_CCC ((g_class), (g_type), c_type))
597 * G_TYPE_CHECK_CLASS_TYPE:
598 * @g_class: (nullable): Location of a #GTypeClass structure
599 * @g_type: The type to be checked
601 * Checks if @g_class is a class structure of the type identified by
602 * @g_type. If @g_class is %NULL, %FALSE will be returned.
604 * This macro should only be used in type implementations.
606 * Returns: %TRUE if @g_class is a class structure of @g_type
608 #define G_TYPE_CHECK_CLASS_TYPE(g_class, g_type) (_G_TYPE_CCT ((g_class), (g_type)))
610 * G_TYPE_CHECK_VALUE:
613 * Checks if @value has been initialized to hold values
616 * This macro should only be used in type implementations.
618 * Returns: %TRUE if @value is initialized
620 #define G_TYPE_CHECK_VALUE(value) (_G_TYPE_CHV ((value)))
622 * G_TYPE_CHECK_VALUE_TYPE:
624 * @g_type: The type to be checked
626 * Checks if @value has been initialized to hold values
629 * This macro should only be used in type implementations.
631 * Returns: %TRUE if @value has been initialized to hold values of type @g_type
633 #define G_TYPE_CHECK_VALUE_TYPE(value, g_type) (_G_TYPE_CVH ((value), (g_type)))
635 * G_TYPE_FROM_INSTANCE:
636 * @instance: Location of a valid #GTypeInstance structure
638 * Get the type identifier from a given @instance structure.
640 * This macro should only be used in type implementations.
642 * Returns: the #GType
644 #define G_TYPE_FROM_INSTANCE(instance) (G_TYPE_FROM_CLASS (((GTypeInstance*) (instance))->g_class))
647 * @g_class: Location of a valid #GTypeClass structure
649 * Get the type identifier from a given @class structure.
651 * This macro should only be used in type implementations.
653 * Returns: the #GType
655 #define G_TYPE_FROM_CLASS(g_class) (((GTypeClass*) (g_class))->g_type)
657 * G_TYPE_FROM_INTERFACE:
658 * @g_iface: Location of a valid #GTypeInterface structure
660 * Get the type identifier from a given @interface structure.
662 * This macro should only be used in type implementations.
664 * Returns: the #GType
666 #define G_TYPE_FROM_INTERFACE(g_iface) (((GTypeInterface*) (g_iface))->g_type)
669 * G_TYPE_INSTANCE_GET_PRIVATE:
670 * @instance: the instance of a type deriving from @private_type
671 * @g_type: the type identifying which private data to retrieve
672 * @c_type: The C type for the private structure
674 * Gets the private structure for a particular type.
676 * The private structure must have been registered in the
677 * class_init function with g_type_class_add_private().
679 * This macro should only be used in type implementations.
682 * Deprecated: 2.58: Use G_ADD_PRIVATE() and the generated
683 * `your_type_get_instance_private()` function instead
684 * Returns: (not nullable): a pointer to the private data structure
686 #define G_TYPE_INSTANCE_GET_PRIVATE(instance, g_type, c_type) ((c_type*) g_type_instance_get_private ((GTypeInstance*) (instance), (g_type))) GOBJECT_DEPRECATED_MACRO_IN_2_58_FOR(G_ADD_PRIVATE)
689 * G_TYPE_CLASS_GET_PRIVATE:
690 * @klass: the class of a type deriving from @private_type
691 * @g_type: the type identifying which private data to retrieve
692 * @c_type: The C type for the private structure
694 * Gets the private class structure for a particular type.
696 * The private structure must have been registered in the
697 * get_type() function with g_type_add_class_private().
699 * This macro should only be used in type implementations.
702 * Returns: (not nullable): a pointer to the private data structure
704 #define G_TYPE_CLASS_GET_PRIVATE(klass, g_type, c_type) ((c_type*) g_type_class_get_private ((GTypeClass*) (klass), (g_type)))
708 * @G_TYPE_DEBUG_NONE: Print no messages
709 * @G_TYPE_DEBUG_OBJECTS: Print messages about object bookkeeping
710 * @G_TYPE_DEBUG_SIGNALS: Print messages about signal emissions
711 * @G_TYPE_DEBUG_MASK: Mask covering all debug flags
712 * @G_TYPE_DEBUG_INSTANCE_COUNT: Keep a count of instances of each type
714 * These flags used to be passed to g_type_init_with_debug_flags() which
717 * If you need to enable debugging features, use the `GOBJECT_DEBUG`
718 * environment variable.
720 * Deprecated: 2.36: g_type_init() is now done automatically
722 typedef enum /*< skip >*/
724 G_TYPE_DEBUG_NONE = 0,
725 G_TYPE_DEBUG_OBJECTS = 1 << 0,
726 G_TYPE_DEBUG_SIGNALS = 1 << 1,
727 G_TYPE_DEBUG_INSTANCE_COUNT = 1 << 2,
728 G_TYPE_DEBUG_MASK = 0x07
729 } GTypeDebugFlags GOBJECT_DEPRECATED_TYPE_IN_2_36;
732 /* --- prototypes --- */
733 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
734 GOBJECT_DEPRECATED_IN_2_36
735 void g_type_init (void);
736 GOBJECT_DEPRECATED_IN_2_36
737 void g_type_init_with_debug_flags (GTypeDebugFlags debug_flags);
738 G_GNUC_END_IGNORE_DEPRECATIONS
740 GOBJECT_AVAILABLE_IN_ALL
741 const gchar * g_type_name (GType type);
742 GOBJECT_AVAILABLE_IN_ALL
743 GQuark g_type_qname (GType type);
744 GOBJECT_AVAILABLE_IN_ALL
745 GType g_type_from_name (const gchar *name);
746 GOBJECT_AVAILABLE_IN_ALL
747 GType g_type_parent (GType type);
748 GOBJECT_AVAILABLE_IN_ALL
749 guint g_type_depth (GType type);
750 GOBJECT_AVAILABLE_IN_ALL
751 GType g_type_next_base (GType leaf_type,
753 GOBJECT_AVAILABLE_IN_ALL
754 gboolean g_type_is_a (GType type,
757 /* Hoist exact GType comparisons into the caller */
758 #define g_type_is_a(a,b) ((a) == (b) || (g_type_is_a) ((a), (b)))
760 GOBJECT_AVAILABLE_IN_ALL
761 gpointer g_type_class_ref (GType type);
762 GOBJECT_AVAILABLE_IN_ALL
763 gpointer g_type_class_peek (GType type);
764 GOBJECT_AVAILABLE_IN_ALL
765 gpointer g_type_class_peek_static (GType type);
766 GOBJECT_AVAILABLE_IN_ALL
767 void g_type_class_unref (gpointer g_class);
768 GOBJECT_AVAILABLE_IN_ALL
769 gpointer g_type_class_peek_parent (gpointer g_class);
770 GOBJECT_AVAILABLE_IN_ALL
771 gpointer g_type_interface_peek (gpointer instance_class,
773 GOBJECT_AVAILABLE_IN_ALL
774 gpointer g_type_interface_peek_parent (gpointer g_iface);
776 GOBJECT_AVAILABLE_IN_ALL
777 gpointer g_type_default_interface_ref (GType g_type);
778 GOBJECT_AVAILABLE_IN_ALL
779 gpointer g_type_default_interface_peek (GType g_type);
780 GOBJECT_AVAILABLE_IN_ALL
781 void g_type_default_interface_unref (gpointer g_iface);
783 /* g_free() the returned arrays */
784 GOBJECT_AVAILABLE_IN_ALL
785 GType* g_type_children (GType type,
787 GOBJECT_AVAILABLE_IN_ALL
788 GType* g_type_interfaces (GType type,
789 guint *n_interfaces);
791 /* per-type _static_ data */
792 GOBJECT_AVAILABLE_IN_ALL
793 void g_type_set_qdata (GType type,
796 GOBJECT_AVAILABLE_IN_ALL
797 gpointer g_type_get_qdata (GType type,
799 GOBJECT_AVAILABLE_IN_ALL
800 void g_type_query (GType type,
803 GOBJECT_AVAILABLE_IN_2_44
804 int g_type_get_instance_count (GType type);
806 /* --- type registration --- */
809 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to initialize
811 * A callback function used by the type system to do base initialization
812 * of the class structures of derived types.
814 * This function is called as part of the initialization process of all derived
815 * classes and should reallocate or reset all dynamic class members copied over
816 * from the parent class.
818 * For example, class members (such as strings) that are not sufficiently
819 * handled by a plain memory copy of the parent class into the derived class
820 * have to be altered. See GClassInitFunc() for a discussion of the class
821 * initialization process.
823 typedef void (*GBaseInitFunc) (gpointer g_class);
826 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to finalize
828 * A callback function used by the type system to finalize those portions
829 * of a derived types class structure that were setup from the corresponding
830 * GBaseInitFunc() function.
832 * Class finalization basically works the inverse way in which class
833 * initialization is performed.
835 * See GClassInitFunc() for a discussion of the class initialization process.
837 typedef void (*GBaseFinalizeFunc) (gpointer g_class);
840 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to initialize.
841 * @class_data: The @class_data member supplied via the #GTypeInfo structure.
843 * A callback function used by the type system to initialize the class
844 * of a specific type.
846 * This function should initialize all static class members.
848 * The initialization process of a class involves:
850 * - Copying common members from the parent class over to the
851 * derived class structure.
852 * - Zero initialization of the remaining members not copied
853 * over from the parent class.
854 * - Invocation of the GBaseInitFunc() initializers of all parent
855 * types and the class' type.
856 * - Invocation of the class' GClassInitFunc() initializer.
858 * Since derived classes are partially initialized through a memory copy
859 * of the parent class, the general rule is that GBaseInitFunc() and
860 * GBaseFinalizeFunc() should take care of necessary reinitialization
861 * and release of those class members that were introduced by the type
862 * that specified these GBaseInitFunc()/GBaseFinalizeFunc().
863 * GClassInitFunc() should only care about initializing static
864 * class members, while dynamic class members (such as allocated strings
865 * or reference counted resources) are better handled by a GBaseInitFunc()
866 * for this type, so proper initialization of the dynamic class members
867 * is performed for class initialization of derived types as well.
869 * An example may help to correspond the intend of the different class
872 * |[<!-- language="C" -->
874 * GObjectClass parent_class;
875 * gint static_integer;
876 * gchar *dynamic_string;
879 * type_a_base_class_init (TypeAClass *class)
881 * class->dynamic_string = g_strdup ("some string");
884 * type_a_base_class_finalize (TypeAClass *class)
886 * g_free (class->dynamic_string);
889 * type_a_class_init (TypeAClass *class)
891 * class->static_integer = 42;
895 * TypeAClass parent_class;
896 * gfloat static_float;
897 * GString *dynamic_gstring;
900 * type_b_base_class_init (TypeBClass *class)
902 * class->dynamic_gstring = g_string_new ("some other string");
905 * type_b_base_class_finalize (TypeBClass *class)
907 * g_string_free (class->dynamic_gstring);
910 * type_b_class_init (TypeBClass *class)
912 * class->static_float = 3.14159265358979323846;
916 * Initialization of TypeBClass will first cause initialization of
917 * TypeAClass (derived classes reference their parent classes, see
918 * g_type_class_ref() on this).
920 * Initialization of TypeAClass roughly involves zero-initializing its fields,
921 * then calling its GBaseInitFunc() type_a_base_class_init() to allocate
922 * its dynamic members (dynamic_string), and finally calling its GClassInitFunc()
923 * type_a_class_init() to initialize its static members (static_integer).
924 * The first step in the initialization process of TypeBClass is then
925 * a plain memory copy of the contents of TypeAClass into TypeBClass and
926 * zero-initialization of the remaining fields in TypeBClass.
927 * The dynamic members of TypeAClass within TypeBClass now need
928 * reinitialization which is performed by calling type_a_base_class_init()
929 * with an argument of TypeBClass.
931 * After that, the GBaseInitFunc() of TypeBClass, type_b_base_class_init()
932 * is called to allocate the dynamic members of TypeBClass (dynamic_gstring),
933 * and finally the GClassInitFunc() of TypeBClass, type_b_class_init(),
934 * is called to complete the initialization process with the static members
937 * Corresponding finalization counter parts to the GBaseInitFunc() functions
938 * have to be provided to release allocated resources at class finalization
941 typedef void (*GClassInitFunc) (gpointer g_class,
942 gpointer class_data);
944 * GClassFinalizeFunc:
945 * @g_class: (type GObject.TypeClass): The #GTypeClass structure to finalize
946 * @class_data: The @class_data member supplied via the #GTypeInfo structure
948 * A callback function used by the type system to finalize a class.
950 * This function is rarely needed, as dynamically allocated class resources
951 * should be handled by GBaseInitFunc() and GBaseFinalizeFunc().
953 * Also, specification of a GClassFinalizeFunc() in the #GTypeInfo
954 * structure of a static type is invalid, because classes of static types
955 * will never be finalized (they are artificially kept alive when their
956 * reference count drops to zero).
958 typedef void (*GClassFinalizeFunc) (gpointer g_class,
959 gpointer class_data);
962 * @instance: The instance to initialize
963 * @g_class: (type GObject.TypeClass): The class of the type the instance is
966 * A callback function used by the type system to initialize a new
967 * instance of a type.
969 * This function initializes all instance members and allocates any resources
972 * Initialization of a derived instance involves calling all its parent
973 * types instance initializers, so the class member of the instance
974 * is altered during its initialization to always point to the class that
975 * belongs to the type the current initializer was introduced for.
977 * The extended members of @instance are guaranteed to have been filled with
978 * zeros before this function is called.
980 typedef void (*GInstanceInitFunc) (GTypeInstance *instance,
983 * GInterfaceInitFunc:
984 * @g_iface: (type GObject.TypeInterface): The interface structure to initialize
985 * @iface_data: The @interface_data supplied via the #GInterfaceInfo structure
987 * A callback function used by the type system to initialize a new
990 * This function should initialize all internal data and* allocate any
991 * resources required by the interface.
993 * The members of @iface_data are guaranteed to have been filled with
994 * zeros before this function is called.
996 typedef void (*GInterfaceInitFunc) (gpointer g_iface,
997 gpointer iface_data);
999 * GInterfaceFinalizeFunc:
1000 * @g_iface: (type GObject.TypeInterface): The interface structure to finalize
1001 * @iface_data: The @interface_data supplied via the #GInterfaceInfo structure
1003 * A callback function used by the type system to finalize an interface.
1005 * This function should destroy any internal data and release any resources
1006 * allocated by the corresponding GInterfaceInitFunc() function.
1008 typedef void (*GInterfaceFinalizeFunc) (gpointer g_iface,
1009 gpointer iface_data);
1011 * GTypeClassCacheFunc:
1012 * @cache_data: data that was given to the g_type_add_class_cache_func() call
1013 * @g_class: (type GObject.TypeClass): The #GTypeClass structure which is
1016 * A callback function which is called when the reference count of a class
1019 * It may use g_type_class_ref() to prevent the class from being freed. You
1020 * should not call g_type_class_unref() from a #GTypeClassCacheFunc function
1021 * to prevent infinite recursion, use g_type_class_unref_uncached() instead.
1023 * The functions have to check the class id passed in to figure
1024 * whether they actually want to cache the class of this type, since all
1025 * classes are routed through the same #GTypeClassCacheFunc chain.
1027 * Returns: %TRUE to stop further #GTypeClassCacheFuncs from being
1028 * called, %FALSE to continue
1030 typedef gboolean (*GTypeClassCacheFunc) (gpointer cache_data,
1031 GTypeClass *g_class);
1033 * GTypeInterfaceCheckFunc:
1034 * @check_data: data passed to g_type_add_interface_check()
1035 * @g_iface: (type GObject.TypeInterface): the interface that has been
1038 * A callback called after an interface vtable is initialized.
1040 * See g_type_add_interface_check().
1044 typedef void (*GTypeInterfaceCheckFunc) (gpointer check_data,
1047 * GTypeFundamentalFlags:
1048 * @G_TYPE_FLAG_CLASSED: Indicates a classed type
1049 * @G_TYPE_FLAG_INSTANTIATABLE: Indicates an instantiatable type (implies classed)
1050 * @G_TYPE_FLAG_DERIVABLE: Indicates a flat derivable type
1051 * @G_TYPE_FLAG_DEEP_DERIVABLE: Indicates a deep derivable type (implies derivable)
1053 * Bit masks used to check or determine specific characteristics of a
1056 typedef enum /*< skip >*/
1058 /* There is no G_TYPE_FUNDAMENTAL_FLAGS_NONE: this is implemented to use
1059 * the same bits as GTypeFlags */
1060 G_TYPE_FLAG_CLASSED = (1 << 0),
1061 G_TYPE_FLAG_INSTANTIATABLE = (1 << 1),
1062 G_TYPE_FLAG_DERIVABLE = (1 << 2),
1063 G_TYPE_FLAG_DEEP_DERIVABLE = (1 << 3)
1064 } GTypeFundamentalFlags;
1067 * @G_TYPE_FLAG_NONE: No special flags. Since: 2.74
1068 * @G_TYPE_FLAG_ABSTRACT: Indicates an abstract type. No instances can be
1069 * created for an abstract type
1070 * @G_TYPE_FLAG_VALUE_ABSTRACT: Indicates an abstract value type, i.e. a type
1071 * that introduces a value table, but can't be used for
1073 * @G_TYPE_FLAG_FINAL: Indicates a final type. A final type is a non-derivable
1074 * leaf node in a deep derivable type hierarchy tree. Since: 2.70
1075 * @G_TYPE_FLAG_DEPRECATED: The type is deprecated and may be removed in a
1076 * future version. A warning will be emitted if it is instantiated while
1077 * running with `G_ENABLE_DIAGNOSTIC=1`. Since 2.76
1079 * Bit masks used to check or determine characteristics of a type.
1081 typedef enum /*< skip >*/
1083 G_TYPE_FLAG_NONE GOBJECT_AVAILABLE_ENUMERATOR_IN_2_74 = 0,
1084 G_TYPE_FLAG_ABSTRACT = (1 << 4),
1085 G_TYPE_FLAG_VALUE_ABSTRACT = (1 << 5),
1086 G_TYPE_FLAG_FINAL GOBJECT_AVAILABLE_ENUMERATOR_IN_2_70 = (1 << 6),
1087 G_TYPE_FLAG_DEPRECATED GOBJECT_AVAILABLE_ENUMERATOR_IN_2_76 = (1 << 7)
1091 * @class_size: Size of the class structure (required for interface, classed and instantiatable types)
1092 * @base_init: Location of the base initialization function (optional)
1093 * @base_finalize: Location of the base finalization function (optional)
1094 * @class_init: Location of the class initialization function for
1095 * classed and instantiatable types. Location of the default vtable
1096 * inititalization function for interface types. (optional) This function
1097 * is used both to fill in virtual functions in the class or default vtable,
1098 * and to do type-specific setup such as registering signals and object
1100 * @class_finalize: Location of the class finalization function for
1101 * classed and instantiatable types. Location of the default vtable
1102 * finalization function for interface types. (optional)
1103 * @class_data: User-supplied data passed to the class init/finalize functions
1104 * @instance_size: Size of the instance (object) structure (required for instantiatable types only)
1105 * @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 this field is ignored.
1106 * @instance_init: Location of the instance initialization function (optional, for instantiatable types only)
1107 * @value_table: A #GTypeValueTable function table for generic handling of GValues
1108 * of this type (usually only useful for fundamental types)
1110 * This structure is used to provide the type system with the information
1111 * required to initialize and destruct (finalize) a type's class and
1114 * The initialized structure is passed to the g_type_register_static() function
1115 * (or is copied into the provided #GTypeInfo structure in the
1116 * g_type_plugin_complete_type_info()). The type system will perform a deep
1117 * copy of this structure, so its memory does not need to be persistent
1118 * across invocation of g_type_register_static().
1122 /* interface types, classed types, instantiated types */
1125 GBaseInitFunc base_init;
1126 GBaseFinalizeFunc base_finalize;
1128 /* interface types, classed types, instantiated types */
1129 GClassInitFunc class_init;
1130 GClassFinalizeFunc class_finalize;
1131 gconstpointer class_data;
1133 /* instantiated types */
1134 guint16 instance_size;
1135 guint16 n_preallocs;
1136 GInstanceInitFunc instance_init;
1138 /* value handling */
1139 const GTypeValueTable *value_table;
1142 * GTypeFundamentalInfo:
1143 * @type_flags: #GTypeFundamentalFlags describing the characteristics of the fundamental type
1145 * A structure that provides information to the type system which is
1146 * used specifically for managing fundamental types.
1148 struct _GTypeFundamentalInfo
1150 GTypeFundamentalFlags type_flags;
1154 * @interface_init: location of the interface initialization function
1155 * @interface_finalize: location of the interface finalization function
1156 * @interface_data: user-supplied data passed to the interface init/finalize functions
1158 * A structure that provides information to the type system which is
1159 * used specifically for managing interface types.
1161 struct _GInterfaceInfo
1163 GInterfaceInitFunc interface_init;
1164 GInterfaceFinalizeFunc interface_finalize;
1165 gpointer interface_data;
1169 * GTypeValueInitFunc:
1170 * @value: the value to initialize
1172 * Initializes the value contents by setting the fields of the `value->data`
1175 * The data array of the #GValue passed into this function was zero-filled
1176 * with `memset()`, so no care has to be taken to free any old contents.
1177 * For example, in the case of a string value that may never be %NULL, the
1178 * implementation might look like:
1180 * |[<!-- language="C" -->
1181 * value->data[0].v_pointer = g_strdup ("");
1186 GOBJECT_AVAILABLE_TYPE_IN_2_78
1187 typedef void (* GTypeValueInitFunc) (GValue *value);
1190 * GTypeValueFreeFunc:
1191 * @value: the value to free
1193 * Frees any old contents that might be left in the `value->data` array of
1196 * No resources may remain allocated through the #GValue contents after this
1197 * function returns. E.g. for our above string type:
1199 * |[<!-- language="C" -->
1200 * // only free strings without a specific flag for static storage
1201 * if (!(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
1202 * g_free (value->data[0].v_pointer);
1207 GOBJECT_AVAILABLE_TYPE_IN_2_78
1208 typedef void (* GTypeValueFreeFunc) (GValue *value);
1211 * GTypeValueCopyFunc:
1212 * @src_value: the value to copy
1213 * @dest_value: (out): the location of the copy
1215 * Copies the content of a #GValue into another.
1217 * The @dest_value is a #GValue with zero-filled data section and @src_value
1218 * is a properly initialized #GValue of same type, or derived type.
1220 * The purpose of this function is to copy the contents of @src_value
1221 * into @dest_value in a way, that even after @src_value has been freed, the
1222 * contents of @dest_value remain valid. String type example:
1224 * |[<!-- language="C" -->
1225 * dest_value->data[0].v_pointer = g_strdup (src_value->data[0].v_pointer);
1230 GOBJECT_AVAILABLE_TYPE_IN_2_78
1231 typedef void (* GTypeValueCopyFunc) (const GValue *src_value,
1232 GValue *dest_value);
1235 * GTypeValuePeekPointerFunc:
1236 * @value: the value to peek
1238 * If the value contents fit into a pointer, such as objects or strings,
1239 * return this pointer, so the caller can peek at the current contents.
1241 * To extend on our above string example:
1243 * |[<!-- language="C" -->
1244 * return value->data[0].v_pointer;
1247 * Returns: (transfer none): a pointer to the value contents
1251 GOBJECT_AVAILABLE_TYPE_IN_2_78
1252 typedef gpointer (* GTypeValuePeekPointerFunc) (const GValue *value);
1255 * GTypeValueCollectFunc:
1256 * @value: the value to initialize
1257 * @n_collect_values: the number of collected values
1258 * @collect_values: (array length=n_collect_values): the collected values
1259 * @collect_flags: optional flags
1261 * This function is responsible for converting the values collected from
1262 * a variadic argument list into contents suitable for storage in a #GValue.
1264 * This function should setup @value similar to #GTypeValueInitFunc; e.g.
1265 * for a string value that does not allow `NULL` pointers, it needs to either
1266 * emit an error, or do an implicit conversion by storing an empty string.
1268 * The @value passed in to this function has a zero-filled data array, so
1269 * just like for #GTypeValueInitFunc it is guaranteed to not contain any old
1270 * contents that might need freeing.
1272 * The @n_collect_values argument is the string length of the `collect_format`
1273 * field of #GTypeValueTable, and `collect_values` is an array of #GTypeCValue
1274 * with length of @n_collect_values, containing the collected values according
1275 * to `collect_format`.
1277 * The @collect_flags argument provided as a hint by the caller. It may
1278 * contain the flag %G_VALUE_NOCOPY_CONTENTS indicating that the collected
1279 * value contents may be considered ‘static’ for the duration of the @value
1280 * lifetime. Thus an extra copy of the contents stored in @collect_values is
1281 * not required for assignment to @value.
1283 * For our above string example, we continue with:
1285 * |[<!-- language="C" -->
1286 * if (!collect_values[0].v_pointer)
1287 * value->data[0].v_pointer = g_strdup ("");
1288 * else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
1290 * value->data[0].v_pointer = collect_values[0].v_pointer;
1291 * // keep a flag for the value_free() implementation to not free this string
1292 * value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
1295 * value->data[0].v_pointer = g_strdup (collect_values[0].v_pointer);
1299 * It should be noted, that it is generally a bad idea to follow the
1300 * %G_VALUE_NOCOPY_CONTENTS hint for reference counted types. Due to
1301 * reentrancy requirements and reference count assertions performed
1302 * by the signal emission code, reference counts should always be
1303 * incremented for reference counted contents stored in the `value->data`
1304 * array. To deviate from our string example for a moment, and taking
1305 * a look at an exemplary implementation for `GTypeValueTable.collect_value()`
1308 * |[<!-- language="C" -->
1309 * GObject *object = G_OBJECT (collect_values[0].v_pointer);
1310 * g_return_val_if_fail (object != NULL,
1311 * g_strdup_printf ("Object %p passed as invalid NULL pointer", object));
1312 * // never honour G_VALUE_NOCOPY_CONTENTS for ref-counted types
1313 * value->data[0].v_pointer = g_object_ref (object);
1317 * The reference count for valid objects is always incremented, regardless
1318 * of `collect_flags`. For invalid objects, the example returns a newly
1319 * allocated string without altering `value`.
1321 * Upon success, `collect_value()` needs to return `NULL`. If, however,
1322 * an error condition occurred, `collect_value()` should return a newly
1323 * allocated string containing an error diagnostic.
1325 * The calling code makes no assumptions about the `value` contents being
1326 * valid upon error returns, `value` is simply thrown away without further
1327 * freeing. As such, it is a good idea to not allocate `GValue` contents
1328 * prior to returning an error; however, `collect_values()` is not obliged
1329 * to return a correctly setup @value for error returns, simply because
1330 * any non-`NULL` return is considered a fatal programming error, and
1331 * further program behaviour is undefined.
1333 * Returns: (transfer full) (nullable): `NULL` on success, otherwise a
1334 * newly allocated error string on failure
1338 GOBJECT_AVAILABLE_TYPE_IN_2_78
1339 typedef gchar * (* GTypeValueCollectFunc) (GValue *value,
1340 guint n_collect_values,
1341 GTypeCValue *collect_values,
1342 guint collect_flags);
1345 * GTypeValueLCopyFunc:
1346 * @value: the value to lcopy
1347 * @n_collect_values: the number of collected values
1348 * @collect_values: (array length=n_collect_values): the collected
1349 * locations for storage
1350 * @collect_flags: optional flags
1352 * This function is responsible for storing the `value`
1353 * contents into arguments passed through a variadic argument list which
1354 * got collected into `collect_values` according to `lcopy_format`.
1356 * The `n_collect_values` argument equals the string length of
1357 * `lcopy_format`, and `collect_flags` may contain %G_VALUE_NOCOPY_CONTENTS.
1359 * In contrast to #GTypeValueCollectFunc, this function is obliged to always
1360 * properly support %G_VALUE_NOCOPY_CONTENTS.
1362 * Similar to #GTypeValueCollectFunc the function may prematurely abort by
1363 * returning a newly allocated string describing an error condition. To
1364 * complete the string example:
1366 * |[<!-- language="C" -->
1367 * gchar **string_p = collect_values[0].v_pointer;
1368 * g_return_val_if_fail (string_p != NULL,
1369 * g_strdup ("string location passed as NULL"));
1371 * if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
1372 * *string_p = value->data[0].v_pointer;
1374 * *string_p = g_strdup (value->data[0].v_pointer);
1377 * And an illustrative version of this function for reference-counted
1380 * |[<!-- language="C" -->
1381 * GObject **object_p = collect_values[0].v_pointer;
1382 * g_return_val_if_fail (object_p != NULL,
1383 * g_strdup ("object location passed as NULL"));
1385 * if (value->data[0].v_pointer == NULL)
1387 * else if (collect_flags & G_VALUE_NOCOPY_CONTENTS) // always honour
1388 * *object_p = value->data[0].v_pointer;
1390 * *object_p = g_object_ref (value->data[0].v_pointer);
1395 * Returns: (transfer full) (nullable): `NULL` on success, otherwise
1396 * a newly allocated error string on failure
1400 GOBJECT_AVAILABLE_TYPE_IN_2_78
1401 typedef gchar * (* GTypeValueLCopyFunc) (const GValue *value,
1402 guint n_collect_values,
1403 GTypeCValue *collect_values,
1404 guint collect_flags);
1408 * @value_init: Function to initialize a GValue
1409 * @value_free: Function to free a GValue
1410 * @value_copy: Function to copy a GValue
1411 * @value_peek_pointer: Function to peek the contents of a GValue if they fit
1413 * @collect_format: A string format describing how to collect the contents of
1414 * this value bit-by-bit. Each character in the format represents
1415 * an argument to be collected, and the characters themselves indicate
1416 * the type of the argument. Currently supported arguments are:
1417 * - `'i'`: Integers, passed as `collect_values[].v_int`
1418 * - `'l'`: Longs, passed as `collect_values[].v_long`
1419 * - `'d'`: Doubles, passed as `collect_values[].v_double`
1420 * - `'p'`: Pointers, passed as `collect_values[].v_pointer`
1421 * It should be noted that for variable argument list construction,
1422 * ANSI C promotes every type smaller than an integer to an int, and
1423 * floats to doubles. So for collection of short int or char, `'i'`
1424 * needs to be used, and for collection of floats `'d'`.
1425 * @collect_value: Function to initialize a GValue from the values
1426 * collected from variadic arguments
1427 * @lcopy_format: Format description of the arguments to collect for @lcopy_value,
1428 * analogous to @collect_format. Usually, @lcopy_format string consists
1429 * only of `'p'`s to provide lcopy_value() with pointers to storage locations.
1430 * @lcopy_value: Function to store the contents of a value into the
1431 * locations collected from variadic arguments
1433 * The #GTypeValueTable provides the functions required by the #GValue
1434 * implementation, to serve as a container for values of a type.
1436 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
1437 struct _GTypeValueTable
1439 GTypeValueInitFunc value_init;
1440 GTypeValueFreeFunc value_free;
1441 GTypeValueCopyFunc value_copy;
1442 GTypeValuePeekPointerFunc value_peek_pointer;
1444 const gchar *collect_format;
1445 GTypeValueCollectFunc collect_value;
1447 const gchar *lcopy_format;
1448 GTypeValueLCopyFunc lcopy_value;
1450 G_GNUC_END_IGNORE_DEPRECATIONS
1452 GOBJECT_AVAILABLE_IN_ALL
1453 GType g_type_register_static (GType parent_type,
1454 const gchar *type_name,
1455 const GTypeInfo *info,
1457 GOBJECT_AVAILABLE_IN_ALL
1458 GType g_type_register_static_simple (GType parent_type,
1459 const gchar *type_name,
1461 GClassInitFunc class_init,
1462 guint instance_size,
1463 GInstanceInitFunc instance_init,
1466 GOBJECT_AVAILABLE_IN_ALL
1467 GType g_type_register_dynamic (GType parent_type,
1468 const gchar *type_name,
1469 GTypePlugin *plugin,
1471 GOBJECT_AVAILABLE_IN_ALL
1472 GType g_type_register_fundamental (GType type_id,
1473 const gchar *type_name,
1474 const GTypeInfo *info,
1475 const GTypeFundamentalInfo *finfo,
1477 GOBJECT_AVAILABLE_IN_ALL
1478 void g_type_add_interface_static (GType instance_type,
1479 GType interface_type,
1480 const GInterfaceInfo *info);
1481 GOBJECT_AVAILABLE_IN_ALL
1482 void g_type_add_interface_dynamic (GType instance_type,
1483 GType interface_type,
1484 GTypePlugin *plugin);
1485 GOBJECT_AVAILABLE_IN_ALL
1486 void g_type_interface_add_prerequisite (GType interface_type,
1487 GType prerequisite_type);
1488 GOBJECT_AVAILABLE_IN_ALL
1489 GType*g_type_interface_prerequisites (GType interface_type,
1490 guint *n_prerequisites);
1491 GOBJECT_AVAILABLE_IN_2_68
1492 GType g_type_interface_instantiatable_prerequisite
1493 (GType interface_type);
1494 GOBJECT_DEPRECATED_IN_2_58
1495 void g_type_class_add_private (gpointer g_class,
1496 gsize private_size);
1497 GOBJECT_AVAILABLE_IN_2_38
1498 gint g_type_add_instance_private (GType class_type,
1499 gsize private_size);
1500 GOBJECT_AVAILABLE_IN_ALL
1501 gpointer g_type_instance_get_private (GTypeInstance *instance,
1502 GType private_type);
1503 GOBJECT_AVAILABLE_IN_2_38
1504 void g_type_class_adjust_private_offset (gpointer g_class,
1505 gint *private_size_or_offset);
1507 GOBJECT_AVAILABLE_IN_ALL
1508 void g_type_add_class_private (GType class_type,
1509 gsize private_size);
1510 GOBJECT_AVAILABLE_IN_ALL
1511 gpointer g_type_class_get_private (GTypeClass *klass,
1512 GType private_type);
1513 GOBJECT_AVAILABLE_IN_2_38
1514 gint g_type_class_get_instance_private_offset (gpointer g_class);
1516 GOBJECT_AVAILABLE_IN_2_34
1517 void g_type_ensure (GType type);
1518 GOBJECT_AVAILABLE_IN_2_36
1519 guint g_type_get_type_registration_serial (void);
1522 /* --- GType boilerplate --- */
1524 * G_DECLARE_FINAL_TYPE:
1525 * @ModuleObjName: The name of the new type, in camel case (like `GtkWidget`)
1526 * @module_obj_name: The name of the new type in lowercase, with words
1527 * separated by `_` (like `gtk_widget`)
1528 * @MODULE: The name of the module, in all caps (like `GTK`)
1529 * @OBJ_NAME: The bare name of the type, in all caps (like `WIDGET`)
1530 * @ParentName: the name of the parent type, in camel case (like `GtkWidget`)
1532 * A convenience macro for emitting the usual declarations in the header file
1533 * for a type which is not (at the present time) intended to be subclassed.
1535 * You might use it in a header as follows:
1537 * |[<!-- language="C" -->
1538 * #ifndef _myapp_window_h_
1539 * #define _myapp_window_h_
1541 * #include <gtk/gtk.h>
1543 * #define MY_APP_TYPE_WINDOW my_app_window_get_type ()
1544 * G_DECLARE_FINAL_TYPE (MyAppWindow, my_app_window, MY_APP, WINDOW, GtkWindow)
1546 * MyAppWindow * my_app_window_new (void);
1553 * And use it as follow in your C file:
1555 * |[<!-- language="C" -->
1556 * struct _MyAppWindow
1561 * G_DEFINE_TYPE (MyAppWindow, my_app_window, GTK_TYPE_WINDOW)
1564 * This results in the following things happening:
1566 * - the usual `my_app_window_get_type()` function is declared with a return type of #GType
1568 * - the `MyAppWindow` type is defined as a `typedef` of `struct _MyAppWindow`. The struct itself is not
1569 * defined and should be defined from the .c file before G_DEFINE_TYPE() is used.
1571 * - the `MY_APP_WINDOW()` cast is emitted as `static inline` function along with the `MY_APP_IS_WINDOW()` type
1574 * - the `MyAppWindowClass` type is defined as a struct containing `GtkWindowClass`. This is done for the
1575 * convenience of the person defining the type and should not be considered to be part of the ABI. In
1576 * particular, without a firm declaration of the instance structure, it is not possible to subclass the type
1577 * and therefore the fact that the size of the class structure is exposed is not a concern and it can be
1578 * freely changed at any point in the future.
1580 * - g_autoptr() support being added for your type, based on the type of your parent class
1582 * You can only use this function if your parent type also supports g_autoptr().
1584 * Because the type macro (`MY_APP_TYPE_WINDOW` in the above example) is not a callable, you must continue to
1585 * manually define this as a macro for yourself.
1587 * The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro
1588 * to be used in the usual way with export control and API versioning macros.
1590 * If you want to declare your own class structure, use G_DECLARE_DERIVABLE_TYPE().
1592 * If you are writing a library, it is important to note that it is possible to convert a type from using
1593 * G_DECLARE_FINAL_TYPE() to G_DECLARE_DERIVABLE_TYPE() without breaking API or ABI. As a precaution, you
1594 * should therefore use G_DECLARE_FINAL_TYPE() until you are sure that it makes sense for your class to be
1595 * subclassed. Once a class structure has been exposed it is not possible to change its size or remove or
1596 * reorder items without breaking the API and/or ABI.
1600 #define G_DECLARE_FINAL_TYPE(ModuleObjName, module_obj_name, MODULE, OBJ_NAME, ParentName) \
1601 GType module_obj_name##_get_type (void); \
1602 G_GNUC_BEGIN_IGNORE_DEPRECATIONS \
1603 typedef struct _##ModuleObjName ModuleObjName; \
1604 typedef struct { ParentName##Class parent_class; } ModuleObjName##Class; \
1606 _GLIB_DEFINE_AUTOPTR_CHAINUP (ModuleObjName, ParentName) \
1607 G_DEFINE_AUTOPTR_CLEANUP_FUNC (ModuleObjName##Class, g_type_class_unref) \
1609 G_GNUC_UNUSED static inline ModuleObjName * MODULE##_##OBJ_NAME (gpointer ptr) { \
1610 return G_TYPE_CHECK_INSTANCE_CAST (ptr, module_obj_name##_get_type (), ModuleObjName); } \
1611 G_GNUC_UNUSED static inline gboolean MODULE##_IS_##OBJ_NAME (gpointer ptr) { \
1612 return G_TYPE_CHECK_INSTANCE_TYPE (ptr, module_obj_name##_get_type ()); } \
1613 G_GNUC_END_IGNORE_DEPRECATIONS
1616 * G_DECLARE_DERIVABLE_TYPE:
1617 * @ModuleObjName: The name of the new type, in camel case (like `GtkWidget`)
1618 * @module_obj_name: The name of the new type in lowercase, with words
1619 * separated by `_` (like `gtk_widget`)
1620 * @MODULE: The name of the module, in all caps (like `GTK`)
1621 * @OBJ_NAME: The bare name of the type, in all caps (like `WIDGET`)
1622 * @ParentName: the name of the parent type, in camel case (like `GtkWidget`)
1624 * A convenience macro for emitting the usual declarations in the
1625 * header file for a type which is intended to be subclassed.
1627 * You might use it in a header as follows:
1629 * |[<!-- language="C" -->
1630 * #ifndef _gtk_frobber_h_
1631 * #define _gtk_frobber_h_
1633 * #define GTK_TYPE_FROBBER gtk_frobber_get_type ()
1634 * GDK_AVAILABLE_IN_3_12
1635 * G_DECLARE_DERIVABLE_TYPE (GtkFrobber, gtk_frobber, GTK, FROBBER, GtkWidget)
1637 * struct _GtkFrobberClass
1639 * GtkWidgetClass parent_class;
1641 * void (* handle_frob) (GtkFrobber *frobber,
1644 * gpointer padding[12];
1647 * GtkWidget * gtk_frobber_new (void);
1654 * Since the instance structure is public it is often needed to declare a
1655 * private struct as follow in your C file:
1657 * |[<!-- language="C" -->
1658 * typedef struct _GtkFrobberPrivate GtkFrobberPrivate;
1659 * struct _GtkFrobberPrivate
1663 * G_DEFINE_TYPE_WITH_PRIVATE (GtkFrobber, gtk_frobber, GTK_TYPE_WIDGET)
1666 * This results in the following things happening:
1668 * - the usual `gtk_frobber_get_type()` function is declared with a return type of #GType
1670 * - the `GtkFrobber` struct is created with `GtkWidget` as the first and only item. You are expected to use
1671 * a private structure from your .c file to store your instance variables.
1673 * - the `GtkFrobberClass` type is defined as a typedef to `struct _GtkFrobberClass`, which is left undefined.
1674 * You should do this from the header file directly after you use the macro.
1676 * - the `GTK_FROBBER()` and `GTK_FROBBER_CLASS()` casts are emitted as `static inline` functions along with
1677 * the `GTK_IS_FROBBER()` and `GTK_IS_FROBBER_CLASS()` type checking functions and `GTK_FROBBER_GET_CLASS()`
1680 * - g_autoptr() support being added for your type, based on the type of your parent class
1682 * You can only use this function if your parent type also supports g_autoptr().
1684 * Because the type macro (`GTK_TYPE_FROBBER` in the above example) is not a callable, you must continue to
1685 * manually define this as a macro for yourself.
1687 * The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro
1688 * to be used in the usual way with export control and API versioning macros.
1690 * If you are writing a library, it is important to note that it is possible to convert a type from using
1691 * G_DECLARE_FINAL_TYPE() to G_DECLARE_DERIVABLE_TYPE() without breaking API or ABI. As a precaution, you
1692 * should therefore use G_DECLARE_FINAL_TYPE() until you are sure that it makes sense for your class to be
1693 * subclassed. Once a class structure has been exposed it is not possible to change its size or remove or
1694 * reorder items without breaking the API and/or ABI. If you want to declare your own class structure, use
1695 * G_DECLARE_DERIVABLE_TYPE(). If you want to declare a class without exposing the class or instance
1696 * structures, use G_DECLARE_FINAL_TYPE().
1698 * If you must use G_DECLARE_DERIVABLE_TYPE() you should be sure to include some padding at the bottom of your
1699 * class structure to leave space for the addition of future virtual functions.
1703 #define G_DECLARE_DERIVABLE_TYPE(ModuleObjName, module_obj_name, MODULE, OBJ_NAME, ParentName) \
1704 GType module_obj_name##_get_type (void); \
1705 G_GNUC_BEGIN_IGNORE_DEPRECATIONS \
1706 typedef struct _##ModuleObjName ModuleObjName; \
1707 typedef struct _##ModuleObjName##Class ModuleObjName##Class; \
1708 struct _##ModuleObjName { ParentName parent_instance; }; \
1710 _GLIB_DEFINE_AUTOPTR_CHAINUP (ModuleObjName, ParentName) \
1711 G_DEFINE_AUTOPTR_CLEANUP_FUNC (ModuleObjName##Class, g_type_class_unref) \
1713 G_GNUC_UNUSED static inline ModuleObjName * MODULE##_##OBJ_NAME (gpointer ptr) { \
1714 return G_TYPE_CHECK_INSTANCE_CAST (ptr, module_obj_name##_get_type (), ModuleObjName); } \
1715 G_GNUC_UNUSED static inline ModuleObjName##Class * MODULE##_##OBJ_NAME##_CLASS (gpointer ptr) { \
1716 return G_TYPE_CHECK_CLASS_CAST (ptr, module_obj_name##_get_type (), ModuleObjName##Class); } \
1717 G_GNUC_UNUSED static inline gboolean MODULE##_IS_##OBJ_NAME (gpointer ptr) { \
1718 return G_TYPE_CHECK_INSTANCE_TYPE (ptr, module_obj_name##_get_type ()); } \
1719 G_GNUC_UNUSED static inline gboolean MODULE##_IS_##OBJ_NAME##_CLASS (gpointer ptr) { \
1720 return G_TYPE_CHECK_CLASS_TYPE (ptr, module_obj_name##_get_type ()); } \
1721 G_GNUC_UNUSED static inline ModuleObjName##Class * MODULE##_##OBJ_NAME##_GET_CLASS (gpointer ptr) { \
1722 return G_TYPE_INSTANCE_GET_CLASS (ptr, module_obj_name##_get_type (), ModuleObjName##Class); } \
1723 G_GNUC_END_IGNORE_DEPRECATIONS
1726 * G_DECLARE_INTERFACE:
1727 * @ModuleObjName: The name of the new type, in camel case (like `GtkWidget`)
1728 * @module_obj_name: The name of the new type in lowercase, with words
1729 * separated by `_` (like `gtk_widget`)
1730 * @MODULE: The name of the module, in all caps (like `GTK`)
1731 * @OBJ_NAME: The bare name of the type, in all caps (like `WIDGET`)
1732 * @PrerequisiteName: the name of the prerequisite type, in camel case (like `GtkWidget`)
1734 * A convenience macro for emitting the usual declarations in the header file for a #GInterface type.
1736 * You might use it in a header as follows:
1738 * |[<!-- language="C" -->
1739 * #ifndef _my_model_h_
1740 * #define _my_model_h_
1742 * #define MY_TYPE_MODEL my_model_get_type ()
1743 * GDK_AVAILABLE_IN_3_12
1744 * G_DECLARE_INTERFACE (MyModel, my_model, MY, MODEL, GObject)
1746 * struct _MyModelInterface
1748 * GTypeInterface g_iface;
1750 * gpointer (* get_item) (MyModel *model);
1753 * gpointer my_model_get_item (MyModel *model);
1760 * And use it as follow in your C file:
1762 * |[<!-- language="C" -->
1763 * G_DEFINE_INTERFACE (MyModel, my_model, G_TYPE_OBJECT);
1766 * my_model_default_init (MyModelInterface *iface)
1772 * This results in the following things happening:
1774 * - the usual `my_model_get_type()` function is declared with a return type of #GType
1776 * - the `MyModelInterface` type is defined as a typedef to `struct _MyModelInterface`,
1777 * which is left undefined. You should do this from the header file directly after
1778 * you use the macro.
1780 * - the `MY_MODEL()` cast is emitted as `static inline` functions along with
1781 * the `MY_IS_MODEL()` type checking function and `MY_MODEL_GET_IFACE()` function.
1783 * - g_autoptr() support being added for your type, based on your prerequisite type.
1785 * You can only use this function if your prerequisite type also supports g_autoptr().
1787 * Because the type macro (`MY_TYPE_MODEL` in the above example) is not a callable, you must continue to
1788 * manually define this as a macro for yourself.
1790 * The declaration of the `_get_type()` function is the first thing emitted by the macro. This allows this macro
1791 * to be used in the usual way with export control and API versioning macros.
1795 #define G_DECLARE_INTERFACE(ModuleObjName, module_obj_name, MODULE, OBJ_NAME, PrerequisiteName) \
1796 GType module_obj_name##_get_type (void); \
1797 G_GNUC_BEGIN_IGNORE_DEPRECATIONS \
1798 typedef struct _##ModuleObjName ModuleObjName; \
1799 typedef struct _##ModuleObjName##Interface ModuleObjName##Interface; \
1801 _GLIB_DEFINE_AUTOPTR_CHAINUP (ModuleObjName, PrerequisiteName) \
1803 G_GNUC_UNUSED static inline ModuleObjName * MODULE##_##OBJ_NAME (gpointer ptr) { \
1804 return G_TYPE_CHECK_INSTANCE_CAST (ptr, module_obj_name##_get_type (), ModuleObjName); } \
1805 G_GNUC_UNUSED static inline gboolean MODULE##_IS_##OBJ_NAME (gpointer ptr) { \
1806 return G_TYPE_CHECK_INSTANCE_TYPE (ptr, module_obj_name##_get_type ()); } \
1807 G_GNUC_UNUSED static inline ModuleObjName##Interface * MODULE##_##OBJ_NAME##_GET_IFACE (gpointer ptr) { \
1808 return G_TYPE_INSTANCE_GET_INTERFACE (ptr, module_obj_name##_get_type (), ModuleObjName##Interface); } \
1809 G_GNUC_END_IGNORE_DEPRECATIONS
1813 * @TN: The name of the new type, in Camel case.
1814 * @t_n: The name of the new type, in lowercase, with words
1816 * @T_P: The #GType of the parent type.
1818 * A convenience macro for type implementations, which declares a class
1819 * initialization function, an instance initialization function (see #GTypeInfo
1820 * for information about these) and a static variable named `t_n_parent_class`
1821 * pointing to the parent class. Furthermore, it defines a `*_get_type()` function.
1822 * See G_DEFINE_TYPE_EXTENDED() for an example.
1826 #define G_DEFINE_TYPE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, 0, {})
1828 * G_DEFINE_TYPE_WITH_CODE:
1829 * @TN: The name of the new type, in Camel case.
1830 * @t_n: The name of the new type in lowercase, with words separated by `_`.
1831 * @T_P: The #GType of the parent type.
1832 * @_C_: Custom code that gets inserted in the `*_get_type()` function.
1834 * A convenience macro for type implementations.
1836 * Similar to G_DEFINE_TYPE(), but allows you to insert custom code into the
1837 * `*_get_type()` function, e.g. interface implementations via G_IMPLEMENT_INTERFACE().
1838 * See G_DEFINE_TYPE_EXTENDED() for an example.
1842 #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()
1844 * G_DEFINE_TYPE_WITH_PRIVATE:
1845 * @TN: The name of the new type, in Camel case.
1846 * @t_n: The name of the new type, in lowercase, with words
1848 * @T_P: The #GType of the parent type.
1850 * A convenience macro for type implementations, which declares a class
1851 * initialization function, an instance initialization function (see #GTypeInfo
1852 * for information about these), a static variable named `t_n_parent_class`
1853 * pointing to the parent class, and adds private instance data to the type.
1855 * Furthermore, it defines a `*_get_type()` function. See G_DEFINE_TYPE_EXTENDED()
1858 * Note that private structs added with this macros must have a struct
1859 * name of the form `TN ## Private`.
1861 * The private instance data can be retrieved using the automatically generated
1862 * getter function `t_n_get_instance_private()`.
1864 * See also: G_ADD_PRIVATE()
1868 #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))
1870 * G_DEFINE_ABSTRACT_TYPE:
1871 * @TN: The name of the new type, in Camel case.
1872 * @t_n: The name of the new type, in lowercase, with words
1874 * @T_P: The #GType of the parent type.
1876 * A convenience macro for type implementations.
1878 * Similar to G_DEFINE_TYPE(), but defines an abstract type.
1879 * See G_DEFINE_TYPE_EXTENDED() for an example.
1883 #define G_DEFINE_ABSTRACT_TYPE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_ABSTRACT, {})
1885 * G_DEFINE_ABSTRACT_TYPE_WITH_CODE:
1886 * @TN: The name of the new type, in Camel case.
1887 * @t_n: The name of the new type, in lowercase, with words
1889 * @T_P: The #GType of the parent type.
1890 * @_C_: Custom code that gets inserted in the `type_name_get_type()` function.
1892 * A convenience macro for type implementations.
1894 * Similar to G_DEFINE_TYPE_WITH_CODE(), but defines an abstract type and
1895 * allows you to insert custom code into the `*_get_type()` function, e.g.
1896 * interface implementations via G_IMPLEMENT_INTERFACE().
1898 * See G_DEFINE_TYPE_EXTENDED() for an example.
1902 #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()
1904 * G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE:
1905 * @TN: The name of the new type, in Camel case.
1906 * @t_n: The name of the new type, in lowercase, with words
1908 * @T_P: The #GType of the parent type.
1910 * Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines an abstract type.
1912 * See G_DEFINE_TYPE_EXTENDED() for an example.
1916 #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))
1918 * G_DEFINE_FINAL_TYPE:
1919 * @TN: the name of the new type, in Camel case
1920 * @t_n: the name of the new type, in lower case, with words
1921 * separated by `_` (snake case)
1922 * @T_P: the #GType of the parent type
1924 * A convenience macro for type implementations.
1926 * Similar to G_DEFINE_TYPE(), but defines a final type.
1928 * See G_DEFINE_TYPE_EXTENDED() for an example.
1932 #define G_DEFINE_FINAL_TYPE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_FINAL, {}) GOBJECT_AVAILABLE_MACRO_IN_2_70
1934 * G_DEFINE_FINAL_TYPE_WITH_CODE:
1935 * @TN: the name of the new type, in Camel case
1936 * @t_n: the name of the new type, in lower case, with words
1937 * separated by `_` (snake case)
1938 * @T_P: the #GType of the parent type
1939 * @_C_: Custom code that gets inserted in the `type_name_get_type()` function.
1941 * A convenience macro for type implementations.
1943 * Similar to G_DEFINE_TYPE_WITH_CODE(), but defines a final type and
1944 * allows you to insert custom code into the `*_get_type()` function, e.g.
1945 * interface implementations via G_IMPLEMENT_INTERFACE().
1947 * See G_DEFINE_TYPE_EXTENDED() for an example.
1951 #define G_DEFINE_FINAL_TYPE_WITH_CODE(TN, t_n, T_P, _C_) _G_DEFINE_TYPE_EXTENDED_BEGIN (TN, t_n, T_P, G_TYPE_FLAG_FINAL) {_C_;} _G_DEFINE_TYPE_EXTENDED_END() GOBJECT_AVAILABLE_MACRO_IN_2_70
1953 * G_DEFINE_FINAL_TYPE_WITH_PRIVATE:
1954 * @TN: the name of the new type, in Camel case
1955 * @t_n: the name of the new type, in lower case, with words
1956 * separated by `_` (snake case)
1957 * @T_P: the #GType of the parent type
1959 * A convenience macro for type implementations.
1961 * Similar to G_DEFINE_TYPE_WITH_PRIVATE(), but defines a final type.
1963 * See G_DEFINE_TYPE_EXTENDED() for an example.
1967 #define G_DEFINE_FINAL_TYPE_WITH_PRIVATE(TN, t_n, T_P) G_DEFINE_TYPE_EXTENDED (TN, t_n, T_P, G_TYPE_FLAG_FINAL, G_ADD_PRIVATE (TN)) GOBJECT_AVAILABLE_MACRO_IN_2_70
1969 * G_DEFINE_TYPE_EXTENDED:
1970 * @TN: The name of the new type, in Camel case.
1971 * @t_n: The name of the new type, in lowercase, with words
1973 * @T_P: The #GType of the parent type.
1974 * @_f_: #GTypeFlags to pass to g_type_register_static()
1975 * @_C_: Custom code that gets inserted in the `*_get_type()` function.
1977 * The most general convenience macro for type implementations, on which
1978 * G_DEFINE_TYPE(), etc are based.
1980 * |[<!-- language="C" -->
1981 * G_DEFINE_TYPE_EXTENDED (GtkGadget,
1985 * G_ADD_PRIVATE (GtkGadget)
1986 * G_IMPLEMENT_INTERFACE (TYPE_GIZMO,
1987 * gtk_gadget_gizmo_init));
1992 * |[<!-- language="C" -->
1993 * static void gtk_gadget_init (GtkGadget *self);
1994 * static void gtk_gadget_class_init (GtkGadgetClass *klass);
1995 * static gpointer gtk_gadget_parent_class = NULL;
1996 * static gint GtkGadget_private_offset;
1997 * static void gtk_gadget_class_intern_init (gpointer klass)
1999 * gtk_gadget_parent_class = g_type_class_peek_parent (klass);
2000 * if (GtkGadget_private_offset != 0)
2001 * g_type_class_adjust_private_offset (klass, &GtkGadget_private_offset);
2002 * gtk_gadget_class_init ((GtkGadgetClass*) klass);
2004 * static inline gpointer gtk_gadget_get_instance_private (GtkGadget *self)
2006 * return (G_STRUCT_MEMBER_P (self, GtkGadget_private_offset));
2010 * gtk_gadget_get_type (void)
2012 * static gsize static_g_define_type_id = 0;
2013 * if (g_once_init_enter (&static_g_define_type_id))
2015 * GType g_define_type_id =
2016 * g_type_register_static_simple (GTK_TYPE_WIDGET,
2017 * g_intern_static_string ("GtkGadget"),
2018 * sizeof (GtkGadgetClass),
2019 * (GClassInitFunc) gtk_gadget_class_intern_init,
2020 * sizeof (GtkGadget),
2021 * (GInstanceInitFunc) gtk_gadget_init,
2024 * GtkGadget_private_offset =
2025 * g_type_add_instance_private (g_define_type_id, sizeof (GtkGadgetPrivate));
2028 * const GInterfaceInfo g_implement_interface_info = {
2029 * (GInterfaceInitFunc) gtk_gadget_gizmo_init
2031 * g_type_add_interface_static (g_define_type_id, TYPE_GIZMO, &g_implement_interface_info);
2033 * g_once_init_leave (&static_g_define_type_id, g_define_type_id);
2035 * return static_g_define_type_id;
2039 * The only pieces which have to be manually provided are the definitions of
2040 * the instance and class structure and the definitions of the instance and
2041 * class init functions.
2045 #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()
2048 * G_DEFINE_INTERFACE:
2049 * @TN: The name of the new type, in Camel case.
2050 * @t_n: The name of the new type, in lowercase, with words separated by `_`.
2051 * @T_P: The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID
2052 * for no prerequisite type.
2054 * A convenience macro for #GTypeInterface definitions, which declares
2055 * a default vtable initialization function and defines a `*_get_type()`
2058 * The macro expects the interface initialization function to have the
2059 * name `t_n ## _default_init`, and the interface structure to have the
2060 * name `TN ## Interface`.
2062 * The initialization function has signature
2063 * `static void t_n ## _default_init (TypeName##Interface *klass);`, rather than
2064 * the full #GInterfaceInitFunc signature, for brevity and convenience. If you
2065 * need to use an initialization function with an `iface_data` argument, you
2066 * must write the #GTypeInterface definitions manually.
2070 #define G_DEFINE_INTERFACE(TN, t_n, T_P) G_DEFINE_INTERFACE_WITH_CODE(TN, t_n, T_P, ;)
2073 * G_DEFINE_INTERFACE_WITH_CODE:
2074 * @TN: The name of the new type, in Camel case.
2075 * @t_n: The name of the new type, in lowercase, with words separated by `_`.
2076 * @T_P: The #GType of the prerequisite type for the interface, or %G_TYPE_INVALID
2077 * for no prerequisite type.
2078 * @_C_: Custom code that gets inserted in the `*_get_type()` function.
2080 * A convenience macro for #GTypeInterface definitions.
2082 * Similar to G_DEFINE_INTERFACE(), but allows you to insert custom code
2083 * into the `*_get_type()` function, e.g. additional interface implementations
2084 * via G_IMPLEMENT_INTERFACE(), or additional prerequisite types.
2086 * See G_DEFINE_TYPE_EXTENDED() for a similar example using
2087 * G_DEFINE_TYPE_WITH_CODE().
2091 #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()
2094 * G_IMPLEMENT_INTERFACE:
2095 * @TYPE_IFACE: The #GType of the interface to add
2096 * @iface_init: (type GInterfaceInitFunc): The interface init function, of type #GInterfaceInitFunc
2098 * A convenience macro to ease interface addition in the `_C_` section
2099 * of G_DEFINE_TYPE_WITH_CODE() or G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
2100 * See G_DEFINE_TYPE_EXTENDED() for an example.
2102 * Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
2103 * macros, since it depends on variable names from those macros.
2107 #define G_IMPLEMENT_INTERFACE(TYPE_IFACE, iface_init) { \
2108 const GInterfaceInfo g_implement_interface_info = { \
2109 (GInterfaceInitFunc)(void (*)(void)) iface_init, NULL, NULL \
2111 g_type_add_interface_static (g_define_type_id, TYPE_IFACE, &g_implement_interface_info); \
2116 * @TypeName: the name of the type in CamelCase
2118 * A convenience macro to ease adding private data to instances of a new type
2119 * in the @_C_ section of G_DEFINE_TYPE_WITH_CODE() or
2120 * G_DEFINE_ABSTRACT_TYPE_WITH_CODE().
2124 * |[<!-- language="C" -->
2125 * typedef struct _MyObject MyObject;
2126 * typedef struct _MyObjectClass MyObjectClass;
2131 * } MyObjectPrivate;
2133 * G_DEFINE_TYPE_WITH_CODE (MyObject, my_object, G_TYPE_OBJECT,
2134 * G_ADD_PRIVATE (MyObject))
2137 * Will add `MyObjectPrivate` as the private data to any instance of the
2140 * `G_DEFINE_TYPE_*` macros will automatically create a private function
2141 * based on the arguments to this macro, which can be used to safely
2142 * retrieve the private data from an instance of the type; for instance:
2144 * |[<!-- language="C" -->
2146 * my_object_get_foo (MyObject *obj)
2148 * MyObjectPrivate *priv = my_object_get_instance_private (obj);
2150 * g_return_val_if_fail (MY_IS_OBJECT (obj), 0);
2156 * my_object_set_bar (MyObject *obj,
2159 * MyObjectPrivate *priv = my_object_get_instance_private (obj);
2161 * g_return_if_fail (MY_IS_OBJECT (obj));
2163 * if (priv->bar != bar)
2168 * Since GLib 2.72, the returned `MyObjectPrivate` pointer is guaranteed to be
2169 * aligned to at least the alignment of the largest basic GLib type (typically
2170 * this is #guint64 or #gdouble). If you need larger alignment for an element in
2171 * the struct, you should allocate it on the heap (aligned), or arrange for your
2172 * `MyObjectPrivate` struct to be appropriately padded.
2174 * Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
2175 * macros, since it depends on variable names from those macros.
2177 * Also note that private structs added with these macros must have a struct
2178 * name of the form `TypeNamePrivate`.
2180 * It is safe to call the `_get_instance_private` function on %NULL or invalid
2181 * objects since it's only adding an offset to the instance pointer. In that
2182 * case the returned pointer must not be dereferenced.
2186 #define G_ADD_PRIVATE(TypeName) { \
2187 TypeName##_private_offset = \
2188 g_type_add_instance_private (g_define_type_id, sizeof (TypeName##Private)); \
2193 * @TypeName: the name of the type in CamelCase
2194 * @field: the name of the field in the private data structure
2196 * Evaluates to the offset of the @field inside the instance private data
2197 * structure for @TypeName.
2199 * Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
2200 * and G_ADD_PRIVATE() macros, since it depends on variable names from
2205 #define G_PRIVATE_OFFSET(TypeName, field) \
2206 (TypeName##_private_offset + (G_STRUCT_OFFSET (TypeName##Private, field)))
2209 * G_PRIVATE_FIELD_P:
2210 * @TypeName: the name of the type in CamelCase
2211 * @inst: the instance of @TypeName you wish to access
2212 * @field_name: the name of the field in the private data structure
2214 * Evaluates to a pointer to the @field_name inside the @inst private data
2215 * structure for @TypeName.
2217 * Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
2218 * and G_ADD_PRIVATE() macros, since it depends on variable names from
2223 #define G_PRIVATE_FIELD_P(TypeName, inst, field_name) \
2224 G_STRUCT_MEMBER_P (inst, G_PRIVATE_OFFSET (TypeName, field_name))
2228 * @TypeName: the name of the type in CamelCase
2229 * @inst: the instance of @TypeName you wish to access
2230 * @field_type: the type of the field in the private data structure
2231 * @field_name: the name of the field in the private data structure
2233 * Evaluates to the @field_name inside the @inst private data
2234 * structure for @TypeName.
2236 * Note that this macro can only be used together with the `G_DEFINE_TYPE_*`
2237 * and G_ADD_PRIVATE() macros, since it depends on variable names from
2242 #define G_PRIVATE_FIELD(TypeName, inst, field_type, field_name) \
2243 G_STRUCT_MEMBER (field_type, inst, G_PRIVATE_OFFSET (TypeName, field_name))
2245 /* we need to have this macro under conditional expansion, as it references
2246 * a function that has been added in 2.38. see bug:
2247 * https://bugzilla.gnome.org/show_bug.cgi?id=703191
2249 #if GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38
2250 #define _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
2251 static void type_name##_class_intern_init (gpointer klass) \
2253 type_name##_parent_class = g_type_class_peek_parent (klass); \
2254 if (TypeName##_private_offset != 0) \
2255 g_type_class_adjust_private_offset (klass, &TypeName##_private_offset); \
2256 type_name##_class_init ((TypeName##Class*) klass); \
2260 #define _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
2261 static void type_name##_class_intern_init (gpointer klass) \
2263 type_name##_parent_class = g_type_class_peek_parent (klass); \
2264 type_name##_class_init ((TypeName##Class*) klass); \
2266 #endif /* GLIB_VERSION_MAX_ALLOWED >= GLIB_VERSION_2_38 */
2268 /* Added for _G_DEFINE_TYPE_EXTENDED_WITH_PRELUDE */
2269 #define _G_DEFINE_TYPE_EXTENDED_BEGIN_PRE(TypeName, type_name, TYPE_PARENT) \
2271 static void type_name##_init (TypeName *self); \
2272 static void type_name##_class_init (TypeName##Class *klass); \
2273 static GType type_name##_get_type_once (void); \
2274 static gpointer type_name##_parent_class = NULL; \
2275 static gint TypeName##_private_offset; \
2277 _G_DEFINE_TYPE_EXTENDED_CLASS_INIT(TypeName, type_name) \
2280 static inline gpointer \
2281 type_name##_get_instance_private (TypeName *self) \
2283 return (G_STRUCT_MEMBER_P (self, TypeName##_private_offset)); \
2287 type_name##_get_type (void) \
2289 static gsize static_g_define_type_id = 0;
2290 /* Prelude goes here */
2292 /* Added for _G_DEFINE_TYPE_EXTENDED_WITH_PRELUDE */
2293 #define _G_DEFINE_TYPE_EXTENDED_BEGIN_REGISTER(TypeName, type_name, TYPE_PARENT, flags) \
2294 if (g_once_init_enter (&static_g_define_type_id)) \
2296 GType g_define_type_id = type_name##_get_type_once (); \
2297 g_once_init_leave (&static_g_define_type_id, g_define_type_id); \
2299 return static_g_define_type_id; \
2300 } /* closes type_name##_get_type() */ \
2304 type_name##_get_type_once (void) \
2306 GType g_define_type_id = \
2307 g_type_register_static_simple (TYPE_PARENT, \
2308 g_intern_static_string (#TypeName), \
2309 sizeof (TypeName##Class), \
2310 (GClassInitFunc)(void (*)(void)) type_name##_class_intern_init, \
2311 sizeof (TypeName), \
2312 (GInstanceInitFunc)(void (*)(void)) type_name##_init, \
2313 (GTypeFlags) flags); \
2314 { /* custom code follows */
2315 #define _G_DEFINE_TYPE_EXTENDED_END() \
2316 /* following custom code */ \
2318 return g_define_type_id; \
2319 } /* closes type_name##_get_type_once() */
2321 /* This was defined before we had G_DEFINE_TYPE_WITH_CODE_AND_PRELUDE, it's simplest
2324 #define _G_DEFINE_TYPE_EXTENDED_BEGIN(TypeName, type_name, TYPE_PARENT, flags) \
2325 _G_DEFINE_TYPE_EXTENDED_BEGIN_PRE(TypeName, type_name, TYPE_PARENT) \
2326 _G_DEFINE_TYPE_EXTENDED_BEGIN_REGISTER(TypeName, type_name, TYPE_PARENT, flags) \
2328 /* Intentionally using (GTypeFlags) 0 instead of G_TYPE_FLAG_NONE here,
2329 * to avoid deprecation warnings with older GLIB_VERSION_MAX_ALLOWED */
2330 #define _G_DEFINE_INTERFACE_EXTENDED_BEGIN(TypeName, type_name, TYPE_PREREQ) \
2332 static void type_name##_default_init (TypeName##Interface *klass); \
2335 type_name##_get_type (void) \
2337 static gsize static_g_define_type_id = 0; \
2338 if (g_once_init_enter (&static_g_define_type_id)) \
2340 GType g_define_type_id = \
2341 g_type_register_static_simple (G_TYPE_INTERFACE, \
2342 g_intern_static_string (#TypeName), \
2343 sizeof (TypeName##Interface), \
2344 (GClassInitFunc)(void (*)(void)) type_name##_default_init, \
2346 (GInstanceInitFunc)NULL, \
2348 if (TYPE_PREREQ != G_TYPE_INVALID) \
2349 g_type_interface_add_prerequisite (g_define_type_id, TYPE_PREREQ); \
2350 { /* custom code follows */
2351 #define _G_DEFINE_INTERFACE_EXTENDED_END() \
2352 /* following custom code */ \
2354 g_once_init_leave (&static_g_define_type_id, g_define_type_id); \
2356 return static_g_define_type_id; \
2357 } /* closes type_name##_get_type() */
2360 * G_DEFINE_BOXED_TYPE:
2361 * @TypeName: The name of the new type, in Camel case
2362 * @type_name: The name of the new type, in lowercase, with words
2364 * @copy_func: the #GBoxedCopyFunc for the new type
2365 * @free_func: the #GBoxedFreeFunc for the new type
2367 * A convenience macro for defining a new custom boxed type.
2369 * Using this macro is the recommended way of defining new custom boxed
2370 * types, over calling g_boxed_type_register_static() directly. It defines
2371 * a `type_name_get_type()` function which will return the newly defined
2372 * #GType, enabling lazy instantiation.
2374 * You might start by putting declarations in a header as follows:
2376 * |[<!-- language="C" -->
2377 * #define MY_TYPE_STRUCT my_struct_get_type ()
2378 * GType my_struct_get_type (void) G_GNUC_CONST;
2380 * MyStruct * my_struct_new (void);
2381 * void my_struct_free (MyStruct *self);
2382 * MyStruct * my_struct_copy (MyStruct *self);
2385 * And then use this macro and define your implementation in the source file as
2388 * |[<!-- language="C" -->
2390 * my_struct_new (void)
2392 * // ... your code to allocate a new MyStruct ...
2396 * my_struct_free (MyStruct *self)
2398 * // ... your code to free a MyStruct ...
2402 * my_struct_copy (MyStruct *self)
2404 * // ... your code return a newly allocated copy of a MyStruct ...
2407 * G_DEFINE_BOXED_TYPE (MyStruct, my_struct, my_struct_copy, my_struct_free)
2414 * ms = my_struct_new ();
2415 * // ... your code ...
2416 * my_struct_free (ms);
2422 #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, {})
2424 * G_DEFINE_BOXED_TYPE_WITH_CODE:
2425 * @TypeName: The name of the new type, in Camel case
2426 * @type_name: The name of the new type, in lowercase, with words
2428 * @copy_func: the #GBoxedCopyFunc for the new type
2429 * @free_func: the #GBoxedFreeFunc for the new type
2430 * @_C_: Custom code that gets inserted in the `*_get_type()` function
2432 * A convenience macro for boxed type implementations.
2434 * Similar to G_DEFINE_BOXED_TYPE(), but allows to insert custom code into the
2435 * `type_name_get_type()` function, e.g. to register value transformations with
2436 * g_value_register_transform_func(), for instance:
2438 * |[<!-- language="C" -->
2439 * G_DEFINE_BOXED_TYPE_WITH_CODE (GdkRectangle, gdk_rectangle,
2440 * gdk_rectangle_copy,
2441 * gdk_rectangle_free,
2442 * register_rectangle_transform_funcs (g_define_type_id))
2445 * Similarly to the `G_DEFINE_TYPE_*` family of macros, the #GType of the newly
2446 * defined boxed type is exposed in the `g_define_type_id` variable.
2450 #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()
2452 /* Only use this in non-C++ on GCC >= 2.7, except for Darwin/ppc64.
2453 * See https://bugzilla.gnome.org/show_bug.cgi?id=647145
2455 #if !defined (G_CXX_STD_VERSION) && (G_GNUC_CHECK_VERSION(2, 7)) && \
2456 !(defined (__APPLE__) && defined (__ppc64__))
2457 #define _G_DEFINE_BOXED_TYPE_BEGIN(TypeName, type_name, copy_func, free_func) \
2458 static GType type_name##_get_type_once (void); \
2461 type_name##_get_type (void) \
2463 static gsize static_g_define_type_id = 0; \
2464 if (g_once_init_enter (&static_g_define_type_id)) \
2466 GType g_define_type_id = type_name##_get_type_once (); \
2467 g_once_init_leave (&static_g_define_type_id, g_define_type_id); \
2469 return static_g_define_type_id; \
2474 type_name##_get_type_once (void) \
2476 GType (* _g_register_boxed) \
2480 TypeName * (*do_copy_type) (TypeName *); \
2481 TypeName * (*do_const_copy_type) (const TypeName *); \
2482 GBoxedCopyFunc do_copy_boxed; \
2483 } __attribute__((__transparent_union__)), \
2486 void (* do_free_type) (TypeName *); \
2487 GBoxedFreeFunc do_free_boxed; \
2488 } __attribute__((__transparent_union__)) \
2489 ) = g_boxed_type_register_static; \
2490 GType g_define_type_id = \
2491 _g_register_boxed (g_intern_static_string (#TypeName), copy_func, free_func); \
2492 { /* custom code follows */
2494 #define _G_DEFINE_BOXED_TYPE_BEGIN(TypeName, type_name, copy_func, free_func) \
2495 static GType type_name##_get_type_once (void); \
2498 type_name##_get_type (void) \
2500 static gsize static_g_define_type_id = 0; \
2501 if (g_once_init_enter (&static_g_define_type_id)) \
2503 GType g_define_type_id = type_name##_get_type_once (); \
2504 g_once_init_leave (&static_g_define_type_id, g_define_type_id); \
2506 return static_g_define_type_id; \
2511 type_name##_get_type_once (void) \
2513 GType g_define_type_id = \
2514 g_boxed_type_register_static (g_intern_static_string (#TypeName), \
2515 (GBoxedCopyFunc) copy_func, \
2516 (GBoxedFreeFunc) free_func); \
2517 { /* custom code follows */
2518 #endif /* __GNUC__ */
2521 * G_DEFINE_POINTER_TYPE:
2522 * @TypeName: The name of the new type, in Camel case
2523 * @type_name: The name of the new type, in lowercase, with words
2526 * A convenience macro for pointer type implementations, which defines a
2527 * `type_name_get_type()` function registering the pointer type.
2531 #define G_DEFINE_POINTER_TYPE(TypeName, type_name) G_DEFINE_POINTER_TYPE_WITH_CODE (TypeName, type_name, {})
2533 * G_DEFINE_POINTER_TYPE_WITH_CODE:
2534 * @TypeName: The name of the new type, in Camel case
2535 * @type_name: The name of the new type, in lowercase, with words
2537 * @_C_: Custom code that gets inserted in the `*_get_type()` function
2539 * A convenience macro for pointer type implementations.
2540 * Similar to G_DEFINE_POINTER_TYPE(), but allows to insert
2541 * custom code into the `type_name_get_type()` function.
2545 #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()
2547 #define _G_DEFINE_POINTER_TYPE_BEGIN(TypeName, type_name) \
2548 static GType type_name##_get_type_once (void); \
2551 type_name##_get_type (void) \
2553 static gsize static_g_define_type_id = 0; \
2554 if (g_once_init_enter (&static_g_define_type_id)) \
2556 GType g_define_type_id = type_name##_get_type_once (); \
2557 g_once_init_leave (&static_g_define_type_id, g_define_type_id); \
2559 return static_g_define_type_id; \
2564 type_name##_get_type_once (void) \
2566 GType g_define_type_id = \
2567 g_pointer_type_register_static (g_intern_static_string (#TypeName)); \
2568 { /* custom code follows */
2570 /* --- protected (for fundamental type implementations) --- */
2571 GOBJECT_AVAILABLE_IN_ALL
2572 GTypePlugin* g_type_get_plugin (GType type);
2573 GOBJECT_AVAILABLE_IN_ALL
2574 GTypePlugin* g_type_interface_get_plugin (GType instance_type,
2575 GType interface_type);
2576 GOBJECT_AVAILABLE_IN_ALL
2577 GType g_type_fundamental_next (void);
2578 GOBJECT_AVAILABLE_IN_ALL
2579 GType g_type_fundamental (GType type_id);
2580 GOBJECT_AVAILABLE_IN_ALL
2581 GTypeInstance* g_type_create_instance (GType type);
2582 GOBJECT_AVAILABLE_IN_ALL
2583 void g_type_free_instance (GTypeInstance *instance);
2585 GOBJECT_AVAILABLE_IN_ALL
2586 void g_type_add_class_cache_func (gpointer cache_data,
2587 GTypeClassCacheFunc cache_func);
2588 GOBJECT_AVAILABLE_IN_ALL
2589 void g_type_remove_class_cache_func (gpointer cache_data,
2590 GTypeClassCacheFunc cache_func);
2591 GOBJECT_AVAILABLE_IN_ALL
2592 void g_type_class_unref_uncached (gpointer g_class);
2594 GOBJECT_AVAILABLE_IN_ALL
2595 void g_type_add_interface_check (gpointer check_data,
2596 GTypeInterfaceCheckFunc check_func);
2597 GOBJECT_AVAILABLE_IN_ALL
2598 void g_type_remove_interface_check (gpointer check_data,
2599 GTypeInterfaceCheckFunc check_func);
2601 GOBJECT_AVAILABLE_IN_ALL
2602 GTypeValueTable* g_type_value_table_peek (GType type);
2606 GOBJECT_AVAILABLE_IN_ALL
2607 gboolean g_type_check_instance (GTypeInstance *instance) G_GNUC_PURE;
2608 GOBJECT_AVAILABLE_IN_ALL
2609 GTypeInstance* g_type_check_instance_cast (GTypeInstance *instance,
2611 GOBJECT_AVAILABLE_IN_ALL
2612 gboolean g_type_check_instance_is_a (GTypeInstance *instance,
2613 GType iface_type) G_GNUC_PURE;
2614 GOBJECT_AVAILABLE_IN_2_42
2615 gboolean g_type_check_instance_is_fundamentally_a (GTypeInstance *instance,
2616 GType fundamental_type) G_GNUC_PURE;
2617 GOBJECT_AVAILABLE_IN_ALL
2618 GTypeClass* g_type_check_class_cast (GTypeClass *g_class,
2620 GOBJECT_AVAILABLE_IN_ALL
2621 gboolean g_type_check_class_is_a (GTypeClass *g_class,
2622 GType is_a_type) G_GNUC_PURE;
2623 GOBJECT_AVAILABLE_IN_ALL
2624 gboolean g_type_check_is_value_type (GType type) G_GNUC_CONST;
2625 GOBJECT_AVAILABLE_IN_ALL
2626 gboolean g_type_check_value (const GValue *value) G_GNUC_PURE;
2627 GOBJECT_AVAILABLE_IN_ALL
2628 gboolean g_type_check_value_holds (const GValue *value,
2629 GType type) G_GNUC_PURE;
2630 GOBJECT_AVAILABLE_IN_ALL
2631 gboolean g_type_test_flags (GType type,
2632 guint flags) G_GNUC_CONST;
2635 /* --- debugging functions --- */
2636 GOBJECT_AVAILABLE_IN_ALL
2637 const gchar * g_type_name_from_instance (GTypeInstance *instance);
2638 GOBJECT_AVAILABLE_IN_ALL
2639 const gchar * g_type_name_from_class (GTypeClass *g_class);
2642 /* --- implementation bits --- */
2643 #if defined(G_DISABLE_CAST_CHECKS) || defined(__OPTIMIZE__)
2644 # define _G_TYPE_CIC(ip, gt, ct) ((ct*) (void *) ip)
2645 # define _G_TYPE_CCC(cp, gt, ct) ((ct*) (void *) cp)
2647 # define _G_TYPE_CIC(ip, gt, ct) \
2648 ((ct*) (void *) g_type_check_instance_cast ((GTypeInstance*) ip, gt))
2649 # define _G_TYPE_CCC(cp, gt, ct) \
2650 ((ct*) (void *) g_type_check_class_cast ((GTypeClass*) cp, gt))
2653 #define _G_TYPE_CHI(ip) (g_type_check_instance ((GTypeInstance*) ip))
2654 #define _G_TYPE_CHV(vl) (g_type_check_value ((GValue*) vl))
2655 #define _G_TYPE_IGC(ip, gt, ct) ((ct*) (((GTypeInstance*) ip)->g_class))
2656 #define _G_TYPE_IGI(ip, gt, ct) ((ct*) g_type_interface_peek (((GTypeInstance*) ip)->g_class, gt))
2657 #define _G_TYPE_CIFT(ip, ft) (g_type_check_instance_is_fundamentally_a ((GTypeInstance*) ip, ft))
2659 # define _G_TYPE_CIT(ip, gt) (G_GNUC_EXTENSION ({ \
2660 GTypeInstance *__inst = (GTypeInstance*) ip; GType __t = gt; gboolean __r; \
2663 else if (__inst->g_class && __inst->g_class->g_type == __t) \
2666 __r = g_type_check_instance_is_a (__inst, __t); \
2669 # define _G_TYPE_CCT(cp, gt) (G_GNUC_EXTENSION ({ \
2670 GTypeClass *__class = (GTypeClass*) cp; GType __t = gt; gboolean __r; \
2673 else if (__class->g_type == __t) \
2676 __r = g_type_check_class_is_a (__class, __t); \
2679 # define _G_TYPE_CVH(vl, gt) (G_GNUC_EXTENSION ({ \
2680 const GValue *__val = (const GValue*) vl; GType __t = gt; gboolean __r; \
2683 else if (__val->g_type == __t) \
2686 __r = g_type_check_value_holds (__val, __t); \
2689 #else /* !__GNUC__ */
2690 # define _G_TYPE_CIT(ip, gt) (g_type_check_instance_is_a ((GTypeInstance*) ip, gt))
2691 # define _G_TYPE_CCT(cp, gt) (g_type_check_class_is_a ((GTypeClass*) cp, gt))
2692 # define _G_TYPE_CVH(vl, gt) (g_type_check_value_holds ((const GValue*) vl, gt))
2693 #endif /* !__GNUC__ */
2695 * G_TYPE_FLAG_RESERVED_ID_BIT:
2697 * A bit in the type number that's supposed to be left untouched.
2699 #define G_TYPE_FLAG_RESERVED_ID_BIT ((GType) (1 << 0))
2703 #endif /* __G_TYPE_H__ */