compiler_wrappers-gcc.adb: fix handling of special filenames

Author: pmderodat

testsuite/tests/integrated_instrumentation/special_filenames/bar.c

@@ -0,0 +1,5 @@
+int
+bar (int c)
+{
+  return c + 1;
+}

testsuite/tests/integrated_instrumentation/special_filenames/foo.c

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

testsuite/tests/integrated_instrumentation/special_filenames/test.c

@@ -0,0 +1,10 @@
+extern int foo (int a, int b);
+extern int bar (int c);
+
+int
+main (void)
+{
+  foo (0, 1);
+  bar (0);
+  return 0;
+}

testsuite/tests/integrated_instrumentation/special_filenames/test.py

@@ -0,0 +1,66 @@
+"""
+Check that the integration instrumentation handles correctly filenames that
+contain spaces.
+"""
+
+import os
+import os.path
+
+from e3.fs import cp
+
+from SUITE.control import env
+from SUITE.cutils import Wdir
+from SCOV.minicheck import check_xcov_reports
+from SUITE.tutils import cmdrun, srctracename_for, thistest, xcov
+
+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 = {
+    "bar.c": 'src bar.c' if env.build.os.name == "windows" else 'src\\"bar.c',
+    "foo.c": "src foo$@.c",
+    "test.c": "test.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 = {
+    "test.c": {"+": {7, 8, 9}},
+    "foo.c": {"+": {4, 7}, "-": {5}},
+    "bar.c": {"+": {4}},
+}
+expected_report = {
+    "{}.xcov".format(copy_map[filename].replace("\\", "-")): report
+    for filename, report in coverage_data.items()
+}
+
+# Setup the instrumentation process
+sources = [os.path.abspath(filename) for filename in copy_map.values()]
+files = [f"--files={filename}" for filename in sources]
+xcov(
+    ["setup-integration", "--level=stmt", "--compilers=gcc", "--output-dir=."]
+    + files
+)
+
+# Shadow the compiler driver with the generated wrapper
+env.add_search_path(env_var="PATH", path=os.getcwd())
+
+# Build the test program and run it
+cmdrun(["gcc", "-o", "test program"] + sources, for_pgm=False)
+cmdrun(["test program"], for_pgm=False)
+
+# Check coverage expectations
+sid_args = [f"--sid={filename}.sid" for filename in sources]
+xcov(
+    ["coverage", "-cstmt", "-axcov", srctracename_for("test")]
+    + sid_args
+)
+check_xcov_reports("*.xcov", expected_report)
+
+thistest.result()

tools/gnatcov/compiler_wrappers-gcc.adb

@@ -213,20 +213,63 @@ is
    ----------------
 
    function Split_Args (Command : String) return String_Vectors.Vector is
+      type State_Kind is
+        (No_Argument, Simple_Argument, Quoted_Argument);
+
+      State  : State_Kind := No_Argument;
       Arg    : Unbounded_String;
       Result : String_Vectors.Vector;
-   begin
-      for C of Command loop
-         if C = ' ' and then Arg /= "" then
+
+      procedure Append_Arg;
+
+      ----------------
+      -- Append_Arg --
+      ----------------
+
+      procedure Append_Arg is
+      begin
+         if State /= No_Argument then
             Result.Append (Arg);
+            State := No_Argument;
             Arg := Null_Unbounded_String;
-         else
-            Append (Arg, C);
          end if;
+      end Append_Arg;
+
+      C : Character;
+      I : Natural := Command'First;
+
+   begin
+      while I <= Command'Last loop
+         C := Command (I);
+         case State is
+            when No_Argument =>
+               if C = '"' then
+                  State := Quoted_Argument;
+               elsif C /= ' ' then
+                  State := Simple_Argument;
+                  Append (Arg, C);
+               end if;
+
+            when Simple_Argument =>
+               if C = ' ' then
+                  Append_Arg;
+               else
+                  Append (Arg, C);
+               end if;
+
+            when Quoted_Argument =>
+               if C = '\' then
+                  I := I + 1;
+                  Append (Arg, Command (I));
+               elsif C = '"' then
+                  Append_Arg;
+               else
+                  Append (Arg, C);
+               end if;
+         end case;
+         I := I + 1;
       end loop;
-      if Arg /= "" then
-         Result.Append (Arg);
-      end if;
+      Append_Arg;
       return Result;
    end Split_Args;
 
@@ -736,7 +779,7 @@ begin
          Fullname    : constant String :=
            Ada.Directories.Full_Name (+Comp_Command.Filename);
          Simple_Name : constant String :=
-           Ada.Directories.Simple_Name (+Comp_Command.Filename);
+           Workaround_Simple_Name (+Comp_Command.Filename);
          Instr_Name  : constant String := (+Prj.Output_Dir) / Simple_Name;
 
       begin

tools/gnatcov/paths.adb

@@ -317,4 +317,22 @@ package body Paths is
              and then Path (Path'First + 1) = ':';
    end Starts_With_Drive_Pattern;
 
+   ----------------------------
+   -- Workaround_Simple_Name --
+   ----------------------------
+
+   function Workaround_Simple_Name (Path : String) return String is
+   begin
+      --  Return the Path suffix that precedes the first directory separator
+      --  according to the current platform. Return the full string if there is
+      --  no separator.
+
+      for I in reverse Path'Range loop
+         if Path (I) = '/' or else (On_Windows and then Path (I) = '\') then
+            return Path (I + 1 .. Path'Last);
+         end if;
+      end loop;
+      return Path;
+   end Workaround_Simple_Name;
+
 end Paths;

tools/gnatcov/paths.ads

@@ -66,4 +66,9 @@ package Paths is
 
    --  TODO??? Handle Unicode file names
 
+   function Workaround_Simple_Name (Path : String) return String;
+   --  TODO??? (eng/toolchain/gnat#603) The native GNAT runtime has a bug on
+   --  Unix systems: Ada.Directories.Simple_Name misbehaves in the presence of
+   --  backslashes. Provide our own implementation as a workaround.
+
 end Paths;