Merge branch 'mr/1583-fix-extending-nav' into 'master'

Fix the navigation / find all refs in extending projects

Closes #1583

See merge request eng/ide/ada_language_server!1889

Author: setton

CHANGELOG.md

@@ -8,6 +8,7 @@ section below it for the last release. -->
 * Fix the reporting of test results in the Testing view when the test tree is not expanded
 * Fix sluggish completion while editing GPR files
 * Provide a task `ada: Build GNATtest test harness project` allowing to customize the build step of test execution in `tasks.json`
+* Fix cross-references (navigation, call hierarchy, finding all references) when the project is an Extending project.
 
 ## 26.0.202412190
 

source/ada/lsp-ada_contexts.adb

@@ -27,7 +27,6 @@ with GPR2.Containers;
 with GPR2.Path_Name;
 with GPR2.Project.Attribute;
 with GPR2.Project.Attribute_Index;
-with GPR2.Project.View.Set;
 with GPR2.Build.Source;
 with GPR2.Build.Source.Sets;
 
@@ -607,61 +606,105 @@ package body LSP.Ada_Contexts is
 
       procedure Update_Source_Files is
 
+         procedure Process_Closure
+           (Root     : GPR2.Project.View.Object;
+            Callback : not null access procedure
+              (View : GPR2.Project.View.Object));
+         --  Process the closure of Root with the given callback.
+         --  Similar to GPR2.Project.View.Closure, but, in addition,
+         --  when encountering an extending project, consider the
+         --  project it is extending to be part of the closure.
+
+         procedure Add_Sources_From_View (View : GPR2.Project.View.Object);
+         --  Add the sources from the given view to the context
+
+         procedure Add_Dirs_From_View (View : GPR2.Project.View.Object);
+         --  Add the source directories from the given view to the context
+
          procedure Insert_Source (Source : GPR2.Build.Source.Object);
          --  Insert Source in Self.Source_Files
 
          -------------------
          -- Insert_Source --
          -------------------
 
-         procedure Insert_Source (Source : GPR2.Build.Source.Object) is
-            Path : constant Virtual_File := Source.Path_Name.Virtual_File;
+         procedure Insert_Source (Source : GPR2.Build.Source.Object)
+         is
+            Path : constant Virtual_File :=
+              Source.Path_Name.Virtual_File;
          begin
             if not Self.Source_Files.Contains (Path) then
                Self.Source_Files.Include (Path);
             end if;
          end Insert_Source;
 
-      begin
-         Self.Source_Files.Clear;
+         ---------------------
+         -- Process_Closure --
+         ---------------------
 
-         for View of Root.Closure (Include_Self => True)
-           when not View.Is_Runtime
-         loop
-            declare
-               Sources : constant GPR2.Build.Source.Sets.Object
-                  := View.Sources;
-               use type GPR2.Language_Id;
-            begin
-               for Source of Sources loop
-                  if Source.Language = GPR2.Ada_Language then
-                     Insert_Source (Source);
-                  end if;
+         procedure Process_Closure
+           (Root     : GPR2.Project.View.Object;
+            Callback : not null access procedure
+              (View : GPR2.Project.View.Object))
+         is
+         begin
+            --  First process the closure of the view
+            for View of Root.Closure
+              (Include_Self => True) when not View.Is_Runtime
+            loop
+               Callback (View);
+            end loop;
+
+            --  If we're looking at an extending view, now
+            --  process the closure of the extended views.
+            if Root.Is_Extending then
+               for V of Root.Extended loop
+                  Process_Closure (V, Callback);
                end loop;
-            end;
-         end loop;
+            end if;
+         end Process_Closure;
 
-         Self.Source_Dirs.Clear;
-         Self.External_Source_Dirs.Clear;
+         ---------------------------
+         -- Add_Sources_From_View --
+         ---------------------------
 
-         declare
-            Views : constant GPR2.Project.View.Set.Object :=
-               Root.Closure (Include_Self => True);
+         procedure Add_Sources_From_View (View : GPR2.Project.View.Object) is
+            Sources : constant GPR2.Build.Source.Sets.Object := View.Sources;
+            use type GPR2.Language_Id;
          begin
-            for View of Views
-              when not View.Is_Runtime
-            loop
-               if View.Is_Externally_Built then
-                  for Dir of View.Source_Directories loop
-                     Self.External_Source_Dirs.Include (Dir.Virtual_File);
-                  end loop;
-               else
-                  for Dir of View.Source_Directories loop
-                     Self.Source_Dirs.Include (Dir.Virtual_File);
-                  end loop;
+            for Source of Sources loop
+               if Source.Language = GPR2.Ada_Language then
+                  Insert_Source (Source);
                end if;
             end loop;
