Pileus Git - ~andy/gtk/blob - gtk/gtktypeutils.h

   1 /* GTK - The GIMP Toolkit
   2  * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
   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 Public
  15  * 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
  20 /*
  21  * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GTK+ Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __GTK_TYPE_UTILS_H__
  28 #define __GTK_TYPE_UTILS_H__
  29
  30
  31 #include <glib-object.h>
  32
  33
  34 G_BEGIN_DECLS
  35
  36 #ifndef GTK_DISABLE_DEPRECATED
  37
  38 /* Fundamental Types
  39  * many of these are just aliases for GLib types to maintain
  40  * compatibility
  41  */
  42 typedef enum    /*< skip >*/
  43 {
  44   GTK_TYPE_INVALID      = G_TYPE_INVALID,
  45   GTK_TYPE_NONE         = G_TYPE_NONE,
  46   GTK_TYPE_ENUM         = G_TYPE_ENUM,
  47   GTK_TYPE_FLAGS        = G_TYPE_FLAGS,
  48
  49   /* GtkArg types */
  50   GTK_TYPE_CHAR         = G_TYPE_CHAR,
  51   GTK_TYPE_UCHAR        = G_TYPE_UCHAR,
  52   GTK_TYPE_BOOL         = G_TYPE_BOOLEAN,
  53   GTK_TYPE_INT          = G_TYPE_INT,
  54   GTK_TYPE_UINT         = G_TYPE_UINT,
  55   GTK_TYPE_LONG         = G_TYPE_LONG,
  56   GTK_TYPE_ULONG        = G_TYPE_ULONG,
  57   GTK_TYPE_FLOAT        = G_TYPE_FLOAT,
  58   GTK_TYPE_DOUBLE       = G_TYPE_DOUBLE,
  59   GTK_TYPE_STRING       = G_TYPE_STRING,
  60   GTK_TYPE_BOXED        = G_TYPE_BOXED,
  61   GTK_TYPE_POINTER      = G_TYPE_POINTER
  62 } GtkFundamentalType;
  63
  64 /* --- type macros --- */
  65 #define GTK_CLASS_NAME(class)           (g_type_name (G_TYPE_FROM_CLASS (class)))
  66 #define GTK_CLASS_TYPE(class)           (G_TYPE_FROM_CLASS (class))
  67 #define GTK_TYPE_IS_OBJECT(type)        (g_type_is_a ((type), GTK_TYPE_OBJECT))
  68
  69 /* outdated macros that really shouldn't e used anymore,
  70  * use the GLib type system instead
  71  */
  72 #define GTK_TYPE_FUNDAMENTAL_LAST        (G_TYPE_LAST_RESERVED_FUNDAMENTAL - 1)
  73 #define GTK_TYPE_FUNDAMENTAL_MAX         (G_TYPE_FUNDAMENTAL_MAX)
  74
  75 #define GTK_FUNDAMENTAL_TYPE    G_TYPE_FUNDAMENTAL
  76 #define GTK_STRUCT_OFFSET       G_STRUCT_OFFSET
  77
  78 #endif /* GTK_DISABLE_DEPRECATED */
  79
  80 /* glib macro wrappers (compatibility) */
  81 #define GTK_CHECK_CAST          G_TYPE_CHECK_INSTANCE_CAST
  82 #define GTK_CHECK_CLASS_CAST    G_TYPE_CHECK_CLASS_CAST
  83 #define GTK_CHECK_GET_CLASS     G_TYPE_INSTANCE_GET_CLASS
  84 #define GTK_CHECK_TYPE          G_TYPE_CHECK_INSTANCE_TYPE
  85 #define GTK_CHECK_CLASS_TYPE    G_TYPE_CHECK_CLASS_TYPE
  86
  87 /* glib type wrappers (compatibility) */
  88
  89 typedef GType                   GtkType;
  90
  91 #ifndef GTK_DISABLE_DEPRECATED
  92
  93 typedef GTypeInstance           GtkTypeObject;
  94 typedef GTypeClass              GtkTypeClass;
  95 typedef GBaseInitFunc           GtkClassInitFunc;
  96 typedef GInstanceInitFunc       GtkObjectInitFunc;
  97
  98 #endif /* GTK_DISABLE_DEPRECATED */
  99
 100 G_END_DECLS
 101
 102 /* Builtin Types
 103  */
 104 #include <gtk/gtktypebuiltins.h>
 105
 106 G_BEGIN_DECLS
 107
 108 /* urg */
 109 #define GTK_TYPE_IDENTIFIER (gtk_identifier_get_type ())
 110 GType gtk_identifier_get_type (void);
 111
 112 /* --- typedefs --- */
 113 /* here we come with some necessary forward declarations for structures and
 114  * provide some fundamental function signatures
 115  */
 116 typedef struct _GtkArg               GtkArg;
 117 typedef struct _GtkObject            GtkObject; /* object forward declaration */
 118 typedef gboolean (*GtkFunction)     (gpointer      data);
 119 typedef void (*GtkDestroyNotify)    (gpointer      data);
 120 typedef void (*GtkCallbackMarshal)  (GtkObject    *object,
 121                                      gpointer      data,
 122                                      guint         n_args,
 123                                      GtkArg       *args);
 124 typedef void (*GtkSignalFunc)       (void);
 125 #define GTK_SIGNAL_FUNC(f)          ((GtkSignalFunc) (f))
 126
 127 #ifndef GTK_DISABLE_DEPRECATED
 128 typedef struct _GtkTypeInfo          GtkTypeInfo;
 129 typedef GSignalCMarshaller          GtkSignalMarshaller;
 130
 131 /* GtkArg, used to hold differently typed values */
 132 struct _GtkArg
 133 {
 134   GtkType type;
 135   gchar *name;
 136
 137   /* this union only defines the required storage types for
 138    * the possibile values, thus there is no gint enum_data field,
 139    * because that would just be a mere alias for gint int_data.
 140    * use the GTK_VALUE_*() and GTK_RETLOC_*() macros to access
 141    * the discrete memebers.
 142    */
 143   union {
 144     /* flat values */
 145     gchar char_data;
 146     guchar uchar_data;
 147     gboolean bool_data;
 148     gint int_data;
 149     guint uint_data;
 150     glong long_data;
 151     gulong ulong_data;
 152     gfloat float_data;
 153     gdouble double_data;
 154     gchar *string_data;
 155     GtkObject *object_data;
 156     gpointer pointer_data;
 157
 158     /* structured values */
 159     struct {
 160       GtkSignalFunc f;
 161       gpointer d;
 162     } signal_data;
 163   } d;
 164 };
 165
 166 /* argument value access macros, these must not contain casts,
 167  * to allow the usage of these macros in combination with the
 168  * adress operator, e.g. &GTK_VALUE_CHAR (*arg)
 169  */
 170 #define GTK_VALUE_CHAR(a)       ((a).d.char_data)
 171 #define GTK_VALUE_UCHAR(a)      ((a).d.uchar_data)
 172 #define GTK_VALUE_BOOL(a)       ((a).d.bool_data)
 173 #define GTK_VALUE_INT(a)        ((a).d.int_data)
 174 #define GTK_VALUE_UINT(a)       ((a).d.uint_data)
 175 #define GTK_VALUE_LONG(a)       ((a).d.long_data)
 176 #define GTK_VALUE_ULONG(a)      ((a).d.ulong_data)
 177 #define GTK_VALUE_FLOAT(a)      ((a).d.float_data)
 178 #define GTK_VALUE_DOUBLE(a)     ((a).d.double_data)
 179 #define GTK_VALUE_STRING(a)     ((a).d.string_data)
 180 #define GTK_VALUE_ENUM(a)       ((a).d.int_data)
 181 #define GTK_VALUE_FLAGS(a)      ((a).d.uint_data)
 182 #define GTK_VALUE_BOXED(a)      ((a).d.pointer_data)
 183 #define GTK_VALUE_OBJECT(a)     ((a).d.object_data)
 184 #define GTK_VALUE_POINTER(a)    ((a).d.pointer_data)
 185 #define GTK_VALUE_SIGNAL(a)     ((a).d.signal_data)
 186
 187 /* return location macros, these all narrow down to
 188  * pointer types, because return values need to be
 189  * passed by reference
 190  */
 191 #define GTK_RETLOC_CHAR(a)      ((gchar*)       (a).d.pointer_data)
 192 #define GTK_RETLOC_UCHAR(a)     ((guchar*)      (a).d.pointer_data)
 193 #define GTK_RETLOC_BOOL(a)      ((gboolean*)    (a).d.pointer_data)
 194 #define GTK_RETLOC_INT(a)       ((gint*)        (a).d.pointer_data)
 195 #define GTK_RETLOC_UINT(a)      ((guint*)       (a).d.pointer_data)
 196 #define GTK_RETLOC_LONG(a)      ((glong*)       (a).d.pointer_data)
 197 #define GTK_RETLOC_ULONG(a)     ((gulong*)      (a).d.pointer_data)
 198 #define GTK_RETLOC_FLOAT(a)     ((gfloat*)      (a).d.pointer_data)
 199 #define GTK_RETLOC_DOUBLE(a)    ((gdouble*)     (a).d.pointer_data)
 200 #define GTK_RETLOC_STRING(a)    ((gchar**)      (a).d.pointer_data)
 201 #define GTK_RETLOC_ENUM(a)      ((gint*)        (a).d.pointer_data)
 202 #define GTK_RETLOC_FLAGS(a)     ((guint*)       (a).d.pointer_data)
 203 #define GTK_RETLOC_BOXED(a)     ((gpointer*)    (a).d.pointer_data)
 204 #define GTK_RETLOC_OBJECT(a)    ((GtkObject**)  (a).d.pointer_data)
 205 #define GTK_RETLOC_POINTER(a)   ((gpointer*)    (a).d.pointer_data)
 206 /* GTK_RETLOC_SIGNAL() - no such thing */
 207
 208 /* type registration, it is recommended to use
 209  * g_type_register_static() or
 210  * g_type_register_dynamic() instead
 211  */
 212 struct _GtkTypeInfo
 213 {
 214   gchar                 *type_name;
 215   guint                  object_size;
 216   guint                  class_size;
 217   GtkClassInitFunc       class_init_func;
 218   GtkObjectInitFunc      object_init_func;
 219   gpointer               reserved_1;
 220   gpointer               reserved_2;
 221   GtkClassInitFunc       base_class_init_func;
 222 };
 223
 224 #endif /* GTK_DISABLE_DEPRECATED */
 225
 226 gpointer        gtk_type_class  (GtkType         type);
 227
 228 #ifndef GTK_DISABLE_DEPRECATED
 229
 230 GtkType         gtk_type_unique (GtkType           parent_type,
 231                                  const GtkTypeInfo *gtkinfo);
 232 gpointer        gtk_type_new    (GtkType         type);
 233
 234 /* --- compatibility defines --- */
 235 #define gtk_type_name(type)              g_type_name (type)
 236 #define gtk_type_from_name(name)         g_type_from_name (name)
 237 #define gtk_type_parent(type)            g_type_parent (type)
 238 #define gtk_type_is_a(type, is_a_type)   g_type_is_a ((type), (is_a_type))
 239
 240 /* deprecated, use g_type_init() instead */
 241 void            gtk_type_init   (GTypeDebugFlags debug_flags);
 242
 243 /* enum/flags compatibility functions, we strongly
 244  * recommend to use the glib enum/flags classes directly
 245  */
 246 typedef GEnumValue  GtkEnumValue;
 247 typedef GFlagsValue GtkFlagValue;
 248 GtkEnumValue*   gtk_type_enum_get_values        (GtkType         enum_type);
 249 GtkFlagValue*   gtk_type_flags_get_values       (GtkType         flags_type);
 250 GtkEnumValue*   gtk_type_enum_find_value        (GtkType         enum_type,
 251                                                  const gchar    *value_name);
 252 GtkFlagValue*   gtk_type_flags_find_value       (GtkType         flags_type,
 253                                                  const gchar    *value_name);
 254
 255 #endif /* GTK_DISABLE_DEPRECATED */
 256
 257 G_END_DECLS
 258
 259 #endif /* __GTK_TYPE_UTILS_H__ */