Add verbose output to show the scope entities structure

This will help understand what scope entities are created for input
sources, for debugging purposes.

Author: pmderodat

tools/gnatcov/gnatcov_bits_specific.adb

@@ -418,6 +418,16 @@ procedure GNATcov_Bits_Specific is
       Create_Matcher (Ignored_Source_Files, Matcher, Has_Matcher);
       Inputs.Iterate (SID_Inputs, SID_Load_Wrapper'Access);
 
+      --  Now that all the scope entities that can be referenced by
+      --  --subprograms are known, dump them in verbose mode.
+
+      if Verbose then
+         for CU in 1 .. Last_CU loop
+            Put_Line ("Scopes for " & Image (CU) & ":");
+            Dump (Get_Scope_Entities (CU), Line_Prefix => "| ");
+         end loop;
+      end if;
+
       --  Parse the listed subprograms of interest
 
       Copy_Arg_List (Opt_Subp_Of_Interest, Subprograms_Inputs);

tools/gnatcov/sc_obligations.adb

@@ -597,6 +597,44 @@ package body SC_Obligations is
    --
    --  ??? Same comment as above.
 
+   -----------
+   -- Image --
+   -----------
+
+   function Image (SE : Scope_Entity) return String is
+   begin
+      return
+        "Scope for "
+        & Ada.Strings.Unbounded.To_String (SE.Name)
+        & "[" & Slocs.Image (SE.Sloc)
+        & "], identifier at "
+        & Get_Simple_Name (SE.Identifier.Decl_SFI)
+        & ":" & Img (SE.Identifier.Decl_Line);
+   end Image;
+
+   ----------
+   -- Dump --
+   ----------
+
+   procedure Dump
+     (Scope_Entities : Scope_Entities_Trees.Tree; Line_Prefix : String := "")
+   is
+      use Scope_Entities_Trees;
+   begin
+      for Cur in Scope_Entities.Iterate loop
+         declare
+            Prefix : constant String :=
+              Line_Prefix & (1 .. 2 * (Natural (Depth (Cur)) - 2) => ' ');
+            SE     : Scope_Entity renames
+              Scope_Entities.Constant_Reference (Cur);
+         begin
+            Put_Line (Prefix & Image (SE));
+            Put_Line (Prefix & "... from " & Image (SE.From));
+            Put_Line (Prefix & "    to   " & Image (SE.To));
+         end;
+      end loop;
+   end Dump;
+
    ---------------------
    -- Scope_Traversal --
    ---------------------
@@ -2699,6 +2737,28 @@ package body SC_Obligations is
       return Sloc;
    end Last_Sloc;
 
+   -----------
+   -- Image --
+   -----------
+
+   function Image (CU : CU_Id) return String is
+   begin
+      return
+        (if CU = No_CU_Id
+         then "No CU"
+         else "CU "
+              & Get_Full_Name (CU_Vector.Constant_Reference (CU).Main_Source));
+   end Image;
+
+   -------------
+   -- Last_CU --
+   -------------
+
+   function Last_CU return CU_Id is
+   begin
+      return CU_Vector.Last_Index;
+   end Last_CU;
+
    --------------
    -- Provider --
    --------------

tools/gnatcov/sc_obligations.ads

@@ -108,6 +108,11 @@ package SC_Obligations is
    No_CU_Id : constant CU_Id := 0;
    subtype Valid_CU_Id is CU_Id range No_CU_Id + 1 .. CU_Id'Last;
 
+   function Image (CU : CU_Id) return String;
+
+   function Last_CU return CU_Id;
+   --  Return the last compilation unit that was created so far
+
    package CU_Id_Vectors is new Ada.Containers.Vectors (Positive, CU_Id);
 
    function Provider (CU : CU_Id) return SCO_Provider;
@@ -203,6 +208,8 @@ package SC_Obligations is
    --  This information is computed by the instrumenters (that know what is
    --  a scope, and what is not).
 
+   function Image (SE : Scope_Entity) return String;
+
    package Scope_Id_Sets is new Ada.Containers.Ordered_Sets
      (Element_Type => Scope_Entity_Identifier);
    subtype Scope_Id_Set is Scope_Id_Sets.Set;
@@ -211,6 +218,11 @@ package SC_Obligations is
      (Element_Type => Scope_Entity);
    subtype Scope_Entities_Tree is Scope_Entities_Trees.Tree;
 
+   procedure Dump
+     (Scope_Entities : Scope_Entities_Trees.Tree; Line_Prefix : String := "");
+   --  Debug helper: print a representation of Scope_Entities on the standard
+   --  output. Each line that is printed has the given Line_Prefix.
+
    subtype Tree_Iterator is
      Scope_Entities_Trees.Tree_Iterator_Interfaces.Forward_Iterator'Class;
    type Iterator_Acc is access Tree_Iterator;

tools/gnatcov/slocs.adb

@@ -143,6 +143,11 @@ package body Slocs is
    -- Image --
    -----------
 
+   function Image (Sloc : Local_Source_Location) return String is
+   begin
+      return Img (Sloc.Line) & ":" & Img (Sloc.Column);
+   end Image;
+
    function Image
      (Sloc        : Source_Location;
       Unique_Name : Boolean := False) return String is

tools/gnatcov/slocs.ads

@@ -37,6 +37,8 @@ package Slocs is
    function "<"  (L, R : Local_Source_Location) return Boolean;
    function "<=" (L, R : Local_Source_Location) return Boolean;
 
+   function Image (Sloc : Local_Source_Location) return String;
+
    No_Local_Location : constant Local_Source_Location := (0, 0);
 
    type Local_Source_Location_Range is record