gobject/gvalue.c

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 /*
  21  * FIXME: MT-safety
  22  */
  23
  24 #include <string.h>
  25
  26 #include "gvalue.h"
  27 #include "gvaluecollector.h"
  28 #include "gbsearcharray.h"
  29
  30
  31 /* --- typedefs & structures --- */
  32 typedef struct {
  33   GType src_type;
  34   GType dest_type;
  35   GValueTransform func;
  36 } TransformEntry;
  37
  38
  39 /* --- prototypes --- */
  40 static gint     transform_entries_cmp   (gconstpointer bsearch_node1,
  41                                          gconstpointer bsearch_node2);
  42
  43
  44 /* --- variables --- */
  45 static GBSearchArray *transform_array = NULL;
  46 static GBSearchConfig transform_bconfig = {
  47   sizeof (TransformEntry),
  48   transform_entries_cmp,
  49   0,
  50 };
  51
  52
  53 /* --- functions --- */
  54 void
  55 g_value_c_init (void)   /* sync with gtype.c */
  56 {
  57   transform_array = g_bsearch_array_create (&transform_bconfig);
  58 }
  59
  60 static inline void              /* keep this function in sync with gvaluecollector.h and gboxed.c */
  61 value_meminit (GValue *value,
  62                GType   value_type)
  63 {
  64   value->g_type = value_type;
  65   memset (value->data, 0, sizeof (value->data));
  66 }
  67
  68 GValue*
  69 g_value_init (GValue *value,
  70               GType   g_type)
  71 {
  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 */
  75
  76   if (G_TYPE_IS_VALUE (g_type) && G_VALUE_TYPE (value) == 0)
  77     {
  78       GTypeValueTable *value_table = g_type_value_table_peek (g_type);
  79
  80       /* setup and init */
  81       value_meminit (value, g_type);
  82       value_table->value_init (value);
  83     }
  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'",
  86                G_STRLOC,
  87                g_type_name (g_type),
  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",
  91                G_STRLOC,
  92                g_type_name (g_type),
  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");
  96   return value;
  97 }
  98
  99 void
 100 g_value_copy (const GValue *src_value,
 101               GValue       *dest_value)
 102 {
 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)));
 106
 107   if (src_value != dest_value)
 108     {
 109       GType dest_type = G_VALUE_TYPE (dest_value);
 110       GTypeValueTable *value_table = g_type_value_table_peek (dest_type);
 111
 112       /* make sure dest_value's value is free()d */
 113       if (value_table->value_free)
 114         value_table->value_free (dest_value);
 115
 116       /* setup and copy */
 117       value_meminit (dest_value, dest_type);
 118       value_table->value_copy (src_value, dest_value);
 119     }
 120 }
 121
 122 GValue*
 123 g_value_reset (GValue *value)
 124 {
 125   GTypeValueTable *value_table;
 126   GType g_type;
 127
 128   g_return_val_if_fail (G_IS_VALUE (value), NULL);
 129
 130   g_type = G_VALUE_TYPE (value);
 131   value_table = g_type_value_table_peek (g_type);
 132
 133   /* make sure value's value is free()d */
 134   if (value_table->value_free)
 135     value_table->value_free (value);
 136
 137   /* setup and init */
 138   value_meminit (value, g_type);
 139   value_table->value_init (value);
 140
 141   return value;
 142 }
 143
 144 void
 145 g_value_unset (GValue *value)
 146 {
 147   GTypeValueTable *value_table;
 148
 149   g_return_if_fail (G_IS_VALUE (value));
 150
 151   value_table = g_type_value_table_peek (G_VALUE_TYPE (value));
 152
 153   if (value_table->value_free)
 154     value_table->value_free (value);
 155   memset (value, 0, sizeof (*value));
 156 }
 157
 158 gboolean
 159 g_value_fits_pointer (const GValue *value)
 160 {
 161   GTypeValueTable *value_table;
 162
 163   g_return_val_if_fail (G_IS_VALUE (value), FALSE);
 164
 165   value_table = g_type_value_table_peek (G_VALUE_TYPE (value));
 166
 167   return value_table->value_peek_pointer != NULL;
 168 }
 169
 170 gpointer
 171 g_value_peek_pointer (const GValue *value)
 172 {
 173   GTypeValueTable *value_table;
 174
 175   g_return_val_if_fail (G_IS_VALUE (value), NULL);
 176
 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);
 180
 181   return value_table->value_peek_pointer (value);
 182 }
 183
 184 void
 185 g_value_set_instance (GValue  *value,
 186                       gpointer instance)
 187 {
 188   GType g_type;
 189   GTypeValueTable *value_table;
 190   GTypeCValue cvalue;
 191   gchar *error_msg;
 192
 193   g_return_if_fail (G_IS_VALUE (value));
 194   if (instance)
 195     {
 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)));
 198     }
 199
 200   g_type = G_VALUE_TYPE (value);
 201   value_table = g_type_value_table_peek (g_type);
 202
 203   g_return_if_fail (strcmp (value_table->collect_format, "p") == 0);
 204
 205   memset (&cvalue, 0, sizeof (cvalue));
 206   cvalue.v_pointer = instance;
 207
 208   /* make sure value's value is free()d */
 209   if (value_table->value_free)
 210     value_table->value_free (value);
 211
 212   /* setup and collect */
 213   value_meminit (value, g_type);
 214   error_msg = value_table->collect_value (value, 1, &cvalue, 0);
 215   if (error_msg)
 216     {
 217       g_warning ("%s: %s", G_STRLOC, error_msg);
 218       g_free (error_msg);
 219
 220       /* we purposely leak the value here, it might not be
 221        * in a sane state if an error condition occoured
 222        */
 223       value_meminit (value, g_type);
 224       value_table->value_init (value);
 225     }
 226 }
 227
 228 static GValueTransform
 229 transform_func_lookup (GType src_type,
 230                        GType dest_type)
 231 {
 232   TransformEntry entry;
 233
 234   entry.src_type = src_type;
 235   do
 236     {
 237       entry.dest_type = dest_type;
 238       do
 239         {
 240           TransformEntry *e;
 241
 242           e = g_bsearch_array_lookup (transform_array, &transform_bconfig, &entry);
 243           if (e)
 244             {
 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))
 248                 return e->func;
 249             }
 250           entry.dest_type = g_type_parent (entry.dest_type);
 251         }
 252       while (entry.dest_type);
 253
 254       entry.src_type = g_type_parent (entry.src_type);
 255     }
 256   while (entry.src_type);
 257
 258   return NULL;
 259 }
 260
 261 static gint
 262 transform_entries_cmp (gconstpointer bsearch_node1,
 263                        gconstpointer bsearch_node2)
 264 {
 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);
 268
 269   if (cmp)
 270     return cmp;
 271   else
 272     return G_BSEARCH_ARRAY_CMP (e1->dest_type, e2->dest_type);
 273 }
 274
 275 void
 276 g_value_register_transform_func (GType           src_type,
 277                                  GType           dest_type,
 278                                  GValueTransform transform_func)
 279 {
 280   TransformEntry entry;
 281
 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));
 285    */
 286   g_return_if_fail (transform_func != NULL);
 287
 288   entry.src_type = src_type;
 289   entry.dest_type = dest_type;
 290
 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'",
 294                transform_func,
 295                g_type_name (src_type),
 296                g_type_name (dest_type));
 297 #endif
 298
 299   entry.func = transform_func;
 300   transform_array = g_bsearch_array_replace (transform_array, &transform_bconfig, &entry);
 301 }
 302
 303 gboolean
 304 g_value_type_transformable (GType src_type,
 305                             GType dest_type)
 306 {
 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);
 309
 310   return (g_value_type_compatible (src_type, dest_type) ||
 311           transform_func_lookup (src_type, dest_type) != NULL);
 312 }
 313
 314 gboolean
 315 g_value_type_compatible (GType src_type,
 316                          GType dest_type)
 317 {
 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);
 320
 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));
 323 }
 324
 325 gboolean
 326 g_value_transform (const GValue *src_value,
 327                    GValue       *dest_value)
 328 {
 329   GType dest_type;
 330
 331   g_return_val_if_fail (G_IS_VALUE (src_value), FALSE);
 332   g_return_val_if_fail (G_IS_VALUE (dest_value), FALSE);
 333
 334   dest_type = G_VALUE_TYPE (dest_value);
 335   if (g_value_type_compatible (G_VALUE_TYPE (src_value), dest_type))
 336     {
 337       g_value_copy (src_value, dest_value);
 338
 339       return TRUE;
 340     }
 341   else
 342     {
 343       GValueTransform transform = transform_func_lookup (G_VALUE_TYPE (src_value), dest_type);
 344
 345       if (transform)
 346         {
 347           g_value_unset (dest_value);
 348
 349           /* setup and transform */
 350           value_meminit (dest_value, dest_type);
 351           transform (src_value, dest_value);
 352
 353           return TRUE;
 354         }
 355     }
 356   return FALSE;
 357 }