/* * Copyright (C) 2022, Red Hat, Inc. * Authors: Matthias Clasen * * 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 . */ #include #include static GQuark number_quark; static GQuark changes_quark; static GQuark selection_quark; static guint get (GListModel *model, guint position) { guint number; GObject *object = g_list_model_get_item (model, position); g_assert_nonnull (object); number = GPOINTER_TO_UINT (g_object_get_qdata (object, number_quark)); g_object_unref (object); return number; } 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 char * section_model_to_string (GListModel *model) { GString *string; guint i, s, e, n; if (!GTK_IS_SECTION_MODEL (model)) return model_to_string (model); string = g_string_new (NULL); n = g_list_model_get_n_items (model); i = 0; while (i < n) { gtk_section_model_get_section (GTK_SECTION_MODEL (model), i, &s, &e); if (i > 0) g_string_append (string, " "); g_string_append (string, "["); for (; i < e; i++) { if (i > s) g_string_append (string, " "); g_string_append_printf (string, "%u", get (model, i)); } g_string_append (string, "]"); i = e; } return g_string_free (string, FALSE); } static char * selection_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 (!gtk_selection_model_is_selected (GTK_SELECTION_MODEL (model), i)) continue; if (string->len > 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_cmpint (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 = g_newa (GObject *, 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_section_model(model, expected) G_STMT_START{ \ char *s = section_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 ignore_changes(model) G_STMT_START{ \ GString *changes = g_object_get_qdata (G_OBJECT (model), changes_quark); \ g_string_set_size (changes, 0); \ }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 #define assert_selection(model, expected) G_STMT_START{ \ char *s = selection_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_selection_changes(model, expected) G_STMT_START{ \ GString *changes = g_object_get_qdata (G_OBJECT (model), selection_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 #define ignore_selection_changes(model) G_STMT_START{ \ GString *changes = g_object_get_qdata (G_OBJECT (model), selection_quark); \ 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_true (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 sections_changed (GListModel *model, guint position, guint n_items, GString *changes) { g_assert_true (n_items != 0); if (changes->len) g_string_append (changes, ", "); g_string_append_printf (changes, "s%u:%u", position, n_items); } static void notify_n_items (GObject *object, GParamSpec *pspec, GString *changes) { g_string_append_c (changes, '*'); } static void selection_changed (GListModel *model, guint position, guint n_items, GString *changes) { if (changes->len) g_string_append (changes, ", "); g_string_append_printf (changes, "%u:%u", position, n_items); } 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 GtkSelectionModel * new_model (GListModel *store, gboolean autoselect, gboolean can_unselect) { GtkSelectionModel *result; GString *changes; result = GTK_SELECTION_MODEL (gtk_no_selection_new (g_object_ref (store))); 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); g_signal_connect (result, "sections-changed", G_CALLBACK (sections_changed), changes); g_signal_connect (result, "notify::n-items", G_CALLBACK (notify_n_items), changes); changes = g_string_new (""); g_object_set_qdata_full (G_OBJECT(result), selection_quark, changes, free_changes); g_signal_connect (result, "selection-changed", G_CALLBACK (selection_changed), changes); return result; } static void test_create (void) { GtkSelectionModel *selection; GListStore *store; if (glib_check_version (2, 59, 0) != NULL) { g_test_skip ("g_list_store_get_item() has overflow issues before GLIB 2.59.0"); return; } store = new_store (1, 5, 2); selection = new_model (G_LIST_MODEL (store), FALSE, FALSE); assert_model (selection, "1 3 5"); assert_changes (selection, ""); assert_selection (selection, ""); assert_selection_changes (selection, ""); g_object_unref (store); assert_model (selection, "1 3 5"); assert_changes (selection, ""); assert_selection (selection, ""); assert_selection_changes (selection, ""); g_object_unref (selection); } static void test_create_empty (void) { GtkSingleSelection *selection; selection = gtk_single_selection_new (NULL); g_assert_cmpint (g_list_model_get_n_items (G_LIST_MODEL (selection)), ==, 0); g_object_unref (selection); } static void test_changes (void) { GtkSelectionModel *selection; GListStore *store; if (glib_check_version (2, 58, 0) != NULL) { g_test_skip ("g_list_store_splice() is broken before GLIB 2.58.0"); return; } store = new_store (1, 5, 1); selection = new_model (G_LIST_MODEL (store), FALSE, FALSE); assert_model (selection, "1 2 3 4 5"); assert_changes (selection, ""); assert_selection (selection, ""); assert_selection_changes (selection, ""); g_list_store_remove (store, 3); assert_model (selection, "1 2 3 5"); assert_changes (selection, "-3*"); assert_selection (selection, ""); assert_selection_changes (selection, ""); insert (store, 3, 99); assert_model (selection, "1 2 3 99 5"); assert_changes (selection, "+3*"); assert_selection (selection, ""); assert_selection_changes (selection, ""); splice (store, 3, 2, (guint[]) { 97 }, 1); assert_model (selection, "1 2 3 97"); assert_changes (selection, "3-2+1*"); assert_selection (selection, ""); assert_selection_changes (selection, ""); g_object_unref (selection); g_object_unref (store); } static void test_selection (void) { GtkSelectionModel *selection; GListStore *store; gboolean ret; if (glib_check_version (2, 59, 0) != NULL) { g_test_skip ("g_list_store_get_item() has overflow issues before GLIB 2.59.0"); return; } store = new_store (1, 5, 1); selection = new_model (G_LIST_MODEL (store), TRUE, FALSE); assert_selection (selection, ""); assert_selection_changes (selection, ""); ret = gtk_selection_model_select_item (selection, 3, FALSE); g_assert_false (ret); assert_selection (selection, ""); assert_selection_changes (selection, ""); ret = gtk_selection_model_unselect_item (selection, 3); g_assert_false (ret); assert_selection (selection, ""); assert_selection_changes (selection, ""); ret = gtk_selection_model_select_item (selection, 1, FALSE); g_assert_false (ret); assert_selection (selection, ""); assert_selection_changes (selection, ""); ret = gtk_selection_model_select_range (selection, 3, 2, FALSE); g_assert_false (ret); assert_selection (selection, ""); assert_selection_changes (selection, ""); ret = gtk_selection_model_unselect_range (selection, 4, 2); g_assert_false (ret); assert_selection (selection, ""); assert_selection_changes (selection, ""); ret = gtk_selection_model_select_all (selection); g_assert_false (ret); assert_selection (selection, ""); assert_selection_changes (selection, ""); ret = gtk_selection_model_unselect_all (selection); g_assert_false (ret); assert_selection (selection, ""); assert_selection_changes (selection, ""); g_object_unref (store); g_object_unref (selection); } static void check_get_selection (GtkSelectionModel *selection) { GtkBitset *set; guint i, n_items; set = gtk_selection_model_get_selection (selection); n_items = g_list_model_get_n_items (G_LIST_MODEL (selection)); if (n_items == 0) { g_assert_true (gtk_bitset_is_empty (set)); } else { for (i = 0; i < n_items; i++) { g_assert_cmpint (gtk_bitset_contains (set, i), ==, gtk_selection_model_is_selected (selection, i)); } /* check that out-of-range has no bits set */ g_assert_cmpint (gtk_bitset_get_maximum (set), <, g_list_model_get_n_items (G_LIST_MODEL (selection))); } gtk_bitset_unref (set); } static void test_query_range (void) { GtkSelectionModel *selection; GListStore *store; store = new_store (1, 5, 1); selection = new_model (G_LIST_MODEL (store), TRUE, TRUE); check_get_selection (selection); gtk_selection_model_unselect_item (selection, 0); check_get_selection (selection); gtk_selection_model_select_item (selection, 2, TRUE); check_get_selection (selection); gtk_selection_model_select_item (selection, 4, TRUE); check_get_selection (selection); ignore_selection_changes (selection); g_object_unref (store); g_object_unref (selection); } static void test_set_model (void) { GtkSelectionModel *selection; GListStore *store; GListModel *m1, *m2; store = new_store (1, 5, 1); m1 = G_LIST_MODEL (store); m2 = G_LIST_MODEL (gtk_slice_list_model_new (g_object_ref (m1), 0, 3)); selection = new_model (G_LIST_MODEL (store), TRUE, TRUE); assert_selection (selection, ""); assert_selection_changes (selection, ""); /* we retain the selected item across model changes */ gtk_no_selection_set_model (GTK_NO_SELECTION (selection), m2); assert_changes (selection, "0-5+3*"); assert_selection (selection, ""); assert_selection_changes (selection, ""); gtk_no_selection_set_model (GTK_NO_SELECTION (selection), m1); assert_changes (selection, "0-3+5*"); assert_selection (selection, ""); assert_selection_changes (selection, ""); gtk_no_selection_set_model (GTK_NO_SELECTION (selection), m2); assert_changes (selection, "0-5+3*"); assert_selection (selection, ""); assert_selection_changes (selection, ""); /* we retain no selected item across model changes */ gtk_no_selection_set_model (GTK_NO_SELECTION (selection), m1); assert_changes (selection, "0-3+5*"); assert_selection (selection, ""); assert_selection_changes (selection, ""); gtk_no_selection_set_model (GTK_NO_SELECTION (selection), m1); assert_changes (selection, ""); assert_selection (selection, ""); assert_selection_changes (selection, ""); g_object_unref (m2); g_object_unref (m1); g_object_unref (selection); } static void test_empty (void) { GtkNoSelection *selection; GListStore *store; selection = gtk_no_selection_new (NULL); g_assert_cmpuint (g_list_model_get_n_items (G_LIST_MODEL (selection)), ==, 0); g_assert_null (g_list_model_get_item (G_LIST_MODEL (selection), 11)); g_assert_true (g_list_model_get_item_type (G_LIST_MODEL (selection)) == G_TYPE_OBJECT); g_assert_null (gtk_no_selection_get_model (GTK_NO_SELECTION (selection))); store = g_list_store_new (G_TYPE_OBJECT); gtk_no_selection_set_model (selection, G_LIST_MODEL (store)); g_object_unref (store); g_assert_cmpuint (g_list_model_get_n_items (G_LIST_MODEL (selection)), ==, 0); g_assert_null (g_list_model_get_item (G_LIST_MODEL (selection), 11)); g_object_unref (selection); } static int by_n (gconstpointer p1, gconstpointer p2, gpointer data) { guint n1 = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (p1), number_quark)); guint n2 = GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (p2), number_quark)); unsigned int n = GPOINTER_TO_UINT (data); n1 = n1 / n; n2 = n2 / n; if (n1 < n2) return -1; else if (n1 > n2) return 1; else return 0; } static int compare (gconstpointer first, gconstpointer second, gpointer unused) { return GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (first), number_quark)) - GPOINTER_TO_UINT (g_object_get_qdata (G_OBJECT (second), number_quark)); } static void test_sections (void) { GListStore *store; GtkSortListModel *sorted; GtkSelectionModel *selection; GtkSorter *sorter; store = new_store (1, 10, 1); sorted = gtk_sort_list_model_new (G_LIST_MODEL (store), GTK_SORTER (gtk_custom_sorter_new (compare, NULL, NULL))); selection = new_model (G_LIST_MODEL (sorted), TRUE, TRUE); assert_model (selection, "1 2 3 4 5 6 7 8 9 10"); assert_section_model (selection, "[1 2 3 4 5 6 7 8 9 10]"); assert_changes (selection, ""); sorter = GTK_SORTER (gtk_custom_sorter_new (by_n, GUINT_TO_POINTER (3), NULL)); gtk_sort_list_model_set_section_sorter (sorted, sorter); g_object_unref (sorter); assert_section_model (selection, "[1 2] [3 4 5] [6 7 8] [9 10]"); assert_changes (selection, "s0:10"); gtk_section_model_sections_changed (GTK_SECTION_MODEL (sorted), 0, 3); assert_changes (selection, "s0:3"); gtk_section_model_sections_changed (GTK_SECTION_MODEL (sorted), 5, 3); assert_changes (selection, "s5:3"); g_object_unref (selection); } int main (int argc, char *argv[]) { (g_test_init) (&argc, &argv, NULL); setlocale (LC_ALL, "C"); 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?"); selection_quark = g_quark_from_static_string ("Mana mana, badibidibi"); g_test_add_func ("/noselection/create", test_create); g_test_add_func ("/noselection/create-empty", test_create_empty); g_test_add_func ("/noselection/selection", test_selection); g_test_add_func ("/noselection/query-range", test_query_range); g_test_add_func ("/noselection/changes", test_changes); g_test_add_func ("/noselection/set-model", test_set_model); g_test_add_func ("/noselection/empty", test_empty); g_test_add_func ("/noselection/sections", test_sections); return g_test_run (); }