[gnome-builder] libide/core: add IdeSettingsActionGroup

[Christian Hergert <chergert src gnome org>]

commit be15c9ab211eefb2383fbc742b5469bfb8a9dfd7
Author: Christian Hergert <chergert redhat com>
Date:   Mon Jul 25 17:58:57 2022 -0700

    libide/core: add IdeSettingsActionGroup
    
    This is like g_settings_create_action() but exports the entire set of keys
    instead of just a single key.

 src/libide/core/ide-settings-action-group.c | 271 ++++++++++++++++++++++++++++
 src/libide/core/ide-settings-action-group.h |  38 ++++
 src/libide/core/libide-core.h               |   1 +
 src/libide/core/meson.build                 |   2 +
 4 files changed, 312 insertions(+)
---
diff --git a/src/libide/core/ide-settings-action-group.c b/src/libide/core/ide-settings-action-group.c
new file mode 100644
index 000000000..480574c03
--- /dev/null
+++ b/src/libide/core/ide-settings-action-group.c
@@ -0,0 +1,271 @@
+/*
+ * ide-settings-action-group.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-settings-action-group"
+
+#include "config.h"
+
+#include "ide-settings-action-group.h"
+
+struct _IdeSettingsActionGroup
+{
+  GObject           parent_instance;
+  GSettings        *settings;
+  GSettingsSchema  *schema;
+  char            **keys;
+};
+
+static void action_group_iface_init (GActionGroupInterface *iface);
+
+G_DEFINE_FINAL_TYPE_WITH_CODE (IdeSettingsActionGroup, ide_settings_action_group, G_TYPE_OBJECT,
+                               G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, action_group_iface_init))
+
+enum {
+  PROP_0,
+  PROP_SETTINGS,
+  N_PROPS
+};
+
+static GParamSpec *properties [N_PROPS];
+
+/**
+ * ide_settings_action_group_new:
+ * @settings: a #GSettings
+ *
+ * Creates a new #GActionGroup that exports @settings.
+ *
+ * Returns: (transfer full): an #IdeSettingsActionGroup
+ */
+GActionGroup *
+ide_settings_action_group_new (GSettings *settings)
+{
+  g_return_val_if_fail (G_IS_SETTINGS (settings), NULL);
+
+  return g_object_new (IDE_TYPE_SETTINGS_ACTION_GROUP,
+                       "settings", settings,
+                       NULL);
+}
+
+static void
+ide_settings_action_group_set_settings (IdeSettingsActionGroup *self,
+                                        GSettings              *settings)
+{
+  g_assert (IDE_IS_SETTINGS_ACTION_GROUP (self));
+  g_assert (self->settings == NULL);
+  g_assert (self->schema == NULL);
+  g_assert (self->keys == NULL);
+  g_assert (G_IS_SETTINGS (settings));
+
+  if (g_set_object (&self->settings, settings))
+    {
+      g_object_get (self->settings,
+                    "settings-schema", &self->schema,
+                    NULL);
+      self->keys = g_settings_schema_list_keys (self->schema);
+    }
+}
+
+static void
+ide_settings_action_group_dispose (GObject *object)
+{
+  IdeSettingsActionGroup *self = (IdeSettingsActionGroup *)object;
+
+  g_clear_object (&self->settings);
+  g_clear_pointer (&self->schema, g_settings_schema_unref);
+
+  G_OBJECT_CLASS (ide_settings_action_group_parent_class)->dispose (object);
+}
+
+static void
+ide_settings_action_group_get_property (GObject    *object,
+                                        guint       prop_id,
+                                        GValue     *value,
+                                        GParamSpec *pspec)
+{
+  IdeSettingsActionGroup *self = IDE_SETTINGS_ACTION_GROUP (object);
+
+  switch (prop_id)
+    {
+    case PROP_SETTINGS:
+      g_value_set_object (value, self->settings);
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+ide_settings_action_group_set_property (GObject      *object,
+                                        guint         prop_id,
+                                        const GValue *value,
+                                        GParamSpec   *pspec)
+{
+  IdeSettingsActionGroup *self = IDE_SETTINGS_ACTION_GROUP (object);
+
+  switch (prop_id)
+    {
+    case PROP_SETTINGS:
+      ide_settings_action_group_set_settings (self, g_value_get_object (value));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+ide_settings_action_group_class_init (IdeSettingsActionGroupClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->dispose = ide_settings_action_group_dispose;
+  object_class->get_property = ide_settings_action_group_get_property;
+  object_class->set_property = ide_settings_action_group_set_property;
+
+  properties [PROP_SETTINGS] =
+    g_param_spec_object ("settings", NULL, NULL,
+                         G_TYPE_SETTINGS,
+                         (G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
+
+  g_object_class_install_properties (object_class, N_PROPS, properties);
+}
+
+static void
+ide_settings_action_group_init (IdeSettingsActionGroup *self)
+{
+}
+
+static gboolean
+ide_settings_action_group_has_action (GActionGroup *group,
+                                      const char   *action_name)
+{
+  return g_strv_contains ((const char * const *)IDE_SETTINGS_ACTION_GROUP (group)->keys, action_name);
+}
+
+static char **
+ide_settings_action_group_list_actions (GActionGroup *group)
+{
+  return g_strdupv (IDE_SETTINGS_ACTION_GROUP (group)->keys);
+}
+
+static gboolean
+ide_settings_action_group_get_action_enabled (GActionGroup *group,
+                                              const char   *action_name)
+{
+  return g_settings_is_writable (IDE_SETTINGS_ACTION_GROUP (group)->settings, action_name);
+}
+
+static GVariant *
+ide_settings_action_group_get_action_state (GActionGroup *group,
+                                            const char   *action_name)
+{
+  IdeSettingsActionGroup *self = (IdeSettingsActionGroup *)group;
+  return g_settings_get_value (self->settings, action_name);
+}
+
+static GVariant *
+ide_settings_action_group_get_action_state_hint (GActionGroup *group,
+                                                 const char   *action_name)
+{
+  IdeSettingsActionGroup *self = (IdeSettingsActionGroup *)group;
+  g_autoptr(GSettingsSchemaKey) key = g_settings_schema_get_key (self->schema, action_name);
+
+  return g_settings_schema_key_get_range (key);
+}
+
+static void
+ide_settings_action_group_change_action_state (GActionGroup *group,
+                                               const char   *action_name,
+                                               GVariant     *value)
+{
+  IdeSettingsActionGroup *self = (IdeSettingsActionGroup *)group;
+  g_autoptr(GSettingsSchemaKey) key = g_settings_schema_get_key (self->schema, action_name);
+
+  if (g_variant_is_of_type (value, g_settings_schema_key_get_value_type (key)) &&
+      g_settings_schema_key_range_check (key, value))
+    g_settings_set_value (self->settings, action_name, value);
+}
+
+static const GVariantType *
+ide_settings_action_group_get_action_state_type (GActionGroup *group,
+                                                 const char   *action_name)
+{
+  IdeSettingsActionGroup *self = (IdeSettingsActionGroup *)group;
+  g_autoptr(GSettingsSchemaKey) key = g_settings_schema_get_key (self->schema, action_name);
+  g_autoptr(GVariant) default_value = g_settings_schema_key_get_default_value (key);
+
+  return g_variant_get_type (default_value);
+}
+
+static void
+ide_settings_action_group_activate_action (GActionGroup *group,
+                                           const char   *action_name,
+                                           GVariant     *parameter)
+{
+  IdeSettingsActionGroup *self = (IdeSettingsActionGroup *)group;
+  g_autoptr(GSettingsSchemaKey) key = g_settings_schema_get_key (self->schema, action_name);
+  g_autoptr(GVariant) default_value = g_settings_schema_key_get_default_value (key);
+
+  if (g_variant_is_of_type (default_value, G_VARIANT_TYPE_BOOLEAN))
+    {
+      GVariant *old;
+
+      if (parameter != NULL)
+        return;
+
+      old = ide_settings_action_group_get_action_state (group, action_name);
+      parameter = g_variant_new_boolean (!g_variant_get_boolean (old));
+      g_variant_unref (old);
+    }
+
+  g_action_group_change_action_state (group, action_name, parameter);
+}
+
+static const GVariantType *
+ide_settings_action_group_get_action_parameter_type (GActionGroup *group,
+                                                     const char   *action_name)
+
+{
+  IdeSettingsActionGroup *self = (IdeSettingsActionGroup *)group;
+  g_autoptr(GSettingsSchemaKey) key = g_settings_schema_get_key (self->schema, action_name);
+  g_autoptr(GVariant) default_value = g_settings_schema_key_get_default_value (key);
+  const GVariantType *type = g_variant_get_type (default_value);
+
+  if (g_variant_type_equal (type, G_VARIANT_TYPE_BOOLEAN))
+    type = NULL;
+
+  return type;
+}
+
+static void
+action_group_iface_init (GActionGroupInterface *iface)
+{
+  iface->has_action = ide_settings_action_group_has_action;
+  iface->list_actions = ide_settings_action_group_list_actions;
+  iface->get_action_parameter_type = ide_settings_action_group_get_action_parameter_type;
+  iface->get_action_enabled = ide_settings_action_group_get_action_enabled;
+  iface->get_action_state = ide_settings_action_group_get_action_state;
+  iface->get_action_state_hint = ide_settings_action_group_get_action_state_hint;
+  iface->get_action_state_type = ide_settings_action_group_get_action_state_type;
+  iface->change_action_state = ide_settings_action_group_change_action_state;
+  iface->activate_action = ide_settings_action_group_activate_action;
+}
diff --git a/src/libide/core/ide-settings-action-group.h b/src/libide/core/ide-settings-action-group.h
new file mode 100644
index 000000000..c5849bf86
--- /dev/null
+++ b/src/libide/core/ide-settings-action-group.h
@@ -0,0 +1,38 @@
+/*
+ * ide-settings-action-group.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 <gio/gio.h>
+
+#include "ide-version-macros.h"
+
+G_BEGIN_DECLS
+
+#define IDE_TYPE_SETTINGS_ACTION_GROUP (ide_settings_action_group_get_type())
+
+IDE_AVAILABLE_IN_ALL
+G_DECLARE_FINAL_TYPE (IdeSettingsActionGroup, ide_settings_action_group, IDE, SETTINGS_ACTION_GROUP, GObject)
+
+IDE_AVAILABLE_IN_ALL
+GActionGroup *ide_settings_action_group_new (GSettings *settings);
+
+G_END_DECLS
diff --git a/src/libide/core/libide-core.h b/src/libide/core/libide-core.h
index bdb1f3fd5..7d2c6d216 100644
--- a/src/libide/core/libide-core.h
+++ b/src/libide/core/libide-core.h
@@ -37,6 +37,7 @@
 #include "ide-object.h"
 #include "ide-object-box.h"
 #include "ide-settings.h"
+#include "ide-settings-action-group.h"
 #include "ide-signal-group.h"
 #include "ide-transfer.h"
 #include "ide-transfer-manager.h"
diff --git a/src/libide/core/meson.build b/src/libide/core/meson.build
index e0f496fd2..2af4625d4 100644
--- a/src/libide/core/meson.build
+++ b/src/libide/core/meson.build
@@ -65,6 +65,7 @@ libide_core_public_headers = [
   'ide-object.h',
   'ide-object-box.h',
   'ide-settings.h',
+  'ide-settings-action-group.h',
   'ide-signal-group.h',
   'ide-transfer.h',
   'ide-transfer-manager.h',
@@ -95,6 +96,7 @@ libide_core_public_sources = [
   'ide-object-box.c',
   'ide-object-notify.c',
   'ide-settings.c',
+  'ide-settings-action-group.c',
   'ide-signal-group.c',
   'ide-transfer.c',
   'ide-transfer-manager.c',