[LLVM-COV] Replace tabs to 2-space indentation in the HTML coverage report.

[MaggieYi]

Summary

When using llvm-cov.exe to generate the HTML report, the HTML report can look quite different to the source file if it includes tabs. The patch includes:

1. Use the default tab size is 2 spaces instead of 8 spaces.
2. Add a command line switch (-tab-size) that allows user to set the tab size.

[vsk]

Mostly looks good. The logic in escape() looks correct.

test/tools/llvm-cov/showTabsHTML.cpp

3

Does the second RUN line achieve any additional test coverage for this patch? If not, please remove it.

21

Since this test is just checking whether tabs are expanded properly, please keep the CHECKs on lines {9, 14, 18} and remove the rest. That should make the test easier to maintain.

38

Ditto, please trim this set of CHECKs.

tools/llvm-cov/CoverageViewOptions.h

37

Please don't introduce static members -- it should be possible to pass a CoverageViewOptions instance instead.

tools/llvm-cov/SourceCoverageViewHTML.cpp

46

Capitalize the iterator variable name.

[MaggieYi]

Thanks Vedant, I have updated the patch following your comments.

[MaggieYi]

Following Vedant's comments, all issues have been fixed.

[vsk]

Great! LGTM.

test/tools/llvm-cov/Inputs/showTabsHTML.proftext

+main
+# Func Hash:
+0
+# Num Counters:
+1
+# Counter Values:
+1
+

test/tools/llvm-cov/showTabsHTML.cpp

+// RUN: llvm-profdata merge -o %t.profdata %S/Inputs/showTabsHTML.proftext
+// RUN: llvm-cov show %S/Inputs/showTabsHTML.covmapping -format html -instr-profile %t.profdata -filename-equivalence %s | FileCheck -check-prefix=CHECK %s
+// RUN: llvm-cov show %S/Inputs/showTabsHTML.covmapping -format html -instr-profile %t.profdata -filename-equivalence -name=main %s | FileCheck -check-prefix=CHECK  %s
+
+int main(int argc, char ** argv) {
+                                                     // CHECK: <td class='covered-line'><pre>1</pre></td>
+                                                     // CHECK: <td class='line-number'><a name='L[[@LINE+2]]'><pre>[[@LINE+2]]</pre></a></td>
+                                                     // CHECK: <td class='code'><pre>
+  (void) "This tab starts at column 0";            // CHECK: &nbsp;&nbsp;(void) &quot;This tab starts at column 0&quot;;
+                                                     // CHECK: </pre></td>
+                                                     // CHECK: <td class='covered-line'><pre>1</pre></td>
+                                                     // CHECK: <td class='line-number'><a name='L[[@LINE+2]]'><pre>[[@LINE+2]]</pre></a></td>
+                                                     // CHECK: <td class='code'><pre>
+  (void) "  This tab starts at column 10";           // CHECK: (void) &quot;&nbsp;&nbsp;This tab starts at column 10&quot;;
+                                                     // CHECK: <td class='covered-line'><pre>1</pre></td>
+                                                     // CHECK: <td class='line-number'><a name='L[[@LINE+2]]'><pre>[[@LINE+2]]</pre></a></td>
+                                                     // CHECK: <td class='code'><pre>
+  (void) "This    tab starts at column 15";           // CHECK: (void) &quot;This &nbsp; tab starts at column 15&quot;;
+
+  return 0;
+}
+
+// RUN: llvm-cov show %S/Inputs/showTabsHTML.covmapping -format html -tab-size=3 -instr-profile %t.profdata -filename-equivalence %s | FileCheck -check-prefix=CHECK-TABSIZE %s
+
+// CHECK-TABSIZE: <td class='covered-line'><pre>1</pre></td>
+// CHECK-TABSIZE: <td class='line-number'><a name='L[[@LINE-17]]'><pre>[[@LINE-17]]</pre></a></td>
+// CHECK-TABSIZE: <td class='code'><pre>
+// CHECK-TABSIZE: &nbsp;&nbsp;&nbsp;(void) &quot;This tab starts at column 0&quot;;
+// CHECK-TABSIZE: </pre></td>
+// CHECK-TABSIZE: <td class='covered-line'><pre>1</pre></td>
+// CHECK-TABSIZE: <td class='line-number'><a name='L[[@LINE-17]]'><pre>[[@LINE-17]]</pre></a></td>
+// CHECK-TABSIZE: <td class='code'><pre>
+// CHECK-TABSIZE: (void) &quot;&nbsp;&nbsp;This tab starts at column 10&quot;;
+// CHECK-TABSIZE: <td class='covered-line'><pre>1</pre></td>
+// CHECK-TABSIZE: <td class='line-number'><a name='L[[@LINE-17]]'><pre>[[@LINE-17]]</pre></a></td>
+// CHECK-TABSIZE: <td class='code'><pre>
+// CHECK-TABSIZE: (void) &quot;This &nbsp;&nbsp;&nbsp; tab starts at column 15&quot;;
 No newline at end of file

