[gnome-builder] libide/gui: add ide_show_tweaks()

[Christian Hergert <chergert src gnome org>]

commit 7d7f18946add38cb8b2b89c28128f33b2f9176fd
Author: Christian Hergert <chergert redhat com>
Date:   Tue Aug 23 14:01:04 2022 -0700

    libide/gui: add ide_show_tweaks()
    
    This moves some of the tweaks code into into a more centralized place.
    Additionally it allows us to start progressing on tweaks for projects
    using IdeContext and a page id to jump to.

 src/libide/gui/ide-application-actions.c |  64 +-------
 src/libide/gui/ide-application-plugins.c | 120 ---------------
 src/libide/gui/ide-application-tweaks.c  | 257 +++++++++++++++++++++++++++++++
 src/libide/gui/ide-application-tweaks.h  |  30 ++++
 src/libide/gui/libide-gui.h              |   1 +
 src/libide/gui/meson.build               |   1 +
 6 files changed, 292 insertions(+), 181 deletions(-)
---
diff --git a/src/libide/gui/ide-application-actions.c b/src/libide/gui/ide-application-actions.c
index 41238ab00..5a4882010 100644
--- a/src/libide/gui/ide-application-actions.c
+++ b/src/libide/gui/ide-application-actions.c
@@ -27,13 +27,12 @@
 
 #include <ide-build-ident.h>
 
-#include <libide-plugins.h>
 #include <libide-projects.h>
-#include <libide-tweaks.h>
 
 #include "ide-application.h"
 #include "ide-application-credits.h"
 #include "ide-application-private.h"
+#include "ide-application-tweaks.h"
 #include "ide-gui-global.h"
 #include "ide-preferences-window.h"
 #include "ide-primary-workspace.h"
@@ -46,76 +45,19 @@ ide_application_actions_tweaks (GSimpleAction *action,
                                 GVariant      *parameter,
                                 gpointer       user_data)
 {
-  static const char *tweaks_resources[] = {
-    "resource:///org/gnome/libide-gui/tweaks.ui",
-  };
   IdeApplication *self = user_data;
-  g_autoptr(IdeTweaks) tweaks = NULL;
-  IdeTweaksWindow *window;
-  IdeTweaksPage *plugins_page;
-  const GList *windows;
-  GtkWindow *toplevel = NULL;
   const char *page = NULL;
 
   IDE_ENTRY;
 
+  g_assert (IDE_IS_MAIN_THREAD ());
   g_assert (G_IS_SIMPLE_ACTION (action));
   g_assert (IDE_IS_APPLICATION (self));
 
   if (parameter && g_variant_is_of_type (parameter, G_VARIANT_TYPE_STRING))
     page = g_variant_get_string (parameter, NULL);
 
-  /* Locate a toplevel for a transient-for property, or a previous
-   * tweaks window to display.
-   */
-  windows = gtk_application_get_windows (GTK_APPLICATION (self));
-  for (; windows; windows = windows->next)
-    {
-      if (IDE_IS_TWEAKS_WINDOW (windows->data))
-        {
-          gtk_window_present (windows->data);
-          return;
-        }
-
-      if (toplevel == NULL && IDE_IS_PRIMARY_WORKSPACE (windows->data))
-        toplevel = windows->data;
-    }
-
-  tweaks = ide_tweaks_new ();
-
-  /* Load our base tweaks scaffolding */
-  for (guint i = 0; i < G_N_ELEMENTS (tweaks_resources); i++)
-    {
-      g_autoptr(GFile) tweaks_file = g_file_new_for_uri (tweaks_resources[i]);
-      g_autoptr(GError) error = NULL;
-
-      ide_tweaks_load_from_file (tweaks, tweaks_file, NULL, &error);
-
-      if (error != NULL)
-        g_critical ("Failed to load tweaks: %s", error->message);
-    }
-
-  /* Expose Plugin Toggles */
-  plugins_page = IDE_TWEAKS_PAGE (ide_tweaks_get_object (tweaks, "plugins_page"));
-  _ide_application_add_plugin_tweaks (self, plugins_page);
-
-  /* Prepare window and setup :application */
-  window = g_object_new (IDE_TYPE_TWEAKS_WINDOW,
-                         "tweaks", tweaks,
-                         NULL);
-  gtk_application_add_window (GTK_APPLICATION (self), GTK_WINDOW (window));
-
-  /* Switch pages before we display if necessary */
-  if (page != NULL)
-    {
-      GObject *object;
-
-      if ((object = ide_tweaks_get_object (tweaks, page)) && IDE_IS_TWEAKS_ITEM (object))
-        ide_tweaks_window_navigate_to (window, IDE_TWEAKS_ITEM (object));
-    }
-
-  /* Now we can display */
-  gtk_window_present (GTK_WINDOW (window));
+  ide_show_tweaks (NULL, page);
 
   IDE_EXIT;
 }
