Rework the verbose mode towards GNATCOLL.Traces-based logs

Use the GNATCOLL.Traces package to create different categories for logs,
so that we can enable only the traces relevant for what is being
debugged (see the `*_Trace : Logging.GNATCOLL_Trace` constants declared
where appropriate).

In addition to GNATCOLL.Traces's traditional way of configuring which
logs are enabled (i.e. the .gnatdebug file in the current directory),
also add a `--log <name>` command line option (internal, just like
--verbose) to enable the GNATCOLL trace called GNATCOV.<name>.

Still keep --verbose/-v as a convenient way to activate all GNATCOV.*
traces so that we still have a way to print all information when we do
not know what we are looking for exactly. Also introduce --quiet/-q
switches (public, this time) to instruct gnatcov not to print logs it
normally emits by default, for instance gprbuild/gprinstall logs for
"gnatcov setup".

Remove "debug switches" (-dX for various X letters) as they are now
obsolete: each one now has a GNATCOLL trace that controls the
corresponding on/off setting.

Author: pmderodat

testsuite/tests/KB30-011-eargs-gnatemu/test.py

@@ -27,7 +27,7 @@
 
 
 def check_eargs(output, eargs, exe, protect_eargs=False):
-    m = re.search('exec:\n  .*gnatemu.*', output)
+    m = re.search('exec: .*gnatemu.*', output)
     e = m.group(0)
     if protect_eargs:
         eargs = ' '.join ([f"'{arg}'" for arg in eargs.split(" ")])

testsuite/tests/MB15-041-verbose-open-crc32/test.py

@@ -19,7 +19,7 @@
 
 CWD_LINE_PREFIX = 'CWD = '
 LOG_OPEN_RE = re.compile(
-    r'--- notice: open "(?P<file>[^"]+)"'
+    r'\[GNATCOV\.MISC\] --- notice: open "(?P<file>[^"]+)"'
     r' \(CRC32 = 0x(?P<crc32>[0-9a-f]{8})\)'
 )
 

testsuite/tests/S529-038-isi-ckpt/test.py

@@ -106,7 +106,7 @@ def check_error(argv, log_name, expected_error):
       '--checkpoint', ckpt(1), trace(1)],
      out='leak.log')
 thistest.fail_if(
-    'discarding source trace entry for unknown instrumented unit: body of'
-    ' main1' not in lines_of('leak.log'))
+    '[GNATCOV.MISC] discarding source trace entry for unknown instrumented'
+    ' unit: body of main1' not in lines_of('leak.log'))
 
 thistest.result()

testsuite/tests/instr-cov/file-context/test.py

@@ -52,17 +52,20 @@ def do_instr(label, args):
 actual_lines = [
     line
     for line in lines_of(log)
-    if line.startswith("Instrumenting ") or line.startswith("warning: ")
+    if (
+        line.startswith("[GNATCOV.MISC] Instrumenting ")
+        or line.startswith("warning: ")
+    )
 ]
 thistest.fail_if_not_equal(
     f'"gnatcov instrument" output',
-    "\n".join(actual_lines),
     "\n".join([
-        "Instrumenting main.adb",
+        "[GNATCOV.MISC] Instrumenting main.adb",
         "warning: Cannot find required source file: missing_a.ads",
         "warning: Cannot find required source file: missing_b.ads",
-        "Instrumenting pkg.ads",
+        "[GNATCOV.MISC] Instrumenting pkg.ads",
     ]),
+    "\n".join(actual_lines),
 )
 
 thistest.result()

testsuite/tests/instr-cov/unknown_unit/test.py

@@ -48,7 +48,8 @@
           '--sid', unrelated_sid, trace_file],
          out='coverage.log')
 thistest.fail_if(
-    'discarding source trace entry for unknown instrumented unit: body of pkg'
+    '[GNATCOV.MISC] discarding source trace entry for unknown instrumented'
+    ' unit: body of pkg'
     not in lines_of('coverage.log'))
 
 thistest.result()

tools/gnatcov/ali_files.adb

@@ -28,7 +28,6 @@ with Files_Table; use Files_Table;
 with Get_SCOs;
 with Inputs;      use Inputs;
 with Outputs;     use Outputs;
-with Switches;    use Switches;
 
 package body ALI_Files is
 
@@ -386,9 +385,7 @@ package body ALI_Files is
 
       --  Here once the ALI file has been succesfully opened
 
-      if Verbose then
-         Put_Line ("Loading SCOs from " & ALI_Filename);
-      end if;
+      SCOs_Trace.Trace ("Loading SCOs from " & ALI_Filename);
 
       Expected_Annotation_Kind := Exempt_On;
       Expected_Annotation_Msg  := null;

tools/gnatcov/annotations.adb

@@ -562,7 +562,7 @@ package body Annotations is
 
       Cur : constant Cursor := ALI_Annotations.Floor (Sloc);
    begin
-      if not Debug_Ignore_Exemptions
+      if not Ignore_Exemptions_Trace.Is_Active
         and then Cur /= No_Element
         and then Key (Cur).Source_File = Sloc.Source_File
       then

tools/gnatcov/cfg_dump.adb

@@ -45,7 +45,6 @@ with Qemu_Traces;
 with SC_Obligations;
 with Strings;
 with Support_Files;
-with Switches;
 with Traces;       use Traces;
 with Traces_Dbase;
 with Traces_Elf;   use Traces_Elf;
