/* GObject - GLib Type, Object, Parameter and Signal Library

 * Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.

 * Portions copyright (c) 2006-2009 Nokia Corporation.  All rights reserved.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General

 * Public License along with this library; if not, write to the

 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,

 * Boston, MA 02111-1307, USA.

 */

/*

 * MT safe

 */

#include "config.h"

#include <string.h>

#include "gparam.h"

#include "gparamspecs.h"

#include "gvaluecollector.h"

#include "gobjectalias.h"

#ifdef __SYMBIAN32__

#include <glib_global.h>

#include "gobject_wsd.h"

#include <gobject_global.h>

#endif /* __SYMBIAN32__ */

/**

 * SECTION:gparamspec

 * @short_description: Metadata for parameter specifications

 * @see_also: g_object_class_install_property(), g_object_set(),

 *     g_object_get(), g_object_set_property(), g_object_get_property(),

 *     g_value_register_transform_func()

 * @title: GParamSpec

 *

 * #GParamSpec is an object structure that encapsulates the metadata

 * required to specify parameters, such as e.g. #GObject properties.

 *

 * <para id="canonical-parameter-name">

 * Parameter names need to start with a letter (a-z or A-Z). Subsequent

 * characters can be letters, numbers or a '-'.

 * All other characters are replaced by a '-' during construction.

 * The result of this replacement is called the canonical name of the

 * parameter.

 * </para>

 */

/* --- defines --- */

#define PARAM_FLOATING_FLAG                     0x2

#define	G_PARAM_USER_MASK			(~0 << G_PARAM_USER_SHIFT)

#define PSPEC_APPLIES_TO_VALUE(pspec, value)	(G_TYPE_CHECK_VALUE_TYPE ((value), G_PARAM_SPEC_VALUE_TYPE (pspec)))

#define	G_SLOCK(mutex)				g_static_mutex_lock (mutex)

#define	G_SUNLOCK(mutex)			g_static_mutex_unlock (mutex)

/* --- prototypes --- */

static void	g_param_spec_class_base_init	 (GParamSpecClass	*class);

static void	g_param_spec_class_base_finalize (GParamSpecClass	*class);

static void	g_param_spec_class_init		 (GParamSpecClass	*class,

						  gpointer               class_data);

static void	g_param_spec_init		 (GParamSpec		*pspec,

						  GParamSpecClass	*class);

static void	g_param_spec_finalize		 (GParamSpec		*pspec);

static void	value_param_init		(GValue		*value);

static void	value_param_free_value		(GValue		*value);

static void	value_param_copy_value		(const GValue	*src_value,

						 GValue		*dest_value);

static void	value_param_transform_value	(const GValue	*src_value,

						 GValue		*dest_value);

static gpointer	value_param_peek_pointer	(const GValue	*value);

static gchar*	value_param_collect_value	(GValue		*value,

						 guint           n_collect_values,

						 GTypeCValue    *collect_values,

						 guint           collect_flags);

static gchar*	value_param_lcopy_value		(const GValue	*value,

						 guint           n_collect_values,

						 GTypeCValue    *collect_values,

						 guint           collect_flags);

/* --- functions --- */

void

g_param_type_init (void)

{

  static const GTypeFundamentalInfo finfo = {

    (G_TYPE_FLAG_CLASSED |

     G_TYPE_FLAG_INSTANTIATABLE |

     G_TYPE_FLAG_DERIVABLE |

     G_TYPE_FLAG_DEEP_DERIVABLE),

  };

  static const GTypeValueTable param_value_table = {

    value_param_init,           /* value_init */

    value_param_free_value,     /* value_free */

    value_param_copy_value,     /* value_copy */

    value_param_peek_pointer,   /* value_peek_pointer */

    "p",			/* collect_format */

    value_param_collect_value,  /* collect_value */

    "p",			/* lcopy_format */

    value_param_lcopy_value,    /* lcopy_value */

  };

  static const GTypeInfo param_spec_info = {

    sizeof (GParamSpecClass),

    (GBaseInitFunc) g_param_spec_class_base_init,

    (GBaseFinalizeFunc) g_param_spec_class_base_finalize,

    (GClassInitFunc) g_param_spec_class_init,

    (GClassFinalizeFunc) NULL,

    NULL,	/* class_data */

    sizeof (GParamSpec),

    0,		/* n_preallocs */

    (GInstanceInitFunc) g_param_spec_init,

    &param_value_table,

  };

  GType type;

  /* This should be registred as GParamSpec instead of GParam, for

   * consistency sake, so that type name can be mapped to struct name,

   * However, some language bindings, most noticable the python ones

   * depends on the "GParam" identifier, see #548689

   */

  type = g_type_register_fundamental (G_TYPE_PARAM, g_intern_static_string ("GParam"), &param_spec_info, &finfo, G_TYPE_FLAG_ABSTRACT);

  g_assert (type == G_TYPE_PARAM);

  g_value_register_transform_func (G_TYPE_PARAM, G_TYPE_PARAM, value_param_transform_value);

}

