[gtk/wip/otte/sortlistmodel: 25/38] Add another incremental sort model

[Benjamin Otte <otte src gnome org>]

commit 86878fbbef5179486fdb8d95d263fe318fc81c4a
Author: Matthias Clasen <mclasen redhat com>
Date:   Wed Jul 8 01:49:59 2020 -0400

    Add another incremental sort model
    
    This one uses a very simple iterative mergesort.

 gtk/gtk.h              |   1 +
 gtk/gtksor5listmodel.c | 549 +++++++++++++++++++++++++++++++++++++++++++++++++
 gtk/gtksor5listmodel.h |  57 +++++
 gtk/meson.build        |   2 +
 4 files changed, 609 insertions(+)
---
diff --git a/gtk/gtk.h b/gtk/gtk.h
index a39a713b51..f19db0664a 100644
--- a/gtk/gtk.h
+++ b/gtk/gtk.h
@@ -236,6 +236,7 @@
 #include <gtk/gtksorter.h>
 #include <gtk/gtksor2listmodel.h>
 #include <gtk/gtksor4listmodel.h>
+#include <gtk/gtksor5listmodel.h>
 #include <gtk/gtksortlistmodel.h>
 #include <gtk/gtkstacksidebar.h>
 #include <gtk/gtksizegroup.h>
