GNOME.org
 

[gnome-builder] plugins/dub: add build system discovery and pipeline addin

commit fcdbe4ee9d480ee01193a04845fdf9df9e7dcf7c
Author: Steven Oliver <oliver steven gmail com>
Date:   Tue Oct 4 02:19:35 2022 +0000

    plugins/dub: add build system discovery and pipeline addin
    
    This allows loading dub.json projects automatically with build system
    discovery. The pipeline connects basic project building.

 src/plugins/dub/dub-plugin.c                     |   8 ++
 src/plugins/dub/gbp-dub-build-system-discovery.c |  47 ++++++
 src/plugins/dub/gbp-dub-build-system-discovery.h |  31 ++++
 src/plugins/dub/gbp-dub-pipeline-addin.c         | 173 +++++++++++++++++++++++
 src/plugins/dub/gbp-dub-pipeline-addin.h         |  31 ++++
 src/plugins/dub/meson.build                      |   2 +
 6 files changed, 292 insertions(+)
---
diff --git a/src/plugins/dub/dub-plugin.c b/src/plugins/dub/dub-plugin.c
index a8ee30734..6128cbc54 100644
--- a/src/plugins/dub/dub-plugin.c
+++ b/src/plugins/dub/dub-plugin.c
@@ -29,6 +29,8 @@
 #include <libide-tree.h>
 
 #include "gbp-dub-build-system.h"
+#include "gbp-dub-build-system-discovery.h"
+#include "gbp-dub-pipeline-addin.h"
 
 _IDE_EXTERN void
 _gbp_dub_register_types (PeasObjectModule *module)
@@ -36,4 +38,10 @@ _gbp_dub_register_types (PeasObjectModule *module)
   peas_object_module_register_extension_type (module,
                                               IDE_TYPE_BUILD_SYSTEM,
                                               GBP_TYPE_DUB_BUILD_SYSTEM);
+  peas_object_module_register_extension_type (module,
+                                              IDE_TYPE_BUILD_SYSTEM_DISCOVERY,
+                                              GBP_TYPE_DUB_BUILD_SYSTEM_DISCOVERY);
+  peas_object_module_register_extension_type (module,
+                                              IDE_TYPE_PIPELINE_ADDIN,
+                                              GBP_TYPE_DUB_PIPELINE_ADDIN);
 }