-         end;
+         end Add_Sources_From_View;
+
+         ------------------------
+         -- Add_Dirs_From_View --
+         ------------------------
+
+         procedure Add_Dirs_From_View (View : GPR2.Project.View.Object) is
+         begin
+            if View.Is_Externally_Built then
+               for Dir of View.Source_Directories loop
+                  Self.External_Source_Dirs.Include (Dir.Virtual_File);
+               end loop;
+            else
+               for Dir of View.Source_Directories loop
+                  Self.Source_Dirs.Include (Dir.Virtual_File);
+               end loop;
+            end if;
+         end Add_Dirs_From_View;
+
+      begin
+         Self.Source_Files.Clear;
+
+         Process_Closure (Root, Add_Sources_From_View'Access);
+
+         Self.Source_Dirs.Clear;
+         Self.External_Source_Dirs.Clear;
+
+         Process_Closure (Root, Add_Dirs_From_View'Access);
 
          Self.Extension_Set.Clear;
 

testsuite/ada_lsp/find_all_refs_extending/common.adb

@@ -0,0 +1,13 @@
+with Ada.Text_IO;
+
+package body Common is
+
+   procedure Put (Item : Enum := Hello) is
+   begin
+      case Item is
+         when Hello => null;
+         when Goodbye => null;
+      end case;
+   end Put;
+
+end Common;

testsuite/ada_lsp/find_all_refs_extending/common/common.ads

@@ -0,0 +1,7 @@
+package Common is
+
+   type Enum is (Hello, Goodbye);
+
+   procedure Put (Item : Enum := Hello);
+
+end Common;

testsuite/ada_lsp/find_all_refs_extending/common/common.gpr

@@ -0,0 +1,6 @@
+project Common is
+
+  for Source_Dirs use (".");
+  for Source_Files use ("common.ads");
+
+end Common;

testsuite/ada_lsp/find_all_refs_extending/extending.gpr

@@ -0,0 +1,6 @@
+project Extending extends "program/program.gpr" is
+
+   for Main use ("extending.adb");
+   for Source_Dirs use ("extending");
+
+end Extending;

testsuite/ada_lsp/find_all_refs_extending/extending/extending.adb

@@ -0,0 +1,8 @@
+with Program;
+with Common;
+
+procedure Extending is
+   X : Common.Enum := Common.Hello;
+begin
+   Program;
+end Extending;

testsuite/ada_lsp/find_all_refs_extending/program/program.adb

@@ -0,0 +1,9 @@
+with Common;
+
+procedure Program is
+begin
+
+   Common.Put (Common.Hello);
+   Common.Put (Common.Goodbye);
+
+end Program;

testsuite/ada_lsp/find_all_refs_extending/program/program.gpr

@@ -0,0 +1,8 @@
+with "../common/common.gpr";
+
+project Program is
+
+   for Main use ("program.adb");
+   for Source_Dirs use (".");
+
+end Program;

testsuite/ada_lsp/find_all_refs_extending/test.py

@@ -0,0 +1,39 @@
+"""test that a references call finds all references to an enumeration
+literal in the context of extending projects."""
+
+from drivers.pylsp import ALSLanguageClient, test
+
+
+@test()
+async def test_called_by(lsp: ALSLanguageClient) -> None:
+    # Send a didChangeConfiguration notification to load the extending project
+    lsp.didChangeConfig({"projectFile": "extending.gpr"})
+
+    # Send a didOpen for main.adb
+    common_ads = lsp.didOpenFile("common/common.ads")
+
+    # Send a textDocument/prepareCallHierarchy request and verify the result
+    res1 = await lsp.references(common_ads, 3, 21)
+    lsp.assertLocationsList(
+        res1,
+        [
+            ("common.ads", 3),
+            ("common.ads", 5),
+            ("extending.adb", 5),
+            ("program.adb", 6),
+        ],
+    )
+
+    # Now load the non-extending project
+    lsp.didChangeConfig({"projectFile": "program/program.gpr"})
+
+    # And verify the result
+    res1 = await lsp.references(common_ads, 3, 21)
+    lsp.assertLocationsList(
+        res1,
+        [
+            ("common.ads", 3),
+            ("common.ads", 5),
+            ("program.adb", 6),
+        ],
+    )