static void

g_param_spec_class_base_init (GParamSpecClass *class)

{

}

static void

g_param_spec_class_base_finalize (GParamSpecClass *class)

{

}

static void

g_param_spec_class_init (GParamSpecClass *class,

			 gpointer         class_data)

{

  class->value_type = G_TYPE_NONE;

  class->finalize = g_param_spec_finalize;

  class->value_set_default = NULL;

  class->value_validate = NULL;

  class->values_cmp = NULL;

}

static void

g_param_spec_init (GParamSpec      *pspec,

		   GParamSpecClass *class)

{

  pspec->name = NULL;

  pspec->_nick = NULL;

  pspec->_blurb = NULL;

  pspec->flags = 0;

  pspec->value_type = class->value_type;

  pspec->owner_type = 0;

  pspec->qdata = NULL;

  g_datalist_init (&pspec->qdata);

  g_datalist_set_flags (&pspec->qdata, PARAM_FLOATING_FLAG);

  pspec->ref_count = 1;

  pspec->param_id = 0;

}

static void

g_param_spec_finalize (GParamSpec *pspec)

{

  g_datalist_clear (&pspec->qdata);

  if (!(pspec->flags & G_PARAM_STATIC_NAME))

    g_free (pspec->name);

  if (!(pspec->flags & G_PARAM_STATIC_NICK))

    g_free (pspec->_nick);

  if (!(pspec->flags & G_PARAM_STATIC_BLURB))

    g_free (pspec->_blurb);

  g_type_free_instance ((GTypeInstance*) pspec);

}

/**

 * g_param_spec_ref:

 * @pspec: a valid #GParamSpec

 *

 * Increments the reference count of @pspec.

 *

 * Returns: the #GParamSpec that was passed into this function

 */

EXPORT_C GParamSpec*

g_param_spec_ref (GParamSpec *pspec)

{

  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);

  g_return_val_if_fail (pspec->ref_count > 0, NULL);

  g_atomic_int_inc ((int *)&pspec->ref_count);

  return pspec;

}

/**

 * g_param_spec_unref:

 * @pspec: a valid #GParamSpec

 *

 * Decrements the reference count of a @pspec.

 */

EXPORT_C void

g_param_spec_unref (GParamSpec *pspec)

{

  gboolean is_zero;

  g_return_if_fail (G_IS_PARAM_SPEC (pspec));

  g_return_if_fail (pspec->ref_count > 0);

  is_zero = g_atomic_int_dec_and_test ((int *)&pspec->ref_count);

  if (G_UNLIKELY (is_zero))

    {

      G_PARAM_SPEC_GET_CLASS (pspec)->finalize (pspec);

    }

}

/**

 * g_param_spec_sink:

 * @pspec: a valid #GParamSpec

 *

 * The initial reference count of a newly created #GParamSpec is 1,

 * even though no one has explicitly called g_param_spec_ref() on it

 * yet. So the initial reference count is flagged as "floating", until

 * someone calls <literal>g_param_spec_ref (pspec); g_param_spec_sink

 * (pspec);</literal> in sequence on it, taking over the initial

 * reference count (thus ending up with a @pspec that has a reference

 * count of 1 still, but is not flagged "floating" anymore).

 */

EXPORT_C void

g_param_spec_sink (GParamSpec *pspec)

