GNOME.org
 

[gnome-builder/wip/chergert/headerbar] listbox: add GtkListBox subclass that can recycle rows

commit 64de2d8ab1edc776f5ac8bd3496bbd09634d223f
Author: Christian Hergert <chergert redhat com>
Date:   Fri Jun 24 15:18:17 2016 -0700

    listbox: add GtkListBox subclass that can recycle rows
    
    This isn't the ideal version we want where we can limit the number of
    inflated rows based on the viewport, but it does help us in situations
    where we have to recreate rows a lot (like when updating search results).
    
    The goal here is to replace the search results with something like this so
    we get less flicker on wayland when repopulating search results.
    
    If we don't add any more complexity to our search results (unlikely), we
    could of course just switch it to TreeView with minimal effort.

 contrib/egg/Makefile.am    |    2 +
 contrib/egg/egg-list-box.c |  342 ++++++++++++++++++++++++++++++++++++++++++++
 contrib/egg/egg-list-box.h |   50 +++++++
 3 files changed, 394 insertions(+), 0 deletions(-)
---
diff --git a/contrib/egg/Makefile.am b/contrib/egg/Makefile.am
index 624736b..7d5b2d8 100644
--- a/contrib/egg/Makefile.am
+++ b/contrib/egg/Makefile.am
@@ -19,6 +19,7 @@ headers_DATA = \
        egg-entry-box.h \
        egg-frame-source.h \
        egg-heap.h \
+       egg-list-box.h \
        egg-menu-manager.h \
        egg-pill-box.h \
        egg-priority-box.h \
@@ -50,6 +51,7 @@ libegg_private_la_SOURCES = \
        egg-entry-box.c \
        egg-frame-source.c \
        egg-heap.c \
+       egg-list-box.c \
        egg-menu-manager.c \
        egg-pill-box.c \
        egg-priority-box.c \
