1 //===- SourceCoverageViewHTML.cpp - A html code coverage view -------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 /// 9 /// \file This file implements the html coverage renderer. 10 /// 11 //===----------------------------------------------------------------------===// 12 13 #include "SourceCoverageViewHTML.h" 14 #include "CoverageReport.h" 15 #include "llvm/ADT/SmallString.h" 16 #include "llvm/ADT/StringExtras.h" 17 #include "llvm/Support/Format.h" 18 #include "llvm/Support/Path.h" 19 #include "llvm/Support/ThreadPool.h" 20 #include <optional> 21 22 using namespace llvm; 23 24 namespace { 25 26 // Return a string with the special characters in \p Str escaped. 27 std::string escape(StringRef Str, const CoverageViewOptions &Opts) { 28 std::string TabExpandedResult; 29 unsigned ColNum = 0; // Record the column number. 30 for (char C : Str) { 31 if (C == '\t') { 32 // Replace '\t' with up to TabSize spaces. 33 unsigned NumSpaces = Opts.TabSize - (ColNum % Opts.TabSize); 34 TabExpandedResult.append(NumSpaces, ' '); 35 ColNum += NumSpaces; 36 } else { 37 TabExpandedResult += C; 38 if (C == '\n' || C == '\r') 39 ColNum = 0; 40 else 41 ++ColNum; 42 } 43 } 44 std::string EscapedHTML; 45 { 46 raw_string_ostream OS{EscapedHTML}; 47 printHTMLEscaped(TabExpandedResult, OS); 48 } 49 return EscapedHTML; 50 } 51 52 // Create a \p Name tag around \p Str, and optionally set its \p ClassName. 53 std::string tag(StringRef Name, StringRef Str, StringRef ClassName = "") { 54 std::string Tag = "<"; 55 Tag += Name; 56 if (!ClassName.empty()) { 57 Tag += " class='"; 58 Tag += ClassName; 59 Tag += "'"; 60 } 61 Tag += ">"; 62 Tag += Str; 63 Tag += "</"; 64 Tag += Name; 65 Tag += ">"; 66 return Tag; 67 } 68 69 // Create an anchor to \p Link with the label \p Str. 70 std::string a(StringRef Link, StringRef Str, StringRef TargetName = "") { 71 std::string Tag; 72 Tag += "<a "; 73 if (!TargetName.empty()) { 74 Tag += "name='"; 75 Tag += TargetName; 76 Tag += "' "; 77 } 78 Tag += "href='"; 79 Tag += Link; 80 Tag += "'>"; 81 Tag += Str; 82 Tag += "</a>"; 83 return Tag; 84 } 85 86 const char *BeginHeader = 87 "<head>" 88 "<meta name='viewport' content='width=device-width,initial-scale=1'>" 89 "<meta charset='UTF-8'>"; 90 91 const char *CSSForCoverage = 92 R"(.red { 93 background-color: #ffd0d0; 94 } 95 .cyan { 96 background-color: cyan; 97 } 98 body { 99 font-family: -apple-system, sans-serif; 100 } 101 pre { 102 margin-top: 0px !important; 103 margin-bottom: 0px !important; 104 } 105 .source-name-title { 106 padding: 5px 10px; 107 border-bottom: 1px solid #dbdbdb; 108 background-color: #eee; 109 line-height: 35px; 110 } 111 .centered { 112 display: table; 113 margin-left: left; 114 margin-right: auto; 115 border: 1px solid #dbdbdb; 116 border-radius: 3px; 117 } 118 .expansion-view { 119 background-color: rgba(0, 0, 0, 0); 120 margin-left: 0px; 121 margin-top: 5px; 122 margin-right: 5px; 123 margin-bottom: 5px; 124 border: 1px solid #dbdbdb; 125 border-radius: 3px; 126 } 127 table { 128 border-collapse: collapse; 129 } 130 .light-row { 131 background: #ffffff; 132 border: 1px solid #dbdbdb; 133 } 134 .light-row-bold { 135 background: #ffffff; 136 border: 1px solid #dbdbdb; 137 font-weight: bold; 138 } 139 .column-entry { 140 text-align: left; 141 } 142 .column-entry-bold { 143 font-weight: bold; 144 text-align: left; 145 } 146 .column-entry-yellow { 147 text-align: left; 148 background-color: #ffffd0; 149 } 150 .column-entry-yellow:hover { 151 background-color: #fffff0; 152 } 153 .column-entry-red { 154 text-align: left; 155 background-color: #ffd0d0; 156 } 157 .column-entry-red:hover { 158 background-color: #fff0f0; 159 } 160 .column-entry-green { 161 text-align: left; 162 background-color: #d0ffd0; 163 } 164 .column-entry-green:hover { 165 background-color: #f0fff0; 166 } 167 .line-number { 168 text-align: right; 169 color: #aaa; 170 } 171 .covered-line { 172 text-align: right; 173 color: #0080ff; 174 } 175 .uncovered-line { 176 text-align: right; 177 color: #ff3300; 178 } 179 .tooltip { 180 position: relative; 181 display: inline; 182 background-color: #b3e6ff; 183 text-decoration: none; 184 } 185 .tooltip span.tooltip-content { 186 position: absolute; 187 width: 100px; 188 margin-left: -50px; 189 color: #FFFFFF; 190 background: #000000; 191 height: 30px; 192 line-height: 30px; 193 text-align: center; 194 visibility: hidden; 195 border-radius: 6px; 196 } 197 .tooltip span.tooltip-content:after { 198 content: ''; 199 position: absolute; 200 top: 100%; 201 left: 50%; 202 margin-left: -8px; 203 width: 0; height: 0; 204 border-top: 8px solid #000000; 205 border-right: 8px solid transparent; 206 border-left: 8px solid transparent; 207 } 208 :hover.tooltip span.tooltip-content { 209 visibility: visible; 210 opacity: 0.8; 211 bottom: 30px; 212 left: 50%; 213 z-index: 999; 214 } 215 th, td { 216 vertical-align: top; 217 padding: 2px 8px; 218 border-collapse: collapse; 219 border-right: solid 1px #eee; 220 border-left: solid 1px #eee; 221 text-align: left; 222 } 223 td pre { 224 display: inline-block; 225 } 226 td:first-child { 227 border-left: none; 228 } 229 td:last-child { 230 border-right: none; 231 } 232 tr:hover { 233 background-color: #f0f0f0; 234 } 235 )"; 236 237 const char *EndHeader = "</head>"; 238 239 const char *BeginCenteredDiv = "<div class='centered'>"; 240 241 const char *EndCenteredDiv = "</div>"; 242 243 const char *BeginSourceNameDiv = "<div class='source-name-title'>"; 244 245 const char *EndSourceNameDiv = "</div>"; 246 247 const char *BeginCodeTD = "<td class='code'>"; 248 249 const char *EndCodeTD = "</td>"; 250 251 const char *BeginPre = "<pre>"; 252 253 const char *EndPre = "</pre>"; 254 255 const char *BeginExpansionDiv = "<div class='expansion-view'>"; 256 257 const char *EndExpansionDiv = "</div>"; 258 259 const char *BeginTable = "<table>"; 260 261 const char *EndTable = "</table>"; 262 263 const char *ProjectTitleTag = "h1"; 264 265 const char *ReportTitleTag = "h2"; 266 267 const char *CreatedTimeTag = "h4"; 268 269 std::string getPathToStyle(StringRef ViewPath) { 270 std::string PathToStyle; 271 std::string PathSep = std::string(sys::path::get_separator()); 272 unsigned NumSeps = ViewPath.count(PathSep); 273 for (unsigned I = 0, E = NumSeps; I < E; ++I) 274 PathToStyle += ".." + PathSep; 275 return PathToStyle + "style.css"; 276 } 277 278 void emitPrelude(raw_ostream &OS, const CoverageViewOptions &Opts, 279 const std::string &PathToStyle = "") { 280 OS << "<!doctype html>" 281 "<html>" 282 << BeginHeader; 283 284 // Link to a stylesheet if one is available. Otherwise, use the default style. 285 if (PathToStyle.empty()) 286 OS << "<style>" << CSSForCoverage << "</style>"; 287 else 288 OS << "<link rel='stylesheet' type='text/css' href='" 289 << escape(PathToStyle, Opts) << "'>"; 290 291 OS << EndHeader << "<body>"; 292 } 293 294 void emitTableRow(raw_ostream &OS, const CoverageViewOptions &Opts, 295 const std::string &FirstCol, const FileCoverageSummary &FCS, 296 bool IsTotals) { 297 SmallVector<std::string, 8> Columns; 298 299 // Format a coverage triple and add the result to the list of columns. 300 auto AddCoverageTripleToColumn = 301 [&Columns, &Opts](unsigned Hit, unsigned Total, float Pctg) { 302 std::string S; 303 { 304 raw_string_ostream RSO{S}; 305 if (Total) 306 RSO << format("%*.2f", 7, Pctg) << "% "; 307 else 308 RSO << "- "; 309 RSO << '(' << Hit << '/' << Total << ')'; 310 } 311 const char *CellClass = "column-entry-yellow"; 312 if (Pctg >= Opts.HighCovWatermark) 313 CellClass = "column-entry-green"; 314 else if (Pctg < Opts.LowCovWatermark) 315 CellClass = "column-entry-red"; 316 Columns.emplace_back(tag("td", tag("pre", S), CellClass)); 317 }; 318 319 Columns.emplace_back(tag("td", tag("pre", FirstCol))); 320 AddCoverageTripleToColumn(FCS.FunctionCoverage.getExecuted(), 321 FCS.FunctionCoverage.getNumFunctions(), 322 FCS.FunctionCoverage.getPercentCovered()); 323 if (Opts.ShowInstantiationSummary) 324 AddCoverageTripleToColumn(FCS.InstantiationCoverage.getExecuted(), 325 FCS.InstantiationCoverage.getNumFunctions(), 326 FCS.InstantiationCoverage.getPercentCovered()); 327 AddCoverageTripleToColumn(FCS.LineCoverage.getCovered(), 328 FCS.LineCoverage.getNumLines(), 329 FCS.LineCoverage.getPercentCovered()); 330 if (Opts.ShowRegionSummary) 331 AddCoverageTripleToColumn(FCS.RegionCoverage.getCovered(), 332 FCS.RegionCoverage.getNumRegions(), 333 FCS.RegionCoverage.getPercentCovered()); 334 if (Opts.ShowBranchSummary) 335 AddCoverageTripleToColumn(FCS.BranchCoverage.getCovered(), 336 FCS.BranchCoverage.getNumBranches(), 337 FCS.BranchCoverage.getPercentCovered()); 338 339 if (IsTotals) 340 OS << tag("tr", join(Columns.begin(), Columns.end(), ""), "light-row-bold"); 341 else 342 OS << tag("tr", join(Columns.begin(), Columns.end(), ""), "light-row"); 343 } 344 345 void emitEpilog(raw_ostream &OS) { 346 OS << "</body>" 347 << "</html>"; 348 } 349 350 } // anonymous namespace 351 352 Expected<CoveragePrinter::OwnedStream> 353 CoveragePrinterHTML::createViewFile(StringRef Path, bool InToplevel) { 354 auto OSOrErr = createOutputStream(Path, "html", InToplevel); 355 if (!OSOrErr) 356 return OSOrErr; 357 358 OwnedStream OS = std::move(OSOrErr.get()); 359 360 if (!Opts.hasOutputDirectory()) { 361 emitPrelude(*OS.get(), Opts); 362 } else { 363 std::string ViewPath = getOutputPath(Path, "html", InToplevel); 364 emitPrelude(*OS.get(), Opts, getPathToStyle(ViewPath)); 365 } 366 367 return std::move(OS); 368 } 369 370 void CoveragePrinterHTML::closeViewFile(OwnedStream OS) { 371 emitEpilog(*OS.get()); 372 } 373 374 /// Emit column labels for the table in the index. 375 static void emitColumnLabelsForIndex(raw_ostream &OS, 376 const CoverageViewOptions &Opts) { 377 SmallVector<std::string, 4> Columns; 378 Columns.emplace_back(tag("td", "Filename", "column-entry-bold")); 379 Columns.emplace_back(tag("td", "Function Coverage", "column-entry-bold")); 380 if (Opts.ShowInstantiationSummary) 381 Columns.emplace_back( 382 tag("td", "Instantiation Coverage", "column-entry-bold")); 383 Columns.emplace_back(tag("td", "Line Coverage", "column-entry-bold")); 384 if (Opts.ShowRegionSummary) 385 Columns.emplace_back(tag("td", "Region Coverage", "column-entry-bold")); 386 if (Opts.ShowBranchSummary) 387 Columns.emplace_back(tag("td", "Branch Coverage", "column-entry-bold")); 388 OS << tag("tr", join(Columns.begin(), Columns.end(), "")); 389 } 390 391 std::string 392 CoveragePrinterHTML::buildLinkToFile(StringRef SF, 393 const FileCoverageSummary &FCS) const { 394 SmallString<128> LinkTextStr(sys::path::relative_path(FCS.Name)); 395 sys::path::remove_dots(LinkTextStr, /*remove_dot_dot=*/true); 396 sys::path::native(LinkTextStr); 397 std::string LinkText = escape(LinkTextStr, Opts); 398 std::string LinkTarget = 399 escape(getOutputPath(SF, "html", /*InToplevel=*/false), Opts); 400 return a(LinkTarget, LinkText); 401 } 402 403 Error CoveragePrinterHTML::emitStyleSheet() { 404 auto CSSOrErr = createOutputStream("style", "css", /*InToplevel=*/true); 405 if (Error E = CSSOrErr.takeError()) 406 return E; 407 408 OwnedStream CSS = std::move(CSSOrErr.get()); 409 CSS->operator<<(CSSForCoverage); 410 411 return Error::success(); 412 } 413 414 void CoveragePrinterHTML::emitReportHeader(raw_ostream &OSRef, 415 const std::string &Title) { 416 // Emit some basic information about the coverage report. 417 if (Opts.hasProjectTitle()) 418 OSRef << tag(ProjectTitleTag, escape(Opts.ProjectTitle, Opts)); 419 OSRef << tag(ReportTitleTag, Title); 420 if (Opts.hasCreatedTime()) 421 OSRef << tag(CreatedTimeTag, escape(Opts.CreatedTimeStr, Opts)); 422 423 // Emit a link to some documentation. 424 OSRef << tag("p", "Click " + 425 a("http://clang.llvm.org/docs/" 426 "SourceBasedCodeCoverage.html#interpreting-reports", 427 "here") + 428 " for information about interpreting this report."); 429 430 // Emit a table containing links to reports for each file in the covmapping. 431 // Exclude files which don't contain any regions. 432 OSRef << BeginCenteredDiv << BeginTable; 433 emitColumnLabelsForIndex(OSRef, Opts); 434 } 435 436 /// Render a file coverage summary (\p FCS) in a table row. If \p IsTotals is 437 /// false, link the summary to \p SF. 438 void CoveragePrinterHTML::emitFileSummary(raw_ostream &OS, StringRef SF, 439 const FileCoverageSummary &FCS, 440 bool IsTotals) const { 441 // Simplify the display file path, and wrap it in a link if requested. 442 std::string Filename; 443 if (IsTotals) { 444 Filename = std::string(SF); 445 } else { 446 Filename = buildLinkToFile(SF, FCS); 447 } 448 449 emitTableRow(OS, Opts, Filename, FCS, IsTotals); 450 } 451 452 Error CoveragePrinterHTML::createIndexFile( 453 ArrayRef<std::string> SourceFiles, const CoverageMapping &Coverage, 454 const CoverageFiltersMatchAll &Filters) { 455 // Emit the default stylesheet. 456 if (Error E = emitStyleSheet()) 457 return E; 458 459 // Emit a file index along with some coverage statistics. 460 auto OSOrErr = createOutputStream("index", "html", /*InToplevel=*/true); 461 if (Error E = OSOrErr.takeError()) 462 return E; 463 auto OS = std::move(OSOrErr.get()); 464 raw_ostream &OSRef = *OS.get(); 465 466 assert(Opts.hasOutputDirectory() && "No output directory for index file"); 467 emitPrelude(OSRef, Opts, getPathToStyle("")); 468 469 emitReportHeader(OSRef, "Coverage Report"); 470 471 FileCoverageSummary Totals("TOTALS"); 472 auto FileReports = CoverageReport::prepareFileReports( 473 Coverage, Totals, SourceFiles, Opts, Filters); 474 bool EmptyFiles = false; 475 for (unsigned I = 0, E = FileReports.size(); I < E; ++I) { 476 if (FileReports[I].FunctionCoverage.getNumFunctions()) 477 emitFileSummary(OSRef, SourceFiles[I], FileReports[I]); 478 else 479 EmptyFiles = true; 480 } 481 emitFileSummary(OSRef, "Totals", Totals, /*IsTotals=*/true); 482 OSRef << EndTable << EndCenteredDiv; 483 484 // Emit links to files which don't contain any functions. These are normally 485 // not very useful, but could be relevant for code which abuses the 486 // preprocessor. 487 if (EmptyFiles && Filters.empty()) { 488 OSRef << tag("p", "Files which contain no functions. (These " 489 "files contain code pulled into other files " 490 "by the preprocessor.)\n"); 491 OSRef << BeginCenteredDiv << BeginTable; 492 for (unsigned I = 0, E = FileReports.size(); I < E; ++I) 493 if (!FileReports[I].FunctionCoverage.getNumFunctions()) { 494 std::string Link = buildLinkToFile(SourceFiles[I], FileReports[I]); 495 OSRef << tag("tr", tag("td", tag("pre", Link)), "light-row") << '\n'; 496 } 497 OSRef << EndTable << EndCenteredDiv; 498 } 499 500 OSRef << tag("h5", escape(Opts.getLLVMVersionString(), Opts)); 501 emitEpilog(OSRef); 502 503 return Error::success(); 504 } 505 506 struct CoveragePrinterHTMLDirectory::Reporter : public DirectoryCoverageReport { 507 CoveragePrinterHTMLDirectory &Printer; 508 509 Reporter(CoveragePrinterHTMLDirectory &Printer, 510 const coverage::CoverageMapping &Coverage, 511 const CoverageFiltersMatchAll &Filters) 512 : DirectoryCoverageReport(Printer.Opts, Coverage, Filters), 513 Printer(Printer) {} 514 515 Error generateSubDirectoryReport(SubFileReports &&SubFiles, 516 SubDirReports &&SubDirs, 517 FileCoverageSummary &&SubTotals) override { 518 auto &LCPath = SubTotals.Name; 519 assert(Options.hasOutputDirectory() && 520 "No output directory for index file"); 521 522 SmallString<128> OSPath = LCPath; 523 sys::path::append(OSPath, "index"); 524 auto OSOrErr = Printer.createOutputStream(OSPath, "html", 525 /*InToplevel=*/false); 526 if (auto E = OSOrErr.takeError()) 527 return E; 528 auto OS = std::move(OSOrErr.get()); 529 raw_ostream &OSRef = *OS.get(); 530 531 auto IndexHtmlPath = Printer.getOutputPath((LCPath + "index").str(), "html", 532 /*InToplevel=*/false); 533 emitPrelude(OSRef, Options, getPathToStyle(IndexHtmlPath)); 534 535 auto NavLink = buildTitleLinks(LCPath); 536 Printer.emitReportHeader(OSRef, "Coverage Report (" + NavLink + ")"); 537 538 std::vector<const FileCoverageSummary *> EmptyFiles; 539 540 // Make directories at the top of the table. 541 for (auto &&SubDir : SubDirs) { 542 auto &Report = SubDir.second.first; 543 if (!Report.FunctionCoverage.getNumFunctions()) 544 EmptyFiles.push_back(&Report); 545 else 546 emitTableRow(OSRef, Options, buildRelLinkToFile(Report.Name), Report, 547 /*IsTotals=*/false); 548 } 549 550 for (auto &&SubFile : SubFiles) { 551 auto &Report = SubFile.second; 552 if (!Report.FunctionCoverage.getNumFunctions()) 553 EmptyFiles.push_back(&Report); 554 else 555 emitTableRow(OSRef, Options, buildRelLinkToFile(Report.Name), Report, 556 /*IsTotals=*/false); 557 } 558 559 // Emit the totals row. 560 emitTableRow(OSRef, Options, "Totals", SubTotals, /*IsTotals=*/false); 561 OSRef << EndTable << EndCenteredDiv; 562 563 // Emit links to files which don't contain any functions. These are normally 564 // not very useful, but could be relevant for code which abuses the 565 // preprocessor. 566 if (!EmptyFiles.empty()) { 567 OSRef << tag("p", "Files which contain no functions. (These " 568 "files contain code pulled into other files " 569 "by the preprocessor.)\n"); 570 OSRef << BeginCenteredDiv << BeginTable; 571 for (auto FCS : EmptyFiles) { 572 auto Link = buildRelLinkToFile(FCS->Name); 573 OSRef << tag("tr", tag("td", tag("pre", Link)), "light-row") << '\n'; 574 } 575 OSRef << EndTable << EndCenteredDiv; 576 } 577 578 // Emit epilog. 579 OSRef << tag("h5", escape(Options.getLLVMVersionString(), Options)); 580 emitEpilog(OSRef); 581 582 return Error::success(); 583 } 584 585 /// Make a title with hyperlinks to the index.html files of each hierarchy 586 /// of the report. 587 std::string buildTitleLinks(StringRef LCPath) const { 588 // For each report level in LCPStack, extract the path component and 589 // calculate the number of "../" relative to current LCPath. 590 SmallVector<std::pair<SmallString<128>, unsigned>, 16> Components; 591 592 auto Iter = LCPStack.begin(), IterE = LCPStack.end(); 593 SmallString<128> RootPath; 594 if (*Iter == 0) { 595 // If llvm-cov works on relative coverage mapping data, the LCP of 596 // all source file paths can be 0, which makes the title path empty. 597 // As we like adding a slash at the back of the path to indicate a 598 // directory, in this case, we use "." as the root path to make it 599 // not be confused with the root path "/". 600 RootPath = "."; 601 } else { 602 RootPath = LCPath.substr(0, *Iter); 603 sys::path::native(RootPath); 604 sys::path::remove_dots(RootPath, /*remove_dot_dot=*/true); 605 } 606 Components.emplace_back(std::move(RootPath), 0); 607 608 for (auto Last = *Iter; ++Iter != IterE; Last = *Iter) { 609 SmallString<128> SubPath = LCPath.substr(Last, *Iter - Last); 610 sys::path::native(SubPath); 611 sys::path::remove_dots(SubPath, /*remove_dot_dot=*/true); 612 auto Level = unsigned(SubPath.count(sys::path::get_separator())) + 1; 613 Components.back().second += Level; 614 Components.emplace_back(std::move(SubPath), Level); 615 } 616 617 // Then we make the title accroding to Components. 618 std::string S; 619 for (auto I = Components.begin(), E = Components.end();;) { 620 auto &Name = I->first; 621 if (++I == E) { 622 S += a("./index.html", Name); 623 S += sys::path::get_separator(); 624 break; 625 } 626 627 SmallString<128> Link; 628 for (unsigned J = I->second; J > 0; --J) 629 Link += "../"; 630 Link += "index.html"; 631 S += a(Link, Name); 632 S += sys::path::get_separator(); 633 } 634 return S; 635 } 636 637 std::string buildRelLinkToFile(StringRef RelPath) const { 638 SmallString<128> LinkTextStr(RelPath); 639 sys::path::native(LinkTextStr); 640 641 // remove_dots will remove trailing slash, so we need to check before it. 642 auto IsDir = LinkTextStr.ends_with(sys::path::get_separator()); 643 sys::path::remove_dots(LinkTextStr, /*remove_dot_dot=*/true); 644 645 SmallString<128> LinkTargetStr(LinkTextStr); 646 if (IsDir) { 647 LinkTextStr += sys::path::get_separator(); 648 sys::path::append(LinkTargetStr, "index.html"); 649 } else { 650 LinkTargetStr += ".html"; 651 } 652 653 auto LinkText = escape(LinkTextStr, Options); 654 auto LinkTarget = escape(LinkTargetStr, Options); 655 return a(LinkTarget, LinkText); 656 } 657 }; 658 659 Error CoveragePrinterHTMLDirectory::createIndexFile( 660 ArrayRef<std::string> SourceFiles, const CoverageMapping &Coverage, 661 const CoverageFiltersMatchAll &Filters) { 662 // The createSubIndexFile function only works when SourceFiles is 663 // more than one. So we fallback to CoveragePrinterHTML when it is. 664 if (SourceFiles.size() <= 1) 665 return CoveragePrinterHTML::createIndexFile(SourceFiles, Coverage, Filters); 666 667 // Emit the default stylesheet. 668 if (Error E = emitStyleSheet()) 669 return E; 670 671 // Emit index files in every subdirectory. 672 Reporter Report(*this, Coverage, Filters); 673 auto TotalsOrErr = Report.prepareDirectoryReports(SourceFiles); 674 if (auto E = TotalsOrErr.takeError()) 675 return E; 676 auto &LCPath = TotalsOrErr->Name; 677 678 // Emit the top level index file. Top level index file is just a redirection 679 // to the index file in the LCP directory. 680 auto OSOrErr = createOutputStream("index", "html", /*InToplevel=*/true); 681 if (auto E = OSOrErr.takeError()) 682 return E; 683 auto OS = std::move(OSOrErr.get()); 684 auto LCPIndexFilePath = 685 getOutputPath((LCPath + "index").str(), "html", /*InToplevel=*/false); 686 *OS.get() << R"(<!DOCTYPE html> 687 <html> 688 <head> 689 <meta http-equiv="Refresh" content="0; url=')" 690 << LCPIndexFilePath << R"('" /> 691 </head> 692 <body></body> 693 </html> 694 )"; 695 696 return Error::success(); 697 } 698 699 void SourceCoverageViewHTML::renderViewHeader(raw_ostream &OS) { 700 OS << BeginCenteredDiv << BeginTable; 701 } 702 703 void SourceCoverageViewHTML::renderViewFooter(raw_ostream &OS) { 704 OS << EndTable << EndCenteredDiv; 705 } 706 707 void SourceCoverageViewHTML::renderSourceName(raw_ostream &OS, bool WholeFile) { 708 OS << BeginSourceNameDiv << tag("pre", escape(getSourceName(), getOptions())) 709 << EndSourceNameDiv; 710 } 711 712 void SourceCoverageViewHTML::renderLinePrefix(raw_ostream &OS, unsigned) { 713 OS << "<tr>"; 714 } 715 716 void SourceCoverageViewHTML::renderLineSuffix(raw_ostream &OS, unsigned) { 717 // If this view has sub-views, renderLine() cannot close the view's cell. 718 // Take care of it here, after all sub-views have been rendered. 719 if (hasSubViews()) 720 OS << EndCodeTD; 721 OS << "</tr>"; 722 } 723 724 void SourceCoverageViewHTML::renderViewDivider(raw_ostream &, unsigned) { 725 // The table-based output makes view dividers unnecessary. 726 } 727 728 void SourceCoverageViewHTML::renderLine(raw_ostream &OS, LineRef L, 729 const LineCoverageStats &LCS, 730 unsigned ExpansionCol, unsigned) { 731 StringRef Line = L.Line; 732 unsigned LineNo = L.LineNo; 733 734 // Steps for handling text-escaping, highlighting, and tooltip creation: 735 // 736 // 1. Split the line into N+1 snippets, where N = |Segments|. The first 737 // snippet starts from Col=1 and ends at the start of the first segment. 738 // The last snippet starts at the last mapped column in the line and ends 739 // at the end of the line. Both are required but may be empty. 740 741 SmallVector<std::string, 8> Snippets; 742 CoverageSegmentArray Segments = LCS.getLineSegments(); 743 744 unsigned LCol = 1; 745 auto Snip = [&](unsigned Start, unsigned Len) { 746 Snippets.push_back(std::string(Line.substr(Start, Len))); 747 LCol += Len; 748 }; 749 750 Snip(LCol - 1, Segments.empty() ? 0 : (Segments.front()->Col - 1)); 751 752 for (unsigned I = 1, E = Segments.size(); I < E; ++I) 753 Snip(LCol - 1, Segments[I]->Col - LCol); 754 755 // |Line| + 1 is needed to avoid underflow when, e.g |Line| = 0 and LCol = 1. 756 Snip(LCol - 1, Line.size() + 1 - LCol); 757 758 // 2. Escape all of the snippets. 759 760 for (unsigned I = 0, E = Snippets.size(); I < E; ++I) 761 Snippets[I] = escape(Snippets[I], getOptions()); 762 763 // 3. Use \p WrappedSegment to set the highlight for snippet 0. Use segment 764 // 1 to set the highlight for snippet 2, segment 2 to set the highlight for 765 // snippet 3, and so on. 766 767 std::optional<StringRef> Color; 768 SmallVector<std::pair<unsigned, unsigned>, 2> HighlightedRanges; 769 auto Highlight = [&](const std::string &Snippet, unsigned LC, unsigned RC) { 770 if (getOptions().Debug) 771 HighlightedRanges.emplace_back(LC, RC); 772 return tag("span", Snippet, std::string(*Color)); 773 }; 774 775 auto CheckIfUncovered = [&](const CoverageSegment *S) { 776 return S && (!S->IsGapRegion || (Color && *Color == "red")) && 777 S->HasCount && S->Count == 0; 778 }; 779 780 if (CheckIfUncovered(LCS.getWrappedSegment())) { 781 Color = "red"; 782 if (!Snippets[0].empty()) 783 Snippets[0] = Highlight(Snippets[0], 1, 1 + Snippets[0].size()); 784 } 785 786 for (unsigned I = 0, E = Segments.size(); I < E; ++I) { 787 const auto *CurSeg = Segments[I]; 788 if (CheckIfUncovered(CurSeg)) 789 Color = "red"; 790 else if (CurSeg->Col == ExpansionCol) 791 Color = "cyan"; 792 else 793 Color = std::nullopt; 794 795 if (Color) 796 Snippets[I + 1] = Highlight(Snippets[I + 1], CurSeg->Col, 797 CurSeg->Col + Snippets[I + 1].size()); 798 } 799 800 if (Color && Segments.empty()) 801 Snippets.back() = Highlight(Snippets.back(), 1, 1 + Snippets.back().size()); 802 803 if (getOptions().Debug) { 804 for (const auto &Range : HighlightedRanges) { 805 errs() << "Highlighted line " << LineNo << ", " << Range.first << " -> "; 806 if (Range.second == 0) 807 errs() << "?"; 808 else 809 errs() << Range.second; 810 errs() << "\n"; 811 } 812 } 813 814 // 4. Snippets[1:N+1] correspond to \p Segments[0:N]: use these to generate 815 // sub-line region count tooltips if needed. 816 817 if (shouldRenderRegionMarkers(LCS)) { 818 // Just consider the segments which start *and* end on this line. 819 for (unsigned I = 0, E = Segments.size() - 1; I < E; ++I) { 820 const auto *CurSeg = Segments[I]; 821 if (!CurSeg->IsRegionEntry) 822 continue; 823 if (CurSeg->Count == LCS.getExecutionCount()) 824 continue; 825 826 Snippets[I + 1] = 827 tag("div", Snippets[I + 1] + tag("span", formatCount(CurSeg->Count), 828 "tooltip-content"), 829 "tooltip"); 830 831 if (getOptions().Debug) 832 errs() << "Marker at " << CurSeg->Line << ":" << CurSeg->Col << " = " 833 << formatCount(CurSeg->Count) << "\n"; 834 } 835 } 836 837 OS << BeginCodeTD; 838 OS << BeginPre; 839 for (const auto &Snippet : Snippets) 840 OS << Snippet; 841 OS << EndPre; 842 843 // If there are no sub-views left to attach to this cell, end the cell. 844 // Otherwise, end it after the sub-views are rendered (renderLineSuffix()). 845 if (!hasSubViews()) 846 OS << EndCodeTD; 847 } 848 849 void SourceCoverageViewHTML::renderLineCoverageColumn( 850 raw_ostream &OS, const LineCoverageStats &Line) { 851 std::string Count; 852 if (Line.isMapped()) 853 Count = tag("pre", formatCount(Line.getExecutionCount())); 854 std::string CoverageClass = 855 (Line.getExecutionCount() > 0) ? "covered-line" : "uncovered-line"; 856 OS << tag("td", Count, CoverageClass); 857 } 858 859 void SourceCoverageViewHTML::renderLineNumberColumn(raw_ostream &OS, 860 unsigned LineNo) { 861 std::string LineNoStr = utostr(uint64_t(LineNo)); 862 std::string TargetName = "L" + LineNoStr; 863 OS << tag("td", a("#" + TargetName, tag("pre", LineNoStr), TargetName), 864 "line-number"); 865 } 866 867 void SourceCoverageViewHTML::renderRegionMarkers(raw_ostream &, 868 const LineCoverageStats &Line, 869 unsigned) { 870 // Region markers are rendered in-line using tooltips. 871 } 872 873 void SourceCoverageViewHTML::renderExpansionSite(raw_ostream &OS, LineRef L, 874 const LineCoverageStats &LCS, 875 unsigned ExpansionCol, 876 unsigned ViewDepth) { 877 // Render the line containing the expansion site. No extra formatting needed. 878 renderLine(OS, L, LCS, ExpansionCol, ViewDepth); 879 } 880 881 void SourceCoverageViewHTML::renderExpansionView(raw_ostream &OS, 882 ExpansionView &ESV, 883 unsigned ViewDepth) { 884 OS << BeginExpansionDiv; 885 ESV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/false, 886 /*ShowTitle=*/false, ViewDepth + 1); 887 OS << EndExpansionDiv; 888 } 889 890 void SourceCoverageViewHTML::renderBranchView(raw_ostream &OS, BranchView &BRV, 891 unsigned ViewDepth) { 892 // Render the child subview. 893 if (getOptions().Debug) 894 errs() << "Branch at line " << BRV.getLine() << '\n'; 895 896 OS << BeginExpansionDiv; 897 OS << BeginPre; 898 for (const auto &R : BRV.Regions) { 899 // Calculate TruePercent and False Percent. 900 double TruePercent = 0.0; 901 double FalsePercent = 0.0; 902 // FIXME: It may overflow when the data is too large, but I have not 903 // encountered it in actual use, and not sure whether to use __uint128_t. 904 uint64_t Total = R.ExecutionCount + R.FalseExecutionCount; 905 906 if (!getOptions().ShowBranchCounts && Total != 0) { 907 TruePercent = ((double)(R.ExecutionCount) / (double)Total) * 100.0; 908 FalsePercent = ((double)(R.FalseExecutionCount) / (double)Total) * 100.0; 909 } 910 911 // Display Line + Column. 912 std::string LineNoStr = utostr(uint64_t(R.LineStart)); 913 std::string ColNoStr = utostr(uint64_t(R.ColumnStart)); 914 std::string TargetName = "L" + LineNoStr; 915 916 OS << " Branch ("; 917 OS << tag("span", 918 a("#" + TargetName, tag("span", LineNoStr + ":" + ColNoStr), 919 TargetName), 920 "line-number") + 921 "): ["; 922 923 if (R.Folded) { 924 OS << "Folded - Ignored]\n"; 925 continue; 926 } 927 928 // Display TrueCount or TruePercent. 929 std::string TrueColor = R.ExecutionCount ? "None" : "red"; 930 std::string TrueCovClass = 931 (R.ExecutionCount > 0) ? "covered-line" : "uncovered-line"; 932 933 OS << tag("span", "True", TrueColor); 934 OS << ": "; 935 if (getOptions().ShowBranchCounts) 936 OS << tag("span", formatCount(R.ExecutionCount), TrueCovClass) << ", "; 937 else 938 OS << format("%0.2f", TruePercent) << "%, "; 939 940 // Display FalseCount or FalsePercent. 941 std::string FalseColor = R.FalseExecutionCount ? "None" : "red"; 942 std::string FalseCovClass = 943 (R.FalseExecutionCount > 0) ? "covered-line" : "uncovered-line"; 944 945 OS << tag("span", "False", FalseColor); 946 OS << ": "; 947 if (getOptions().ShowBranchCounts) 948 OS << tag("span", formatCount(R.FalseExecutionCount), FalseCovClass); 949 else 950 OS << format("%0.2f", FalsePercent) << "%"; 951 952 OS << "]\n"; 953 } 954 OS << EndPre; 955 OS << EndExpansionDiv; 956 } 957 958 void SourceCoverageViewHTML::renderInstantiationView(raw_ostream &OS, 959 InstantiationView &ISV, 960 unsigned ViewDepth) { 961 OS << BeginExpansionDiv; 962 if (!ISV.View) 963 OS << BeginSourceNameDiv 964 << tag("pre", 965 escape("Unexecuted instantiation: " + ISV.FunctionName.str(), 966 getOptions())) 967 << EndSourceNameDiv; 968 else 969 ISV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/true, 970 /*ShowTitle=*/false, ViewDepth); 971 OS << EndExpansionDiv; 972 } 973 974 void SourceCoverageViewHTML::renderTitle(raw_ostream &OS, StringRef Title) { 975 if (getOptions().hasProjectTitle()) 976 OS << tag(ProjectTitleTag, escape(getOptions().ProjectTitle, getOptions())); 977 OS << tag(ReportTitleTag, escape(Title, getOptions())); 978 if (getOptions().hasCreatedTime()) 979 OS << tag(CreatedTimeTag, 980 escape(getOptions().CreatedTimeStr, getOptions())); 981 } 982 983 void SourceCoverageViewHTML::renderTableHeader(raw_ostream &OS, 984 unsigned FirstUncoveredLineNo, 985 unsigned ViewDepth) { 986 std::string SourceLabel; 987 if (FirstUncoveredLineNo == 0) { 988 SourceLabel = tag("td", tag("pre", "Source")); 989 } else { 990 std::string LinkTarget = "#L" + utostr(uint64_t(FirstUncoveredLineNo)); 991 SourceLabel = 992 tag("td", tag("pre", "Source (" + 993 a(LinkTarget, "jump to first uncovered line") + 994 ")")); 995 } 996 997 renderLinePrefix(OS, ViewDepth); 998 OS << tag("td", tag("pre", "Line")) << tag("td", tag("pre", "Count")) 999 << SourceLabel; 1000 renderLineSuffix(OS, ViewDepth); 1001 } 1002