Merge branch 'topic/als.1729.more_fallback_cases' into 'master'

Add fallback indenter for onTypeFormatting on IndentOnly is False

See merge request eng/ide/ada_language_server!2157

Author: AdrienBoulanger

source/ada/lsp-ada_formatter.adb

@@ -219,23 +219,27 @@ package body LSP.Ada_Formatter is
         LSP.Ada_Handlers.Formatting.Get_Formatting_Options
           (Context.all, Value.options);
 
+      Prev_Line : constant Natural := Natural'Max (Value.position.line - 1, 0);
       Indent_Array :
         constant LSP.Formatters.Fallback_Indenter.Indentation_Array :=
           LSP.Ada_Handlers.Formatting.Get_Indentation
             (Filename => Context.URI_To_File (Document.URI),
              Buffer   =>
+               --  Add one more line because the fallback formatter ignore
+               --  the last EOL as EOF
                Document.Get_Text ((0, 0), (Value.position.line + 1, 0)),
              Span     =>
-               ((Value.position.line, 0), (Value.position.line + 1, 0)),
+               --  We possibly want to reindent the previous line
+               ((Prev_Line, 0), (Value.position.line, 0)),
              Options  => Full_Options);
       Indentation  : constant VSS.Strings.Character_Count :=
         (declare
            Indentation_First_Guess : constant VSS.Strings.Character_Count :=
-             ((if Indent_Array (Value.position.line + 1) = -1
+             ((if Indent_Array (Value.position.line) = -1
                then 0
                else
                  VSS.Strings.Character_Count
-                   (Indent_Array (Value.position.line + 1))));
+                   (Indent_Array (Value.position.line))));
          begin
            (if Indentation_First_Guess
               >= VSS.Strings.Character_Count (Value.position.character)
@@ -308,6 +312,20 @@ package body LSP.Ada_Formatter is
                    (Filename => Context.URI_To_File (Document.URI),
                     Options  => Full_Options,
                     S        => Indentation * ' ')));
+
+         --  If not in indent-only mode, re-indent the previous line too
+         if not Self.Parent.Context.Get_Configuration.Indent_Only
+           and then Value.position.line > 0
+           and then Indent_Array (Prev_Line) /= -1
+         then
+            Response.Append
+              (LSP.Ada_Handlers.Formatting.Reindent_Line
+                 (Filename   => Context.URI_To_File (Document.URI),
+                  Line       => Document.Get_Line (Prev_Line),
+                  Pos        => (Prev_Line, 0),
+                  Options    => Full_Options,
+                  New_Indent => Indent_Array (Prev_Line)));
+         end if;
       end Handle_Document_With_Diagnostics;
 
       -----------------------------------------

source/ada/lsp-ada_handlers-formatting.adb

@@ -215,7 +215,12 @@ package body LSP.Ada_Handlers.Formatting is
       Buffer : constant VSS.Strings.Virtual_String :=
         (if Span = Empty_Range
          then Document.Text
-         else Document.Slice (((0, 0), Actual_Span.an_end)));
+         else
+           Document.Slice
+             (((0, 0),
+               (Natural'Min (Document.Line_Count - 1,
+                Actual_Span.an_end.line + 1),
+                0))));
       --  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
@@ -230,22 +235,17 @@ package body LSP.Ada_Handlers.Formatting is
              Options  => Options);
       --  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");
       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);
-
             --  Generate a text edit to reindent the line.
             Response.Append
               (Reindent_Line
                  (Filename   => Filename,
-                  Line       => Document.Get_Line (Pos.line),
+                  Line       => Document.Get_Line (Line),
                   Options    => Options,
-                  Pos        => Pos,
+                  Pos        => (Line, 0),
                   New_Indent => Indent_Lines (Line)));
          end if;
       end loop;

source/ada/lsp-formatters-fallback_indenter.adb

@@ -911,11 +911,11 @@ package body LSP.Formatters.Fallback_Indenter is
 
    function Get_Indentation
      (Buffer          : String;
-      From, To        : Natural;
+      From, To        : Positive;
       Indent_Level    : Natural := 3;
       Indent_Continue : Natural := 2) return Indentation_Array
    is
-      Result : Indentation_Array (From .. To) := (others => -1);
+      Result : Indentation_Array (From - 1 .. To - 1) := (others => -1);
 
       ---------------
       -- Constants --
@@ -1189,9 +1189,9 @@ package body LSP.Formatters.Fallback_Indenter is
             Continuation_Val := 0;
          end if;
 
