Add a 2nd timsort model

This one does incremental sorting.

Not very well though, because the final merge takes too long.
This commit is contained in:
Benjamin Otte
2020-07-11 07:21:33 +02:00
parent d67df53f17
commit a16494cc39
5 changed files with 659 additions and 0 deletions

View File

@@ -261,6 +261,7 @@
#include <gtk/gtktexttagtable.h>
#include <gtk/gtktextview.h>
#include <gtk/gtktim1sortmodel.h>
#include <gtk/gtktim2sortmodel.h>
#include <gtk/gtktogglebutton.h>
#include <gtk/gtktooltip.h>
#include <gtk/gtktestutils.h>

598
gtk/gtktim2sortmodel.c Normal file
View File

@@ -0,0 +1,598 @@
/*
* 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 "gtktim2sortmodel.h"
#include "gtkintl.h"
#include "gtkprivate.h"
#include "gtktimsortprivate.h"
typedef struct _SortItem SortItem;
struct _SortItem
{
GObject *item;
guint position;
};
static void
sort_item_clear (gpointer data)
{
SortItem *si = data;
g_clear_object (&si->item);
}
#define GTK_VECTOR_ELEMENT_TYPE SortItem
#define GTK_VECTOR_TYPE_NAME SortArray
#define GTK_VECTOR_NAME sort_array
#define GTK_VECTOR_FREE_FUNC sort_item_clear
#define GTK_VECTOR_BY_VALUE 1
#include "gtkvectorimpl.c"
/**
* SECTION:gtksor4listmodel
* @title: GtkTim2SortModel
* @short_description: A list model that sorts its items
* @see_also: #GListModel, #GtkSorter
*
* #GtkTim2SortModel is a list model that takes a list model and
* sorts its elements according to a #GtkSorter.
*
* #GtkTim2SortModel 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 #GtkTim2SortModel, it
* is strongly recommended that you write your own sorting list
* model.
*/
enum {
PROP_0,
PROP_MODEL,
PROP_SORTER,
NUM_PROPERTIES
};
struct _GtkTim2SortModel
{
GObject parent_instance;
GListModel *model;
GtkSorter *sorter;
GtkTimSort sort; /* ongoing sort operation */
guint sort_cb; /* 0 or current ongoing sort callback */
SortArray items; /* empty if known unsorted */
};
struct _GtkTim2SortModelClass
{
GObjectClass parent_class;
};
static GParamSpec *properties[NUM_PROPERTIES] = { NULL, };
static GType
gtk_tim2_sort_model_get_item_type (GListModel *list)
{
return G_TYPE_OBJECT;
}
static guint
gtk_tim2_sort_model_get_n_items (GListModel *list)
{
GtkTim2SortModel *self = GTK_TIM2_SORT_MODEL (list);
if (self->model == NULL)
return 0;
return g_list_model_get_n_items (self->model);
}
static gpointer
gtk_tim2_sort_model_get_item (GListModel *list,
guint position)
{
GtkTim2SortModel *self = GTK_TIM2_SORT_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)->item);
}
static void
gtk_tim2_sort_model_model_init (GListModelInterface *iface)
{
iface->get_item_type = gtk_tim2_sort_model_get_item_type;
iface->get_n_items = gtk_tim2_sort_model_get_n_items;
iface->get_item = gtk_tim2_sort_model_get_item;
}
G_DEFINE_TYPE_WITH_CODE (GtkTim2SortModel, gtk_tim2_sort_model, G_TYPE_OBJECT,
G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL, gtk_tim2_sort_model_model_init))
static gboolean
gtk_tim2_sort_model_is_sorting (GtkTim2SortModel *self)
{
return self->sort_cb != 0;
}
static void
gtk_tim2_sort_model_stop_sorting (GtkTim2SortModel *self)
{
if (self->sort_cb == 0)
return;
gtk_tim_sort_finish (&self->sort);
g_clear_handle_id (&self->sort_cb, g_source_remove);
}
static gboolean
gtk_tim2_sort_model_sort_cb (gpointer data)
{
GtkTim2SortModel *self = data;
if (gtk_tim_sort_step (&self->sort))
{
guint n_items = sort_array_get_size (&self->items);
g_list_model_items_changed (G_LIST_MODEL (self), 0, n_items, n_items);
return G_SOURCE_CONTINUE;
}
gtk_tim2_sort_model_stop_sorting (self);
return G_SOURCE_REMOVE;
}
static void
gtk_tim2_sort_model_start_sorting (GtkTim2SortModel *self)
{
if (self->sort_cb != 0)
return;
self->sort_cb = g_idle_add (gtk_tim2_sort_model_sort_cb, self);
}
static void
gtk_tim2_sort_model_clear_items (GtkTim2SortModel *self)
{
gtk_tim2_sort_model_stop_sorting (self);
sort_array_clear (&self->items);
}
static gboolean
gtk_tim2_sort_model_should_sort (GtkTim2SortModel *self)
{
return self->sorter != NULL &&
self->model != NULL &&
gtk_sorter_get_order (self->sorter) != GTK_SORTER_ORDER_NONE;
}
static void
gtk_tim2_sort_model_create_items (GtkTim2SortModel *self)
{
guint i, n_items;
if (!gtk_tim2_sort_model_should_sort (self))
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, &(SortItem) { g_list_model_get_item (self->model, i), i });
}
}
static int
sort_func (gconstpointer a,
gconstpointer b,
gpointer data)
{
SortItem *sa = (SortItem *) a;
SortItem *sb = (SortItem *) b;
return gtk_sorter_compare (data, sa->item, sb->item);
}
static void
gtk_tim2_sort_model_resort (GtkTim2SortModel *self,
guint already_sorted)
{
if (gtk_tim2_sort_model_is_sorting (self))
{
already_sorted = 0;
gtk_tim2_sort_model_stop_sorting (self);
}
gtk_tim_sort_init (&self->sort,
sort_array_get_data (&self->items),
sort_array_get_size (&self->items),
sizeof (SortItem),
sort_func,
self->sorter);
gtk_tim_sort_set_already_sorted (&self->sort, already_sorted);
gtk_tim2_sort_model_start_sorting (self);
}
static void
gtk_tim2_sort_model_remove_items (GtkTim2SortModel *self,
guint position,
guint removed,
guint added,
guint *unmodified_start,
guint *unmodified_end)
{
guint i, n_items, valid;
guint start, end;
n_items = sort_array_get_size (&self->items);
start = n_items;
end = n_items;
valid = 0;
for (i = 0; i < n_items; i++)
{
SortItem *si = sort_array_index (&self->items, i);
if (si->position >= position + removed)
si->position = si->position - removed + added;
else if (si->position >= position)
{
start = MIN (start, valid);
end = n_items - i - 1;
sort_item_clear (si);
continue;
}
if (valid < i)
*sort_array_index (&self->items, valid) = *sort_array_index (&self->items, i);
valid++;
}
g_assert (valid == n_items - removed);
memset (sort_array_index (&self->items, valid), 0, sizeof (SortItem) * removed);
sort_array_set_size (&self->items, valid);
*unmodified_start = start;
*unmodified_end = end;
}
static void
gtk_tim2_sort_model_items_changed_cb (GListModel *model,
guint position,
guint removed,
guint added,
GtkTim2SortModel *self)
{
guint i, n_items, start, end;
gboolean was_sorting;
if (removed == 0 && added == 0)
return;
if (!gtk_tim2_sort_model_should_sort (self))
{
g_list_model_items_changed (G_LIST_MODEL (self), position, removed, added);
return;
}
was_sorting = gtk_tim2_sort_model_is_sorting (self);
gtk_tim2_sort_model_stop_sorting (self);
gtk_tim2_sort_model_remove_items (self, position, removed, added, &start, &end);
if (added > 0)
{
sort_array_reserve (&self->items, sort_array_get_size (&self->items) + added);
for (i = position; i < position + added; i++)
{
sort_array_append (&self->items, &(SortItem) { g_list_model_get_item (self->model, i), i });
}
gtk_tim2_sort_model_resort (self, was_sorting ? 0 : sort_array_get_size (&self->items) - added);
}
else
{
if (was_sorting)
gtk_tim2_sort_model_resort (self, 0);
}
n_items = sort_array_get_size (&self->items) - start - end;
g_list_model_items_changed (G_LIST_MODEL (self), start, n_items - added + removed, n_items);
}
static void
gtk_tim2_sort_model_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
GtkTim2SortModel *self = GTK_TIM2_SORT_MODEL (object);
switch (prop_id)
{
case PROP_MODEL:
gtk_tim2_sort_model_set_model (self, g_value_get_object (value));
break;
case PROP_SORTER:
gtk_tim2_sort_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_tim2_sort_model_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
GtkTim2SortModel *self = GTK_TIM2_SORT_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_tim2_sort_model_sorter_changed_cb (GtkSorter *sorter,
int change,
GtkTim2SortModel *self)
{
guint n_items;
if (gtk_sorter_get_order (sorter) == GTK_SORTER_ORDER_NONE)
gtk_tim2_sort_model_clear_items (self);
else if (sort_array_is_empty (&self->items))
gtk_tim2_sort_model_create_items (self);
gtk_tim2_sort_model_resort (self, 0);
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_tim2_sort_model_clear_model (GtkTim2SortModel *self)
{
if (self->model == NULL)
return;
g_signal_handlers_disconnect_by_func (self->model, gtk_tim2_sort_model_items_changed_cb, self);
g_clear_object (&self->model);
gtk_tim2_sort_model_clear_items (self);
}
static void
gtk_tim2_sort_model_clear_sorter (GtkTim2SortModel *self)
{
if (self->sorter == NULL)
return;
g_signal_handlers_disconnect_by_func (self->sorter, gtk_tim2_sort_model_sorter_changed_cb, self);
g_clear_object (&self->sorter);
gtk_tim2_sort_model_clear_items (self);
}
static void
gtk_tim2_sort_model_dispose (GObject *object)
{
GtkTim2SortModel *self = GTK_TIM2_SORT_MODEL (object);
gtk_tim2_sort_model_clear_model (self);
gtk_tim2_sort_model_clear_sorter (self);
G_OBJECT_CLASS (gtk_tim2_sort_model_parent_class)->dispose (object);
};
static void
gtk_tim2_sort_model_class_init (GtkTim2SortModelClass *class)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (class);
gobject_class->set_property = gtk_tim2_sort_model_set_property;
gobject_class->get_property = gtk_tim2_sort_model_get_property;
gobject_class->dispose = gtk_tim2_sort_model_dispose;
/**
* GtkTim2SortModel: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);
/**
* GtkTim2SortModel: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_tim2_sort_model_init (GtkTim2SortModel *self)
{
}
/**
* gtk_tim2_sort_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 #GtkTim2SortModel
**/
GtkTim2SortModel *
gtk_tim2_sort_model_new (GListModel *model,
GtkSorter *sorter)
{
GtkTim2SortModel *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_TIM2_SORT_MODEL,
"model", model,
"sorter", sorter,
NULL);
return result;
}
/**
* gtk_tim2_sort_model_set_model:
* @self: a #GtkTim2SortModel
* @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_tim2_sort_model_set_model (GtkTim2SortModel *self,
GListModel *model)
{
guint removed, added;
g_return_if_fail (GTK_IS_TIM2_SORT_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_tim2_sort_model_clear_model (self);
if (model)
{
self->model = g_object_ref (model);
g_signal_connect (model, "items-changed", G_CALLBACK (gtk_tim2_sort_model_items_changed_cb), self);
added = g_list_model_get_n_items (model);
gtk_tim2_sort_model_create_items (self);
gtk_tim2_sort_model_resort (self, 0);
}
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_tim2_sort_model_get_model:
* @self: a #GtkTim2SortModel
*
* Gets the model currently sorted or %NULL if none.
*
* Returns: (nullable) (transfer none): The model that gets sorted
**/
GListModel *
gtk_tim2_sort_model_get_model (GtkTim2SortModel *self)
{
g_return_val_if_fail (GTK_IS_TIM2_SORT_MODEL (self), NULL);
return self->model;
}
/**
* gtk_tim2_sort_model_set_sorter:
* @self: a #GtkTim2SortModel
* @sorter: (allow-none): the #GtkSorter to sort @model with
*
* Sets a new sorter on @self.
*/
void
gtk_tim2_sort_model_set_sorter (GtkTim2SortModel *self,
GtkSorter *sorter)
{
g_return_if_fail (GTK_IS_TIM2_SORT_MODEL (self));
g_return_if_fail (sorter == NULL || GTK_IS_SORTER (sorter));
gtk_tim2_sort_model_clear_sorter (self);
if (sorter)
{
self->sorter = g_object_ref (sorter);
g_signal_connect (sorter, "changed", G_CALLBACK (gtk_tim2_sort_model_sorter_changed_cb), self);
gtk_tim2_sort_model_sorter_changed_cb (sorter, GTK_SORTER_CHANGE_DIFFERENT, self);
}
else
{
guint 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);
}
g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_SORTER]);
}
/**
* gtk_tim2_sort_model_get_sorter:
* @self: a #GtkSor4LisTModel
*
* Gets the sorter that is used to sort @self.
*
* Returns: (nullable) (transfer none): the sorter of #self
*/
GtkSorter *
gtk_tim2_sort_model_get_sorter (GtkTim2SortModel *self)
{
g_return_val_if_fail (GTK_IS_TIM2_SORT_MODEL (self), NULL);
return self->sorter;
}

