genums.h 7.28 KB
Newer Older
1
/* GObject - GLib Type, Object, Parameter and Signal Library
2
 * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
 *
 * 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.
 */
19 20 21 22
#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
#error "Only <glib-object.h> can be included directly."
#endif

23 24 25
#ifndef __G_ENUMS_H__
#define __G_ENUMS_H__

26
#include <gobject/gtype.h>
27

28
G_BEGIN_DECLS
29 30

/* --- type macros --- */
Stefan Kost's avatar
Stefan Kost committed
31 32 33 34
/**
 * G_TYPE_IS_ENUM:
 * @type: a #GType ID.
 * 
35 36 37
 * Checks whether @type "is a" %G_TYPE_ENUM.
 *
 * Returns: %TRUE if @type "is a" %G_TYPE_ENUM.
Stefan Kost's avatar
Stefan Kost committed
38
 */
39
#define G_TYPE_IS_ENUM(type)	       (G_TYPE_FUNDAMENTAL (type) == G_TYPE_ENUM)
Stefan Kost's avatar
Stefan Kost committed
40 41 42 43 44 45
/**
 * G_ENUM_CLASS:
 * @class: a valid #GEnumClass
 * 
 * Casts a derived #GEnumClass structure into a #GEnumClass structure.
 */
46
#define G_ENUM_CLASS(class)	       (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_ENUM, GEnumClass))
Stefan Kost's avatar
Stefan Kost committed
47 48 49 50 51 52 53
/**
 * G_IS_ENUM_CLASS:
 * @class: a #GEnumClass
 * 
 * Checks whether @class "is a" valid #GEnumClass structure of type %G_TYPE_ENUM
 * or derived.
 */
54
#define G_IS_ENUM_CLASS(class)	       (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_ENUM))
Stefan Kost's avatar
Stefan Kost committed
55 56 57 58
/**
 * G_ENUM_CLASS_TYPE:
 * @class: a #GEnumClass
 * 
59 60 61
 * Get the type identifier from a given #GEnumClass structure.
 *
 * Returns: the #GType
Stefan Kost's avatar
Stefan Kost committed
62
 */
63
#define G_ENUM_CLASS_TYPE(class)       (G_TYPE_FROM_CLASS (class))
Stefan Kost's avatar
Stefan Kost committed
64 65 66 67
/**
 * G_ENUM_CLASS_TYPE_NAME:
 * @class: a #GEnumClass
 * 
68 69 70
 * Get the static type name from a given #GEnumClass structure.
 *
 * Returns: the type name.
Stefan Kost's avatar
Stefan Kost committed
71
 */
72
#define G_ENUM_CLASS_TYPE_NAME(class)  (g_type_name (G_ENUM_CLASS_TYPE (class)))
Stefan Kost's avatar
Stefan Kost committed
73 74 75 76 77


/**
 * G_TYPE_IS_FLAGS:
 * @type: a #GType ID.
78 79 80 81
 *
 * Checks whether @type "is a" %G_TYPE_FLAGS. 
 *
 * Returns: %TRUE if @type "is a" %G_TYPE_FLAGS.
Stefan Kost's avatar
Stefan Kost committed
82
 */
83
#define G_TYPE_IS_FLAGS(type)	       (G_TYPE_FUNDAMENTAL (type) == G_TYPE_FLAGS)
Stefan Kost's avatar
Stefan Kost committed
84 85 86 87 88 89
/**
 * G_FLAGS_CLASS:
 * @class: a valid #GFlagsClass
 * 
 * Casts a derived #GFlagsClass structure into a #GFlagsClass structure.
 */
90
#define G_FLAGS_CLASS(class)	       (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_FLAGS, GFlagsClass))
Stefan Kost's avatar
Stefan Kost committed
91 92 93 94 95 96 97
/**
 * G_IS_FLAGS_CLASS:
 * @class: a #GFlagsClass
 * 
 * Checks whether @class "is a" valid #GFlagsClass structure of type %G_TYPE_FLAGS
 * or derived.
 */
98
#define G_IS_FLAGS_CLASS(class)        (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_FLAGS))
Stefan Kost's avatar
Stefan Kost committed
99 100 101 102
/**
 * G_FLAGS_CLASS_TYPE:
 * @class: a #GFlagsClass
 * 
103 104 105
 * Get the type identifier from a given #GFlagsClass structure.
 *
 * Returns: the #GType
Stefan Kost's avatar
Stefan Kost committed
106
 */
107
#define G_FLAGS_CLASS_TYPE(class)      (G_TYPE_FROM_CLASS (class))
Stefan Kost's avatar
Stefan Kost committed
108 109 110 111
/**
 * G_FLAGS_CLASS_TYPE_NAME:
 * @class: a #GFlagsClass
 * 
112 113 114
 * Get the static type name from a given #GFlagsClass structure.
 *
 * Returns: the type name.
Stefan Kost's avatar
Stefan Kost committed
115
 */
116
#define G_FLAGS_CLASS_TYPE_NAME(class) (g_type_name (G_FLAGS_CLASS_TYPE (class)))
Stefan Kost's avatar
Stefan Kost committed
117 118


