[gnome-builder] project-tree: add tree builder for vcs status

[Christian Hergert <chergert src gnome org>]

commit 76181cea7d71917f01161e4adffd413b739bcde1
Author: Christian Hergert <chergert redhat com>
Date:   Sat Dec 9 02:11:08 2017 -0800

    project-tree: add tree builder for vcs status
    
    This doesn't yet set the emblems (we need artwork made), but it
    will query the VCS status from the given back-end asynchronously
    and then update the node with the result.
    
    One thing this doesn't yet handle (that I'd like to) is adding
    an emblem to each of the parent nodes. The difficulty currently
    is that we would need to synthesize the parent nodes in the
    hashtable so that we can add status objects for directories
    when querying the VCS.

 src/plugins/project-tree/gb-project-tree.c     |    4 +
 src/plugins/project-tree/gb-vcs-tree-builder.c |  230 ++++++++++++++++++++++++
 src/plugins/project-tree/gb-vcs-tree-builder.h |   31 ++++
 src/plugins/project-tree/meson.build           |    2 +
 4 files changed, 267 insertions(+), 0 deletions(-)
---
diff --git a/src/plugins/project-tree/gb-project-tree.c b/src/plugins/project-tree/gb-project-tree.c
index 2775391..34df0e8 100644
--- a/src/plugins/project-tree/gb-project-tree.c
+++ b/src/plugins/project-tree/gb-project-tree.c
@@ -26,6 +26,7 @@
 #include "gb-project-tree-actions.h"
 #include "gb-project-tree-builder.h"
 #include "gb-project-tree-private.h"
+#include "gb-vcs-tree-builder.h"
 
 G_DEFINE_TYPE (GbProjectTree, gb_project_tree, DZL_TYPE_TREE)
 
@@ -334,6 +335,9 @@ gb_project_tree_init (GbProjectTree *self)
   builder = gb_project_tree_builder_new ();
   dzl_tree_add_builder (DZL_TREE (self), builder);
 