57
gtk/gtktim2sortmodel.h Normal file
View File

@@ -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_TIM2_SORT_MODEL_H__
#define __GTK_TIM2_SORT_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_TIM2_SORT_MODEL (gtk_tim2_sort_model_get_type ())
GDK_AVAILABLE_IN_ALL
G_DECLARE_FINAL_TYPE (GtkTim2SortModel, gtk_tim2_sort_model, GTK, TIM2_SORT_MODEL, GObject)
GDK_AVAILABLE_IN_ALL
GtkTim2SortModel * gtk_tim2_sort_model_new (GListModel *model,
GtkSorter *sorter);
GDK_AVAILABLE_IN_ALL
void gtk_tim2_sort_model_set_sorter (GtkTim2SortModel *self,
GtkSorter *sorter);
GDK_AVAILABLE_IN_ALL
GtkSorter * gtk_tim2_sort_model_get_sorter (GtkTim2SortModel *self);
GDK_AVAILABLE_IN_ALL
void gtk_tim2_sort_model_set_model (GtkTim2SortModel *self,
GListModel *model);
GDK_AVAILABLE_IN_ALL
GListModel * gtk_tim2_sort_model_get_model (GtkTim2SortModel *self);
G_END_DECLS
#endif /* __GTK_TIM2_SORT_MODEL_H__ */

View File

@@ -406,6 +406,7 @@ gtk_public_sources = files([
'gtktextutil.c',
'gtktextview.c',
'gtktim1sortmodel.c',
'gtktim2sortmodel.c',
'gtktogglebutton.c',
'gtktooltip.c',
'gtktooltipwindow.c',
@@ -673,6 +674,7 @@ gtk_public_headers = files([
'gtktexttagtable.h',
'gtktextview.h',
'gtktim1sortmodel.h',
'gtktim2sortmodel.h',
'gtktogglebutton.h',
'gtktooltip.h',
'gtktreednd.h',

View File

@@ -312,6 +312,7 @@ run_test (GtkStringList *source,
GTK_TYPE_SOR4_LIST_MODEL,
GTK_TYPE_SOR5_LIST_MODEL,
GTK_TYPE_TIM1_SORT_MODEL,
GTK_TYPE_TIM2_SORT_MODEL,
};
guint random = g_random_int ();
guint i;