{

  gpointer oldvalue;

  g_return_if_fail (G_IS_PARAM_SPEC (pspec));

  g_return_if_fail (pspec->ref_count > 0);

  do

    oldvalue = g_atomic_pointer_get (&pspec->qdata);

  while (!g_atomic_pointer_compare_and_exchange ((void**) &pspec->qdata, oldvalue,

                                                 (gpointer) ((gsize) oldvalue & ~(gsize) PARAM_FLOATING_FLAG)));

  if ((gsize) oldvalue & PARAM_FLOATING_FLAG)

    g_param_spec_unref (pspec);

}

/**

 * g_param_spec_ref_sink:

 * @pspec: a valid #GParamSpec

 *

 * Convenience function to ref and sink a #GParamSpec.

 *

 * Since: 2.10

 * Returns: the #GParamSpec that was passed into this function

 */

EXPORT_C GParamSpec*

g_param_spec_ref_sink (GParamSpec *pspec)

{

  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);

  g_return_val_if_fail (pspec->ref_count > 0, NULL);

  g_param_spec_ref (pspec);

  g_param_spec_sink (pspec);

  return pspec;

}

/**

 * g_param_spec_get_name:

 * @pspec: a valid #GParamSpec

 *

 * Get the name of a #GParamSpec.

 *

 * Returns: the name of @pspec.

 */

EXPORT_C G_CONST_RETURN gchar*

g_param_spec_get_name (GParamSpec *pspec)

{

  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);

  return pspec->name;

}

/**

 * g_param_spec_get_nick:

 * @pspec: a valid #GParamSpec

 *

 * Get the nickname of a #GParamSpec.

 *

 * Returns: the nickname of @pspec.

 */

EXPORT_C G_CONST_RETURN gchar*

g_param_spec_get_nick (GParamSpec *pspec)

{

  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);

  if (pspec->_nick)

    return pspec->_nick;

  else

    {

      GParamSpec *redirect_target;

      redirect_target = g_param_spec_get_redirect_target (pspec);

      if (redirect_target && redirect_target->_nick)

	return redirect_target->_nick;

    }

  return pspec->name;

}

/**

 * g_param_spec_get_blurb:

 * @pspec: a valid #GParamSpec

 *

 * Get the short description of a #GParamSpec.

 *

 * Returns: the short description of @pspec.

 */

EXPORT_C G_CONST_RETURN gchar*

g_param_spec_get_blurb (GParamSpec *pspec)

{

  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);

  if (pspec->_blurb)

    return pspec->_blurb;

  else

    {

      GParamSpec *redirect_target;

      redirect_target = g_param_spec_get_redirect_target (pspec);

      if (redirect_target && redirect_target->_blurb)

	return redirect_target->_blurb;

    }

  return NULL;

}

static void

canonicalize_key (gchar *key)

{

  gchar *p;

  for (p = key; *p != 0; p++)

    {

      gchar c = *p;

      if (c != '-' &&

	  (c < '0' || c > '9') &&

	  (c < 'A' || c > 'Z') &&

	  (c < 'a' || c > 'z'))

	*p = '-';

    }

}

static gboolean

is_canonical (const gchar *key)

{

  const gchar *p;

  for (p = key; *p != 0; p++)

    {

      gchar c = *p;

      if (c != '-' &&

	  (c < '0' || c > '9') &&

	  (c < 'A' || c > 'Z') &&

	  (c < 'a' || c > 'z'))

	return FALSE;

    }

  return TRUE;

}

/**

 * g_param_spec_internal:

 * @param_type: the #GType for the property; must be derived from #G_TYPE_PARAM

 * @name: the canonical name of the property

 * @nick: the nickname of the property

 * @blurb: a short description of the property

 * @flags: a combination of #GParamFlags

 *

 * Creates a new #GParamSpec instance.

 *

 * A property name consists of segments consisting of ASCII letters and

 * digits, separated by either the '-' or '_' character. The first

 * character of a property name must be a letter. Names which violate these

 * rules lead to undefined behaviour.

 *

 * When creating and looking up a #GParamSpec, either separator can be

 * used, but they cannot be mixed. Using '-' is considerably more

 * efficient and in fact required when using property names as detail

 * strings for signals.

 *

 * Beyond the name, #GParamSpec<!-- -->s have two more descriptive

 * strings associated with them, the @nick, which should be suitable

 * for use as a label for the property in a property editor, and the

 * @blurb, which should be a somewhat longer description, suitable for

 * e.g. a tooltip. The @nick and @blurb should ideally be localized.

 *

 * Returns: a newly allocated #GParamSpec instance

 */