diff --git a/gtk/gtksor5listmodel.c b/gtk/gtksor5listmodel.c
new file mode 100644
index 0000000000..eabcd0c6d9
--- /dev/null
+++ b/gtk/gtksor5listmodel.c
@@ -0,0 +1,549 @@
+/*
+ * Copyright © 2018 Benjamin Otte
+ *
+ * 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.1 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/>.
+ *
+ * Authors: Benjamin Otte <otte gnome org>
+ */
+
+#include "config.h"
+
+#include "gtksor5listmodel.h"
+
+#include "gtkintl.h"
+#include "gtkprivate.h"
+
+#define GDK_ARRAY_ELEMENT_TYPE GObject *
+#define GDK_ARRAY_TYPE_NAME SortArray
+#define GDK_ARRAY_NAME sort_array
+#define GDK_ARRAY_FREE_FUNC g_object_unref
+#define GDK_ARRAY_PREALLOC 16
+#include "gdk/gdkarrayimpl.c"
+
+/**
+ * SECTION:gtksor5listmodel
+ * @title: GtkSor5ListModel
+ * @short_description: A list model that sorts its items
+ * @see_also: #GListModel, #GtkSorter
+ *
+ * #GtkSor5ListModel is a list model that takes a list model and
+ * sorts its elements according to a #GtkSorter.
+ *
+ * #GtkSor5ListModel is a generic model and because of that it
+ * cannot take advantage of any external knowledge when sorting.
+ * If you run into performance issues with #GtkSor5ListModel, it
+ * is strongly recommended that you write your own sorting list
+ * model.
+ */
+
+enum {
+  PROP_0,
+  PROP_MODEL,
+  PROP_SORTER,
+  NUM_PROPERTIES
+};
+
+struct _GtkSor5ListModel
+{
+  GObject parent_instance;
+
+  GListModel *model;
+  GtkSorter *sorter;
+
+  SortArray items; /* empty if known unsorted */
+
+  guint sorting_cb;
+  guint size;
+  guint start;
+};
+
+struct _GtkSor5ListModelClass
+{
+  GObjectClass parent_class;
+};
+
+static GParamSpec *properties[NUM_PROPERTIES] = { NULL, };
+
+static GType
+gtk_sor5_list_model_get_item_type (GListModel *list)
+{
+  return G_TYPE_OBJECT;
+}
+
+static guint
+gtk_sor5_list_model_get_n_items (GListModel *list)
+{
+  GtkSor5ListModel *self = GTK_SOR5_LIST_MODEL (list);
+
+  if (self->model == NULL)
+    return 0;
+
+  return g_list_model_get_n_items (self->model);
+}
+
+static gpointer
+gtk_sor5_list_model_get_item (GListModel *list,
+                              guint       position)
+{
+  GtkSor5ListModel *self = GTK_SOR5_LIST_MODEL (list);
+
+  if (self->model == NULL)
+    return NULL;
+
+  if (sort_array_is_empty (&self->items))
+    return g_list_model_get_item (self->model, position);
+
+  if (position >= sort_array_get_size (&self->items))
+    return NULL;
+
+  return g_object_ref (sort_array_get (&self->items, position));
+}
+
+static void
+gtk_sor5_list_model_model_init (GListModelInterface *iface)
+{
+  iface->get_item_type = gtk_sor5_list_model_get_item_type;
+  iface->get_n_items = gtk_sor5_list_model_get_n_items;
+  iface->get_item = gtk_sor5_list_model_get_item;
+}
+
+G_DEFINE_TYPE_WITH_CODE (GtkSor5ListModel, gtk_sor5_list_model, G_TYPE_OBJECT,
+                         G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL, gtk_sor5_list_model_model_init))
+
+static void
+gtk_sor5_list_model_clear_items (GtkSor5ListModel *self)
+{
+  sort_array_clear (&self->items);
+}
+
+static void
+gtk_sor5_list_model_create_items (GtkSor5ListModel *self)
+{
+  guint i, n_items;
+
+  if (self->sorter == NULL ||
+      self->model == NULL ||
+      gtk_sorter_get_order (self->sorter) == GTK_SORTER_ORDER_NONE)
+    return;
+
+  n_items = g_list_model_get_n_items (self->model);
+  sort_array_reserve (&self->items, n_items);
+  for (i = 0; i < n_items; i++)
+    sort_array_append (&self->items, g_list_model_get_item (self->model, i));
+}
+
+static void
+gtk_sor5_list_model_stop_sorting (GtkSor5ListModel *self)
+{
+  g_clear_handle_id (&self->sorting_cb, g_source_remove);
+}
+
+static guint
+merge (SortArray *items,
+       guint      start,
+       guint      mid,
+       guint      end,
+       GtkSorter *sorter)
+{
+  int start2 = mid + 1;
+  int c = 0;
+
+  if (mid == end)
+    return 0;
+
+  if (gtk_sorter_compare (sorter,
+                          sort_array_get (items, mid),
+                          sort_array_get (items, start2)) <= 0)
+    return 1;
+
+  while (start <= mid && start2 <= end)
+    {
+      c++;
+      if (gtk_sorter_compare (sorter,
+                              sort_array_get (items, start),
+                              sort_array_get (items, start2)) <= 0)
+        start++;
+      else
+        {
+          GObject *value = sort_array_get (items, start2);
+          int index = start2;
+
+          while (index != start)
+            {
+              c++;
+              *sort_array_index (items, index) = sort_array_get (items, index - 1);
+              index--;
+            }
+
+          c++;
+          *sort_array_index (items, start) = value;
+
+          start++;
+          mid++;
+          start2++;
+        }
+    }
+
+  return c;
+}
+
+static gboolean
+gtk_sor5_list_model_sort_cb (gpointer data)
+{
+  GtkSor5ListModel *self = GTK_SOR5_LIST_MODEL (data);
+  guint n_items = sort_array_get_size (&self->items);
+  guint i;
+  guint s, e;
+
+  s = self->start;
+  e = self->start;
+
+  i = 0;
+  while (i < 10000)
+    {
+      guint mid = MIN (self->start + self->size - 1, n_items - 1);
+      guint end = MIN (self->start + 2 * self->size - 1, n_items - 1);
+
+      i += merge (&self->items, self->start, mid, end, self->sorter);
+
+      s = MIN (s, self->start);
+      e = MAX (e, end);
+
+      self->start += 2 * self->size;
+      if (self->start >= n_items - 1)
+        {
+          self->start = 0;
+          self->size *= 2;
+          if (self->size >= n_items)
+            {
+              gtk_sor5_list_model_stop_sorting (self);
+              break;
+            }
+        }
+    }
+
+  //g_print ("items changed %u:%u\n", s, e - s + 1);
+  g_list_model_items_changed (G_LIST_MODEL (self), s, e - s + 1, e - s + 1);
+
+  return G_SOURCE_CONTINUE;
+}
+
+static void
+gtk_sor5_list_model_start_sorting (GtkSor5ListModel *self)
+{
+  if (sort_array_get_size (&self->items) == 0)
+    return;
+
+  g_assert (self->sorting_cb == 0);
+
+  self->size = 1;
+  self->start = 0;
+
+  self->sorting_cb = g_idle_add (gtk_sor5_list_model_sort_cb, self);
+  g_source_set_name_by_id (self->sorting_cb, "[gtk] gtk_sor5_list_model_sort_cb");
+}
+
+static void
+gtk_sor5_list_model_resort (GtkSor5ListModel *self)
+{
+  gtk_sor5_list_model_stop_sorting (self);
+  gtk_sor5_list_model_start_sorting (self);
+}
+
+static void
+gtk_sor5_list_model_items_changed_cb (GListModel       *model,
+                                      guint             position,
+                                      guint             removed,
+                                      guint             added,
+                                      GtkSor5ListModel *self)
+{
+  guint n_items;
+
+  /* doesn't free() the array */
+  sort_array_set_size (&self->items, 0);
+  gtk_sor5_list_model_create_items (self);
+  gtk_sor5_list_model_resort (self);
+
+  n_items = g_list_model_get_n_items (model);
+  g_list_model_items_changed (G_LIST_MODEL (self), 0, n_items - added + removed, n_items);
+}
+
+static void
+gtk_sor5_list_model_set_property (GObject      *object,
+                                  guint         prop_id,
+                                  const GValue *value,
+                                  GParamSpec   *pspec)
+{
+  GtkSor5ListModel *self = GTK_SOR5_LIST_MODEL (object);
+
+  switch (prop_id)
+    {
+    case PROP_MODEL:
+      gtk_sor5_list_model_set_model (self, g_value_get_object (value));
+      break;
+
+    case PROP_SORTER:
+      gtk_sor5_list_model_set_sorter (self, g_value_get_object (value));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    }
+}
+
+static void
+gtk_sor5_list_model_get_property (GObject     *object,
+                                  guint        prop_id,
+                                  GValue      *value,
+                                  GParamSpec  *pspec)
+{
+  GtkSor5ListModel *self = GTK_SOR5_LIST_MODEL (object);
+
+  switch (prop_id)
+    {
+    case PROP_MODEL:
+      g_value_set_object (value, self->model);
+      break;
+
+    case PROP_SORTER:
+      g_value_set_object (value, self->sorter);
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    }
+}
+
+static void
+gtk_sor5_list_model_sorter_changed_cb (GtkSorter        *sorter,
+                                       int               change,
+                                       GtkSor5ListModel *self)
+{
+  guint n_items;
+
+  if (gtk_sorter_get_order (sorter) == GTK_SORTER_ORDER_NONE)
+    gtk_sor5_list_model_clear_items (self);
+  else if (sort_array_is_empty (&self->items))
+    gtk_sor5_list_model_create_items (self);
+
+  gtk_sor5_list_model_resort (self);
+
+  n_items = g_list_model_get_n_items (G_LIST_MODEL (self));
+  if (n_items > 1)
+    g_list_model_items_changed (G_LIST_MODEL (self), 0, n_items, n_items);
+}
+
+static void
+gtk_sor5_list_model_clear_model (GtkSor5ListModel *self)
+{
+  if (self->model == NULL)
+    return;
+
+  g_signal_handlers_disconnect_by_func (self->model, gtk_sor5_list_model_items_changed_cb, self);
+  g_clear_object (&self->model);
+  gtk_sor5_list_model_stop_sorting (self);
+  gtk_sor5_list_model_clear_items (self);
+}
+
+static void
+gtk_sor5_list_model_clear_sorter (GtkSor5ListModel *self)
+{
+  if (self->sorter == NULL)
+    return;
+
+  g_signal_handlers_disconnect_by_func (self->sorter, gtk_sor5_list_model_sorter_changed_cb, self);
+  g_clear_object (&self->sorter);
+  gtk_sor5_list_model_stop_sorting (self);
+  gtk_sor5_list_model_clear_items (self);
+}
+
+static void
+gtk_sor5_list_model_dispose (GObject *object)
+{
+  GtkSor5ListModel *self = GTK_SOR5_LIST_MODEL (object);
+
+  gtk_sor5_list_model_stop_sorting (self);
+  gtk_sor5_list_model_clear_model (self);
+  gtk_sor5_list_model_clear_sorter (self);
+
+  G_OBJECT_CLASS (gtk_sor5_list_model_parent_class)->dispose (object);
+};
+
+static void
+gtk_sor5_list_model_class_init (GtkSor5ListModelClass *class)
+{
+  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
+
+  gobject_class->set_property = gtk_sor5_list_model_set_property;
+  gobject_class->get_property = gtk_sor5_list_model_get_property;
+  gobject_class->dispose = gtk_sor5_list_model_dispose;
+
+  /**
+   * GtkSor5ListModel:sorter:
+   *
+   * The sorter for this model
+   */
+  properties[PROP_SORTER] =
+      g_param_spec_object ("sorter",
+                            P_("Sorter"),
+                            P_("The sorter for this model"),
+                            GTK_TYPE_SORTER,
+                            GTK_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
+
+  /**
+   * GtkSor5ListModel:model:
+   *
+   * The model being sorted
+   */
+  properties[PROP_MODEL] =
+      g_param_spec_object ("model",
+                           P_("Model"),
+                           P_("The model being sorted"),
+                           G_TYPE_LIST_MODEL,
+                           GTK_PARAM_READWRITE | G_PARAM_EXPLICIT_NOTIFY);
+
+  g_object_class_install_properties (gobject_class, NUM_PROPERTIES, properties);
+}
+
+static void
+gtk_sor5_list_model_init (GtkSor5ListModel *self)
+{
+}
+
+/**
+ * gtk_sor5_list_model_new:
+ * @model: (allow-none): the model to sort
+ * @sorter: (allow-none): the #GtkSorter to sort @model with
+ *
+ * Creates a new sort list model that uses the @sorter to sort @model.
+ *
+ * Returns: a new #GtkSor5ListModel
+ **/
+GtkSor5ListModel *
+gtk_sor5_list_model_new (GListModel *model,
+                         GtkSorter  *sorter)
+{
+  GtkSor5ListModel *result;
+
+  g_return_val_if_fail (model == NULL || G_IS_LIST_MODEL (model), NULL);
+  g_return_val_if_fail (sorter == NULL || GTK_IS_SORTER (sorter), NULL);
+
+  result = g_object_new (GTK_TYPE_SOR5_LIST_MODEL,
+                         "model", model,
+                         "sorter", sorter,
+                         NULL);
+
+  return result;
+}
+
+/**
+ * gtk_sor5_list_model_set_model:
+ * @self: a #GtkSor5ListModel
+ * @model: (allow-none): The model to be sorted
+ *
+ * Sets the model to be sorted. The @model's item type must conform to
+ * the item type of @self.
+ **/
+void
+gtk_sor5_list_model_set_model (GtkSor5ListModel *self,
+                               GListModel       *model)
+{
+  guint removed, added;
+
+  g_return_if_fail (GTK_IS_SOR5_LIST_MODEL (self));
+  g_return_if_fail (model == NULL || G_IS_LIST_MODEL (model));
+
+  if (self->model == model)
+    return;
+
+  removed = g_list_model_get_n_items (G_LIST_MODEL (self));
+  gtk_sor5_list_model_clear_model (self);
+
+  if (model)
+    {
+      self->model = g_object_ref (model);
+      g_signal_connect (model, "items-changed", G_CALLBACK (gtk_sor5_list_model_items_changed_cb), self);
+      added = g_list_model_get_n_items (model);
+
+      gtk_sor5_list_model_create_items (self);
+      gtk_sor5_list_model_resort (self);
+    }
+  else
+    added = 0;
+  
+  if (removed > 0 || added > 0)
+    g_list_model_items_changed (G_LIST_MODEL (self), 0, removed, added);
+
+  g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_MODEL]);
+}
+
+/**
+ * gtk_sor5_list_model_get_model:
+ * @self: a #GtkSor5ListModel
+ *
+ * Gets the model currently sorted or %NULL if none.
+ *
+ * Returns: (nullable) (transfer none): The model that gets sorted
+ **/
+GListModel *
+gtk_sor5_list_model_get_model (GtkSor5ListModel *self)
+{
+  g_return_val_if_fail (GTK_IS_SOR5_LIST_MODEL (self), NULL);
+
+  return self->model;
+}
+
+/**
+ * gtk_sor5_list_model_set_sorter:
+ * @self: a #GtkSor5ListModel
+ * @sorter: (allow-none): the #GtkSorter to sort @model with
+ *
+ * Sets a new sorter on @self.
+ */
+void
+gtk_sor5_list_model_set_sorter (GtkSor5ListModel *self,
+                                GtkSorter        *sorter)
+{
+  g_return_if_fail (GTK_IS_SOR5_LIST_MODEL (self));
+  g_return_if_fail (sorter == NULL || GTK_IS_SORTER (sorter));
+
+  gtk_sor5_list_model_clear_sorter (self);
+
+  if (sorter)
+    {
+      self->sorter = g_object_ref (sorter);
+      g_signal_connect (sorter, "changed", G_CALLBACK (gtk_sor5_list_model_sorter_changed_cb), self);
+      gtk_sor5_list_model_sorter_changed_cb (sorter, GTK_SORTER_CHANGE_DIFFERENT, self);
+    }
+
+  g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_SORTER]);
+}
+
+/**
+ * gtk_sor5_list_model_get_sorter:
+ * @self: a #GtkSor5LisTModel
+ *
+ * Gets the sorter that is used to sort @self.
+ *
+ * Returns: (nullable) (transfer none): the sorter of #self
+ */
+GtkSorter *
+gtk_sor5_list_model_get_sorter (GtkSor5ListModel *self)
+{
+  g_return_val_if_fail (GTK_IS_SOR5_LIST_MODEL (self), NULL);
+
+  return self->sorter;
+}
diff --git a/gtk/gtksor5listmodel.h b/gtk/gtksor5listmodel.h
new file mode 100644
index 0000000000..5b884eb88b
--- /dev/null
+++ b/gtk/gtksor5listmodel.h
@@ -0,0 +1,57 @@
+/*
+ * Copyright © 2018 Benjamin Otte
+ *
+ * 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.1 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/>.
+ *
+ * Authors: Benjamin Otte <otte gnome org>
+ */
+
+#ifndef __GTK_SOR5_LIST_MODEL_H__
+#define __GTK_SOR5_LIST_MODEL_H__
+
+
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only <gtk/gtk.h> can be included directly."
+#endif
+
+#include <gio/gio.h>
+#include <gtk/gtkwidget.h>
+#include <gtk/gtksorter.h>
+
+
+G_BEGIN_DECLS
+
+#define GTK_TYPE_SOR5_LIST_MODEL (gtk_sor5_list_model_get_type ())
+
+GDK_AVAILABLE_IN_ALL
+G_DECLARE_FINAL_TYPE (GtkSor5ListModel, gtk_sor5_list_model, GTK, SOR5_LIST_MODEL, GObject)
+
+GDK_AVAILABLE_IN_ALL
+GtkSor5ListModel *      gtk_sor5_list_model_new                 (GListModel            *model,
+                                                                 GtkSorter             *sorter);
+GDK_AVAILABLE_IN_ALL
+void                    gtk_sor5_list_model_set_sorter          (GtkSor5ListModel       *self,
+                                                                 GtkSorter              *sorter);
+GDK_AVAILABLE_IN_ALL
+GtkSorter *             gtk_sor5_list_model_get_sorter          (GtkSor5ListModel       *self);
+
+GDK_AVAILABLE_IN_ALL
+void                    gtk_sor5_list_model_set_model           (GtkSor5ListModel       *self,
+                                                                 GListModel             *model);
+GDK_AVAILABLE_IN_ALL
+GListModel *            gtk_sor5_list_model_get_model           (GtkSor5ListModel       *self);
+
+G_END_DECLS
+
+#endif /* __GTK_SOR5_LIST_MODEL_H__ */
diff --git a/gtk/meson.build b/gtk/meson.build
index fc60b7ff92..a9dda4770d 100644
--- a/gtk/meson.build
+++ b/gtk/meson.build
@@ -374,6 +374,7 @@ gtk_public_sources = files([
   'gtksorter.c',
   'gtksor2listmodel.c',
   'gtksor4listmodel.c',
+  'gtksor5listmodel.c',
   'gtksortlistmodel.c',
   'gtkspinbutton.c',
   'gtkspinner.c',
@@ -650,6 +651,7 @@ gtk_public_headers = files([
   'gtksorter.h',
   'gtksor2listmodel.h',
   'gtksor4listmodel.h',
+  'gtksor5listmodel.h',
   'gtksortlistmodel.h',
   'gtkspinbutton.h',
   'gtkspinner.h',