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