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.
27 #include "gvaluecollector.h"
28 #include "gbsearcharray.h"
31 /* --- typedefs & structures --- */
39 /* --- prototypes --- */
40 static gint transform_entries_cmp (gconstpointer bsearch_node1,
41 gconstpointer bsearch_node2);
44 /* --- variables --- */
45 static GBSearchArray *transform_array = NULL;
46 static GBSearchConfig transform_bconfig = {
47 sizeof (TransformEntry),
48 transform_entries_cmp,
53 /* --- functions --- */
55 g_value_c_init (void) /* sync with gtype.c */
57 transform_array = g_bsearch_array_create (&transform_bconfig);
60 static inline void /* keep this function in sync with gvaluecollector.h and gboxed.c */
61 value_meminit (GValue *value,
64 value->g_type = value_type;
65 memset (value->data, 0, sizeof (value->data));
69 g_value_init (GValue *value,
72 /* g_return_val_if_fail (G_TYPE_IS_VALUE (g_type), NULL); be more elaborate below */
73 g_return_val_if_fail (value != NULL, NULL);
74 /* g_return_val_if_fail (G_VALUE_TYPE (value) == 0, NULL); be more elaborate below */
76 if (G_TYPE_IS_VALUE (g_type) && G_VALUE_TYPE (value) == 0)
78 GTypeValueTable *value_table = g_type_value_table_peek (g_type);
81 value_meminit (value, g_type);
82 value_table->value_init (value);
84 else if (G_VALUE_TYPE (value))
85 g_warning ("%s: cannot initialize GValue with type `%s', the value has already been initialized as `%s'",
88 g_type_name (G_VALUE_TYPE (value)));
89 else /* !G_TYPE_IS_VALUE (g_type) */
90 g_warning ("%s: cannot initialize GValue with type `%s', %s",
93 g_type_value_table_peek (g_type) ?
94 "this type is abstract with regards to GValue use, use a more specific (derived) type" :
95 "this type has no GTypeValueTable implementation");
100 g_value_copy (const GValue *src_value,
103 g_return_if_fail (G_IS_VALUE (src_value));
104 g_return_if_fail (G_IS_VALUE (dest_value));
105 g_return_if_fail (g_value_type_compatible (G_VALUE_TYPE (src_value), G_VALUE_TYPE (dest_value)));
107 if (src_value != dest_value)
109 GType dest_type = G_VALUE_TYPE (dest_value);
110 GTypeValueTable *value_table = g_type_value_table_peek (dest_type);
112 /* make sure dest_value's value is free()d */
113 if (value_table->value_free)
114 value_table->value_free (dest_value);
117 value_meminit (dest_value, dest_type);
118 value_table->value_copy (src_value, dest_value);
123 g_value_reset (GValue *value)
125 GTypeValueTable *value_table;
128 g_return_val_if_fail (G_IS_VALUE (value), NULL);
130 g_type = G_VALUE_TYPE (value);
131 value_table = g_type_value_table_peek (g_type);
133 /* make sure value's value is free()d */
134 if (value_table->value_free)
135 value_table->value_free (value);
138 value_meminit (value, g_type);
139 value_table->value_init (value);
145 g_value_unset (GValue *value)
147 GTypeValueTable *value_table;
149 g_return_if_fail (G_IS_VALUE (value));
151 value_table = g_type_value_table_peek (G_VALUE_TYPE (value));
153 if (value_table->value_free)
154 value_table->value_free (value);
155 memset (value, 0, sizeof (*value));
159 g_value_fits_pointer (const GValue *value)
161 GTypeValueTable *value_table;
163 g_return_val_if_fail (G_IS_VALUE (value), FALSE);
165 value_table = g_type_value_table_peek (G_VALUE_TYPE (value));
167 return value_table->value_peek_pointer != NULL;
171 g_value_peek_pointer (const GValue *value)
173 GTypeValueTable *value_table;
175 g_return_val_if_fail (G_IS_VALUE (value), NULL);
177 value_table = g_type_value_table_peek (G_VALUE_TYPE (value));
178 if (!value_table->value_peek_pointer)
180 g_assert (g_value_fits_pointer (value) == TRUE);
184 return value_table->value_peek_pointer (value);
188 g_value_set_instance (GValue *value,
192 GTypeValueTable *value_table;
196 g_return_if_fail (G_IS_VALUE (value));
199 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
200 g_return_if_fail (g_value_type_compatible (G_TYPE_FROM_INSTANCE (instance), G_VALUE_TYPE (value)));
203 g_type = G_VALUE_TYPE (value);
204 value_table = g_type_value_table_peek (g_type);
206 g_return_if_fail (strcmp (value_table->collect_format, "p") == 0);
208 memset (&cvalue, 0, sizeof (cvalue));
209 cvalue.v_pointer = instance;
211 /* make sure value's value is free()d */
212 if (value_table->value_free)
213 value_table->value_free (value);
215 /* setup and collect */
216 value_meminit (value, g_type);
217 error_msg = value_table->collect_value (value, 1, &cvalue, 0);
220 g_warning ("%s: %s", G_STRLOC, error_msg);
223 /* we purposely leak the value here, it might not be
224 * in a sane state if an error condition occoured
226 value_meminit (value, g_type);
227 value_table->value_init (value);
231 static GValueTransform
232 transform_func_lookup (GType src_type,
235 TransformEntry entry;
237 entry.src_type = src_type;
240 entry.dest_type = dest_type;
245 e = g_bsearch_array_lookup (transform_array, &transform_bconfig, &entry);
248 /* need to check that there hasn't been a change in value handling */
249 if (g_type_value_table_peek (entry.dest_type) == g_type_value_table_peek (dest_type) &&
250 g_type_value_table_peek (entry.src_type) == g_type_value_table_peek (src_type))
253 entry.dest_type = g_type_parent (entry.dest_type);
255 while (entry.dest_type);
257 entry.src_type = g_type_parent (entry.src_type);
259 while (entry.src_type);
265 transform_entries_cmp (gconstpointer bsearch_node1,
266 gconstpointer bsearch_node2)
268 const TransformEntry *e1 = bsearch_node1;
269 const TransformEntry *e2 = bsearch_node2;
270 gint cmp = G_BSEARCH_ARRAY_CMP (e1->src_type, e2->src_type);
275 return G_BSEARCH_ARRAY_CMP (e1->dest_type, e2->dest_type);
279 g_value_register_transform_func (GType src_type,
281 GValueTransform transform_func)
283 TransformEntry entry;
285 /* these checks won't pass for dynamic types.
286 * g_return_if_fail (G_TYPE_HAS_VALUE_TABLE (src_type));
287 * g_return_if_fail (G_TYPE_HAS_VALUE_TABLE (dest_type));
289 g_return_if_fail (transform_func != NULL);
291 entry.src_type = src_type;
292 entry.dest_type = dest_type;
294 #if 0 /* let transform function replacement be a valid operation */
295 if (g_bsearch_array_lookup (transform_array, &transform_bconfig, &entry))
296 g_warning ("reregistering value transformation function (%p) for `%s' to `%s'",
298 g_type_name (src_type),
299 g_type_name (dest_type));
302 entry.func = transform_func;
303 transform_array = g_bsearch_array_replace (transform_array, &transform_bconfig, &entry);
307 g_value_type_transformable (GType src_type,
310 g_return_val_if_fail (G_TYPE_IS_VALUE (src_type), FALSE);
311 g_return_val_if_fail (G_TYPE_IS_VALUE (dest_type), FALSE);
313 return (g_value_type_compatible (src_type, dest_type) ||
314 transform_func_lookup (src_type, dest_type) != NULL);
318 g_value_type_compatible (GType src_type,
321 g_return_val_if_fail (G_TYPE_IS_VALUE (src_type), FALSE);
322 g_return_val_if_fail (G_TYPE_IS_VALUE (dest_type), FALSE);
324 return (g_type_is_a (src_type, dest_type) &&
325 g_type_value_table_peek (dest_type) == g_type_value_table_peek (src_type));
329 g_value_transform (const GValue *src_value,
334 g_return_val_if_fail (G_IS_VALUE (src_value), FALSE);
335 g_return_val_if_fail (G_IS_VALUE (dest_value), FALSE);
337 dest_type = G_VALUE_TYPE (dest_value);
338 if (g_value_type_compatible (G_VALUE_TYPE (src_value), dest_type))
340 g_value_copy (src_value, dest_value);
346 GValueTransform transform = transform_func_lookup (G_VALUE_TYPE (src_value), dest_type);
350 g_value_unset (dest_value);
352 /* setup and transform */
353 value_meminit (dest_value, dest_type);
354 transform (src_value, dest_value);