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