Merge branch 'topic/lalrefactor_issue8' into 'master'

Update to new LAL Refactor Auto Import API

See merge request eng/ide/ada_language_server!1421

Author: joaopsazevedo

.gitlab-ci.yml

@@ -39,7 +39,7 @@ build_and_test:
     - !reference [.basic-setup]
 
     - echo -e "\e[0Ksection_start:`date +%s`:build_als[collapsed=true]\r\e[0Kanod build als"
-    - anod build als $ACI_TRACK_QUALIFIER --minimal
+    - anod build als $ACI_TRACK_QUALIFIER
     - echo -e "\e[0Ksection_end:`date +%s`:build_als\r\e[0K"
 
     - echo -e "\e[0Ksection_start:`date +%s`:build_vscode[collapsed=true]\r\e[0Kanod build vscode-extension"
@@ -51,7 +51,7 @@ build_and_test:
 
     - echo -e "\e[0Ksection_start:`date +%s`:test_als[collapsed=true]\r\e[0Kanod test als"
     # Run ALS tests
-    - anod test als $ACI_TRACK_QUALIFIER --minimal
+    - anod test als $ACI_TRACK_QUALIFIER
 
     # TODO: it would be nice to have a simpler way of getting this info
     - ALS_BUILD_SPACE_NAME=`anod eval als --primitive test build_space_name $ACI_TRACK_QUALIFIER | tr -d "'"`

source/ada/lsp-ada_driver.adb

@@ -51,7 +51,7 @@ with LSP.Ada_Handlers.Refactor.Change_Parameter_Mode;
 with LSP.Ada_Handlers.Refactor.Change_Parameters_Default_Value;
 with LSP.Ada_Handlers.Refactor.Change_Parameters_Type;
 with LSP.Ada_Handlers.Refactor.Extract_Subprogram;
-with LSP.Ada_Handlers.Refactor.Imports_Commands;
+with LSP.Ada_Handlers.Refactor.Auto_Import;
 with LSP.Ada_Handlers.Refactor.Introduce_Parameter;
 with LSP.Ada_Handlers.Refactor.Move_Parameter;
 with LSP.Ada_Handlers.Refactor.Pull_Up_Declaration;
