gobject/gboxed.c

   1 /* GObject - GLib Type, Object, Parameter and Signal Library
   2  * Copyright (C) 2000-2001 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 #include "config.h"
  21
  22 #include <string.h>
  23
  24 #include "gboxed.h"
  25 #include "gtype-private.h"
  26 #include "gvalue.h"
  27 #include "gvaluearray.h"
  28 #include "gclosure.h"
  29 #include "gvaluecollector.h"
  30
  31
  32 /**
  33  * SECTION:gboxed
  34  * @short_description: A mechanism to wrap opaque C structures registered
  35  *     by the type system
  36  * @see_also: #GParamSpecBoxed, g_param_spec_boxed()
  37  * @title: Boxed Types
  38  *
  39  * GBoxed is a generic wrapper mechanism for arbitrary C structures. The only
  40  * thing the type system needs to know about the structures is how to copy and
  41  * free them, beyond that they are treated as opaque chunks of memory.
  42  *
  43  * Boxed types are useful for simple value-holder structures like rectangles or
  44  * points. They can also be used for wrapping structures defined in non-GObject
  45  * based libraries.
  46  */
  47
  48 static inline void              /* keep this function in sync with gvalue.c */
  49 value_meminit (GValue *value,
  50                GType   value_type)
  51 {
  52   value->g_type = value_type;
  53   memset (value->data, 0, sizeof (value->data));
  54 }
  55
  56 static GValue *
  57 value_copy (GValue *src_value)
  58 {
  59   GValue *dest_value = g_new0 (GValue, 1);
  60
  61   if (G_VALUE_TYPE (src_value))
  62     {
  63       g_value_init (dest_value, G_VALUE_TYPE (src_value));
  64       g_value_copy (src_value, dest_value);
  65     }
  66   return dest_value;
  67 }
  68
  69 static void
  70 value_free (GValue *value)
  71 {
  72   if (G_VALUE_TYPE (value))
  73     g_value_unset (value);
  74   g_free (value);
  75 }
  76
  77 void
  78 _g_boxed_type_init (void)
  79 {
  80   static const GTypeInfo info = {
  81     0,                          /* class_size */
  82     NULL,                       /* base_init */
  83     NULL,                       /* base_destroy */
  84     NULL,                       /* class_init */
  85     NULL,                       /* class_destroy */
  86     NULL,                       /* class_data */
  87     0,                          /* instance_size */
  88     0,                          /* n_preallocs */
  89     NULL,                       /* instance_init */
  90     NULL,                       /* value_table */
  91   };
  92   const GTypeFundamentalInfo finfo = { G_TYPE_FLAG_DERIVABLE, };
  93   GType type;
  94
  95   /* G_TYPE_BOXED
  96    */
  97   type = g_type_register_fundamental (G_TYPE_BOXED, g_intern_static_string ("GBoxed"), &info, &finfo,
  98                                       G_TYPE_FLAG_ABSTRACT | G_TYPE_FLAG_VALUE_ABSTRACT);
  99   g_assert (type == G_TYPE_BOXED);
 100 }
 101
 102 static GDate *
 103 gdate_copy (GDate *date)
 104 {
 105   return g_date_new_julian (g_date_get_julian (date));
 106 }
 107
 108 static GString *
 109 gstring_copy (GString *src_gstring)
 110 {
 111   return g_string_new_len (src_gstring->str, src_gstring->len);
 112 }
 113
 114 static void
 115 gstring_free (GString *gstring)
 116 {
 117   g_string_free (gstring, TRUE);
 118 }
 119
 120 G_DEFINE_BOXED_TYPE (GClosure, g_closure, g_closure_ref, g_closure_unref)
 121 G_DEFINE_BOXED_TYPE (GValue, g_value, value_copy, value_free)
 122 G_DEFINE_BOXED_TYPE (GValueArray, g_value_array, g_value_array_copy, g_value_array_free)
 123 G_DEFINE_BOXED_TYPE (GDate, g_date, gdate_copy, g_date_free)
 124 /* the naming is a bit odd, but GString is obviously not G_TYPE_STRING */
 125 G_DEFINE_BOXED_TYPE (GString, g_gstring, gstring_copy, gstring_free)
 126 G_DEFINE_BOXED_TYPE (GHashTable, g_hash_table, g_hash_table_ref, g_hash_table_unref)
 127 G_DEFINE_BOXED_TYPE (GArray, g_array, g_array_ref, g_array_unref)
 128 G_DEFINE_BOXED_TYPE (GPtrArray, g_ptr_array,g_ptr_array_ref, g_ptr_array_unref)
 129 G_DEFINE_BOXED_TYPE (GByteArray, g_byte_array, g_byte_array_ref, g_byte_array_unref)
 130
 131 #ifdef ENABLE_REGEX
 132 G_DEFINE_BOXED_TYPE (GRegex, g_regex, g_regex_ref, g_regex_unref)
 133 #else
 134 GType g_regex_get_type (void) { return G_TYPE_INVALID; }
 135 #endif /* ENABLE_REGEX */
 136
 137 #define g_variant_type_get_type g_variant_type_get_gtype
 138 G_DEFINE_BOXED_TYPE (GVariantType, g_variant_type, g_variant_type_copy, g_variant_type_free)
 139 #undef g_variant_type_get_type
 140
 141 G_DEFINE_BOXED_TYPE (GVariantBuilder, g_variant_builder, g_variant_builder_ref, g_variant_builder_unref)
 142
 143 G_DEFINE_BOXED_TYPE (GError, g_error, g_error_copy, g_error_free)
 144
 145 G_DEFINE_BOXED_TYPE (GDateTime, g_date_time, g_date_time_ref, g_date_time_unref);
 146
 147 /* This one can't use G_DEFINE_BOXED_TYPE (GStrv, g_strv, g_strdupv, g_strfreev) */
 148 GType
 149 g_strv_get_type (void)
 150 {
 151   static volatile gsize g_define_type_id__volatile = 0;
 152
 153   if (g_once_init_enter (&g_define_type_id__volatile))
 154     {
 155       GType g_define_type_id =
 156         g_boxed_type_register_static (g_intern_static_string ("GStrv"),
 157                                       (GBoxedCopyFunc) g_strdupv,
 158                                       (GBoxedFreeFunc) g_strfreev);
 159
 160       g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
 161     }
 162
 163   return g_define_type_id__volatile;
 164 }
 165
 166 /**
 167  * g_variant_get_gtype:
 168  *
 169  * Since: 2.24
 170  * Deprecated: 2.26
 171  */
 172 GType
 173 g_variant_get_gtype (void)
 174 {
 175   return G_TYPE_VARIANT;
 176 }
 177
 178 static void
 179 boxed_proxy_value_init (GValue *value)
 180 {
 181   value->data[0].v_pointer = NULL;
 182 }
 183
 184 static void
 185 boxed_proxy_value_free (GValue *value)
 186 {
 187   if (value->data[0].v_pointer && !(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
 188     _g_type_boxed_free (G_VALUE_TYPE (value), value->data[0].v_pointer);
 189 }
 190
 191 static void
 192 boxed_proxy_value_copy (const GValue *src_value,
 193                         GValue       *dest_value)
 194 {
 195   if (src_value->data[0].v_pointer)
 196     dest_value->data[0].v_pointer = _g_type_boxed_copy (G_VALUE_TYPE (src_value), src_value->data[0].v_pointer);
 197   else
 198     dest_value->data[0].v_pointer = src_value->data[0].v_pointer;
 199 }
 200
 201 static gpointer
 202 boxed_proxy_value_peek_pointer (const GValue *value)
 203 {
 204   return value->data[0].v_pointer;
 205 }
 206
 207 static gchar*
 208 boxed_proxy_collect_value (GValue      *value,
 209                            guint        n_collect_values,
 210                            GTypeCValue *collect_values,
 211                            guint        collect_flags)
 212 {
 213   if (!collect_values[0].v_pointer)
 214     value->data[0].v_pointer = NULL;
 215   else
 216     {
 217       if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
 218         {
 219           value->data[0].v_pointer = collect_values[0].v_pointer;
 220           value->data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
 221         }
 222       else
 223         value->data[0].v_pointer = _g_type_boxed_copy (G_VALUE_TYPE (value), collect_values[0].v_pointer);
 224     }
 225
 226   return NULL;
 227 }
 228
 229 static gchar*
 230 boxed_proxy_lcopy_value (const GValue *value,
 231                          guint         n_collect_values,
 232                          GTypeCValue  *collect_values,
 233                          guint         collect_flags)
 234 {
 235   gpointer *boxed_p = collect_values[0].v_pointer;
 236
 237   if (!boxed_p)
 238     return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
 239
 240   if (!value->data[0].v_pointer)
 241     *boxed_p = NULL;
 242   else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
 243     *boxed_p = value->data[0].v_pointer;
 244   else
 245     *boxed_p = _g_type_boxed_copy (G_VALUE_TYPE (value), value->data[0].v_pointer);
 246
 247   return NULL;
 248 }
 249
 250 /**
 251  * g_boxed_type_register_static:
 252  * @name: Name of the new boxed type.
 253  * @boxed_copy: Boxed structure copy function.
 254  * @boxed_free: Boxed structure free function.
 255  *
 256  * This function creates a new %G_TYPE_BOXED derived type id for a new
 257  * boxed type with name @name. Boxed type handling functions have to be
 258  * provided to copy and free opaque boxed structures of this type.
 259  *
 260  * Returns: New %G_TYPE_BOXED derived type id for @name.
 261  */
 262 GType
 263 g_boxed_type_register_static (const gchar   *name,
 264                               GBoxedCopyFunc boxed_copy,
 265                               GBoxedFreeFunc boxed_free)
 266 {
 267   static const GTypeValueTable vtable = {
 268     boxed_proxy_value_init,
 269     boxed_proxy_value_free,
 270     boxed_proxy_value_copy,
 271     boxed_proxy_value_peek_pointer,
 272     "p",
 273     boxed_proxy_collect_value,
 274     "p",
 275     boxed_proxy_lcopy_value,
 276   };
 277   GTypeInfo type_info = {
 278     0,                  /* class_size */
 279     NULL,               /* base_init */
 280     NULL,               /* base_finalize */
 281     NULL,               /* class_init */
 282     NULL,               /* class_finalize */
 283     NULL,               /* class_data */
 284     0,                  /* instance_size */
 285     0,                  /* n_preallocs */
 286     NULL,               /* instance_init */
 287     &vtable,            /* value_table */
 288   };
 289   GType type;
 290
 291   g_return_val_if_fail (name != NULL, 0);
 292   g_return_val_if_fail (boxed_copy != NULL, 0);
 293   g_return_val_if_fail (boxed_free != NULL, 0);
 294   g_return_val_if_fail (g_type_from_name (name) == 0, 0);
 295
 296   type = g_type_register_static (G_TYPE_BOXED, name, &type_info, 0);
 297
 298   /* install proxy functions upon successfull registration */
 299   if (type)
 300     _g_type_boxed_init (type, boxed_copy, boxed_free);
 301
 302   return type;
 303 }
 304
 305 /**
 306  * g_boxed_copy:
 307  * @boxed_type: The type of @src_boxed.
 308  * @src_boxed: The boxed structure to be copied.
 309  *
 310  * Provide a copy of a boxed structure @src_boxed which is of type @boxed_type.
 311  *
 312  * Returns: The newly created copy of the boxed structure.
 313  */
 314 gpointer
 315 g_boxed_copy (GType         boxed_type,
 316               gconstpointer src_boxed)
 317 {
 318   GTypeValueTable *value_table;
 319   gpointer dest_boxed;
 320
 321   g_return_val_if_fail (G_TYPE_IS_BOXED (boxed_type), NULL);
 322   g_return_val_if_fail (G_TYPE_IS_ABSTRACT (boxed_type) == FALSE, NULL);
 323   g_return_val_if_fail (src_boxed != NULL, NULL);
 324
 325   value_table = g_type_value_table_peek (boxed_type);
 326   if (!value_table)
 327     g_return_val_if_fail (G_TYPE_IS_VALUE_TYPE (boxed_type), NULL);
 328
 329   /* check if our proxying implementation is used, we can short-cut here */
 330   if (value_table->value_copy == boxed_proxy_value_copy)
 331     dest_boxed = _g_type_boxed_copy (boxed_type, (gpointer) src_boxed);
 332   else
 333     {
 334       GValue src_value, dest_value;
 335
 336       /* we heavily rely on third-party boxed type value vtable
 337        * implementations to follow normal boxed value storage
 338        * (data[0].v_pointer is the boxed struct, and
 339        * data[1].v_uint holds the G_VALUE_NOCOPY_CONTENTS flag,
 340        * rest zero).
 341        * but then, we can expect that since we layed out the
 342        * g_boxed_*() API.
 343        * data[1].v_uint&G_VALUE_NOCOPY_CONTENTS shouldn't be set
 344        * after a copy.
 345        */
 346       /* equiv. to g_value_set_static_boxed() */
 347       value_meminit (&src_value, boxed_type);
 348       src_value.data[0].v_pointer = (gpointer) src_boxed;
 349       src_value.data[1].v_uint = G_VALUE_NOCOPY_CONTENTS;
 350
 351       /* call third-party code copy function, fingers-crossed */
 352       value_meminit (&dest_value, boxed_type);
 353       value_table->value_copy (&src_value, &dest_value);
 354
 355       /* double check and grouse if things went wrong */
 356       if (dest_value.data[1].v_ulong)
 357         g_warning ("the copy_value() implementation of type `%s' seems to make use of reserved GValue fields",
 358                    g_type_name (boxed_type));
 359
 360       dest_boxed = dest_value.data[0].v_pointer;
 361     }
 362
 363   return dest_boxed;
 364 }
 365
 366 /**
 367  * g_boxed_free:
 368  * @boxed_type: The type of @boxed.
 369  * @boxed: The boxed structure to be freed.
 370  *
 371  * Free the boxed structure @boxed which is of type @boxed_type.
 372  */
 373 void
 374 g_boxed_free (GType    boxed_type,
 375               gpointer boxed)
 376 {
 377   GTypeValueTable *value_table;
 378
 379   g_return_if_fail (G_TYPE_IS_BOXED (boxed_type));
 380   g_return_if_fail (G_TYPE_IS_ABSTRACT (boxed_type) == FALSE);
 381   g_return_if_fail (boxed != NULL);
 382
 383   value_table = g_type_value_table_peek (boxed_type);
 384   if (!value_table)
 385     g_return_if_fail (G_TYPE_IS_VALUE_TYPE (boxed_type));
 386
 387   /* check if our proxying implementation is used, we can short-cut here */
 388   if (value_table->value_free == boxed_proxy_value_free)
 389     _g_type_boxed_free (boxed_type, boxed);
 390   else
 391     {
 392       GValue value;
 393
 394       /* see g_boxed_copy() on why we think we can do this */
 395       value_meminit (&value, boxed_type);
 396       value.data[0].v_pointer = boxed;
 397       value_table->value_free (&value);
 398     }
 399 }
 400
 401 /**
 402  * g_value_get_boxed:
 403  * @value: a valid #GValue of %G_TYPE_BOXED derived type
 404  *
 405  * Get the contents of a %G_TYPE_BOXED derived #GValue.
 406  *
 407  * Returns: (transfer none): boxed contents of @value
 408  */
 409 gpointer
 410 g_value_get_boxed (const GValue *value)
 411 {
 412   g_return_val_if_fail (G_VALUE_HOLDS_BOXED (value), NULL);
 413   g_return_val_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)), NULL);
 414
 415   return value->data[0].v_pointer;
 416 }
 417
 418 /**
 419  * g_value_dup_boxed: (skip)
 420  * @value: a valid #GValue of %G_TYPE_BOXED derived type
 421  *
 422  * Get the contents of a %G_TYPE_BOXED derived #GValue.  Upon getting,
 423  * the boxed value is duplicated and needs to be later freed with
 424  * g_boxed_free(), e.g. like: g_boxed_free (G_VALUE_TYPE (@value),
 425  * return_value);
 426  *
 427  * Returns: boxed contents of @value
 428  */
 429 gpointer
 430 g_value_dup_boxed (const GValue *value)
 431 {
 432   g_return_val_if_fail (G_VALUE_HOLDS_BOXED (value), NULL);
 433   g_return_val_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)), NULL);
 434
 435   return value->data[0].v_pointer ? g_boxed_copy (G_VALUE_TYPE (value), value->data[0].v_pointer) : NULL;
 436 }
 437
 438 static inline void
 439 value_set_boxed_internal (GValue       *value,
 440                           gconstpointer boxed,
 441                           gboolean      need_copy,
 442                           gboolean      need_free)
 443 {
 444   if (!boxed)
 445     {
 446       /* just resetting to NULL might not be desired, need to
 447        * have value reinitialized also (for values defaulting
 448        * to other default value states than a NULL data pointer),
 449        * g_value_reset() will handle this
 450        */
 451       g_value_reset (value);
 452       return;
 453     }
 454
 455   if (value->data[0].v_pointer && !(value->data[1].v_uint & G_VALUE_NOCOPY_CONTENTS))
 456     g_boxed_free (G_VALUE_TYPE (value), value->data[0].v_pointer);
 457   value->data[1].v_uint = need_free ? 0 : G_VALUE_NOCOPY_CONTENTS;
 458   value->data[0].v_pointer = need_copy ? g_boxed_copy (G_VALUE_TYPE (value), boxed) : (gpointer) boxed;
 459 }
 460
 461 /**
 462  * g_value_set_boxed:
 463  * @value: a valid #GValue of %G_TYPE_BOXED derived type
 464  * @v_boxed: boxed value to be set
 465  *
 466  * Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
 467  */
 468 void
 469 g_value_set_boxed (GValue       *value,
 470                    gconstpointer boxed)
 471 {
 472   g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
 473   g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));
 474
 475   value_set_boxed_internal (value, boxed, TRUE, TRUE);
 476 }
 477
 478 /**
 479  * g_value_set_static_boxed:
 480  * @value: a valid #GValue of %G_TYPE_BOXED derived type
 481  * @v_boxed: static boxed value to be set
 482  *
 483  * Set the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed.
 484  * The boxed value is assumed to be static, and is thus not duplicated
 485  * when setting the #GValue.
 486  */
 487 void
 488 g_value_set_static_boxed (GValue       *value,
 489                           gconstpointer boxed)
 490 {
 491   g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
 492   g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));
 493
 494   value_set_boxed_internal (value, boxed, FALSE, FALSE);
 495 }
 496
 497 /**
 498  * g_value_set_boxed_take_ownership:
 499  * @value: a valid #GValue of %G_TYPE_BOXED derived type
 500  * @v_boxed: duplicated unowned boxed value to be set
 501  *
 502  * This is an internal function introduced mainly for C marshallers.
 503  *
 504  * Deprecated: 2.4: Use g_value_take_boxed() instead.
 505  */
 506 void
 507 g_value_set_boxed_take_ownership (GValue       *value,
 508                                   gconstpointer boxed)
 509 {
 510   g_value_take_boxed (value, boxed);
 511 }
 512
 513 /**
 514  * g_value_take_boxed:
 515  * @value: a valid #GValue of %G_TYPE_BOXED derived type
 516  * @v_boxed: duplicated unowned boxed value to be set
 517  *
 518  * Sets the contents of a %G_TYPE_BOXED derived #GValue to @v_boxed
 519  * and takes over the ownership of the callers reference to @v_boxed;
 520  * the caller doesn't have to unref it any more.
 521  *
 522  * Since: 2.4
 523  */
 524 void
 525 g_value_take_boxed (GValue       *value,
 526                     gconstpointer boxed)
 527 {
 528   g_return_if_fail (G_VALUE_HOLDS_BOXED (value));
 529   g_return_if_fail (G_TYPE_IS_VALUE (G_VALUE_TYPE (value)));
 530
 531   value_set_boxed_internal (value, boxed, FALSE, TRUE);
 532 }