diff --git a/src/libide/gui/ide-application-plugins.c b/src/libide/gui/ide-application-plugins.c
index 255ad9e58..a46eab38d 100644
--- a/src/libide/gui/ide-application-plugins.c
+++ b/src/libide/gui/ide-application-plugins.c
@@ -28,9 +28,6 @@
 #include "ide-application-addin.h"
 #include "ide-application-private.h"
 
-#include "ide-plugin-section-private.h"
-#include "ide-plugin-view.h"
-
 static void
 ide_application_changed_plugin_cb (GSettings      *settings,
                                    const gchar    *key,
@@ -506,120 +503,3 @@ _ide_application_unload_addins (IdeApplication *self)
 
   g_clear_object (&self->addins);
 }
-
-static GtkWidget *
-create_plugin_toggle (IdeTweaksWidget *instance,
-                      IdeTweaksWidget *widget,
-                      IdePlugin       *plugin)
-{
-  g_autofree char *schema_path = NULL;
-  g_autoptr(GSettings) settings = NULL;
-  AdwExpanderRow *row;
-  GtkWidget *view;
-  GtkSwitch *toggle;
-  const char *id;
-
-  g_assert (IDE_IS_TWEAKS_WIDGET (instance));
-  g_assert (IDE_IS_TWEAKS_WIDGET (widget));
-  g_assert (IDE_IS_PLUGIN (plugin));
-
-  id = ide_plugin_get_id (plugin);
-
-  toggle = g_object_new (GTK_TYPE_SWITCH,
-                         "valign", GTK_ALIGN_CENTER,
-                         NULL);
-  row = g_object_new (ADW_TYPE_EXPANDER_ROW,
-                      "title", ide_plugin_get_name (plugin),
-                      "subtitle", ide_plugin_get_description (plugin),
-                      "show-enable-switch", FALSE,
-                      NULL);
-  adw_expander_row_add_action (row, GTK_WIDGET (toggle));
-
-  view = g_object_new (IDE_TYPE_PLUGIN_VIEW,
-                       "plugin", plugin,
-                       NULL);
-  adw_expander_row_add_row (row, GTK_WIDGET (view));
-
-  schema_path = g_strdup_printf ("/org/gnome/builder/plugins/%s/", id);
-  settings = g_settings_new_with_path ("org.gnome.builder.plugin", schema_path);
-  g_object_set_data_full (G_OBJECT (row),
-                          "SETTINGS",
-                          g_object_ref (settings),
-                          g_object_unref);
-
-  g_settings_bind (settings, "enabled", toggle, "active", G_SETTINGS_BIND_DEFAULT);
-
-  return GTK_WIDGET (row);
-}
-
-void
-_ide_application_add_plugin_tweaks (IdeApplication *self,
-                                    IdeTweaksPage  *page)
-{
-  g_autoptr(GHashTable) categories = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, g_object_unref);
-  IdeTweaksPage *category_page;
-  GListModel *sections;
-  guint n_sections;
-
-  g_return_if_fail (IDE_IS_APPLICATION (self));
-  g_return_if_fail (IDE_IS_TWEAKS_PAGE (page));
-
-  sections = _ide_plugin_section_get_all ();
-  n_sections = g_list_model_get_n_items (sections);
-
-  for (guint i = 0; i < n_sections; i++)
-    {
-      g_autoptr(IdeTweaksSection) t_section = ide_tweaks_section_new ();
-      g_autoptr(IdePluginSection) section = g_list_model_get_item (sections, i);
-      GListModel *plugins = ide_plugin_section_get_plugins (section);
-      guint n_plugins;
-
-      ide_tweaks_section_set_title (t_section,
-                                    ide_plugin_section_get_id (section));
-      ide_tweaks_item_insert_after (IDE_TWEAKS_ITEM (t_section),
-                                    IDE_TWEAKS_ITEM (page),
-                                    NULL);
-
-      n_plugins = g_list_model_get_n_items (plugins);
-
-      for (guint j = 0; j < n_plugins; j++)
-        {
-          g_autoptr(IdePlugin) plugin = g_list_model_get_item (plugins, j);
-          const char *category_id = ide_plugin_get_category_id (plugin);
-          const char *category = ide_plugin_get_category (plugin);
-          g_autoptr(IdeTweaksSettings) settings = NULL;
-          g_autoptr(IdeTweaksWidget) widget = NULL;
-          IdeTweaksGroup *group;
-
-          if (!(category_page = g_hash_table_lookup (categories, category)))
-            {
-              g_autofree char *page_id = g_strdup_printf ("plugin_%s_page", category_id);
-              g_autoptr(IdeTweaksGroup) first_group = ide_tweaks_group_new ();
-
-              category_page = ide_tweaks_page_new ();
-              GTK_BUILDABLE_GET_IFACE (category_page)->set_id (GTK_BUILDABLE (category_page), page_id);
-              ide_tweaks_page_set_title (category_page, category);
-              ide_tweaks_page_set_show_icon (category_page, FALSE);
-              ide_tweaks_item_insert_after (IDE_TWEAKS_ITEM (category_page),
-                                            IDE_TWEAKS_ITEM (t_section),
-                                            NULL);
-              ide_tweaks_item_insert_after (IDE_TWEAKS_ITEM (first_group),
-                                            IDE_TWEAKS_ITEM (category_page),
-                                            NULL);
-              g_hash_table_insert (categories, (char *)category, category_page);
-            }
-
-          group = IDE_TWEAKS_GROUP (ide_tweaks_item_get_first_child (IDE_TWEAKS_ITEM (category_page)));
-          widget = ide_tweaks_widget_new ();
-          g_signal_connect_object (widget,
-                                   "create-for-item",
-                                   G_CALLBACK (create_plugin_toggle),
-                                   plugin,
-                                   0);
-
-          ide_tweaks_item_insert_after (IDE_TWEAKS_ITEM (widget),
-                                        IDE_TWEAKS_ITEM (group),
-                                        NULL);
-        }
-    }
-}
diff --git a/src/libide/gui/ide-application-tweaks.c b/src/libide/gui/ide-application-tweaks.c
new file mode 100644
index 000000000..5635480d6
--- /dev/null
+++ b/src/libide/gui/ide-application-tweaks.c
@@ -0,0 +1,257 @@
+/* ide-application-tweaks.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-application-tweaks"
+
+#include "config.h"
+
+#include <libide-plugins.h>
+#include <libide-tweaks.h>
+
+#include "ide-application.h"
+#include "ide-application-tweaks.h"
+#include "ide-plugin-view.h"
+#include "ide-primary-workspace.h"
+
+#include "ide-plugin-section-private.h"
+
+static const char *tweaks_resources[] = {
+  "resource:///org/gnome/libide-gui/tweaks.ui",
+};
+
+static GtkWidget *
+create_plugin_toggle (IdeTweaksWidget *instance,
+                      IdeTweaksWidget *widget,
+                      IdePlugin       *plugin)
+{
+  g_autofree char *schema_path = NULL;
+  g_autoptr(GSettings) settings = NULL;
+  AdwExpanderRow *row;
+  GtkWidget *view;
+  GtkSwitch *toggle;
+  const char *id;
+
+  g_assert (IDE_IS_TWEAKS_WIDGET (instance));
+  g_assert (IDE_IS_TWEAKS_WIDGET (widget));
+  g_assert (IDE_IS_PLUGIN (plugin));
+
+  id = ide_plugin_get_id (plugin);
+
+  toggle = g_object_new (GTK_TYPE_SWITCH,
+                         "valign", GTK_ALIGN_CENTER,
+                         NULL);
+  row = g_object_new (ADW_TYPE_EXPANDER_ROW,
+                      "title", ide_plugin_get_name (plugin),
+                      "subtitle", ide_plugin_get_description (plugin),
+                      "show-enable-switch", FALSE,
+                      NULL);
+  adw_expander_row_add_action (row, GTK_WIDGET (toggle));
+
+  view = g_object_new (IDE_TYPE_PLUGIN_VIEW,
+                       "plugin", plugin,
+                       NULL);
+  adw_expander_row_add_row (row, GTK_WIDGET (view));
+
+  schema_path = g_strdup_printf ("/org/gnome/builder/plugins/%s/", id);
+  settings = g_settings_new_with_path ("org.gnome.builder.plugin", schema_path);
+  g_object_set_data_full (G_OBJECT (row),
+                          "SETTINGS",
+                          g_object_ref (settings),
+                          g_object_unref);
+
+  g_settings_bind (settings, "enabled", toggle, "active", G_SETTINGS_BIND_DEFAULT);
+
+  return GTK_WIDGET (row);
+}
+
+static void
+add_plugin_tweaks (IdeTweaksPage *page)
+{
+  g_autoptr(GHashTable) categories = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, g_object_unref);
+  IdeTweaksPage *category_page;
+  GListModel *sections;
+  guint n_sections;
+
+  g_return_if_fail (IDE_IS_TWEAKS_PAGE (page));
+
+  sections = _ide_plugin_section_get_all ();
+  n_sections = g_list_model_get_n_items (sections);
+
+  for (guint i = 0; i < n_sections; i++)
+    {
+      g_autoptr(IdeTweaksSection) t_section = ide_tweaks_section_new ();
+      g_autoptr(IdePluginSection) section = g_list_model_get_item (sections, i);
+      GListModel *plugins = ide_plugin_section_get_plugins (section);
+      guint n_plugins;
+
+      ide_tweaks_section_set_title (t_section,
+                                    ide_plugin_section_get_id (section));
+      ide_tweaks_item_insert_after (IDE_TWEAKS_ITEM (t_section),
+                                    IDE_TWEAKS_ITEM (page),
+                                    NULL);
+
+      n_plugins = g_list_model_get_n_items (plugins);
+
+      for (guint j = 0; j < n_plugins; j++)
+        {
+          g_autoptr(IdePlugin) plugin = g_list_model_get_item (plugins, j);
+          const char *category_id = ide_plugin_get_category_id (plugin);
+          const char *category = ide_plugin_get_category (plugin);
+          g_autoptr(IdeTweaksSettings) settings = NULL;
+          g_autoptr(IdeTweaksWidget) widget = NULL;
+          IdeTweaksGroup *group;
+
+          if (!(category_page = g_hash_table_lookup (categories, category)))
+            {
+              g_autofree char *page_id = g_strdup_printf ("plugin_%s_page", category_id);
+              g_autoptr(IdeTweaksGroup) first_group = ide_tweaks_group_new ();
+
+              category_page = ide_tweaks_page_new ();
+              GTK_BUILDABLE_GET_IFACE (category_page)->set_id (GTK_BUILDABLE (category_page), page_id);
+              ide_tweaks_page_set_title (category_page, category);
+              ide_tweaks_page_set_show_icon (category_page, FALSE);
+              ide_tweaks_item_insert_after (IDE_TWEAKS_ITEM (category_page),
+                                            IDE_TWEAKS_ITEM (t_section),
+                                            NULL);
+              ide_tweaks_item_insert_after (IDE_TWEAKS_ITEM (first_group),
+                                            IDE_TWEAKS_ITEM (category_page),
+                                            NULL);
+              g_hash_table_insert (categories, (char *)category, category_page);
+            }
+
+          group = IDE_TWEAKS_GROUP (ide_tweaks_item_get_first_child (IDE_TWEAKS_ITEM (category_page)));
+          widget = ide_tweaks_widget_new ();
+          g_signal_connect_object (widget,
+                                   "create-for-item",
+                                   G_CALLBACK (create_plugin_toggle),
+                                   plugin,
+                                   0);
+
+          ide_tweaks_item_insert_after (IDE_TWEAKS_ITEM (widget),
+                                        IDE_TWEAKS_ITEM (group),
+                                        NULL);
+        }
+    }
+}
+
+static gboolean
+try_reuse_window (IdeTweaksWindow *window,
+                  IdeContext      *context,
+                  const char      *page)
+{
+  g_autofree char *context_project_id = NULL;
+  const char *project_id;
+  IdeTweaks *tweaks;
+  GObject *object = NULL;
+
+  g_assert (IDE_IS_TWEAKS_WINDOW (window));
+  g_assert (!context || IDE_IS_CONTEXT (context));
+
+  if (!(tweaks = ide_tweaks_window_get_tweaks (window)))
+    return FALSE;
+
+  project_id = ide_tweaks_get_project_id (tweaks);
+  context_project_id = context ? ide_context_dup_project_id (context) : NULL;
+  if (g_strcmp0 (project_id, context_project_id) != 0)
+    return FALSE;
+
+  if (page != NULL)
+    {
+      if (!(object = ide_tweaks_get_object (tweaks, page)) ||
+          !IDE_IS_TWEAKS_ITEM (object))
+        return FALSE;
+    }
+
+  ide_tweaks_window_navigate_initial (window);
+
+  if (object != NULL)
+    ide_tweaks_window_navigate_to (window, IDE_TWEAKS_ITEM (object));
+
+  gtk_window_present (GTK_WINDOW (window));
+
+  return TRUE;
+}
+
+void
+ide_show_tweaks (IdeContext *context,
+                 const char *page)
+{
+  IdeApplication *app = IDE_APPLICATION_DEFAULT;
+  g_autoptr(IdeTweaks) tweaks = NULL;
+  IdeTweaksWindow *window;
+  const GList *windows;
+  GtkWindow *toplevel = NULL;
+
+  g_return_if_fail (IDE_IS_MAIN_THREAD ());
+  g_return_if_fail (IDE_IS_APPLICATION (app));
+  g_return_if_fail (!context || IDE_IS_CONTEXT (context));
+
+  /* Locate a toplevel for a transient-for property, or a previous
+   * tweaks window to display.
+   */
+  windows = gtk_application_get_windows (GTK_APPLICATION (app));
+  for (; windows; windows = windows->next)
+    {
+      GtkWindow *win = windows->data;
+
+      if (IDE_IS_TWEAKS_WINDOW (win) &&
+          try_reuse_window (IDE_TWEAKS_WINDOW (win), context, page))
+        return;
+
+      if (toplevel && IDE_IS_PRIMARY_WORKSPACE (win))
+        toplevel = win;
+    }
+
+  tweaks = ide_tweaks_new_for_context (context);
+
+  /* Load our base tweaks scaffolding */
+  for (guint i = 0; i < G_N_ELEMENTS (tweaks_resources); i++)
+    {
+      g_autoptr(GFile) tweaks_file = g_file_new_for_uri (tweaks_resources[i]);
+      g_autoptr(GError) error = NULL;
+
+      ide_tweaks_load_from_file (tweaks, tweaks_file, NULL, &error);
+
+      if (error != NULL)
+        g_critical ("Failed to load tweaks: %s", error->message);
+    }
+
+  /* Expose plugin toggles when in application mode */
+  if (context == NULL)
+    add_plugin_tweaks (IDE_TWEAKS_PAGE (ide_tweaks_get_object (tweaks, "plugins_page")));
+
+  /* Prepare window and setup :application */
+  window = g_object_new (IDE_TYPE_TWEAKS_WINDOW,
+                         "tweaks", tweaks,
+                         NULL);
+  gtk_application_add_window (GTK_APPLICATION (app), GTK_WINDOW (window));
+
+  /* Switch pages before we display if necessary */
+  if (page != NULL)
+    {
+      GObject *object;
+
+      if ((object = ide_tweaks_get_object (tweaks, page)) && IDE_IS_TWEAKS_ITEM (object))
+        ide_tweaks_window_navigate_to (window, IDE_TWEAKS_ITEM (object));
+    }
+
+  /* Now we can display */
+  gtk_window_present (GTK_WINDOW (window));
+}
diff --git a/src/libide/gui/ide-application-tweaks.h b/src/libide/gui/ide-application-tweaks.h
new file mode 100644
index 000000000..e80145474
--- /dev/null
+++ b/src/libide/gui/ide-application-tweaks.h
@@ -0,0 +1,30 @@
+/* ide-application-tweaks.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 <libide-core.h>
+
+G_BEGIN_DECLS
+
+void ide_show_tweaks (IdeContext *context,
+                      const char *page);
+
+G_END_DECLS
diff --git a/src/libide/gui/libide-gui.h b/src/libide/gui/libide-gui.h
index 57fa3deb7..b446980f8 100644
--- a/src/libide/gui/libide-gui.h
+++ b/src/libide/gui/libide-gui.h
@@ -31,6 +31,7 @@
 #define IDE_GUI_INSIDE
 # include "ide-application.h"
 # include "ide-application-addin.h"
+# include "ide-application-tweaks.h"
 # include "ide-config-view-addin.h"
 # include "ide-environment-editor.h"
 # include "ide-frame.h"
diff --git a/src/libide/gui/meson.build b/src/libide/gui/meson.build
index ce31fb298..2dd884132 100644
--- a/src/libide/gui/meson.build
+++ b/src/libide/gui/meson.build
@@ -68,6 +68,7 @@ libide_gui_private_sources = [
   'ide-application-color.c',
   'ide-application-plugins.c',
   'ide-application-settings.c',
+  'ide-application-tweaks.c',
   'ide-environment-editor-row.c',
   'ide-notification-list-box-row.c',
   'ide-notification-stack.c',