Use fallback indenter for textDocument/formatting request

To format entire GPR files.

For eng/ide/ada_language_server#1529

Author: AnthonyLeonardoGracio

source/ada/lsp-ada_handlers-formatting.adb

@@ -202,36 +202,56 @@ package body LSP.Ada_Handlers.Formatting is
      (Tracer   : not null LSP.Tracers.Tracer_Access;
       Filename : GNATCOLL.VFS.Virtual_File;
       Document : LSP.Text_Documents.Text_Document'Class;
-      Span     : LSP.Structures.A_Range;
       Options  : Gnatformat.Configuration.Format_Options_Type;
+      Span     : LSP.Structures.A_Range := LSP.Text_Documents.Empty_Range;
       Success  : out Boolean;
       Response : out LSP.Structures.TextEdit_Vector;
       Messages : out VSS.String_Vectors.Virtual_String_Vector;
       Error    : out LSP.Errors.ResponseError)
    is
       pragma Unreferenced (Messages);
+      use LSP.Structures;
+      use LSP.Text_Documents;
       use VSS.Strings;
 
+      Actual_Span : constant A_Range :=
+        (if Span = Empty_Range
+         then ((0, 0), (Integer'Max (Document.Line_Count - 1, 0), 0))
+         else Span);
+      --  If no span is provided, indent the whole document.
+
+      Buffer : constant VSS.Strings.Virtual_String :=
+        (if Span = Empty_Range
+         then Document.Text
+         else Document.Slice (((0, 0), Actual_Span.an_end)));
+      --  Get the relevant buffer to indent.
+      --  If no span is provided, get the whole document buffer.
+      --  Otherwise get the buffer from the start of the document
+      --  to the end of the given span.
+
       Indent_Lines :
         constant LSP.Formatters.Fallback_Indenter.Indentation_Array :=
           Get_Indentation
             (Filename => Filename,
-             Buffer   => Document.Slice (((0, 0), Span.an_end)),
-             Span     => Span,
+             Buffer   => Buffer,
+             Span     => Actual_Span,
              Options  => Options);
-      Pos          : LSP.Structures.Position;
-      Line_Span    : LSP.Structures.A_Range;
+      --  Get the indentation levels for each line in the span.
+
+      Pos       : LSP.Structures.Position;
    begin
-      Tracer.Trace_Text
-        (Incorrect_Code_Msg & ", using the fallback indenter");
+      Tracer.Trace_Text (Incorrect_Code_Msg & ", using the fallback indenter");
       for Line in Indent_Lines'Range loop
          if Indent_Lines (Line) /= -1 then
+            --  LSP is 0-based, while the array returned by the fallback
+            --  indenter is 1-based.
             Pos := (Line - 1, 0);
-            Line_Span := (Pos, (Pos.line + 1, 0));
+
+            --  Generate a text edit to reindent the line.
             Response.Append
               (Reindent_Line
                  (Filename   => Filename,
-                  Line       => Document.Slice (Line_Span),
+                  Line       => Document.Get_Line (Pos.line),
                   Options    => Options,
                   Pos        => Pos,
                   New_Indent => Indent_Lines (Line)));

source/ada/lsp-ada_handlers-formatting.ads

@@ -59,6 +59,8 @@ package LSP.Ada_Handlers.Formatting is
       return LSP.Formatters.Fallback_Indenter.Indentation_Array;
    --  Use the fallback indenter to get an array of indentation for each
    --  line in Span.
+   --  Each line in the array is 1-based indexed (i.e., the first line is at
+   --  index 1).
    --  Buffer is the content of the document referenced by Filename. Should
    --  contain the whole content of the document or a substring including
    --  at least the lines in Span.
@@ -67,14 +69,15 @@ package LSP.Ada_Handlers.Formatting is
      (Tracer   : not null LSP.Tracers.Tracer_Access;
       Filename : GNATCOLL.VFS.Virtual_File;
       Document : LSP.Text_Documents.Text_Document'Class;
-      Span     : LSP.Structures.A_Range;
       Options  : Gnatformat.Configuration.Format_Options_Type;
+      Span     : LSP.Structures.A_Range := LSP.Text_Documents.Empty_Range;
       Success  : out Boolean;
       Response : out LSP.Structures.TextEdit_Vector;
       Messages : out VSS.String_Vectors.Virtual_String_Vector;
       Error    : out LSP.Errors.ResponseError);
    --  Generate a TextEdit_Vector to reindent the lines in Span using the
    --  fallback indenter.
+   --  If no Span is provided, the whole document is indented.
    --  Document is the document to indent.
    --  Tracer is used to log messages.
    --  Filename is the name of the file referenced by Document. Used to

source/gpr/lsp-gpr_handlers.adb

@@ -444,6 +444,8 @@ package body LSP.GPR_Handlers is
             others            => <>));
       Capabilities.documentRangeFormattingProvider :=
         (Is_Set => True, Value => (Is_Boolean => True, Boolean => True));
