Pileus Git - ~andy/gtk/blob - gtk/tests/object.c

   1 /* Gtk+ object tests
   2  * Copyright (C) 2007 Imendio AB
   3  * Authors: Tim Janik
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20 #include <gtk/gtk.h>
  21 #include <string.h>
  22
  23 /* --- helper macros for property value generation --- */
  24 /* dvalue=+0: generate minimum value
  25  * dvalue=.x: generate value within value range proportional to x.
  26  * dvalue=+1: generate maximum value
  27  * dvalue=-1: generate random value within value range
  28  * dvalue=+2: initialize value from default_value
  29  */
  30 #define ASSIGN_VALUE(__g_value_set_func, __value, PSPECTYPE, __pspec, __default_value, __minimum, __maximum, __dvalue) do { \
  31   PSPECTYPE __p = (PSPECTYPE) __pspec; \
  32   __g_value_set_func (__value, SELECT_VALUE (__dvalue, __p->__default_value, __p->__minimum, __p->__maximum)); \
  33 } while (0)
  34 #define SELECT_VALUE(__dvalue, __default_value, __minimum, __maximum) ( \
  35   __dvalue >= 0 && __dvalue <= 1 ? __minimum * (1 - __dvalue) + __dvalue * __maximum : \
  36     __dvalue <= -1 ? g_test_rand_double_range (__minimum, __maximum) : \
  37       __default_value)
  38 #define SELECT_NAME(__dvalue) ( \
  39   __dvalue == 0 ? "minimum" : \
  40     __dvalue == 1 ? "maximum" : \
  41       __dvalue >= +2 ? "default" : \
  42         __dvalue == 0.5 ? "medium" : \
  43           __dvalue > 0 && __dvalue < 1 ? "fractional" : \
  44             "random")
  45 #define MATCH_ANY_VALUE         ((void*) 0xf1874c23)
  46
  47 /* --- property blacklists --- */
  48 typedef struct {
  49   const char   *type_name;
  50   const char   *name;
  51   gconstpointer value;
  52 } IgnoreProperty;
  53 static const IgnoreProperty*
  54 list_ignore_properties (gboolean buglist)
  55 {
  56   /* currently untestable properties */
  57   static const IgnoreProperty ignore_properties[] = {
  58     { "GtkContainer",           "child",                NULL, },                        /* needs working child widget */
  59     { "GtkRadioMenuItem",       "group",                NULL, },                        /* needs working sibling */
  60     { "GtkWidget",              "parent",               NULL, },                        /* needs working parent widget */
  61     { "GtkCList",               "selection-mode",       (void*) GTK_SELECTION_NONE, },
  62     { "GtkWidget",              "has-default",          (void*) TRUE, },                /* conflicts with toplevel-less widgets */
  63     { "GtkWidget",              "screen",               NULL, },
  64     { "GtkWindow",              "type-hint",            (void*) GDK_WINDOW_TYPE_HINT_DND, }, /* conflicts with ::visible=TRUE */
  65     { "GtkCellView",            "background",           (void*) "", },                  /* "" is not a valid background color */
  66     { "GtkColorButton",         "color",                (void*) NULL, },                /* not a valid boxed color */
  67     { "GtkInputDialog",         "has-separator",        (void*) MATCH_ANY_VALUE, },     /* property disabled */
  68     { "GtkMessageDialog",       "has-separator",        (void*) MATCH_ANY_VALUE, },     /* property disabled */
  69     { "GtkFontSelectionDialog", "has-separator",        (void*) MATCH_ANY_VALUE, },     /* property disabled */
  70     { "GtkColorSelectionDialog","has-separator",        (void*) MATCH_ANY_VALUE, },     /* property disabled */
  71     { "GtkColorSelection",      "child",                NULL, },
  72     { "GtkColorSelection",      "current-color",        (void*) NULL, },                /* not a valid boxed color */
  73     { "GtkComboBox",            "row-span-column",      (void*) MATCH_ANY_VALUE },      /* GtkComboBoxEntry needs a tree model for this */
  74     { "GtkComboBox",            "column-span-column",   (void*) MATCH_ANY_VALUE },      /* GtkComboBoxEntry needs a tree model for this */
  75     { "GtkFileChooserButton",   "select-multiple",      (void*) MATCH_ANY_VALUE },      /* property disabled */
  76     { "GtkFileChooserButton",   "action",               (void*) GTK_FILE_CHOOSER_ACTION_SAVE },
  77     { "GtkFileChooserButton",   "action",               (void*) GTK_FILE_CHOOSER_ACTION_CREATE_FOLDER },
  78     { "GtkFileChooserWidget",   "select-multiple",      (void*) 0x1 },                  /* property conflicts */
  79     { "GtkFileChooserDialog",   "select-multiple",      (void*) MATCH_ANY_VALUE },      /* property disabled */
  80     { "GtkMenu",                "accel-path",           (void*) MATCH_ANY_VALUE },      /* has odd restrictions in the setter */
  81     { "GtkMenuItem",            "accel-path",           (void*) MATCH_ANY_VALUE },      /* has odd restrictions in the setter */
  82     { "GtkRecentChooserMenu",   "select-multiple",      (void*) MATCH_ANY_VALUE },      /* property disabled */
  83     { "GtkTextView",            "overwrite",            (void*) MATCH_ANY_VALUE },      /* needs text buffer */
  84     { "GtkToolbar",             "icon-size",            (void*) GTK_ICON_SIZE_INVALID },
  85     { NULL, NULL, NULL }
  86   };
  87   /* properties suspected to be Gdk/Gtk+ bugs */
  88   static const IgnoreProperty bug_properties[] = {
  89     { "GtkComboBox",            "active",               (void*) MATCH_ANY_VALUE },      /* FIXME: triggers NULL model bug */
  90     { "GtkCTree",               "spacing",              (void*) MATCH_ANY_VALUE },      /* FIXME: triggers signedness bug */
  91     { "GtkFileChooserButton",   "local-only",           (void*) MATCH_ANY_VALUE },      /* FIXME: triggers NULL path assertion */
  92     { "GtkFileChooserDialog",   "local-only",           (void*) MATCH_ANY_VALUE },      /* FIXME: triggers NULL path assertion */
  93     { "GtkFileChooserWidget",   "local-only",           (void*) MATCH_ANY_VALUE },      /* FIXME: triggers NULL path assertion */
  94     { "GtkMenu",                "tearoff-state",        (void*) MATCH_ANY_VALUE },      /* FIXME: triggers NULL widget cast */
  95     { "GtkText",                "text-position",        (void*) MATCH_ANY_VALUE },      /* FIXME: segfaults, fix property minimum/maximum */
  96     { NULL, NULL, NULL }
  97   };
  98   if (buglist)
  99     return bug_properties;
 100   else
 101     return ignore_properties;
 102 }
 103
 104 /* --- test functions --- */
 105 static void
 106 pspec_select_value (GParamSpec *pspec,
 107                     GValue     *value,
 108                     double      dvalue)
 109 {
 110   /* generate a value suitable for pspec */
 111   if (G_IS_PARAM_SPEC_CHAR (pspec))
 112     ASSIGN_VALUE (g_value_set_char, value, GParamSpecChar*, pspec, default_value, minimum, maximum, dvalue);
 113   else if (G_IS_PARAM_SPEC_UCHAR (pspec))
 114     ASSIGN_VALUE (g_value_set_uchar, value, GParamSpecUChar*, pspec, default_value, minimum, maximum, dvalue);
 115   else if (G_IS_PARAM_SPEC_INT (pspec))
 116     ASSIGN_VALUE (g_value_set_int, value, GParamSpecInt*, pspec, default_value, minimum, maximum, dvalue);
 117   else if (G_IS_PARAM_SPEC_UINT (pspec))
 118     ASSIGN_VALUE (g_value_set_uint, value, GParamSpecUInt*, pspec, default_value, minimum, maximum, dvalue);
 119   else if (G_IS_PARAM_SPEC_LONG (pspec))
 120     ASSIGN_VALUE (g_value_set_long, value, GParamSpecLong*, pspec, default_value, minimum, maximum, dvalue);
 121   else if (G_IS_PARAM_SPEC_ULONG (pspec))
 122     ASSIGN_VALUE (g_value_set_ulong, value, GParamSpecULong*, pspec, default_value, minimum, maximum, dvalue);
 123   else if (G_IS_PARAM_SPEC_INT64 (pspec))
 124     ASSIGN_VALUE (g_value_set_int64, value, GParamSpecInt64*, pspec, default_value, minimum, maximum, dvalue);
 125   else if (G_IS_PARAM_SPEC_UINT64 (pspec))
 126     ASSIGN_VALUE (g_value_set_uint64, value, GParamSpecUInt64*, pspec, default_value, minimum, maximum, dvalue);
 127   else if (G_IS_PARAM_SPEC_FLOAT (pspec))
 128     ASSIGN_VALUE (g_value_set_float, value, GParamSpecFloat*, pspec, default_value, minimum, maximum, dvalue);
 129   else if (G_IS_PARAM_SPEC_DOUBLE (pspec))
 130     ASSIGN_VALUE (g_value_set_double, value, GParamSpecDouble*, pspec, default_value, minimum, maximum, dvalue);
 131   else if (G_IS_PARAM_SPEC_BOOLEAN (pspec))
 132     g_value_set_boolean (value, SELECT_VALUE (dvalue, ((GParamSpecBoolean*) pspec)->default_value, FALSE, TRUE));
 133   else if (G_IS_PARAM_SPEC_UNICHAR (pspec))
 134     g_value_set_uint (value, SELECT_VALUE (dvalue, ((GParamSpecUnichar*) pspec)->default_value, FALSE, TRUE));
 135   else if (G_IS_PARAM_SPEC_GTYPE (pspec))
 136     g_value_set_gtype (value, SELECT_VALUE ((int) dvalue, ((GParamSpecGType*) pspec)->is_a_type, 0, GTK_TYPE_WIDGET));
 137   else if (G_IS_PARAM_SPEC_STRING (pspec))
 138     {
 139       GParamSpecString *sspec = (GParamSpecString*) pspec;
 140       if (dvalue >= +2)
 141         g_value_set_string (value, sspec->default_value);
 142       if (dvalue > 0 && sspec->cset_first && sspec->cset_nth)
 143         g_value_take_string (value, g_strdup_printf ("%c%c", sspec->cset_first[0], sspec->cset_nth[0]));
 144       else /* if (sspec->ensure_non_null) */
 145         g_value_set_string (value, "");
 146     }
 147   else if (G_IS_PARAM_SPEC_ENUM (pspec))
 148     {
 149       GParamSpecEnum *espec = (GParamSpecEnum*) pspec;
 150       if (dvalue >= +2)
 151         g_value_set_enum (value, espec->default_value);
 152       if (dvalue >= 0 && dvalue <= 1)
 153         g_value_set_enum (value, espec->enum_class->values[(int) ((espec->enum_class->n_values - 1) * dvalue)].value);
 154       else if (dvalue <= -1)
 155         g_value_set_enum (value, espec->enum_class->values[g_test_rand_int_range (0, espec->enum_class->n_values)].value);
 156     }
 157   else if (G_IS_PARAM_SPEC_FLAGS (pspec))
 158     {
 159       GParamSpecFlags *fspec = (GParamSpecFlags*) pspec;
 160       if (dvalue >= +2)
 161         g_value_set_flags (value, fspec->default_value);
 162       if (dvalue >= 0 && dvalue <= 1)
 163         g_value_set_flags (value, fspec->flags_class->values[(int) ((fspec->flags_class->n_values - 1) * dvalue)].value);
 164       else if (dvalue <= -1)
 165         g_value_set_flags (value, fspec->flags_class->values[g_test_rand_int_range (0, fspec->flags_class->n_values)].value);
 166     }
 167   /* unimplemented:
 168    * G_IS_PARAM_SPEC_PARAM
 169    * G_IS_PARAM_SPEC_BOXED
 170    * G_IS_PARAM_SPEC_POINTER
 171    * G_IS_PARAM_SPEC_VALUE_ARRAY
 172    * G_IS_PARAM_SPEC_OBJECT
 173    */
 174 }
 175
 176 static gpointer
 177 value_as_pointer (GValue *value)
 178 {
 179   if (g_value_fits_pointer (value))
 180     return g_value_peek_pointer (value);
 181   if (G_VALUE_HOLDS_BOOLEAN (value))
 182     return GINT_TO_POINTER(g_value_get_boolean (value));
 183   if (G_VALUE_HOLDS_CHAR (value))
 184     return (void*) (gssize) g_value_get_char (value);
 185   if (G_VALUE_HOLDS_UCHAR (value))
 186     return (void*) (gsize) g_value_get_uchar (value);
 187   if (G_VALUE_HOLDS_INT (value))
 188     return GINT_TO_POINTER(g_value_get_int (value));
 189   if (G_VALUE_HOLDS_UINT (value))
 190     return GUINT_TO_POINTER(g_value_get_uint (value));
 191   if (G_VALUE_HOLDS_LONG (value))
 192     return (void*) g_value_get_long (value);
 193   if (G_VALUE_HOLDS_ULONG (value))
 194     return (void*) g_value_get_ulong (value);
 195   if (G_VALUE_HOLDS_FLOAT (value))
 196     return (void*) (gssize) g_value_get_float (value);
 197   if (G_VALUE_HOLDS_DOUBLE (value))
 198     return (void*) (gssize) g_value_get_double (value);
 199   if (G_VALUE_HOLDS_ENUM (value))
 200     return (void*) (gssize) g_value_get_enum (value);
 201   if (G_VALUE_HOLDS_FLAGS (value))
 202     return (void*) (gsize) g_value_get_flags (value);
 203   return (void*) 0x1373babe;
 204 }
 205
 206 static void
 207 object_test_property (GObject           *object,
 208                       GParamSpec        *pspec,
 209                       double             dvalue)
 210 {
 211   /* test setting of a normal writable property */
 212   if (pspec->flags & G_PARAM_WRITABLE &&
 213       !(pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)))
 214     {
 215       GValue value = G_VALUE_INIT;
 216       guint i;
 217       const IgnoreProperty *ignore_properties;
 218       /* select value to set */
 219       g_value_init (&value, G_PARAM_SPEC_VALUE_TYPE (pspec));
 220       pspec_select_value (pspec, &value, dvalue);
 221       /* ignore untestable properties */
 222       ignore_properties = list_ignore_properties (FALSE);
 223       for (i = 0; ignore_properties[i].name; i++)
 224         if (g_strcmp0 ("", ignore_properties[i].name) ||
 225             (g_type_is_a (G_OBJECT_TYPE (object), g_type_from_name (ignore_properties[i].type_name)) &&
 226              strcmp (pspec->name, ignore_properties[i].name) == 0 &&
 227              (MATCH_ANY_VALUE == ignore_properties[i].value ||
 228               value_as_pointer (&value) == ignore_properties[i].value ||
 229               (G_VALUE_HOLDS_STRING (&value) &&
 230                strcmp (g_value_get_string (&value), ignore_properties[i].value) == 0))))
 231           break;
 232       /* ignore known property bugs if not testing thoroughly */
 233       if (ignore_properties[i].name == NULL && !g_test_thorough ())
 234         {
 235           ignore_properties = list_ignore_properties (TRUE);
 236           for (i = 0; ignore_properties[i].name; i++)
 237             if (g_type_is_a (G_OBJECT_TYPE (object), g_type_from_name (ignore_properties[i].type_name)) &&
 238                 strcmp (pspec->name, ignore_properties[i].name) == 0 &&
 239                 (MATCH_ANY_VALUE == ignore_properties[i].value ||
 240                  value_as_pointer (&value) == ignore_properties[i].value ||
 241                  (G_VALUE_HOLDS_STRING (&value) &&
 242                   strcmp (g_value_get_string (&value), ignore_properties[i].value) == 0)))
 243               break;
 244         }
 245       /* assign unignored properties */
 246       if (ignore_properties[i].name == NULL)
 247         {
 248           if (g_test_verbose ())
 249             g_print ("PropertyTest: %s::%s := (%s value (%s): %p)\n",
 250                      g_type_name (G_OBJECT_TYPE (object)), pspec->name,
 251                      SELECT_NAME (dvalue), g_type_name (G_VALUE_TYPE (&value)),
 252                      value_as_pointer (&value));
 253           g_object_set_property (object, pspec->name, &value);
 254         }
 255       /* cleanups */
 256       g_value_unset (&value);
 257     }
 258 }
 259
 260 static void
 261 widget_test_properties (GtkWidget   *widget,
 262                         double       dvalue)
 263 {
 264   /* try setting all possible properties, according to dvalue */
 265   guint i, n_pspecs = 0;
 266   GParamSpec **pspecs = g_object_class_list_properties (G_OBJECT_GET_CLASS (widget), &n_pspecs);
 267   for (i = 0; i < n_pspecs; i++)
 268     {
 269       GParamSpec *pspec = pspecs[i];
 270       if (pspec->flags & G_PARAM_WRITABLE &&
 271           !(pspec->flags & (G_PARAM_CONSTRUCT | G_PARAM_CONSTRUCT_ONLY)))
 272         object_test_property (G_OBJECT (widget), pspecs[i], dvalue);
 273     }
 274   g_free (pspecs);
 275 }
 276
 277 static void
 278 widget_fixups (GtkWidget *widget)
 279 {
 280   /* post-constructor for widgets that need additional settings to work correctly */
 281   if (GTK_IS_COMBO_BOX (widget))
 282     {
 283       GtkListStore *store = gtk_list_store_new (1, G_TYPE_STRING);
 284       g_object_set (widget, "model", store, NULL);
 285       g_object_unref (store);
 286       gtk_combo_box_append_text (GTK_COMBO_BOX (widget), "test text");
 287     }
 288 }
 289
 290 static void
 291 widget_property_tests (gconstpointer test_data)
 292 {
 293   GType wtype = (GType) test_data;
 294   /* create widget */
 295   GtkWidget *widget = gtk_widget_new (wtype, NULL);
 296   g_object_ref_sink (widget);
 297   widget_fixups (widget);
 298   /* test property values */
 299   widget_test_properties (widget,  +2); /* test default_value */
 300   widget_test_properties (widget,   0); /* test minimum */
 301   widget_test_properties (widget, 0.5); /* test medium */
 302   widget_test_properties (widget,   1); /* test maximum */
 303   widget_test_properties (widget,  -1); /* test random value */
 304   /* cleanup */
 305   gtk_widget_destroy (widget);
 306   g_object_unref (widget);
 307 }
 308
 309 extern void pixbuf_init (void);
 310
 311 /* --- main test program --- */
 312 int
 313 main (int   argc,
 314       char *argv[])
 315 {
 316   const GType *otypes;
 317   guint i;
 318   /* initialize test program */
 319   pixbuf_init ();
 320   gtk_test_init (&argc, &argv);
 321   gtk_test_register_all_types ();
 322   /* install a property test for each widget type */
 323   otypes = gtk_test_list_all_types (NULL);
 324   for (i = 0; otypes[i]; i++)
 325     if (g_type_is_a (otypes[i], GTK_TYPE_WIDGET) &&
 326         G_TYPE_IS_OBJECT (otypes[i]) &&
 327         !G_TYPE_IS_ABSTRACT (otypes[i]))
 328       {
 329         gchar *testpath = g_strdup_printf ("/properties/%s", g_type_name (otypes[i]));
 330         g_test_add_data_func (testpath, (void*) otypes[i], widget_property_tests);
 331         g_free (testpath);
 332       }
 333   return g_test_run ();
 334 }