applied patch from Matthias Clasen <maclas@gmx.de> to check for
[platform/upstream/glib.git] / gobject / gparam.c
index 7ead600..db0568d 100644 (file)
@@ -1,5 +1,5 @@
 /* GObject - GLib Type, Object, Parameter and Signal Library
- * Copyright (C) 1997, 1998, 1999, 2000 Tim Janik and Red Hat, Inc.
+ * Copyright (C) 1997-1999, 2000-2001 Tim Janik and Red Hat, Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -30,8 +30,7 @@
 
 
 /* --- defines --- */
-#define G_PARAM_SPEC_CLASS(class)              (G_TYPE_CHECK_CLASS_CAST ((class), G_TYPE_PARAM, GParamSpecClass))
-#define        G_PARAM_USER_MASK                       ((1 << G_PARAM_USER_SHIFT) - 1)
+#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)
@@ -49,6 +48,8 @@ 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,
@@ -104,6 +105,7 @@ g_param_type_init (void)    /* sync with gtype.c */
 
   type = g_type_register_fundamental (G_TYPE_PARAM, "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
@@ -134,13 +136,14 @@ g_param_spec_init (GParamSpec      *pspec,
                   GParamSpecClass *class)
 {
   pspec->name = NULL;
-  pspec->nick = NULL;
-  pspec->blurb = NULL;
+  pspec->_nick = NULL;
+  pspec->_blurb = NULL;
   pspec->flags = 0;
   pspec->value_type = class->value_type;
   pspec->owner_type = 0;
   pspec->qdata = NULL;
   pspec->ref_count = 1;
+  pspec->param_id = 0;
   g_datalist_id_set_data (&pspec->qdata, quark_floating, GUINT_TO_POINTER (TRUE));
 }
 
@@ -150,8 +153,8 @@ g_param_spec_finalize (GParamSpec *pspec)
   g_datalist_clear (&pspec->qdata);
   
   g_free (pspec->name);
-  g_free (pspec->nick);
-  g_free (pspec->blurb);
+  g_free (pspec->_nick);
+  g_free (pspec->_blurb);
 
   g_type_free_instance ((GTypeInstance*) pspec);
 }
@@ -230,6 +233,47 @@ g_param_spec_sink (GParamSpec *pspec)
     }
 }
 
+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_CONST_RETURN gchar*
+g_param_spec_get_nick (GParamSpec *pspec)
+{
+  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
+
+  return pspec->_nick ? pspec->_nick : pspec->name;
+}
+
+G_CONST_RETURN gchar*
+g_param_spec_get_blurb (GParamSpec *pspec)
+{
+  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), NULL);
+
+  return pspec->_blurb;
+}
+
+static void
+canonalize_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 = '-';
+    }
+}
+
 gpointer
 g_param_spec_internal (GType        param_type,
                       const gchar *name,
@@ -238,17 +282,18 @@ g_param_spec_internal (GType        param_type,
                       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);
+  
   pspec = (gpointer) g_type_create_instance (param_type);
   pspec->name = g_strdup (name);
-  g_strcanon (pspec->name, G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "-", '-');
-  pspec->nick = g_strdup (nick ? nick : pspec->name);
-  pspec->blurb = g_strdup (blurb);
+  canonalize_key (pspec->name);
+  pspec->_nick = g_strdup (nick);
+  pspec->_blurb = g_strdup (blurb);
   pspec->flags = (flags & G_PARAM_USER_MASK) | (flags & G_PARAM_MASK);
-
+  
   return pspec;
 }
 
@@ -345,6 +390,40 @@ g_param_value_validate (GParamSpec *pspec,
   return FALSE;
 }
 