+      Capabilities.documentFormattingProvider :=
+        (Is_Set => True, Value => (Is_Boolean => True, Boolean => True));
 
       Capabilities.textDocumentSync :=
         (Is_Set => True,
@@ -508,6 +510,48 @@ package body LSP.GPR_Handlers is
       Self.Sender.On_Initialize_Response (Id, Response);
    end On_Initialize_Request;
 
+   ---------------------------
+   -- On_Formatting_Request --
+   ---------------------------
+
+   overriding
+   procedure On_Formatting_Request
+     (Self  : in out Message_Handler;
+      Id    : LSP.Structures.Integer_Or_Virtual_String;
+      Value : LSP.Structures.DocumentFormattingParams)
+   is
+      Document : constant LSP.GPR_Documents.Document_Access :=
+        Self.Get_Open_Document (Value.textDocument.uri);
+      Response : LSP.Structures.TextEdit_Vector_Or_Null;
+      Error    : LSP.Errors.ResponseError;
+      Success  : Boolean := True;
+      Messages : VSS.String_Vectors.Virtual_String_Vector;
+      Options  : constant Gnatformat.Configuration.Format_Options_Type :=
+        Gnatformat.Configuration.Default_Format_Options;
+   begin
+      LSP.Ada_Handlers.Formatting.Indent_Lines
+        (Tracer   => Self.Tracer,
+         Filename => Self.To_File (Value.textDocument.uri),
+         Document => Document.all,
+         Options  => Options,
+         Success  => Success,
+         Response => Response,
+         Messages => Messages,
+         Error    => Error);
+
+      if Success then
+         Self.Sender.On_Formatting_Response (Id, Response);
+
+         for Message of Messages loop
+            Self.Sender.On_ShowMessage_Notification
+              ((LSP.Enumerations.Info, Message));
+         end loop;
+
+      else
+         Self.Sender.On_Error_Response (Id, Error);
+      end if;
+   end On_Formatting_Request;
+
    --------------------------------
    -- On_RangeFormatting_Request --
    --------------------------------
@@ -527,7 +571,6 @@ package body LSP.GPR_Handlers is
       Options  : constant Gnatformat.Configuration.Format_Options_Type :=
         Gnatformat.Configuration.Default_Format_Options;
    begin
-      --  TODO: check if we can get indentation options from GNATformat
       LSP.Ada_Handlers.Formatting.Indent_Lines
         (Tracer   => Self.Tracer,
          Filename => Self.To_File (Value.textDocument.uri),

source/gpr/lsp-gpr_handlers.ads

@@ -158,11 +158,18 @@ private
      (Self  : in out Message_Handler;
       Value : LSP.Structures.DidSaveTextDocumentParams);
 
-   overriding procedure On_Hover_Request
+   overriding
+   procedure On_Hover_Request
      (Self  : in out Message_Handler;
       Id    : LSP.Structures.Integer_Or_Virtual_String;
       Value : LSP.Structures.HoverParams);
 
+   overriding
+   procedure On_Formatting_Request
+     (Self  : in out Message_Handler;
+      Id    : LSP.Structures.Integer_Or_Virtual_String;
+      Value : LSP.Structures.DocumentFormattingParams);
+
    overriding
    procedure On_RangeFormatting_Request
      (Self  : in out Message_Handler;

source/server/lsp-text_documents-langkit_documents.adb

@@ -59,15 +59,15 @@ package body LSP.Text_Documents.Langkit_Documents is
       Line : constant Natural := To_LSP_Line (Index);
 
    begin
-      if Self.Line_Marker.Last_Index = Line then
+      if Self.Line_Markers.Last_Index = Line then
          return
            Self.Text.Slice
-             (Self.Line_Marker (Line), Self.Text.After_Last_Character);
+             (Self.Line_Markers (Line), Self.Text.After_Last_Character);
 
       else
          return
            Self.Text.Slice
-             (Self.Line_Marker (Line), Self.Line_Marker (Line + 1));
+             (Self.Line_Markers (Line), Self.Line_Markers (Line + 1));
       end if;
    end Line;
 
@@ -187,7 +187,7 @@ package body LSP.Text_Documents.Langkit_Documents is
       return Langkit_Support.Slocs.Source_Location
    is
       Iterator    : VSS.Strings.Character_Iterators.Character_Iterator :=
-        Self.Text.At_Character (Self.Line_Marker (Position.line));
+        Self.Text.At_Character (Self.Line_Markers (Position.line));
    begin
       return ((Line   => To_Source_Line (Position.line),
                Column => To_Source_Column (Iterator, Position.character)));