Instrument.C: fix handling of double quotes in filenames

Author: pmderodat

testsuite/tests/instr-cov/c_special_filenames/bar.c

@@ -0,0 +1,8 @@
+int
+bar (int a, int b, int c)
+{
+  if (a)
+    return b;
+  else
+    return c;
+}

testsuite/tests/instr-cov/c_special_filenames/$foo@bar$.c renamed to testsuite/tests/instr-cov/c_special_filenames/foo.c

@@ -1,8 +1,9 @@
 extern int foo (int i);
+extern int bar (int a, int b, int c);
 
 int
 main (void)
 {
-  int result = foo (0);
+  int result = foo (0) + bar (1, 0, 2);
   return result;
 }

testsuite/tests/instr-cov/c_special_filenames/main.c

@@ -3,32 +3,56 @@
 characters produces valid instrumented sources.
 """
 
+import os.path
+
+from e3.fs import cp
+
 from SCOV.minicheck import build_run_and_coverage, check_xcov_reports
+from SUITE.control import env
 from SUITE.context import thistest
 from SUITE.cutils import Wdir
 from SUITE.tutils import gprfor
 from SUITE.gprutils import GPRswitches
 
 
-tmp = Wdir('tmp_')
+tmp = Wdir("tmp_")
+
+# Copy the sources in the temporary directory. Note that we cannot test the
+# case of a filename containing a double quote or a backslash on Windows
+# because of filename restrictions on that platform.
+copy_map = {
+    "ada_main.adb": "ada_main.adb",
+    "bar.c": "src bar.c" if env.build.os.name == "windows" else 'src\\"bar.c',
+    "foo.c": "src [email protected]",
+    "main.c": "main.c",
+}
+for src, dest in copy_map.items():
+    cp(os.path.join("..", src), dest)
+
+# Compute the expected coverage report from the actual source filenames. Note
+# that in xcov filenames, "gnatcov coverage" first turns '\' to '/' (during
+# path separator canonicalization) and then the unique filename machinery turns
+# '/' to '-'.
+coverage_data = {
+    "ada_main.adb": {"+": {7, 9}},
+    "bar.c": {"+": {4, 5}, "-": {7}},
+    "foo.c": {"+": {4}},
+    "main.c": {"+": {7, 8}},
+}
+expected_report = {
+    "{}.xcov".format(copy_map[filename].replace("\\", "-")): report
+    for filename, report in coverage_data.items()
+}
 
 build_run_and_coverage(
     gprsw=GPRswitches(
-        root_project=gprfor(srcdirs=['..'], mains=['main.c', 'ada_main.adb'])
+        root_project=gprfor(srcdirs=["."], mains=["main.c", "ada_main.adb"])
     ),
-    covlevel='stmt',
-    mains=['main', 'ada_main'],
-    extra_coverage_args=['-axcov', '--output-dir=xcov'],
-    trace_mode='src',
-)
-check_xcov_reports(
-    '*.xcov',
-    {
-        'main.c.xcov': {'+': {6}},
-        '$foo@bar$.c.xcov': {'+': {4}},
-        'ada_main.adb.xcov': {'+': {9}},
-    },
-    'xcov',
+    covlevel="stmt",
+    mains=["main", "ada_main"],
+    extra_coverage_args=["-axcov", "--output-dir=xcov"],
+    trace_mode="src",
 )
+check_xcov_reports("*.xcov", expected_report, "xcov")
 
 thistest.result()

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

@@ -3585,7 +3585,7 @@ package body Instrument.C is
                --  filenames.
 
                & "  .unit_name = "
-               & " {""" & Escape_Backslashes (CU_Filename) & """, "
+               & " {" & C_String_Literal (CU_Filename) & ", "
                & CU_Filename'Length'Image & "}"
                & ","
                & ASCII.LF
@@ -3777,11 +3777,12 @@ package body Instrument.C is
                File.Put_Line (Indent2 & Simple & "),");
 
                File.Put_Line (Indent2
-                              & "STR ("""
-                              & (if Dump_Config.Trigger = Manual
-                                 then +Prj.Prj_Name
-                                 else Escape_Backslashes (+Main.Filename))
-                              & """),");
+                              & "STR ("
+                              & C_String_Literal
+                                  (if Dump_Config.Trigger = Manual
+                                   then +Prj.Prj_Name
+                                   else +Main.Filename)
+                              & "),");
                File.Put_Line (Indent2 & "gnatcov_rts_time_to_uint64()" & ",");
                File.Put_Line (Indent2 & "STR ("""")");
             end;
