/* GObject - GLib Type, Object, Parameter and Signal Library
- * Copyright (C) 1998, 1999, 2000 Tim Janik and Red Hat, Inc.
+ * Copyright (C) 1998-1999, 2000-2001 Tim Janik and Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* Boston, MA 02111-1307, USA.
*/
-#include <string.h>
+/*
+ * MT safe
+ */
+
+#include "config.h"
+
+#include <string.h>
+
+#include "genums.h"
+#include "gtype-private.h"
+#include "gvalue.h"
+#include "gvaluecollector.h"
-#include "genums.h"
-#include "gvalue.h"
-#include "gvaluecollector.h"
+/**
+ * SECTION:enumerations_flags
+ * @short_description: Enumeration and flags types
+ * @title: Enumeration and Flag Types
+ * @see_also:#GParamSpecEnum, #GParamSpecFlags, g_param_spec_enum(),
+ * g_param_spec_flags()
+ *
+ * The GLib type system provides fundamental types for enumeration and
+ * flags types. (Flags types are like enumerations, but allow their
+ * values to be combined by bitwise or). A registered enumeration or
+ * flags type associates a name and a nickname with each allowed
+ * value, and the methods g_enum_get_value_by_name(),
+ * g_enum_get_value_by_nick(), g_flags_get_value_by_name() and
+ * g_flags_get_value_by_nick() can look up values by their name or
+ * nickname. When an enumeration or flags type is registered with the
+ * GLib type system, it can be used as value type for object
+ * properties, using g_param_spec_enum() or g_param_spec_flags().
+ *
+ * GObject ships with a utility called <link
+ * linkend="glib-mkenums">glib-mkenums</link> that can construct
+ * suitable type registration functions from C enumeration
+ * definitions.
+ */
/* --- prototypes --- */
gpointer class_data);
static void g_flags_class_init (GFlagsClass *class,
gpointer class_data);
-static void g_value_enum_init (GValue *value);
-static void g_value_enum_copy_value (const GValue *src_value,
+static void value_flags_enum_init (GValue *value);
+static void value_flags_enum_copy_value (const GValue *src_value,
GValue *dest_value);
-static gchar* g_value_enum_collect_value (GValue *value,
- guint nth_value,
- GType *collect_type,
- GTypeCValue *collect_value);
-static gchar* g_value_enum_lcopy_value (const GValue *value,
- guint nth_value,
- GType *collect_type,
- GTypeCValue *collect_value);
-
+static gchar* value_flags_enum_collect_value (GValue *value,
+ guint n_collect_values,
+ GTypeCValue *collect_values,
+ guint collect_flags);
+static gchar* value_flags_enum_lcopy_value (const GValue *value,
+ guint n_collect_values,
+ GTypeCValue *collect_values,
+ guint collect_flags);
/* --- functions --- */
void
-g_enum_types_init (void) /* sync with gtype.c */
+_g_enum_types_init (void)
{
static gboolean initialized = FALSE;
- static const GTypeFundamentalInfo finfo = {
- G_TYPE_FLAG_CLASSED | G_TYPE_FLAG_DERIVABLE,
+ static const GTypeValueTable flags_enum_value_table = {
+ value_flags_enum_init, /* value_init */
+ NULL, /* value_free */
+ value_flags_enum_copy_value, /* value_copy */
+ NULL, /* value_peek_pointer */
+ "i", /* collect_format */
+ value_flags_enum_collect_value, /* collect_value */
+ "p", /* lcopy_format */
+ value_flags_enum_lcopy_value, /* lcopy_value */
};
- static GTypeInfo info = {
- 0 /* class_size */,
- NULL /* base_init */,
- NULL /* base_finalize */,
- NULL /* class_init */,
- NULL /* class_finalize */,
- NULL /* class_data */,
+ GTypeInfo info = {
+ 0, /* class_size */
+ NULL, /* base_init */
+ NULL, /* base_destroy */
+ NULL, /* class_init */
+ NULL, /* class_destroy */
+ NULL, /* class_data */
+ 0, /* instance_size */
+ 0, /* n_preallocs */
+ NULL, /* instance_init */
+ &flags_enum_value_table, /* value_table */
};
- static const GTypeValueTable value_table = {
- g_value_enum_init, /* value_init */
- NULL, /* value_free */
- g_value_enum_copy_value, /* value_copy */
- G_VALUE_COLLECT_INT, /* collect_type */
- g_value_enum_collect_value, /* collect_value */
- G_VALUE_COLLECT_POINTER, /* lcopy_type */
- g_value_enum_lcopy_value, /* lcopy_value */
+ static const GTypeFundamentalInfo finfo = {
+ G_TYPE_FLAG_CLASSED | G_TYPE_FLAG_DERIVABLE,
};
GType type;
g_return_if_fail (initialized == FALSE);
initialized = TRUE;
-
- info.value_table = &value_table;
-
+
/* G_TYPE_ENUM
*/
info.class_size = sizeof (GEnumClass);
- type = g_type_register_fundamental (G_TYPE_ENUM, "GEnum", &info, &finfo);
+ type = g_type_register_fundamental (G_TYPE_ENUM, g_intern_static_string ("GEnum"), &info, &finfo,
+ G_TYPE_FLAG_ABSTRACT | G_TYPE_FLAG_VALUE_ABSTRACT);
g_assert (type == G_TYPE_ENUM);
/* G_TYPE_FLAGS
*/
info.class_size = sizeof (GFlagsClass);
- type = g_type_register_fundamental (G_TYPE_FLAGS, "GFlags", &info, &finfo);
+ type = g_type_register_fundamental (G_TYPE_FLAGS, g_intern_static_string ("GFlags"), &info, &finfo,
+ G_TYPE_FLAG_ABSTRACT | G_TYPE_FLAG_VALUE_ABSTRACT);
g_assert (type == G_TYPE_FLAGS);
}
+static void
+value_flags_enum_init (GValue *value)
+{
+ value->data[0].v_long = 0;
+}
+
+static void
+value_flags_enum_copy_value (const GValue *src_value,
+ GValue *dest_value)
+{
+ dest_value->data[0].v_long = src_value->data[0].v_long;
+}
+
+static gchar*
+value_flags_enum_collect_value (GValue *value,
+ guint n_collect_values,
+ GTypeCValue *collect_values,
+ guint collect_flags)
+{
+ value->data[0].v_long = collect_values[0].v_int;
+
+ return NULL;
+}
+
+static gchar*
+value_flags_enum_lcopy_value (const GValue *value,
+ guint n_collect_values,
+ GTypeCValue *collect_values,
+ guint collect_flags)
+{
+ gint *int_p = collect_values[0].v_pointer;
+
+ if (!int_p)
+ return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
+
+ *int_p = value->data[0].v_long;
+
+ return NULL;
+}
+
+/**
+ * g_enum_register_static:
+ * @name: A nul-terminated string used as the name of the new type.
+ * @const_static_values: An array of #GEnumValue structs for the possible
+ * enumeration values. The array is terminated by a struct with all
+ * members being 0. GObject keeps a reference to the data, so it cannot
+ * be stack-allocated.
+ *
+ * Registers a new static enumeration type with the name @name.
+ *
+ * It is normally more convenient to let <link
+ * linkend="glib-mkenums">glib-mkenums</link> generate a
+ * my_enum_get_type() function from a usual C enumeration definition
+ * than to write one yourself using g_enum_register_static().
+ *
+ * Returns: The new type identifier.
+ */
GType
g_enum_register_static (const gchar *name,
const GEnumValue *const_static_values)
{
GTypeInfo enum_type_info = {
- sizeof (GEnumClass),
- NULL /* base_init */,
- NULL /* base_finalize */,
+ sizeof (GEnumClass), /* class_size */
+ NULL, /* base_init */
+ NULL, /* base_finalize */
(GClassInitFunc) g_enum_class_init,
- NULL /* class_finalize */,
- NULL /* class_data */,
+ NULL, /* class_finalize */
+ NULL, /* class_data */
+ 0, /* instance_size */
+ 0, /* n_preallocs */
+ NULL, /* instance_init */
+ NULL, /* value_table */
};
GType type;
enum_type_info.class_data = const_static_values;
- type = g_type_register_static (G_TYPE_ENUM, name, &enum_type_info);
+ type = g_type_register_static (G_TYPE_ENUM, name, &enum_type_info, 0);
return type;
}
+/**
+ * g_flags_register_static:
+ * @name: A nul-terminated string used as the name of the new type.
+ * @const_static_values: An array of #GFlagsValue structs for the possible
+ * flags values. The array is terminated by a struct with all members being 0.
+ * GObject keeps a reference to the data, so it cannot be stack-allocated.
+ *
+ * Registers a new static flags type with the name @name.
+ *
+ * It is normally more convenient to let <link
+ * linkend="glib-mkenums">glib-mkenums</link> generate a
+ * my_flags_get_type() function from a usual C enumeration definition
+ * than to write one yourself using g_flags_register_static().
+ *
+ * Returns: The new type identifier.
+ */
GType
g_flags_register_static (const gchar *name,
const GFlagsValue *const_static_values)
{
GTypeInfo flags_type_info = {
- sizeof (GFlagsClass),
- NULL /* base_init */,
- NULL /* base_finalize */,
+ sizeof (GFlagsClass), /* class_size */
+ NULL, /* base_init */
+ NULL, /* base_finalize */
(GClassInitFunc) g_flags_class_init,
- NULL /* class_finalize */,
- NULL /* class_data */,
+ NULL, /* class_finalize */
+ NULL, /* class_data */
+ 0, /* instance_size */
+ 0, /* n_preallocs */
+ NULL, /* instance_init */
+ NULL, /* value_table */
};
GType type;
flags_type_info.class_data = const_static_values;
- type = g_type_register_static (G_TYPE_FLAGS, name, &flags_type_info);
+ type = g_type_register_static (G_TYPE_FLAGS, name, &flags_type_info, 0);
return type;
}
+/**
+ * g_enum_complete_type_info:
+ * @g_enum_type: the type identifier of the type being completed
+ * @info: the #GTypeInfo struct to be filled in
+ * @const_values: An array of #GEnumValue structs for the possible
+ * enumeration values. The array is terminated by a struct with all
+ * members being 0.
+ *
+ * This function is meant to be called from the <literal>complete_type_info</literal>
+ * function of a #GTypePlugin implementation, as in the following
+ * example:
+ *
+ * |[
+ * static void
+ * my_enum_complete_type_info (GTypePlugin *plugin,
+ * GType g_type,
+ * GTypeInfo *info,
+ * GTypeValueTable *value_table)
+ * {
+ * static const GEnumValue values[] = {
+ * { MY_ENUM_FOO, "MY_ENUM_FOO", "foo" },
+ * { MY_ENUM_BAR, "MY_ENUM_BAR", "bar" },
+ * { 0, NULL, NULL }
+ * };
+ *
+ * g_enum_complete_type_info (type, info, values);
+ * }
+ * ]|
+ */
void
g_enum_complete_type_info (GType g_enum_type,
GTypeInfo *info,
info->class_data = const_values;
}
+/**
+ * g_flags_complete_type_info:
+ * @g_flags_type: the type identifier of the type being completed
+ * @info: the #GTypeInfo struct to be filled in
+ * @const_values: An array of #GFlagsValue structs for the possible
+ * enumeration values. The array is terminated by a struct with all
+ * members being 0.
+ *
+ * This function is meant to be called from the complete_type_info()
+ * function of a #GTypePlugin implementation, see the example for
+ * g_enum_complete_type_info() above.
+ */
void
g_flags_complete_type_info (GType g_flags_type,
GTypeInfo *info,
}
}
+/**
+ * g_enum_get_value_by_name:
+ * @enum_class: a #GEnumClass
+ * @name: the name to look up
+ *
+ * Looks up a #GEnumValue by name.
+ *
+ * Returns: the #GEnumValue with name @name, or %NULL if the
+ * enumeration doesn't have a member with that name
+ */
GEnumValue*
g_enum_get_value_by_name (GEnumClass *enum_class,
const gchar *name)
return NULL;
}
+/**
+ * g_flags_get_value_by_name:
+ * @flags_class: a #GFlagsClass
+ * @name: the name to look up
+ *
+ * Looks up a #GFlagsValue by name.
+ *
+ * Returns: the #GFlagsValue with name @name, or %NULL if there is no
+ * flag with that name
+ */
GFlagsValue*
g_flags_get_value_by_name (GFlagsClass *flags_class,
const gchar *name)
return NULL;
}
+/**
+ * g_enum_get_value_by_nick:
+ * @enum_class: a #GEnumClass
+ * @nick: the nickname to look up
+ *
+ * Looks up a #GEnumValue by nickname.
+ *
+ * Returns: the #GEnumValue with nickname @nick, or %NULL if the
+ * enumeration doesn't have a member with that nickname
+ */
GEnumValue*
g_enum_get_value_by_nick (GEnumClass *enum_class,
const gchar *nick)
return NULL;
}
+/**
+ * g_flags_get_value_by_nick:
+ * @flags_class: a #GFlagsClass
+ * @nick: the nickname to look up
+ *
+ * Looks up a #GFlagsValue by nickname.
+ *
+ * Returns: the #GFlagsValue with nickname @nick, or %NULL if there is
+ * no flag with that nickname
+ */
GFlagsValue*
g_flags_get_value_by_nick (GFlagsClass *flags_class,
const gchar *nick)
return NULL;
}
+/**
+ * g_enum_get_value:
+ * @enum_class: a #GEnumClass
+ * @value: the value to look up
+ *
+ * Returns the #GEnumValue for a value.
+ *
+ * Returns: the #GEnumValue for @value, or %NULL if @value is not a
+ * member of the enumeration
+ */
GEnumValue*
g_enum_get_value (GEnumClass *enum_class,
gint value)
return NULL;
}
+/**
+ * g_flags_get_first_value:
+ * @flags_class: a #GFlagsClass
+ * @value: the value
+ *
+ * Returns the first #GFlagsValue which is set in @value.
+ *
+ * Returns: the first #GFlagsValue which is set in @value, or %NULL if
+ * none is set
+ */
GFlagsValue*
g_flags_get_first_value (GFlagsClass *flags_class,
guint value)
if (flags_class->n_values)
{
GFlagsValue *flags_value;
-
- for (flags_value = flags_class->values; flags_value->value_name; flags_value++)
- if ((flags_value->value & value) > 0)
- return flags_value;
+
+ if (value == 0)
+ {
+ for (flags_value = flags_class->values; flags_value->value_name; flags_value++)
+ if (flags_value->value == 0)
+ return flags_value;
+ }
+ else
+ {
+ for (flags_value = flags_class->values; flags_value->value_name; flags_value++)
+ if (flags_value->value != 0 && (flags_value->value & value) == flags_value->value)
+ return flags_value;
+ }
}
return NULL;
}
+/**
+ * g_value_set_enum:
+ * @value: a valid #GValue whose type is derived from %G_TYPE_ENUM
+ * @v_enum: enum value to be set
+ *
+ * Set the contents of a %G_TYPE_ENUM #GValue to @v_enum.
+ */
void
g_value_set_enum (GValue *value,
gint v_enum)
{
- g_return_if_fail (G_IS_VALUE_ENUM (value));
-
+ g_return_if_fail (G_VALUE_HOLDS_ENUM (value));
+
value->data[0].v_long = v_enum;
}
+/**
+ * g_value_get_enum:
+ * @value: a valid #GValue whose type is derived from %G_TYPE_ENUM
+ *
+ * Get the contents of a %G_TYPE_ENUM #GValue.
+ *
+ * Returns: enum contents of @value
+ */
gint
-g_value_get_enum (GValue *value)
+g_value_get_enum (const GValue *value)
{
- g_return_val_if_fail (G_IS_VALUE_ENUM (value), 0);
-
+ g_return_val_if_fail (G_VALUE_HOLDS_ENUM (value), 0);
+
return value->data[0].v_long;
}
+/**
+ * g_value_set_flags:
+ * @value: a valid #GValue whose type is derived from %G_TYPE_FLAGS
+ * @v_flags: flags value to be set
+ *
+ * Set the contents of a %G_TYPE_FLAGS #GValue to @v_flags.
+ */
void
g_value_set_flags (GValue *value,
guint v_flags)
{
- g_return_if_fail (G_IS_VALUE_FLAGS (value));
-
+ g_return_if_fail (G_VALUE_HOLDS_FLAGS (value));
+
value->data[0].v_ulong = v_flags;
}
+/**
+ * g_value_get_flags:
+ * @value: a valid #GValue whose type is derived from %G_TYPE_FLAGS
+ *
+ * Get the contents of a %G_TYPE_FLAGS #GValue.
+ *
+ * Returns: flags contents of @value
+ */
guint
-g_value_get_flags (GValue *value)
-{
- g_return_val_if_fail (G_IS_VALUE_FLAGS (value), 0);
-
- return value->data[0].v_ulong;
-}
-
-static void
-g_value_enum_init (GValue *value)
-{
- value->data[0].v_long = 0;
-}
-
-static void
-g_value_enum_copy_value (const GValue *src_value,
- GValue *dest_value)
-{
- dest_value->data[0].v_long = src_value->data[0].v_long;
-}
-
-static gchar*
-g_value_enum_collect_value (GValue *value,
- guint nth_value,
- GType *collect_type,
- GTypeCValue *collect_value)
-{
- value->data[0].v_long = collect_value->v_int;
-
- *collect_type = 0;
- return NULL;
-}
-
-static gchar*
-g_value_enum_lcopy_value (const GValue *value,
- guint nth_value,
- GType *collect_type,
- GTypeCValue *collect_value)
+g_value_get_flags (const GValue *value)
{
- gint *int_p = collect_value->v_pointer;
+ g_return_val_if_fail (G_VALUE_HOLDS_FLAGS (value), 0);
- if (!int_p)
- return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
-
- *int_p = value->data[0].v_long;
-
- *collect_type = 0;
- return NULL;
+ return value->data[0].v_ulong;
}
projects / platform / upstream / glib.git / blobdiff