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