[llvm-cov] Add the project summary to the text coverage report for each source file.

[MaggieYi]

Summary

This patch is a spin-off from https://reviews.llvm.org/D23922. It extends the text view to preserve the same feature as the html view.

[vsk]

Thanks for doing this. LGTM with one small change.

tools/llvm-cov/SourceCoverageView.h

277

Please add a short doxygen comment here, e.g 'Return the source name formatted for the host OS.'

test/tools/llvm-cov/native_separators.c

 // RUN: FileCheck -check-prefixes=HTML -input-file=%t.dir/coverage/tmp/native_separators.c.html %s
 
 // TEXT-INDEX: \tmp\native_separators.c
 // HTML-INDEX: >tmp\native_separators.c</a>
 // HTML: <pre>Source: \tmp\native_separators.c</pre>
 // HTML: tools\llvm-cov\Inputs\native_separators.covmapping</pre>
 
 int main() {}
+
+// RUN: llvm-cov show %S/Inputs/native_separators.covmapping -instr-profile=%t.profdata -filename-equivalence %s -o %t.dir
+// RUN: FileCheck -check-prefixes=TEXT -input-file=%t.dir/coverage/tmp/native_separators.c.txt %s
+// TEXT: {{^}}Source: \tmp\native_separators.c:{{$}}
+// TEXT: {{^}}Binary: {{.*}}tools\llvm-cov\Inputs\native_separators.covmapping:{{$}}

test/tools/llvm-cov/showTemplateInstantiations.cpp

 // RUN: llvm-cov show %S/Inputs/templateInstantiations.covmapping -instr-profile %S/Inputs/templateInstantiations.profdata -filename-equivalence %s | FileCheck -check-prefixes=SHARED,ALL %s
 // RUN: llvm-cov show %S/Inputs/templateInstantiations.covmapping -instr-profile %S/Inputs/templateInstantiations.profdata -filename-equivalence -name=_Z4funcIbEiT_ %s | FileCheck -check-prefixes=SHARED,FILTER %s
 
 // before coverage   // ALL:         [[@LINE]]|  |// before
                      // FILTER-NOT:[[@LINE-1]]|  |// before
 template<typename T> // ALL:         [[@LINE]]|  |template<typename T>
 int func(T x) {      // ALL-NEXT:    [[@LINE]]| 2|int func(T x) {
   if(x)              // ALL-NEXT:    [[@LINE]]| 2|  if(x)
     return 0;        // ALL-NEXT:    [[@LINE]]| 1|    return 0;
   else               // ALL-NEXT:    [[@LINE]]| 2|  else
     return 1;        // ALL-NEXT:    [[@LINE]]| 1|    return 1;
   int j = 1;         // ALL-NEXT:    [[@LINE]]| 0|  int j = 1;
 }                    // ALL-NEXT:    [[@LINE]]| 2|}
 
-                     // SHARED:       {{^ *(\| )?}}_Z4funcIbEiT_:
+                     // SHARED:       {{^ *(\| )?}}Function: _Z4funcIbEiT_:
                      // SHARED:       [[@LINE-9]]| 1|int func(T x) {
                      // SHARED-NEXT:  [[@LINE-9]]| 1|  if(x)
                      // SHARED-NEXT:  [[@LINE-9]]| 1|    return 0;
                      // SHARED-NEXT:  [[@LINE-9]]| 1|  else
                      // SHARED-NEXT:  [[@LINE-9]]| 0|    return 1;
                      // SHARED-NEXT:  [[@LINE-9]]| 0|  int j = 1;
                      // SHARED-NEXT:  [[@LINE-9]]| 1|}
 
-                     // ALL:         {{^ *}}| _Z4funcIiEiT_:
-                     // FILTER-NOT:  {{^ *(\| )?}} _Z4funcIiEiT_:
+                     // ALL:         {{^ *}}| Function: _Z4funcIiEiT_:
+                     // FILTER-NOT:  {{^ *(\| )?}}Function: _Z4funcIiEiT_:
                      // ALL:         [[@LINE-19]]| 1|int func(T x) {
                      // ALL-NEXT:    [[@LINE-19]]| 1|  if(x)
                      // ALL-NEXT:    [[@LINE-19]]| 0|    return 0;
                      // ALL-NEXT:    [[@LINE-19]]| 1|  else
                      // ALL-NEXT:    [[@LINE-19]]| 1|    return 1;
                      // ALL-NEXT:    [[@LINE-19]]| 0|  int j = 1;
                      // ALL-NEXT:    [[@LINE-19]]| 1|}
 

tools/llvm-cov/CodeCoverage.cpp

