[gnome-builder/wip/gtk4-port: 1514/1774] plugins/shellcmd: export shortcuts for shellcmd run commands

[Christian Hergert <chergert src gnome org>]

commit 3a8a7c9574d000751056463f12844c42cbdcc175
Author: Christian Hergert <chergert redhat com>
Date:   Tue Jun 14 22:46:41 2022 -0700

    plugins/shellcmd: export shortcuts for shellcmd run commands
    
    There is still work necessary to make the commands actually execute, but
    this gets the machinery into place at least.

 .../shellcmd/gbp-shellcmd-shortcut-provider.c      | 239 +++++++++++++++++++++
 .../shellcmd/gbp-shellcmd-shortcut-provider.h      |  31 +++
 src/plugins/shellcmd/meson.build                   |   1 +
 src/plugins/shellcmd/shellcmd-plugin.c             |   4 +
 4 files changed, 275 insertions(+)
---
diff --git a/src/plugins/shellcmd/gbp-shellcmd-shortcut-provider.c 
b/src/plugins/shellcmd/gbp-shellcmd-shortcut-provider.c
new file mode 100644
index 000000000..cc90cb423
--- /dev/null
+++ b/src/plugins/shellcmd/gbp-shellcmd-shortcut-provider.c
@@ -0,0 +1,239 @@
+/* gbp-shellcmd-shortcut-provider.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 "gbp-shellcmd-shortcut-provider"
+
+#include "config.h"
+
+#include <libide-gui.h>
+
+#include "gbp-shellcmd-command-model.h"
+#include "gbp-shellcmd-run-command.h"
+#include "gbp-shellcmd-shortcut-provider.h"
+
+struct _GbpShellcmdShortcutProvider
+{
+  IdeObject   parent_instance;
+  GListStore *model;
+};
+
+static gboolean
+gbp_shellcmd_shortcut_func (GtkWidget *widget,
+                            GVariant  *args,
+                            gpointer   user_data)
+{
+  GbpShellcmdRunCommand *command = user_data;
+  IdeWorkspace *workspace;
+  IdeContext *context;
+
+  IDE_ENTRY;
+
+  g_assert (GTK_IS_WIDGET (widget));
+  g_assert (args == NULL);
+  g_assert (GBP_IS_SHELLCMD_RUN_COMMAND (command));
+
+  g_debug ("Shortcut triggered to run command “%s” which has accelerator %s",
+           ide_run_command_get_display_name (IDE_RUN_COMMAND (command)),
+           gbp_shellcmd_run_command_get_accelerator (command));
+
+  if (!(workspace = ide_widget_get_workspace (widget)) ||
+      !(context = ide_workspace_get_context (workspace)))
+    IDE_RETURN (FALSE);
+
+  /* Commands executed through shortcuts do not run with the run-manager
+   * (where as they can be run through that too). Instead we just create
+   * a new terminal pane if necessary and add them to that.
+   */
+  g_print ("TODO: Run shortcut command\n");
+
+  IDE_RETURN (TRUE);
+}
+
+static gboolean
+accelerator_to_trigger (GBinding     *binding,
+                        const GValue *from_value,
+                        GValue       *to_value,
+                        gpointer      user_data)
+{
+  const char *accel;
+
+  g_assert (G_IS_BINDING (binding));
+  g_assert (G_VALUE_HOLDS_STRING (from_value));
+
+  accel = g_value_get_string (from_value);
+
+  if (!ide_str_empty0 (accel))
+    {
+      GtkShortcutTrigger *trigger;
+
+      if ((trigger = gtk_shortcut_trigger_parse_string (accel)))
+        {
+          g_value_take_object (to_value, trigger);
+          return TRUE;
+        }
+    }
+
+  g_value_set_object (to_value, gtk_never_trigger_get ());
+
+  return TRUE;
+}
+
+static gpointer
+gbp_shellcmd_shortcut_provider_map_func (gpointer item,
+                                         gpointer user_data)
+{
+  g_autoptr(GbpShellcmdRunCommand) command = item;
+  g_autoptr(GtkShortcutAction) action = NULL;
+  GtkShortcut *ret;
+
+  g_assert (GBP_IS_SHELLCMD_RUN_COMMAND (command));
+  g_assert (user_data == NULL);
+
+  action = gtk_callback_action_new (gbp_shellcmd_shortcut_func,
+                                    g_object_ref (command),
+                                    g_object_unref);
+  ret = gtk_shortcut_new (NULL, g_steal_pointer (&action));
+
+  /* We want the accelerator to update when the command changes it */
+  g_object_bind_property_full (command, "accelerator", ret, "trigger",
+                               G_BINDING_SYNC_CREATE,
+                               accelerator_to_trigger, NULL,
+                               NULL, NULL);
+
+  /* Our capture/bubble filters require a phase set. Keep in sync
+   * with ide_shortcut_is_phase().
+   */
+  g_object_set_data (G_OBJECT (ret),
+                     "PHASE",
+                     GINT_TO_POINTER (GTK_PHASE_BUBBLE));
+
+  return g_steal_pointer (&ret);
+}
+
+static void
+add_with_mapping (GListStore *store,
+                  GListModel *commands,
+                  gboolean    prepend)
+{
+  g_autoptr(GtkMapListModel) map = NULL;
+
+  g_assert (G_IS_LIST_STORE (store));
+  g_assert (GBP_IS_SHELLCMD_COMMAND_MODEL (commands));
+
+  map = gtk_map_list_model_new (g_object_ref (commands),
+                                gbp_shellcmd_shortcut_provider_map_func,
+                                NULL, NULL);
+
+  if (prepend)
+    g_list_store_insert (store, 0, map);
+  else
+    g_list_store_append (store, map);
+}
+
+static void
+project_id_changed_cb (GbpShellcmdShortcutProvider *self,
+                       GParamSpec                  *pspec,
+                       IdeContext                  *context)
+{
+  g_autoptr(GbpShellcmdCommandModel) project_model = NULL;
+
+  g_assert (IDE_IS_MAIN_THREAD ());
+  g_assert (GBP_IS_SHELLCMD_SHORTCUT_PROVIDER (self));
+  g_assert (IDE_IS_CONTEXT (context));
+
+  if (g_list_model_get_n_items (G_LIST_MODEL (self->model)) > 1)
+    g_list_store_remove (self->model, 0);
+
+  if (ide_context_has_project (context))
+    {
+      project_model = gbp_shellcmd_command_model_new_for_project (context);
+      add_with_mapping (self->model, G_LIST_MODEL (project_model), TRUE);
+    }
+}
+
+static GListModel *
+gbp_shellcmd_shortcut_provider_list_shortcuts (IdeShortcutProvider *provider)
+{
+  GbpShellcmdShortcutProvider *self = (GbpShellcmdShortcutProvider *)provider;
+  GtkFlattenListModel *ret;
+
+  IDE_ENTRY;
+
+  g_assert (IDE_IS_MAIN_THREAD ());
+  g_assert (GBP_IS_SHELLCMD_SHORTCUT_PROVIDER (self));
+
+  if (self->model == NULL)
+    {
+      IdeContext *context = ide_object_get_context (IDE_OBJECT (self));
+      g_autoptr(GbpShellcmdCommandModel) app_model = gbp_shellcmd_command_model_new_for_app ();
+      g_autoptr(GbpShellcmdCommandModel) project_model = NULL;
+
+      self->model = g_list_store_new (G_TYPE_LIST_MODEL);
+
+      if (ide_context_has_project (context))
+        project_model = gbp_shellcmd_command_model_new_for_project (context);
+      else
+        g_signal_connect_object (context,
+                                 "notify::project-id",
+                                 G_CALLBACK (project_id_changed_cb),
+                                 self,
+                                 G_CONNECT_SWAPPED);
+
+      if (project_model != NULL)
+        add_with_mapping (self->model, G_LIST_MODEL (project_model), TRUE);
+      add_with_mapping (self->model, G_LIST_MODEL (app_model), FALSE);
+    }
+
+  ret = gtk_flatten_list_model_new (g_object_ref (G_LIST_MODEL (self->model)));
+
+  IDE_RETURN (G_LIST_MODEL (ret));
+}
+
+static void
+shortcut_provider_iface_init (IdeShortcutProviderInterface *iface)
+{
+  iface->list_shortcuts = gbp_shellcmd_shortcut_provider_list_shortcuts;
+}
+
+G_DEFINE_FINAL_TYPE_WITH_CODE (GbpShellcmdShortcutProvider, gbp_shellcmd_shortcut_provider, IDE_TYPE_OBJECT,
+                               G_IMPLEMENT_INTERFACE (IDE_TYPE_SHORTCUT_PROVIDER, 
shortcut_provider_iface_init))
+
+static void
+gbp_shellcmd_shortcut_provider_dispose (GObject *object)
+{
+  GbpShellcmdShortcutProvider *self = (GbpShellcmdShortcutProvider *)object;
+
+  g_clear_object (&self->model);
+
+  G_OBJECT_CLASS (gbp_shellcmd_shortcut_provider_parent_class)->dispose (object);
+}
+
+static void
+gbp_shellcmd_shortcut_provider_class_init (GbpShellcmdShortcutProviderClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->dispose = gbp_shellcmd_shortcut_provider_dispose;
+}
+
+static void
+gbp_shellcmd_shortcut_provider_init (GbpShellcmdShortcutProvider *self)
+{
+}
diff --git a/src/plugins/shellcmd/gbp-shellcmd-shortcut-provider.h 
b/src/plugins/shellcmd/gbp-shellcmd-shortcut-provider.h
new file mode 100644
index 000000000..7707d7b61
--- /dev/null
+++ b/src/plugins/shellcmd/gbp-shellcmd-shortcut-provider.h
@@ -0,0 +1,31 @@
+/* gbp-shellcmd-shortcut-provider.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
+
+#define GBP_TYPE_SHELLCMD_SHORTCUT_PROVIDER (gbp_shellcmd_shortcut_provider_get_type())
+
+G_DECLARE_FINAL_TYPE (GbpShellcmdShortcutProvider, gbp_shellcmd_shortcut_provider, GBP, 
SHELLCMD_SHORTCUT_PROVIDER, IdeObject)
+
+G_END_DECLS
diff --git a/src/plugins/shellcmd/meson.build b/src/plugins/shellcmd/meson.build
index 0476d6297..7cd294749 100644
--- a/src/plugins/shellcmd/meson.build
+++ b/src/plugins/shellcmd/meson.build
@@ -7,6 +7,7 @@ plugins_sources += files([
   'gbp-shellcmd-preferences-addin.c',
   'gbp-shellcmd-run-command.c',
   'gbp-shellcmd-run-command-provider.c',
+  'gbp-shellcmd-shortcut-provider.c',
 ])
 
 plugin_shellcmd_enum_headers = [
diff --git a/src/plugins/shellcmd/shellcmd-plugin.c b/src/plugins/shellcmd/shellcmd-plugin.c
index b5a6daee8..4a22fe1c2 100644
--- a/src/plugins/shellcmd/shellcmd-plugin.c
+++ b/src/plugins/shellcmd/shellcmd-plugin.c
@@ -27,6 +27,7 @@
 
 #include "gbp-shellcmd-preferences-addin.h"
 #include "gbp-shellcmd-run-command-provider.h"
+#include "gbp-shellcmd-shortcut-provider.h"
 
 _IDE_EXTERN void
 _gbp_shellcmd_register_types (PeasObjectModule *module)
@@ -37,4 +38,7 @@ _gbp_shellcmd_register_types (PeasObjectModule *module)
   peas_object_module_register_extension_type (module,
                                               IDE_TYPE_RUN_COMMAND_PROVIDER,
                                               GBP_TYPE_SHELLCMD_RUN_COMMAND_PROVIDER);
+  peas_object_module_register_extension_type (module,
+                                              IDE_TYPE_SHORTCUT_PROVIDER,
+                                              GBP_TYPE_SHELLCMD_SHORTCUT_PROVIDER);
 }