GNOME.org
 

[gnome-builder] langserv: implement formatter for Language Server Protocol

commit 47fc1ea59ef24eb9c7054acb17eb4ea503bbc0d3
Author: Christian Hergert <chergert redhat com>
Date:   Thu Mar 30 18:54:24 2017 -0600

    langserv: implement formatter for Language Server Protocol
    
    This is a fairly straightforward implementation of the Language Server
    Protocol for reformating text buffers.
    
    https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md#textDocument_formatting

 libide/Makefile.am                       |    2 +
 libide/langserv/ide-langserv-formatter.c |  437 ++++++++++++++++++++++++++++++
 libide/langserv/ide-langserv-formatter.h |   49 ++++
 3 files changed, 488 insertions(+), 0 deletions(-)
---
diff --git a/libide/Makefile.am b/libide/Makefile.am
index 6ec65f1..fe17c3c 100644
--- a/libide/Makefile.am
+++ b/libide/Makefile.am
@@ -81,6 +81,7 @@ libide_1_0_la_public_headers =                                              \
        langserv/ide-langserv-client.h                                      \
        langserv/ide-langserv-completion-provider.h                         \
        langserv/ide-langserv-diagnostic-provider.h                         \
+       langserv/ide-langserv-formatter.h                                   \
        langserv/ide-langserv-highlighter.h                                 \
        langserv/ide-langserv-rename-provider.h                             \
        langserv/ide-langserv-symbol-node.h                                 \
@@ -266,6 +267,7 @@ libide_1_0_la_public_sources =                                              \
        langserv/ide-langserv-client.c                                      \
        langserv/ide-langserv-completion-provider.c                         \
        langserv/ide-langserv-diagnostic-provider.c                         \
+       langserv/ide-langserv-formatter.c                                   \
        langserv/ide-langserv-highlighter.c                                 \
        langserv/ide-langserv-rename-provider.c                             \
        langserv/ide-langserv-symbol-node.c                                 \