@@ -109,7 +109,7 @@ procedure LSP.Ada_Driver is
       LSP.Ada_Commands.Register
         (LSP.Ada_Handlers.Named_Parameters_Commands.Command'Tag);
       LSP.Ada_Commands.Register
-        (LSP.Ada_Handlers.Refactor.Imports_Commands.Command'Tag);
+        (LSP.Ada_Handlers.Refactor.Auto_Import.Command'Tag);
       LSP.Ada_Commands.Register
         (LSP.Ada_Handlers.Refactor.Suppress_Seperate.Command'Tag);
       LSP.Ada_Commands.Register

source/ada/lsp-ada_handlers-refactor-imports_commands.adb renamed to source/ada/lsp-ada_handlers-refactor-auto_import.adb

@@ -15,22 +15,19 @@
 -- of the license.                                                          --
 ------------------------------------------------------------------------------
 
-with Ada.Strings.Unbounded;
 with Ada.Strings.Wide_Wide_Unbounded;
 
 with Langkit_Support.Text;
 
 with Libadalang.Analysis;
-with Libadalang.Common;
-
-with Laltools.Common;
 
 with VSS.JSON.Streams;
+with VSS.Strings.Conversions;
 
 with LSP.Enumerations;
 with LSP.Structures.LSPAny_Vectors; use LSP.Structures.LSPAny_Vectors;
 
-package body LSP.Ada_Handlers.Refactor.Imports_Commands is
+package body LSP.Ada_Handlers.Refactor.Auto_Import is
 
    ----------------
    -- Initialize --
@@ -45,8 +42,11 @@ package body LSP.Ada_Handlers.Refactor.Imports_Commands is
    begin
       Self.Context     := Context.Id;
       Self.Where       := Where;
-      Self.With_Clause := With_Clause;
-      Self.Prefix      := Prefix;
+      Self.Suggestion :=
+        (Import    =>
+           VSS.Strings.Conversions.To_Unbounded_Wide_Wide_String (With_Clause),
+         Qualifier =>
+           VSS.Strings.Conversions.To_Unbounded_Wide_Wide_String (Prefix));
    end Initialize;
 
    ------------
@@ -84,11 +84,15 @@ package body LSP.Ada_Handlers.Refactor.Imports_Commands is
                elsif Key = "where" then
                   Self.Where := From_Any (C);
 
-               elsif Key = "with_clause" then
-                  Self.With_Clause := Element (C).String_Value;
+               elsif Key = "import" then
+                  Self.Suggestion.Import :=
+                    VSS.Strings.Conversions.To_Unbounded_Wide_Wide_String
+                      (From_Any (C));
 
-               elsif Key = "prefix" then
-                  Self.Prefix := Element (C).String_Value;
+               elsif Key = "qualifier" then
+                  Self.Suggestion.Qualifier :=
+                    VSS.Strings.Conversions.To_Unbounded_Wide_Wide_String
+                      (From_Any (C));
 
                else
                   Skip_Value (C);
@@ -105,16 +109,16 @@ package body LSP.Ada_Handlers.Refactor.Imports_Commands is
    -------------------------------------
 
    procedure Append_Suggestion
-     (Self              : in out Command;
-      Context           : LSP.Ada_Context_Sets.Context_Access;
-      Where             : LSP.Structures.Location;
-      Commands_Vector   : in out LSP.Structures.Command_Or_CodeAction_Vector;
-      Suggestion        : LAL_Refactor.Refactor_Imports.Import_Suggestion)
+     (Self            : in out Command;
+      Context         : LSP.Ada_Context_Sets.Context_Access;
+      Where           : LSP.Structures.Location;
+      Commands_Vector : in out LSP.Structures.Command_Or_CodeAction_Vector;
+      Suggestion      : LAL_Refactor.Auto_Import.Import_Type)
    is
       Item    : LSP.Structures.CodeAction;
 
       function Create_Suggestion_Title
-        (Suggestion : LAL_Refactor.Refactor_Imports.Import_Suggestion)
+        (Suggestion : LAL_Refactor.Auto_Import.Import_Type)
          return VSS.Strings.Virtual_String;
       --  Creates the suggestion text that will be shown by the client to
       --  to the developer. The text is costumized based on the need of
@@ -125,39 +129,17 @@ package body LSP.Ada_Handlers.Refactor.Imports_Commands is
       ------------------------------
 
       function Create_Suggestion_Title
-        (Suggestion : LAL_Refactor.Refactor_Imports.Import_Suggestion)
+        (Suggestion : LAL_Refactor.Auto_Import.Import_Type)
          return VSS.Strings.Virtual_String
       is
-         Title : Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String :=
-             Ada.Strings.Wide_Wide_Unbounded.Null_Unbounded_Wide_Wide_String;
-         use type Ada.Strings.Wide_Wide_Unbounded.Unbounded_Wide_Wide_String;
+         use Ada.Strings.Wide_Wide_Unbounded;
 
+         Title : constant Langkit_Support.Text.Unbounded_Text_Type :=
+           "Qualify with " & Suggestion.Qualifier;
       begin
-         if Suggestion.With_Clause_Text /= "" then
-            if Suggestion.Prefix_Text /= "" then
-               --  Add with clause and prefix
-               Title :=
-                 Title
-                 & "Add 'with' clause for "
-                 & Suggestion.With_Clause_Text
-                 & " and prefix the object with "
-                 & Suggestion.Prefix_Text;
-
-            else
-               --  Add with clause and leave the prefix as it is
-               Title :=
-                 Title
-                 & "Add 'with' clause for "
-                 & Suggestion.With_Clause_Text;
-            end if;
-         else
-            --  Only add prefix
-
-            Title := Title & "Prefix the object with "
-              & Suggestion.Prefix_Text;
-         end if;
-         return VSS.Strings.To_Virtual_String
-           (Langkit_Support.Text.To_Text (Title));
+         return
+           VSS.Strings.To_Virtual_String
+             (Langkit_Support.Text.To_Text (Title));
       end Create_Suggestion_Title;
 
    begin
@@ -167,15 +149,15 @@ package body LSP.Ada_Handlers.Refactor.Imports_Commands is
                          Where.a_range.start),
          With_Clause =>
            VSS.Strings.Conversions.To_Virtual_String
-             (Suggestion.With_Clause_Text),
+             (Suggestion.Import),
          Prefix      =>
            VSS.Strings.Conversions.To_Virtual_String
-             (Suggestion.Prefix_Text));
+             (Suggestion.Qualifier));
 
       Item :=
         (title       => Create_Suggestion_Title (Suggestion),
          kind        => (Is_Set => True,
-                         Value  => LSP.Enumerations.RefactorRewrite),
+                         Value  => LSP.Enumerations.QuickFix),
          diagnostics => <>,
          disabled    => (Is_Set => False),
          edit        => (Is_Set => False),
@@ -203,119 +185,21 @@ package body LSP.Ada_Handlers.Refactor.Imports_Commands is
       Document : LSP.Ada_Documents.Document_Access)
       return LAL_Refactor.Refactoring_Edits
    is
