/* GObject - GLib Type, Object, Parameter and Signal Library
- * Copyright (C) 1997, 1998, 1999, 2000 Tim Janik and Red Hat, Inc.
+ * Copyright (C) 1997-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
*
* gparam.h: GParamSpec base class implementation
*/
+#if !defined (__GLIB_GOBJECT_H_INSIDE__) && !defined (GOBJECT_COMPILATION)
+#error "Only <glib-object.h> can be included directly."
+#endif
+
#ifndef __G_PARAM_H__
#define __G_PARAM_H__
-
#include <gobject/gvalue.h>
+G_BEGIN_DECLS
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
-
-
-/* --- type macros --- */
+/* --- standard type macros --- */
#define G_TYPE_IS_PARAM(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_PARAM)
-#define G_PARAM_SPEC_TYPE(pspec) (G_TYPE_FROM_INSTANCE (pspec))
-#define G_PARAM_SPEC_TYPE_NAME(pspec) (g_type_name (G_PARAM_SPEC_TYPE (pspec)))
#define G_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM, GParamSpec))
#define G_IS_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM))
+#define G_PARAM_SPEC_CLASS(pclass) (G_TYPE_CHECK_CLASS_CAST ((pclass), G_TYPE_PARAM, GParamSpecClass))
+#define G_IS_PARAM_SPEC_CLASS(pclass) (G_TYPE_CHECK_CLASS_TYPE ((pclass), G_TYPE_PARAM))
#define G_PARAM_SPEC_GET_CLASS(pspec) (G_TYPE_INSTANCE_GET_CLASS ((pspec), G_TYPE_PARAM, GParamSpecClass))
-#define G_PARAM_SPEC_VALUE_TYPE(pspec) (G_PARAM_SPEC_GET_CLASS (pspec)->value_type)
-#define G_IS_VALUE_PARAM(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_PARAM))
+
+
+/* --- convenience macros --- */
+#define G_PARAM_SPEC_TYPE(pspec) (G_TYPE_FROM_INSTANCE (pspec))
+#define G_PARAM_SPEC_TYPE_NAME(pspec) (g_type_name (G_PARAM_SPEC_TYPE (pspec)))
+#define G_PARAM_SPEC_VALUE_TYPE(pspec) (G_PARAM_SPEC (pspec)->value_type)
+#define G_VALUE_HOLDS_PARAM(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_PARAM))
/* --- flags --- */
G_PARAM_WRITABLE = 1 << 1,
G_PARAM_CONSTRUCT = 1 << 2,
G_PARAM_CONSTRUCT_ONLY = 1 << 3,
- G_PARAM_PRIVATE = 1 << 4,
-#define G_PARAM_MASK (0x000000ff)
- /* bits in the range 0xffffff00 are reserved for 3rd party usage */
-#define G_PARAM_USER_MASK (0xffffff00)
+ G_PARAM_LAX_VALIDATION = 1 << 4,
+ G_PARAM_PRIVATE = 1 << 5
} GParamFlags;
+#define G_PARAM_READWRITE (G_PARAM_READABLE | G_PARAM_WRITABLE)
+#define G_PARAM_MASK (0x000000ff)
+/* bits in the range 0xffffff00 are reserved for 3rd party usage */
+#define G_PARAM_USER_SHIFT (8)
/* --- typedefs & structures --- */
typedef struct _GParamSpec GParamSpec;
typedef struct _GParamSpecClass GParamSpecClass;
+typedef struct _GParameter GParameter;
typedef struct _GParamSpecPool GParamSpecPool;
struct _GParamSpec
{
GTypeInstance g_type_instance;
gchar *name;
- gchar *nick;
- gchar *blurb;
GParamFlags flags;
+ GType value_type;
+ GType owner_type; /* class using this property */
/*< private >*/
- GType owner_type;
+ gchar *_nick;
+ gchar *_blurb;
GData *qdata;
guint ref_count;
+ guint param_id; /* sort-criteria */
};
struct _GParamSpecClass
{
gint (*values_cmp) (GParamSpec *pspec,
const GValue *value1,
const GValue *value2);
+ gpointer dummy[4];
+};
+struct _GParameter /* auxillary structure for _setv() variants */
+{
+ const gchar *name;
+ GValue value;
};
GValue *value);
gboolean g_param_value_validate (GParamSpec *pspec,
GValue *value);
+gboolean g_param_value_convert (GParamSpec *pspec,
+ const GValue *src_value,
+ GValue *dest_value,
+ gboolean strict_validation);
gint g_param_values_cmp (GParamSpec *pspec,
const GValue *value1,
const GValue *value2);
+G_CONST_RETURN gchar* g_param_spec_get_name (GParamSpec *pspec);
+G_CONST_RETURN gchar* g_param_spec_get_nick (GParamSpec *pspec);
+G_CONST_RETURN gchar* g_param_spec_get_blurb (GParamSpec *pspec);
void g_value_set_param (GValue *value,
GParamSpec *param);
GParamSpec* g_value_get_param (const GValue *value);
GParamSpec* g_value_dup_param (const GValue *value);
+/* --- marshaller specific --- */
+void g_value_set_param_take_ownership (GValue *value,
+ GParamSpec *param);
+
+
/* --- convenience functions --- */
typedef struct _GParamSpecTypeInfo GParamSpecTypeInfo;
struct _GParamSpecTypeInfo
GType g_param_type_register_static (const gchar *name,
const GParamSpecTypeInfo *pspec_info);
+/* For registering builting types */
+GType _g_param_type_register_static_constant (const gchar *name,
+ const GParamSpecTypeInfo *pspec_info,
+ GType opt_type);
+
/* --- protected --- */
gpointer g_param_spec_internal (GType param_type,
GParamSpec* g_param_spec_pool_lookup (GParamSpecPool *pool,
const gchar *param_name,
GType owner_type,
- gboolean walk_ancestors,
- const gchar **trailer_p);
+ gboolean walk_ancestors);
+GList* g_param_spec_pool_list_owned (GParamSpecPool *pool,
+ GType owner_type);
+GParamSpec** g_param_spec_pool_list (GParamSpecPool *pool,
+ GType owner_type,
+ guint *n_pspecs_p);
+
/* contracts:
* gint values_cmp (GParamSpec *pspec,
* const GValue *value1,
* const GValue *value2):
- * return value1 - value2, i.e. <0 if value1 < value2,
- * >0 if value1 > value2, and 0 otherwise (they are equal)
+ * return value1 - value2, i.e. (-1) if value1 < value2,
+ * (+1) if value1 > value2, and (0) otherwise (equality)
*/
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+G_END_DECLS
#endif /* __G_PARAM_H__ */
projects / platform / upstream / glib.git / blobdiff