tools/llvm-cov/CodeCoverage.cpp

cl::opt<bool> ShowInstantiations("show-instantiations", cl::Optional,
                                    cl::cat(ViewCategory));
 
   cl::opt<std::string> ShowOutputDirectory(
       "output-dir", cl::init(""),
       cl::desc("Directory in which coverage information is written out"));
   cl::alias ShowOutputDirectoryA("o", cl::desc("Alias for --output-dir"),
                                  cl::aliasopt(ShowOutputDirectory));
 
+  cl::opt<uint32_t> TabSize(
+      "tab-size", cl::Hidden, cl::init(2),
+      cl::desc("Set tab size for the HTML coverage report (default = 2)"));
+
   auto Err = commandLineParser(argc, argv);
   if (Err)
     return Err;
 
   ViewOpts.ShowLineNumbers = true;
   ViewOpts.ShowLineStats = ShowLineExecutionCounts.getNumOccurrences() != 0 ||
                            !ShowRegions || ShowBestLineRegionsCounts;
   ViewOpts.ShowRegionMarkers = ShowRegions || ShowBestLineRegionsCounts;
   ViewOpts.ShowLineStatsOrRegionMarkers = ShowBestLineRegionsCounts;
   ViewOpts.ShowExpandedRegions = ShowExpansions;
   ViewOpts.ShowFunctionInstantiations = ShowInstantiations;
   ViewOpts.ShowOutputDirectory = ShowOutputDirectory;
+  ViewOpts.TabSize = TabSize;
 
   if (ViewOpts.hasOutputDirectory()) {
     if (auto E = sys::fs::create_directories(ViewOpts.ShowOutputDirectory)) {
       error("Could not create output directory!", E.message());
       return 1;
     }
   }
 

tools/llvm-cov/CoverageViewOptions.h

struct CoverageViewOptions {
   bool ShowRegionMarkers;
   bool ShowLineStatsOrRegionMarkers;
   bool ShowExpandedRegions;
   bool ShowFunctionInstantiations;
   bool ShowFullFilenames;
   OutputFormat Format;
   std::string ShowOutputDirectory;
   std::vector<std::string> DemanglerOpts;
+  static uint32_t TabSize;
 
   /// \brief Change the output's stream color if the colors are enabled.
   ColoredRawOstream colored_ostream(raw_ostream &OS,
                                     raw_ostream::Colors Color) const {
     return llvm::colored_ostream(OS, Color, Colors);
   }
 
   /// \brief Check if an output directory has been specified.
   bool hasOutputDirectory() const { return !ShowOutputDirectory.empty(); }
 
   /// \brief Check if a demangler has been specified.
   bool hasDemangler() const { return !DemanglerOpts.empty(); }
 };
 }
 
 #endif // LLVM_COV_COVERAGEVIEWOPTIONS_H

tools/llvm-cov/SourceCoverageViewHTML.cpp

 
 #include "SourceCoverageViewHTML.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/ADT/SmallString.h"
 #include "llvm/ADT/StringExtras.h"
 #include "llvm/Support/Path.h"
 
 using namespace llvm;
+uint32_t CoverageViewOptions::TabSize;
 
 namespace {
 
 // Return a string with the special characters in \p Str escaped.
 std::string escape(StringRef Str) {
   std::string Result;
+  unsigned ColNum = 0;        // Record the column number.
   for (char C : Str) {
+    ++ColNum;
     if (C == '&')
       Result += "&";
     else if (C == '<')
       Result += "&lt;";
     else if (C == '>')
       Result += "&gt;";
     else if (C == '\"')
       Result += "&quot;";
-    else
+    // Replace '\t' with 2-space indentation.
+    else if (C == '\n' || C == '\r') {
+      Result += C;
+      ColNum = 0;
+    } else if (C == '\t') {
+      unsigned NumSpaces = CoverageViewOptions::TabSize -
+                           (--ColNum % CoverageViewOptions::TabSize);
+      for (unsigned i = 0; i < NumSpaces; ++i)
+        Result += "&nbsp;";
+      ColNum += NumSpaces;
+    } else
       Result += C;
   }
   return Result;
 }
 
 // Create a \p Name tag around \p Str, and optionally set its \p ClassName.
 std::string tag(const std::string &Name, const std::string &Str,
                 const std::string &ClassName = "") {