xref: /freebsd-src/contrib/llvm-project/llvm/tools/llvm-cov/SourceCoverageViewHTML.cpp (revision 5f757f3ff9144b609b3c433dfd370cc6bdc191ad) 
10b57cec5SDimitry Andric //===- SourceCoverageViewHTML.cpp - A html code coverage view -------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric ///
90b57cec5SDimitry Andric /// \file This file implements the html coverage renderer.
100b57cec5SDimitry Andric ///
110b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
120b57cec5SDimitry Andric 
130b57cec5SDimitry Andric #include "SourceCoverageViewHTML.h"
14*5f757f3fSDimitry Andric #include "CoverageReport.h"
150b57cec5SDimitry Andric #include "llvm/ADT/SmallString.h"
160b57cec5SDimitry Andric #include "llvm/ADT/StringExtras.h"
170b57cec5SDimitry Andric #include "llvm/Support/Format.h"
180b57cec5SDimitry Andric #include "llvm/Support/Path.h"
19*5f757f3fSDimitry Andric #include "llvm/Support/ThreadPool.h"
20bdd1243dSDimitry Andric #include <optional>
210b57cec5SDimitry Andric 
220b57cec5SDimitry Andric using namespace llvm;
230b57cec5SDimitry Andric 
240b57cec5SDimitry Andric namespace {
250b57cec5SDimitry Andric 
260b57cec5SDimitry Andric // Return a string with the special characters in \p Str escaped.
270b57cec5SDimitry Andric std::string escape(StringRef Str, const CoverageViewOptions &Opts) {
280b57cec5SDimitry Andric   std::string TabExpandedResult;
290b57cec5SDimitry Andric   unsigned ColNum = 0; // Record the column number.
300b57cec5SDimitry Andric   for (char C : Str) {
310b57cec5SDimitry Andric     if (C == '\t') {
320b57cec5SDimitry Andric       // Replace '\t' with up to TabSize spaces.
330b57cec5SDimitry Andric       unsigned NumSpaces = Opts.TabSize - (ColNum % Opts.TabSize);
345ffd83dbSDimitry Andric       TabExpandedResult.append(NumSpaces, ' ');
350b57cec5SDimitry Andric       ColNum += NumSpaces;
360b57cec5SDimitry Andric     } else {
370b57cec5SDimitry Andric       TabExpandedResult += C;
380b57cec5SDimitry Andric       if (C == '\n' || C == '\r')
390b57cec5SDimitry Andric         ColNum = 0;
400b57cec5SDimitry Andric       else
410b57cec5SDimitry Andric         ++ColNum;
420b57cec5SDimitry Andric     }
430b57cec5SDimitry Andric   }
440b57cec5SDimitry Andric   std::string EscapedHTML;
450b57cec5SDimitry Andric   {
460b57cec5SDimitry Andric     raw_string_ostream OS{EscapedHTML};
470b57cec5SDimitry Andric     printHTMLEscaped(TabExpandedResult, OS);
480b57cec5SDimitry Andric   }
490b57cec5SDimitry Andric   return EscapedHTML;
500b57cec5SDimitry Andric }
510b57cec5SDimitry Andric 
520b57cec5SDimitry Andric // Create a \p Name tag around \p Str, and optionally set its \p ClassName.
53*5f757f3fSDimitry Andric std::string tag(StringRef Name, StringRef Str, StringRef ClassName = "") {
54*5f757f3fSDimitry Andric   std::string Tag = "<";
55*5f757f3fSDimitry Andric   Tag += Name;
56*5f757f3fSDimitry Andric   if (!ClassName.empty()) {
57*5f757f3fSDimitry Andric     Tag += " class='";
58*5f757f3fSDimitry Andric     Tag += ClassName;
59*5f757f3fSDimitry Andric     Tag += "'";
60*5f757f3fSDimitry Andric   }
61*5f757f3fSDimitry Andric   Tag += ">";
62*5f757f3fSDimitry Andric   Tag += Str;
63*5f757f3fSDimitry Andric   Tag += "</";
64*5f757f3fSDimitry Andric   Tag += Name;
65*5f757f3fSDimitry Andric   Tag += ">";
66*5f757f3fSDimitry Andric   return Tag;
670b57cec5SDimitry Andric }
680b57cec5SDimitry Andric 
690b57cec5SDimitry Andric // Create an anchor to \p Link with the label \p Str.
70*5f757f3fSDimitry Andric std::string a(StringRef Link, StringRef Str, StringRef TargetName = "") {
71*5f757f3fSDimitry Andric   std::string Tag;
72*5f757f3fSDimitry Andric   Tag += "<a ";
73*5f757f3fSDimitry Andric   if (!TargetName.empty()) {
74*5f757f3fSDimitry Andric     Tag += "name='";
75*5f757f3fSDimitry Andric     Tag += TargetName;
76*5f757f3fSDimitry Andric     Tag += "' ";
77*5f757f3fSDimitry Andric   }
78*5f757f3fSDimitry Andric   Tag += "href='";
79*5f757f3fSDimitry Andric   Tag += Link;
80*5f757f3fSDimitry Andric   Tag += "'>";
81*5f757f3fSDimitry Andric   Tag += Str;
82*5f757f3fSDimitry Andric   Tag += "</a>";
83*5f757f3fSDimitry Andric   return Tag;
840b57cec5SDimitry Andric }
850b57cec5SDimitry Andric 
860b57cec5SDimitry Andric const char *BeginHeader =
870b57cec5SDimitry Andric     "<head>"
880b57cec5SDimitry Andric     "<meta name='viewport' content='width=device-width,initial-scale=1'>"
890b57cec5SDimitry Andric     "<meta charset='UTF-8'>";
900b57cec5SDimitry Andric 
910b57cec5SDimitry Andric const char *CSSForCoverage =
920b57cec5SDimitry Andric     R"(.red {
930b57cec5SDimitry Andric   background-color: #ffd0d0;
940b57cec5SDimitry Andric }
950b57cec5SDimitry Andric .cyan {
960b57cec5SDimitry Andric   background-color: cyan;
970b57cec5SDimitry Andric }
980b57cec5SDimitry Andric body {
990b57cec5SDimitry Andric   font-family: -apple-system, sans-serif;
1000b57cec5SDimitry Andric }
1010b57cec5SDimitry Andric pre {
1020b57cec5SDimitry Andric   margin-top: 0px !important;
1030b57cec5SDimitry Andric   margin-bottom: 0px !important;
1040b57cec5SDimitry Andric }
1050b57cec5SDimitry Andric .source-name-title {
1060b57cec5SDimitry Andric   padding: 5px 10px;
1070b57cec5SDimitry Andric   border-bottom: 1px solid #dbdbdb;
1080b57cec5SDimitry Andric   background-color: #eee;
1090b57cec5SDimitry Andric   line-height: 35px;
1100b57cec5SDimitry Andric }
1110b57cec5SDimitry Andric .centered {
1120b57cec5SDimitry Andric   display: table;
1130b57cec5SDimitry Andric   margin-left: left;
1140b57cec5SDimitry Andric   margin-right: auto;
1150b57cec5SDimitry Andric   border: 1px solid #dbdbdb;
1160b57cec5SDimitry Andric   border-radius: 3px;
1170b57cec5SDimitry Andric }
1180b57cec5SDimitry Andric .expansion-view {
1190b57cec5SDimitry Andric   background-color: rgba(0, 0, 0, 0);
1200b57cec5SDimitry Andric   margin-left: 0px;
1210b57cec5SDimitry Andric   margin-top: 5px;
1220b57cec5SDimitry Andric   margin-right: 5px;
1230b57cec5SDimitry Andric   margin-bottom: 5px;
1240b57cec5SDimitry Andric   border: 1px solid #dbdbdb;
1250b57cec5SDimitry Andric   border-radius: 3px;
1260b57cec5SDimitry Andric }
1270b57cec5SDimitry Andric table {
1280b57cec5SDimitry Andric   border-collapse: collapse;
1290b57cec5SDimitry Andric }
1300b57cec5SDimitry Andric .light-row {
1310b57cec5SDimitry Andric   background: #ffffff;
1320b57cec5SDimitry Andric   border: 1px solid #dbdbdb;
1330b57cec5SDimitry Andric }
1340b57cec5SDimitry Andric .light-row-bold {
1350b57cec5SDimitry Andric   background: #ffffff;
1360b57cec5SDimitry Andric   border: 1px solid #dbdbdb;
1370b57cec5SDimitry Andric   font-weight: bold;
1380b57cec5SDimitry Andric }
1390b57cec5SDimitry Andric .column-entry {
1400b57cec5SDimitry Andric   text-align: left;
1410b57cec5SDimitry Andric }
1420b57cec5SDimitry Andric .column-entry-bold {
1430b57cec5SDimitry Andric   font-weight: bold;
1440b57cec5SDimitry Andric   text-align: left;
1450b57cec5SDimitry Andric }
1460b57cec5SDimitry Andric .column-entry-yellow {
1470b57cec5SDimitry Andric   text-align: left;
1480b57cec5SDimitry Andric   background-color: #ffffd0;
1490b57cec5SDimitry Andric }
1500b57cec5SDimitry Andric .column-entry-yellow:hover {
1510b57cec5SDimitry Andric   background-color: #fffff0;
1520b57cec5SDimitry Andric }
1530b57cec5SDimitry Andric .column-entry-red {
1540b57cec5SDimitry Andric   text-align: left;
1550b57cec5SDimitry Andric   background-color: #ffd0d0;
1560b57cec5SDimitry Andric }
1570b57cec5SDimitry Andric .column-entry-red:hover {
1580b57cec5SDimitry Andric   background-color: #fff0f0;
1590b57cec5SDimitry Andric }
1600b57cec5SDimitry Andric .column-entry-green {
1610b57cec5SDimitry Andric   text-align: left;
1620b57cec5SDimitry Andric   background-color: #d0ffd0;
1630b57cec5SDimitry Andric }
1640b57cec5SDimitry Andric .column-entry-green:hover {
1650b57cec5SDimitry Andric   background-color: #f0fff0;
1660b57cec5SDimitry Andric }
1670b57cec5SDimitry Andric .line-number {
1680b57cec5SDimitry Andric   text-align: right;
1690b57cec5SDimitry Andric   color: #aaa;
1700b57cec5SDimitry Andric }
1710b57cec5SDimitry Andric .covered-line {
1720b57cec5SDimitry Andric   text-align: right;
1730b57cec5SDimitry Andric   color: #0080ff;
1740b57cec5SDimitry Andric }
1750b57cec5SDimitry Andric .uncovered-line {
1760b57cec5SDimitry Andric   text-align: right;
1770b57cec5SDimitry Andric   color: #ff3300;
1780b57cec5SDimitry Andric }
1790b57cec5SDimitry Andric .tooltip {
1800b57cec5SDimitry Andric   position: relative;
1810b57cec5SDimitry Andric   display: inline;
1820b57cec5SDimitry Andric   background-color: #b3e6ff;
1830b57cec5SDimitry Andric   text-decoration: none;
1840b57cec5SDimitry Andric }
1850b57cec5SDimitry Andric .tooltip span.tooltip-content {
1860b57cec5SDimitry Andric   position: absolute;
1870b57cec5SDimitry Andric   width: 100px;
1880b57cec5SDimitry Andric   margin-left: -50px;
1890b57cec5SDimitry Andric   color: #FFFFFF;
1900b57cec5SDimitry Andric   background: #000000;
1910b57cec5SDimitry Andric   height: 30px;
1920b57cec5SDimitry Andric   line-height: 30px;
1930b57cec5SDimitry Andric   text-align: center;
1940b57cec5SDimitry Andric   visibility: hidden;
1950b57cec5SDimitry Andric   border-radius: 6px;
1960b57cec5SDimitry Andric }
1970b57cec5SDimitry Andric .tooltip span.tooltip-content:after {
1980b57cec5SDimitry Andric   content: '';
1990b57cec5SDimitry Andric   position: absolute;
2000b57cec5SDimitry Andric   top: 100%;
2010b57cec5SDimitry Andric   left: 50%;
2020b57cec5SDimitry Andric   margin-left: -8px;
2030b57cec5SDimitry Andric   width: 0; height: 0;
2040b57cec5SDimitry Andric   border-top: 8px solid #000000;
2050b57cec5SDimitry Andric   border-right: 8px solid transparent;
2060b57cec5SDimitry Andric   border-left: 8px solid transparent;
2070b57cec5SDimitry Andric }
2080b57cec5SDimitry Andric :hover.tooltip span.tooltip-content {
2090b57cec5SDimitry Andric   visibility: visible;
2100b57cec5SDimitry Andric   opacity: 0.8;
2110b57cec5SDimitry Andric   bottom: 30px;
2120b57cec5SDimitry Andric   left: 50%;
2130b57cec5SDimitry Andric   z-index: 999;
2140b57cec5SDimitry Andric }
2150b57cec5SDimitry Andric th, td {
2160b57cec5SDimitry Andric   vertical-align: top;
2170b57cec5SDimitry Andric   padding: 2px 8px;
2180b57cec5SDimitry Andric   border-collapse: collapse;
2190b57cec5SDimitry Andric   border-right: solid 1px #eee;
2200b57cec5SDimitry Andric   border-left: solid 1px #eee;
2210b57cec5SDimitry Andric   text-align: left;
2220b57cec5SDimitry Andric }
2230b57cec5SDimitry Andric td pre {
2240b57cec5SDimitry Andric   display: inline-block;
2250b57cec5SDimitry Andric }
2260b57cec5SDimitry Andric td:first-child {
2270b57cec5SDimitry Andric   border-left: none;
2280b57cec5SDimitry Andric }
2290b57cec5SDimitry Andric td:last-child {
2300b57cec5SDimitry Andric   border-right: none;
2310b57cec5SDimitry Andric }
2320b57cec5SDimitry Andric tr:hover {
2330b57cec5SDimitry Andric   background-color: #f0f0f0;
2340b57cec5SDimitry Andric }
2350b57cec5SDimitry Andric )";
2360b57cec5SDimitry Andric 
2370b57cec5SDimitry Andric const char *EndHeader = "</head>";
2380b57cec5SDimitry Andric 
2390b57cec5SDimitry Andric const char *BeginCenteredDiv = "<div class='centered'>";
2400b57cec5SDimitry Andric 
2410b57cec5SDimitry Andric const char *EndCenteredDiv = "</div>";
2420b57cec5SDimitry Andric 
2430b57cec5SDimitry Andric const char *BeginSourceNameDiv = "<div class='source-name-title'>";
2440b57cec5SDimitry Andric 
2450b57cec5SDimitry Andric const char *EndSourceNameDiv = "</div>";
2460b57cec5SDimitry Andric 
2470b57cec5SDimitry Andric const char *BeginCodeTD = "<td class='code'>";
2480b57cec5SDimitry Andric 
2490b57cec5SDimitry Andric const char *EndCodeTD = "</td>";
2500b57cec5SDimitry Andric 
2510b57cec5SDimitry Andric const char *BeginPre = "<pre>";
2520b57cec5SDimitry Andric 
2530b57cec5SDimitry Andric const char *EndPre = "</pre>";
2540b57cec5SDimitry Andric 
2550b57cec5SDimitry Andric const char *BeginExpansionDiv = "<div class='expansion-view'>";
2560b57cec5SDimitry Andric 
2570b57cec5SDimitry Andric const char *EndExpansionDiv = "</div>";
2580b57cec5SDimitry Andric 
2590b57cec5SDimitry Andric const char *BeginTable = "<table>";
2600b57cec5SDimitry Andric 
2610b57cec5SDimitry Andric const char *EndTable = "</table>";
2620b57cec5SDimitry Andric 
2630b57cec5SDimitry Andric const char *ProjectTitleTag = "h1";
2640b57cec5SDimitry Andric 
2650b57cec5SDimitry Andric const char *ReportTitleTag = "h2";
2660b57cec5SDimitry Andric 
2670b57cec5SDimitry Andric const char *CreatedTimeTag = "h4";
2680b57cec5SDimitry Andric 
2690b57cec5SDimitry Andric std::string getPathToStyle(StringRef ViewPath) {
270e8d8bef9SDimitry Andric   std::string PathToStyle;
2715ffd83dbSDimitry Andric   std::string PathSep = std::string(sys::path::get_separator());
2720b57cec5SDimitry Andric   unsigned NumSeps = ViewPath.count(PathSep);
2730b57cec5SDimitry Andric   for (unsigned I = 0, E = NumSeps; I < E; ++I)
2740b57cec5SDimitry Andric     PathToStyle += ".." + PathSep;
2750b57cec5SDimitry Andric   return PathToStyle + "style.css";
2760b57cec5SDimitry Andric }
2770b57cec5SDimitry Andric 
2780b57cec5SDimitry Andric void emitPrelude(raw_ostream &OS, const CoverageViewOptions &Opts,
2790b57cec5SDimitry Andric                  const std::string &PathToStyle = "") {
2800b57cec5SDimitry Andric   OS << "<!doctype html>"
2810b57cec5SDimitry Andric         "<html>"
2820b57cec5SDimitry Andric      << BeginHeader;
2830b57cec5SDimitry Andric 
2840b57cec5SDimitry Andric   // Link to a stylesheet if one is available. Otherwise, use the default style.
2850b57cec5SDimitry Andric   if (PathToStyle.empty())
2860b57cec5SDimitry Andric     OS << "<style>" << CSSForCoverage << "</style>";
2870b57cec5SDimitry Andric   else
2880b57cec5SDimitry Andric     OS << "<link rel='stylesheet' type='text/css' href='"
2890b57cec5SDimitry Andric        << escape(PathToStyle, Opts) << "'>";
2900b57cec5SDimitry Andric 
2910b57cec5SDimitry Andric   OS << EndHeader << "<body>";
2920b57cec5SDimitry Andric }
2930b57cec5SDimitry Andric 
294*5f757f3fSDimitry Andric void emitTableRow(raw_ostream &OS, const CoverageViewOptions &Opts,
295*5f757f3fSDimitry Andric                   const std::string &FirstCol, const FileCoverageSummary &FCS,
296*5f757f3fSDimitry Andric                   bool IsTotals) {
297*5f757f3fSDimitry Andric   SmallVector<std::string, 8> Columns;
298*5f757f3fSDimitry Andric 
299*5f757f3fSDimitry Andric   // Format a coverage triple and add the result to the list of columns.
300*5f757f3fSDimitry Andric   auto AddCoverageTripleToColumn =
301*5f757f3fSDimitry Andric       [&Columns, &Opts](unsigned Hit, unsigned Total, float Pctg) {
302*5f757f3fSDimitry Andric         std::string S;
303*5f757f3fSDimitry Andric         {
304*5f757f3fSDimitry Andric           raw_string_ostream RSO{S};
305*5f757f3fSDimitry Andric           if (Total)
306*5f757f3fSDimitry Andric             RSO << format("%*.2f", 7, Pctg) << "% ";
307*5f757f3fSDimitry Andric           else
308*5f757f3fSDimitry Andric             RSO << "- ";
309*5f757f3fSDimitry Andric           RSO << '(' << Hit << '/' << Total << ')';
310*5f757f3fSDimitry Andric         }
311*5f757f3fSDimitry Andric         const char *CellClass = "column-entry-yellow";
312*5f757f3fSDimitry Andric         if (Pctg >= Opts.HighCovWatermark)
313*5f757f3fSDimitry Andric           CellClass = "column-entry-green";
314*5f757f3fSDimitry Andric         else if (Pctg < Opts.LowCovWatermark)
315*5f757f3fSDimitry Andric           CellClass = "column-entry-red";
316*5f757f3fSDimitry Andric         Columns.emplace_back(tag("td", tag("pre", S), CellClass));
317*5f757f3fSDimitry Andric       };
318*5f757f3fSDimitry Andric 
319*5f757f3fSDimitry Andric   Columns.emplace_back(tag("td", tag("pre", FirstCol)));
320*5f757f3fSDimitry Andric   AddCoverageTripleToColumn(FCS.FunctionCoverage.getExecuted(),
321*5f757f3fSDimitry Andric                             FCS.FunctionCoverage.getNumFunctions(),
322*5f757f3fSDimitry Andric                             FCS.FunctionCoverage.getPercentCovered());
323*5f757f3fSDimitry Andric   if (Opts.ShowInstantiationSummary)
324*5f757f3fSDimitry Andric     AddCoverageTripleToColumn(FCS.InstantiationCoverage.getExecuted(),
325*5f757f3fSDimitry Andric                               FCS.InstantiationCoverage.getNumFunctions(),
326*5f757f3fSDimitry Andric                               FCS.InstantiationCoverage.getPercentCovered());
327*5f757f3fSDimitry Andric   AddCoverageTripleToColumn(FCS.LineCoverage.getCovered(),
328*5f757f3fSDimitry Andric                             FCS.LineCoverage.getNumLines(),
329*5f757f3fSDimitry Andric                             FCS.LineCoverage.getPercentCovered());
330*5f757f3fSDimitry Andric   if (Opts.ShowRegionSummary)
331*5f757f3fSDimitry Andric     AddCoverageTripleToColumn(FCS.RegionCoverage.getCovered(),
332*5f757f3fSDimitry Andric                               FCS.RegionCoverage.getNumRegions(),
333*5f757f3fSDimitry Andric                               FCS.RegionCoverage.getPercentCovered());
334*5f757f3fSDimitry Andric   if (Opts.ShowBranchSummary)
335*5f757f3fSDimitry Andric     AddCoverageTripleToColumn(FCS.BranchCoverage.getCovered(),
336*5f757f3fSDimitry Andric                               FCS.BranchCoverage.getNumBranches(),
337*5f757f3fSDimitry Andric                               FCS.BranchCoverage.getPercentCovered());
338*5f757f3fSDimitry Andric   if (Opts.ShowMCDCSummary)
339*5f757f3fSDimitry Andric     AddCoverageTripleToColumn(FCS.MCDCCoverage.getCoveredPairs(),
340*5f757f3fSDimitry Andric                               FCS.MCDCCoverage.getNumPairs(),
341*5f757f3fSDimitry Andric                               FCS.MCDCCoverage.getPercentCovered());
342*5f757f3fSDimitry Andric 
343*5f757f3fSDimitry Andric   if (IsTotals)
344*5f757f3fSDimitry Andric     OS << tag("tr", join(Columns.begin(), Columns.end(), ""), "light-row-bold");
345*5f757f3fSDimitry Andric   else
346*5f757f3fSDimitry Andric     OS << tag("tr", join(Columns.begin(), Columns.end(), ""), "light-row");
347*5f757f3fSDimitry Andric }
348*5f757f3fSDimitry Andric 
3490b57cec5SDimitry Andric void emitEpilog(raw_ostream &OS) {
3500b57cec5SDimitry Andric   OS << "</body>"
3510b57cec5SDimitry Andric      << "</html>";
3520b57cec5SDimitry Andric }
3530b57cec5SDimitry Andric 
3540b57cec5SDimitry Andric } // anonymous namespace
3550b57cec5SDimitry Andric 
3560b57cec5SDimitry Andric Expected<CoveragePrinter::OwnedStream>
3570b57cec5SDimitry Andric CoveragePrinterHTML::createViewFile(StringRef Path, bool InToplevel) {
3580b57cec5SDimitry Andric   auto OSOrErr = createOutputStream(Path, "html", InToplevel);
3590b57cec5SDimitry Andric   if (!OSOrErr)
3600b57cec5SDimitry Andric     return OSOrErr;
3610b57cec5SDimitry Andric 
3620b57cec5SDimitry Andric   OwnedStream OS = std::move(OSOrErr.get());
3630b57cec5SDimitry Andric 
3640b57cec5SDimitry Andric   if (!Opts.hasOutputDirectory()) {
3650b57cec5SDimitry Andric     emitPrelude(*OS.get(), Opts);
3660b57cec5SDimitry Andric   } else {
3670b57cec5SDimitry Andric     std::string ViewPath = getOutputPath(Path, "html", InToplevel);
3680b57cec5SDimitry Andric     emitPrelude(*OS.get(), Opts, getPathToStyle(ViewPath));
3690b57cec5SDimitry Andric   }
3700b57cec5SDimitry Andric 
3710b57cec5SDimitry Andric   return std::move(OS);
3720b57cec5SDimitry Andric }
3730b57cec5SDimitry Andric 
3740b57cec5SDimitry Andric void CoveragePrinterHTML::closeViewFile(OwnedStream OS) {
3750b57cec5SDimitry Andric   emitEpilog(*OS.get());
3760b57cec5SDimitry Andric }
3770b57cec5SDimitry Andric 
3780b57cec5SDimitry Andric /// Emit column labels for the table in the index.
3790b57cec5SDimitry Andric static void emitColumnLabelsForIndex(raw_ostream &OS,
3800b57cec5SDimitry Andric                                      const CoverageViewOptions &Opts) {
3810b57cec5SDimitry Andric   SmallVector<std::string, 4> Columns;
3820b57cec5SDimitry Andric   Columns.emplace_back(tag("td", "Filename", "column-entry-bold"));
3830b57cec5SDimitry Andric   Columns.emplace_back(tag("td", "Function Coverage", "column-entry-bold"));
3840b57cec5SDimitry Andric   if (Opts.ShowInstantiationSummary)
3850b57cec5SDimitry Andric     Columns.emplace_back(
3860b57cec5SDimitry Andric         tag("td", "Instantiation Coverage", "column-entry-bold"));
3870b57cec5SDimitry Andric   Columns.emplace_back(tag("td", "Line Coverage", "column-entry-bold"));
3880b57cec5SDimitry Andric   if (Opts.ShowRegionSummary)
3890b57cec5SDimitry Andric     Columns.emplace_back(tag("td", "Region Coverage", "column-entry-bold"));
390e8d8bef9SDimitry Andric   if (Opts.ShowBranchSummary)
391e8d8bef9SDimitry Andric     Columns.emplace_back(tag("td", "Branch Coverage", "column-entry-bold"));
392*5f757f3fSDimitry Andric   if (Opts.ShowMCDCSummary)
393*5f757f3fSDimitry Andric     Columns.emplace_back(tag("td", "MC/DC", "column-entry-bold"));
3940b57cec5SDimitry Andric   OS << tag("tr", join(Columns.begin(), Columns.end(), ""));
3950b57cec5SDimitry Andric }
3960b57cec5SDimitry Andric 
3970b57cec5SDimitry Andric std::string
3980b57cec5SDimitry Andric CoveragePrinterHTML::buildLinkToFile(StringRef SF,
3990b57cec5SDimitry Andric                                      const FileCoverageSummary &FCS) const {
4000b57cec5SDimitry Andric   SmallString<128> LinkTextStr(sys::path::relative_path(FCS.Name));
40104eeddc0SDimitry Andric   sys::path::remove_dots(LinkTextStr, /*remove_dot_dot=*/true);
4020b57cec5SDimitry Andric   sys::path::native(LinkTextStr);
4030b57cec5SDimitry Andric   std::string LinkText = escape(LinkTextStr, Opts);
4040b57cec5SDimitry Andric   std::string LinkTarget =
4050b57cec5SDimitry Andric       escape(getOutputPath(SF, "html", /*InToplevel=*/false), Opts);
4060b57cec5SDimitry Andric   return a(LinkTarget, LinkText);
4070b57cec5SDimitry Andric }
4080b57cec5SDimitry Andric 
409*5f757f3fSDimitry Andric Error CoveragePrinterHTML::emitStyleSheet() {
4100b57cec5SDimitry Andric   auto CSSOrErr = createOutputStream("style", "css", /*InToplevel=*/true);
4110b57cec5SDimitry Andric   if (Error E = CSSOrErr.takeError())
4120b57cec5SDimitry Andric     return E;
4130b57cec5SDimitry Andric 
4140b57cec5SDimitry Andric   OwnedStream CSS = std::move(CSSOrErr.get());
4150b57cec5SDimitry Andric   CSS->operator<<(CSSForCoverage);
4160b57cec5SDimitry Andric 
417*5f757f3fSDimitry Andric   return Error::success();
418*5f757f3fSDimitry Andric }
4190b57cec5SDimitry Andric 
420*5f757f3fSDimitry Andric void CoveragePrinterHTML::emitReportHeader(raw_ostream &OSRef,
421*5f757f3fSDimitry Andric                                            const std::string &Title) {
4220b57cec5SDimitry Andric   // Emit some basic information about the coverage report.
4230b57cec5SDimitry Andric   if (Opts.hasProjectTitle())
4240b57cec5SDimitry Andric     OSRef << tag(ProjectTitleTag, escape(Opts.ProjectTitle, Opts));
425*5f757f3fSDimitry Andric   OSRef << tag(ReportTitleTag, Title);
4260b57cec5SDimitry Andric   if (Opts.hasCreatedTime())
4270b57cec5SDimitry Andric     OSRef << tag(CreatedTimeTag, escape(Opts.CreatedTimeStr, Opts));
4280b57cec5SDimitry Andric 
4290b57cec5SDimitry Andric   // Emit a link to some documentation.
4300b57cec5SDimitry Andric   OSRef << tag("p", "Click " +
4310b57cec5SDimitry Andric                         a("http://clang.llvm.org/docs/"
4320b57cec5SDimitry Andric                           "SourceBasedCodeCoverage.html#interpreting-reports",
4330b57cec5SDimitry Andric                           "here") +
4340b57cec5SDimitry Andric                         " for information about interpreting this report.");
4350b57cec5SDimitry Andric 
4360b57cec5SDimitry Andric   // Emit a table containing links to reports for each file in the covmapping.
4370b57cec5SDimitry Andric   // Exclude files which don't contain any regions.
4380b57cec5SDimitry Andric   OSRef << BeginCenteredDiv << BeginTable;
4390b57cec5SDimitry Andric   emitColumnLabelsForIndex(OSRef, Opts);
440*5f757f3fSDimitry Andric }
441*5f757f3fSDimitry Andric 
442*5f757f3fSDimitry Andric /// Render a file coverage summary (\p FCS) in a table row. If \p IsTotals is
443*5f757f3fSDimitry Andric /// false, link the summary to \p SF.
444*5f757f3fSDimitry Andric void CoveragePrinterHTML::emitFileSummary(raw_ostream &OS, StringRef SF,
445*5f757f3fSDimitry Andric                                           const FileCoverageSummary &FCS,
446*5f757f3fSDimitry Andric                                           bool IsTotals) const {
447*5f757f3fSDimitry Andric   // Simplify the display file path, and wrap it in a link if requested.
448*5f757f3fSDimitry Andric   std::string Filename;
449*5f757f3fSDimitry Andric   if (IsTotals) {
450*5f757f3fSDimitry Andric     Filename = std::string(SF);
451*5f757f3fSDimitry Andric   } else {
452*5f757f3fSDimitry Andric     Filename = buildLinkToFile(SF, FCS);
453*5f757f3fSDimitry Andric   }
454*5f757f3fSDimitry Andric 
455*5f757f3fSDimitry Andric   emitTableRow(OS, Opts, Filename, FCS, IsTotals);
456*5f757f3fSDimitry Andric }
457*5f757f3fSDimitry Andric 
458*5f757f3fSDimitry Andric Error CoveragePrinterHTML::createIndexFile(
459*5f757f3fSDimitry Andric     ArrayRef<std::string> SourceFiles, const CoverageMapping &Coverage,
460*5f757f3fSDimitry Andric     const CoverageFiltersMatchAll &Filters) {
461*5f757f3fSDimitry Andric   // Emit the default stylesheet.
462*5f757f3fSDimitry Andric   if (Error E = emitStyleSheet())
463*5f757f3fSDimitry Andric     return E;
464*5f757f3fSDimitry Andric 
465*5f757f3fSDimitry Andric   // Emit a file index along with some coverage statistics.
466*5f757f3fSDimitry Andric   auto OSOrErr = createOutputStream("index", "html", /*InToplevel=*/true);
467*5f757f3fSDimitry Andric   if (Error E = OSOrErr.takeError())
468*5f757f3fSDimitry Andric     return E;
469*5f757f3fSDimitry Andric   auto OS = std::move(OSOrErr.get());
470*5f757f3fSDimitry Andric   raw_ostream &OSRef = *OS.get();
471*5f757f3fSDimitry Andric 
472*5f757f3fSDimitry Andric   assert(Opts.hasOutputDirectory() && "No output directory for index file");
473*5f757f3fSDimitry Andric   emitPrelude(OSRef, Opts, getPathToStyle(""));
474*5f757f3fSDimitry Andric 
475*5f757f3fSDimitry Andric   emitReportHeader(OSRef, "Coverage Report");
476*5f757f3fSDimitry Andric 
4770b57cec5SDimitry Andric   FileCoverageSummary Totals("TOTALS");
4780b57cec5SDimitry Andric   auto FileReports = CoverageReport::prepareFileReports(
4790b57cec5SDimitry Andric       Coverage, Totals, SourceFiles, Opts, Filters);
4800b57cec5SDimitry Andric   bool EmptyFiles = false;
4810b57cec5SDimitry Andric   for (unsigned I = 0, E = FileReports.size(); I < E; ++I) {
4820b57cec5SDimitry Andric     if (FileReports[I].FunctionCoverage.getNumFunctions())
4830b57cec5SDimitry Andric       emitFileSummary(OSRef, SourceFiles[I], FileReports[I]);
4840b57cec5SDimitry Andric     else
4850b57cec5SDimitry Andric       EmptyFiles = true;
4860b57cec5SDimitry Andric   }
4870b57cec5SDimitry Andric   emitFileSummary(OSRef, "Totals", Totals, /*IsTotals=*/true);
4880b57cec5SDimitry Andric   OSRef << EndTable << EndCenteredDiv;
4890b57cec5SDimitry Andric 
4900b57cec5SDimitry Andric   // Emit links to files which don't contain any functions. These are normally
4910b57cec5SDimitry Andric   // not very useful, but could be relevant for code which abuses the
4920b57cec5SDimitry Andric   // preprocessor.
4930b57cec5SDimitry Andric   if (EmptyFiles && Filters.empty()) {
4940b57cec5SDimitry Andric     OSRef << tag("p", "Files which contain no functions. (These "
4950b57cec5SDimitry Andric                       "files contain code pulled into other files "
4960b57cec5SDimitry Andric                       "by the preprocessor.)\n");
4970b57cec5SDimitry Andric     OSRef << BeginCenteredDiv << BeginTable;
4980b57cec5SDimitry Andric     for (unsigned I = 0, E = FileReports.size(); I < E; ++I)
4990b57cec5SDimitry Andric       if (!FileReports[I].FunctionCoverage.getNumFunctions()) {
5000b57cec5SDimitry Andric         std::string Link = buildLinkToFile(SourceFiles[I], FileReports[I]);
5010b57cec5SDimitry Andric         OSRef << tag("tr", tag("td", tag("pre", Link)), "light-row") << '\n';
5020b57cec5SDimitry Andric       }
5030b57cec5SDimitry Andric     OSRef << EndTable << EndCenteredDiv;
5040b57cec5SDimitry Andric   }
5050b57cec5SDimitry Andric 
5060b57cec5SDimitry Andric   OSRef << tag("h5", escape(Opts.getLLVMVersionString(), Opts));
5070b57cec5SDimitry Andric   emitEpilog(OSRef);
5080b57cec5SDimitry Andric 
5090b57cec5SDimitry Andric   return Error::success();
5100b57cec5SDimitry Andric }
5110b57cec5SDimitry Andric 
512*5f757f3fSDimitry Andric struct CoveragePrinterHTMLDirectory::Reporter : public DirectoryCoverageReport {
513*5f757f3fSDimitry Andric   CoveragePrinterHTMLDirectory &Printer;
514*5f757f3fSDimitry Andric 
515*5f757f3fSDimitry Andric   Reporter(CoveragePrinterHTMLDirectory &Printer,
516*5f757f3fSDimitry Andric            const coverage::CoverageMapping &Coverage,
517*5f757f3fSDimitry Andric            const CoverageFiltersMatchAll &Filters)
518*5f757f3fSDimitry Andric       : DirectoryCoverageReport(Printer.Opts, Coverage, Filters),
519*5f757f3fSDimitry Andric         Printer(Printer) {}
520*5f757f3fSDimitry Andric 
521*5f757f3fSDimitry Andric   Error generateSubDirectoryReport(SubFileReports &&SubFiles,
522*5f757f3fSDimitry Andric                                    SubDirReports &&SubDirs,
523*5f757f3fSDimitry Andric                                    FileCoverageSummary &&SubTotals) override {
524*5f757f3fSDimitry Andric     auto &LCPath = SubTotals.Name;
525*5f757f3fSDimitry Andric     assert(Options.hasOutputDirectory() &&
526*5f757f3fSDimitry Andric            "No output directory for index file");
527*5f757f3fSDimitry Andric 
528*5f757f3fSDimitry Andric     SmallString<128> OSPath = LCPath;
529*5f757f3fSDimitry Andric     sys::path::append(OSPath, "index");
530*5f757f3fSDimitry Andric     auto OSOrErr = Printer.createOutputStream(OSPath, "html",
531*5f757f3fSDimitry Andric                                               /*InToplevel=*/false);
532*5f757f3fSDimitry Andric     if (auto E = OSOrErr.takeError())
533*5f757f3fSDimitry Andric       return E;
534*5f757f3fSDimitry Andric     auto OS = std::move(OSOrErr.get());
535*5f757f3fSDimitry Andric     raw_ostream &OSRef = *OS.get();
536*5f757f3fSDimitry Andric 
537*5f757f3fSDimitry Andric     auto IndexHtmlPath = Printer.getOutputPath((LCPath + "index").str(), "html",
538*5f757f3fSDimitry Andric                                                /*InToplevel=*/false);
539*5f757f3fSDimitry Andric     emitPrelude(OSRef, Options, getPathToStyle(IndexHtmlPath));
540*5f757f3fSDimitry Andric 
541*5f757f3fSDimitry Andric     auto NavLink = buildTitleLinks(LCPath);
542*5f757f3fSDimitry Andric     Printer.emitReportHeader(OSRef, "Coverage Report (" + NavLink + ")");
543*5f757f3fSDimitry Andric 
544*5f757f3fSDimitry Andric     std::vector<const FileCoverageSummary *> EmptyFiles;
545*5f757f3fSDimitry Andric 
546*5f757f3fSDimitry Andric     // Make directories at the top of the table.
547*5f757f3fSDimitry Andric     for (auto &&SubDir : SubDirs) {
548*5f757f3fSDimitry Andric       auto &Report = SubDir.second.first;
549*5f757f3fSDimitry Andric       if (!Report.FunctionCoverage.getNumFunctions())
550*5f757f3fSDimitry Andric         EmptyFiles.push_back(&Report);
551*5f757f3fSDimitry Andric       else
552*5f757f3fSDimitry Andric         emitTableRow(OSRef, Options, buildRelLinkToFile(Report.Name), Report,
553*5f757f3fSDimitry Andric                      /*IsTotals=*/false);
554*5f757f3fSDimitry Andric     }
555*5f757f3fSDimitry Andric 
556*5f757f3fSDimitry Andric     for (auto &&SubFile : SubFiles) {
557*5f757f3fSDimitry Andric       auto &Report = SubFile.second;
558*5f757f3fSDimitry Andric       if (!Report.FunctionCoverage.getNumFunctions())
559*5f757f3fSDimitry Andric         EmptyFiles.push_back(&Report);
560*5f757f3fSDimitry Andric       else
561*5f757f3fSDimitry Andric         emitTableRow(OSRef, Options, buildRelLinkToFile(Report.Name), Report,
562*5f757f3fSDimitry Andric                      /*IsTotals=*/false);
563*5f757f3fSDimitry Andric     }
564*5f757f3fSDimitry Andric 
565*5f757f3fSDimitry Andric     // Emit the totals row.
566*5f757f3fSDimitry Andric     emitTableRow(OSRef, Options, "Totals", SubTotals, /*IsTotals=*/false);
567*5f757f3fSDimitry Andric     OSRef << EndTable << EndCenteredDiv;
568*5f757f3fSDimitry Andric 
569*5f757f3fSDimitry Andric     // Emit links to files which don't contain any functions. These are normally
570*5f757f3fSDimitry Andric     // not very useful, but could be relevant for code which abuses the
571*5f757f3fSDimitry Andric     // preprocessor.
572*5f757f3fSDimitry Andric     if (!EmptyFiles.empty()) {
573*5f757f3fSDimitry Andric       OSRef << tag("p", "Files which contain no functions. (These "
574*5f757f3fSDimitry Andric                         "files contain code pulled into other files "
575*5f757f3fSDimitry Andric                         "by the preprocessor.)\n");
576*5f757f3fSDimitry Andric       OSRef << BeginCenteredDiv << BeginTable;
577*5f757f3fSDimitry Andric       for (auto FCS : EmptyFiles) {
578*5f757f3fSDimitry Andric         auto Link = buildRelLinkToFile(FCS->Name);
579*5f757f3fSDimitry Andric         OSRef << tag("tr", tag("td", tag("pre", Link)), "light-row") << '\n';
580*5f757f3fSDimitry Andric       }
581*5f757f3fSDimitry Andric       OSRef << EndTable << EndCenteredDiv;
582*5f757f3fSDimitry Andric     }
583*5f757f3fSDimitry Andric 
584*5f757f3fSDimitry Andric     // Emit epilog.
585*5f757f3fSDimitry Andric     OSRef << tag("h5", escape(Options.getLLVMVersionString(), Options));
586*5f757f3fSDimitry Andric     emitEpilog(OSRef);
587*5f757f3fSDimitry Andric 
588*5f757f3fSDimitry Andric     return Error::success();
589*5f757f3fSDimitry Andric   }
590*5f757f3fSDimitry Andric 
591*5f757f3fSDimitry Andric   /// Make a title with hyperlinks to the index.html files of each hierarchy
592*5f757f3fSDimitry Andric   /// of the report.
593*5f757f3fSDimitry Andric   std::string buildTitleLinks(StringRef LCPath) const {
594*5f757f3fSDimitry Andric     // For each report level in LCPStack, extract the path component and
595*5f757f3fSDimitry Andric     // calculate the number of "../" relative to current LCPath.
596*5f757f3fSDimitry Andric     SmallVector<std::pair<SmallString<128>, unsigned>, 16> Components;
597*5f757f3fSDimitry Andric 
598*5f757f3fSDimitry Andric     auto Iter = LCPStack.begin(), IterE = LCPStack.end();
599*5f757f3fSDimitry Andric     SmallString<128> RootPath;
600*5f757f3fSDimitry Andric     if (*Iter == 0) {
601*5f757f3fSDimitry Andric       // If llvm-cov works on relative coverage mapping data, the LCP of
602*5f757f3fSDimitry Andric       // all source file paths can be 0, which makes the title path empty.
603*5f757f3fSDimitry Andric       // As we like adding a slash at the back of the path to indicate a
604*5f757f3fSDimitry Andric       // directory, in this case, we use "." as the root path to make it
605*5f757f3fSDimitry Andric       // not be confused with the root path "/".
606*5f757f3fSDimitry Andric       RootPath = ".";
607*5f757f3fSDimitry Andric     } else {
608*5f757f3fSDimitry Andric       RootPath = LCPath.substr(0, *Iter);
609*5f757f3fSDimitry Andric       sys::path::native(RootPath);
610*5f757f3fSDimitry Andric       sys::path::remove_dots(RootPath, /*remove_dot_dot=*/true);
611*5f757f3fSDimitry Andric     }
612*5f757f3fSDimitry Andric     Components.emplace_back(std::move(RootPath), 0);
613*5f757f3fSDimitry Andric 
614*5f757f3fSDimitry Andric     for (auto Last = *Iter; ++Iter != IterE; Last = *Iter) {
615*5f757f3fSDimitry Andric       SmallString<128> SubPath = LCPath.substr(Last, *Iter - Last);
616*5f757f3fSDimitry Andric       sys::path::native(SubPath);
617*5f757f3fSDimitry Andric       sys::path::remove_dots(SubPath, /*remove_dot_dot=*/true);
618*5f757f3fSDimitry Andric       auto Level = unsigned(SubPath.count(sys::path::get_separator())) + 1;
619*5f757f3fSDimitry Andric       Components.back().second += Level;
620*5f757f3fSDimitry Andric       Components.emplace_back(std::move(SubPath), Level);
621*5f757f3fSDimitry Andric     }
622*5f757f3fSDimitry Andric 
623*5f757f3fSDimitry Andric     // Then we make the title accroding to Components.
624*5f757f3fSDimitry Andric     std::string S;
625*5f757f3fSDimitry Andric     for (auto I = Components.begin(), E = Components.end();;) {
626*5f757f3fSDimitry Andric       auto &Name = I->first;
627*5f757f3fSDimitry Andric       if (++I == E) {
628*5f757f3fSDimitry Andric         S += a("./index.html", Name);
629*5f757f3fSDimitry Andric         S += sys::path::get_separator();
630*5f757f3fSDimitry Andric         break;
631*5f757f3fSDimitry Andric       }
632*5f757f3fSDimitry Andric 
633*5f757f3fSDimitry Andric       SmallString<128> Link;
634*5f757f3fSDimitry Andric       for (unsigned J = I->second; J > 0; --J)
635*5f757f3fSDimitry Andric         Link += "../";
636*5f757f3fSDimitry Andric       Link += "index.html";
637*5f757f3fSDimitry Andric       S += a(Link, Name);
638*5f757f3fSDimitry Andric       S += sys::path::get_separator();
639*5f757f3fSDimitry Andric     }
640*5f757f3fSDimitry Andric     return S;
641*5f757f3fSDimitry Andric   }
642*5f757f3fSDimitry Andric 
643*5f757f3fSDimitry Andric   std::string buildRelLinkToFile(StringRef RelPath) const {
644*5f757f3fSDimitry Andric     SmallString<128> LinkTextStr(RelPath);
645*5f757f3fSDimitry Andric     sys::path::native(LinkTextStr);
646*5f757f3fSDimitry Andric 
647*5f757f3fSDimitry Andric     // remove_dots will remove trailing slash, so we need to check before it.
648*5f757f3fSDimitry Andric     auto IsDir = LinkTextStr.ends_with(sys::path::get_separator());
649*5f757f3fSDimitry Andric     sys::path::remove_dots(LinkTextStr, /*remove_dot_dot=*/true);
650*5f757f3fSDimitry Andric 
651*5f757f3fSDimitry Andric     SmallString<128> LinkTargetStr(LinkTextStr);
652*5f757f3fSDimitry Andric     if (IsDir) {
653*5f757f3fSDimitry Andric       LinkTextStr += sys::path::get_separator();
654*5f757f3fSDimitry Andric       sys::path::append(LinkTargetStr, "index.html");
655*5f757f3fSDimitry Andric     } else {
656*5f757f3fSDimitry Andric       LinkTargetStr += ".html";
657*5f757f3fSDimitry Andric     }
658*5f757f3fSDimitry Andric 
659*5f757f3fSDimitry Andric     auto LinkText = escape(LinkTextStr, Options);
660*5f757f3fSDimitry Andric     auto LinkTarget = escape(LinkTargetStr, Options);
661*5f757f3fSDimitry Andric     return a(LinkTarget, LinkText);
662*5f757f3fSDimitry Andric   }
663*5f757f3fSDimitry Andric };
664*5f757f3fSDimitry Andric 
665*5f757f3fSDimitry Andric Error CoveragePrinterHTMLDirectory::createIndexFile(
666*5f757f3fSDimitry Andric     ArrayRef<std::string> SourceFiles, const CoverageMapping &Coverage,
667*5f757f3fSDimitry Andric     const CoverageFiltersMatchAll &Filters) {
668*5f757f3fSDimitry Andric   // The createSubIndexFile function only works when SourceFiles is
669*5f757f3fSDimitry Andric   // more than one. So we fallback to CoveragePrinterHTML when it is.
670*5f757f3fSDimitry Andric   if (SourceFiles.size() <= 1)
671*5f757f3fSDimitry Andric     return CoveragePrinterHTML::createIndexFile(SourceFiles, Coverage, Filters);
672*5f757f3fSDimitry Andric 
673*5f757f3fSDimitry Andric   // Emit the default stylesheet.
674*5f757f3fSDimitry Andric   if (Error E = emitStyleSheet())
675*5f757f3fSDimitry Andric     return E;
676*5f757f3fSDimitry Andric 
677*5f757f3fSDimitry Andric   // Emit index files in every subdirectory.
678*5f757f3fSDimitry Andric   Reporter Report(*this, Coverage, Filters);
679*5f757f3fSDimitry Andric   auto TotalsOrErr = Report.prepareDirectoryReports(SourceFiles);
680*5f757f3fSDimitry Andric   if (auto E = TotalsOrErr.takeError())
681*5f757f3fSDimitry Andric     return E;
682*5f757f3fSDimitry Andric   auto &LCPath = TotalsOrErr->Name;
683*5f757f3fSDimitry Andric 
684*5f757f3fSDimitry Andric   // Emit the top level index file. Top level index file is just a redirection
685*5f757f3fSDimitry Andric   // to the index file in the LCP directory.
686*5f757f3fSDimitry Andric   auto OSOrErr = createOutputStream("index", "html", /*InToplevel=*/true);
687*5f757f3fSDimitry Andric   if (auto E = OSOrErr.takeError())
688*5f757f3fSDimitry Andric     return E;
689*5f757f3fSDimitry Andric   auto OS = std::move(OSOrErr.get());
690*5f757f3fSDimitry Andric   auto LCPIndexFilePath =
691*5f757f3fSDimitry Andric       getOutputPath((LCPath + "index").str(), "html", /*InToplevel=*/false);
692*5f757f3fSDimitry Andric   *OS.get() << R"(<!DOCTYPE html>
693*5f757f3fSDimitry Andric   <html>
694*5f757f3fSDimitry Andric     <head>
695*5f757f3fSDimitry Andric       <meta http-equiv="Refresh" content="0; url=')"
696*5f757f3fSDimitry Andric             << LCPIndexFilePath << R"('" />
697*5f757f3fSDimitry Andric     </head>
698*5f757f3fSDimitry Andric     <body></body>
699*5f757f3fSDimitry Andric   </html>
700*5f757f3fSDimitry Andric   )";
701*5f757f3fSDimitry Andric 
702*5f757f3fSDimitry Andric   return Error::success();
703*5f757f3fSDimitry Andric }
704*5f757f3fSDimitry Andric 
7050b57cec5SDimitry Andric void SourceCoverageViewHTML::renderViewHeader(raw_ostream &OS) {
7060b57cec5SDimitry Andric   OS << BeginCenteredDiv << BeginTable;
7070b57cec5SDimitry Andric }
7080b57cec5SDimitry Andric 
7090b57cec5SDimitry Andric void SourceCoverageViewHTML::renderViewFooter(raw_ostream &OS) {
7100b57cec5SDimitry Andric   OS << EndTable << EndCenteredDiv;
7110b57cec5SDimitry Andric }
7120b57cec5SDimitry Andric 
7130b57cec5SDimitry Andric void SourceCoverageViewHTML::renderSourceName(raw_ostream &OS, bool WholeFile) {
7140b57cec5SDimitry Andric   OS << BeginSourceNameDiv << tag("pre", escape(getSourceName(), getOptions()))
7150b57cec5SDimitry Andric      << EndSourceNameDiv;
7160b57cec5SDimitry Andric }
7170b57cec5SDimitry Andric 
7180b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLinePrefix(raw_ostream &OS, unsigned) {
7190b57cec5SDimitry Andric   OS << "<tr>";
7200b57cec5SDimitry Andric }
7210b57cec5SDimitry Andric 
7220b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLineSuffix(raw_ostream &OS, unsigned) {
7230b57cec5SDimitry Andric   // If this view has sub-views, renderLine() cannot close the view's cell.
7240b57cec5SDimitry Andric   // Take care of it here, after all sub-views have been rendered.
7250b57cec5SDimitry Andric   if (hasSubViews())
7260b57cec5SDimitry Andric     OS << EndCodeTD;
7270b57cec5SDimitry Andric   OS << "</tr>";
7280b57cec5SDimitry Andric }
7290b57cec5SDimitry Andric 
7300b57cec5SDimitry Andric void SourceCoverageViewHTML::renderViewDivider(raw_ostream &, unsigned) {
7310b57cec5SDimitry Andric   // The table-based output makes view dividers unnecessary.
7320b57cec5SDimitry Andric }
7330b57cec5SDimitry Andric 
7340b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLine(raw_ostream &OS, LineRef L,
7350b57cec5SDimitry Andric                                         const LineCoverageStats &LCS,
7360b57cec5SDimitry Andric                                         unsigned ExpansionCol, unsigned) {
7370b57cec5SDimitry Andric   StringRef Line = L.Line;
7380b57cec5SDimitry Andric   unsigned LineNo = L.LineNo;
7390b57cec5SDimitry Andric 
7400b57cec5SDimitry Andric   // Steps for handling text-escaping, highlighting, and tooltip creation:
7410b57cec5SDimitry Andric   //
7420b57cec5SDimitry Andric   // 1. Split the line into N+1 snippets, where N = |Segments|. The first
7430b57cec5SDimitry Andric   //    snippet starts from Col=1 and ends at the start of the first segment.
7440b57cec5SDimitry Andric   //    The last snippet starts at the last mapped column in the line and ends
7450b57cec5SDimitry Andric   //    at the end of the line. Both are required but may be empty.
7460b57cec5SDimitry Andric 
7470b57cec5SDimitry Andric   SmallVector<std::string, 8> Snippets;
7480b57cec5SDimitry Andric   CoverageSegmentArray Segments = LCS.getLineSegments();
7490b57cec5SDimitry Andric 
7500b57cec5SDimitry Andric   unsigned LCol = 1;
7510b57cec5SDimitry Andric   auto Snip = [&](unsigned Start, unsigned Len) {
7525ffd83dbSDimitry Andric     Snippets.push_back(std::string(Line.substr(Start, Len)));
7530b57cec5SDimitry Andric     LCol += Len;
7540b57cec5SDimitry Andric   };
7550b57cec5SDimitry Andric 
7560b57cec5SDimitry Andric   Snip(LCol - 1, Segments.empty() ? 0 : (Segments.front()->Col - 1));
7570b57cec5SDimitry Andric 
7580b57cec5SDimitry Andric   for (unsigned I = 1, E = Segments.size(); I < E; ++I)
7590b57cec5SDimitry Andric     Snip(LCol - 1, Segments[I]->Col - LCol);
7600b57cec5SDimitry Andric 
7610b57cec5SDimitry Andric   // |Line| + 1 is needed to avoid underflow when, e.g |Line| = 0 and LCol = 1.
7620b57cec5SDimitry Andric   Snip(LCol - 1, Line.size() + 1 - LCol);
7630b57cec5SDimitry Andric 
7640b57cec5SDimitry Andric   // 2. Escape all of the snippets.
7650b57cec5SDimitry Andric 
7660b57cec5SDimitry Andric   for (unsigned I = 0, E = Snippets.size(); I < E; ++I)
7670b57cec5SDimitry Andric     Snippets[I] = escape(Snippets[I], getOptions());
7680b57cec5SDimitry Andric 
7690b57cec5SDimitry Andric   // 3. Use \p WrappedSegment to set the highlight for snippet 0. Use segment
7700b57cec5SDimitry Andric   //    1 to set the highlight for snippet 2, segment 2 to set the highlight for
7710b57cec5SDimitry Andric   //    snippet 3, and so on.
7720b57cec5SDimitry Andric 
773bdd1243dSDimitry Andric   std::optional<StringRef> Color;
7740b57cec5SDimitry Andric   SmallVector<std::pair<unsigned, unsigned>, 2> HighlightedRanges;
7750b57cec5SDimitry Andric   auto Highlight = [&](const std::string &Snippet, unsigned LC, unsigned RC) {
7760b57cec5SDimitry Andric     if (getOptions().Debug)
7770b57cec5SDimitry Andric       HighlightedRanges.emplace_back(LC, RC);
77881ad6265SDimitry Andric     return tag("span", Snippet, std::string(*Color));
7790b57cec5SDimitry Andric   };
7800b57cec5SDimitry Andric 
7810b57cec5SDimitry Andric   auto CheckIfUncovered = [&](const CoverageSegment *S) {
7820b57cec5SDimitry Andric     return S && (!S->IsGapRegion || (Color && *Color == "red")) &&
7830b57cec5SDimitry Andric            S->HasCount && S->Count == 0;
7840b57cec5SDimitry Andric   };
7850b57cec5SDimitry Andric 
7860b57cec5SDimitry Andric   if (CheckIfUncovered(LCS.getWrappedSegment())) {
7870b57cec5SDimitry Andric     Color = "red";
7880b57cec5SDimitry Andric     if (!Snippets[0].empty())
7890b57cec5SDimitry Andric       Snippets[0] = Highlight(Snippets[0], 1, 1 + Snippets[0].size());
7900b57cec5SDimitry Andric   }
7910b57cec5SDimitry Andric 
7920b57cec5SDimitry Andric   for (unsigned I = 0, E = Segments.size(); I < E; ++I) {
7930b57cec5SDimitry Andric     const auto *CurSeg = Segments[I];
7940b57cec5SDimitry Andric     if (CheckIfUncovered(CurSeg))
7950b57cec5SDimitry Andric       Color = "red";
7960b57cec5SDimitry Andric     else if (CurSeg->Col == ExpansionCol)
7970b57cec5SDimitry Andric       Color = "cyan";
7980b57cec5SDimitry Andric     else
799bdd1243dSDimitry Andric       Color = std::nullopt;
8000b57cec5SDimitry Andric 
80181ad6265SDimitry Andric     if (Color)
8020b57cec5SDimitry Andric       Snippets[I + 1] = Highlight(Snippets[I + 1], CurSeg->Col,
8030b57cec5SDimitry Andric                                   CurSeg->Col + Snippets[I + 1].size());
8040b57cec5SDimitry Andric   }
8050b57cec5SDimitry Andric 
80681ad6265SDimitry Andric   if (Color && Segments.empty())
8070b57cec5SDimitry Andric     Snippets.back() = Highlight(Snippets.back(), 1, 1 + Snippets.back().size());
8080b57cec5SDimitry Andric 
8090b57cec5SDimitry Andric   if (getOptions().Debug) {
8100b57cec5SDimitry Andric     for (const auto &Range : HighlightedRanges) {
8110b57cec5SDimitry Andric       errs() << "Highlighted line " << LineNo << ", " << Range.first << " -> ";
8120b57cec5SDimitry Andric       if (Range.second == 0)
8130b57cec5SDimitry Andric         errs() << "?";
8140b57cec5SDimitry Andric       else
8150b57cec5SDimitry Andric         errs() << Range.second;
8160b57cec5SDimitry Andric       errs() << "\n";
8170b57cec5SDimitry Andric     }
8180b57cec5SDimitry Andric   }
8190b57cec5SDimitry Andric 
8200b57cec5SDimitry Andric   // 4. Snippets[1:N+1] correspond to \p Segments[0:N]: use these to generate
8210b57cec5SDimitry Andric   //    sub-line region count tooltips if needed.
8220b57cec5SDimitry Andric 
8230b57cec5SDimitry Andric   if (shouldRenderRegionMarkers(LCS)) {
8240b57cec5SDimitry Andric     // Just consider the segments which start *and* end on this line.
8250b57cec5SDimitry Andric     for (unsigned I = 0, E = Segments.size() - 1; I < E; ++I) {
8260b57cec5SDimitry Andric       const auto *CurSeg = Segments[I];
8270b57cec5SDimitry Andric       if (!CurSeg->IsRegionEntry)
8280b57cec5SDimitry Andric         continue;
8290b57cec5SDimitry Andric       if (CurSeg->Count == LCS.getExecutionCount())
8300b57cec5SDimitry Andric         continue;
8310b57cec5SDimitry Andric 
8320b57cec5SDimitry Andric       Snippets[I + 1] =
8330b57cec5SDimitry Andric           tag("div", Snippets[I + 1] + tag("span", formatCount(CurSeg->Count),
8340b57cec5SDimitry Andric                                            "tooltip-content"),
8350b57cec5SDimitry Andric               "tooltip");
8360b57cec5SDimitry Andric 
8370b57cec5SDimitry Andric       if (getOptions().Debug)
8380b57cec5SDimitry Andric         errs() << "Marker at " << CurSeg->Line << ":" << CurSeg->Col << " = "
8390b57cec5SDimitry Andric                << formatCount(CurSeg->Count) << "\n";
8400b57cec5SDimitry Andric     }
8410b57cec5SDimitry Andric   }
8420b57cec5SDimitry Andric 
8430b57cec5SDimitry Andric   OS << BeginCodeTD;
8440b57cec5SDimitry Andric   OS << BeginPre;
8450b57cec5SDimitry Andric   for (const auto &Snippet : Snippets)
8460b57cec5SDimitry Andric     OS << Snippet;
8470b57cec5SDimitry Andric   OS << EndPre;
8480b57cec5SDimitry Andric 
8490b57cec5SDimitry Andric   // If there are no sub-views left to attach to this cell, end the cell.
8500b57cec5SDimitry Andric   // Otherwise, end it after the sub-views are rendered (renderLineSuffix()).
8510b57cec5SDimitry Andric   if (!hasSubViews())
8520b57cec5SDimitry Andric     OS << EndCodeTD;
8530b57cec5SDimitry Andric }
8540b57cec5SDimitry Andric 
8550b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLineCoverageColumn(
8560b57cec5SDimitry Andric     raw_ostream &OS, const LineCoverageStats &Line) {
857e8d8bef9SDimitry Andric   std::string Count;
8580b57cec5SDimitry Andric   if (Line.isMapped())
8590b57cec5SDimitry Andric     Count = tag("pre", formatCount(Line.getExecutionCount()));
8600b57cec5SDimitry Andric   std::string CoverageClass =
8610b57cec5SDimitry Andric       (Line.getExecutionCount() > 0) ? "covered-line" : "uncovered-line";
8620b57cec5SDimitry Andric   OS << tag("td", Count, CoverageClass);
8630b57cec5SDimitry Andric }
8640b57cec5SDimitry Andric 
8650b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLineNumberColumn(raw_ostream &OS,
8660b57cec5SDimitry Andric                                                     unsigned LineNo) {
8670b57cec5SDimitry Andric   std::string LineNoStr = utostr(uint64_t(LineNo));
8680b57cec5SDimitry Andric   std::string TargetName = "L" + LineNoStr;
8690b57cec5SDimitry Andric   OS << tag("td", a("#" + TargetName, tag("pre", LineNoStr), TargetName),
8700b57cec5SDimitry Andric             "line-number");
8710b57cec5SDimitry Andric }
8720b57cec5SDimitry Andric 
8730b57cec5SDimitry Andric void SourceCoverageViewHTML::renderRegionMarkers(raw_ostream &,
8740b57cec5SDimitry Andric                                                  const LineCoverageStats &Line,
8750b57cec5SDimitry Andric                                                  unsigned) {
8760b57cec5SDimitry Andric   // Region markers are rendered in-line using tooltips.
8770b57cec5SDimitry Andric }
8780b57cec5SDimitry Andric 
8790b57cec5SDimitry Andric void SourceCoverageViewHTML::renderExpansionSite(raw_ostream &OS, LineRef L,
8800b57cec5SDimitry Andric                                                  const LineCoverageStats &LCS,
8810b57cec5SDimitry Andric                                                  unsigned ExpansionCol,
8820b57cec5SDimitry Andric                                                  unsigned ViewDepth) {
8830b57cec5SDimitry Andric   // Render the line containing the expansion site. No extra formatting needed.
8840b57cec5SDimitry Andric   renderLine(OS, L, LCS, ExpansionCol, ViewDepth);
8850b57cec5SDimitry Andric }
8860b57cec5SDimitry Andric 
8870b57cec5SDimitry Andric void SourceCoverageViewHTML::renderExpansionView(raw_ostream &OS,
8880b57cec5SDimitry Andric                                                  ExpansionView &ESV,
8890b57cec5SDimitry Andric                                                  unsigned ViewDepth) {
8900b57cec5SDimitry Andric   OS << BeginExpansionDiv;
8910b57cec5SDimitry Andric   ESV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/false,
8920b57cec5SDimitry Andric                   /*ShowTitle=*/false, ViewDepth + 1);
8930b57cec5SDimitry Andric   OS << EndExpansionDiv;
8940b57cec5SDimitry Andric }
8950b57cec5SDimitry Andric 
896e8d8bef9SDimitry Andric void SourceCoverageViewHTML::renderBranchView(raw_ostream &OS, BranchView &BRV,
897e8d8bef9SDimitry Andric                                               unsigned ViewDepth) {
898e8d8bef9SDimitry Andric   // Render the child subview.
899e8d8bef9SDimitry Andric   if (getOptions().Debug)
900e8d8bef9SDimitry Andric     errs() << "Branch at line " << BRV.getLine() << '\n';
901e8d8bef9SDimitry Andric 
902e8d8bef9SDimitry Andric   OS << BeginExpansionDiv;
903e8d8bef9SDimitry Andric   OS << BeginPre;
904e8d8bef9SDimitry Andric   for (const auto &R : BRV.Regions) {
905e8d8bef9SDimitry Andric     // Calculate TruePercent and False Percent.
906e8d8bef9SDimitry Andric     double TruePercent = 0.0;
907e8d8bef9SDimitry Andric     double FalsePercent = 0.0;
908*5f757f3fSDimitry Andric     // FIXME: It may overflow when the data is too large, but I have not
909*5f757f3fSDimitry Andric     // encountered it in actual use, and not sure whether to use __uint128_t.
910*5f757f3fSDimitry Andric     uint64_t Total = R.ExecutionCount + R.FalseExecutionCount;
911e8d8bef9SDimitry Andric 
912e8d8bef9SDimitry Andric     if (!getOptions().ShowBranchCounts && Total != 0) {
913e8d8bef9SDimitry Andric       TruePercent = ((double)(R.ExecutionCount) / (double)Total) * 100.0;
914e8d8bef9SDimitry Andric       FalsePercent = ((double)(R.FalseExecutionCount) / (double)Total) * 100.0;
915e8d8bef9SDimitry Andric     }
916e8d8bef9SDimitry Andric 
917e8d8bef9SDimitry Andric     // Display Line + Column.
918e8d8bef9SDimitry Andric     std::string LineNoStr = utostr(uint64_t(R.LineStart));
919e8d8bef9SDimitry Andric     std::string ColNoStr = utostr(uint64_t(R.ColumnStart));
920e8d8bef9SDimitry Andric     std::string TargetName = "L" + LineNoStr;
921e8d8bef9SDimitry Andric 
922e8d8bef9SDimitry Andric     OS << "  Branch (";
923e8d8bef9SDimitry Andric     OS << tag("span",
924e8d8bef9SDimitry Andric               a("#" + TargetName, tag("span", LineNoStr + ":" + ColNoStr),
925e8d8bef9SDimitry Andric                 TargetName),
926e8d8bef9SDimitry Andric               "line-number") +
927e8d8bef9SDimitry Andric               "): [";
928e8d8bef9SDimitry Andric 
929e8d8bef9SDimitry Andric     if (R.Folded) {
930e8d8bef9SDimitry Andric       OS << "Folded - Ignored]\n";
931e8d8bef9SDimitry Andric       continue;
932e8d8bef9SDimitry Andric     }
933e8d8bef9SDimitry Andric 
934e8d8bef9SDimitry Andric     // Display TrueCount or TruePercent.
935e8d8bef9SDimitry Andric     std::string TrueColor = R.ExecutionCount ? "None" : "red";
936e8d8bef9SDimitry Andric     std::string TrueCovClass =
937e8d8bef9SDimitry Andric         (R.ExecutionCount > 0) ? "covered-line" : "uncovered-line";
938e8d8bef9SDimitry Andric 
939e8d8bef9SDimitry Andric     OS << tag("span", "True", TrueColor);
940e8d8bef9SDimitry Andric     OS << ": ";
941e8d8bef9SDimitry Andric     if (getOptions().ShowBranchCounts)
942e8d8bef9SDimitry Andric       OS << tag("span", formatCount(R.ExecutionCount), TrueCovClass) << ", ";
943e8d8bef9SDimitry Andric     else
944e8d8bef9SDimitry Andric       OS << format("%0.2f", TruePercent) << "%, ";
945e8d8bef9SDimitry Andric 
946e8d8bef9SDimitry Andric     // Display FalseCount or FalsePercent.
947e8d8bef9SDimitry Andric     std::string FalseColor = R.FalseExecutionCount ? "None" : "red";
948e8d8bef9SDimitry Andric     std::string FalseCovClass =
949e8d8bef9SDimitry Andric         (R.FalseExecutionCount > 0) ? "covered-line" : "uncovered-line";
950e8d8bef9SDimitry Andric 
951e8d8bef9SDimitry Andric     OS << tag("span", "False", FalseColor);
952e8d8bef9SDimitry Andric     OS << ": ";
953e8d8bef9SDimitry Andric     if (getOptions().ShowBranchCounts)
954e8d8bef9SDimitry Andric       OS << tag("span", formatCount(R.FalseExecutionCount), FalseCovClass);
955e8d8bef9SDimitry Andric     else
956e8d8bef9SDimitry Andric       OS << format("%0.2f", FalsePercent) << "%";
957e8d8bef9SDimitry Andric 
958e8d8bef9SDimitry Andric     OS << "]\n";
959e8d8bef9SDimitry Andric   }
960e8d8bef9SDimitry Andric   OS << EndPre;
961e8d8bef9SDimitry Andric   OS << EndExpansionDiv;
962e8d8bef9SDimitry Andric }
963e8d8bef9SDimitry Andric 
964*5f757f3fSDimitry Andric void SourceCoverageViewHTML::renderMCDCView(raw_ostream &OS, MCDCView &MRV,
965*5f757f3fSDimitry Andric                                             unsigned ViewDepth) {
966*5f757f3fSDimitry Andric   for (auto &Record : MRV.Records) {
967*5f757f3fSDimitry Andric     OS << BeginExpansionDiv;
968*5f757f3fSDimitry Andric     OS << BeginPre;
969*5f757f3fSDimitry Andric     OS << "  MC/DC Decision Region (";
970*5f757f3fSDimitry Andric 
971*5f757f3fSDimitry Andric     // Display Line + Column information.
972*5f757f3fSDimitry Andric     const CounterMappingRegion &DecisionRegion = Record.getDecisionRegion();
973*5f757f3fSDimitry Andric     std::string LineNoStr = Twine(DecisionRegion.LineStart).str();
974*5f757f3fSDimitry Andric     std::string ColNoStr = Twine(DecisionRegion.ColumnStart).str();
975*5f757f3fSDimitry Andric     std::string TargetName = "L" + LineNoStr;
976*5f757f3fSDimitry Andric     OS << tag("span",
977*5f757f3fSDimitry Andric               a("#" + TargetName, tag("span", LineNoStr + ":" + ColNoStr),
978*5f757f3fSDimitry Andric                 TargetName),
979*5f757f3fSDimitry Andric               "line-number") +
980*5f757f3fSDimitry Andric               ") to (";
981*5f757f3fSDimitry Andric     LineNoStr = utostr(uint64_t(DecisionRegion.LineEnd));
982*5f757f3fSDimitry Andric     ColNoStr = utostr(uint64_t(DecisionRegion.ColumnEnd));
983*5f757f3fSDimitry Andric     OS << tag("span",
984*5f757f3fSDimitry Andric               a("#" + TargetName, tag("span", LineNoStr + ":" + ColNoStr),
985*5f757f3fSDimitry Andric                 TargetName),
986*5f757f3fSDimitry Andric               "line-number") +
987*5f757f3fSDimitry Andric               ")\n\n";
988*5f757f3fSDimitry Andric 
989*5f757f3fSDimitry Andric     // Display MC/DC Information.
990*5f757f3fSDimitry Andric     OS << "  Number of Conditions: " << Record.getNumConditions() << "\n";
991*5f757f3fSDimitry Andric     for (unsigned i = 0; i < Record.getNumConditions(); i++) {
992*5f757f3fSDimitry Andric       OS << "     " << Record.getConditionHeaderString(i);
993*5f757f3fSDimitry Andric     }
994*5f757f3fSDimitry Andric     OS << "\n";
995*5f757f3fSDimitry Andric     OS << "  Executed MC/DC Test Vectors:\n\n     ";
996*5f757f3fSDimitry Andric     OS << Record.getTestVectorHeaderString();
997*5f757f3fSDimitry Andric     for (unsigned i = 0; i < Record.getNumTestVectors(); i++)
998*5f757f3fSDimitry Andric       OS << Record.getTestVectorString(i);
999*5f757f3fSDimitry Andric     OS << "\n";
1000*5f757f3fSDimitry Andric     for (unsigned i = 0; i < Record.getNumConditions(); i++)
1001*5f757f3fSDimitry Andric       OS << Record.getConditionCoverageString(i);
1002*5f757f3fSDimitry Andric     OS << "  MC/DC Coverage for Expression: ";
1003*5f757f3fSDimitry Andric     OS << format("%0.2f", Record.getPercentCovered()) << "%\n";
1004*5f757f3fSDimitry Andric     OS << EndPre;
1005*5f757f3fSDimitry Andric     OS << EndExpansionDiv;
1006*5f757f3fSDimitry Andric   }
1007*5f757f3fSDimitry Andric   return;
1008*5f757f3fSDimitry Andric }
1009*5f757f3fSDimitry Andric 
10100b57cec5SDimitry Andric void SourceCoverageViewHTML::renderInstantiationView(raw_ostream &OS,
10110b57cec5SDimitry Andric                                                      InstantiationView &ISV,
10120b57cec5SDimitry Andric                                                      unsigned ViewDepth) {
10130b57cec5SDimitry Andric   OS << BeginExpansionDiv;
10140b57cec5SDimitry Andric   if (!ISV.View)
10150b57cec5SDimitry Andric     OS << BeginSourceNameDiv
10160b57cec5SDimitry Andric        << tag("pre",
10170b57cec5SDimitry Andric               escape("Unexecuted instantiation: " + ISV.FunctionName.str(),
10180b57cec5SDimitry Andric                      getOptions()))
10190b57cec5SDimitry Andric        << EndSourceNameDiv;
10200b57cec5SDimitry Andric   else
10210b57cec5SDimitry Andric     ISV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/true,
10220b57cec5SDimitry Andric                     /*ShowTitle=*/false, ViewDepth);
10230b57cec5SDimitry Andric   OS << EndExpansionDiv;
10240b57cec5SDimitry Andric }
10250b57cec5SDimitry Andric 
10260b57cec5SDimitry Andric void SourceCoverageViewHTML::renderTitle(raw_ostream &OS, StringRef Title) {
10270b57cec5SDimitry Andric   if (getOptions().hasProjectTitle())
10280b57cec5SDimitry Andric     OS << tag(ProjectTitleTag, escape(getOptions().ProjectTitle, getOptions()));
10290b57cec5SDimitry Andric   OS << tag(ReportTitleTag, escape(Title, getOptions()));
10300b57cec5SDimitry Andric   if (getOptions().hasCreatedTime())
10310b57cec5SDimitry Andric     OS << tag(CreatedTimeTag,
10320b57cec5SDimitry Andric               escape(getOptions().CreatedTimeStr, getOptions()));
10330b57cec5SDimitry Andric }
10340b57cec5SDimitry Andric 
10350b57cec5SDimitry Andric void SourceCoverageViewHTML::renderTableHeader(raw_ostream &OS,
10360b57cec5SDimitry Andric                                                unsigned FirstUncoveredLineNo,
10370b57cec5SDimitry Andric                                                unsigned ViewDepth) {
10380b57cec5SDimitry Andric   std::string SourceLabel;
10390b57cec5SDimitry Andric   if (FirstUncoveredLineNo == 0) {
10400b57cec5SDimitry Andric     SourceLabel = tag("td", tag("pre", "Source"));
10410b57cec5SDimitry Andric   } else {
10420b57cec5SDimitry Andric     std::string LinkTarget = "#L" + utostr(uint64_t(FirstUncoveredLineNo));
10430b57cec5SDimitry Andric     SourceLabel =
10440b57cec5SDimitry Andric         tag("td", tag("pre", "Source (" +
10450b57cec5SDimitry Andric                                  a(LinkTarget, "jump to first uncovered line") +
10460b57cec5SDimitry Andric                                  ")"));
10470b57cec5SDimitry Andric   }
10480b57cec5SDimitry Andric 
10490b57cec5SDimitry Andric   renderLinePrefix(OS, ViewDepth);
10500b57cec5SDimitry Andric   OS << tag("td", tag("pre", "Line")) << tag("td", tag("pre", "Count"))
10510b57cec5SDimitry Andric      << SourceLabel;
10520b57cec5SDimitry Andric   renderLineSuffix(OS, ViewDepth);
10530b57cec5SDimitry Andric }
1054