gobject/gtype.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General
  15  * Public License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19 #if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
  20 #error "Only <glib-object.h> can be included directly."
  21 #endif
  22
  23 #ifndef __G_TYPE_H__
  24 #define __G_TYPE_H__
  25
  26 #include        <glib.h>
  27
  28 G_BEGIN_DECLS
  29
  30 /* Basic Type Macros
  31  */
  32 #define G_TYPE_FUNDAMENTAL(type)        (g_type_fundamental (type))
  33 #define G_TYPE_FUNDAMENTAL_MAX          (255 << G_TYPE_FUNDAMENTAL_SHIFT)
  34
  35 /* Constant fundamental types,
  36  * introduced by g_type_init().
  37  */
  38 #define G_TYPE_INVALID                  G_TYPE_MAKE_FUNDAMENTAL (0)
  39 #define G_TYPE_NONE                     G_TYPE_MAKE_FUNDAMENTAL (1)
  40 #define G_TYPE_INTERFACE                G_TYPE_MAKE_FUNDAMENTAL (2)
  41 #define G_TYPE_CHAR                     G_TYPE_MAKE_FUNDAMENTAL (3)
  42 #define G_TYPE_UCHAR                    G_TYPE_MAKE_FUNDAMENTAL (4)
  43 #define G_TYPE_BOOLEAN                  G_TYPE_MAKE_FUNDAMENTAL (5)
  44 #define G_TYPE_INT                      G_TYPE_MAKE_FUNDAMENTAL (6)
  45 #define G_TYPE_UINT                     G_TYPE_MAKE_FUNDAMENTAL (7)
  46 #define G_TYPE_LONG                     G_TYPE_MAKE_FUNDAMENTAL (8)
  47 #define G_TYPE_ULONG                    G_TYPE_MAKE_FUNDAMENTAL (9)
  48 #define G_TYPE_INT64                    G_TYPE_MAKE_FUNDAMENTAL (10)
  49 #define G_TYPE_UINT64                   G_TYPE_MAKE_FUNDAMENTAL (11)
  50 #define G_TYPE_ENUM                     G_TYPE_MAKE_FUNDAMENTAL (12)
  51 #define G_TYPE_FLAGS                    G_TYPE_MAKE_FUNDAMENTAL (13)
  52 #define G_TYPE_FLOAT                    G_TYPE_MAKE_FUNDAMENTAL (14)
  53 #define G_TYPE_DOUBLE                   G_TYPE_MAKE_FUNDAMENTAL (15)
  54 #define G_TYPE_STRING                   G_TYPE_MAKE_FUNDAMENTAL (16)
  55 #define G_TYPE_POINTER                  G_TYPE_MAKE_FUNDAMENTAL (17)
  56 #define G_TYPE_BOXED                    G_TYPE_MAKE_FUNDAMENTAL (18)
  57 #define G_TYPE_PARAM                    G_TYPE_MAKE_FUNDAMENTAL (19)
  58 #define G_TYPE_OBJECT                   G_TYPE_MAKE_FUNDAMENTAL (20)
  59
  60
  61 /* Reserved fundamental type numbers to create new fundamental
  62  * type IDs with G_TYPE_MAKE_FUNDAMENTAL().
  63  * Send email to gtk-devel-list@redhat.com for reservations.
  64  */
  65 #define G_TYPE_FUNDAMENTAL_SHIFT        (2)
  66 #define G_TYPE_MAKE_FUNDAMENTAL(x)      ((GType) ((x) << G_TYPE_FUNDAMENTAL_SHIFT))
  67 #define G_TYPE_RESERVED_GLIB_FIRST      (21)
  68 #define G_TYPE_RESERVED_GLIB_LAST       (31)
  69 #define G_TYPE_RESERVED_BSE_FIRST       (32)
  70 #define G_TYPE_RESERVED_BSE_LAST        (48)
  71 #define G_TYPE_RESERVED_USER_FIRST      (49)
  72
  73
  74 /* Type Checking Macros
  75  */
  76 #define G_TYPE_IS_FUNDAMENTAL(type)             ((type) <= G_TYPE_FUNDAMENTAL_MAX)
  77 #define G_TYPE_IS_DERIVED(type)                 ((type) > G_TYPE_FUNDAMENTAL_MAX)
  78 #define G_TYPE_IS_INTERFACE(type)               (G_TYPE_FUNDAMENTAL (type) == G_TYPE_INTERFACE)
  79 #define G_TYPE_IS_CLASSED(type)                 (g_type_test_flags ((type), G_TYPE_FLAG_CLASSED))
  80 #define G_TYPE_IS_INSTANTIATABLE(type)          (g_type_test_flags ((type), G_TYPE_FLAG_INSTANTIATABLE))
  81 #define G_TYPE_IS_DERIVABLE(type)               (g_type_test_flags ((type), G_TYPE_FLAG_DERIVABLE))
  82 #define G_TYPE_IS_DEEP_DERIVABLE(type)          (g_type_test_flags ((type), G_TYPE_FLAG_DEEP_DERIVABLE))
  83 #define G_TYPE_IS_ABSTRACT(type)                (g_type_test_flags ((type), G_TYPE_FLAG_ABSTRACT))
  84 #define G_TYPE_IS_VALUE_ABSTRACT(type)          (g_type_test_flags ((type), G_TYPE_FLAG_VALUE_ABSTRACT))
  85 #define G_TYPE_IS_VALUE_TYPE(type)              (g_type_check_is_value_type (type))
  86 #define G_TYPE_HAS_VALUE_TABLE(type)            (g_type_value_table_peek (type) != NULL)
  87
  88
  89 /* Typedefs
  90  */
  91 #if     GLIB_SIZEOF_LONG == GLIB_SIZEOF_SIZE_T
  92 typedef gulong                          GType;
  93 #else   /* hm, shouldn't happen? */
  94 typedef gsize                           GType;
  95 #endif
  96 typedef struct _GValue                  GValue;
  97 typedef union  _GTypeCValue             GTypeCValue;
  98 typedef struct _GTypePlugin             GTypePlugin;
  99 typedef struct _GTypeClass              GTypeClass;
 100 typedef struct _GTypeInterface          GTypeInterface;
 101 typedef struct _GTypeInstance           GTypeInstance;
 102 typedef struct _GTypeInfo               GTypeInfo;
 103 typedef struct _GTypeFundamentalInfo    GTypeFundamentalInfo;
 104 typedef struct _GInterfaceInfo          GInterfaceInfo;
 105 typedef struct _GTypeValueTable         GTypeValueTable;
 106 typedef struct _GTypeQuery              GTypeQuery;
 107
 108
 109 /* Basic Type Structures
 110  */
 111 struct _GTypeClass
 112 {
 113   /*< private >*/
 114   GType g_type;
 115 };
 116 struct _GTypeInstance
 117 {
 118   /*< private >*/
 119   GTypeClass *g_class;
 120 };
 121 struct _GTypeInterface
 122 {
 123   /*< private >*/
 124   GType g_type;         /* iface type */
 125   GType g_instance_type;
 126 };
 127 struct _GTypeQuery
 128 {
 129   GType         type;
 130   const gchar  *type_name;
 131   guint         class_size;
 132   guint         instance_size;
 133 };
 134
 135
 136 /* Casts, checks and accessors for structured types
 137  * usage of these macros is reserved to type implementations only
 138  */
 139 /*< protected >*/
 140 #define G_TYPE_CHECK_INSTANCE(instance)                         (_G_TYPE_CHI ((GTypeInstance*) (instance)))
 141 #define G_TYPE_CHECK_INSTANCE_CAST(instance, g_type, c_type)    (_G_TYPE_CIC ((instance), (g_type), c_type))
 142 #define G_TYPE_CHECK_INSTANCE_TYPE(instance, g_type)            (_G_TYPE_CIT ((instance), (g_type)))
 143 #define G_TYPE_INSTANCE_GET_CLASS(instance, g_type, c_type)     (_G_TYPE_IGC ((instance), (g_type), c_type))
 144 #define G_TYPE_INSTANCE_GET_INTERFACE(instance, g_type, c_type) (_G_TYPE_IGI ((instance), (g_type), c_type))
 145 #define G_TYPE_CHECK_CLASS_CAST(g_class, g_type, c_type)        (_G_TYPE_CCC ((g_class), (g_type), c_type))
 146 #define G_TYPE_CHECK_CLASS_TYPE(g_class, g_type)                (_G_TYPE_CCT ((g_class), (g_type)))
 147 #define G_TYPE_CHECK_VALUE(value)                               (_G_TYPE_CHV ((value)))
 148 #define G_TYPE_CHECK_VALUE_TYPE(value, g_type)                  (_G_TYPE_CVH ((value), (g_type)))
 149 #define G_TYPE_FROM_INSTANCE(instance)                          (G_TYPE_FROM_CLASS (((GTypeInstance*) (instance))->g_class))
 150 #define G_TYPE_FROM_CLASS(g_class)                              (((GTypeClass*) (g_class))->g_type)
 151 #define G_TYPE_FROM_INTERFACE(g_iface)                          (((GTypeInterface*) (g_iface))->g_type)
 152
 153 #define G_TYPE_INSTANCE_GET_PRIVATE(instance, g_type, c_type)   ((c_type*) g_type_instance_get_private ((GTypeInstance*) (instance), (g_type)))
 154
 155
 156 /* debug flags for g_type_init_with_debug_flags() */
 157 typedef enum    /*< skip >*/
 158 {
 159   G_TYPE_DEBUG_NONE     = 0,
 160   G_TYPE_DEBUG_OBJECTS  = 1 << 0,
 161   G_TYPE_DEBUG_SIGNALS  = 1 << 1,
 162   G_TYPE_DEBUG_MASK     = 0x03
 163 } GTypeDebugFlags;
 164
 165
 166 /* --- prototypes --- */
 167 void                  g_type_init                    (void);
 168 void                  g_type_init_with_debug_flags   (GTypeDebugFlags  debug_flags);
 169 G_CONST_RETURN gchar* g_type_name                    (GType            type);
 170 GQuark                g_type_qname                   (GType            type);
 171 GType                 g_type_from_name               (const gchar     *name);
 172 GType                 g_type_parent                  (GType            type);
 173 guint                 g_type_depth                   (GType            type);
 174 GType                 g_type_next_base               (GType            leaf_type,
 175                                                       GType            root_type);
 176 gboolean              g_type_is_a                    (GType            type,
 177                                                       GType            is_a_type);
 178 gpointer              g_type_class_ref               (GType            type);
 179 gpointer              g_type_class_peek              (GType            type);
 180 void                  g_type_class_unref             (gpointer         g_class);
 181 gpointer              g_type_class_peek_parent       (gpointer         g_class);
 182 gpointer              g_type_interface_peek          (gpointer         instance_class,
 183                                                       GType            iface_type);
 184 gpointer              g_type_interface_peek_parent   (gpointer         g_iface);
 185
 186 /* g_free() the returned arrays */
 187 GType*                g_type_children                (GType            type,
 188                                                       guint           *n_children);
 189 GType*                g_type_interfaces              (GType            type,
 190                                                       guint           *n_interfaces);
 191
 192 /* per-type _static_ data */
 193 void                  g_type_set_qdata               (GType            type,
 194                                                       GQuark           quark,
 195                                                       gpointer         data);
 196 gpointer              g_type_get_qdata               (GType            type,
 197                                                       GQuark           quark);
 198 void                  g_type_query                   (GType            type,
 199                                                       GTypeQuery      *query);
 200
 201
 202 /* --- type registration --- */
 203 typedef void   (*GBaseInitFunc)              (gpointer         g_class);
 204 typedef void   (*GBaseFinalizeFunc)          (gpointer         g_class);
 205 typedef void   (*GClassInitFunc)             (gpointer         g_class,
 206                                               gpointer         class_data);
 207 typedef void   (*GClassFinalizeFunc)         (gpointer         g_class,
 208                                               gpointer         class_data);
 209 typedef void   (*GInstanceInitFunc)          (GTypeInstance   *instance,
 210                                               gpointer         g_class);
 211 typedef void   (*GInterfaceInitFunc)         (gpointer         g_iface,
 212                                               gpointer         iface_data);
 213 typedef void   (*GInterfaceFinalizeFunc)     (gpointer         g_iface,
 214                                               gpointer         iface_data);
 215 typedef gboolean (*GTypeClassCacheFunc)      (gpointer         cache_data,
 216                                               GTypeClass      *g_class);
 217 typedef enum    /*< skip >*/
 218 {
 219   G_TYPE_FLAG_CLASSED           = (1 << 0),
 220   G_TYPE_FLAG_INSTANTIATABLE    = (1 << 1),
 221   G_TYPE_FLAG_DERIVABLE         = (1 << 2),
 222   G_TYPE_FLAG_DEEP_DERIVABLE    = (1 << 3)
 223 } GTypeFundamentalFlags;
 224 typedef enum    /*< skip >*/
 225 {
 226   G_TYPE_FLAG_ABSTRACT          = (1 << 4),
 227   G_TYPE_FLAG_VALUE_ABSTRACT    = (1 << 5)
 228 } GTypeFlags;
 229 struct _GTypeInfo
 230 {
 231   /* interface types, classed types, instantiated types */
 232   guint16                class_size;
 233
 234   GBaseInitFunc          base_init;
 235   GBaseFinalizeFunc      base_finalize;
 236
 237   /* classed types, instantiated types */
 238   GClassInitFunc         class_init;
 239   GClassFinalizeFunc     class_finalize;
 240   gconstpointer          class_data;
 241
 242   /* instantiated types */
 243   guint16                instance_size;
 244   guint16                n_preallocs;
 245   GInstanceInitFunc      instance_init;
 246
 247   /* value handling */
 248   const GTypeValueTable *value_table;
 249 };
 250 struct _GTypeFundamentalInfo
 251 {
 252   GTypeFundamentalFlags  type_flags;
 253 };
 254 struct _GInterfaceInfo
 255 {
 256   GInterfaceInitFunc     interface_init;
 257   GInterfaceFinalizeFunc interface_finalize;
 258   gpointer               interface_data;
 259 };
 260 struct _GTypeValueTable
 261 {
 262   void     (*value_init)         (GValue       *value);
 263   void     (*value_free)         (GValue       *value);
 264   void     (*value_copy)         (const GValue *src_value,
 265                                   GValue       *dest_value);
 266   /* varargs functionality (optional) */
 267   gpointer (*value_peek_pointer) (const GValue *value);
 268   gchar     *collect_format;
 269   gchar*   (*collect_value)      (GValue       *value,
 270                                   guint         n_collect_values,
 271                                   GTypeCValue  *collect_values,
 272                                   guint         collect_flags);
 273   gchar     *lcopy_format;
 274   gchar*   (*lcopy_value)        (const GValue *value,
 275                                   guint         n_collect_values,
 276                                   GTypeCValue  *collect_values,
 277                                   guint         collect_flags);
 278 };
 279 GType g_type_register_static            (GType                       parent_type,
 280                                          const gchar                *type_name,
 281                                          const GTypeInfo            *info,
 282                                          GTypeFlags                  flags);
 283 GType g_type_register_dynamic           (GType                       parent_type,
 284                                          const gchar                *type_name,
 285                                          GTypePlugin                *plugin,
 286                                          GTypeFlags                  flags);
 287 GType g_type_register_fundamental       (GType                       type_id,
 288                                          const gchar                *type_name,
 289                                          const GTypeInfo            *info,
 290                                          const GTypeFundamentalInfo *finfo,
 291                                          GTypeFlags                  flags);
 292 void  g_type_add_interface_static       (GType                       instance_type,
 293                                          GType                       interface_type,
 294                                          const GInterfaceInfo       *info);
 295 void  g_type_add_interface_dynamic      (GType                       instance_type,
 296                                          GType                       interface_type,
 297                                          GTypePlugin                *plugin);
 298 void  g_type_interface_add_prerequisite (GType                       interface_type,
 299                                          GType                       prerequisite_type);
 300 GType *g_type_interface_prerequisites   (GType                       interface_type,
 301                                          guint                       *n_prerequisites);
 302
 303 void     g_type_class_add_private    (gpointer       g_class,
 304                                       gsize          private_size);
 305 gpointer g_type_instance_get_private (GTypeInstance *instance,
 306                                       GType          private_type);
 307
 308 /* --- protected (for fundamental type implementations) --- */
 309 GTypePlugin*     g_type_get_plugin              (GType               type);
 310 GTypePlugin*     g_type_interface_get_plugin    (GType               instance_type,
 311                                                  GType               interface_type);
 312 GType            g_type_fundamental_next        (void);
 313 GType            g_type_fundamental             (GType               type_id);
 314 GTypeInstance*   g_type_create_instance         (GType               type);
 315 void             g_type_free_instance           (GTypeInstance      *instance);
 316 void             g_type_add_class_cache_func    (gpointer            cache_data,
 317                                                  GTypeClassCacheFunc cache_func);
 318 void             g_type_remove_class_cache_func (gpointer            cache_data,
 319                                                  GTypeClassCacheFunc cache_func);
 320 void             g_type_class_unref_uncached    (gpointer            g_class);
 321 GTypeValueTable* g_type_value_table_peek        (GType               type);
 322
 323
 324 /*< private >*/
 325 gboolean         g_type_check_instance          (GTypeInstance      *instance);
 326 GTypeInstance*   g_type_check_instance_cast     (GTypeInstance      *instance,
 327                                                  GType               iface_type);
 328 gboolean         g_type_check_instance_is_a     (GTypeInstance      *instance,
 329                                                  GType               iface_type);
 330 GTypeClass*      g_type_check_class_cast        (GTypeClass         *g_class,
 331                                                  GType               is_a_type);
 332 gboolean         g_type_check_class_is_a        (GTypeClass         *g_class,
 333                                                  GType               is_a_type);
 334 gboolean         g_type_check_is_value_type     (GType               type);
 335 gboolean         g_type_check_value             (GValue             *value);
 336 gboolean         g_type_check_value_holds       (GValue             *value,
 337                                                  GType               type);
 338 gboolean         g_type_test_flags              (GType               type,
 339                                                  guint               flags);
 340
 341
 342 /* --- debugging functions --- */
 343 G_CONST_RETURN gchar* g_type_name_from_instance (GTypeInstance  *instance);
 344 G_CONST_RETURN gchar* g_type_name_from_class    (GTypeClass     *g_class);
 345
 346
 347 /* --- implementation bits --- */
 348 #ifndef G_DISABLE_CAST_CHECKS
 349 #  define _G_TYPE_CIC(ip, gt, ct) \
 350     ((ct*) g_type_check_instance_cast ((GTypeInstance*) ip, gt))
 351 #  define _G_TYPE_CCC(cp, gt, ct) \
 352     ((ct*) g_type_check_class_cast ((GTypeClass*) cp, gt))
 353 #else /* G_DISABLE_CAST_CHECKS */
 354 #  define _G_TYPE_CIC(ip, gt, ct)       ((ct*) ip)
 355 #  define _G_TYPE_CCC(cp, gt, ct)       ((ct*) cp)
 356 #endif /* G_DISABLE_CAST_CHECKS */
 357 #define _G_TYPE_CHI(ip)                 (g_type_check_instance ((GTypeInstance*) ip))
 358 #define _G_TYPE_CVH(vl, gt)             (g_type_check_value_holds ((GValue*) vl, gt))
 359 #define _G_TYPE_CHV(vl)                 (g_type_check_value ((GValue*) vl))
 360 #define _G_TYPE_IGC(ip, gt, ct)         ((ct*) (((GTypeInstance*) ip)->g_class))
 361 #define _G_TYPE_IGI(ip, gt, ct)         ((ct*) g_type_interface_peek (((GTypeInstance*) ip)->g_class, gt))
 362 #ifdef  __GNUC__
 363 #  define _G_TYPE_CIT(ip, gt)             (G_GNUC_EXTENSION ({ \
 364   GTypeInstance *__inst = (GTypeInstance*) ip; GType __t = gt; gboolean __r; \
 365   if (__inst && __inst->g_class && __inst->g_class->g_type == __t) \
 366     __r = TRUE; \
 367   else \
 368     __r = g_type_check_instance_is_a (__inst, __t); \
 369   __r; \
 370 }))
 371 #  define _G_TYPE_CCT(cp, gt)             (G_GNUC_EXTENSION ({ \
 372   GTypeClass *__class = (GTypeClass*) cp; GType __t = gt; gboolean __r; \
 373   if (__class && __class->g_type == __t) \
 374     __r = TRUE; \
 375   else \
 376     __r = g_type_check_class_is_a (__class, __t); \
 377   __r; \
 378 }))
 379 #else  /* !__GNUC__ */
 380 #  define _G_TYPE_CIT(ip, gt)             (g_type_check_instance_is_a ((GTypeInstance*) ip, gt))
 381 #  define _G_TYPE_CCT(cp, gt)             (g_type_check_class_is_a ((GTypeClass*) cp, gt))
 382 #endif /* !__GNUC__ */
 383 #define G_TYPE_FLAG_RESERVED_ID_BIT     ((GType) (1 << 0))
 384 extern GTypeDebugFlags                  _g_type_debug_flags;
 385
 386 G_END_DECLS
 387
 388 #endif /* __G_TYPE_H__ */