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)
179 g_return_val_if_fail (g_value_fits_pointer (value) == TRUE, NULL);
181 return value_table->value_peek_pointer (value);
185 g_value_set_instance (GValue *value,
189 GTypeValueTable *value_table;
193 g_return_if_fail (G_IS_VALUE (value));
196 g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
197 g_return_if_fail (g_value_type_compatible (G_TYPE_FROM_INSTANCE (instance), G_VALUE_TYPE (value)));
200 g_type = G_VALUE_TYPE (value);
201 value_table = g_type_value_table_peek (g_type);
203 g_return_if_fail (strcmp (value_table->collect_format, "p") == 0);
205 memset (&cvalue, 0, sizeof (cvalue));
206 cvalue.v_pointer = instance;
208 /* make sure value's value is free()d */
209 if (value_table->value_free)
210 value_table->value_free (value);
212 /* setup and collect */
213 value_meminit (value, g_type);
214 error_msg = value_table->collect_value (value, 1, &cvalue, 0);
217 g_warning ("%s: %s", G_STRLOC, error_msg);
220 /* we purposely leak the value here, it might not be
221 * in a sane state if an error condition occoured
223 value_meminit (value, g_type);
224 value_table->value_init (value);
228 static GValueTransform
229 transform_func_lookup (GType src_type,
232 TransformEntry entry;
234 entry.src_type = src_type;
237 entry.dest_type = dest_type;
242 e = g_bsearch_array_lookup (transform_array, &transform_bconfig, &entry);
245 /* need to check that there hasn't been a change in value handling */
246 if (g_type_value_table_peek (entry.dest_type) == g_type_value_table_peek (dest_type) &&
247 g_type_value_table_peek (entry.src_type) == g_type_value_table_peek (src_type))
250 entry.dest_type = g_type_parent (entry.dest_type);
252 while (entry.dest_type);
254 entry.src_type = g_type_parent (entry.src_type);
256 while (entry.src_type);
262 transform_entries_cmp (gconstpointer bsearch_node1,
263 gconstpointer bsearch_node2)
265 const TransformEntry *e1 = bsearch_node1;
266 const TransformEntry *e2 = bsearch_node2;
267 gint cmp = G_BSEARCH_ARRAY_CMP (e1->src_type, e2->src_type);
272 return G_BSEARCH_ARRAY_CMP (e1->dest_type, e2->dest_type);
276 g_value_register_transform_func (GType src_type,
278 GValueTransform transform_func)
280 TransformEntry entry;
282 /* these checks won't pass for dynamic types.
283 * g_return_if_fail (G_TYPE_HAS_VALUE_TABLE (src_type));
284 * g_return_if_fail (G_TYPE_HAS_VALUE_TABLE (dest_type));
286 g_return_if_fail (transform_func != NULL);
288 entry.src_type = src_type;
289 entry.dest_type = dest_type;
291 #if 0 /* let transform function replacement be a valid operation */
292 if (g_bsearch_array_lookup (transform_array, &transform_bconfig, &entry))
293 g_warning ("reregistering value transformation function (%p) for `%s' to `%s'",
295 g_type_name (src_type),
296 g_type_name (dest_type));
299 entry.func = transform_func;
300 transform_array = g_bsearch_array_replace (transform_array, &transform_bconfig, &entry);
304 g_value_type_transformable (GType src_type,
307 g_return_val_if_fail (G_TYPE_IS_VALUE (src_type), FALSE);
308 g_return_val_if_fail (G_TYPE_IS_VALUE (dest_type), FALSE);
310 return (g_value_type_compatible (src_type, dest_type) ||
311 transform_func_lookup (src_type, dest_type) != NULL);
315 g_value_type_compatible (GType src_type,
318 g_return_val_if_fail (G_TYPE_IS_VALUE (src_type), FALSE);
319 g_return_val_if_fail (G_TYPE_IS_VALUE (dest_type), FALSE);
321 return (g_type_is_a (src_type, dest_type) &&
322 g_type_value_table_peek (dest_type) == g_type_value_table_peek (src_type));
326 g_value_transform (const GValue *src_value,
331 g_return_val_if_fail (G_IS_VALUE (src_value), FALSE);
332 g_return_val_if_fail (G_IS_VALUE (dest_value), FALSE);
334 dest_type = G_VALUE_TYPE (dest_value);
335 if (g_value_type_compatible (G_VALUE_TYPE (src_value), dest_type))
337 g_value_copy (src_value, dest_value);
343 GValueTransform transform = transform_func_lookup (G_VALUE_TYPE (src_value), dest_type);
347 g_value_unset (dest_value);
349 /* setup and transform */
350 value_meminit (dest_value, dest_type);
351 transform (src_value, dest_value);