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