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 = {
  46   transform_entries_cmp,
  47   sizeof (TransformEntry),
  48   0, /* no flags */
  49   0, NULL,
  50 };
  51
  52
  53 /* --- functions --- */
  54 static inline void              /* keep this function in sync with gvaluecollector.h and gboxed.c */
  55 value_meminit (GValue *value,
  56                GType   value_type)
  57 {
  58   value->g_type = value_type;
  59   memset (value->data, 0, sizeof (value->data));
  60 }
  61
  62 GValue*
  63 g_value_init (GValue *value,
  64               GType   g_type)
  65 {
  66   /* g_return_val_if_fail (G_TYPE_IS_VALUE (g_type), NULL);     be more elaborate below */
  67   g_return_val_if_fail (value != NULL, NULL);
  68   /* g_return_val_if_fail (G_VALUE_TYPE (value) == 0, NULL);    be more elaborate below */
  69
  70   if (G_TYPE_IS_VALUE (g_type) && G_VALUE_TYPE (value) == 0)
  71     {
  72       GTypeValueTable *value_table = g_type_value_table_peek (g_type);
  73
  74       /* setup and init */
  75       value_meminit (value, g_type);
  76       value_table->value_init (value);
  77     }
  78   else if (G_VALUE_TYPE (value))
  79     g_warning ("%s: cannot initialize GValue with type `%s', the value has already been initialized as `%s'",
  80                G_STRLOC,
  81                g_type_name (g_type),
  82                g_type_name (G_VALUE_TYPE (value)));
  83   else /* !G_TYPE_IS_VALUE (g_type) */
  84     g_warning ("%s: cannot initialize GValue with type `%s', %s",
  85                G_STRLOC,
  86                g_type_name (g_type),
  87                g_type_value_table_peek (g_type) ?
  88                "this type is abstract with regards to GValue use, use a more specific (derived) type" :
  89                "this type has no GTypeValueTable implementation");
  90   return value;
  91 }
  92
  93 void
  94 g_value_copy (const GValue *src_value,
  95               GValue       *dest_value)
  96 {
  97   g_return_if_fail (G_IS_VALUE (src_value));
  98   g_return_if_fail (G_IS_VALUE (dest_value));
  99   g_return_if_fail (g_value_type_compatible (G_VALUE_TYPE (src_value), G_VALUE_TYPE (dest_value)));
 100
 101   if (src_value != dest_value)
 102     {
 103       GType dest_type = G_VALUE_TYPE (dest_value);
 104       GTypeValueTable *value_table = g_type_value_table_peek (dest_type);
 105
 106       /* make sure dest_value's value is free()d */
 107       if (value_table->value_free)
 108         value_table->value_free (dest_value);
 109
 110       /* setup and copy */
 111       value_meminit (dest_value, dest_type);
 112       value_table->value_copy (src_value, dest_value);
 113     }
 114 }
 115
 116 GValue*
 117 g_value_reset (GValue *value)
 118 {
 119   GTypeValueTable *value_table;
 120   GType g_type;
 121
 122   g_return_val_if_fail (G_IS_VALUE (value), NULL);
 123
 124   g_type = G_VALUE_TYPE (value);
 125   value_table = g_type_value_table_peek (g_type);
 126
 127   /* make sure value's value is free()d */
 128   if (value_table->value_free)
 129     value_table->value_free (value);
 130
 131   /* setup and init */
 132   value_meminit (value, g_type);
 133   value_table->value_init (value);
 134
 135   return value;
 136 }
 137
 138 void
 139 g_value_unset (GValue *value)
 140 {
 141   GTypeValueTable *value_table;
 142
 143   g_return_if_fail (G_IS_VALUE (value));
 144
 145   value_table = g_type_value_table_peek (G_VALUE_TYPE (value));
 146
 147   if (value_table->value_free)
 148     value_table->value_free (value);
 149   memset (value, 0, sizeof (*value));
 150 }
 151
 152 gboolean
 153 g_value_fits_pointer (const GValue *value)
 154 {
 155   GTypeValueTable *value_table;
 156
 157   g_return_val_if_fail (G_IS_VALUE (value), FALSE);
 158
 159   value_table = g_type_value_table_peek (G_VALUE_TYPE (value));
 160
 161   return value_table->value_peek_pointer != NULL;
 162 }
 163
 164 gpointer
 165 g_value_peek_pointer (const GValue *value)
 166 {
 167   GTypeValueTable *value_table;
 168
 169   g_return_val_if_fail (G_IS_VALUE (value), NULL);
 170
 171   value_table = g_type_value_table_peek (G_VALUE_TYPE (value));
 172   if (!value_table->value_peek_pointer)
 173     g_return_val_if_fail (g_value_fits_pointer (value) == TRUE, NULL);
 174
 175   return value_table->value_peek_pointer (value);
 176 }
 177
 178 void
 179 g_value_set_instance (GValue  *value,
 180                       gpointer instance)
 181 {
 182   GType g_type;
 183   GTypeValueTable *value_table;
 184   GTypeCValue cvalue;
 185   gchar *error_msg;
 186
 187   g_return_if_fail (G_IS_VALUE (value));
 188   if (instance)
 189     {
 190       g_return_if_fail (G_TYPE_CHECK_INSTANCE (instance));
 191       g_return_if_fail (g_value_type_compatible (G_TYPE_FROM_INSTANCE (instance), G_VALUE_TYPE (value)));
 192     }
 193
 194   g_type = G_VALUE_TYPE (value);
 195   value_table = g_type_value_table_peek (g_type);
 196
 197   g_return_if_fail (strcmp (value_table->collect_format, "p") == 0);
 198
 199   memset (&cvalue, 0, sizeof (cvalue));
 200   cvalue.v_pointer = instance;
 201
 202   /* make sure value's value is free()d */
 203   if (value_table->value_free)
 204     value_table->value_free (value);
 205
 206   /* setup and collect */
 207   value_meminit (value, g_type);
 208   error_msg = value_table->collect_value (value, 1, &cvalue, 0);
 209   if (error_msg)
 210     {
 211       g_warning ("%s: %s", G_STRLOC, error_msg);
 212       g_free (error_msg);
 213
 214       /* we purposely leak the value here, it might not be
 215        * in a sane state if an error condition occoured
 216        */
 217       value_meminit (value, g_type);
 218       value_table->value_init (value);
 219     }
 220 }
 221
 222 static GValueTransform
 223 transform_func_lookup (GType src_type,
 224                        GType dest_type)
 225 {
 226   TransformEntry entry;
 227
 228   entry.src_type = src_type;
 229   do
 230     {
 231       entry.dest_type = dest_type;
 232       do
 233         {
 234           TransformEntry *e;
 235
 236           e = g_bsearch_array_lookup (&transform_array, &entry);
 237           if (e)
 238             {
 239               /* need to check that there hasn't been a change in value handling */
 240               if (g_type_value_table_peek (entry.dest_type) == g_type_value_table_peek (dest_type) &&
 241                   g_type_value_table_peek (entry.src_type) == g_type_value_table_peek (src_type))
 242                 return e->func;
 243             }
 244           entry.dest_type = g_type_parent (entry.dest_type);
 245         }
 246       while (entry.dest_type);
 247
 248       entry.src_type = g_type_parent (entry.src_type);
 249     }
 250   while (entry.src_type);
 251
 252   return NULL;
 253 }
 254
 255 static gint
 256 transform_entries_cmp (gconstpointer bsearch_node1,
 257                        gconstpointer bsearch_node2)
 258 {
 259   const TransformEntry *e1 = bsearch_node1;
 260   const TransformEntry *e2 = bsearch_node2;
 261   gint cmp = G_BSEARCH_ARRAY_CMP (e1->src_type, e2->src_type);
 262
 263   if (cmp)
 264     return cmp;
 265   else
 266     return G_BSEARCH_ARRAY_CMP (e1->dest_type, e2->dest_type);
 267 }
 268
 269 void
 270 g_value_register_transform_func (GType           src_type,
 271                                  GType           dest_type,
 272                                  GValueTransform transform_func)
 273 {
 274   TransformEntry entry;
 275
 276   g_return_if_fail (G_TYPE_HAS_VALUE_TABLE (src_type));
 277   g_return_if_fail (G_TYPE_HAS_VALUE_TABLE (dest_type));
 278   g_return_if_fail (transform_func != NULL);
 279
 280   if (transform_func_lookup (src_type, dest_type))
 281     g_warning ("reregistering value transformation function (%p) for `%s' to `%s'",
 282                transform_func,
 283                g_type_name (src_type),
 284                g_type_name (dest_type));
 285   entry.src_type = src_type;
 286   entry.dest_type = dest_type;
 287   entry.func = transform_func;
 288   g_bsearch_array_insert (&transform_array, &entry, TRUE);
 289 }
 290
 291 gboolean
 292 g_value_type_transformable (GType src_type,
 293                             GType dest_type)
 294 {
 295   g_return_val_if_fail (G_TYPE_IS_VALUE (src_type), FALSE);
 296   g_return_val_if_fail (G_TYPE_IS_VALUE (dest_type), FALSE);
 297
 298   return (g_value_type_compatible (src_type, dest_type) ||
 299           transform_func_lookup (src_type, dest_type) != NULL);
 300 }
 301
 302 gboolean
 303 g_value_type_compatible (GType src_type,
 304                          GType dest_type)
 305 {
 306   g_return_val_if_fail (G_TYPE_IS_VALUE (src_type), FALSE);
 307   g_return_val_if_fail (G_TYPE_IS_VALUE (dest_type), FALSE);
 308
 309   return (g_type_is_a (src_type, dest_type) &&
 310           g_type_value_table_peek (dest_type) == g_type_value_table_peek (src_type));
 311 }
 312
 313 gboolean
 314 g_value_transform (const GValue *src_value,
 315                    GValue       *dest_value)
 316 {
 317   GType dest_type;
 318
 319   g_return_val_if_fail (G_IS_VALUE (src_value), FALSE);
 320   g_return_val_if_fail (G_IS_VALUE (dest_value), FALSE);
 321
 322   dest_type = G_VALUE_TYPE (dest_value);
 323   if (g_value_type_compatible (G_VALUE_TYPE (src_value), dest_type))
 324     {
 325       g_value_copy (src_value, dest_value);
 326
 327       return TRUE;
 328     }
 329   else
 330     {
 331       GValueTransform transform = transform_func_lookup (G_VALUE_TYPE (src_value), dest_type);
 332
 333       if (transform)
 334         {
 335           g_value_unset (dest_value);
 336
 337           /* setup and transform */
 338           value_meminit (dest_value, dest_type);
 339           transform (src_value, dest_value);
 340
 341           return TRUE;
 342         }
 343     }
 344   return FALSE;
 345 }