g_list_store_splice: Add items in the order of the input array and at the given position

It inserted the new items one position after the given one and inserted all new items
at the same position resulting in the items being in the reverse order of the
input array.

It was decided to make these behavioural changes because this function has according to
https://codesearch.debian.net/search?q=g_list_store_splice only one real user (nautilus)
and it didn't do what one would expect from reading the documentation.

https://bugzilla.gnome.org/show_bug.cgi?id=795307
This commit is contained in:
Christoph Reiter 2018-04-24 18:00:51 +02:00
parent 1af84aa435
commit 758d7073a9
2 changed files with 108 additions and 1 deletions

View File

@ -477,7 +477,6 @@ g_list_store_splice (GListStore *store,
{
gint i;
it = g_sequence_iter_next (it);
for (i = 0; i < n_additions; i++)
{
if G_UNLIKELY (!g_type_is_a (G_OBJECT_TYPE (additions[i]), store->item_type))
@ -488,6 +487,7 @@ g_list_store_splice (GListStore *store,
}
it = g_sequence_insert_before (it, g_object_ref (additions[i]));
it = g_sequence_iter_next (it);
}
}

View File

@ -216,13 +216,120 @@ test_store_sorted (void)
g_object_unref (store);
}
/* Test that using splice() to replace the middle element in a list store works. */
static void
test_store_splice_replace_middle (void)
{
GListStore *store;
GListModel *model;
GAction *item;
GPtrArray *array;
g_test_bug ("795307");
store = g_list_store_new (G_TYPE_SIMPLE_ACTION);
model = G_LIST_MODEL (store);
array = g_ptr_array_new_full (0, g_object_unref);
g_ptr_array_add (array, g_simple_action_new ("1", NULL));
g_ptr_array_add (array, g_simple_action_new ("2", NULL));
g_ptr_array_add (array, g_simple_action_new ("3", NULL));
g_ptr_array_add (array, g_simple_action_new ("4", NULL));
g_ptr_array_add (array, g_simple_action_new ("5", NULL));
/* Add three items through splice */
g_list_store_splice (store, 0, 0, array->pdata, 3);
g_assert_cmpuint (g_list_model_get_n_items (model), ==, 3);
item = g_list_model_get_item (model, 0);
g_assert_cmpstr (g_action_get_name (item), ==, "1");
g_object_unref (item);
item = g_list_model_get_item (model, 1);
g_assert_cmpstr (g_action_get_name (item), ==, "2");
g_object_unref (item);
item = g_list_model_get_item (model, 2);
g_assert_cmpstr (g_action_get_name (item), ==, "3");
g_object_unref (item);
/* Replace the middle one with two new items */
g_list_store_splice (store, 1, 1, array->pdata + 3, 2);
g_assert_cmpuint (g_list_model_get_n_items (model), ==, 4);
item = g_list_model_get_item (model, 0);
g_assert_cmpstr (g_action_get_name (item), ==, "1");
g_object_unref (item);
item = g_list_model_get_item (model, 1);
g_assert_cmpstr (g_action_get_name (item), ==, "4");
g_object_unref (item);
item = g_list_model_get_item (model, 2);
g_assert_cmpstr (g_action_get_name (item), ==, "5");
g_object_unref (item);
item = g_list_model_get_item (model, 3);
g_assert_cmpstr (g_action_get_name (item), ==, "3");
g_object_unref (item);
g_ptr_array_unref (array);
g_object_unref (store);
}
/* Test that using splice() to replace the whole list store works. */
static void
test_store_splice_replace_all (void)
{
GListStore *store;
GListModel *model;
GPtrArray *array;
GAction *item;
g_test_bug ("795307");
store = g_list_store_new (G_TYPE_SIMPLE_ACTION);
model = G_LIST_MODEL (store);
array = g_ptr_array_new_full (0, g_object_unref);
g_ptr_array_add (array, g_simple_action_new ("1", NULL));
g_ptr_array_add (array, g_simple_action_new ("2", NULL));
g_ptr_array_add (array, g_simple_action_new ("3", NULL));
g_ptr_array_add (array, g_simple_action_new ("4", NULL));
/* Add the first two */
g_list_store_splice (store, 0, 0, array->pdata, 2);
g_assert_cmpuint (g_list_model_get_n_items (model), ==, 2);
item = g_list_model_get_item (model, 0);
g_assert_cmpstr (g_action_get_name (item), ==, "1");
g_object_unref (item);
item = g_list_model_get_item (model, 1);
g_assert_cmpstr (g_action_get_name (item), ==, "2");
g_object_unref (item);
/* Replace all with the last two */
g_list_store_splice (store, 0, 2, array->pdata + 2, 2);
g_assert_cmpuint (g_list_model_get_n_items (model), ==, 2);
item = g_list_model_get_item (model, 0);
g_assert_cmpstr (g_action_get_name (item), ==, "3");
g_object_unref (item);
item = g_list_model_get_item (model, 1);
g_assert_cmpstr (g_action_get_name (item), ==, "4");
g_object_unref (item);
g_ptr_array_unref (array);
g_object_unref (store);
}
int main (int argc, char *argv[])
{
g_test_init (&argc, &argv, NULL);
g_test_bug_base ("https://bugzilla.gnome.org/");
g_test_add_func ("/glistmodel/store/boundaries", test_store_boundaries);
g_test_add_func ("/glistmodel/store/refcounts", test_store_refcounts);
g_test_add_func ("/glistmodel/store/sorted", test_store_sorted);
g_test_add_func ("/glistmodel/store/splice-replace-middle",
test_store_splice_replace_middle);
g_test_add_func ("/glistmodel/store/splice-replace-all",
test_store_splice_replace_all);
return g_test_run ();
}