[gnome-builder] libide/tweaks: add IdeTweaksModel

[Christian Hergert <chergert src gnome org>]

commit 819ab2b86bdce4424fb54bd7af0d5897616fc4bf
Author: Christian Hergert <chergert redhat com>
Date:   Tue Aug 2 14:15:29 2022 -0700

    libide/tweaks: add IdeTweaksModel
    
    This is meant to give us something we can bind to widgets so that we can
    avoid manual widget management.

 src/libide/tweaks/ide-tweaks-model-private.h |  37 +++++
 src/libide/tweaks/ide-tweaks-model.c         | 222 +++++++++++++++++++++++++++
 src/libide/tweaks/meson.build                |   1 +
 3 files changed, 260 insertions(+)
---
diff --git a/src/libide/tweaks/ide-tweaks-model-private.h b/src/libide/tweaks/ide-tweaks-model-private.h
new file mode 100644
index 000000000..5dd6bc032
--- /dev/null
+++ b/src/libide/tweaks/ide-tweaks-model-private.h
@@ -0,0 +1,37 @@
+/*
+ * ide-tweaks-model-private.h
+ *
+ * Copyright 2022 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/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#pragma once
+
+#include "ide-tweaks-item.h"
+
+G_BEGIN_DECLS
+
+#define IDE_TYPE_TWEAKS_MODEL (ide_tweaks_model_get_type())
+
+G_DECLARE_FINAL_TYPE (IdeTweaksModel, ide_tweaks_model, IDE, TWEAKS_MODEL, GObject)
+
+IdeTweaksModel *ide_tweaks_model_new      (IdeTweaksItem  *item,
+                                           const GType    *allowed_types,
+                                           guint           n_allowed_types);
+IdeTweaksItem  *ide_tweaks_model_get_item (IdeTweaksModel *self);
+
+G_END_DECLS
diff --git a/src/libide/tweaks/ide-tweaks-model.c b/src/libide/tweaks/ide-tweaks-model.c
new file mode 100644
index 000000000..2a4ca9f97
--- /dev/null
+++ b/src/libide/tweaks/ide-tweaks-model.c
@@ -0,0 +1,222 @@
+/*
+ * ide-tweaks-model.c
+ *
+ * Copyright 2022 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/>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-or-later
+ */
+
+#define G_LOG_DOMAIN "ide-tweaks-model"
+
+#include "config.h"
+
+#include "ide-tweaks-factory-private.h"
+#include "ide-tweaks-model-private.h"
+
+struct _IdeTweaksModel
+{
+  GObject        parent_instance;
+  IdeTweaksItem *item;
+  GPtrArray     *items;
+};
+
+static GType
+list_model_get_item_type (GListModel *model)
+{
+  return IDE_TYPE_TWEAKS_ITEM;
+}
+
+static guint
+list_model_get_n_items (GListModel *model)
+{
+  return IDE_TWEAKS_MODEL (model)->items->len;
+}
+
+static gpointer
+list_model_get_item (GListModel *model,
+                     guint       position)
+{
+  IdeTweaksModel *self = IDE_TWEAKS_MODEL (model);
+
+  if (position >= self->items->len)
+    return NULL;
+
+  return g_object_ref (g_ptr_array_index (self->items, position));
+}
+
+static void
+list_model_iface_init (GListModelInterface *iface)
+{
+  iface->get_item_type = list_model_get_item_type;
+  iface->get_n_items = list_model_get_n_items;
+  iface->get_item = list_model_get_item;
+}
+
+G_DEFINE_FINAL_TYPE_WITH_CODE (IdeTweaksModel, ide_tweaks_model, G_TYPE_OBJECT,
+                               G_IMPLEMENT_INTERFACE (G_TYPE_LIST_MODEL, list_model_iface_init))
+
+enum {
+  PROP_0,
+  PROP_ITEM,
+  N_PROPS
+};
+
+static GParamSpec *properties [N_PROPS];
+
+static inline gboolean
+descendant_is_allowed (IdeTweaksItem *item,
+                       const GType   *allowed_types,
+                       guint          n_allowed_types)
+{
+  GType item_type = G_OBJECT_TYPE (item);
+
+  for (guint i = 0; i < n_allowed_types; i++)
+    {
+      if (g_type_is_a (item_type, allowed_types[i]))
+        return TRUE;
+    }
+
+  return FALSE;
+}
+
+static void
+ide_tweaks_model_populate (IdeTweaksModel *self,
+                           const GType    *allowed_types,
+                           guint           n_allowed_types)
+{
+  g_assert (IDE_IS_TWEAKS_MODEL (self));
+  g_assert (IDE_IS_TWEAKS_ITEM (self->item));
+  g_assert (self->items != NULL);
+  g_assert (self->items->len == 0);
+  g_assert (allowed_types != NULL);
+  g_assert (n_allowed_types > 0);
+
+  for (IdeTweaksItem *child = ide_tweaks_item_get_first_child (self->item);
+       child != NULL;
+       child = ide_tweaks_item_get_next_sibling (child))
+    {
+      if (descendant_is_allowed (child, allowed_types, n_allowed_types))
+        {
+          g_ptr_array_add (self->items, g_object_ref (child));
+          continue;
+        }
+
+      /* Now check if this is a factory, we might need to create
+       * items based on the factory.
+       */
+      if (IDE_IS_TWEAKS_FACTORY (child) &&
+          _ide_tweaks_factory_is_one_of (IDE_TWEAKS_FACTORY (child),
+                                         allowed_types,
+                                         n_allowed_types))
+        {
+          g_autoptr(GPtrArray) factory_items = _ide_tweaks_factory_inflate (IDE_TWEAKS_FACTORY (child));
+
+          for (guint i = 0; i < factory_items->len; i++)
+            {
+              IdeTweaksItem *factory_item = g_ptr_array_index (factory_items, i);
+
+              if (descendant_is_allowed (factory_item, allowed_types, n_allowed_types))
+                g_ptr_array_add (self->items, g_object_ref (factory_item));
+            }
+        }
+    }
+}
+
+IdeTweaksModel *
+ide_tweaks_model_new (IdeTweaksItem *item,
+                      const GType   *allowed_types,
+                      guint          n_allowed_types)
+{
+  IdeTweaksModel *self;
+
+  g_return_val_if_fail (IDE_IS_TWEAKS_ITEM (item), NULL);
+  g_return_val_if_fail (allowed_types != NULL, NULL);
+  g_return_val_if_fail (n_allowed_types > 0, NULL);
+
+  self = g_object_new (IDE_TYPE_TWEAKS_MODEL, NULL);
+  self->items = g_ptr_array_new_with_free_func (g_object_unref);
+
+  if (g_set_object (&self->item, item))
+    ide_tweaks_model_populate (self, allowed_types, n_allowed_types);
+
+  return self;
+}
+
+static void
+ide_tweaks_model_dispose (GObject *object)
+{
+  IdeTweaksModel *self = (IdeTweaksModel *)object;
+
+  g_clear_object (&self->item);
+
+  G_OBJECT_CLASS (ide_tweaks_model_parent_class)->dispose (object);
+}
+
+static void
+ide_tweaks_model_get_property (GObject    *object,
+                               guint       prop_id,
+                               GValue     *value,
+                               GParamSpec *pspec)
+{
+  IdeTweaksModel *self = IDE_TWEAKS_MODEL (object);
+
+  switch (prop_id)
+    {
+    case PROP_ITEM:
+      g_value_set_object (value, ide_tweaks_model_get_item (self));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+ide_tweaks_model_class_init (IdeTweaksModelClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->dispose = ide_tweaks_model_dispose;
+  object_class->get_property = ide_tweaks_model_get_property;
+
+  properties [PROP_ITEM] =
+    g_param_spec_object ("item", NULL, NULL,
+                         IDE_TYPE_TWEAKS_ITEM,
+                         (G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
+
+  g_object_class_install_properties (object_class, N_PROPS, properties);
+}
+
+static void
+ide_tweaks_model_init (IdeTweaksModel *self)
+{
+}
+
+/**
+ * ide_tweaks_model_get_item:
+ * @self: an #IdeTweaksModel
+ *
+ * Gets the parent item for the model.
+ *
+ * Returns: (transfer none): an #IdeItem
+ */
+IdeTweaksItem *
+ide_tweaks_model_get_item (IdeTweaksModel *self)
+{
+  g_return_val_if_fail (IDE_IS_TWEAKS_MODEL (self), NULL);
+
+  return self->item;
+}
diff --git a/src/libide/tweaks/meson.build b/src/libide/tweaks/meson.build
index d6809bfe2..a063fdda6 100644
--- a/src/libide/tweaks/meson.build
+++ b/src/libide/tweaks/meson.build
@@ -41,6 +41,7 @@ libide_tweaks_public_sources = [
 
 libide_tweaks_private_sources = [
   'ide-tweaks-init.c',
+  'ide-tweaks-model.c',
   'ide-tweaks-panel.c',
   'ide-tweaks-panel-list.c',
 ]