+  builder = gb_vcs_tree_builder_new ();
+  dzl_tree_add_builder (DZL_TREE (self), builder);
+
   g_signal_connect (self,
                     "notify::selection",
                     G_CALLBACK (gb_project_tree_notify_selection),
diff --git a/src/plugins/project-tree/gb-vcs-tree-builder.c b/src/plugins/project-tree/gb-vcs-tree-builder.c
new file mode 100644
index 0000000..8955d43
--- /dev/null
+++ b/src/plugins/project-tree/gb-vcs-tree-builder.c
@@ -0,0 +1,230 @@
+/* gb-vcs-tree-builder.c
+ *
+ * Copyright © 2017 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/>.
+ */
+
+#define G_LOG_DOMAIN "gb-vcs-tree-builder"
+
+#include <ide.h>
+
+#include "gb-project-file.h"
+#include "gb-vcs-tree-builder.h"
+
+struct _GbVcsTreeBuilder
+{
+  DzlTreeBuilder parent_instance;
+
+  /*
+   * This is a mapping of a #GFile to the node that was built for it.
+   * After we've returned to the main loop, an operation is requested
+   * to get all of the project file status and then each node is updated
+   * with the resulting information.
+   */
+  GHashTable *queued;
+
+  /*
+   * Our registered idle handler to flush the requests into a VCS query.
+   * This will start the async process which queries the VCS (and then we
+   * can handle the results to update the nodes).
+   */
+  guint queued_handler;
+};
+
+G_DEFINE_TYPE (GbVcsTreeBuilder, gb_vcs_tree_builder, DZL_TYPE_TREE_BUILDER)
+
+static void
+gb_vcs_tree_builder_list_status_cb (GObject      *object,
+                                    GAsyncResult *result,
+                                    gpointer      user_data)
+{
+  IdeVcs *vcs = (IdeVcs *)object;
+  g_autoptr(GError) error = NULL;
+  g_autoptr(GTask) task = user_data;
+  g_autoptr(GListModel) model = NULL;
+  GHashTable *queued;
+  guint n_items;
+
+  g_assert (IDE_IS_VCS (vcs));
+
+  model = ide_vcs_list_status_finish (vcs, result, &error);
+
+  if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_CANCELLED) ||
+      g_error_matches (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
+    return;
+
+  if (error != NULL)
+    {
+      g_warning ("%s", error->message);
+      return;
+    }
+
+  queued = g_task_get_task_data (task);
+  g_assert (queued != NULL);
+
+  n_items = g_list_model_get_n_items (model);
+
+  for (guint i = 0; i < n_items; i++)
+    {
+      g_autoptr(IdeVcsFileInfo) info = g_list_model_get_item (model, i);
+      GFile *file = ide_vcs_file_info_get_file (info);
+      DzlTreeNode *node = g_hash_table_lookup (queued, file);
+
+      if (node != NULL)
+        {
+          IdeVcsFileStatus status = ide_vcs_file_info_get_status (info);
+
+          switch (status)
+            {
+            case IDE_VCS_FILE_STATUS_ADDED:
+              /* TODO: add emblems */
+              break;
+
+            case IDE_VCS_FILE_STATUS_CHANGED:
+              /* TODO: add emblems */
+              break;
+
+            case IDE_VCS_FILE_STATUS_DELETED:
+            case IDE_VCS_FILE_STATUS_RENAMED:
+            case IDE_VCS_FILE_STATUS_IGNORED:
+            case IDE_VCS_FILE_STATUS_UNCHANGED:
+            default:
+              break;
+            }
+
+        }
+    }
+}
+
+static gboolean
+gb_vcs_tree_builder_flush (gpointer data)
+{
+  GbVcsTreeBuilder *self = data;
+  g_autoptr(GHashTable) queued = NULL;
+  DzlTreeNode *root;
+  IdeContext *context;
+  DzlTree *tree;
+
+  g_assert (GB_IS_VCS_TREE_BUILDER (self));
+
+  self->queued_handler = 0;
+
+  queued = g_steal_pointer (&self->queued);
+
+  tree = dzl_tree_builder_get_tree (DZL_TREE_BUILDER (self));
+  root = dzl_tree_get_root (tree);
+  context = IDE_CONTEXT (dzl_tree_node_get_item (root));
+
+  if (context != NULL && queued != NULL)
+    {
+      g_autoptr(GTask) task = NULL;
+      IdeVcs *vcs;
+
+      task = g_task_new (self, NULL, NULL, NULL);
+      g_task_set_source_tag (task, gb_vcs_tree_builder_flush);
+      g_task_set_priority (task, G_PRIORITY_LOW);
+      g_task_set_task_data (task,
+                            g_steal_pointer (&queued),
+                            (GDestroyNotify) g_hash_table_unref);
+
+      vcs = ide_context_get_vcs (context);
+
+      /* TODO: We could possibly reduce how much we look at here
+       *       instead of querying the whole data set.
+       */
+
+      ide_vcs_list_status_async (vcs,
+                                 NULL,
+                                 TRUE,
+                                 G_PRIORITY_LOW,
+                                 NULL,
+                                 gb_vcs_tree_builder_list_status_cb,
+                                 g_steal_pointer (&task));
+    }
+
+  return G_SOURCE_REMOVE;
+}
+
+static void
+gb_vcs_tree_builder_build_node (DzlTreeBuilder *builder,
+                                DzlTreeNode    *node)
+{
+  GbVcsTreeBuilder *self = (GbVcsTreeBuilder *)builder;
+  GObject *item;
+  GFile *file;
+
+  g_assert (GB_IS_VCS_TREE_BUILDER (self));
+  g_assert (DZL_IS_TREE_NODE (node));
+
+  item = dzl_tree_node_get_item (node);
+
+  if (!GB_IS_PROJECT_FILE (item))
+    return;
+
+  file = gb_project_file_get_file (GB_PROJECT_FILE (item));
+
+  if (!G_IS_FILE (file))
+    return;
+
+  if (self->queued == NULL)
+    self->queued = g_hash_table_new_full (g_file_hash,
+                                          (GEqualFunc) g_file_equal,
+                                          g_object_unref,
+                                          g_object_unref);
+
+  g_assert (G_IS_FILE (file));
+  g_assert (DZL_IS_TREE_NODE (node));
+
+  g_hash_table_insert (self->queued, g_object_ref (file), g_object_ref (node));
+
+  if (self->queued_handler == 0)
+    self->queued_handler = g_idle_add_full (G_PRIORITY_LOW,
+                                            gb_vcs_tree_builder_flush,
+                                            g_object_ref (self),
+                                            g_object_unref);
+}
+
+static void
+gb_vcs_tree_builder_dispose (GObject *object)
+{
+  GbVcsTreeBuilder *self = (GbVcsTreeBuilder *)object;
+
+  g_clear_pointer (&self->queued, g_hash_table_unref);
+  dzl_clear_source (&self->queued_handler);
+
+  G_OBJECT_CLASS (gb_vcs_tree_builder_parent_class)->dispose (object);
+}
+
+static void
+gb_vcs_tree_builder_class_init (GbVcsTreeBuilderClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+  DzlTreeBuilderClass *builder_class = DZL_TREE_BUILDER_CLASS (klass);
+
+  object_class->dispose = gb_vcs_tree_builder_dispose;
+
+  builder_class->build_node = gb_vcs_tree_builder_build_node;
+}
+
+static void
+gb_vcs_tree_builder_init (GbVcsTreeBuilder *self)
+{
+}
+
+DzlTreeBuilder *
+gb_vcs_tree_builder_new (void)
+{
+  return g_object_new (GB_TYPE_VCS_TREE_BUILDER, NULL);
+}
diff --git a/src/plugins/project-tree/gb-vcs-tree-builder.h b/src/plugins/project-tree/gb-vcs-tree-builder.h
new file mode 100644
index 0000000..b1a9a3c
--- /dev/null
+++ b/src/plugins/project-tree/gb-vcs-tree-builder.h
@@ -0,0 +1,31 @@
+/* gb-vcs-tree-builder.h
+ *
+ * Copyright © 2017 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/>.
+ */
+
+#pragma once
+
+#include <dazzle.h>
+
+G_BEGIN_DECLS
+
+#define GB_TYPE_VCS_TREE_BUILDER (gb_vcs_tree_builder_get_type())
+
+G_DECLARE_FINAL_TYPE (GbVcsTreeBuilder, gb_vcs_tree_builder, GB, VCS_TREE_BUILDER, DzlTreeBuilder)
+
+DzlTreeBuilder *gb_vcs_tree_builder_new (void);
+
+G_END_DECLS
diff --git a/src/plugins/project-tree/meson.build b/src/plugins/project-tree/meson.build
index c18d31b..4ca0242 100644
--- a/src/plugins/project-tree/meson.build
+++ b/src/plugins/project-tree/meson.build
@@ -25,6 +25,8 @@ project_tree_sources = [
   'gb-rename-file-popover.h',
   'gb-project-tree-addin.c',
   'gb-project-tree-addin.h',
+  'gb-vcs-tree-builder.c',
+  'gb-vcs-tree-builder.h',
   'project-tree-plugin.c',
 ]