diff --git a/src/plugins/dub/gbp-dub-build-system-discovery.c 
b/src/plugins/dub/gbp-dub-build-system-discovery.c
new file mode 100644
index 000000000..310e84990
--- /dev/null
+++ b/src/plugins/dub/gbp-dub-build-system-discovery.c
@@ -0,0 +1,47 @@
+/* gbp-dub-build-system-discovery.c
+ *
+ * Copyright 2022 Steven Oliver <oliver steven gmail 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-dub-build-system-discovery"
+
+#include "config.h"
+
+#include "gbp-dub-build-system-discovery.h"
+
+struct _GbpDubBuildSystemDiscovery
+{
+  IdeSimpleBuildSystemDiscovery parent_instance;
+};
+
+G_DEFINE_FINAL_TYPE (GbpDubBuildSystemDiscovery, gbp_dub_build_system_discovery, 
IDE_TYPE_SIMPLE_BUILD_SYSTEM_DISCOVERY)
+
+static void
+gbp_dub_build_system_discovery_class_init (GbpDubBuildSystemDiscoveryClass *klass)
+{
+}
+
+static void
+gbp_dub_build_system_discovery_init (GbpDubBuildSystemDiscovery *self)
+{
+  g_object_set (self,
+                "glob", "dub.json",
+                "hint", "dub",
+                "priority", -200,
+                NULL);
+}
diff --git a/src/plugins/dub/gbp-dub-build-system-discovery.h 
b/src/plugins/dub/gbp-dub-build-system-discovery.h
new file mode 100644
index 000000000..4e3c1a6bd
--- /dev/null
+++ b/src/plugins/dub/gbp-dub-build-system-discovery.h
@@ -0,0 +1,31 @@
+/* gbp-dub-build-system-discovery.h
+ *
+ * Copyright 2022 Steven Olive<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-foundry.h>
+
+G_BEGIN_DECLS
+
+#define GBP_TYPE_DUB_BUILD_SYSTEM_DISCOVERY (gbp_dub_build_system_discovery_get_type())
+
+G_DECLARE_FINAL_TYPE (GbpDubBuildSystemDiscovery, gbp_dub_build_system_discovery, GBP, 
DUB_BUILD_SYSTEM_DISCOVERY, IdeSimpleBuildSystemDiscovery)
+
+G_END_DECLS
diff --git a/src/plugins/dub/gbp-dub-pipeline-addin.c b/src/plugins/dub/gbp-dub-pipeline-addin.c
new file mode 100644
index 000000000..556430175
--- /dev/null
+++ b/src/plugins/dub/gbp-dub-pipeline-addin.c
@@ -0,0 +1,173 @@
+/* gbp-dub-pipeline-addin.c
+ *
+ * Copyright 2022 Steven Oliver <oliver steven gmail 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-dub-pipeline-addin"
+
+#include "config.h"
+
+#include <glib/gi18n.h>
+
+#include <libide-foundry.h>
+
+#include "gbp-dub-build-system.h"
+#include "gbp-dub-pipeline-addin.h"
+
+struct _GbpDubPipelineAddin
+{
+  IdeObject parent_instance;
+};
+
+G_GNUC_NULL_TERMINATED
+static IdeRunCommand *
+create_run_command (IdePipeline *pipeline,
+                    const char  *project_dir,
+                    const char  *argv,
+                    ...)
+{
+  IdeRunCommand *ret;
+  va_list args;
+
+  g_assert (IDE_IS_PIPELINE (pipeline));
+
+  ret = ide_run_command_new ();
+  ide_run_command_set_cwd (ret, project_dir);
+
+  va_start (args, argv);
+  while (argv != NULL)
+    {
+      ide_run_command_append_argv (ret, argv);
+      argv = va_arg (args, const char *);
+    }
+  va_end (args);
+
+  return g_steal_pointer (&ret);
+}
+
+static IdePipelineStage *
+attach_run_command (GbpDubPipelineAddin *self,
+                    IdePipeline           *pipeline,
+                    IdePipelinePhase       phase,
+                    IdeRunCommand         *build_command,
+                    IdeRunCommand         *clean_command,
+                    const char            *title)
+{
+  g_autoptr(IdePipelineStage) stage = NULL;
+  guint id;
+
+  g_assert (GBP_IS_DUB_PIPELINE_ADDIN (self));
+  g_assert (IDE_IS_PIPELINE (pipeline));
+  g_assert (IDE_IS_RUN_COMMAND (build_command));
+  g_assert (!clean_command || IDE_IS_RUN_COMMAND (clean_command));
+
+  stage = ide_pipeline_stage_command_new (build_command, clean_command);
+  ide_pipeline_stage_set_name (stage, title);
+
+  id = ide_pipeline_attach (pipeline, phase, 0, stage);
+  ide_pipeline_addin_track (IDE_PIPELINE_ADDIN (self), id);
+
+  return g_steal_pointer (&stage);
+}
+
+static void
+query_cb (IdePipelineStage *stage,
+          IdePipeline      *pipeline,
+          GPtrArray        *targets,
+          GCancellable     *cancellable,
+          gpointer          user_data)
+{
+  g_assert (IDE_IS_PIPELINE_STAGE (stage));
+  g_assert (IDE_IS_PIPELINE (pipeline));
+  g_assert (!cancellable || G_IS_CANCELLABLE (cancellable));
+
+  /* Always defer to dub to check if build is needed */
+  ide_pipeline_stage_set_completed (stage, FALSE);
+}
+
+static void
+gbp_dub_pipeline_addin_load (IdePipelineAddin *addin,
+                               IdePipeline      *pipeline)
+{
+  GbpDubPipelineAddin *self = (GbpDubPipelineAddin *)addin;
+  g_autoptr(IdeRunCommand) build_command = NULL;
+  g_autoptr(IdeRunCommand) clean_command = NULL;
+  g_autoptr(IdePipelineStage) build_stage = NULL;
+  g_autofree char *project_dir = NULL;
+  g_autofree char *dub = NULL;
+  IdeBuildSystem *build_system;
+  const char *config_opts;
+  IdeContext *context;
+  IdeConfig *config;
+
+  IDE_ENTRY;
+
+  g_assert (GBP_IS_DUB_PIPELINE_ADDIN (self));
+  g_assert (IDE_IS_PIPELINE (pipeline));
+
+  context = ide_object_get_context (IDE_OBJECT (addin));
+  build_system = ide_build_system_from_context (context);
+
+  if (!GBP_IS_DUB_BUILD_SYSTEM (build_system))
+    IDE_EXIT;
+
+  project_dir = gbp_dub_build_system_get_project_dir (GBP_DUB_BUILD_SYSTEM (build_system));
+  config = ide_pipeline_get_config (pipeline);
+  config_opts = ide_config_get_config_opts (config);
+  dub = gbp_dub_build_system_locate_dub (GBP_DUB_BUILD_SYSTEM (build_system), pipeline, config);
+
+  g_assert (project_dir != NULL);
+  g_assert (IDE_IS_CONFIG (config));
+  g_assert (dub != NULL);
+
+  build_command = create_run_command (pipeline, project_dir, dub, "build", NULL);
+  clean_command = create_run_command (pipeline, project_dir, dub, "clean", NULL);
+
+  if (!ide_config_get_debug (config))
+    ide_run_command_append_argv (build_command, "--build=release");
+
+  /* Configure Options get passed to "dub build" because there is no
+   * equivalent "configure stage" for dub.
+   */
+  if (!ide_str_empty0 (config_opts))
+    ide_run_command_append_parsed (build_command, config_opts, NULL);
+
+  build_stage = attach_run_command (self, pipeline, IDE_PIPELINE_PHASE_BUILD, build_command, clean_command, 
_("Build project"));
+  g_signal_connect (build_stage, "query", G_CALLBACK (query_cb), NULL);
+
+  IDE_EXIT;
+}
+
+static void
+pipeline_addin_iface_init (IdePipelineAddinInterface *iface)
+{
+  iface->load = gbp_dub_pipeline_addin_load;
+}
+
+G_DEFINE_FINAL_TYPE_WITH_CODE (GbpDubPipelineAddin, gbp_dub_pipeline_addin, IDE_TYPE_OBJECT,
+                               G_IMPLEMENT_INTERFACE (IDE_TYPE_PIPELINE_ADDIN, pipeline_addin_iface_init))
+
+static void
+gbp_dub_pipeline_addin_class_init (GbpDubPipelineAddinClass *klass)
+{
+}
+
+static void
+gbp_dub_pipeline_addin_init (GbpDubPipelineAddin *self)
+{
+}
diff --git a/src/plugins/dub/gbp-dub-pipeline-addin.h b/src/plugins/dub/gbp-dub-pipeline-addin.h
new file mode 100644
index 000000000..403d4d810
--- /dev/null
+++ b/src/plugins/dub/gbp-dub-pipeline-addin.h
@@ -0,0 +1,31 @@
+/* gbp-dub-pipeline-addin.h
+ *
+ * Copyright 2022 Steven Oliver <oliver steven gmail 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_DUB_PIPELINE_ADDIN (gbp_dub_pipeline_addin_get_type())
+
+G_DECLARE_FINAL_TYPE (GbpDubPipelineAddin, gbp_dub_pipeline_addin, GBP, DUB_PIPELINE_ADDIN, IdeObject)
+
+G_END_DECLS
diff --git a/src/plugins/dub/meson.build b/src/plugins/dub/meson.build
index a66c03742..2a3145a52 100644
--- a/src/plugins/dub/meson.build
+++ b/src/plugins/dub/meson.build
@@ -3,6 +3,8 @@ if get_option('plugin_dub')
 plugins_sources += files([
   'dub-plugin.c',
   'gbp-dub-build-system.c',
+  'gbp-dub-build-system-discovery.c',
+  'gbp-dub-pipeline-addin.c',
 ])
 
 plugin_dub_resources = gnome.compile_resources(
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]