-         if Line_Count in Result'Range then
-            Result (Line_Count) := Indentation;
-            if Line_Count = Result'Last then
+         if Line_Count - 1 in Result'Range then
+            Result (Line_Count - 1) := Indentation;
+            if Line_Count - 1 = Result'Last then
                raise Finished;
             end if;
          end if;
@@ -2996,7 +2996,6 @@ package body LSP.Formatters.Fallback_Indenter is
                --  first line.
 
                if Ref_Indent = Num_Spaces
-                 and then To /= 0
                  and then L not in From .. To
                then
                   Ref_Indent := Integer'Max (P - Start_Of_Line, 0);

source/ada/lsp-formatters-fallback_indenter.ads

@@ -21,7 +21,7 @@ package LSP.Formatters.Fallback_Indenter is
 
    function Get_Indentation
      (Buffer          : String;
-      From, To        : Natural;
+      From, To        : Positive;
       Indent_Level    : Natural := 3;
       Indent_Continue : Natural := 2) return Indentation_Array;
    --  Return an array of indentation levels for each line in Buffer, from

source/gpr/lsp-gpr_handlers.adb

@@ -655,21 +655,22 @@ package body LSP.GPR_Handlers is
       Filename : constant GNATCOLL.VFS.Virtual_File :=
         Self.To_File (Value.textDocument.uri);
 
+      Prev_Line : constant Natural := Natural'Max (Value.position.line - 1, 0);
       Indent_Array :
         constant LSP.Formatters.Fallback_Indenter.Indentation_Array :=
           LSP.Ada_Handlers.Formatting.Get_Indentation
             (Filename => Filename,
              Buffer   =>
                Document.Slice (((0, 0), (Value.position.line + 1, 0))),
              Span     =>
-               ((0, 0), (Value.position.line + 1, 0)),
+               ((Prev_Line, 0), (Value.position.line, 0)),
              Options  => Options);
       Indentation  : constant VSS.Strings.Character_Count :=
-        (if Indent_Array (Value.position.line + 1) = -1
+        (if Indent_Array (Value.position.line) = -1
          then 0
          else
            VSS.Strings.Character_Count
-             (Indent_Array (Value.position.line + 1)));
+             (Indent_Array (Value.position.line)));
    begin
       --  First set the indentation for the new line
       Response.Append
@@ -683,23 +684,17 @@ package body LSP.GPR_Handlers is
                  S        => Indentation * ' ')));
 
       --  If not in indent-only mode, re-indent the previous line too
-      if not Self.Configuration.Indent_Only then
-         declare
-            Prev_Line             : constant Natural :=
-              Natural'Max (Value.position.line - 1, 0);
-            Indentation : constant Natural :=
-              (if Indent_Array (Prev_Line + 1) = -1
-               then 0
-               else Indent_Array (Prev_Line + 1));
-         begin
-            Response.Append
-              (LSP.Ada_Handlers.Formatting.Reindent_Line
-                 (Filename   => Filename,
-                  Line       => Document.Get_Line (Prev_Line),
-                  Pos        => (Prev_Line, 0),
-                  Options    => Options,
-                  New_Indent => Indentation));
-         end;
+      if not Self.Configuration.Indent_Only
+        and then Value.position.line > 0
+        and then Indent_Array (Prev_Line) /= -1
+      then
+         Response.Append
+           (LSP.Ada_Handlers.Formatting.Reindent_Line
+              (Filename   => Filename,
+               Line       => Document.Get_Line (Prev_Line),
+               Pos        => (Prev_Line, 0),
+               Options    => Options,
+               New_Indent => Indent_Array (Prev_Line)));
       end if;
 
       Self.Sender.On_OnTypeFormatting_Response (Id, Response);

testsuite/ada_lsp/onTypeFormatting/indentOnlyFalse_fallback/t.adb

@@ -0,0 +1,30 @@
+procedure T is
+   X   : Integer := 1;
+   YYY : Natural := 2;
+begin
+ if X = YYY or else X + X > YYY and then (X < YYY and then Y > 2) then
+      null;
+   end if;
+
+   for I in 1 .. X loop
+      if X > 2 then
+         Y := Y + 1;
+      end if;
+   end loop;
+
+  case X is
+      when X > 10          =>
+         null;
+
+      when X > 20          =>
+         null;
+
+      when X > 30 | Y > 10 =>
+         null;
+
+      when others          =>
+         null;
+   end case;
+
+   this_statement_is_missing_a_semicolon
+end T;