EXPORT_C gpointer

g_param_spec_internal (GType        param_type,

		       const gchar *name,

		       const gchar *nick,

		       const gchar *blurb,

		       GParamFlags  flags)

{

  GParamSpec *pspec;

  g_return_val_if_fail (G_TYPE_IS_PARAM (param_type) && param_type != G_TYPE_PARAM, NULL);

  g_return_val_if_fail (name != NULL, NULL);

  g_return_val_if_fail ((name[0] >= 'A' && name[0] <= 'Z') || (name[0] >= 'a' && name[0] <= 'z'), NULL);

  g_return_val_if_fail (!(flags & G_PARAM_STATIC_NAME) || is_canonical (name), NULL);

  pspec = (gpointer) g_type_create_instance (param_type);

  if (flags & G_PARAM_STATIC_NAME)

    {

      pspec->name = g_intern_static_string (name);

      if (!is_canonical (pspec->name))

        g_warning ("G_PARAM_STATIC_NAME used with non-canonical pspec name: %s", pspec->name);

    }

  else

    {

      pspec->name = g_strdup (name);

      canonicalize_key (pspec->name);

      g_intern_string (pspec->name);

    }

  if (flags & G_PARAM_STATIC_NICK)

    pspec->_nick = (gchar*) nick;

  else

    pspec->_nick = g_strdup (nick);

  if (flags & G_PARAM_STATIC_BLURB)

    pspec->_blurb = (gchar*) blurb;

  else

    pspec->_blurb = g_strdup (blurb);

  pspec->flags = (flags & G_PARAM_USER_MASK) | (flags & G_PARAM_MASK);

  return pspec;

}

/**

 * g_param_spec_get_qdata:

 * @pspec: a valid #GParamSpec

 * @quark: a #GQuark, naming the user data pointer

 *

 * Gets back user data pointers stored via g_param_spec_set_qdata().

 *

 * Returns: the user data pointer set, or %NULL

 */

EXPORT_C gpointer

g_param_spec_get_qdata (GParamSpec *pspec,

			GQuark      quark)

{

  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);

  return quark ? g_datalist_id_get_data (&pspec->qdata, quark) : NULL;

}

/**

 * g_param_spec_set_qdata:

 * @pspec: the #GParamSpec to set store a user data pointer

 * @quark: a #GQuark, naming the user data pointer

 * @data: an opaque user data pointer

 *

 * Sets an opaque, named pointer on a #GParamSpec. The name is

 * specified through a #GQuark (retrieved e.g. via

 * g_quark_from_static_string()), and the pointer can be gotten back

 * from the @pspec with g_param_spec_get_qdata().  Setting a

 * previously set user data pointer, overrides (frees) the old pointer

 * set, using %NULL as pointer essentially removes the data stored.

 */

EXPORT_C void

g_param_spec_set_qdata (GParamSpec *pspec,

			GQuark      quark,

			gpointer    data)

{

  g_return_if_fail (G_IS_PARAM_SPEC (pspec));

  g_return_if_fail (quark > 0);

  g_datalist_id_set_data (&pspec->qdata, quark, data);

}

/**

 * g_param_spec_set_qdata_full:

 * @pspec: the #GParamSpec to set store a user data pointer

 * @quark: a #GQuark, naming the user data pointer

 * @data: an opaque user data pointer

 * @destroy: function to invoke with @data as argument, when @data needs to

 *  be freed

 *

 * This function works like g_param_spec_set_qdata(), but in addition,

 * a <literal>void (*destroy) (gpointer)</literal> function may be

 * specified which is called with @data as argument when the @pspec is

 * finalized, or the data is being overwritten by a call to

 * g_param_spec_set_qdata() with the same @quark.

 */

EXPORT_C void

g_param_spec_set_qdata_full (GParamSpec    *pspec,

			     GQuark         quark,

			     gpointer       data,

			     GDestroyNotify destroy)

{

  g_return_if_fail (G_IS_PARAM_SPEC (pspec));

  g_return_if_fail (quark > 0);

  g_datalist_id_set_data_full (&pspec->qdata, quark, data, data ? destroy : (GDestroyNotify) NULL);

}