gobject/genums.h

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 1998, 1999, 2000 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 #ifndef __G_ENUMS_H__
  20 #define __G_ENUMS_H__
  21
  22 #include        <gobject/gtype.h>
  23
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29
  30 /* --- type macros --- */
  31 #define G_TYPE_IS_ENUM(type)    (G_TYPE_FUNDAMENTAL (type) == G_TYPE_ENUM)
  32 #define G_ENUM_TYPE(class)      (G_TYPE_FROM_CLASS (class))
  33 #define G_ENUM_NAME(class)      (g_type_name (G_ENUM_TYPE (class)))
  34 #define G_ENUM_CLASS(class)     (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_ENUM, GEnumClass))
  35 #define G_IS_ENUM_CLASS(class)  (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_ENUM))
  36 #define G_TYPE_IS_FLAGS(type)   (G_TYPE_FUNDAMENTAL (type) == G_TYPE_FLAGS)
  37 #define G_FLAGS_TYPE(class)     (G_TYPE_FROM_CLASS (class))
  38 #define G_FLAGS_NAME(class)     (g_type_name (G_FLAGS_TYPE (class)))
  39 #define G_FLAGS_CLASS(class)    (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_FLAGS, GFlagsClass))
  40 #define G_IS_FLAGS_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_FLAGS))
  41
  42
  43 /* --- enum/flag values & classes --- */
  44 typedef struct _GEnumClass  GEnumClass;
  45 typedef struct _GFlagsClass GFlagsClass;
  46 typedef struct _GEnumValue  GEnumValue;
  47 typedef struct _GFlagsValue GFlagsValue;
  48 struct  _GEnumClass
  49 {
  50   GTypeClass  g_type_class;
  51
  52   gint        minimum;
  53   gint        maximum;
  54   guint       n_values;
  55   GEnumValue *values;
  56 };
  57 struct  _GFlagsClass
  58 {
  59   GTypeClass   g_type_class;
  60
  61   guint        mask;
  62   guint        n_values;
  63   GFlagsValue *values;
  64 };
  65 struct _GEnumValue
  66 {
  67   gint   value;
  68   gchar *value_name;
  69   gchar *value_nick;
  70 };
  71 struct _GFlagsValue
  72 {
  73   guint  value;
  74   gchar *value_name;
  75   gchar *value_nick;
  76 };
  77
  78
  79 /* --- prototypes --- */
  80 GEnumValue*     g_enum_get_value                (GEnumClass     *enum_class,
  81                                                  gint            value);
  82 GEnumValue*     g_enum_get_value_by_name        (GEnumClass     *enum_class,
  83                                                  const gchar    *name);
  84 GEnumValue*     g_enum_get_value_by_nick        (GEnumClass     *enum_class,
  85                                                  const gchar    *nick);
  86 GFlagsValue*    g_flags_get_first_value         (GFlagsClass    *flags_class,
  87                                                  guint           value);
  88 GFlagsValue*    g_flags_get_value_by_name       (GFlagsClass    *flags_class,
  89                                                  const gchar    *name);
  90 GFlagsValue*    g_flags_get_value_by_nick       (GFlagsClass    *flags_class,
  91                                                  const gchar    *nick);
  92
  93
  94 /* --- registration functions --- */
  95 /* const_static_values is a NULL terminated array of enum/flags
  96  * values that is taken over!
  97  */
  98 GType   g_enum_register_static     (const gchar       *name,
  99                                     const GEnumValue  *const_static_values);
 100 GType   g_flags_register_static    (const gchar       *name,
 101                                     const GFlagsValue *const_static_values);
 102 /* functions to complete the type information
 103  * for enums/flags implemented by plugins
 104  */
 105 void    g_enum_complete_type_info  (GType              g_enum_type,
 106                                     GTypeInfo         *info,
 107                                     const GEnumValue  *const_values);
 108 void    g_flags_complete_type_info (GType              g_flags_type,
 109                                     GTypeInfo         *info,
 110                                     const GFlagsValue *const_values);
 111
 112
 113
 114 #ifdef __cplusplus
 115 }
 116 #endif /* __cplusplus */
 117
 118 #endif /* __G_ENUMS_H__ */