U415-027 Added support to resourceOperations client capability

File creations/deletions/renames are sent according to the capabilities
sent by the client in `workspace.workspaceEdit.resourceOperations`.
Added a test case where a top level declartion is renamed and file renames
are computed but not sent.

Author: joaopsazevedo

source/ada/lsp-ada_handlers-refactor_change_parameter_mode.adb

@@ -323,7 +323,8 @@ package body LSP.Ada_Handlers.Refactor_Change_Parameter_Mode is
       Edits := Changer.Refactor (Analysis_Units'Access);
 
       Workspace_Edits := LSP.Lal_Utils.To_Workspace_Edit
-        (Edits.Text_Edits,
+        (Edits,
+         Message_Handler.Resource_Operations,
          Message_Handler.Versioned_Documents,
          Message_Handler'Access);
 

source/ada/lsp-ada_handlers-refactor_move_parameter.adb

@@ -258,7 +258,8 @@ package body LSP.Ada_Handlers.Refactor_Move_Parameter is
       end if;
 
       Workspace_Edits := LSP.Lal_Utils.To_Workspace_Edit
-        (Edits.Text_Edits,
+        (Edits,
+         Message_Handler.Resource_Operations,
          Message_Handler.Versioned_Documents,
          Message_Handler'Access);
 

source/ada/lsp-ada_handlers-refactor_remove_parameter.adb

@@ -232,7 +232,8 @@ package body LSP.Ada_Handlers.Refactor_Remove_Parameter is
       Edits := Remover.Refactor (Analysis_Units'Access);
 
       Workspace_Edits := LSP.Lal_Utils.To_Workspace_Edit
-        (Edits.Text_Edits,
+        (Edits,
+         Message_Handler.Resource_Operations,
          Message_Handler.Versioned_Documents,
          Message_Handler'Access);
 

source/ada/lsp-ada_handlers-refactor_suppress_seperate.adb

@@ -180,6 +180,7 @@ package body LSP.Ada_Handlers.Refactor_Suppress_Seperate is
 
       Workspace_Edits := LSP.Lal_Utils.To_Workspace_Edit
         (Edits,
+         Message_Handler.Resource_Operations,
          Message_Handler.Versioned_Documents,
          Message_Handler'Access,
          True);

source/ada/lsp-ada_handlers.adb

@@ -760,6 +760,9 @@ package body LSP.Ada_Handlers is
         (Is_Set => True,
          Value => (Is_Boolean => True, Bool => True));
 
+      Self.Resource_Operations :=
+        Value.capabilities.workspace.workspaceEdit.resourceOperations;
+
       --  Client capability to support versioned document changes in
       --  `WorkspaceEdit`s.
       Self.Versioned_Documents :=
@@ -3269,7 +3272,7 @@ package body LSP.Ada_Handlers is
       --  All contexts were processed, and no rename problems were found
 
       Response.result := To_Workspace_Edit
-        (All_Edits, Self.Versioned_Documents, Self);
+        (All_Edits, Self.Resource_Operations, Self.Versioned_Documents, Self);
 
       return Response;
 

source/ada/lsp-ada_handlers.ads

@@ -40,6 +40,7 @@ with LSP.Server_Request_Handlers;
 with LSP.Server_Notification_Receivers;
 with LSP.Servers;
 with LSP.Types;
+with LSP.Messages;
 
 package LSP.Ada_Handlers is
 
@@ -221,6 +222,10 @@ private
       --  textDocument/documentSymbol handler. Actual value depends on
       --  client's capabilities.
 
+      Resource_Operations : LSP.Messages.Optional_ResourceOperationKindSet;
+      --  Client capabilities to support resource operations in
+      --  `WorkspaceEdit`s.
+
       Versioned_Documents : Boolean := False;
       --  Client capabilities to support versioned document changes in
       --  `WorkspaceEdit`s.

source/ada/lsp-lal_utils.adb

@@ -922,9 +922,11 @@ package body LSP.Lal_Utils is
 
    function To_Workspace_Edit
      (Edits               : Laltools.Refactor.Refactoring_Edits;
+      Resource_Operations : LSP.Messages.Optional_ResourceOperationKindSet :=
+        LSP.Messages.Optional_ResourceOperationKindSet'(Is_Set => False);
       Versioned_Documents : Boolean := False;
-      Document_Provider   : access LSP.Ada_Documents.Document_Provider'Class
-      := null;
+      Document_Provider   : access LSP.Ada_Documents.Document_Provider'Class :=
+        null;
       Rename              : Boolean := False)
       return LSP.Messages.WorkspaceEdit
    is
@@ -933,12 +935,27 @@ package body LSP.Lal_Utils is
       Text_Edits : LSP.Messages.TextEdit_Vector;
 
       use Laltools.Refactor;
+      use LSP.Messages;
 
       Text_Edits_Cursor     : Text_Edit_Ordered_Maps.Cursor
         := Edits.Text_Edits.First;
       File_Deletions_Cursor : Unbounded_String_Ordered_Sets.Cursor
         := Edits.File_Deletions.First;
 
+      Is_Create_Supported : constant Boolean :=
+        Resource_Operations.Is_Set
+        and then ResourceOperationKindSets.Contains
+          (ResourceOperationKindSets.Set (Resource_Operations.Value), create);
+      Is_Rename_Supported : constant Boolean :=
+        Resource_Operations.Is_Set
+        and then ResourceOperationKindSets.Contains
+          (ResourceOperationKindSets.Set (Resource_Operations.Value),
+           LSP.Messages.rename);
+      Is_Delete_Supported : constant Boolean :=
+        Resource_Operations.Is_Set
+        and then ResourceOperationKindSets.Contains
+          (ResourceOperationKindSets.Set (Resource_Operations.Value), delete);
+
    begin
       return WE : LSP.Messages.WorkspaceEdit do
          --  Text edits
@@ -953,9 +970,14 @@ package body LSP.Lal_Utils is
             File_URI := LSP.Types.File_To_URI
               (Text_Edit_Ordered_Maps.Key (Text_Edits_Cursor));
 
+            --  If `workspace.workspaceEdit.documentChanges` client capability
+            --  was true, then use `TextDocumentEdit[]` instead of
+            --  `TextEdit[]`.
+
             if Versioned_Documents then
                declare
                   Annotaded_Edits : LSP.Messages.AnnotatedTextEdit_Vector;
+
                begin
                   Annotaded_Edits.Reserve_Capacity (Text_Edits.Capacity);
                   for X of Text_Edits loop
@@ -979,31 +1001,50 @@ package body LSP.Lal_Utils is
             Text_Edit_Ordered_Maps.Next (Text_Edits_Cursor);
          end loop;
 
-         --  File creations
-         --  TODO
-
-         --  File deletions
-
-         if not Rename then
-            while Unbounded_String_Ordered_Sets.Has_Element
-              (File_Deletions_Cursor)
-            loop
+         --  Resource operations are only supported if
+         --  `workspace.workspaceEdit.documentChanges` is True since they
+         --  must be sent in the `documentChanges` field.
+         --  `workspace.workspaceEdit.resourceOperations` client capability
+         --  must be checked in order to know which kind of operations are
+         --  supported.
 
-               File_URI := LSP.Types.File_To_URI
-                 (Unbounded_String_Ordered_Sets.Element
-                    (File_Deletions_Cursor));
+         --  File creations
 
+         if Versioned_Documents and then Is_Create_Supported then
+            for File_Creation of Edits.File_Creations loop
                WE.documentChanges.Append
                  (LSP.Messages.Document_Change'(
-                  (Kind        => LSP.Messages.Delete_File,
-                   Delete_File => LSP.Messages.DeleteFile'(
-                     uri    => File_URI,
-                     others => <>
-                    ))));
+                  (Kind        => LSP.Messages.Create_File,
+                   Create_File => LSP.Messages.CreateFile'
+                     (uri    => LSP.Types.File_To_URI (File_Creation.Filepath),
+                      others => <>))));
 
-               Unbounded_String_Ordered_Sets.Next (File_Deletions_Cursor);
+               declare
+                  Annotaded_Edits : LSP.Messages.AnnotatedTextEdit_Vector;
+                  Content : constant LSP.Messages.AnnotatedTextEdit :=
+                    LSP.Messages.AnnotatedTextEdit'
+                      (span    => ((0, 0), (0, 0)),
+                       newText => To_LSP_String
+                         (Ada.Strings.Unbounded.
+                            To_String (File_Creation.Content)),
+                       others  => <>);
+
+               begin
+                  Annotaded_Edits.Append (Content);
+
+                  WE.documentChanges.Append
+                    (LSP.Messages.Document_Change'(
+                     (Kind               => LSP.Messages.Text_Document_Edit,
+                      Text_Document_Edit => LSP.Messages.TextDocumentEdit'
+                        (edits => Annotaded_Edits,
+                         others => <>))));
+               end;
             end loop;
-         else
+         end if;
+
+         --  File deletions
+
+         if Versioned_Documents and then Is_Delete_Supported then
             while Unbounded_String_Ordered_Sets.Has_Element
               (File_Deletions_Cursor)
             loop
@@ -1017,7 +1058,8 @@ package body LSP.Lal_Utils is
                   (Kind        => LSP.Messages.Rename_File,
                    Rename_File => LSP.Messages.RenameFile'
                      (oldUri       => File_URI,
-                      newUri       => File_URI & ".bak",
+                      newUri       =>
+                        (if Rename then File_URI & ".bak" else File_URI),
                       others => <>))));
 
                Unbounded_String_Ordered_Sets.Next (File_Deletions_Cursor);
@@ -1026,15 +1068,17 @@ package body LSP.Lal_Utils is
 
          --  File renames
 
-         for File_Rename of Edits.File_Renames loop
-            WE.documentChanges.Append
-              (LSP.Messages.Document_Change'(
-               (Kind        => LSP.Messages.Rename_File,
-                Rename_File => LSP.Messages.RenameFile'
-                  (oldUri => LSP.Types.File_To_URI (File_Rename.Filepath),
-                   newUri => LSP.Types.File_To_URI (File_Rename.New_Name),
-                   others => <>))));
-         end loop;
+         if Versioned_Documents and then Is_Rename_Supported then
+            for File_Rename of Edits.File_Renames loop
+               WE.documentChanges.Append
+                 (LSP.Messages.Document_Change'(
+                  (Kind        => LSP.Messages.Rename_File,
+                   Rename_File => LSP.Messages.RenameFile'
+                     (oldUri => LSP.Types.File_To_URI (File_Rename.Filepath),
+                      newUri => LSP.Types.File_To_URI (File_Rename.New_Name),
+                      others => <>))));
+            end loop;
+         end if;
       end return;
    end To_Workspace_Edit;
 

source/ada/lsp-lal_utils.ads

@@ -140,9 +140,11 @@ package LSP.Lal_Utils is
 
    function To_Workspace_Edit
      (Edits               : Laltools.Refactor.Refactoring_Edits;
+      Resource_Operations : LSP.Messages.Optional_ResourceOperationKindSet :=
+        LSP.Messages.Optional_ResourceOperationKindSet'(Is_Set => False);
       Versioned_Documents : Boolean := False;
-      Document_Provider   : access LSP.Ada_Documents.Document_Provider'Class
-      := null;
+      Document_Provider   : access LSP.Ada_Documents.Document_Provider'Class :=
+        null;
       Rename              : Boolean := False)
       return LSP.Messages.WorkspaceEdit;
    --  Converts a Refactoring_Edits into a WorkspaceEdit. The Rename flag