gobject/gparam.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  * MT safe
  22  */
  23
  24 #include "config.h"
  25
  26 #include <string.h>
  27
  28 #include "gparam.h"
  29 #include "gparamspecs.h"
  30 #include "gvaluecollector.h"
  31
  32
  33 /**
  34  * SECTION:gparamspec
  35  * @short_description: Metadata for parameter specifications
  36  * @see_also: g_object_class_install_property(), g_object_set(),
  37  *     g_object_get(), g_object_set_property(), g_object_get_property(),
  38  *     g_value_register_transform_func()
  39  * @title: GParamSpec
  40  *
  41  * #GParamSpec is an object structure that encapsulates the metadata
  42  * required to specify parameters, such as e.g. #GObject properties.
  43  *
  44  * <para id="canonical-parameter-name">
  45  * Parameter names need to start with a letter (a-z or A-Z). Subsequent
  46  * characters can be letters, numbers or a '-'.
  47  * All other characters are replaced by a '-' during construction.
  48  * The result of this replacement is called the canonical name of the
  49  * parameter.
  50  * </para>
  51  */
  52
  53
  54 /* --- defines --- */
  55 #define PARAM_FLOATING_FLAG                     0x2
  56 #define G_PARAM_USER_MASK                       (~0 << G_PARAM_USER_SHIFT)
  57 #define PSPEC_APPLIES_TO_VALUE(pspec, value)    (G_TYPE_CHECK_VALUE_TYPE ((value), G_PARAM_SPEC_VALUE_TYPE (pspec)))
  58 #define G_SLOCK(mutex)                          g_static_mutex_lock (mutex)
  59 #define G_SUNLOCK(mutex)                        g_static_mutex_unlock (mutex)
  60
  61
  62 /* --- prototypes --- */
  63 static void     g_param_spec_class_base_init     (GParamSpecClass       *class);
  64 static void     g_param_spec_class_base_finalize (GParamSpecClass       *class);
  65 static void     g_param_spec_class_init          (GParamSpecClass       *class,
  66                                                   gpointer               class_data);
  67 static void     g_param_spec_init                (GParamSpec            *pspec,
  68                                                   GParamSpecClass       *class);
  69 static void     g_param_spec_finalize            (GParamSpec            *pspec);
  70 static void     value_param_init                (GValue         *value);
  71 static void     value_param_free_value          (GValue         *value);
  72 static void     value_param_copy_value          (const GValue   *src_value,
  73                                                  GValue         *dest_value);
  74 static void     value_param_transform_value     (const GValue   *src_value,
  75                                                  GValue         *dest_value);
  76 static gpointer value_param_peek_pointer        (const GValue   *value);
  77 static gchar*   value_param_collect_value       (GValue         *value,
  78                                                  guint           n_collect_values,
  79                                                  GTypeCValue    *collect_values,
  80                                                  guint           collect_flags);
  81 static gchar*   value_param_lcopy_value         (const GValue   *value,
  82                                                  guint           n_collect_values,
  83                                                  GTypeCValue    *collect_values,
  84                                                  guint           collect_flags);
  85
  86
  87 /* --- functions --- */
  88 void
  89 _g_param_type_init (void)
  90 {
  91   static const GTypeFundamentalInfo finfo = {
  92     (G_TYPE_FLAG_CLASSED |
  93      G_TYPE_FLAG_INSTANTIATABLE |
  94      G_TYPE_FLAG_DERIVABLE |
  95      G_TYPE_FLAG_DEEP_DERIVABLE),
  96   };
  97   static const GTypeValueTable param_value_table = {
  98     value_param_init,           /* value_init */
  99     value_param_free_value,     /* value_free */
 100     value_param_copy_value,     /* value_copy */
 101     value_param_peek_pointer,   /* value_peek_pointer */
 102     "p",                        /* collect_format */
 103     value_param_collect_value,  /* collect_value */
 104     "p",                        /* lcopy_format */
 105     value_param_lcopy_value,    /* lcopy_value */
 106   };
 107   static const GTypeInfo param_spec_info = {
 108     sizeof (GParamSpecClass),
 109
 110     (GBaseInitFunc) g_param_spec_class_base_init,
 111     (GBaseFinalizeFunc) g_param_spec_class_base_finalize,
 112     (GClassInitFunc) g_param_spec_class_init,
 113     (GClassFinalizeFunc) NULL,
 114     NULL,       /* class_data */
 115
 116     sizeof (GParamSpec),
 117     0,          /* n_preallocs */
 118     (GInstanceInitFunc) g_param_spec_init,
 119
 120     &param_value_table,
 121   };
 122   GType type;
 123
 124   /* This should be registred as GParamSpec instead of GParam, for
 125    * consistency sake, so that type name can be mapped to struct name,
 126    * However, some language bindings, most noticable the python ones
 127    * depends on the "GParam" identifier, see #548689
 128    */
 129   type = g_type_register_fundamental (G_TYPE_PARAM, g_intern_static_string ("GParam"), &param_spec_info, &finfo, G_TYPE_FLAG_ABSTRACT);
 130   g_assert (type == G_TYPE_PARAM);
 131   g_value_register_transform_func (G_TYPE_PARAM, G_TYPE_PARAM, value_param_transform_value);
 132 }
 133
 134 static void
 135 g_param_spec_class_base_init (GParamSpecClass *class)
 136 {
 137 }
 138
 139 static void
 140 g_param_spec_class_base_finalize (GParamSpecClass *class)
 141 {
 142 }
 143
 144 static void
 145 g_param_spec_class_init (GParamSpecClass *class,
 146                          gpointer         class_data)
 147 {
 148   class->value_type = G_TYPE_NONE;
 149   class->finalize = g_param_spec_finalize;
 150   class->value_set_default = NULL;
 151   class->value_validate = NULL;
 152   class->values_cmp = NULL;
 153 }
 154
 155 static void
 156 g_param_spec_init (GParamSpec      *pspec,
 157                    GParamSpecClass *class)
 158 {
 159   pspec->name = NULL;
 160   pspec->_nick = NULL;
 161   pspec->_blurb = NULL;
 162   pspec->flags = 0;
 163   pspec->value_type = class->value_type;
 164   pspec->owner_type = 0;
 165   pspec->qdata = NULL;
 166   g_datalist_set_flags (&pspec->qdata, PARAM_FLOATING_FLAG);
 167   pspec->ref_count = 1;
 168   pspec->param_id = 0;
 169 }
 170
 171 static void
 172 g_param_spec_finalize (GParamSpec *pspec)
 173 {
 174   g_datalist_clear (&pspec->qdata);
 175
 176   if (!(pspec->flags & G_PARAM_STATIC_NAME))
 177     g_free (pspec->name);
 178
 179   if (!(pspec->flags & G_PARAM_STATIC_NICK))
 180     g_free (pspec->_nick);
 181
 182   if (!(pspec->flags & G_PARAM_STATIC_BLURB))
 183     g_free (pspec->_blurb);
 184
 185   g_type_free_instance ((GTypeInstance*) pspec);
 186 }
 187
 188 /**
 189  * g_param_spec_ref: (skip)
 190  * @pspec: a valid #GParamSpec
 191  *
 192  * Increments the reference count of @pspec.
 193  *
 194  * Returns: the #GParamSpec that was passed into this function
 195  */
 196 GParamSpec*
 197 g_param_spec_ref (GParamSpec *pspec)
 198 {
 199   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
 200
 201   g_atomic_int_inc ((int *)&pspec->ref_count);
 202
 203   return pspec;
 204 }
 205
 206 /**
 207  * g_param_spec_unref: (skip)
 208  * @pspec: a valid #GParamSpec
 209  *
 210  * Decrements the reference count of a @pspec.
 211  */
 212 void
 213 g_param_spec_unref (GParamSpec *pspec)
 214 {
 215   gboolean is_zero;
 216
 217   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
 218
 219   is_zero = g_atomic_int_dec_and_test ((int *)&pspec->ref_count);
 220
 221   if (G_UNLIKELY (is_zero))
 222     {
 223       G_PARAM_SPEC_GET_CLASS (pspec)->finalize (pspec);
 224     }
 225 }
 226
 227 /**
 228  * g_param_spec_sink:
 229  * @pspec: a valid #GParamSpec
 230  *
 231  * The initial reference count of a newly created #GParamSpec is 1,
 232  * even though no one has explicitly called g_param_spec_ref() on it
 233  * yet. So the initial reference count is flagged as "floating", until
 234  * someone calls <literal>g_param_spec_ref (pspec); g_param_spec_sink
 235  * (pspec);</literal> in sequence on it, taking over the initial
 236  * reference count (thus ending up with a @pspec that has a reference
 237  * count of 1 still, but is not flagged "floating" anymore).
 238  */
 239 void
 240 g_param_spec_sink (GParamSpec *pspec)
 241 {
 242   gsize oldvalue;
 243   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
 244
 245   oldvalue = g_atomic_pointer_and (&pspec->qdata, ~(gsize)PARAM_FLOATING_FLAG);
 246   if (oldvalue & PARAM_FLOATING_FLAG)
 247     g_param_spec_unref (pspec);
 248 }
 249
 250 /**
 251  * g_param_spec_ref_sink: (skip)
 252  * @pspec: a valid #GParamSpec
 253  *
 254  * Convenience function to ref and sink a #GParamSpec.
 255  *
 256  * Since: 2.10
 257  * Returns: the #GParamSpec that was passed into this function
 258  */
 259 GParamSpec*
 260 g_param_spec_ref_sink (GParamSpec *pspec)
 261 {
 262   gsize oldvalue;
 263   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
 264
 265   oldvalue = g_atomic_pointer_and (&pspec->qdata, ~(gsize)PARAM_FLOATING_FLAG);
 266   if (!(oldvalue & PARAM_FLOATING_FLAG))
 267     g_param_spec_ref (pspec);
 268
 269   return pspec;
 270 }
 271
 272 /**
 273  * g_param_spec_get_name:
 274  * @pspec: a valid #GParamSpec
 275  *
 276  * Get the name of a #GParamSpec.
 277  *
 278  * Returns: the name of @pspec.
 279  */
 280 const gchar *
 281 g_param_spec_get_name (GParamSpec *pspec)
 282 {
 283   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
 284
 285   return pspec->name;
 286 }
 287
 288 /**
 289  * g_param_spec_get_nick:
 290  * @pspec: a valid #GParamSpec
 291  *
 292  * Get the nickname of a #GParamSpec.
 293  *
 294  * Returns: the nickname of @pspec.
 295  */
 296 const gchar *
 297 g_param_spec_get_nick (GParamSpec *pspec)
 298 {
 299   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
 300
 301   if (pspec->_nick)
 302     return pspec->_nick;
 303   else
 304     {
 305       GParamSpec *redirect_target;
 306
 307       redirect_target = g_param_spec_get_redirect_target (pspec);
 308       if (redirect_target && redirect_target->_nick)
 309         return redirect_target->_nick;
 310     }
 311
 312   return pspec->name;
 313 }
 314
 315 /**
 316  * g_param_spec_get_blurb:
 317  * @pspec: a valid #GParamSpec
 318  *
 319  * Get the short description of a #GParamSpec.
 320  *
 321  * Returns: the short description of @pspec.
 322  */
 323 const gchar *
 324 g_param_spec_get_blurb (GParamSpec *pspec)
 325 {
 326   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
 327
 328   if (pspec->_blurb)
 329     return pspec->_blurb;
 330   else
 331     {
 332       GParamSpec *redirect_target;
 333
 334       redirect_target = g_param_spec_get_redirect_target (pspec);
 335       if (redirect_target && redirect_target->_blurb)
 336         return redirect_target->_blurb;
 337     }
 338
 339   return NULL;
 340 }
 341
 342 static void
 343 canonicalize_key (gchar *key)
 344 {
 345   gchar *p;
 346
 347   for (p = key; *p != 0; p++)
 348     {
 349       gchar c = *p;
 350
 351       if (c != '-' &&
 352           (c < '0' || c > '9') &&
 353           (c < 'A' || c > 'Z') &&
 354           (c < 'a' || c > 'z'))
 355         *p = '-';
 356     }
 357 }
 358
 359 static gboolean
 360 is_canonical (const gchar *key)
 361 {
 362   const gchar *p;
 363
 364   for (p = key; *p != 0; p++)
 365     {
 366       gchar c = *p;
 367
 368       if (c != '-' &&
 369           (c < '0' || c > '9') &&
 370           (c < 'A' || c > 'Z') &&
 371           (c < 'a' || c > 'z'))
 372         return FALSE;
 373     }
 374
 375   return TRUE;
 376 }
 377
 378 /**
 379  * g_param_spec_internal: (skip)
 380  * @param_type: the #GType for the property; must be derived from #G_TYPE_PARAM
 381  * @name: the canonical name of the property
 382  * @nick: the nickname of the property
 383  * @blurb: a short description of the property
 384  * @flags: a combination of #GParamFlags
 385  *
 386  * Creates a new #GParamSpec instance.
 387  *
 388  * A property name consists of segments consisting of ASCII letters and
 389  * digits, separated by either the '-' or '_' character. The first
 390  * character of a property name must be a letter. Names which violate these
 391  * rules lead to undefined behaviour.
 392  *
 393  * When creating and looking up a #GParamSpec, either separator can be
 394  * used, but they cannot be mixed. Using '-' is considerably more
 395  * efficient and in fact required when using property names as detail
 396  * strings for signals.
 397  *
 398  * Beyond the name, #GParamSpec<!-- -->s have two more descriptive
 399  * strings associated with them, the @nick, which should be suitable
 400  * for use as a label for the property in a property editor, and the
 401  * @blurb, which should be a somewhat longer description, suitable for
 402  * e.g. a tooltip. The @nick and @blurb should ideally be localized.
 403  *
 404  * Returns: a newly allocated #GParamSpec instance
 405  */
 406 gpointer
 407 g_param_spec_internal (GType        param_type,
 408                        const gchar *name,
 409                        const gchar *nick,
 410                        const gchar *blurb,
 411                        GParamFlags  flags)
 412 {
 413   GParamSpec *pspec;
 414
 415   g_return_val_if_fail (G_TYPE_IS_PARAM (param_type) && param_type != G_TYPE_PARAM, NULL);
 416   g_return_val_if_fail (name != NULL, NULL);
 417   g_return_val_if_fail ((name[0] >= 'A' && name[0] <= 'Z') || (name[0] >= 'a' && name[0] <= 'z'), NULL);
 418   g_return_val_if_fail (!(flags & G_PARAM_STATIC_NAME) || is_canonical (name), NULL);
 419
 420   pspec = (gpointer) g_type_create_instance (param_type);
 421
 422   if (flags & G_PARAM_STATIC_NAME)
 423     {
 424       /* pspec->name is not freed if (flags & G_PARAM_STATIC_NAME) */
 425       pspec->name = (gchar *) g_intern_static_string (name);
 426       if (!is_canonical (pspec->name))
 427         g_warning ("G_PARAM_STATIC_NAME used with non-canonical pspec name: %s", pspec->name);
 428     }
 429   else
 430     {
 431       pspec->name = g_strdup (name);
 432       canonicalize_key (pspec->name);
 433       g_intern_string (pspec->name);
 434     }
 435
 436   if (flags & G_PARAM_STATIC_NICK)
 437     pspec->_nick = (gchar*) nick;
 438   else
 439     pspec->_nick = g_strdup (nick);
 440
 441   if (flags & G_PARAM_STATIC_BLURB)
 442     pspec->_blurb = (gchar*) blurb;
 443   else
 444     pspec->_blurb = g_strdup (blurb);
 445
 446   pspec->flags = (flags & G_PARAM_USER_MASK) | (flags & G_PARAM_MASK);
 447
 448   return pspec;
 449 }
 450
 451 /**
 452  * g_param_spec_get_qdata:
 453  * @pspec: a valid #GParamSpec
 454  * @quark: a #GQuark, naming the user data pointer
 455  *
 456  * Gets back user data pointers stored via g_param_spec_set_qdata().
 457  *
 458  * Returns: (transfer none): the user data pointer set, or %NULL
 459  */
 460 gpointer
 461 g_param_spec_get_qdata (GParamSpec *pspec,
 462                         GQuark      quark)
 463 {
 464   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
 465
 466   return quark ? g_datalist_id_get_data (&pspec->qdata, quark) : NULL;
 467 }
 468
 469 /**
 470  * g_param_spec_set_qdata:
 471  * @pspec: the #GParamSpec to set store a user data pointer
 472  * @quark: a #GQuark, naming the user data pointer
 473  * @data: an opaque user data pointer
 474  *
 475  * Sets an opaque, named pointer on a #GParamSpec. The name is
 476  * specified through a #GQuark (retrieved e.g. via
 477  * g_quark_from_static_string()), and the pointer can be gotten back
 478  * from the @pspec with g_param_spec_get_qdata().  Setting a
 479  * previously set user data pointer, overrides (frees) the old pointer
 480  * set, using %NULL as pointer essentially removes the data stored.
 481  */
 482 void
 483 g_param_spec_set_qdata (GParamSpec *pspec,
 484                         GQuark      quark,
 485                         gpointer    data)
 486 {
 487   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
 488   g_return_if_fail (quark > 0);
 489
 490   g_datalist_id_set_data (&pspec->qdata, quark, data);
 491 }
 492
 493 /**
 494  * g_param_spec_set_qdata_full: (skip)
 495  * @pspec: the #GParamSpec to set store a user data pointer
 496  * @quark: a #GQuark, naming the user data pointer
 497  * @data: an opaque user data pointer
 498  * @destroy: function to invoke with @data as argument, when @data needs to
 499  *  be freed
 500  *
 501  * This function works like g_param_spec_set_qdata(), but in addition,
 502  * a <literal>void (*destroy) (gpointer)</literal> function may be
 503  * specified which is called with @data as argument when the @pspec is
 504  * finalized, or the data is being overwritten by a call to
 505  * g_param_spec_set_qdata() with the same @quark.
 506  */
 507 void
 508 g_param_spec_set_qdata_full (GParamSpec    *pspec,
 509                              GQuark         quark,
 510                              gpointer       data,
 511                              GDestroyNotify destroy)
 512 {
 513   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
 514   g_return_if_fail (quark > 0);
 515
 516   g_datalist_id_set_data_full (&pspec->qdata, quark, data, data ? destroy : (GDestroyNotify) NULL);
 517 }
 518
 519 /**
 520  * g_param_spec_steal_qdata:
 521  * @pspec: the #GParamSpec to get a stored user data pointer from
 522  * @quark: a #GQuark, naming the user data pointer
 523  *
 524  * Gets back user data pointers stored via g_param_spec_set_qdata()
 525  * and removes the @data from @pspec without invoking its destroy()
 526  * function (if any was set).  Usually, calling this function is only
 527  * required to update user data pointers with a destroy notifier.
 528  *
 529  * Returns: (transfer none): the user data pointer set, or %NULL
 530  */
 531 gpointer
 532 g_param_spec_steal_qdata (GParamSpec *pspec,
 533                           GQuark      quark)
 534 {
 535   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
 536   g_return_val_if_fail (quark > 0, NULL);
 537
 538   return g_datalist_id_remove_no_notify (&pspec->qdata, quark);
 539 }
 540
 541 /**
 542  * g_param_spec_get_redirect_target:
 543  * @pspec: a #GParamSpec
 544  *
 545  * If the paramspec redirects operations to another paramspec,
 546  * returns that paramspec. Redirect is used typically for
 547  * providing a new implementation of a property in a derived
 548  * type while preserving all the properties from the parent
 549  * type. Redirection is established by creating a property
 550  * of type #GParamSpecOverride. See g_object_class_override_property()
 551  * for an example of the use of this capability.
 552  *
 553  * Since: 2.4
 554  *
 555  * Returns: (transfer none): paramspec to which requests on this
 556  *          paramspec should be redirected, or %NULL if none.
 557  */
 558 GParamSpec*
 559 g_param_spec_get_redirect_target (GParamSpec *pspec)
 560 {
 561   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
 562
 563   if (G_IS_PARAM_SPEC_OVERRIDE (pspec))
 564     {
 565       GParamSpecOverride *ospec = G_PARAM_SPEC_OVERRIDE (pspec);
 566
 567       return ospec->overridden;
 568     }
 569   else
 570     return NULL;
 571 }
 572
 573 /**
 574  * g_param_value_set_default:
 575  * @pspec: a valid #GParamSpec
 576  * @value: a #GValue of correct type for @pspec
 577  *
 578  * Sets @value to its default value as specified in @pspec.
 579  */
 580 void
 581 g_param_value_set_default (GParamSpec *pspec,
 582                            GValue     *value)
 583 {
 584   g_return_if_fail (G_IS_PARAM_SPEC (pspec));
 585   g_return_if_fail (G_IS_VALUE (value));
 586   g_return_if_fail (PSPEC_APPLIES_TO_VALUE (pspec, value));
 587
 588   g_value_reset (value);
 589   G_PARAM_SPEC_GET_CLASS (pspec)->value_set_default (pspec, value);
 590 }
 591
 592 /**
 593  * g_param_value_defaults:
 594  * @pspec: a valid #GParamSpec
 595  * @value: a #GValue of correct type for @pspec
 596  *
 597  * Checks whether @value contains the default value as specified in @pspec.
 598  *
 599  * Returns: whether @value contains the canonical default for this @pspec
 600  */
 601 gboolean
 602 g_param_value_defaults (GParamSpec *pspec,
 603                         GValue     *value)
 604 {
 605   GValue dflt_value = { 0, };
 606   gboolean defaults;
 607
 608   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
 609   g_return_val_if_fail (G_IS_VALUE (value), FALSE);
 610   g_return_val_if_fail (PSPEC_APPLIES_TO_VALUE (pspec, value), FALSE);
 611
 612   g_value_init (&dflt_value, G_PARAM_SPEC_VALUE_TYPE (pspec));
 613   G_PARAM_SPEC_GET_CLASS (pspec)->value_set_default (pspec, &dflt_value);
 614   defaults = G_PARAM_SPEC_GET_CLASS (pspec)->values_cmp (pspec, value, &dflt_value) == 0;
 615   g_value_unset (&dflt_value);
 616
 617   return defaults;
 618 }
 619
 620 /**
 621  * g_param_value_validate:
 622  * @pspec: a valid #GParamSpec
 623  * @value: a #GValue of correct type for @pspec
 624  *
 625  * Ensures that the contents of @value comply with the specifications
 626  * set out by @pspec. For example, a #GParamSpecInt might require
 627  * that integers stored in @value may not be smaller than -42 and not be
 628  * greater than +42. If @value contains an integer outside of this range,
 629  * it is modified accordingly, so the resulting value will fit into the
 630  * range -42 .. +42.
 631  *
 632  * Returns: whether modifying @value was necessary to ensure validity
 633  */
 634 gboolean
 635 g_param_value_validate (GParamSpec *pspec,
 636                         GValue     *value)
 637 {
 638   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
 639   g_return_val_if_fail (G_IS_VALUE (value), FALSE);
 640   g_return_val_if_fail (PSPEC_APPLIES_TO_VALUE (pspec, value), FALSE);
 641
 642   if (G_PARAM_SPEC_GET_CLASS (pspec)->value_validate)
 643     {
 644       GValue oval = *value;
 645
 646       if (G_PARAM_SPEC_GET_CLASS (pspec)->value_validate (pspec, value) ||
 647           memcmp (&oval.data, &value->data, sizeof (oval.data)))
 648         return TRUE;
 649     }
 650
 651   return FALSE;
 652 }
 653
 654 /**
 655  * g_param_value_convert:
 656  * @pspec: a valid #GParamSpec
 657  * @src_value: souce #GValue
 658  * @dest_value: destination #GValue of correct type for @pspec
 659  * @strict_validation: %TRUE requires @dest_value to conform to @pspec
 660  * without modifications
 661  *
 662  * Transforms @src_value into @dest_value if possible, and then
 663  * validates @dest_value, in order for it to conform to @pspec.  If
 664  * @strict_validation is %TRUE this function will only succeed if the
 665  * transformed @dest_value complied to @pspec without modifications.
 666  *
 667  * See also g_value_type_transformable(), g_value_transform() and
 668  * g_param_value_validate().
 669  *
 670  * Returns: %TRUE if transformation and validation were successful,
 671  *  %FALSE otherwise and @dest_value is left untouched.
 672  */
 673 gboolean
 674 g_param_value_convert (GParamSpec   *pspec,
 675                        const GValue *src_value,
 676                        GValue       *dest_value,
 677                        gboolean      strict_validation)
 678 {
 679   GValue tmp_value = { 0, };
 680
 681   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
 682   g_return_val_if_fail (G_IS_VALUE (src_value), FALSE);
 683   g_return_val_if_fail (G_IS_VALUE (dest_value), FALSE);
 684   g_return_val_if_fail (PSPEC_APPLIES_TO_VALUE (pspec, dest_value), FALSE);
 685
 686   /* better leave dest_value untouched when returning FALSE */
 687
 688   g_value_init (&tmp_value, G_VALUE_TYPE (dest_value));
 689   if (g_value_transform (src_value, &tmp_value) &&
 690       (!g_param_value_validate (pspec, &tmp_value) || !strict_validation))
 691     {
 692       g_value_unset (dest_value);
 693
 694       /* values are relocatable */
 695       memcpy (dest_value, &tmp_value, sizeof (tmp_value));
 696
 697       return TRUE;
 698     }
 699   else
 700     {
 701       g_value_unset (&tmp_value);
 702
 703       return FALSE;
 704     }
 705 }
 706
 707 /**
 708  * g_param_values_cmp:
 709  * @pspec: a valid #GParamSpec
 710  * @value1: a #GValue of correct type for @pspec
 711  * @value2: a #GValue of correct type for @pspec
 712  *
 713  * Compares @value1 with @value2 according to @pspec, and return -1, 0 or +1,
 714  * if @value1 is found to be less than, equal to or greater than @value2,
 715  * respectively.
 716  *
 717  * Returns: -1, 0 or +1, for a less than, equal to or greater than result
 718  */
 719 gint
 720 g_param_values_cmp (GParamSpec   *pspec,
 721                     const GValue *value1,
 722                     const GValue *value2)
 723 {
 724   gint cmp;
 725
 726   /* param_values_cmp() effectively does: value1 - value2
 727    * so the return values are:
 728    * -1)  value1 < value2
 729    *  0)  value1 == value2
 730    *  1)  value1 > value2
 731    */
 732   g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), 0);
 733   g_return_val_if_fail (G_IS_VALUE (value1), 0);
 734   g_return_val_if_fail (G_IS_VALUE (value2), 0);
 735   g_return_val_if_fail (PSPEC_APPLIES_TO_VALUE (pspec, value1), 0);
 736   g_return_val_if_fail (PSPEC_APPLIES_TO_VALUE (pspec, value2), 0);
 737
 738   cmp = G_PARAM_SPEC_GET_CLASS (pspec)->values_cmp (pspec, value1, value2);
 739
 740   return CLAMP (cmp, -1, 1);
 741 }
 742
 743 static void
 744 value_param_init (GValue *value)
 745 {
 746   value->data[0].v_pointer = NULL;
 747 }
 748
 749 static void
 750 value_param_free_value (GValue *value)
 751 {
 752   if (value->data[0].v_pointer)
 753     g_param_spec_unref (value->data[0].v_pointer);
 754 }
 755
 756 static void
 757 value_param_copy_value (const GValue *src_value,
 758                         GValue       *dest_value)
 759 {
 760   if (src_value->data[0].v_pointer)
 761     dest_value->data[0].v_pointer = g_param_spec_ref (src_value->data[0].v_pointer);
 762   else
 763     dest_value->data[0].v_pointer = NULL;
 764 }
 765
 766 static void
 767 value_param_transform_value (const GValue *src_value,
 768                              GValue       *dest_value)
 769 {
 770   if (src_value->data[0].v_pointer &&
 771       g_type_is_a (G_PARAM_SPEC_TYPE (dest_value->data[0].v_pointer), G_VALUE_TYPE (dest_value)))
 772     dest_value->data[0].v_pointer = g_param_spec_ref (src_value->data[0].v_pointer);
 773   else
 774     dest_value->data[0].v_pointer = NULL;
 775 }
 776
 777 static gpointer
 778 value_param_peek_pointer (const GValue *value)
 779 {
 780   return value->data[0].v_pointer;
 781 }
 782
 783 static gchar*
 784 value_param_collect_value (GValue      *value,
 785                            guint        n_collect_values,
 786                            GTypeCValue *collect_values,
 787                            guint        collect_flags)
 788 {
 789   if (collect_values[0].v_pointer)
 790     {
 791       GParamSpec *param = collect_values[0].v_pointer;
 792
 793       if (param->g_type_instance.g_class == NULL)
 794         return g_strconcat ("invalid unclassed param spec pointer for value type `",
 795                             G_VALUE_TYPE_NAME (value),
 796                             "'",
 797                             NULL);
 798       else if (!g_value_type_compatible (G_PARAM_SPEC_TYPE (param), G_VALUE_TYPE (value)))
 799         return g_strconcat ("invalid param spec type `",
 800                             G_PARAM_SPEC_TYPE_NAME (param),
 801                             "' for value type `",
 802                             G_VALUE_TYPE_NAME (value),
 803                             "'",
 804                             NULL);
 805       value->data[0].v_pointer = g_param_spec_ref (param);
 806     }
 807   else
 808     value->data[0].v_pointer = NULL;
 809
 810   return NULL;
 811 }
 812
 813 static gchar*
 814 value_param_lcopy_value (const GValue *value,
 815                          guint         n_collect_values,
 816                          GTypeCValue  *collect_values,
 817                          guint         collect_flags)
 818 {
 819   GParamSpec **param_p = collect_values[0].v_pointer;
 820
 821   if (!param_p)
 822     return g_strdup_printf ("value location for `%s' passed as NULL", G_VALUE_TYPE_NAME (value));
 823
 824   if (!value->data[0].v_pointer)
 825     *param_p = NULL;
 826   else if (collect_flags & G_VALUE_NOCOPY_CONTENTS)
 827     *param_p = value->data[0].v_pointer;
 828   else
 829     *param_p = g_param_spec_ref (value->data[0].v_pointer);
 830
 831   return NULL;
 832 }
 833
 834
 835 /* --- param spec pool --- */
 836 /**
 837  * GParamSpecPool:
 838  *
 839  * A #GParamSpecPool maintains a collection of #GParamSpec<!-- -->s which can be
 840  * quickly accessed by owner and name. The implementation of the #GObject property
 841  * system uses such a pool to store the #GParamSpecs of the properties all object
 842  * types.
 843  */
 844 struct _GParamSpecPool
 845 {
 846   GStaticMutex smutex;
 847   gboolean     type_prefixing;
 848   GHashTable  *hash_table;
 849 };
 850
 851 static guint
 852 param_spec_pool_hash (gconstpointer key_spec)
 853 {
 854   const GParamSpec *key = key_spec;
 855   const gchar *p;
 856   guint h = key->owner_type;
 857
 858   for (p = key->name; *p; p++)
 859     h = (h << 5) - h + *p;
 860
 861   return h;
 862 }
 863
 864 static gboolean
 865 param_spec_pool_equals (gconstpointer key_spec_1,
 866                         gconstpointer key_spec_2)
 867 {
 868   const GParamSpec *key1 = key_spec_1;
 869   const GParamSpec *key2 = key_spec_2;
 870
 871   return (key1->owner_type == key2->owner_type &&
 872           strcmp (key1->name, key2->name) == 0);
 873 }
 874
 875 /**
 876  * g_param_spec_pool_new:
 877  * @type_prefixing: Whether the pool will support type-prefixed property names.
 878  *
 879  * Creates a new #GParamSpecPool.
 880  *
 881  * If @type_prefixing is %TRUE, lookups in the newly created pool will
 882  * allow to specify the owner as a colon-separated prefix of the
 883  * property name, like "GtkContainer:border-width". This feature is
 884  * deprecated, so you should always set @type_prefixing to %FALSE.
 885  *
 886  * Returns: (transfer none): a newly allocated #GParamSpecPool.
 887  */
 888 GParamSpecPool*
 889 g_param_spec_pool_new (gboolean type_prefixing)
 890 {
 891   static GStaticMutex init_smutex = G_STATIC_MUTEX_INIT;
 892   GParamSpecPool *pool = g_new (GParamSpecPool, 1);
 893
 894   memcpy (&pool->smutex, &init_smutex, sizeof (init_smutex));
 895   pool->type_prefixing = type_prefixing != FALSE;
 896   pool->hash_table = g_hash_table_new (param_spec_pool_hash, param_spec_pool_equals);
 897
 898   return pool;
 899 }
 900
 901 /**
 902  * g_param_spec_pool_insert:
 903  * @pool: a #GParamSpecPool.
 904  * @pspec: the #GParamSpec to insert
 905  * @owner_type: a #GType identifying the owner of @pspec
 906  *
 907  * Inserts a #GParamSpec in the pool.
 908  */
 909 void
 910 g_param_spec_pool_insert (GParamSpecPool *pool,
 911                           GParamSpec     *pspec,
 912                           GType           owner_type)
 913 {
 914   gchar *p;
 915
 916   if (pool && pspec && owner_type > 0 && pspec->owner_type == 0)
 917     {
 918       for (p = pspec->name; *p; p++)
 919         {
 920           if (!strchr (G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "-_", *p))
 921             {
 922               g_warning (G_STRLOC ": pspec name \"%s\" contains invalid characters", pspec->name);
 923               return;
 924             }
 925         }
 926       G_SLOCK (&pool->smutex);
 927       pspec->owner_type = owner_type;
 928       g_param_spec_ref (pspec);
 929       g_hash_table_insert (pool->hash_table, pspec, pspec);
 930       G_SUNLOCK (&pool->smutex);
 931     }
 932   else
 933     {
 934       g_return_if_fail (pool != NULL);
 935       g_return_if_fail (pspec);
 936       g_return_if_fail (owner_type > 0);
 937       g_return_if_fail (pspec->owner_type == 0);
 938     }
 939 }
 940
 941 /**
 942  * g_param_spec_pool_remove:
 943  * @pool: a #GParamSpecPool
 944  * @pspec: the #GParamSpec to remove
 945  *
 946  * Removes a #GParamSpec from the pool.
 947  */
 948 void
 949 g_param_spec_pool_remove (GParamSpecPool *pool,
 950                           GParamSpec     *pspec)
 951 {
 952   if (pool && pspec)
 953     {
 954       G_SLOCK (&pool->smutex);
 955       if (g_hash_table_remove (pool->hash_table, pspec))
 956         g_param_spec_unref (pspec);
 957       else
 958         g_warning (G_STRLOC ": attempt to remove unknown pspec `%s' from pool", pspec->name);
 959       G_SUNLOCK (&pool->smutex);
 960     }
 961   else
 962     {
 963       g_return_if_fail (pool != NULL);
 964       g_return_if_fail (pspec);
 965     }
 966 }
 967
 968 static inline GParamSpec*
 969 param_spec_ht_lookup (GHashTable  *hash_table,
 970                       const gchar *param_name,
 971                       GType        owner_type,
 972                       gboolean     walk_ancestors)
 973 {
 974   GParamSpec key, *pspec;
 975
 976   key.owner_type = owner_type;
 977   key.name = (gchar*) param_name;
 978   if (walk_ancestors)
 979     do
 980       {
 981         pspec = g_hash_table_lookup (hash_table, &key);
 982         if (pspec)
 983           return pspec;
 984         key.owner_type = g_type_parent (key.owner_type);
 985       }
 986     while (key.owner_type);
 987   else
 988     pspec = g_hash_table_lookup (hash_table, &key);
 989
 990   if (!pspec && !is_canonical (param_name))
 991     {
 992       /* try canonicalized form */
 993       key.name = g_strdup (param_name);
 994       key.owner_type = owner_type;
 995
 996       canonicalize_key (key.name);
 997       if (walk_ancestors)
 998         do
 999           {
1000             pspec = g_hash_table_lookup (hash_table, &key);
1001             if (pspec)
1002               {
1003                 g_free (key.name);
1004                 return pspec;
1005               }
1006             key.owner_type = g_type_parent (key.owner_type);
1007           }
1008         while (key.owner_type);
1009       else
1010         pspec = g_hash_table_lookup (hash_table, &key);
1011       g_free (key.name);
1012     }
1013
1014   return pspec;
1015 }
1016
1017 /**
1018  * g_param_spec_pool_lookup:
1019  * @pool: a #GParamSpecPool
1020  * @param_name: the name to look for
1021  * @owner_type: the owner to look for
1022  * @walk_ancestors: If %TRUE, also try to find a #GParamSpec with @param_name
1023  *  owned by an ancestor of @owner_type.
1024  *
1025  * Looks up a #GParamSpec in the pool.
1026  *
1027  * Returns: (transfer none): The found #GParamSpec, or %NULL if no
1028  * matching #GParamSpec was found.
1029  */
1030 GParamSpec*
1031 g_param_spec_pool_lookup (GParamSpecPool *pool,
1032                           const gchar    *param_name,
1033                           GType           owner_type,
1034                           gboolean        walk_ancestors)
1035 {
1036   GParamSpec *pspec;
1037   gchar *delim;
1038
1039   if (!pool || !param_name)
1040     {
1041       g_return_val_if_fail (pool != NULL, NULL);
1042       g_return_val_if_fail (param_name != NULL, NULL);
1043     }
1044
1045   G_SLOCK (&pool->smutex);
1046
1047   delim = pool->type_prefixing ? strchr (param_name, ':') : NULL;
1048
1049   /* try quick and away, i.e. without prefix */
1050   if (!delim)
1051     {
1052       pspec = param_spec_ht_lookup (pool->hash_table, param_name, owner_type, walk_ancestors);
1053       G_SUNLOCK (&pool->smutex);
1054
1055       return pspec;
1056     }
1057
1058   /* strip type prefix */
1059   if (pool->type_prefixing && delim[1] == ':')
1060     {
1061       guint l = delim - param_name;
1062       gchar stack_buffer[32], *buffer = l < 32 ? stack_buffer : g_new (gchar, l + 1);
1063       GType type;
1064
1065       strncpy (buffer, param_name, delim - param_name);
1066       buffer[l] = 0;
1067       type = g_type_from_name (buffer);
1068       if (l >= 32)
1069         g_free (buffer);
1070       if (type)         /* type==0 isn't a valid type pefix */
1071         {
1072           /* sanity check, these cases don't make a whole lot of sense */
1073           if ((!walk_ancestors && type != owner_type) || !g_type_is_a (owner_type, type))
1074             {
1075               G_SUNLOCK (&pool->smutex);
1076
1077               return NULL;
1078             }
1079           owner_type = type;
1080           param_name += l + 2;
1081           pspec = param_spec_ht_lookup (pool->hash_table, param_name, owner_type, walk_ancestors);
1082           G_SUNLOCK (&pool->smutex);
1083
1084           return pspec;
1085         }
1086     }
1087   /* malformed param_name */
1088
1089   G_SUNLOCK (&pool->smutex);
1090
1091   return NULL;
1092 }
1093
1094 static void
1095 pool_list (gpointer key,
1096            gpointer value,
1097            gpointer user_data)
1098 {
1099   GParamSpec *pspec = value;
1100   gpointer *data = user_data;
1101   GType owner_type = (GType) data[1];
1102
1103   if (owner_type == pspec->owner_type)
1104     data[0] = g_list_prepend (data[0], pspec);
1105 }
1106
1107 /**
1108  * g_param_spec_pool_list_owned:
1109  * @pool: a #GParamSpecPool
1110  * @owner_type: the owner to look for
1111  *
1112  * Gets an #GList of all #GParamSpec<!-- -->s owned by @owner_type in
1113  * the pool.
1114  *
1115  * Returns: (transfer container) (element-type GObject.ParamSpec): a
1116  *          #GList of all #GParamSpec<!-- -->s owned by @owner_type in
1117  *          the pool#GParamSpec<!-- -->s.
1118  */
1119 GList*
1120 g_param_spec_pool_list_owned (GParamSpecPool *pool,
1121                               GType           owner_type)
1122 {
1123   gpointer data[2];
1124
1125   g_return_val_if_fail (pool != NULL, NULL);
1126   g_return_val_if_fail (owner_type > 0, NULL);
1127
1128   G_SLOCK (&pool->smutex);
1129   data[0] = NULL;
1130   data[1] = (gpointer) owner_type;
1131   g_hash_table_foreach (pool->hash_table, pool_list, &data);
1132   G_SUNLOCK (&pool->smutex);
1133
1134   return data[0];
1135 }
1136
1137 static gint
1138 pspec_compare_id (gconstpointer a,
1139                   gconstpointer b)
1140 {
1141   const GParamSpec *pspec1 = a, *pspec2 = b;
1142
1143   if (pspec1->param_id < pspec2->param_id)
1144     return -1;
1145
1146   if (pspec1->param_id > pspec2->param_id)
1147     return 1;
1148
1149   return strcmp (pspec1->name, pspec2->name);
1150 }
1151
1152 static inline GSList*
1153 pspec_list_remove_overridden_and_redirected (GSList     *plist,
1154                                              GHashTable *ht,
1155                                              GType       owner_type,
1156                                              guint      *n_p)
1157 {
1158   GSList *rlist = NULL;
1159
1160   while (plist)
1161     {
1162       GSList *tmp = plist->next;
1163       GParamSpec *pspec = plist->data;
1164       GParamSpec *found;
1165       gboolean remove = FALSE;
1166
1167       /* Remove paramspecs that are redirected, and also paramspecs
1168        * that have are overridden by non-redirected properties.
1169        * The idea is to get the single paramspec for each name that
1170        * best corresponds to what the application sees.
1171        */
1172       if (g_param_spec_get_redirect_target (pspec))
1173         remove = TRUE;
1174       else
1175         {
1176           found = param_spec_ht_lookup (ht, pspec->name, owner_type, TRUE);
1177           if (found != pspec)
1178             {
1179               GParamSpec *redirect = g_param_spec_get_redirect_target (found);
1180               if (redirect != pspec)
1181                 remove = TRUE;
1182             }
1183         }
1184
1185       if (remove)
1186         {
1187           g_slist_free_1 (plist);
1188         }
1189       else
1190         {
1191           plist->next = rlist;
1192           rlist = plist;
1193           *n_p += 1;
1194         }
1195       plist = tmp;
1196     }
1197   return rlist;
1198 }
1199
1200 static void
1201 pool_depth_list (gpointer key,
1202                  gpointer value,
1203                  gpointer user_data)
1204 {
1205   GParamSpec *pspec = value;
1206   gpointer *data = user_data;
1207   GSList **slists = data[0];
1208   GType owner_type = (GType) data[1];
1209
1210   if (g_type_is_a (owner_type, pspec->owner_type))
1211     {
1212       if (G_TYPE_IS_INTERFACE (pspec->owner_type))
1213         {
1214           slists[0] = g_slist_prepend (slists[0], pspec);
1215         }
1216       else
1217         {
1218           guint d = g_type_depth (pspec->owner_type);
1219
1220           slists[d - 1] = g_slist_prepend (slists[d - 1], pspec);
1221         }
1222     }
1223 }
1224
1225 /* We handle interfaces specially since we don't want to
1226  * count interface prerequisites like normal inheritance;
1227  * the property comes from the direct inheritance from
1228  * the prerequisite class, not from the interface that
1229  * prerequires it.
1230  *
1231  * also 'depth' isn't a meaningful concept for interface
1232  * prerequites.
1233  */
1234 static void
1235 pool_depth_list_for_interface (gpointer key,
1236                                gpointer value,
1237                                gpointer user_data)
1238 {
1239   GParamSpec *pspec = value;
1240   gpointer *data = user_data;
1241   GSList **slists = data[0];
1242   GType owner_type = (GType) data[1];
1243
1244   if (pspec->owner_type == owner_type)
1245     slists[0] = g_slist_prepend (slists[0], pspec);
1246 }
1247
1248 /**
1249  * g_param_spec_pool_list:
1250  * @pool: a #GParamSpecPool
1251  * @owner_type: the owner to look for
1252  * @n_pspecs_p: (out): return location for the length of the returned array
1253  *
1254  * Gets an array of all #GParamSpec<!-- -->s owned by @owner_type in
1255  * the pool.
1256  *
1257  * Returns: (array length=n_pspecs_p) (transfer container): a newly
1258  *          allocated array containing pointers to all #GParamSpecs
1259  *          owned by @owner_type in the pool
1260  */
1261 GParamSpec**
1262 g_param_spec_pool_list (GParamSpecPool *pool,
1263                         GType           owner_type,
1264                         guint          *n_pspecs_p)
1265 {
1266   GParamSpec **pspecs, **p;
1267   GSList **slists, *node;
1268   gpointer data[2];
1269   guint d, i;
1270
1271   g_return_val_if_fail (pool != NULL, NULL);
1272   g_return_val_if_fail (owner_type > 0, NULL);
1273   g_return_val_if_fail (n_pspecs_p != NULL, NULL);
1274
1275   G_SLOCK (&pool->smutex);
1276   *n_pspecs_p = 0;
1277   d = g_type_depth (owner_type);
1278   slists = g_new0 (GSList*, d);
1279   data[0] = slists;
1280   data[1] = (gpointer) owner_type;
1281
1282   g_hash_table_foreach (pool->hash_table,
1283                         G_TYPE_IS_INTERFACE (owner_type) ?
1284                            pool_depth_list_for_interface :
1285                            pool_depth_list,
1286                         &data);
1287
1288   for (i = 0; i < d; i++)
1289     slists[i] = pspec_list_remove_overridden_and_redirected (slists[i], pool->hash_table, owner_type, n_pspecs_p);
1290   pspecs = g_new (GParamSpec*, *n_pspecs_p + 1);
1291   p = pspecs;
1292   for (i = 0; i < d; i++)
1293     {
1294       slists[i] = g_slist_sort (slists[i], pspec_compare_id);
1295       for (node = slists[i]; node; node = node->next)
1296         *p++ = node->data;
1297       g_slist_free (slists[i]);
1298     }
1299   *p++ = NULL;
1300   g_free (slists);
1301   G_SUNLOCK (&pool->smutex);
1302
1303   return pspecs;
1304 }
1305
1306
1307 /* --- auxillary functions --- */
1308 typedef struct
1309 {
1310   /* class portion */
1311   GType           value_type;
1312   void          (*finalize)             (GParamSpec   *pspec);
1313   void          (*value_set_default)    (GParamSpec   *pspec,
1314                                          GValue       *value);
1315   gboolean      (*value_validate)       (GParamSpec   *pspec,
1316                                          GValue       *value);
1317   gint          (*values_cmp)           (GParamSpec   *pspec,
1318                                          const GValue *value1,
1319                                          const GValue *value2);
1320 } ParamSpecClassInfo;
1321
1322 static void
1323 param_spec_generic_class_init (gpointer g_class,
1324                                gpointer class_data)
1325 {
1326   GParamSpecClass *class = g_class;
1327   ParamSpecClassInfo *info = class_data;
1328
1329   class->value_type = info->value_type;
1330   if (info->finalize)
1331     class->finalize = info->finalize;                   /* optional */
1332   class->value_set_default = info->value_set_default;
1333   if (info->value_validate)
1334     class->value_validate = info->value_validate;       /* optional */
1335   class->values_cmp = info->values_cmp;
1336   g_free (class_data);
1337 }
1338
1339 static void
1340 default_value_set_default (GParamSpec *pspec,
1341                            GValue     *value)
1342 {
1343   /* value is already zero initialized */
1344 }
1345
1346 static gint
1347 default_values_cmp (GParamSpec   *pspec,
1348                     const GValue *value1,
1349                     const GValue *value2)
1350 {
1351   return memcmp (&value1->data, &value2->data, sizeof (value1->data));
1352 }
1353
1354 /**
1355  * g_param_type_register_static:
1356  * @name: 0-terminated string used as the name of the new #GParamSpec type.
1357  * @pspec_info: The #GParamSpecTypeInfo for this #GParamSpec type.
1358  *
1359  * Registers @name as the name of a new static type derived from
1360  * #G_TYPE_PARAM. The type system uses the information contained in
1361  * the #GParamSpecTypeInfo structure pointed to by @info to manage the
1362  * #GParamSpec type and its instances.
1363  *
1364  * Returns: The new type identifier.
1365  */
1366 GType
1367 g_param_type_register_static (const gchar              *name,
1368                               const GParamSpecTypeInfo *pspec_info)
1369 {
1370   GTypeInfo info = {
1371     sizeof (GParamSpecClass),      /* class_size */
1372     NULL,                          /* base_init */
1373     NULL,                          /* base_destroy */
1374     param_spec_generic_class_init, /* class_init */
1375     NULL,                          /* class_destroy */
1376     NULL,                          /* class_data */
1377     0,                             /* instance_size */
1378     16,                            /* n_preallocs */
1379     NULL,                          /* instance_init */
1380   };
1381   ParamSpecClassInfo *cinfo;
1382
1383   g_return_val_if_fail (name != NULL, 0);
1384   g_return_val_if_fail (pspec_info != NULL, 0);
1385   g_return_val_if_fail (g_type_from_name (name) == 0, 0);
1386   g_return_val_if_fail (pspec_info->instance_size >= sizeof (GParamSpec), 0);
1387   g_return_val_if_fail (g_type_name (pspec_info->value_type) != NULL, 0);
1388   /* default: g_return_val_if_fail (pspec_info->value_set_default != NULL, 0); */
1389   /* optional: g_return_val_if_fail (pspec_info->value_validate != NULL, 0); */
1390   /* default: g_return_val_if_fail (pspec_info->values_cmp != NULL, 0); */
1391
1392   info.instance_size = pspec_info->instance_size;
1393   info.n_preallocs = pspec_info->n_preallocs;
1394   info.instance_init = (GInstanceInitFunc) pspec_info->instance_init;
1395   cinfo = g_new (ParamSpecClassInfo, 1);
1396   cinfo->value_type = pspec_info->value_type;
1397   cinfo->finalize = pspec_info->finalize;
1398   cinfo->value_set_default = pspec_info->value_set_default ? pspec_info->value_set_default : default_value_set_default;
1399   cinfo->value_validate = pspec_info->value_validate;
1400   cinfo->values_cmp = pspec_info->values_cmp ? pspec_info->values_cmp : default_values_cmp;
1401   info.class_data = cinfo;
1402
1403   return g_type_register_static (G_TYPE_PARAM, name, &info, 0);
1404 }
1405
1406 /**
1407  * g_value_set_param:
1408  * @value: a valid #GValue of type %G_TYPE_PARAM
1409  * @param: the #GParamSpec to be set
1410  *
1411  * Set the contents of a %G_TYPE_PARAM #GValue to @param.
1412  */
1413 void
1414 g_value_set_param (GValue     *value,
1415                    GParamSpec *param)
1416 {
1417   g_return_if_fail (G_VALUE_HOLDS_PARAM (value));
1418   if (param)
1419     g_return_if_fail (G_IS_PARAM_SPEC (param));
1420
1421   if (value->data[0].v_pointer)
1422     g_param_spec_unref (value->data[0].v_pointer);
1423   value->data[0].v_pointer = param;
1424   if (value->data[0].v_pointer)
1425     g_param_spec_ref (value->data[0].v_pointer);
1426 }
1427
1428 /**
1429  * g_value_set_param_take_ownership: (skip)
1430  * @value: a valid #GValue of type %G_TYPE_PARAM
1431  * @param: the #GParamSpec to be set
1432  *
1433  * This is an internal function introduced mainly for C marshallers.
1434  *
1435  * Deprecated: 2.4: Use g_value_take_param() instead.
1436  */
1437 void
1438 g_value_set_param_take_ownership (GValue     *value,
1439                                   GParamSpec *param)
1440 {
1441   g_value_take_param (value, param);
1442 }
1443
1444 /**
1445  * g_value_take_param: (skip)
1446  * @value: a valid #GValue of type %G_TYPE_PARAM
1447  * @param: the #GParamSpec to be set
1448  *
1449  * Sets the contents of a %G_TYPE_PARAM #GValue to @param and takes
1450  * over the ownership of the callers reference to @param; the caller
1451  * doesn't have to unref it any more.
1452  *
1453  * Since: 2.4
1454  */
1455 void
1456 g_value_take_param (GValue     *value,
1457                     GParamSpec *param)
1458 {
1459   g_return_if_fail (G_VALUE_HOLDS_PARAM (value));
1460   if (param)
1461     g_return_if_fail (G_IS_PARAM_SPEC (param));
1462
1463   if (value->data[0].v_pointer)
1464     g_param_spec_unref (value->data[0].v_pointer);
1465   value->data[0].v_pointer = param; /* we take over the reference count */
1466 }
1467
1468 /**
1469  * g_value_get_param:
1470  * @value: a valid #GValue whose type is derived from %G_TYPE_PARAM
1471  *
1472  * Get the contents of a %G_TYPE_PARAM #GValue.
1473  *
1474  * Returns: (transfer none): #GParamSpec content of @value
1475  */
1476 GParamSpec*
1477 g_value_get_param (const GValue *value)
1478 {
1479   g_return_val_if_fail (G_VALUE_HOLDS_PARAM (value), NULL);
1480
1481   return value->data[0].v_pointer;
1482 }
1483
1484 /**
1485  * g_value_dup_param: (skip)
1486  * @value: a valid #GValue whose type is derived from %G_TYPE_PARAM
1487  *
1488  * Get the contents of a %G_TYPE_PARAM #GValue, increasing its
1489  * reference count.
1490  *
1491  * Returns: #GParamSpec content of @value, should be unreferenced when
1492  *          no longer needed.
1493  */
1494 GParamSpec*
1495 g_value_dup_param (const GValue *value)
1496 {
1497   g_return_val_if_fail (G_VALUE_HOLDS_PARAM (value), NULL);
1498
1499   return value->data[0].v_pointer ? g_param_spec_ref (value->data[0].v_pointer) : NULL;
1500 }