testsuite/ada_lsp/onTypeFormatting/indentOnlyFalse_fallback/test-loc.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<Locations>
+  <Project>
+    <vfs_file>/home/boulanger/adacore/ancr/src/als/testsuite/ada_lsp/onTypeFormatting/indentOnlyFalse_fallback/test.gpr</vfs_file>
+    <file_marker current="true" column=" 1" line=" 1" >
+      <vfs_project>/home/boulanger/adacore/ancr/src/als/testsuite/ada_lsp/onTypeFormatting/indentOnlyFalse_fallback/test.gpr</vfs_project>
+      <vfs_file>/home/boulanger/adacore/ancr/src/als/testsuite/ada_lsp/onTypeFormatting/indentOnlyFalse_fallback/t.adb</vfs_file>
+    </file_marker>
+  </Project>
+</Locations>

testsuite/ada_lsp/onTypeFormatting/indentOnlyFalse_fallback/test.gpr

@@ -0,0 +1,4 @@
+project Test is
+
+end Test;
+

testsuite/ada_lsp/onTypeFormatting/indentOnlyFalse_fallback/test.py

@@ -0,0 +1,109 @@
+"""Test the onTypeFormatting in format mode when there are diagnostics"""
+
+import os
+from drivers.pylsp import URI, ALSLanguageClient, OnTypeFormattingSetting, test
+from drivers.lsp_ada_requests import run_indentation_testcases, IndentationTestCase
+from lsprotocol.types import (
+    ClientCapabilities,
+    DocumentOnTypeFormattingOptions,
+    FormattingOptions,
+    InitializedParams,
+    InitializeParams,
+    Position,
+    Range,
+    TextEdit,
+)
+
+
+@test(initialize=False)
+async def test_on_type_formatting_indentation(lsp: ALSLanguageClient) -> None:
+    """
+    Test the onTypeFormatting feature of ALS.
+
+    This test verifies that ALS correctly estimates the indentation that should
+    be added after a line break.
+
+    Tests should be added to the indentation_tests list.
+    """
+
+    # Send the initialize request
+
+    response = await lsp.initialize_session(
+        InitializeParams(
+            capabilities=ClientCapabilities(),
+            root_uri=URI(os.getcwd()),
+        )
+    )
+
+    # Verify that the right capability is advertised
+
+    lsp.assertEqual(
+        response.capabilities.document_on_type_formatting_provider,
+        DocumentOnTypeFormattingOptions(
+            first_trigger_character="\n", more_trigger_character=None
+        ),
+    )
+
+    # Send the initialized notification and the didChangeConfiguration
+    # notification, configuring ALS to only indent when it receives an
+    # onTypeFormattingRequest
+
+    lsp.initialized(InitializedParams())
+
+    lsp.didChangeConfig({"onTypeFormatting": OnTypeFormattingSetting(indentOnly=False)})
+    await lsp.awaitIndexingEnd()
+
+    # Test list
+    indentation_tests = [
+        IndentationTestCase(
+            "Indentation after when",
+            "t.adb",
+            Position(15, 29),
+            "         ",
+            [TextEdit(Range(Position(15, 0), Position(15, 6)), "      ")],
+        ),
+        IndentationTestCase(
+            "Indentation after case",
+            "t.adb",
+            Position(14, 11),
+            "      ",
+            [TextEdit(Range(Position(14, 0), Position(14, 2)), "   ")],
+        ),
+        IndentationTestCase(
+            "Indentation after for+if/then",
+            "t.adb",
+            Position(9, 19),
+            "         ",
+            [TextEdit(Range(Position(9, 0), Position(9, 6)), "      ")],
+        ),
+        IndentationTestCase(
+            "Indentation after for",
+            "t.adb",
+            Position(8, 23),
+            "      ",
+            [TextEdit(Range(Position(8, 0), Position(8, 3)), "   ")],
+        ),
+        IndentationTestCase(
+            "Indentation after end if",
+            "t.adb",
+            Position(6, 10),
+            "   ",
+            [TextEdit(Range(Position(6, 0), Position(6, 3)), "   ")],
+        ),
+        IndentationTestCase(
+            "Indentation after if/then",
+            "t.adb",
+            Position(4, 70),
+            "      ",
+            [TextEdit(Range(Position(4, 0), Position(4, 1)), "   ")],
+        ),
+    ]
+
+    failed_tests = await run_indentation_testcases(
+        lsp, indentation_tests, FormattingOptions(tab_size=3, insert_spaces=True)
+    )
+
+    if len(failed_tests) > 0:
+        fail_messages = "\n\n".join(failed_tests)
+        message = f"Indentation tests failed\n\n{fail_messages}"
+        raise Exception(message)  # pylint: disable=broad-exception-raised

testsuite/ada_lsp/onTypeFormatting/indentOnlyFalse_fallback/test.yaml

@@ -0,0 +1 @@
+driver: pylsp