diff --git a/contrib/egg/egg-list-box.c b/contrib/egg/egg-list-box.c
new file mode 100644
index 0000000..a2a2136
--- /dev/null
+++ b/contrib/egg/egg-list-box.c
@@ -0,0 +1,342 @@
+/* egg-list-box.c
+ *
+ * Copyright (C) 2016 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#define G_LOG_DOMAIN "egg-list-box"
+
+/*
+ * This widget is just like GtkListBox, except that it allows you to
+ * very simply re-use existing widgets instead of creating new widgets
+ * all the time.
+ *
+ * It does not, however, try to keep the number of inflated widgets
+ * low (that would require more work in GtkListBox directly).
+ *
+ * This mostly just avoids the overhead of reparsing the template XML
+ * on every widget (re)creation.
+ */
+
+#include "egg-list-box.h"
+
+typedef struct
+{
+  GListModel *model;
+  gchar      *property_name;
+  GType       row_type;
+  guint       recycle_max;
+  GQueue      trashed_rows;
+} EggListBoxPrivate;
+
+G_DEFINE_TYPE_WITH_PRIVATE (EggListBox, egg_list_box, GTK_TYPE_LIST_BOX)
+
+enum {
+  PROP_0,
+  PROP_PROPERTY_NAME,
+  PROP_ROW_TYPE,
+  PROP_ROW_TYPE_NAME,
+  N_PROPS
+};
+
+static GParamSpec *properties [N_PROPS];
+
+static GtkWidget *
+egg_list_box_create_row (gpointer item,
+                         gpointer user_data)
+{
+  EggListBox *self = user_data;
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  g_assert (G_IS_OBJECT (item));
+  g_assert (EGG_IS_LIST_BOX (self));
+
+  if (priv->trashed_rows.length > 0)
+    {
+      GtkListBoxRow *row = g_queue_pop_tail (&priv->trashed_rows);
+
+      g_object_set (row, priv->property_name, item, NULL);
+      g_object_force_floating (G_OBJECT (row));
+      g_object_unref (row);
+
+      return GTK_WIDGET (row);
+    }
+
+  return g_object_new (priv->row_type,
+                       "visible", TRUE,
+                       priv->property_name, item,
+                       NULL);
+}
+
+static void
+egg_list_box_remove (GtkContainer *container,
+                     GtkWidget    *widget)
+{
+  EggListBox *self = (EggListBox *)container;
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  g_assert (EGG_IS_LIST_BOX (self));
+  g_assert (GTK_IS_LIST_BOX_ROW (widget));
+
+  g_object_ref (widget);
+
+  GTK_CONTAINER_CLASS (egg_list_box_parent_class)->remove (container, widget);
+
+  if (priv->trashed_rows.length < priv->recycle_max)
+    {
+      g_object_set (widget, priv->property_name, NULL, NULL);
+      g_queue_push_head (&priv->trashed_rows, g_steal_pointer (&widget));
+    }
+
+  g_clear_object (&widget);
+}
+
+static void
+egg_list_box_constructed (GObject *object)
+{
+  EggListBox *self = (EggListBox *)object;
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+  GObjectClass *row_class;
+  GParamSpec *pspec;
+  gboolean valid;
+
+  G_OBJECT_CLASS (egg_list_box_parent_class)->constructed (object);
+
+  if (!g_type_is_a (priv->row_type, GTK_TYPE_LIST_BOX_ROW) || !priv->property_name)
+    goto failure;
+
+  row_class = g_type_class_ref (priv->row_type);
+  pspec = g_object_class_find_property (row_class, priv->property_name);
+  valid = (pspec != NULL) && g_type_is_a (pspec->value_type, G_TYPE_OBJECT);
+  g_type_class_unref (row_class);
+
+  if (valid)
+    return;
+
+failure:
+  g_warning ("Invalid EggListBox instantiated, will not work as expected");
+  priv->row_type = G_TYPE_INVALID;
+  g_clear_pointer (&priv->property_name, g_free);
+}
+
+static void
+egg_list_box_destroy (GtkWidget *widget)
+{
+  EggListBox *self = (EggListBox *)widget;
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  g_assert (EGG_IS_LIST_BOX (self));
+
+  g_queue_foreach (&priv->trashed_rows, (GFunc)g_object_unref, NULL);
+  g_queue_clear (&priv->trashed_rows);
+
+  GTK_WIDGET_CLASS (egg_list_box_parent_class)->destroy (widget);
+}
+
+static void
+egg_list_box_finalize (GObject *object)
+{
+  EggListBox *self = (EggListBox *)object;
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  g_clear_pointer (&priv->property_name, g_free);
+  priv->row_type = G_TYPE_INVALID;
+
+  G_OBJECT_CLASS (egg_list_box_parent_class)->finalize (object);
+}
+
+static void
+egg_list_box_get_property (GObject    *object,
+                           guint       prop_id,
+                           GValue     *value,
+                           GParamSpec *pspec)
+{
+  EggListBox *self = EGG_LIST_BOX (object);
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  switch (prop_id)
+    {
+    case PROP_ROW_TYPE:
+      g_value_set_gtype (value, priv->row_type);
+      break;
+
+    case PROP_PROPERTY_NAME:
+      g_value_set_string (value, priv->property_name);
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+egg_list_box_set_property (GObject      *object,
+                           guint         prop_id,
+                           const GValue *value,
+                           GParamSpec   *pspec)
+{
+  EggListBox *self = EGG_LIST_BOX (object);
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  switch (prop_id)
+    {
+    case PROP_ROW_TYPE:
+      {
+        GType gtype = g_value_get_gtype (value);
+
+        if (gtype != G_TYPE_INVALID)
+          priv->row_type = gtype;
+      }
+      break;
+
+    case PROP_ROW_TYPE_NAME:
+      {
+        const gchar *name = g_value_get_string (value);
+
+        if (name != NULL)
+          priv->row_type = g_type_from_name (name);
+      }
+      break;
+
+    case PROP_PROPERTY_NAME:
+      priv->property_name = g_value_dup_string (value);
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+egg_list_box_class_init (EggListBoxClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
+  GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);
+
+  object_class->constructed = egg_list_box_constructed;
+  object_class->finalize = egg_list_box_finalize;
+  object_class->get_property = egg_list_box_get_property;
+  object_class->set_property = egg_list_box_set_property;
+
+  widget_class->destroy = egg_list_box_destroy;
+
+  container_class->remove = egg_list_box_remove;
+
+  properties [PROP_ROW_TYPE] =
+    g_param_spec_gtype ("row-type",
+                        "Row Type",
+                        "The GtkListBoxRow or subclass type to instantiate",
+                        GTK_TYPE_LIST_BOX_ROW,
+                        (G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
+
+  properties [PROP_ROW_TYPE_NAME] =
+    g_param_spec_string ("row-type-name",
+                         "Row Type Name",
+                         "The name of the GType as a string",
+                         NULL,
+                         (G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
+
+  properties [PROP_PROPERTY_NAME] =
+    g_param_spec_string ("property-name",
+                         "Property Name",
+                         "The property in which to assign the model item",
+                         NULL,
+                         (G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
+
+  g_object_class_install_properties (object_class, N_PROPS, properties);
+}
+
+static void
+egg_list_box_init (EggListBox *self)
+{
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  priv->row_type = G_TYPE_INVALID;
+  priv->recycle_max = 25;
+
+  g_queue_init (&priv->trashed_rows);
+}
+
+EggListBox *
+egg_list_box_new (GType        row_type,
+                  const gchar *property_name)
+{
+  g_return_val_if_fail (g_type_is_a (row_type, GTK_TYPE_LIST_BOX_ROW), NULL);
+  g_return_val_if_fail (property_name != NULL, NULL);
+
+  return g_object_new (EGG_TYPE_LIST_BOX,
+                       "property-name", property_name,
+                       "row-type", row_type,
+                       NULL);
+}
+
+/**
+ * egg_list_box_get_model:
+ *
+ * Returns: (nullable) (transfer none): A #GListModel or %NULL.
+ */
+GListModel *
+egg_list_box_get_model (EggListBox *self)
+{
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  g_return_val_if_fail (EGG_IS_LIST_BOX (self), NULL);
+
+  return priv->model;
+}
+
+GType
+egg_list_box_get_row_type (EggListBox *self)
+{
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  g_return_val_if_fail (EGG_IS_LIST_BOX (self), G_TYPE_INVALID);
+
+  return priv->row_type;
+}
+
+const gchar *
+egg_list_box_get_property_name (EggListBox *self)
+{
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  g_return_val_if_fail (EGG_IS_LIST_BOX (self), NULL);
+
+  return priv->property_name;
+}
+
+void
+egg_list_box_set_model (EggListBox *self,
+                        GListModel *model)
+{
+  EggListBoxPrivate *priv = egg_list_box_get_instance_private (self);
+
+  g_return_if_fail (EGG_IS_LIST_BOX (self));
+  g_return_if_fail (priv->property_name != NULL);
+  g_return_if_fail (priv->row_type != G_TYPE_INVALID);
+
+  if (model == NULL)
+    {
+      gtk_list_box_bind_model (GTK_LIST_BOX (self), NULL, NULL, NULL, NULL);
+      return;
+    }
+
+  gtk_list_box_bind_model (GTK_LIST_BOX (self),
+                           model,
+                           egg_list_box_create_row,
+                           self,
+                           NULL);
+}
diff --git a/contrib/egg/egg-list-box.h b/contrib/egg/egg-list-box.h
new file mode 100644
index 0000000..a80126e
--- /dev/null
+++ b/contrib/egg/egg-list-box.h
@@ -0,0 +1,50 @@
+/* egg-list-box.h
+ *
+ * Copyright (C) 2016 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef EGG_LIST_BOX_H
+#define EGG_LIST_BOX_H
+
+#include <gtk/gtk.h>
+
+G_BEGIN_DECLS
+
+#define EGG_TYPE_LIST_BOX (egg_list_box_get_type())
+
+G_DECLARE_DERIVABLE_TYPE (EggListBox, egg_list_box, EGG, LIST_BOX, GtkListBox)
+
+struct _EggListBoxClass
+{
+  GtkListBoxClass parent_class;
+
+  gpointer _reserved1;
+  gpointer _reserved2;
+  gpointer _reserved3;
+  gpointer _reserved4;
+};
+
+EggListBox  *egg_list_box_new               (GType        row_type,
+                                             const gchar *property_name);
+GType        egg_list_box_get_row_type      (EggListBox  *self);
+const gchar *egg_list_box_get_property_name (EggListBox  *self);
+GListModel  *egg_list_box_get_model         (EggListBox  *self);
+void         egg_list_box_set_model         (EggListBox  *self,
+                                             GListModel  *model);
+
+G_END_DECLS
+
+#endif /* EGG_LIST_BOX_H */
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]