Merge branch 'topic/als.138.gnatformat_option' into 'edge'

AdrienBoulanger · AdrienBoulanger · commit d8d1ebde8437 · 2024-09-19T10:57:12.000Z
Add gnatformat preferences to FormatOptions

See merge request eng/ide/ada_language_server!1639
diff --git a/doc/metaModel.json b/doc/metaModel.json
@@ -9087,58 +9087,6 @@
 			],
 			"documentation": "Provider options for a [DocumentLinkRequest](#DocumentLinkRequest)."
 		},
-		{
-			"name": "FormattingOptions",
-			"properties": [
-				{
-					"name": "tabSize",
-					"type": {
-						"kind": "base",
-						"name": "uinteger"
-					},
-					"documentation": "Size of a tab in spaces."
-				},
-				{
-					"name": "insertSpaces",
-					"type": {
-						"kind": "base",
-						"name": "boolean"
-					},
-					"documentation": "Prefer spaces over tabs."
-				},
-				{
-					"name": "trimTrailingWhitespace",
-					"type": {
-						"kind": "base",
-						"name": "boolean"
-					},
-					"optional": true,
-					"documentation": "Trim trailing whitespace on a line.\n\n@since 3.15.0",
-					"since": "3.15.0"
-				},
-				{
-					"name": "insertFinalNewline",
-					"type": {
-						"kind": "base",
-						"name": "boolean"
-					},
-					"optional": true,
-					"documentation": "Insert a newline character at the end of the file if one does not exist.\n\n@since 3.15.0",
-					"since": "3.15.0"
-				},
-				{
-					"name": "trimFinalNewlines",
-					"type": {
-						"kind": "base",
-						"name": "boolean"
-					},
-					"optional": true,
-					"documentation": "Trim all newlines after the final newline at the end of the file.\n\n@since 3.15.0",
-					"since": "3.15.0"
-				}
-			],
-			"documentation": "Value-object describing what options formatting should use."
-		},
 		{
 			"name": "DocumentFormattingOptions",
 			"properties": [],
diff --git a/doc/metaModel.patch.json b/doc/metaModel.patch.json
@@ -132,6 +132,76 @@
       }
    ],
    "structures": [
+      {
+	 "name": "FormattingOptions",
+         "properties": [
+         {
+            "name": "tabSize",
+            "type": {
+               "kind": "base",
+               "name": "uinteger"
+            },
+            "documentation": "Size of a tab in spaces."
+	},
+	{
+            "name": "insertSpaces",
+            "type": {
+               "kind": "base",
+               "name": "boolean"
+            },
+            "documentation": "Prefer spaces over tabs."
+	},
+	{
+            "name": "trimTrailingWhitespace",
+            "type": {
+               "kind": "base",
+               "name": "boolean"
+            },
+            "optional": true,
+            "documentation": "Trim trailing whitespace on a line.\n\n@since 3.15.0",
+            "since": "3.15.0"
+	},
+	{
+            "name": "insertFinalNewline",
+            "type": {
+               "kind": "base",
+               "name": "boolean"
+            },
+            "optional": true,
+            "documentation": "Insert a newline character at the end of the file if one does not exist.\n\n@since 3.15.0",
+            "since": "3.15.0"
+         },
+         {
+            "name": "trimFinalNewlines",
+            "type": {
+               "kind": "base",
+               "name": "boolean"
+            },
+            "optional": true,
+            "documentation": "Trim all newlines after the final newline at the end of the file.\n\n@since 3.15.0",
+            "since": "3.15.0"
+         },
+         {
+            "name": "gnatFormatMaxSize",
+            "type": {
+               "kind": "base",
+               "name": "uinteger"
+            },
+            "optional": true,
+            "documentation": "Maximum line width for gnatformat"
+         },
+         {
+            "name": "gnatFormatContinuationLineIndent",
+            "type": {
+               "kind": "base",
+               "name": "uinteger"
+            },
+            "optional": true,
+            "documentation": "Continuation Line Indentation size (defaults to indentation-1) for gnatformat"
+         }
+         ],
+         "documentation": "Value-object describing what options formatting should use."
+      },
       {
          "name": "AlsCheckSyntaxParams",
          "properties": [
diff --git a/liblsp_3_16/source/generated/lsp-message_io.adb b/liblsp_3_16/source/generated/lsp-message_io.adb
@@ -7855,6 +7855,10 @@ package body LSP.Message_IO is
                Optional_Boolean'Read (S, V.insertFinalNewline);
             elsif Key = "trimFinalNewlines" then
                Optional_Boolean'Read (S, V.trimFinalNewlines);
+            elsif Key = "gnatFormatMaxSize" then
+               Optional_uinteger'Read (S, V.gnatFormatMaxSize);
+            elsif Key = "gnatFormatContinuationLineIndent" then
+               Optional_uinteger'Read (S, V.gnatFormatContinuationLineIndent);
             else
                JS.Skip_Value;
             end if;
@@ -7880,6 +7884,10 @@ package body LSP.Message_IO is
       Optional_Boolean'Write (S, V.insertFinalNewline);
       JS.Key ("trimFinalNewlines");
       Optional_Boolean'Write (S, V.trimFinalNewlines);
+      JS.Key ("gnatFormatMaxSize");
+      Optional_uinteger'Write (S, V.gnatFormatMaxSize);
+      JS.Key ("gnatFormatContinuationLineIndent");
+      Optional_uinteger'Write (S, V.gnatFormatContinuationLineIndent);
       JS.End_Object;
    end Write_FormattingOptions;
 
diff --git a/liblsp_3_16/source/lsp-messages.ads b/liblsp_3_16/source/lsp-messages.ads
@@ -8716,6 +8716,8 @@ package LSP.Messages is
       trimTrailingWhitespace: Optional_Boolean;
       insertFinalNewline: Optional_Boolean;
       trimFinalNewlines: Optional_Boolean;
+      gnatFormatMaxSize : Optional_uinteger;
+      gnatFormatContinuationLineIndent : Optional_uinteger;
       --  [key: string]: boolean | number | string; ???
    end record;
    procedure Read_FormattingOptions
diff --git a/liblsp_3_17/source/generated/lsp-inputs-part_19.adb b/liblsp_3_17/source/generated/lsp-inputs-part_19.adb
@@ -382,7 +382,9 @@ package body LSP.Inputs.Part_19 is
          "insertSpaces",
          "trimTrailingWhitespace",
          "insertFinalNewline",
-         "trimFinalNewlines"]);
+         "trimFinalNewlines",
+         "gnatFormatMaxSize",
+         "gnatFormatContinuationLineIndent"]);
 
    end FormattingOptions_Scope;
 
