Merge branch 'topic/als.1713.fallback_indenter' into 'master'

Add fallback indenter and do some cleanup

See merge request eng/ide/ada_language_server!2116

Author: AnthonyLeonardoGracio

doc/settings.md

@@ -121,6 +121,7 @@ Settings understood by the Ada Language Server itself, independently from the LS
 * [followSymlinks](#followsymlinks)
 * [documentationStyle](#documentationstyle)
 * [onTypeFormatting.indentOnly](#ontypeformattingindentonly)
+* [rangeFormattingFallback](#rangeFormattingFallback)
 * [useGnatformat](#usegnatformat)
 
 ----
@@ -418,11 +419,16 @@ Conversely, in VS Code this settings can be set without nesting:
 }
 ```
 
+### rangeFormattingFallback
+
+This option controls if the `textDocument/rangeFormatting` request should fallback to another
+indenter in case the code is not syntactically correct. If disabled, `textDocument/rangeFormatting`
+will return an error if the code is not syntactically correct.
+
 ### useGnatformat
 
-This option controls the formatting provider for the `textDocument/formatting`,
-`textDocument/rangeFormatting` and `textDocument/onTypeFormatting` request. By default, this option
-is enabled and ALS uses GNATformat as its formatting provider. If disabled, GNATpp is used instead.
+GNATpp has been removed as a provider for formatting requests. GNATformat is now enabled by default
+and this settings is now obsolete.
 
 ### logThreshold
 
@@ -434,4 +440,3 @@ See the documentation on [ALS Traces](traces.md) for more information.
 ### enableExperimentalFeatures
 
 This option enable the use of experimental features which are still under development.
-

integration/vscode/ada/package.json

@@ -371,6 +371,26 @@
                         ],
                         "default": null,
                         "markdownDescription": "If the VS Code `editor.formatOnType` setting is enabled, the Ada Language Server will format Ada code while it is being typed in the editor, in particular when a new line is typed.\n\nThis setting controls whether formatting should only perform the indentation of the new line (true) or also format the previous line (false).\n\nIf not set in VS Code, this setting takes its value from the [`.als.json`](https://github.com/AdaCore/ada_language_server/blob/master/doc/settings.md) file at the root of the workspace, if that file exists. Otherwise it defaults to `true`."
+                    },
+                    "ada.rangeFormattingFallback": {
+                        "scope": "window",
+                        "enum": [
+                            true,
+                            false,
+                            null
+                        ],
+                        "enumItemLabels": [
+                            null,
+                            null,
+                            "Provided by .als.json (default: true)"
+                        ],
+                        "markdownEnumDescriptions": [
+                            "true",
+                            "false",
+                            "Provided by [`.als.json`](https://github.com/AdaCore/ada_language_server/blob/master/doc/settings.md) if it exists at the workspace root, otherwise defaults to `true`."
+                        ],
+                        "default": null,
+                        "markdownDescription": "Enable fallback indenter in case the file is not syntactically correct.\n\nIf not set in VS Code, this setting takes its value from the [`.als.json`](https://github.com/AdaCore/ada_language_server/blob/master/doc/settings.md) file at the root of the workspace, if that file exists. Otherwise it defaults to `true`."
                     }
                 }
             },

integration/vscode/ada/schemas/als-settings-schema.json

@@ -53,6 +53,11 @@
             "default": true,
             "markdownDescription": "Enable GNATformat as the formatting provider for Ada source files."
         },
+        "rangeFormattingFallback": {
+            "type": "boolean",
+            "default": true,
+            "markdownDescription": "Enable fallback indenter in case the file is not syntactically correct."
+        },
         "onTypeFormatting": {
             "type": "object",
             "properties": {

source/ada/lsp-ada_configurations.adb

@@ -57,13 +57,6 @@ package body LSP.Ada_Configurations is
        ("ALS.COMPLETION.FORMATTING", Default => GNATCOLL.Traces.On);
    --  Used in Completion_Formatting/LSP.Ada_Completions.Pretty_Print_Snippet
 
-   Partial_Gnatpp_Trace : constant GNATCOLL.Traces.Trace_Handle :=
-     GNATCOLL.Traces.Create
-       (Unit_Name => "ALS.PARTIAL_GNATPP",
-        Default   => GNATCOLL.Traces.On);
-   --  Trace to enable/disable using partial Gnatpp in the rangeFormatting
-   --  request.
-
    On_Type_Formatting_Trace : constant GNATCOLL.Traces.Trace_Handle :=
      GNATCOLL.Traces.Create
        (Unit_Name => "ALS.ON_TYPE_FORMATTING",
@@ -433,6 +426,12 @@ package body LSP.Ada_Configurations is
 
                end if;
 
+            elsif Check_Variable
+               (Name, JSON (Index).Kind, "rangeFormattingFallback",
+                Boolean_Value)
+            then
+               Self.Range_Formatting_Fallback := JSON (Index).Boolean_Value;
+
             elsif Check_Variable
               (Name, JSON (Index).Kind, "useGnatformat", Boolean_Value)
             then
@@ -475,15 +474,6 @@ package body LSP.Ada_Configurations is
       end loop;
    end Parse_Ada;
 
-   --------------------
-   -- Partial_GNATPP --
-   --------------------
-
-   function Partial_GNATPP return Boolean is
-   begin
-      return Partial_Gnatpp_Trace.Is_Active;
-   end Partial_GNATPP;
-
    ---------------
    -- Read_File --
    ---------------

source/ada/lsp-ada_configurations.ads

@@ -131,6 +131,10 @@ package LSP.Ada_Configurations is
 
    function Indent_Only (Self : Configuration'Class) return Boolean;
 
+   function Range_Formatting_Fallback
+     (Self : Configuration'Class) return Boolean;
+   --  Whether the fallback indenter is enabled for rangeFormatting
+
    function Follow_Symlinks (Self : Configuration'Class) return Boolean;
    --  False if the client disables symlink following. In this case
    --  URIs from client should match file names reported by LAL and
@@ -155,9 +159,6 @@ package LSP.Ada_Configurations is
    function Completion_Formatting return Boolean;
    --  Used in LSP.Ada_Completions.Pretty_Print_Snippet
 
-   function Partial_GNATPP return Boolean;
-   --  Whether partial GNATPP is enabled.
-
    function On_Type_Formatting return Boolean;
    --  Whether onTypeFormatting is enabled.
 
@@ -187,6 +188,7 @@ private
       Use_Completion_Snippets         : Boolean := True;
       Use_Gnatformat                  : Boolean := True;
       Indent_Only                     : Boolean := True;
+      Range_Formatting_Fallback       : Boolean := False;
       Follow_Symlinks                 : Boolean := True;
       Insert_With_Clauses             : Boolean := True;
 
@@ -281,6 +283,10 @@ private
    function Indent_Only (Self : Configuration'Class) return Boolean is
      (Self.Indent_Only);
 
+   function Range_Formatting_Fallback
+     (Self : Configuration'Class) return Boolean is
+      (Self.Range_Formatting_Fallback);
+
    function Documentation_Style (Self : Configuration'Class)
      return GNATdoc.Comments.Options.Documentation_Style is
        (Self.Documentation_Style);

source/ada/lsp-ada_contexts.adb

@@ -17,8 +17,6 @@
 
 with Ada.Characters.Handling;     use Ada.Characters.Handling;
 
-with GNAT.Strings;
-
 with GNATCOLL.Traces;             use GNATCOLL.Traces;
 with GNATCOLL.VFS;                use GNATCOLL.VFS;
 
@@ -36,14 +34,10 @@ with VSS.Strings.Conversions;
 with Libadalang.Common;           use Libadalang.Common;
 with Langkit_Support.Slocs;
 
-with Utils.Command_Lines.Common;
-
-with Pp.Actions;
 with Langkit_Support.Text;
 
 with URIs;
 with LSP.Ada_Id_Iterators;
-with LSP.Ada_Projects;
 
 package body LSP.Ada_Contexts is
 
@@ -582,8 +576,6 @@ package body LSP.Ada_Contexts is
    is
       procedure Update_Source_Files;
       --  Update the value of Self.Source_Files
-      procedure Pretty_Printer_Setup;
-      --  Setup PP_Options object
 
       -------------------------
       -- Update_Source_Files --
@@ -709,66 +701,6 @@ package body LSP.Ada_Contexts is
          end loop;
       end Update_Source_Files;
 
-      --------------------------
-      -- Pretty_Printer_Setup --
-      --------------------------
-
-      procedure Pretty_Printer_Setup is
-         Validated : GNAT.Strings.String_List_Access;
-         Index     : Integer := 0;
-         Attribute : GPR2.Project.Attribute.Object;
-         Values    : GPR2.Containers.Value_List;
-
-      begin
-
-         --  Initialize an gnatpp command line object
-
-         if Provider.Projects.First_Element.Check_Attribute
-           (Name   => LSP.Ada_Projects.Pretty_Printer.Switches,
-            Index  => LSP.Ada_Projects.Pretty_Printer.Ada_Index,
-            Result => Attribute)
-         then
-
-            --  Fill 'Values' with non empty value
-
-            for Value of Attribute.Values loop
-               declare
-                  Text : constant String := Value.Text;
-               begin
-                  if Text /= "" then
-                     Values.Append (Text);
-                     Index := Index + 1;
-                  end if;
-               end;
-            end loop;
-
-            Validated := new GNAT.Strings.String_List (1 .. Index);
-
-            if Index > 0 then
-               Index := Validated'First;
-               for Text of Values loop
-                  Validated (Index) := new String'(Text);
-                  Index := Index + 1;
-               end loop;
-            end if;
-         else
-            Validated := new GNAT.Strings.String_List (1 .. 0);
-         end if;
-
-         Utils.Command_Lines.Parse
-           (Validated,
-            Self.PP_Options,
-            Phase              => Utils.Command_Lines.Cmd_Line_1,
-            Callback           => null,
-            Collect_File_Names => False,
-            Ignore_Errors      => True);
-
-         GNAT.Strings.Free (Validated);
-
-         --  Set UTF-8 encoding
-         Utils.Command_Lines.Common.Set_WCEM (Self.PP_Options, "8");
-      end Pretty_Printer_Setup;
-
    begin
       --  Use the full path for the ID to avoid conflict when project are
       --  sharing the same name. For example for GNATTest stubs.
@@ -786,7 +718,6 @@ package body LSP.Ada_Contexts is
       Self.Reload;
       Update_Source_Files;
 
-      Pretty_Printer_Setup;
       --  Choose the first project in case of aggregate context, assuming
       --  they all share the gnatformat options.
       Self.Format_Options :=
@@ -818,9 +749,6 @@ package body LSP.Ada_Contexts is
       Self.Source_Files.Clear;
       Self.Source_Dirs.Clear;
       Self.Tree := GPR2.Project.Tree.Undefined;
-
-      --  Cleanup gnatpp's template tables
-      Pp.Actions.Clear_Template_Tables;
    end Free;
 
    --------

source/ada/lsp-ada_contexts.ads

@@ -35,9 +35,6 @@ with Libadalang.Analysis;
 with Libadalang.Common;
 with Libadalang.Project_Provider;
 
-with Utils.Command_Lines;
-with Pp.Command_Lines;
-
 with VSS.String_Vectors;
 with VSS.Strings;
 
@@ -190,13 +187,12 @@ package LSP.Ada_Contexts is
    function File_Count (Self : Context) return Natural;
    --  Return number of files known to this context.
 
-   function Get_PP_Options
-     (Self : Context) return Utils.Command_Lines.Command_Line;
-   --  Return the command line for the Pretty Printer
-
    function Get_Format_Options
      (Self : Context) return Gnatformat.Configuration.Format_Options_Type;
-   --  Return the formatting options for Gnatformat
+   --  Return the project formatting options for Gnatformat.
+   --  This function should not be called directly most of the time because
+   --  it doesn't take in consideration the request options. Please use
+   --  LSP.Ada_Handlers.Formatting.Get_Formatting_Options
 
    function Get_Documentation_Style
      (Self : Context) return GNATdoc.Comments.Options.Documentation_Style;
@@ -364,10 +360,6 @@ private
       Extension_Set : LSP.Ada_File_Sets.Extension_Sets.Set;
       --  All the ada extensions valid for the current project
 
-      PP_Options : Utils.Command_Lines.Command_Line
-                    (Pp.Command_Lines.Descriptor'Access);
-      --  Object to keep gnatpp options
-
       Format_Options : Gnatformat.Configuration.Format_Options_Type;
 
       Style : GNATdoc.Comments.Options.Documentation_Style :=
@@ -396,9 +388,6 @@ private
    function File_Count (Self : Context) return Natural
    is (Self.Source_Files.Length);
 
-   function Get_PP_Options (Self : Context) return
-     Utils.Command_Lines.Command_Line is (Self.PP_Options);
-
    function Get_Format_Options
      (Self : Context)
       return Gnatformat.Configuration.Format_Options_Type