-      use Langkit_Support.Text;
       use Libadalang.Analysis;
-      use Libadalang.Common;
-      use Libadalang.Slocs;
-      use LAL_Refactor;
-      use VSS.Strings;
-      use VSS.Strings.Conversions;
+      use LAL_Refactor.Auto_Import;
 
-      Node : Ada_Node :=
-        Document.Get_Node_At (Context, Self.Where.position);
+      Name : constant Libadalang.Analysis.Name :=
+        Document.Get_Node_At (Context, Self.Where.position).As_Name;
 
-      Edits :  LAL_Refactor.Refactoring_Edits;
+      function Units return Analysis_Unit_Array is ([]);
 
    begin
-      --  Add prefix
-
-      if not Self.Prefix.Is_Empty
-        and then Node.Kind in Ada_Identifier
-      then
-         --  If this is a DottedName them remove the current prefix and replace
-         --  it by the suggested one. Otherwise, just add the prepend the
-         --  prefix
-
-         while Node.Parent.Kind in Ada_Dotted_Name_Range loop
-            Node := Node.Parent;
-         end loop;
+      return
+        Create_Auto_Importer
+          (Name,
+           Self.Suggestion)
+          .Refactor (Units'Access);
 
-         if Node.Kind in Ada_Dotted_Name_Range then
-            Node := Node.As_Dotted_Name.F_Suffix.As_Ada_Node;
-         end if;
-
-         if Node.Parent.Kind = Ada_Dotted_Name then
-            --  Node.Parent is the full Dotted Name: this includes the
-            --  current prefixes and the identifier. Using this SLOC instead
-            --  of only the current prefixes SLOC is better since this covers
-            --  cases when the Dotted Name is splitted in multiple lines.
-
-            Safe_Insert
-              (Edits     => Edits.Text_Edits,
-               File_Name => Node.Unit.Get_Filename,
-               Edit      =>
-                 Text_Edit'
-                   (Location =>
-                      Make_Range
-                        (Start_Sloc
-                           (Node.Parent.As_Dotted_Name.F_Prefix.Sloc_Range),
-                         Start_Sloc (Node.Sloc_Range)),
-                    Text     =>
-                      Ada.Strings.Unbounded.To_Unbounded_String
-                        (To_UTF8 (To_Wide_Wide_String (Self.Prefix)))));
-
-         else
-            Safe_Insert
-              (Edits     => Edits.Text_Edits,
-               File_Name => Node.Unit.Get_Filename,
-               Edit      =>
-                 Text_Edit'
-                   (Location =>
-                      Make_Range
-                        (Start_Sloc (Node.Sloc_Range),
-                         Start_Sloc (Node.Sloc_Range)),
-                    Text     =>
-                      Ada.Strings.Unbounded.To_Unbounded_String
-                        (To_UTF8 (To_Wide_Wide_String (Self.Prefix)))));
-         end if;
-      end if;
-
-      --  Add with clause
-
-      if not Self.With_Clause.Is_Empty then
-         declare
-            Last : Boolean;
-            S    : constant Libadalang.Slocs.Source_Location :=
-              Laltools.Common.Get_Insert_With_Location
-                (Node      => Laltools.Common.Get_Compilation_Unit (Node),
-                 Pack_Name =>
-                   VSS.Strings.Conversions.To_Wide_Wide_String
-                     (Self.With_Clause),
-                 Last      => Last);
-         begin
-            if S /= Libadalang.Slocs.No_Source_Location then
-               if Last then
-                  Safe_Insert
-                    (Edits     => Edits.Text_Edits,
-                     File_Name => Node.Unit.Get_Filename,
-                     Edit      =>
-                       Text_Edit'
-                         (Location => Make_Range (S, S),
-                          Text     =>
-                            Ada.Strings.Unbounded.To_Unbounded_String
-                              (To_UTF8 (To_Wide_Wide_String
-                               (Document.Line_Terminator
-                               & "with " & Self.With_Clause & ";")))));
-
-               else
-                  Safe_Insert
-                    (Edits     => Edits.Text_Edits,
-                     File_Name => Node.Unit.Get_Filename,
-                     Edit      =>
-                       Text_Edit'
-                         (Location => Make_Range (S, S),
-                          Text     =>
-                            Ada.Strings.Unbounded.To_Unbounded_String
-                              (To_UTF8 (To_Wide_Wide_String
-                               ("with " & Self.With_Clause & ";"
-                                  & Document.Line_Terminator)))));
-               end if;
-
-            end if;
-         end;
-      end if;
-
-      return Edits;
    end Command_To_Refactoring_Edits;
 
    --------------
@@ -351,6 +235,7 @@ package body LSP.Ada_Handlers.Refactor.Imports_Commands is
       use VSS.JSON.Streams;
 
       Result : LSP.Structures.LSPAny_Vector;
+
    begin
       Result.Append (JSON_Stream_Element'(Kind => Start_Array));
       Result.Append (JSON_Stream_Element'(Kind => Start_Object));
@@ -363,18 +248,22 @@ package body LSP.Ada_Handlers.Refactor.Imports_Commands is
       Add_Key ("where", Result);
       To_Any (Self.Where, Result);
 
-      --  "with_clause"
-      Add_Key ("with_clause", Result);
-      To_Any (Self.With_Clause, Result);
+      --  "import"
+      Add_Key ("import", Result);
+      To_Any
+        (VSS.Strings.Conversions.To_Virtual_String (Self.Suggestion.Import),
+         Result);
 
-      --  "prefix"
-      Add_Key ("prefix", Result);
-      To_Any (Self.Prefix, Result);
+      --  "qualifier"
+      Add_Key ("qualifier", Result);
+      To_Any
+        (VSS.Strings.Conversions.To_Virtual_String (Self.Suggestion.Qualifier),
+         Result);
 
       Result.Append (JSON_Stream_Element'(Kind => End_Object));
       Result.Append (JSON_Stream_Element'(Kind => End_Array));
 
       return Result;
    end Write_Command;
 
-end LSP.Ada_Handlers.Refactor.Imports_Commands;
+end LSP.Ada_Handlers.Refactor.Auto_Import;