@@ -426,6 +428,20 @@ package body LSP.Inputs.Part_19 is
                      Value  => <>);
                   Value.trimFinalNewlines.Value := Handler.Boolean_Value;
                   Handler.Read_Next;
+               when 6 =>  --  gnatFormatMaxSize
+                  Value.gnatFormatMaxSize       :=
+                    (Is_Set => True,
+                     Value  => <>);
+                  Value.gnatFormatMaxSize.Value :=
+                    Integer (Handler.Number_Value.Integer_Value);
+                  Handler.Read_Next;
+               when 7 =>  --  gnatFormatContinuationLineIndent
+                  Value.gnatFormatContinuationLineIndent       :=
+                    (Is_Set => True,
+                     Value  => <>);
+                  Value.gnatFormatContinuationLineIndent.Value :=
+                    Integer (Handler.Number_Value.Integer_Value);
+                  Handler.Read_Next;
                when others =>
                   Handler.Skip_Current_Value;
             end case;
diff --git a/liblsp_3_17/source/generated/lsp-outputs.adb b/liblsp_3_17/source/generated/lsp-outputs.adb
@@ -7609,6 +7609,15 @@ package body LSP.Outputs is
          Handler.Key_Name ("trimFinalNewlines");
          Handler.Boolean_Value (Value.trimFinalNewlines.Value);
       end if;