@@ -3793,11 +3794,12 @@ package body Instrument.C is
             --  program name is the name of the main, and there is no way to
             --  get the current execution time.
 
-            File.Put_Line (Indent2 & "STR ("""
-                           & (if Dump_Config.Trigger = Manual
-                             then +Prj.Prj_Name
-                             else Escape_Backslashes (+Main.Filename))
-                           & """),");
+            File.Put_Line (Indent2 & "STR ("
+                           & C_String_Literal
+                               (if Dump_Config.Trigger = Manual
+                                then +Prj.Prj_Name
+                                else +Main.Filename)
+                           & "),");
             File.Put_Line (Indent2 & "0,");
             File.Put_Line (Indent2 & "STR ("""")");
 
@@ -4605,4 +4607,25 @@ package body Instrument.C is
       end;
    end Is_Source_Of_Interest;
 
+   ----------------------
+   -- C_String_Literal --
+   ----------------------
+
+   function C_String_Literal (Str : String) return String is
+      Result : Unbounded_String;
+   begin
+      Append (Result, '"');
+      for C of Str loop
+         if C = '\' then
+            Append (Result, "\\");
+         elsif C = '"' then
+            Append (Result, "\""");
+         else
+            Append (Result, C);
+         end if;
+      end loop;
+      Append (Result, '"');
+      return +Result;
+   end C_String_Literal;
+
 end Instrument.C;

tools/gnatcov/instrument-c.adb

@@ -395,6 +395,14 @@ package Instrument.C is
    --  UIC.Sources_Of_Interest. Return whether this source file is a source of
    --  interest.
 
+   function C_String_Literal (Str : String) return String;
+   --  Turn Str into the corresponding C string literal. For instance:
+   --
+   --    C_String_Literal ("foo") = """foo"""
+   --    C_String_Literal ("a\b") = """a\\b"""
+   --    C_String_Literal ("a\b") = """a\\b"""
+   --    C_String_Literal ("a""b") = """a\""b"""
+
 private
 
    function Find_Instrumented_Entities

tools/gnatcov/instrument-c.ads

@@ -22,8 +22,6 @@ with Ada.Strings.Unbounded;
 with GNAT.OS_Lib;
 with GNAT.Regpat;
 
-with Strings; use Strings;
-
 package body Paths is
 
    On_Windows : constant Boolean := GNAT.OS_Lib.Directory_Separator = '\';
@@ -319,23 +317,4 @@ package body Paths is
              and then Path (Path'First + 1) = ':';
    end Starts_With_Drive_Pattern;
 
-   -------------------------
-   -- Escape_Windows_Path --
-   -------------------------
-
-   function Escape_Backslashes (Str : String) return String
-   is
-      use Ada.Strings.Unbounded;
-      Result : Unbounded_String;
-   begin
-      for C of Str loop
-         if C = '\' then
-            Append (Result, "\\");
-         else
-            Append (Result, C);
-         end if;
-      end loop;
-      return +Result;
-   end Escape_Backslashes;
-
 end Paths;

tools/gnatcov/paths.adb

@@ -64,10 +64,6 @@ package Paths is
    --  of the service, this one always matches both Windows or Unix file path
    --  flavors.
 
-   function Escape_Backslashes (Str : String) return String;
-   --  Escape every backslash in the given Str, to turn it into a C-compatible
-   --  string.
-
    --  TODO??? Handle Unicode file names
 
 end Paths;