SC_Obligations: fix loading of scopes for ignored source files

This fixes an assertion failure: when remapping source files from the
scopes loaded from a SID/checkpoint, scopes whose identifier references
ignored source files will lose their identifier. Such scopes will
remain, but users will not be able to mark them of interest.

Author: pmderodat

testsuite/tests/subp_of_interest/src/pkg.adb

@@ -1,15 +1,34 @@
 with Ada.Text_IO; use Ada.Text_IO;
 
 package body Pkg is
+
+   ---------
+   -- Foo --
+   ---------
+
    procedure Foo (I : Integer) is
    begin
       Put_Line ("Hello from Foo!");
    end Foo;
 
+   ---------
+   -- Bar --
+   ---------
+
    procedure Bar is
       procedure Nested_Bar_1 is null;
+      procedure Nested_Bar_2;
+
       Dummy_Decl : Boolean;
-      procedure Nested_Bar_2 is null;
+
+      ------------------
+      -- Nested_Bar_2 --
+      ------------------
+
+      procedure Nested_Bar_2 is
+      begin
+         Put_Line ("Hello from Nested_Bar_2!");
+      end Nested_Bar_2;
    begin
       Nested_Bar_1;
       Nested_Bar_2;

testsuite/tests/subp_of_interest/src/pkg.ads

@@ -3,4 +3,6 @@ pragma Ada_2012;
 package Pkg is
    procedure Foo (I : Integer) with Pre => I > 0;
    procedure Bar;
+
+   I : Integer;
 end Pkg;

testsuite/tests/subp_of_interest/test.py

@@ -53,15 +53,16 @@ def check_xcov(label, args, expected_output=""):
 # that the coverage report contains only coverage data for the specified
 # subprograms for source traces. For binary traces, simply check that the
 # gnatcov coverage invocation yields the expected warning.
+ckpt_filename = "trace.ckpt"
 check_xcov(
     "xcov_subp",
     cov_args
     + [
         "--save-checkpoint",
-        "trace.ckpt",
+        ckpt_filename,
         f"--subprograms={pkg_spec}:4",
-        f"--subprograms={pkg_body}:10",
-        f"--subprograms={pkg_body}:12",
+        f"--subprograms={pkg_body}:19",
+        f"--subprograms={pkg_body}:20",
     ],
     expected_output=(
         ""
@@ -70,12 +71,14 @@ def check_xcov(label, args, expected_output=""):
         " with binary traces."
     ),
 )
+cov_ckpt_args = cov_args[:-1] + ["--checkpoint", ckpt_filename]
 if src_traces:
     check_xcov_reports(
         "*.xcov",
         {
             "main.adb.xcov": {},
-            "pkg.adb.xcov": {"+": {6, 10, 12}},
+            "pkg.ads.xcov": {},
+            "pkg.adb.xcov": {"+": {11, 19, 30}},
         },
         "xcov_subp",
     )
@@ -84,20 +87,37 @@ def check_xcov(label, args, expected_output=""):
     # specific subprogram. To do this, produce a new coverage report from the
     # checkpoint without using the --subprograms switch.
     thistest.log("== xcov_no_subp ==")
-    check_xcov(
-        "xcov_no_subp",
-        cov_args[:-1]
-        + ["--checkpoint", "trace.ckpt"],
-    )
+    check_xcov("xcov_no_subp", cov_ckpt_args)
     check_xcov_reports(
         "*.xcov",
         {
             "main.adb.xcov": {"-": {5, 6}},
-            "pkg.adb.xcov": {"+": {6, 10, 12}, "-": {11, 14, 15, 16}},
+            "pkg.ads.xcov": {"-": {7}},
+            "pkg.adb.xcov": {"+": {11, 19, 30}, "-": {22, 33, 34, 35}},
         },
         "xcov_no_subp",
     )
 
+    # Check that we can still select subprograms of interest declared in the
+    # package body, when the package specification is ignored through
+    # --ignored-source-files.
+    thistest.log("== xcov_ignore ==")
+    check_xcov(
+        "xcov_ignore",
+        cov_args + [
+            f"--subprograms={pkg_body}:20",
+            "--ignore-source-files=pkg.ads",
+        ],
+    )
+    check_xcov_reports(
+        "*.xcov",
+        {
+            "main.adb.xcov": {},
+            "pkg.adb.xcov": {"+": {30}},
+        },
+        "xcov_ignore",
+    )
+
     # Also check the warnings when the subprogram switch is ill-formed
 
     # Case 1: missing colon in the argument

tools/gnatcov/sc_obligations.adb

@@ -1232,15 +1232,23 @@ package body SC_Obligations is
          for Scope_Ent of CP_CU.Scope_Entities loop
             Remap_SCO_Id (Scope_Ent.From);
             Remap_SCO_Id (Scope_Ent.To);
-            Remap_SFI (Relocs, Scope_Ent.Identifier.Decl_SFI);
+
+            --  Scopes whose identifier references ignored source files will
+            --  lose their identifier: such scopes will remain, but users will
+            --  not be able to mark them of interest.
+
+            if SFI_Ignored (Relocs, Scope_Ent.Identifier.Decl_SFI) then
+               Scope_Ent.Identifier := No_Scope_Entity_Identifier;
+            else
+               Remap_SFI (Relocs, Scope_Ent.Identifier.Decl_SFI);
+            end if;
 
             --  Register each scope identifiers to make them available to users
             --  on the command line.
 
             Available_Subps_Of_Interest.Include (Scope_Ent.Identifier);
          end loop;
          pragma Assert (SCOs_Nested_And_Ordered (CP_CU.Scope_Entities));
-
       end if;
 
       --  Preallocate line table entries for last file

tools/gnatcov/sc_obligations.ads

@@ -177,6 +177,9 @@ package SC_Obligations is
    --  and line for the original declaration (which is the body declaration for
    --  C/C++ and the specification declaration for Ada).
 
+   No_Scope_Entity_Identifier : constant Scope_Entity_Identifier :=
+     (Decl_SFI => No_Source_File, Decl_Line => 0);
+
    function "<" (L, R : Scope_Entity_Identifier) return Boolean is
      (if L.Decl_SFI = R.Decl_SFI
       then L.Decl_Line < R.Decl_Line
@@ -271,7 +274,7 @@ package SC_Obligations is
       To         => No_SCO_Id,
       Name       => +"",
       Sloc       => No_Local_Location,
-      Identifier => (Decl_SFI => 0, Decl_Line => 0));
+      Identifier => No_Scope_Entity_Identifier);
 
    type Any_SCO_Kind is (Removed, Statement, Decision, Condition, Operator);
    subtype SCO_Kind is Any_SCO_Kind range Statement .. Operator;