[gnome-builder] plugins/dub: add plugin for Dub projects

[Christian Hergert <chergert src gnome org>]

commit 10a9ccebefbba9165b8776cff4759ee71c909d31
Author: steveno <oliver steven gmail com>
Date:   Wed Sep 28 21:25:10 2022 -0400

    plugins/dub: add plugin for Dub projects
    
    Contains the build system scaffolding, pipeline addins still needed.

 meson_options.txt                      |   1 +
 src/plugins/dub/dub-plugin.c           |  39 ++++++
 src/plugins/dub/dub.gresource.xml      |   6 +
 src/plugins/dub/dub.plugin             |  11 ++
 src/plugins/dub/gbp-dub-build-system.c | 243 +++++++++++++++++++++++++++++++++
 src/plugins/dub/gbp-dub-build-system.h |  37 +++++
 src/plugins/dub/meson.build            |  16 +++
 src/plugins/meson.build                |   2 +
 8 files changed, 355 insertions(+)
---
diff --git a/meson_options.txt b/meson_options.txt
index 7e16ee4cb..34904150e 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -32,6 +32,7 @@ option('plugin_copyright', type: 'boolean')
 option('plugin_ctags', type: 'boolean')
 option('plugin_deviced', type: 'boolean', value: false)
 option('plugin_dspy', type: 'boolean')
+option('plugin_dub', type: 'boolean')
 option('plugin_editorconfig', type: 'boolean')
 option('plugin_eslint', type: 'boolean')
 option('plugin_file_search', type: 'boolean')