@@ -1750,29 +1749,16 @@ package body CFG_Dump is
       Context.Keep_Edges := Keep_Edges;
       Context.Tag_Executed := Inputs.Length (Traces_Files_List) > 0;
 
-      if Switches.Verbose then
-         Report
-           (Msg  => "Hello, this is the dumper!",
-            Kind => Notice);
-         Report
-           (Msg  => "Dumping code from: " & Exec_Path,
-            Kind => Notice);
-         Report
-           (Msg  =>
-              (if Output = null
-               then "To standard output"
-               else "To " & Output.all),
-            Kind => Notice);
-         Report
-           (Msg  => "Format: " & Output_Format'Image (Format),
-            Kind => Notice);
-         Report
-           (Msg  =>
-              (if Keep_Edges
-               then "Keep edges that follow exception raises"
-               else "Strip edges that follow exception raises"),
-            Kind => Notice);
-      end if;
+      CFG_Dump_Trace.Trace ("Dumping code from: " & Exec_Path);
+      CFG_Dump_Trace.Trace
+        (if Output = null
+         then "To standard output"
+         else "To " & Output.all);
+      CFG_Dump_Trace.Trace ("Format: " & Output_Format'Image (Format));
+      CFG_Dump_Trace.Trace
+        (if Keep_Edges
+         then "Keep edges that follow exception raises"
+         else "Strip edges that follow exception raises");
 
       begin
          Execs_Dbase.Open_Exec (Exec_Path, 0, Context.Exec);
@@ -1781,38 +1767,26 @@ package body CFG_Dump is
             Fatal_Error ("Could not open " & Exec_Path);
       end;
 
-      if Switches.Verbose then
-         Report (Msg => "Reading symbols...", Kind => Notice);
-      end if;
+      CFG_Dump_Trace.Trace ("Reading symbols...");
       Build_Symbols (Context.Exec.all);
 
       Translate_Locations (Ctx.Exec, Locations, Context.Locs);
 
       if Context.Group_By_Condition then
          Coverage.Set_Coverage_Levels ("stmt+mcdc");
-         if Switches.Verbose then
-            Report (Msg => "Loading ALI files...", Kind => Notice);
-         end if;
+         CFG_Dump_Trace.Trace ("Loading ALI files...");
          Inputs.Iterate (SCO_Files_List, Load_SCOs'Access);
          Coverage.Source.Initialize_SCI;
 
-         if Switches.Verbose then
-            Report (Msg => "Reading routine names...", Kind => Notice);
-         end if;
+         CFG_Dump_Trace.Trace ("Reading routine names...");
          Read_Routine_Names (Context.Exec.all, Exclude => False);
       end if;
 
-      if Switches.Verbose then
-         Report (Msg => "Reading debug line info...", Kind => Notice);
-      end if;
+      CFG_Dump_Trace.Trace ("Reading debug line info...");
       Build_Debug_Lines (Context.Exec.all);
 
       if Context.Group_By_Condition then
-         if Switches.Verbose then
-            Report
-              (Msg => "Performing static analysis for decisions...",
-               Kind => Notice);
-         end if;
+         CFG_Dump_Trace.Trace ("Performing static analysis for decisions...");
          Decision_Map.Analyze (Context.Exec);
       end if;
 
@@ -1826,13 +1800,10 @@ package body CFG_Dump is
             exit when Section = null;
 
             if Section.Section_Name.all = ".text" then
-               if Switches.Verbose then
-                  Report
-                    (Msg => "ELF section #"
-                     & Strings.Img (Integer (Section.Section_Sec_Idx))
-                     & " looks interesting: loading its instructions...",
-                     Kind => Notice);
-               end if;
+               CFG_Dump_Trace.Trace
+                 ("ELF section #"
+                  & Strings.Img (Integer (Section.Section_Sec_Idx))
+                  & " looks interesting: loading its instructions...");
                Load_Section_Content (Context.Exec.all, Section);
                Collect_Instructions (Ctx, Section);
             end if;

tools/gnatcov/cfg_dump.ads

@@ -19,11 +19,15 @@
 with GNAT.Strings; use GNAT.Strings;
 
 with Inputs;
+with Logging;
 with Object_Locations; use Object_Locations;
 with Slocs;            use Slocs;
 
 package CFG_Dump is
 
+   CFG_Dump_Trace : constant Logging.GNATCOLL_Trace :=
+     Logging.Create_Trace ("CFG_DUMP");
+
    type Output_Format is (None, Dot, SVG, PDF, PNG);
    --  Format used to output the CFG. None stands for "output the Dot graph
    --  without passing it to dot(1)".

tools/gnatcov/command_line.adb

@@ -34,8 +34,26 @@ package body Command_Line is
       case Option is
          when Opt_Include =>
             Result.Remaining_Args.Append (+"--include");
+
          when Opt_Exclude =>
             Result.Remaining_Args.Append (+"--exclude");
+
+         when Opt_Quiet =>
+
+            --  "--quiet" cancels all the previous requests to enable logs
+            --  ("--log") and cancels any previuos request for full verbosity
+            --  ("--verbose").
+
+            Result.Bool_Args (Opt_Verbose) := False;
+            Result.String_List_Args (Opt_Log).Clear;
+
+         when Opt_Verbose =>
+
+            --  "--verbose" cancels any previous request for quiet verbosity
+            --  ("--quiet").
+
+            Result.Bool_Args (Opt_Quiet) := False;
+
          when others =>
             null;
       end case;