diff --git a/libide/langserv/ide-langserv-formatter.c b/libide/langserv/ide-langserv-formatter.c
new file mode 100644
index 0000000..f616e1c
--- /dev/null
+++ b/libide/langserv/ide-langserv-formatter.c
@@ -0,0 +1,437 @@
+/* ide-langserv-formatter.c
+ *
+ * Copyright (C) 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 "ide-langserv-formatter"
+
+#include <jsonrpc-glib.h>
+
+#include "ide-context.h"
+#include "ide-debug.h"
+
+#include "buffers/ide-buffer.h"
+#include "buffers/ide-buffer-manager.h"
+#include "diagnostics/ide-source-location.h"
+#include "diagnostics/ide-source-range.h"
+#include "langserv/ide-langserv-formatter.h"
+#include "projects/ide-project-edit.h"
+
+typedef struct
+{
+  IdeLangservClient *client;
+} IdeLangservFormatterPrivate;
+
+enum {
+  PROP_0,
+  PROP_CLIENT,
+  N_PROPS
+};
+
+static void formatter_iface_init (IdeFormatterInterface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (IdeLangservFormatter, ide_langserv_formatter, IDE_TYPE_OBJECT,
+                         G_ADD_PRIVATE (IdeLangservFormatter)
+                         G_IMPLEMENT_INTERFACE (IDE_TYPE_FORMATTER, formatter_iface_init))
+
+static GParamSpec *properties [N_PROPS];
+
+/**
+ * ide_langserv_formatter_get_client:
+ * @self: a #IdeLangservFormatter
+ *
+ * Gets the client to use for the formatter.
+ *
+ * Returns: (transfer none): An #IdeLangservClient or %NULL.
+ */
+IdeLangservClient *
+ide_langserv_formatter_get_client (IdeLangservFormatter *self)
+{
+  IdeLangservFormatterPrivate *priv = ide_langserv_formatter_get_instance_private (self);
+
+  g_return_val_if_fail (IDE_IS_LANGSERV_FORMATTER (self), NULL);
+
+  return priv->client;
+}
+
+void
+ide_langserv_formatter_set_client (IdeLangservFormatter *self,
+                                   IdeLangservClient    *client)
+{
+  IdeLangservFormatterPrivate *priv = ide_langserv_formatter_get_instance_private (self);
+
+  g_return_if_fail (IDE_IS_LANGSERV_FORMATTER (self));
+
+  if (g_set_object (&priv->client, client))
+    g_object_notify_by_pspec (G_OBJECT (self), properties [PROP_CLIENT]);
+}
+
+static void
+ide_langserv_formatter_finalize (GObject *object)
+{
+  IdeLangservFormatter *self = (IdeLangservFormatter *)self;
+  IdeLangservFormatterPrivate *priv = ide_langserv_formatter_get_instance_private (self);
+
+  g_clear_object (&priv->client);
+
+  G_OBJECT_CLASS (ide_langserv_formatter_parent_class)->finalize (object);
+}
+
+static void
+ide_langserv_formatter_get_property (GObject    *object,
+                                     guint       prop_id,
+                                     GValue     *value,
+                                     GParamSpec *pspec)
+{
+  IdeLangservFormatter *self = IDE_LANGSERV_FORMATTER (object);
+
+  switch (prop_id)
+    {
+    case PROP_CLIENT:
+      g_value_set_object (value, ide_langserv_formatter_get_client (self));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+ide_langserv_formatter_set_property (GObject      *object,
+                                     guint         prop_id,
+                                     const GValue *value,
+                                     GParamSpec   *pspec)
+{
+  IdeLangservFormatter *self = IDE_LANGSERV_FORMATTER (object);
+
+  switch (prop_id)
+    {
+    case PROP_CLIENT:
+      ide_langserv_formatter_set_client (self, g_value_get_object (value));
+      break;
+
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+    }
+}
+
+static void
+ide_langserv_formatter_class_init (IdeLangservFormatterClass *klass)
+{
+  GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+  object_class->finalize = ide_langserv_formatter_finalize;
+  object_class->get_property = ide_langserv_formatter_get_property;
+  object_class->set_property = ide_langserv_formatter_set_property;
+
+  properties [PROP_CLIENT] =
+    g_param_spec_object ("client",
+                         "Client",
+                         "The client to communicate over",
+                         IDE_TYPE_LANGSERV_CLIENT,
+                         (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+
+  g_object_class_install_properties (object_class, N_PROPS, properties);
+}
+
+static void
+ide_langserv_formatter_init (IdeLangservFormatter *self)
+{
+}
+
+static void
+ide_langserv_formatter_apply_changes (IdeLangservFormatter *self,
+                                      IdeBuffer            *buffer,
+                                      GVariant             *text_edits)
+{
+  g_autoptr(GPtrArray) project_edits = NULL;
+  IdeBufferManager *buffer_manager;
+  IdeContext *context;
+  GVariant *text_edit;
+  IdeFile *ifile;
+  GVariantIter iter;
+
+  IDE_ENTRY;
+
+  g_assert (IDE_IS_LANGSERV_FORMATTER (self));
+  g_assert (text_edits != NULL);
+
+  if (!g_variant_is_container (text_edits))
+    {
+      g_warning ("variant is not a container, ignoring");
+      IDE_EXIT;
+    }
+
+  ifile = ide_buffer_get_file (buffer);
+  project_edits = g_ptr_array_new_with_free_func (g_object_unref);
+
+  g_variant_iter_init (&iter, text_edits);
+
+  while (g_variant_iter_loop (&iter, "v", &text_edit))
+    {
+      g_autoptr(IdeSourceLocation) begin_location = NULL;
+      g_autoptr(IdeSourceLocation) end_location = NULL;
+      g_autoptr(IdeSourceRange) range = NULL;
+      g_autoptr(IdeProjectEdit) edit = NULL;
+      const gchar *new_text = NULL;
+      gboolean success;
+      struct {
+        gint64 line;
+        gint64 column;
+      } begin, end;
+
+      success = JSONRPC_MESSAGE_PARSE (text_edit,
+        "range", "{",
+          "start", "{",
+            "line", JSONRPC_MESSAGE_GET_INT64 (&begin.line),
+            "character", JSONRPC_MESSAGE_GET_INT64 (&begin.column),
+          "}",
+          "end", "{",
+            "line", JSONRPC_MESSAGE_GET_INT64 (&end.line),
+            "character", JSONRPC_MESSAGE_GET_INT64 (&end.column),
+          "}",
+        "}",
+        "newText", JSONRPC_MESSAGE_GET_STRING (&new_text)
+      );
+
+      if (!success)
+        {
+          IDE_TRACE_MSG ("Failed to extract change from variant");
+          continue;
+        }
+
+      begin_location = ide_source_location_new (ifile, begin.line, begin.column, 0);
+      end_location = ide_source_location_new (ifile, end.line, end.column, 0);
+      range = ide_source_range_new (begin_location, end_location);
+
+      edit = g_object_new (IDE_TYPE_PROJECT_EDIT,
+                           "range", range,
+                           "replacement", new_text,
+                           NULL);
+
+      g_ptr_array_add (project_edits, g_steal_pointer (&edit));
+    }
+
+  context = ide_buffer_get_context (buffer);
+  buffer_manager = ide_context_get_buffer_manager (context);
+
+  ide_buffer_manager_apply_edits_async (buffer_manager,
+                                        g_steal_pointer (&project_edits),
+                                        NULL, NULL, NULL);
+
+  IDE_EXIT;
+}
+
+static void
+ide_langserv_formatter_format_call_cb (GObject      *object,
+                                       GAsyncResult *result,
+                                       gpointer      user_data)
+{
+  IdeLangservClient *client = (IdeLangservClient *)object;
+  g_autoptr(GTask) task = user_data;
+  g_autoptr(GError) error = NULL;
+  g_autoptr(GVariant) reply = NULL;
+  IdeLangservFormatter *self;
+  IdeBuffer *buffer;
+
+  g_return_if_fail (IDE_IS_LANGSERV_CLIENT (client));
+  g_return_if_fail (G_IS_ASYNC_RESULT (result));
+
+  if (!ide_langserv_client_call_finish (client, result, &reply, &error))
+    {
+      g_task_return_error (task, g_steal_pointer (&task));
+      return;
+    }
+
+  self = g_task_get_source_object (task);
+  buffer = g_task_get_task_data (task);
+
+  g_assert (IDE_IS_LANGSERV_FORMATTER (self));
+  g_assert (IDE_IS_BUFFER (buffer));
+
+  ide_langserv_formatter_apply_changes (self, buffer, reply);
+
+  g_task_return_boolean (task, TRUE);
+}
+
+static void
+ide_langserv_formatter_format_async (IdeFormatter        *formatter,
+                                     IdeBuffer           *buffer,
+                                     IdeFormatterOptions *options,
+                                     GCancellable        *cancellable,
+                                     GAsyncReadyCallback  callback,
+                                     gpointer             user_data)
+{
+  IdeLangservFormatter *self = (IdeLangservFormatter *)formatter;
+  IdeLangservFormatterPrivate *priv = ide_langserv_formatter_get_instance_private (self);
+  g_autoptr(GVariant) params = NULL;
+  g_autoptr(GTask) task = NULL;
+  g_autofree gchar *uri = NULL;
+  g_autofree gchar *text = NULL;
+  GtkTextIter begin;
+  GtkTextIter end;
+  gint64 version;
+  gint tab_size;
+  gboolean insert_spaces;
+
+  g_assert (IDE_IS_LANGSERV_FORMATTER (self));
+  g_assert (!cancellable || G_IS_CANCELLABLE (cancellable));
+
+  task = g_task_new (self, cancellable, callback, user_data);
+  g_task_set_source_tag (task, ide_langserv_formatter_format_async);
+  g_task_set_task_data (task, g_object_ref (buffer), g_object_unref);
+
+  gtk_text_buffer_get_bounds (GTK_TEXT_BUFFER (buffer), &begin, &end);
+  gtk_text_iter_order (&begin, &end);
+
+  version = ide_buffer_get_change_count (buffer);
+  uri = ide_buffer_get_uri (buffer);
+  text = gtk_text_buffer_get_text (GTK_TEXT_BUFFER (buffer), &begin, &end, TRUE);
+
+  tab_size = ide_formatter_options_get_tab_width (options);
+  insert_spaces = ide_formatter_options_get_insert_spaces (options);
+
+  params = JSONRPC_MESSAGE_NEW (
+    "textDocument", "{",
+      "uri", JSONRPC_MESSAGE_PUT_STRING (uri),
+      "text", JSONRPC_MESSAGE_PUT_STRING (text),
+      "version", JSONRPC_MESSAGE_PUT_INT64 (version),
+    "}",
+    "options", "{",
+      "tabSize", JSONRPC_MESSAGE_PUT_INT32 (tab_size),
+      "insertSpaces", JSONRPC_MESSAGE_PUT_BOOLEAN (insert_spaces),
+    "}"
+  );
+
+  ide_langserv_client_call_async (priv->client,
+                                  "textDocument/formatting",
+                                  g_steal_pointer (&params),
+                                  cancellable,
+                                  ide_langserv_formatter_format_call_cb,
+                                  g_steal_pointer (&task));
+}
+
+static gboolean
+ide_langserv_formatter_format_finish (IdeFormatter  *self,
+                                      GAsyncResult  *result,
+                                      GError       **error)
+{
+  g_assert (IDE_IS_FORMATTER (self));
+  g_assert (G_IS_TASK (result));
+
+  return g_task_propagate_boolean (G_TASK (result), error);
+}
+
+static void
+ide_langserv_formatter_format_range_async (IdeFormatter        *formatter,
+                                           IdeBuffer           *buffer,
+                                           IdeFormatterOptions *options,
+                                           const GtkTextIter   *begin,
+                                           const GtkTextIter   *end,
+                                           GCancellable        *cancellable,
+                                           GAsyncReadyCallback  callback,
+                                           gpointer             user_data)
+{
+  IdeLangservFormatter *self = (IdeLangservFormatter *)formatter;
+  IdeLangservFormatterPrivate *priv = ide_langserv_formatter_get_instance_private (self);
+  g_autoptr(GVariant) params = NULL;
+  g_autoptr(GTask) task = NULL;
+  g_autofree gchar *uri = NULL;
+  g_autofree gchar *text = NULL;
+  gint64 version;
+  gint tab_size;
+  gboolean insert_spaces;
+  struct {
+    gint line;
+    gint character;
+  } b, e;
+
+  g_assert (IDE_IS_LANGSERV_FORMATTER (self));
+  g_assert (!cancellable || G_IS_CANCELLABLE (cancellable));
+
+  task = g_task_new (self, cancellable, callback, user_data);
+  g_task_set_source_tag (task, ide_langserv_formatter_format_async);
+  g_task_set_task_data (task, g_object_ref (buffer), g_object_unref);
+
+  if (gtk_text_iter_compare (begin, end) > 0)
+    {
+      const GtkTextIter *tmp = end;
+      end = begin;
+      begin = tmp;
+    }
+
+  version = ide_buffer_get_change_count (buffer);
+  uri = ide_buffer_get_uri (buffer);
+  text = gtk_text_buffer_get_text (GTK_TEXT_BUFFER (buffer), begin, end, TRUE);
+
+  tab_size = ide_formatter_options_get_tab_width (options);
+  insert_spaces = ide_formatter_options_get_insert_spaces (options);
+
+  b.line = gtk_text_iter_get_line (begin);
+  b.character = gtk_text_iter_get_line_offset (begin);
+
+  e.line = gtk_text_iter_get_line (end);
+  e.character = gtk_text_iter_get_line_offset (begin);
+
+  params = JSONRPC_MESSAGE_NEW (
+    "textDocument", "{",
+      "uri", JSONRPC_MESSAGE_PUT_STRING (uri),
+      "text", JSONRPC_MESSAGE_PUT_STRING (text),
+      "version", JSONRPC_MESSAGE_PUT_INT64 (version),
+    "}",
+    "options", "{",
+      "tabSize", JSONRPC_MESSAGE_PUT_INT32 (tab_size),
+      "insertSpaces", JSONRPC_MESSAGE_PUT_BOOLEAN (insert_spaces),
+    "}",
+    "range", "{",
+      "start", "{",
+        "line", JSONRPC_MESSAGE_PUT_INT32 (b.line),
+        "character", JSONRPC_MESSAGE_PUT_INT32 (b.character),
+      "}",
+      "end", "{",
+        "line", JSONRPC_MESSAGE_PUT_INT32 (e.line),
+        "character", JSONRPC_MESSAGE_PUT_INT32 (e.character),
+      "}",
+    "}"
+  );
+
+  ide_langserv_client_call_async (priv->client,
+                                  "textDocument/rangeFormatting",
+                                  g_steal_pointer (&params),
+                                  cancellable,
+                                  ide_langserv_formatter_format_call_cb,
+                                  g_steal_pointer (&task));
+}
+
+static gboolean
+ide_langserv_formatter_format_range_finish (IdeFormatter  *self,
+                                            GAsyncResult  *result,
+                                            GError       **error)
+{
+  g_assert (IDE_IS_FORMATTER (self));
+  g_assert (G_IS_TASK (result));
+
+  return g_task_propagate_boolean (G_TASK (result), error);
+}
+
+static void
+formatter_iface_init (IdeFormatterInterface *iface)
+{
+  iface->format_async = ide_langserv_formatter_format_async;
+  iface->format_finish = ide_langserv_formatter_format_finish;
+  iface->format_range_async = ide_langserv_formatter_format_range_async;
+  iface->format_range_finish = ide_langserv_formatter_format_range_finish;
+}
diff --git a/libide/langserv/ide-langserv-formatter.h b/libide/langserv/ide-langserv-formatter.h
new file mode 100644
index 0000000..1f40b50
--- /dev/null
+++ b/libide/langserv/ide-langserv-formatter.h
@@ -0,0 +1,49 @@
+/* ide-langserv-formatter.h
+ *
+ * Copyright (C) 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/>.
+ */
+
+#ifndef IDE_LANGSERV_FORMATTER_H
+#define IDE_LANGSERV_FORMATTER_H
+
+#include "ide-object.h"
+
+#include "formatting/ide-formatter.h"
+#include "langserv/ide-langserv-client.h"
+
+G_BEGIN_DECLS
+
+#define IDE_TYPE_LANGSERV_FORMATTER (ide_langserv_formatter_get_type())
+
+struct _IdeLangservFormatter
+{
+  IdeObject parent_class;
+
+  gpointer _reserved1;
+  gpointer _reserved2;
+  gpointer _reserved3;
+  gpointer _reserved4;
+};
+
+G_DECLARE_FINAL_TYPE (IdeLangservFormatter, ide_langserv_formatter, IDE, LANGSERV_FORMATTER, IdeObject)
+
+void                  ide_langserv_formatter_set_client (IdeLangservFormatter *self,
+                                                         IdeLangservClient    *client);
+IdeLangservClient    *ide_langserv_formatter_get_client (IdeLangservFormatter *self);
+
+G_END_DECLS
+
+#endif /* IDE_LANGSERV_FORMATTER_H */
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]