diff --git a/src/plugins/dub/dub-plugin.c b/src/plugins/dub/dub-plugin.c
new file mode 100644
index 000000000..a8ee30734
--- /dev/null
+++ b/src/plugins/dub/dub-plugin.c
@@ -0,0 +1,39 @@
+/* dub-plugin.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 "dub-plugin"
+
+#include "config.h"
+
+#include <libpeas/peas.h>
+
+#include <libide-editor.h>
+#include <libide-gui.h>
+#include <libide-tree.h>
+
+#include "gbp-dub-build-system.h"
+
+_IDE_EXTERN void
+_gbp_dub_register_types (PeasObjectModule *module)
+{
+  peas_object_module_register_extension_type (module,
+                                              IDE_TYPE_BUILD_SYSTEM,
+                                              GBP_TYPE_DUB_BUILD_SYSTEM);
+}
diff --git a/src/plugins/dub/dub.gresource.xml b/src/plugins/dub/dub.gresource.xml
new file mode 100644
index 000000000..793572cdd
--- /dev/null
+++ b/src/plugins/dub/dub.gresource.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<gresources>
+  <gresource prefix="/plugins/dub">
+    <file>dub.plugin</file>
+  </gresource>
+</gresources>
\ No newline at end of file
diff --git a/src/plugins/dub/dub.plugin b/src/plugins/dub/dub.plugin
new file mode 100644
index 000000000..f4e73b69a
--- /dev/null
+++ b/src/plugins/dub/dub.plugin
@@ -0,0 +1,11 @@
+[Plugin]
+Authors=Steven Oliver <oliver steven gmail com>
+Builtin=true
+Copyright=Copyright © 2022 Steven Oliver
+Description=Provides integration with the dub build system
+Embedded=_gbp_dub_register_types
+Module=dub
+Name=dub
+X-Category=buildsystems
+X-Project-File-Filter-Name=dub (dub.json)
+X-Project-File-Filter-Pattern=dub.json
diff --git a/src/plugins/dub/gbp-dub-build-system.c b/src/plugins/dub/gbp-dub-build-system.c
new file mode 100644
index 000000000..af2041a07
--- /dev/null
+++ b/src/plugins/dub/gbp-dub-build-system.c
@@ -0,0 +1,243 @@
+/* gbp-dub-build-system.c
+ *
+ * Copyright 2022 Steven Oliver <oliver.steven@gmailcom>
+ *
+ * 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"
+#define DUB "dub"
+
+#include "config.h"
+
+#include "gbp-dub-build-system.h"
+
+struct _GbpDubBuildSystem
+{
+  IdeObject  parent_instance;
+  GFile     *project_file;
+};
+
+enum {
+  PROP_0,
+  PROP_PROJECT_FILE,
+  N_PROPS
+};
+
+static char *
+gbp_dub_build_system_get_id (IdeBuildSystem *build_system)
+{
+  return g_strdup (DUB);
+}
+
+static char *
+gbp_dub_build_system_get_display_name (IdeBuildSystem *build_system)
+{
+  return g_strdup ("dub");
+}
+
+static int
+gbp_dub_build_system_get_priority (IdeBuildSystem *build_system)
+{
+  return -200;
+}
+
+static gboolean
+gbp_dub_build_system_supports_language (IdeBuildSystem *build_system,
+                                        const char     *language)
+{
+  return g_strv_contains (IDE_STRV_INIT ("d"), language);
+}
+
+static void
+build_system_iface_init (IdeBuildSystemInterface *iface)
+{
+  iface->get_id = gbp_dub_build_system_get_id;
+  iface->get_display_name = gbp_dub_build_system_get_display_name;
+  iface->get_priority = gbp_dub_build_system_get_priority;
+  iface->supports_language = gbp_dub_build_system_supports_language;
+}
+
+G_DEFINE_FINAL_TYPE_WITH_CODE (GbpDubBuildSystem, gbp_dub_build_system, IDE_TYPE_OBJECT,
+                               G_IMPLEMENT_INTERFACE (IDE_TYPE_BUILD_SYSTEM, build_system_iface_init))
+
+static GParamSpec *properties [N_PROPS];
+
+static void
+gbp_dub_build_system_dispose (GObject *object)
+{
+  GbpDubBuildSystem *self = (GbpDubBuildSystem *)object;
+
+  g_clear_object (&self->project_file);
+
+  G_OBJECT_CLASS (gbp_dub_build_system_parent_class)->dispose (object);
+}
+
+static void
+gbp_dub_build_system_get_property (GObject    *object,
+                                   guint       prop_id,
+                                   GValue     *value,
+                                   GParamSpec *pspec)
+{
+  GbpDubBuildSystem *self = GBP_DUB_BUILD_SYSTEM (object);
+
+  switch (prop_id)
+    {
+    case PROP_PROJECT_FILE:
+      g_value_set_object (value, self->project_file);
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+gbp_dub_build_system_set_property (GObject      *object,
+                                   guint         prop_id,
+                                   const GValue *value,
+                                   GParamSpec   *pspec)
+{
+  GbpDubBuildSystem *self = GBP_DUB_BUILD_SYSTEM (object);
+
+  switch (prop_id)
+    {
+    case PROP_PROJECT_FILE:
+      g_set_object (&self->project_file, g_value_get_object (value));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+gbp_dub_build_system_class_init (GbpDubBuildSystemClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->dispose = gbp_dub_build_system_dispose;
+  object_class->get_property = gbp_dub_build_system_get_property;
+  object_class->set_property = gbp_dub_build_system_set_property;
+
+  properties [PROP_PROJECT_FILE] =
+    g_param_spec_object ("project-file",
+                         "Project File",
+                         "The project file (dub.json)",
+                         G_TYPE_FILE,
+                         (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+  g_object_class_install_properties (object_class, N_PROPS, properties);
+}
+
+static void
+gbp_dub_build_system_init (GbpDubBuildSystem *self)
+{
+}
+
+char *
+gbp_dub_build_system_get_project_dir (GbpDubBuildSystem *self)
+{
+  g_autoptr(GFile) workdir = NULL;
+  g_autofree char *base = NULL;
+  IdeContext *context;
+
+  g_return_val_if_fail (GBP_IS_DUB_BUILD_SYSTEM (self), NULL);
+
+  context = ide_object_get_context (IDE_OBJECT (self));
+  workdir = ide_context_ref_workdir (context);
+
+  if (self->project_file == NULL)
+    return g_strdup (g_file_peek_path (workdir));
+
+  base = g_file_get_basename (self->project_file);
+
+  if (strcasecmp (base, "dub.json") == 0)
+    {
+      g_autoptr(GFile) parent = g_file_get_parent (self->project_file);
+      return g_file_get_path (parent);
+    }
+
+  return g_file_get_path (self->project_file);
+}
+
+char *
+gbp_dub_build_system_get_dub_json_path (GbpDubBuildSystem *self)
+{
+  g_autofree char *base = NULL;
+  g_autoptr(GFile) child = NULL;
+
+  g_return_val_if_fail (GBP_IS_DUB_BUILD_SYSTEM (self), NULL);
+
+  base = g_file_get_basename (self->project_file);
+  if (strcasecmp (base, "dub.json") == 0)
+    return g_file_get_path (self->project_file);
+
+  child = g_file_get_child (self->project_file, "dub.json");
+  return g_file_get_path (child);
+}
+
+/**
+ * gbp_dub_build_system_locate_dub:
+ * @self: (nullable): a #GbpDubBuildSystem or %NULL
+ * @pipeline: (nullable): an #IdePipeline or %NULL
+ * @config: (nullable): an #IdeConfig or %NULL
+ *
+ * Currently, @self may be %NULL but is kept around so that in
+ * the future we may have other fallbacks which could take use
+ * of the build system.
+ *
+ * This function will first check for "DUB" in @config's environment
+ * variables. If specified, that will be used.
+ *
+ * Then the config's runtime+sdk-extensions will be checked and if it
+ * contains "dub" in the pipeline's $PATH, that will be used.
+ *
+ * Lastly, nothing was found, so "dub" will be used with the hope
+ * that something, somewhere, will find it when executing.
+ *
+ * Returns: (transfer full) (not nullable): a path to a dub program
+ *   or "dub" in the case that a specific path was not found.
+ */
+char *
+gbp_dub_build_system_locate_dub (GbpDubBuildSystem *self,
+                                 IdePipeline       *pipeline,
+                                 IdeConfig         *config)
+{
+  g_autofree char *dub_in_home = NULL;
+  const char *envvar;
+
+  g_return_val_if_fail (!self || GBP_IS_DUB_BUILD_SYSTEM (self), NULL);
+  g_return_val_if_fail (!pipeline || IDE_IS_PIPELINE (pipeline), NULL);
+  g_return_val_if_fail (!config || IDE_IS_CONFIG (config), NULL);
+
+  /* First check DUB=path override in IdeConfig */
+  if (config != NULL)
+    {
+      if ((envvar = ide_config_getenv (config, "DUB")))
+        return g_strdup (envvar);
+    }
+
+  /* Next see if the pipeline or one of it's extensions has Dub */
+  if (pipeline != NULL)
+    {
+      if (ide_pipeline_contains_program_in_path (pipeline, DUB, NULL))
+        return g_strdup (DUB);
+    }
+
+  /* Fallback to "dub" and hope for the best */
+  return g_strdup (DUB);
+}
diff --git a/src/plugins/dub/gbp-dub-build-system.h b/src/plugins/dub/gbp-dub-build-system.h
new file mode 100644
index 000000000..b480bfe52
--- /dev/null
+++ b/src/plugins/dub/gbp-dub-build-system.h
@@ -0,0 +1,37 @@
+/* gbp-dub-build-system.h
+ *
+ * Copyright 2016-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-foundry.h>
+
+G_BEGIN_DECLS
+
+#define GBP_TYPE_DUB_BUILD_SYSTEM (gbp_dub_build_system_get_type())
+
+G_DECLARE_FINAL_TYPE (GbpDubBuildSystem, gbp_dub_build_system, GBP, DUB_BUILD_SYSTEM, IdeObject)
+
+char *gbp_dub_build_system_get_dub_toml_path (GbpDubBuildSystem *self);
+char *gbp_dub_build_system_get_project_dir   (GbpDubBuildSystem *self);
+char *gbp_dub_build_system_locate_dub        (GbpDubBuildSystem *self,
+                                              IdePipeline       *pipeline,
+                                              IdeConfig         *config);
+
+G_END_DECLS
diff --git a/src/plugins/dub/meson.build b/src/plugins/dub/meson.build
new file mode 100644
index 000000000..a66c03742
--- /dev/null
+++ b/src/plugins/dub/meson.build
@@ -0,0 +1,16 @@
+if get_option('plugin_dub')
+
+plugins_sources += files([
+  'dub-plugin.c',
+  'gbp-dub-build-system.c',
+])
+
+plugin_dub_resources = gnome.compile_resources(
+  'dub-resources',
+  'dub.gresource.xml',
+  c_name: 'gbp_dub',
+)
+
+plugins_sources += plugin_dub_resources
+
+endif
diff --git a/src/plugins/meson.build b/src/plugins/meson.build
index fc5715811..deb2d81fe 100644
--- a/src/plugins/meson.build
+++ b/src/plugins/meson.build
@@ -60,6 +60,7 @@ subdir('debuggerui')
 subdir('deviced')
 subdir('doap')
 subdir('dspy')
+subdir('dub')
 subdir('editorui')
 subdir('editorconfig')
 subdir('eslint')
@@ -164,6 +165,7 @@ status += [
   'Copyright ............................ : @0@'.format(get_option('plugin_copyright')),
   'Deviced .............................. : @0@'.format(get_option('plugin_deviced')),
   'D-Bus Spy ............................ : @0@'.format(get_option('plugin_dspy')),
+  'Dub .................................. : @0@'.format(get_option('plugin_dub')),
   'Editorconfig ......................... : @0@'.format(get_option('plugin_editorconfig')),
   'ESLint ............................... : @0@'.format(get_option('plugin_eslint')),
   'File Search .......................... : @0@'.format(get_option('plugin_file_search')),