if (!Filters.empty()) {
     }
 
     Printer->closeViewFile(std::move(OS));
     return 0;
   }
 
   // Show files
   bool ShowFilenames =
-      (SourceFiles.size() != 1) ||
+      (SourceFiles.size() != 1) || ViewOpts.hasOutputDirectory() ||
       (ViewOpts.Format == CoverageViewOptions::OutputFormat::HTML);
 
   if (SourceFiles.empty())
     // Get the source files from the function coverage mapping.
     for (StringRef Filename : Coverage->getUniqueSourceFiles())
       SourceFiles.push_back(Filename);
 
   // Create an index out of the source files.

tools/llvm-cov/SourceCoverageView.h

public:
   create(StringRef SourceName, const MemoryBuffer &File,
          const CoverageViewOptions &Options,
          coverage::CoverageData &&CoverageInfo, bool FucntionView = false);
 
   virtual ~SourceCoverageView() {}
 
   StringRef getSourceName() const { return SourceName; }
 
+  std::string getNativeSourceName() const;
+
   bool isFunctionView() const { return FunctionView; }
 
   const CoverageViewOptions &getOptions() const { return Options; }
 
   /// \brief Add an expansion subview to this view.
   void addExpansion(const coverage::CounterMappingRegion &Region,
                     std::unique_ptr<SourceCoverageView> View);
 

tools/llvm-cov/SourceCoverageView.cpp

return llvm::make_unique<SourceCoverageViewText>(
         SourceName, File, Options, std::move(CoverageInfo), FunctionView);
   case CoverageViewOptions::OutputFormat::HTML:
     return llvm::make_unique<SourceCoverageViewHTML>(
         SourceName, File, Options, std::move(CoverageInfo), FunctionView);
   }
   llvm_unreachable("Unknown coverage output format!");
 }
 
+std::string SourceCoverageView::getNativeSourceName() const {
+  std::string SourceFile = isFunctionView() ? "Function: " : "Source: ";
+  SourceFile += getSourceName().str();
+  SmallString<128> SourceText(SourceFile);
+  sys::path::remove_dots(SourceText, /*remove_dot_dots=*/true);
+  sys::path::native(SourceText);
+  return SourceText.c_str();
+}
+
 void SourceCoverageView::addExpansion(
     const coverage::CounterMappingRegion &Region,
     std::unique_ptr<SourceCoverageView> View) {
   ExpansionSubViews.emplace_back(Region, std::move(View));
 }
 
 void SourceCoverageView::addInstantiation(
     StringRef FunctionName, unsigned Line,

tools/llvm-cov/SourceCoverageViewHTML.cpp

 
 void SourceCoverageViewHTML::renderViewFooter(raw_ostream &OS) {
   OS << EndTable << EndCenteredDiv;
 }
 
 void SourceCoverageViewHTML::renderSourceName(raw_ostream &OS, bool WholeFile) {
   OS << BeginSourceNameDiv;
   // Render the source name for the view.
-  std::string SourceFile = isFunctionView() ? "Function: " : "Source: ";
-  SourceFile += getSourceName().str();
-  SmallString<128> SourceText(SourceFile);
-  sys::path::remove_dots(SourceText, /*remove_dot_dots=*/true);
-  sys::path::native(SourceText);
-  OS << tag("pre", escape(SourceText, getOptions()));
+  OS << tag("pre", escape(getNativeSourceName(), getOptions()));
   // Render the object file name for the view.
   if (WholeFile)
     OS << tag("pre",
               escape("Binary: " + getOptions().ObjectFilename, getOptions()));
   OS << EndSourceNameDiv;
 }
 
 void SourceCoverageViewHTML::renderLinePrefix(raw_ostream &OS, unsigned) {

tools/llvm-cov/SourceCoverageViewText.cpp

 
 } // anonymous namespace
 
 void SourceCoverageViewText::renderViewHeader(raw_ostream &) {}
 
 void SourceCoverageViewText::renderViewFooter(raw_ostream &) {}
 
 void SourceCoverageViewText::renderSourceName(raw_ostream &OS, bool WholeFile) {
-  getOptions().colored_ostream(OS, raw_ostream::CYAN) << getSourceName()
+  getOptions().colored_ostream(OS, raw_ostream::CYAN) << getNativeSourceName()
                                                       << ":\n";
   if (WholeFile) {
     getOptions().colored_ostream(OS, raw_ostream::CYAN)
-        << getOptions().ObjectFilename << ":\n";
+        << "Binary: " << getOptions().ObjectFilename << ":\n";
   }
 }
 
 void SourceCoverageViewText::renderLinePrefix(raw_ostream &OS,
                                               unsigned ViewDepth) {
   for (unsigned I = 0; I < ViewDepth; ++I)
     OS << "  |";
 }