[gtk] testsuite: Add slice model tests

[Benjamin Otte <otte src gnome org>]

commit 9430b0b6ee3eae95cfa137508df53937a7126b6a
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun Jan 6 12:25:50 2019 -0500

    testsuite: Add slice model tests
    
    Do the same style of tests we do for all the
    other list models. These tests found the issue
    fixed in the previous commit.

 testsuite/gtk/meson.build      |   1 +
 testsuite/gtk/slicelistmodel.c | 341 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 342 insertions(+)
---
diff --git a/testsuite/gtk/meson.build b/testsuite/gtk/meson.build
index 912dbb409a..e4e9eec959 100644
--- a/testsuite/gtk/meson.build
+++ b/testsuite/gtk/meson.build
@@ -44,6 +44,7 @@ tests = [
   ['regression-tests'],
   ['scrolledwindow'],
   ['searchbar'],
+  ['slicelistmodel'],
   ['sortlistmodel'],
   ['spinbutton'],
   ['stylecontext'],
diff --git a/testsuite/gtk/slicelistmodel.c b/testsuite/gtk/slicelistmodel.c
new file mode 100644
index 0000000000..960133c805
--- /dev/null
+++ b/testsuite/gtk/slicelistmodel.c
@@ -0,0 +1,341 @@
+/* 
+ * Copyright (C) 2019, Red Hat, Inc.
+ * Authors: Matthias Clasen <mclasen redhat com>
+ *
+ * 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, see <http://www.gnu.org/licenses/>.
+ */
+
+#include <locale.h>
+
+#include <gtk/gtk.h>
+
+static GQuark number_quark;
+static GQuark changes_quark;
+
+static guint
+get (GListModel *model,
+     guint       position)
+{
+  GObject *object = g_list_model_get_item (model, position);
+  g_assert (object != NULL);
+  return GPOINTER_TO_UINT (g_object_get_qdata (object, number_quark));
+}
+
+static char *
+model_to_string (GListModel *model)
+{
+  GString *string = g_string_new (NULL);
+  guint i;
+
+  for (i = 0; i < g_list_model_get_n_items (model); i++)
+    {
+      if (i > 0)
+        g_string_append (string, " ");
+      g_string_append_printf (string, "%u", get (model, i));
+    }
+
+  return g_string_free (string, FALSE);
+}
+
+static GListStore *
+new_store (guint start,
+           guint end,
+           guint step);
+
+static GObject *
+make_object (guint number)
+{
+  GObject *object;
+
+  /* 0 cannot be differentiated from NULL, so don't use it */
+  g_assert (number != 0);
+
+  object = g_object_new (G_TYPE_OBJECT, NULL);
+  g_object_set_qdata (object, number_quark, GUINT_TO_POINTER (number));
+
+  return object;
+}
+
+static void
+splice (GListStore *store,
+        guint       pos,
+        guint       removed,
+        guint      *numbers,
+        guint       added)
+{
+  GObject *objects[added];
+  guint i;
+
+  for (i = 0; i < added; i++)
+    objects[i] = make_object (numbers[i]);
+
+  g_list_store_splice (store, pos, removed, (gpointer *) objects, added);
+
+  for (i = 0; i < added; i++)
+    g_object_unref (objects[i]);
+}
+
+static void
+add (GListStore *store,
+     guint       number)
+{
+  GObject *object = make_object (number);
+  g_list_store_append (store, object);
+  g_object_unref (object);
+}
+
+static void
+insert (GListStore *store,
+        guint position,
+        guint number)
+{
+  GObject *object = make_object (number);
+  g_list_store_insert (store, position, object);
+  g_object_unref (object);
+}
+
+#define assert_model(model, expected) G_STMT_START{ \
+  char *s = model_to_string (G_LIST_MODEL (model)); \
+  if (!g_str_equal (s, expected)) \
+     g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
+         #model " == " #expected, s, "==", expected); \
+  g_free (s); \
+}G_STMT_END
+
+#define assert_changes(model, expected) G_STMT_START{ \
+  GString *changes = g_object_get_qdata (G_OBJECT (model), changes_quark); \
+  if (!g_str_equal (changes->str, expected)) \
+     g_assertion_message_cmpstr (G_LOG_DOMAIN, __FILE__, __LINE__, G_STRFUNC, \
+         #model " == " #expected, changes->str, "==", expected); \
+  g_string_set_size (changes, 0); \
+}G_STMT_END
+
+static GListStore *
+new_empty_store (void)
+{
+  return g_list_store_new (G_TYPE_OBJECT);
+}
+
+static GListStore *
+new_store (guint start,
+           guint end,
+           guint step)
+{
+  GListStore *store = new_empty_store ();
+  guint i;
+
+  for (i = start; i <= end; i += step)
+    add (store, i);
+
+  return store;
+}
+
+static void
+items_changed (GListModel *model,
+               guint       position,
+               guint       removed,
+               guint       added,
+               GString    *changes)
+{
+  g_assert (removed != 0 || added != 0);
+
+  if (changes->len)
+    g_string_append (changes, ", ");
+
+  if (removed == 1 && added == 0)
+    {
+      g_string_append_printf (changes, "-%u", position);
+    }
+  else if (removed == 0 && added == 1)
+    {
+      g_string_append_printf (changes, "+%u", position);
+    }
+  else
+    {
+      g_string_append_printf (changes, "%u", position);
+      if (removed > 0)
+        g_string_append_printf (changes, "-%u", removed);
+      if (added > 0)
+        g_string_append_printf (changes, "+%u", added);
+    }
+}
+
+static void
+free_changes (gpointer data)
+{
+  GString *changes = data;
+
+  /* all changes must have been checked via assert_changes() before */
+  g_assert_cmpstr (changes->str, ==, "");
+
+  g_string_free (changes, TRUE);
+}
+
+static GtkSliceListModel *
+new_model (GListStore *store, guint offset, guint size)
+{
+  GtkSliceListModel *result;
+  GString *changes;
+
+  result = gtk_slice_list_model_new_for_type (G_TYPE_OBJECT);
+  if (store)
+    gtk_slice_list_model_set_model (result, G_LIST_MODEL (store));
+  gtk_slice_list_model_set_offset (result, offset);
+  gtk_slice_list_model_set_size (result, size);
+
+  changes = g_string_new ("");
+  g_object_set_qdata_full (G_OBJECT(result), changes_quark, changes, free_changes);
+  g_signal_connect (result, "items-changed", G_CALLBACK (items_changed), changes);
+
+  return result;
+}
+
+static void
+test_create_empty (void)
+{
+  GtkSliceListModel *slice;
+
+  slice = new_model (NULL, 0, 0);
+  assert_model (slice, "");
+  assert_changes (slice, "");
+
+  g_object_unref (slice);
+}
+
+static void
+test_create (void)
+{
+  GtkSliceListModel *slice;
+  GListStore *store;
+  
+  store = new_store (1, 5, 2);
+  slice = new_model (store, 0, 10);
+  assert_model (slice, "1 3 5");
+  assert_changes (slice, "");
+
+  g_object_unref (store);
+  assert_model (slice, "1 3 5");
+  assert_changes (slice, "");
+
+  g_object_unref (slice);
+}
+
+static void
+test_set_model (void)
+{
+  GtkSliceListModel *slice;
+  GListStore *store;
+  
+  slice = new_model (NULL, 0, 2);
+  assert_model (slice, "");
+  assert_changes (slice, "");
+
+  store = new_store (1, 7, 2);
+  gtk_slice_list_model_set_model (slice, G_LIST_MODEL (store));
+  assert_model (slice, "1 3");
+  assert_changes (slice, "0+2");
+
+  gtk_slice_list_model_set_model (slice, NULL);
+  assert_model (slice, "");
+  assert_changes (slice, "0-2");
+
+  g_object_unref (store);
+  g_object_unref (slice);
+}
+
+static void
+test_set_slice (void)
+{
+  GtkSliceListModel *slice;
+  GListStore *store;
+  
+  store = new_store (1, 7, 2);
+  slice = new_model (store, 0, 3);
+  assert_model (slice, "1 3 5");
+  assert_changes (slice, "");
+
+  gtk_slice_list_model_set_offset (slice, 1);
+  assert_model (slice, "3 5 7");
+  assert_changes (slice, "0-3+3");
+
+  gtk_slice_list_model_set_size (slice, 2);
+  assert_model (slice, "3 5");
+  assert_changes (slice, "-2");
+
+  gtk_slice_list_model_set_size (slice, 10);
+  assert_model (slice, "3 5 7");
+  assert_changes (slice, "+2");
+
+  g_object_unref (store);
+  g_object_unref (slice);
+}
+
+static void
+test_changes (void)
+{
+  GtkSliceListModel *slice;
+  GListStore *store;
+  
+  store = new_store (1, 20, 1);
+  slice = new_model (store, 10, 5);
+  assert_model (slice, "11 12 13 14 15");
+  assert_changes (slice, "");
+
+  g_list_store_remove (store, 19);
+  assert_changes (slice, "");
+
+  g_list_store_remove (store, 1);
+  assert_model (slice, "12 13 14 15 16");
+  assert_changes (slice, "0-5+5");
+
+  insert (store, 12, 99);
+  assert_model (slice, "12 13 99 14 15");
+  assert_changes (slice, "2-3+3");
+
+  splice (store, 13, 6, (guint[]) { 97 }, 1);
+  assert_model (slice, "12 13 99 97");
+  assert_changes (slice, "3-2+1");
+
+  splice (store, 13, 1, (guint[]) { 36, 37, 38 }, 3);
+  assert_model (slice, "12 13 99 36 37");
+  assert_changes (slice, "3-1+2");
+
+  g_list_store_remove_all (store);
+  assert_model (slice, "");
+  assert_changes (slice, "0-5");
+
+  g_object_unref (store);
+  g_object_unref (slice);
+}
+
+int
+main (int argc, char *argv[])
+{
+  g_test_init (&argc, &argv, NULL);
+  setlocale (LC_ALL, "C");
+  g_test_bug_base ("http://bugzilla.gnome.org/show_bug.cgi?id=%s";);
+
+  number_quark = g_quark_from_static_string ("Hell and fire was spawned to be released.");
+  changes_quark = g_quark_from_static_string ("What did I see? Can I believe what I saw?");
+
+  g_test_add_func ("/slicelistmodel/create_empty", test_create_empty);
+  g_test_add_func ("/slicelistmodel/create", test_create);
+  g_test_add_func ("/slicelistmodel/set-model", test_set_model);
+  g_test_add_func ("/slicelistmodel/set-slice", test_set_slice);
+#if GLIB_CHECK_VERSION (2, 58, 0) /* g_list_store_splice() is broken before 2.58 */
+  g_test_add_func ("/slicelistmodel/changes", test_changes);
+#endif
+
+  return g_test_run ();
+}