+gboolean
+g_param_value_convert (GParamSpec   *pspec,
+                      const GValue *src_value,
+                      GValue       *dest_value,
+                      gboolean      strict_validation)
+{
+  GValue tmp_value = { 0, };
+
+  g_return_val_if_fail (G_IS_PARAM_SPEC (pspec), FALSE);
+  g_return_val_if_fail (G_IS_VALUE (src_value), FALSE);
+  g_return_val_if_fail (G_IS_VALUE (dest_value), FALSE);
+  g_return_val_if_fail (PSPEC_APPLIES_TO_VALUE (pspec, dest_value), FALSE);
+
+  /* better leave dest_value untouched when returning FALSE */
+
+  g_value_init (&tmp_value, G_VALUE_TYPE (dest_value));
+  if (g_value_transform (src_value, &tmp_value) &&
+      (!g_param_value_validate (pspec, &tmp_value) || !strict_validation))
+    {
+      g_value_unset (dest_value);
+      
+      /* values are relocatable */
+      memcpy (dest_value, &tmp_value, sizeof (tmp_value));
+      
+      return TRUE;
+    }
+  else
+    {
+      g_value_unset (&tmp_value);
+      
+      return FALSE;
+    }
+}
+
 gint
 g_param_values_cmp (GParamSpec   *pspec,
                    const GValue *value1,
@@ -386,9 +465,21 @@ static void
 value_param_copy_value (const GValue *src_value,
                        GValue       *dest_value)
 {
-  dest_value->data[0].v_pointer = (src_value->data[0].v_pointer
-                                  ? g_param_spec_ref (src_value->data[0].v_pointer)
-                                  : NULL);
+  if (src_value->data[0].v_pointer)
+    dest_value->data[0].v_pointer = g_param_spec_ref (src_value->data[0].v_pointer);
+  else
+    dest_value->data[0].v_pointer = NULL;
+}
+
+static void
+value_param_transform_value (const GValue *src_value,
+                            GValue       *dest_value)
+{
+  if (src_value->data[0].v_pointer &&
+      g_type_is_a (G_PARAM_SPEC_TYPE (dest_value->data[0].v_pointer), G_VALUE_TYPE (dest_value)))
+    dest_value->data[0].v_pointer = g_param_spec_ref (src_value->data[0].v_pointer);
+  else
+    dest_value->data[0].v_pointer = NULL;
 }
 
 static gpointer
@@ -412,7 +503,7 @@ value_param_collect_value (GValue      *value,
                            G_VALUE_TYPE_NAME (value),
                            "'",
                            NULL);
-      else if (!g_type_is_a (G_PARAM_SPEC_TYPE (param), G_VALUE_TYPE (value)))
+      else if (!g_value_type_compatible (G_PARAM_SPEC_TYPE (param), G_VALUE_TYPE (value)))
        return g_strconcat ("invalid param spec type `",
                            G_PARAM_SPEC_TYPE_NAME (param),
                            "' for value type `",
@@ -572,11 +663,11 @@ param_spec_ht_lookup (GHashTable  *hash_table,
 
   if (!pspec)
     {
-      /* sigh, try canonicalization */
+      /* try canonicalized form */
       key.name = g_strdup (param_name);
       key.owner_type = owner_type;
       
-      g_strcanon (key.name, G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "-", '-');
+      canonalize_key (key.name);
       if (walk_ancestors)
        do
          {
@@ -601,8 +692,7 @@ GParamSpec*
 g_param_spec_pool_lookup (GParamSpecPool *pool,
                          const gchar    *param_name,
                          GType           owner_type,
-                         gboolean        walk_ancestors,
-                         const gchar   **trailer_p)
+                         gboolean        walk_ancestors)
 {
   GParamSpec *pspec;
   gchar *delim;
@@ -615,13 +705,11 @@ g_param_spec_pool_lookup (GParamSpecPool *pool,
 
   G_SLOCK (&pool->smutex);
 
-  delim = strchr (param_name, ':');
+  delim = pool->type_prefixing ? strchr (param_name, ':') : NULL;
 
-  /* try quick and away, i.e. no prefix, no trailer */
+  /* try quick and away, i.e. without prefix */
   if (!delim)
     {
-      if (trailer_p)
-       *trailer_p = NULL;
       pspec = param_spec_ht_lookup (pool->hash_table, param_name, owner_type, walk_ancestors);
       G_SUNLOCK (&pool->smutex);
 
@@ -645,51 +733,147 @@ g_param_spec_pool_lookup (GParamSpecPool *pool,
          /* sanity check, these cases don't make a whole lot of sense */
          if ((!walk_ancestors && type != owner_type) || !g_type_is_a (owner_type, type))
            {
-             if (trailer_p)
-               *trailer_p = NULL;
              G_SUNLOCK (&pool->smutex);
 
              return NULL;
            }
          owner_type = type;
          param_name += l + 2;
-         delim = strchr (param_name, ':');
-         if (!delim)           /* good, can still forget about trailer */
-           {
-             if (trailer_p)
-               *trailer_p = NULL;
-             pspec = param_spec_ht_lookup (pool->hash_table, param_name, owner_type, walk_ancestors);
-              G_SUNLOCK (&pool->smutex);
+         pspec = param_spec_ht_lookup (pool->hash_table, param_name, owner_type, walk_ancestors);
+         G_SUNLOCK (&pool->smutex);
 
-             return pspec;
-           }
+         return pspec;
+       }
+    }
+  /* malformed param_name */
+
+  G_SUNLOCK (&pool->smutex);
+
+  return NULL;
+}
+
+static void
+pool_list (gpointer key,
+          gpointer value,
+          gpointer user_data)
+{
+  GParamSpec *pspec = value;
+  gpointer *data = user_data;
+  GType owner_type = (GType) data[1];
+
+  if (owner_type == pspec->owner_type)
+    data[0] = g_list_prepend (data[0], pspec);
+}
+
+GList*
+g_param_spec_pool_list_owned (GParamSpecPool *pool,
+                             GType           owner_type)
+{
+  gpointer data[2];
+
+  g_return_val_if_fail (pool != NULL, NULL);
+  g_return_val_if_fail (owner_type > 0, NULL);
+  
+  G_SLOCK (&pool->smutex);
+  data[0] = NULL;
+  data[1] = (gpointer) owner_type;
+  g_hash_table_foreach (pool->hash_table, pool_list, &data);
+  G_SUNLOCK (&pool->smutex);
+
+  return data[0];
+}
+
+static gint
+pspec_compare_id (gconstpointer a,
+                 gconstpointer b)
+{
+  const GParamSpec *pspec1 = a, *pspec2 = b;
+
+  return pspec1->param_id < pspec2->param_id ? -1 : pspec1->param_id > pspec2->param_id;
+}
+
+static inline GSList*
+pspec_list_remove_overridden (GSList     *plist,
+                             GHashTable *ht,
+                             GType       owner_type,
+                             guint      *n_p)
+{
+  GSList *rlist = NULL;
+
+  while (plist)
+    {
+      GSList *tmp = plist->next;
+      GParamSpec *pspec = plist->data;
+
+      if (param_spec_ht_lookup (ht, pspec->name, owner_type, TRUE) != pspec)
+       g_slist_free_1 (plist);
+      else
+       {
+         plist->next = rlist;
+         rlist = plist;
+         *n_p += 1;
        }
+      plist = tmp;
     }
+  return rlist;
+}
 
-  /* ok, no prefix, handle trailer */
-  if (delim[1] == ':')
+static void
+pool_depth_list (gpointer key,
+                gpointer value,
+                gpointer user_data)
+{
+  GParamSpec *pspec = value;
+  gpointer *data = user_data;
+  GSList **slists = data[0];
+  GType owner_type = (GType) data[1];
+
+  if (g_type_is_a (owner_type, pspec->owner_type))
     {
-      guint l = delim - param_name;
-      gchar stack_buffer[32], *buffer = l < 32 ? stack_buffer : g_new (gchar, l + 1);
-      
-      strncpy (buffer, param_name, delim - param_name);
-      buffer[l] = 0;
-      pspec = param_spec_ht_lookup (pool->hash_table, buffer, owner_type, walk_ancestors);
-      if (l >= 32)
-       g_free (buffer);
-      if (trailer_p)
-       *trailer_p = pspec ? delim + 2 : NULL;
-      G_SUNLOCK (&pool->smutex);
+      guint d = g_type_depth (pspec->owner_type);
 
-      return pspec;
+      slists[d - 1] = g_slist_prepend (slists[d - 1], pspec);
     }
+}
 
-  /* malformed param_name */
-  if (trailer_p)
-    *trailer_p = NULL;
+GParamSpec** /* free result */
+g_param_spec_pool_list (GParamSpecPool *pool,
+                       GType           owner_type,
+                       guint          *n_pspecs_p)
+{
+  GParamSpec **pspecs, **p;
+  GSList **slists, *node;
+  gpointer data[2];
+  guint d, i;
+
+  g_return_val_if_fail (pool != NULL, NULL);
+  g_return_val_if_fail (owner_type > 0, NULL);
+  g_return_val_if_fail (n_pspecs_p != NULL, NULL);
+  
+  G_SLOCK (&pool->smutex);
+  *n_pspecs_p = 0;
+  d = g_type_depth (owner_type);
+  slists = g_new0 (GSList*, d);
+  data[0] = slists;
+  data[1] = (gpointer) owner_type;
+  g_hash_table_foreach (pool->hash_table, pool_depth_list, &data);
+  for (i = 0; i < d - 1; i++)
+    slists[i] = pspec_list_remove_overridden (slists[i], pool->hash_table, owner_type, n_pspecs_p);
+  *n_pspecs_p += g_slist_length (slists[i]);
+  pspecs = g_new (GParamSpec*, *n_pspecs_p + 1);
+  p = pspecs;
+  for (i = 0; i < d; i++)
+    {
+      slists[i] = g_slist_sort (slists[i], pspec_compare_id);
+      for (node = slists[i]; node; node = node->next)
+       *p++ = node->data;
+      g_slist_free (slists[i]);
+    }
+  *p++ = NULL;
+  g_free (slists);
   G_SUNLOCK (&pool->smutex);
 
-  return NULL;
+  return pspecs;
 }
 
 
@@ -784,7 +968,7 @@ void
 g_value_set_param (GValue     *value,
                   GParamSpec *param)
 {
-  g_return_if_fail (G_IS_VALUE_PARAM (value));
+  g_return_if_fail (G_VALUE_HOLDS_PARAM (value));
   if (param)
     g_return_if_fail (G_IS_PARAM_SPEC (param));
 
@@ -795,10 +979,23 @@ g_value_set_param (GValue     *value,
     g_param_spec_ref (value->data[0].v_pointer);
 }
 
+void
+g_value_set_param_take_ownership (GValue     *value,
+                                 GParamSpec *param)
+{
+  g_return_if_fail (G_VALUE_HOLDS_PARAM (value));
+  if (param)
+    g_return_if_fail (G_IS_PARAM_SPEC (param));
+
+  if (value->data[0].v_pointer)
+    g_param_spec_unref (value->data[0].v_pointer);
+  value->data[0].v_pointer = param; /* we take over the reference count */
+}
+
 GParamSpec*
 g_value_get_param (const GValue *value)
 {
-  g_return_val_if_fail (G_IS_VALUE_PARAM (value), NULL);
+  g_return_val_if_fail (G_VALUE_HOLDS_PARAM (value), NULL);
 
   return value->data[0].v_pointer;
 }
@@ -806,7 +1003,7 @@ g_value_get_param (const GValue *value)
 GParamSpec*
 g_value_dup_param (const GValue *value)
 {
-  g_return_val_if_fail (G_IS_VALUE_PARAM (value), NULL);
+  g_return_val_if_fail (G_VALUE_HOLDS_PARAM (value), NULL);
 
   return value->data[0].v_pointer ? g_param_spec_ref (value->data[0].v_pointer) : NULL;
 }