mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-27 07:56:14 +01:00
137d3248c7
2001-02-21 Tor Lillqvist <tml@iki.fi> * *.h: Use G_BEGIN_DECLS and G_END_DECLS. * Makefile.am: Use libglib-1.3.la from top_builddir. Invoke libtool with -no-undefined for Win32 and Cygwin.
363 lines
15 KiB
C
363 lines
15 KiB
C
/* GObject - GLib Type, Object, Parameter and Signal Library
|
|
* Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General
|
|
* Public License along with this library; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
|
|
* Boston, MA 02111-1307, USA.
|
|
*/
|
|
#ifndef __G_TYPE_H__
|
|
#define __G_TYPE_H__
|
|
|
|
extern const char *g_log_domain_gruntime;
|
|
#include <glib.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/* Basic Type Macros
|
|
*/
|
|
#define G_TYPE_FUNDAMENTAL(type) ((type) & 0xff)
|
|
#define G_TYPE_FUNDAMENTAL_MAX (0xff)
|
|
#define G_TYPE_DERIVE_ID(ptype, branch_seqno) (G_TYPE_FUNDAMENTAL (ptype) | ((branch_seqno) << 8))
|
|
#define G_TYPE_BRANCH_SEQNO(type) ((type) >> 8)
|
|
#define G_TYPE_FUNDAMENTAL_LAST ((GType) g_type_fundamental_last ())
|
|
|
|
|
|
/* predefined fundamental and derived types
|
|
*/
|
|
typedef enum /*< skip >*/
|
|
{
|
|
/* standard types, introduced by g_type_init() */
|
|
G_TYPE_INVALID,
|
|
G_TYPE_NONE,
|
|
G_TYPE_INTERFACE,
|
|
|
|
/* GLib type ids */
|
|
G_TYPE_CHAR,
|
|
G_TYPE_UCHAR,
|
|
G_TYPE_BOOLEAN,
|
|
G_TYPE_INT,
|
|
G_TYPE_UINT,
|
|
G_TYPE_LONG,
|
|
G_TYPE_ULONG,
|
|
G_TYPE_ENUM,
|
|
G_TYPE_FLAGS,
|
|
G_TYPE_FLOAT,
|
|
G_TYPE_DOUBLE,
|
|
G_TYPE_STRING,
|
|
G_TYPE_POINTER,
|
|
G_TYPE_BOXED,
|
|
G_TYPE_PARAM,
|
|
G_TYPE_OBJECT,
|
|
|
|
/* reserved fundamental type ids,
|
|
* mail gtk-devel-list@redhat.com for reservations
|
|
*/
|
|
G_TYPE_RESERVED_BSE_FIRST,
|
|
G_TYPE_RESERVED_BSE_LAST = G_TYPE_RESERVED_BSE_FIRST + 15,
|
|
G_TYPE_RESERVED_LAST_FUNDAMENTAL,
|
|
|
|
/* derived type ids */
|
|
G_TYPE_CLOSURE = G_TYPE_DERIVE_ID (G_TYPE_BOXED, 1),
|
|
G_TYPE_VALUE = G_TYPE_DERIVE_ID (G_TYPE_BOXED, 2),
|
|
G_TYPE_VALUE_ARRAY = G_TYPE_DERIVE_ID (G_TYPE_BOXED, 3),
|
|
G_TYPE_PARAM_CHAR = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 1),
|
|
G_TYPE_PARAM_UCHAR = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 2),
|
|
G_TYPE_PARAM_BOOLEAN = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 3),
|
|
G_TYPE_PARAM_INT = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 4),
|
|
G_TYPE_PARAM_UINT = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 5),
|
|
G_TYPE_PARAM_LONG = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 6),
|
|
G_TYPE_PARAM_ULONG = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 7),
|
|
G_TYPE_PARAM_ENUM = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 8),
|
|
G_TYPE_PARAM_FLAGS = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 9),
|
|
G_TYPE_PARAM_FLOAT = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 10),
|
|
G_TYPE_PARAM_DOUBLE = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 11),
|
|
G_TYPE_PARAM_STRING = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 12),
|
|
G_TYPE_PARAM_PARAM = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 13),
|
|
G_TYPE_PARAM_BOXED = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 14),
|
|
G_TYPE_PARAM_POINTER = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 15),
|
|
G_TYPE_PARAM_VALUE_ARRAY = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 16),
|
|
G_TYPE_PARAM_CLOSURE = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 17),
|
|
G_TYPE_PARAM_OBJECT = G_TYPE_DERIVE_ID (G_TYPE_PARAM, 18)
|
|
} GTypeFundamentals;
|
|
|
|
|
|
/* Type Checking Macros
|
|
*/
|
|
#define G_TYPE_IS_FUNDAMENTAL(type) (G_TYPE_BRANCH_SEQNO (type) == 0)
|
|
#define G_TYPE_IS_DERIVED(type) (G_TYPE_BRANCH_SEQNO (type) > 0)
|
|
#define G_TYPE_IS_INTERFACE(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_INTERFACE)
|
|
#define G_TYPE_IS_CLASSED(type) (g_type_check_flags ((type), G_TYPE_FLAG_CLASSED))
|
|
#define G_TYPE_IS_INSTANTIATABLE(type) (g_type_check_flags ((type), G_TYPE_FLAG_INSTANTIATABLE))
|
|
#define G_TYPE_IS_DERIVABLE(type) (g_type_check_flags ((type), G_TYPE_FLAG_DERIVABLE))
|
|
#define G_TYPE_IS_DEEP_DERIVABLE(type) (g_type_check_flags ((type), G_TYPE_FLAG_DEEP_DERIVABLE))
|
|
#define G_TYPE_IS_ABSTRACT(type) (g_type_check_flags ((type), G_TYPE_FLAG_ABSTRACT))
|
|
#define G_TYPE_IS_VALUE_ABSTRACT(type) (g_type_check_flags ((type), G_TYPE_FLAG_VALUE_ABSTRACT))
|
|
#define G_TYPE_IS_PARAM(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_PARAM)
|
|
#define G_TYPE_IS_VALUE_TYPE(type) (g_type_check_is_value_type (type))
|
|
#define G_TYPE_HAS_VALUE_TABLE(type) (g_type_value_table_peek (type) != NULL)
|
|
|
|
|
|
/* Typedefs
|
|
*/
|
|
typedef guint32 GType;
|
|
typedef struct _GValue GValue;
|
|
typedef union _GTypeCValue GTypeCValue;
|
|
typedef struct _GTypePlugin GTypePlugin;
|
|
typedef struct _GTypeClass GTypeClass;
|
|
typedef struct _GTypeInterface GTypeInterface;
|
|
typedef struct _GTypeInstance GTypeInstance;
|
|
typedef struct _GTypeInfo GTypeInfo;
|
|
typedef struct _GTypeFundamentalInfo GTypeFundamentalInfo;
|
|
typedef struct _GInterfaceInfo GInterfaceInfo;
|
|
typedef struct _GTypeValueTable GTypeValueTable;
|
|
|
|
|
|
/* Basic Type Structures
|
|
*/
|
|
struct _GTypeClass
|
|
{
|
|
/*< private >*/
|
|
GType g_type;
|
|
};
|
|
struct _GTypeInstance
|
|
{
|
|
/*< private >*/
|
|
GTypeClass *g_class;
|
|
};
|
|
struct _GTypeInterface
|
|
{
|
|
/*< private >*/
|
|
GType g_type; /* iface type */
|
|
GType g_instance_type;
|
|
};
|
|
|
|
|
|
/* Casts, checks and accessors for structured types
|
|
* usage of these macros is reserved to type implementations only
|
|
*/
|
|
/*< protected >*/
|
|
#define G_TYPE_CHECK_INSTANCE(instance) (_G_TYPE_CHI ((GTypeInstance*) (instance)))
|
|
#define G_TYPE_CHECK_INSTANCE_CAST(instance, g_type, c_type) (_G_TYPE_CIC ((instance), (g_type), c_type))
|
|
#define G_TYPE_CHECK_INSTANCE_TYPE(instance, g_type) (_G_TYPE_CIT ((instance), (g_type)))
|
|
#define G_TYPE_INSTANCE_GET_CLASS(instance, g_type, c_type) (_G_TYPE_IGC ((instance), (g_type), c_type))
|
|
#define G_TYPE_INSTANCE_GET_INTERFACE(instance, g_type, c_type) (_G_TYPE_IGI ((instance), (g_type), c_type))
|
|
#define G_TYPE_CHECK_CLASS_CAST(g_class, g_type, c_type) (_G_TYPE_CCC ((g_class), (g_type), c_type))
|
|
#define G_TYPE_CHECK_CLASS_TYPE(g_class, g_type) (_G_TYPE_CCT ((g_class), (g_type)))
|
|
#define G_TYPE_CHECK_VALUE(value) (_G_TYPE_CHV ((value)))
|
|
#define G_TYPE_CHECK_VALUE_TYPE(value, g_type) (_G_TYPE_CVH ((value), (g_type)))
|
|
#define G_TYPE_FROM_INSTANCE(instance) (G_TYPE_FROM_CLASS (((GTypeInstance*) (instance))->g_class))
|
|
#define G_TYPE_FROM_CLASS(g_class) (((GTypeClass*) (g_class))->g_type)
|
|
#define G_TYPE_FROM_INTERFACE(g_iface) (((GTypeInterface*) (g_iface))->g_type)
|
|
|
|
|
|
/* debug flags for g_type_init() */
|
|
typedef enum /*< skip >*/
|
|
{
|
|
G_TYPE_DEBUG_NONE = 0,
|
|
G_TYPE_DEBUG_OBJECTS = 1 << 0,
|
|
G_TYPE_DEBUG_SIGNALS = 1 << 1,
|
|
G_TYPE_DEBUG_MASK = 0x03
|
|
} GTypeDebugFlags;
|
|
|
|
|
|
/* --- prototypes --- */
|
|
void g_type_init (GTypeDebugFlags debug_flags);
|
|
G_CONST_RETURN gchar* g_type_name (GType type);
|
|
GQuark g_type_qname (GType type);
|
|
GType g_type_from_name (const gchar *name);
|
|
GType g_type_parent (GType type);
|
|
GType g_type_next_base (GType leaf_type,
|
|
GType root_type);
|
|
gboolean g_type_is_a (GType type,
|
|
GType is_a_type);
|
|
guint g_type_fundamental_branch_last (GType type);
|
|
gpointer g_type_class_ref (GType type);
|
|
gpointer g_type_class_peek (GType type);
|
|
void g_type_class_unref (gpointer g_class);
|
|
gpointer g_type_class_peek_parent (gpointer g_class);
|
|
gpointer g_type_interface_peek (gpointer instance_class,
|
|
GType iface_type);
|
|
|
|
/* g_free() the returned arrays */
|
|
GType* g_type_children (GType type,
|
|
guint *n_children);
|
|
GType* g_type_interfaces (GType type,
|
|
guint *n_interfaces);
|
|
|
|
/* per-type _static_ data */
|
|
void g_type_set_qdata (GType type,
|
|
GQuark quark,
|
|
gpointer data);
|
|
gpointer g_type_get_qdata (GType type,
|
|
GQuark quark);
|
|
|
|
|
|
/* --- type registration --- */
|
|
typedef void (*GBaseInitFunc) (gpointer g_class);
|
|
typedef void (*GBaseFinalizeFunc) (gpointer g_class);
|
|
typedef void (*GClassInitFunc) (gpointer g_class,
|
|
gpointer class_data);
|
|
typedef void (*GClassFinalizeFunc) (gpointer g_class,
|
|
gpointer class_data);
|
|
typedef void (*GInstanceInitFunc) (GTypeInstance *instance,
|
|
gpointer g_class);
|
|
typedef void (*GInterfaceInitFunc) (gpointer g_iface,
|
|
gpointer iface_data);
|
|
typedef void (*GInterfaceFinalizeFunc) (gpointer g_iface,
|
|
gpointer iface_data);
|
|
typedef gboolean (*GTypeClassCacheFunc) (gpointer cache_data,
|
|
GTypeClass *g_class);
|
|
typedef enum /*< skip >*/
|
|
{
|
|
G_TYPE_FLAG_CLASSED = (1 << 0),
|
|
G_TYPE_FLAG_INSTANTIATABLE = (1 << 1),
|
|
G_TYPE_FLAG_DERIVABLE = (1 << 2),
|
|
G_TYPE_FLAG_DEEP_DERIVABLE = (1 << 3)
|
|
} GTypeFundamentalFlags;
|
|
typedef enum /*< skip >*/
|
|
{
|
|
G_TYPE_FLAG_ABSTRACT = (1 << 4),
|
|
G_TYPE_FLAG_VALUE_ABSTRACT = (1 << 5)
|
|
} GTypeFlags;
|
|
struct _GTypeInfo
|
|
{
|
|
/* interface types, classed types, instantiated types */
|
|
guint16 class_size;
|
|
|
|
GBaseInitFunc base_init;
|
|
GBaseFinalizeFunc base_finalize;
|
|
|
|
/* classed types, instantiated types */
|
|
GClassInitFunc class_init;
|
|
GClassFinalizeFunc class_finalize;
|
|
gconstpointer class_data;
|
|
|
|
/* instantiated types */
|
|
guint16 instance_size;
|
|
guint16 n_preallocs;
|
|
GInstanceInitFunc instance_init;
|
|
|
|
/* value handling */
|
|
const GTypeValueTable *value_table;
|
|
};
|
|
struct _GTypeFundamentalInfo
|
|
{
|
|
GTypeFundamentalFlags type_flags;
|
|
};
|
|
struct _GInterfaceInfo
|
|
{
|
|
GInterfaceInitFunc interface_init;
|
|
GInterfaceFinalizeFunc interface_finalize;
|
|
gpointer interface_data;
|
|
};
|
|
struct _GTypeValueTable
|
|
{
|
|
void (*value_init) (GValue *value);
|
|
void (*value_free) (GValue *value);
|
|
void (*value_copy) (const GValue *src_value,
|
|
GValue *dest_value);
|
|
/* varargs functionality (optional) */
|
|
gpointer (*value_peek_pointer) (const GValue *value);
|
|
gchar *collect_format;
|
|
gchar* (*collect_value) (GValue *value,
|
|
guint n_collect_values,
|
|
GTypeCValue *collect_values,
|
|
guint collect_flags);
|
|
gchar *lcopy_format;
|
|
gchar* (*lcopy_value) (const GValue *value,
|
|
guint n_collect_values,
|
|
GTypeCValue *collect_values,
|
|
guint collect_flags);
|
|
};
|
|
GType g_type_register_static (GType parent_type,
|
|
const gchar *type_name,
|
|
const GTypeInfo *info,
|
|
GTypeFlags flags);
|
|
GType g_type_register_dynamic (GType parent_type,
|
|
const gchar *type_name,
|
|
GTypePlugin *plugin,
|
|
GTypeFlags flags);
|
|
GType g_type_register_fundamental (GType type_id,
|
|
const gchar *type_name,
|
|
const GTypeInfo *info,
|
|
const GTypeFundamentalInfo *finfo,
|
|
GTypeFlags flags);
|
|
void g_type_add_interface_static (GType instance_type,
|
|
GType interface_type,
|
|
const GInterfaceInfo *info);
|
|
void g_type_add_interface_dynamic (GType instance_type,
|
|
GType interface_type,
|
|
GTypePlugin *plugin);
|
|
void g_type_interface_add_prerequisite (GType interface_type,
|
|
GType prerequisite_type);
|
|
|
|
|
|
/* --- protected (for fundamental type implementations) --- */
|
|
GTypePlugin* g_type_get_plugin (GType type);
|
|
GTypePlugin* g_type_interface_get_plugin (GType instance_type,
|
|
GType implementation_type);
|
|
|
|
GType g_type_fundamental_last (void);
|
|
gboolean g_type_check_flags (GType type,
|
|
guint flags);
|
|
GTypeInstance* g_type_create_instance (GType type);
|
|
void g_type_free_instance (GTypeInstance *instance);
|
|
void g_type_add_class_cache_func (gpointer cache_data,
|
|
GTypeClassCacheFunc cache_func);
|
|
void g_type_remove_class_cache_func (gpointer cache_data,
|
|
GTypeClassCacheFunc cache_func);
|
|
void g_type_class_unref_uncached (gpointer g_class);
|
|
|
|
|
|
/*< private >*/
|
|
gboolean g_type_check_instance (GTypeInstance *instance);
|
|
GTypeInstance* g_type_check_instance_cast (GTypeInstance *instance,
|
|
GType iface_type);
|
|
gboolean g_type_instance_is_a (GTypeInstance *instance,
|
|
GType iface_type);
|
|
GTypeClass* g_type_check_class_cast (GTypeClass *g_class,
|
|
GType is_a_type);
|
|
gboolean g_type_class_is_a (GTypeClass *g_class,
|
|
GType is_a_type);
|
|
gboolean g_type_check_is_value_type (GType type);
|
|
gboolean g_type_check_value (GValue *value);
|
|
gboolean g_type_check_value_holds (GValue *value,
|
|
GType type);
|
|
GTypeValueTable* g_type_value_table_peek (GType type);
|
|
|
|
|
|
/* --- implementation bits --- */
|
|
#ifndef G_DISABLE_CAST_CHECKS
|
|
# define _G_TYPE_CIC(ip, gt, ct) \
|
|
((ct*) g_type_check_instance_cast ((GTypeInstance*) ip, gt))
|
|
# define _G_TYPE_CCC(cp, gt, ct) \
|
|
((ct*) g_type_check_class_cast ((GTypeClass*) cp, gt))
|
|
#else /* G_DISABLE_CAST_CHECKS */
|
|
# define _G_TYPE_CIC(ip, gt, ct) ((ct*) ip)
|
|
# define _G_TYPE_CCC(cp, gt, ct) ((ct*) cp)
|
|
#endif /* G_DISABLE_CAST_CHECKS */
|
|
#define _G_TYPE_CHI(ip) (g_type_check_instance ((GTypeInstance*) ip))
|
|
#define _G_TYPE_CIT(ip, gt) (g_type_instance_is_a ((GTypeInstance*) ip, gt))
|
|
#define _G_TYPE_CCT(cp, gt) (g_type_class_is_a ((GTypeClass*) cp, gt))
|
|
#define _G_TYPE_CVH(vl, gt) (g_type_check_value_holds ((GValue*) vl, gt))
|
|
#define _G_TYPE_CHV(vl) (g_type_check_value ((GValue*) vl))
|
|
#define _G_TYPE_IGC(ip, gt, ct) ((ct*) (((GTypeInstance*) ip)->g_class))
|
|
#define _G_TYPE_IGI(ip, gt, ct) ((ct*) g_type_interface_peek (((GTypeInstance*) ip)->g_class, gt))
|
|
#define G_TYPE_FLAG_RESERVED_ID_BIT (1 << 30)
|
|
extern GTypeDebugFlags _g_type_debug_flags;
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_TYPE_H__ */
|