1 /* GObject - GLib Type, Object, Parameter and Signal Library
2 * Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.
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.
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.
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.
19 * gparam.h: GParamSpec base class implementation
25 #include <gobject/gvalue.h>
30 #endif /* __cplusplus */
33 /* --- type macros --- */
34 #define G_TYPE_IS_PARAM(type) (G_TYPE_FUNDAMENTAL (type) == G_TYPE_PARAM)
35 #define G_PARAM_SPEC_TYPE(pspec) (G_TYPE_FROM_INSTANCE (pspec))
36 #define G_PARAM_SPEC_TYPE_NAME(pspec) (g_type_name (G_PARAM_SPEC_TYPE (pspec)))
37 #define G_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_CAST ((pspec), G_TYPE_PARAM, GParamSpec))
38 #define G_IS_PARAM_SPEC(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), G_TYPE_PARAM))
39 #define G_PARAM_SPEC_GET_CLASS(pspec) (G_TYPE_INSTANCE_GET_CLASS ((pspec), G_TYPE_PARAM, GParamSpecClass))
40 #define G_PARAM_SPEC_VALUE_TYPE(pspec) (G_PARAM_SPEC (pspec)->value_type)
41 #define G_VALUE_HOLDS_PARAM(value) (G_TYPE_CHECK_VALUE_TYPE ((value), G_TYPE_PARAM))
47 G_PARAM_READABLE = 1 << 0,
48 G_PARAM_WRITABLE = 1 << 1,
49 G_PARAM_CONSTRUCT = 1 << 2,
50 G_PARAM_CONSTRUCT_ONLY = 1 << 3,
51 G_PARAM_LAX_VALIDATION = 1 << 4,
52 G_PARAM_PRIVATE = 1 << 5
54 #define G_PARAM_READWRITE (G_PARAM_READABLE | G_PARAM_WRITABLE)
55 #define G_PARAM_MASK (0x000000ff)
56 /* bits in the range 0xffffff00 are reserved for 3rd party usage */
57 #define G_PARAM_USER_SHIFT (8)
60 /* --- typedefs & structures --- */
61 typedef struct _GParamSpec GParamSpec;
62 typedef struct _GParamSpecClass GParamSpecClass;
63 typedef struct _GParamSpecPool GParamSpecPool;
66 GTypeInstance g_type_instance;
79 struct _GParamSpecClass
81 GTypeClass g_type_class;
85 void (*finalize) (GParamSpec *pspec);
88 void (*value_set_default) (GParamSpec *pspec,
90 gboolean (*value_validate) (GParamSpec *pspec,
92 gint (*values_cmp) (GParamSpec *pspec,
94 const GValue *value2);
98 /* --- prototypes --- */
99 GParamSpec* g_param_spec_ref (GParamSpec *pspec);
100 void g_param_spec_unref (GParamSpec *pspec);
101 void g_param_spec_sink (GParamSpec *pspec);
102 gpointer g_param_spec_get_qdata (GParamSpec *pspec,
104 void g_param_spec_set_qdata (GParamSpec *pspec,
107 void g_param_spec_set_qdata_full (GParamSpec *pspec,
110 GDestroyNotify destroy);
111 gpointer g_param_spec_steal_qdata (GParamSpec *pspec,
113 void g_param_value_set_default (GParamSpec *pspec,
115 gboolean g_param_value_defaults (GParamSpec *pspec,
117 gboolean g_param_value_validate (GParamSpec *pspec,
119 gboolean g_param_value_convert (GParamSpec *dest_value_spec,
120 const GValue *src_value,
122 gboolean strict_validation);
123 gint g_param_values_cmp (GParamSpec *pspec,
124 const GValue *value1,
125 const GValue *value2);
126 void g_value_set_param (GValue *value,
128 GParamSpec* g_value_get_param (const GValue *value);
129 GParamSpec* g_value_dup_param (const GValue *value);
132 /* --- convenience functions --- */
133 typedef struct _GParamSpecTypeInfo GParamSpecTypeInfo;
134 struct _GParamSpecTypeInfo
136 /* type system portion */
137 guint16 instance_size; /* obligatory */
138 guint16 n_preallocs; /* optional */
139 void (*instance_init) (GParamSpec *pspec); /* optional */
142 GType value_type; /* obligatory */
143 void (*finalize) (GParamSpec *pspec); /* optional */
144 void (*value_set_default) (GParamSpec *pspec, /* recommended */
146 gboolean (*value_validate) (GParamSpec *pspec, /* optional */
148 gint (*values_cmp) (GParamSpec *pspec, /* recommended */
149 const GValue *value1,
150 const GValue *value2);
152 GType g_param_type_register_static (const gchar *name,
153 const GParamSpecTypeInfo *pspec_info);
156 /* --- protected --- */
157 gpointer g_param_spec_internal (GType param_type,
162 GParamSpecPool* g_param_spec_pool_new (gboolean type_prefixing);
163 void g_param_spec_pool_insert (GParamSpecPool *pool,
166 void g_param_spec_pool_remove (GParamSpecPool *pool,
168 GParamSpec* g_param_spec_pool_lookup (GParamSpecPool *pool,
169 const gchar *param_name,
171 gboolean walk_ancestors);
176 * gboolean value_validate (GParamSpec *pspec,
178 * modify value contents in the least destructive way, so
179 * that it complies with pspec's requirements (i.e.
180 * according to minimum/maximum ranges etc...). return
181 * whether modification was necessary.
183 * gint values_cmp (GParamSpec *pspec,
184 * const GValue *value1,
185 * const GValue *value2):
186 * return value1 - value2, i.e. <0 if value1 < value2,
187 * >0 if value1 > value2, and 0 otherwise (they are equal)
192 #endif /* __cplusplus */
194 #endif /* __G_PARAM_H__ */