+      if Value.gnatFormatMaxSize.Is_Set then
+         Handler.Key_Name ("gnatFormatMaxSize");
+         Handler.Integer_Value (Integer'Pos (Value.gnatFormatMaxSize.Value));
+      end if;
+      if Value.gnatFormatContinuationLineIndent.Is_Set then
+         Handler.Key_Name ("gnatFormatContinuationLineIndent");
+         Handler.Integer_Value
+           (Integer'Pos (Value.gnatFormatContinuationLineIndent.Value));
+      end if;
       Handler.End_Object;
    end Write_FormattingOptions;
 
diff --git a/liblsp_3_17/source/generated/lsp-structures.ads b/liblsp_3_17/source/generated/lsp-structures.ads
@@ -4884,6 +4884,13 @@ package LSP.Structures is
       --
       --  @since 3.15.0
 
+      gnatFormatMaxSize : Natural_Optional;
+      --  Maximum line width for gnatformat
+
+      gnatFormatContinuationLineIndent : Natural_Optional;
+      --  Continuation Line Indentation size (defaults to indentation-1) for
+      --  gnatformat
+
    end record;
    --  Value-object describing what options formatting should use.
 
diff --git a/source/ada/lsp-ada_documents.adb b/source/ada/lsp-ada_documents.adb
@@ -20,7 +20,7 @@ with Ada.Tags;
 with GNAT.Strings;
 with GNATCOLL.Traces;
 with GNATCOLL.VFS;
-
+with Gnatformat.Configuration;
 with Gnatformat.Formatting;
 
 with Langkit_Support.Symbols;
@@ -50,6 +50,7 @@ with LSP.Ada_Id_Iterators;
 with LSP.Enumerations;
 with LSP.Formatters.File_Names;
 with LSP.Formatters.Texts;
+with LSP.GNATFormat_Utils;
 with LSP.Predicates;
 with LSP.Structures.LSPAny_Vectors;
 with LSP.Utils;
@@ -1242,23 +1243,30 @@ package body LSP.Ada_Documents is
    function Range_Format
      (Self    : Document;
       Context : LSP.Ada_Contexts.Context;
-      Span    : LSP.Structures.A_Range)
+      Span    : LSP.Structures.A_Range;
+      Options : LSP.Structures.FormattingOptions)
       return LSP.Structures.TextEdit
    is
       use type LSP.Structures.A_Range;
+      use Gnatformat.Configuration;
 
+      Full_Options : Format_Options_Type := Context.Get_Format_Options;
    begin
       if Span = LSP.Text_Documents.Empty_Range then
          return (LSP.Constants.Empty, VSS.Strings.Empty_Virtual_String);
       end if;
 
+      --  Combine the project options with the ones from the request
+      Full_Options.Overwrite
+        (LSP.GNATFormat_Utils.Get_Format_Option (Options));
+
       declare
          Range_Formatted_Document :
            constant Gnatformat.Formatting.Formatted_Edits :=
              Gnatformat.Formatting.Range_Format
                (Self.Unit (Context),
                 Self.To_Source_Location_Range (Span),
-                Context.Get_Format_Options);
+                Full_Options);
 
       begin
          return
diff --git a/source/ada/lsp-ada_documents.ads b/source/ada/lsp-ada_documents.ads
@@ -196,7 +196,8 @@ package LSP.Ada_Documents is
    function Range_Format
      (Self    : Document;
       Context : LSP.Ada_Contexts.Context;
-      Span    : LSP.Structures.A_Range)
+      Span    : LSP.Structures.A_Range;
+      Options : LSP.Structures.FormattingOptions)
       return LSP.Structures.TextEdit;
    --  Format part of Self defined by Span with formatting options based on
    --  Context.
diff --git a/source/ada/lsp-ada_handlers-formatting.adb b/source/ada/lsp-ada_handlers-formatting.adb
@@ -187,7 +187,8 @@ package body LSP.Ada_Handlers.Formatting is
       begin
          Success := True;
          Response.Clear;
-         Response.Append (Document.Range_Format (Context, Span));
+         Response.Append
+           (Document.Range_Format (Context, Span, Options => Options));
 
       exception
          when E : others =>