Stefan Kost's avatar
Stefan Kost committed
119 120 121 122 123 124 125 126
/**
 * G_VALUE_HOLDS_ENUM:
 * @value: a valid #GValue structure
 * 
 * Checks whether the given #GValue can hold values derived from type %G_TYPE_ENUM.
 * 
 * Returns: %TRUE on success.
 */
127
#define G_VALUE_HOLDS_ENUM(value)      (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_ENUM))
Stefan Kost's avatar
Stefan Kost committed
128 129 130 131 132 133 134 135
/**
 * G_VALUE_HOLDS_FLAGS:
 * @value: a valid #GValue structure
 * 
 * Checks whether the given #GValue can hold values derived from type %G_TYPE_FLAGS.
 * 
 * Returns: %TRUE on success.
 */
136
#define G_VALUE_HOLDS_FLAGS(value)     (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_FLAGS))
137 138 139 140 141 142 143


/* --- enum/flag values & classes --- */
typedef struct _GEnumClass  GEnumClass;
typedef struct _GFlagsClass GFlagsClass;
typedef struct _GEnumValue  GEnumValue;
typedef struct _GFlagsValue GFlagsValue;
Stefan Kost's avatar
Stefan Kost committed
144 145 146 147 148 149 150 151 152 153 154 155 156

/**
 * GEnumClass:
 * @g_type_class: the parent class
 * @minimum: the smallest possible value.
 * @maximum: the largest possible value.
 * @n_values: the number of possible values.
 * @values: an array of #GEnumValue structs describing the 
 *  individual values.
 * 
 * The class of an enumeration type holds information about its 
 * possible values.
 */
157 158 159
struct	_GEnumClass
{
  GTypeClass  g_type_class;
160 161

  /*< public >*/  
162 163 164 165 166
  gint	      minimum;
  gint	      maximum;
  guint	      n_values;
  GEnumValue *values;
};
Stefan Kost's avatar
Stefan Kost committed
167 168 169 170 171 172 173 174 175 176 177
/**
 * GFlagsClass:
 * @g_type_class: the parent class
 * @mask: a mask covering all possible values.
 * @n_values: the number of possible values.
 * @values: an array of #GFlagsValue structs describing the 
 *  individual values.
 * 
 * The class of a flags type holds information about its 
 * possible values.
 */
178 179 180 181
struct	_GFlagsClass
{
  GTypeClass   g_type_class;
  
182
  /*< public >*/  
183 184 185 186
  guint	       mask;
  guint	       n_values;
  GFlagsValue *values;
};
Stefan Kost's avatar
Stefan Kost committed
187 188 189 190 191 192
/**
 * GEnumValue:
 * @value: the enum value
 * @value_name: the name of the value
 * @value_nick: the nickname of the value
 * 
193
 * A structure which contains a single enum value, its name, and its
Stefan Kost's avatar
Stefan Kost committed
194 195
 * nickname.
 */
196 197 198
struct _GEnumValue
{
  gint	 value;
199 200
  const gchar *value_name;
  const gchar *value_nick;
201
};
Stefan Kost's avatar
Stefan Kost committed
202 203 204 205 206 207
/**
 * GFlagsValue:
 * @value: the flags value
 * @value_name: the name of the value
 * @value_nick: the nickname of the value
 * 
208
 * A structure which contains a single flags value, its name, and its
Stefan Kost's avatar
Stefan Kost committed
209 210
 * nickname.
 */
211 212 213
struct _GFlagsValue
{
  guint	 value;
214 215
  const gchar *value_name;
  const gchar *value_nick;
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
};


/* --- prototypes --- */
GEnumValue*	g_enum_get_value		(GEnumClass	*enum_class,
						 gint		 value);
GEnumValue*	g_enum_get_value_by_name	(GEnumClass	*enum_class,
						 const gchar	*name);
GEnumValue*	g_enum_get_value_by_nick	(GEnumClass	*enum_class,
						 const gchar	*nick);
GFlagsValue*	g_flags_get_first_value		(GFlagsClass	*flags_class,
						 guint		 value);
GFlagsValue*	g_flags_get_value_by_name	(GFlagsClass	*flags_class,
						 const gchar	*name);
GFlagsValue*	g_flags_get_value_by_nick	(GFlagsClass	*flags_class,
						 const gchar	*nick);
232 233
void            g_value_set_enum        	(GValue         *value,
						 gint            v_enum);
234
gint            g_value_get_enum        	(const GValue   *value);
235 236
void            g_value_set_flags       	(GValue         *value,
						 guint           v_flags);
237
guint           g_value_get_flags       	(const GValue   *value);
238

239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258


/* --- registration functions --- */
/* const_static_values is a NULL terminated array of enum/flags
 * values that is taken over!
 */
GType	g_enum_register_static	   (const gchar	      *name,
				    const GEnumValue  *const_static_values);
GType	g_flags_register_static	   (const gchar	      *name,
				    const GFlagsValue *const_static_values);
/* functions to complete the type information
 * for enums/flags implemented by plugins
 */
void	g_enum_complete_type_info  (GType	       g_enum_type,
				    GTypeInfo	      *info,
				    const GEnumValue  *const_values);
void	g_flags_complete_type_info (GType	       g_flags_type,
				    GTypeInfo	      *info,
				    const GFlagsValue *const_values);

259
G_END_DECLS
260 261

#endif /* __G_ENUMS_H__ */