diff --git a/source/ada/lsp-gnatformat_utils.adb b/source/ada/lsp-gnatformat_utils.adb
@@ -0,0 +1,56 @@
+------------------------------------------------------------------------------
+--                         Language Server Protocol                         --
+--                                                                          --
+--                     Copyright (C) 2024, AdaCore                          --
+--                                                                          --
+-- This is free software;  you can redistribute it  and/or modify it  under --
+-- terms of the  GNU General Public License as published  by the Free Soft- --
+-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
+-- sion.  This software is distributed in the hope  that it will be useful, --
+-- but WITHOUT ANY WARRANTY;  without even the implied warranty of MERCHAN- --
+-- TABILITY 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  distributed  with  this  software;   see  file --
+-- COPYING3.  If not, go to http://www.gnu.org/licenses for a complete copy --
+-- of the license.                                                          --
+------------------------------------------------------------------------------
+
+package body LSP.GNATFormat_Utils is
+
+   -----------------------
+   -- Get_Format_Option --
+   -----------------------
+
+   function Get_Format_Option
+     (Option : LSP.Structures.FormattingOptions)
+      return Standard.Gnatformat.Configuration.Format_Options_Type
+   is
+      use Gnatformat;
+      use Gnatformat.Configuration;
+      Format_Options_Builder : Format_Options_Builder_Type :=
+        Create_Format_Options_Builder;
+   begin
+
+      if Option.tabSize /= 0 then
+         --  FormattingOptions is not optional, however in case a client
+         --  forgot to set it try to be resilient.
+         Format_Options_Builder.With_Indentation
+           (Option.tabSize, Ada_Language);
+      end if;
+      Format_Options_Builder.With_Indentation_Kind
+        ((if Option.insertSpaces then Spaces else Tabs), Ada_Language);
+
+      if Option.gnatFormatMaxSize.Is_Set then
+         Format_Options_Builder.With_Width
+           (Option.gnatFormatMaxSize.Value, Ada_Language);
+      end if;
+
+      if Option.gnatFormatContinuationLineIndent.Is_Set then
+         Format_Options_Builder.With_Indentation_Continuation
+           (Option.gnatFormatContinuationLineIndent.Value, Ada_Language);
+      end if;
+
+      return Format_Options_Builder.Build;
+   end Get_Format_Option;
+
+end LSP.GNATFormat_Utils;
diff --git a/source/ada/lsp-gnatformat_utils.ads b/source/ada/lsp-gnatformat_utils.ads
@@ -0,0 +1,27 @@
+------------------------------------------------------------------------------
+--                         Language Server Protocol                         --
+--                                                                          --
+--                     Copyright (C) 2024, AdaCore                          --
+--                                                                          --
+-- This is free software;  you can redistribute it  and/or modify it  under --
+-- terms of the  GNU General Public License as published  by the Free Soft- --
+-- ware  Foundation;  either version 3,  or (at your option) any later ver- --
+-- sion.  This software is distributed in the hope  that it will be useful, --
+-- but WITHOUT ANY WARRANTY;  without even the implied warranty of MERCHAN- --
+-- TABILITY 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  distributed  with  this  software;   see  file --
+-- COPYING3.  If not, go to http://www.gnu.org/licenses for a complete copy --
+-- of the license.                                                          --
+------------------------------------------------------------------------------
+
+with LSP.Structures;
+with Gnatformat.Configuration;
+
+package LSP.GNATFormat_Utils is
+
+   function Get_Format_Option
+     (Option : LSP.Structures.FormattingOptions)
+      return Gnatformat.Configuration.Format_Options_Type;
+
+end LSP.GNATFormat_Utils;
diff --git a/testsuite/ada_lsp/gnatformat/range_format/test.json b/testsuite/ada_lsp/gnatformat/range_format/test.json
@@ -106,6 +106,13 @@
                      "line": 7,
                      "character": 1
                   }
+               },
+               "options": {
+                  "trimTrailingWhitespace": true,
+                  "insertSpaces": true,
+                  "tabSize": 3,
+                  "trimFinalNewlines": true,
+                  "insertFinalNewline": false
                }
             }
          },
