1 //===- SourceCoverageViewHTML.cpp - A html code coverage view -------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 /// 10 /// \file This file implements the html coverage renderer. 11 /// 12 //===----------------------------------------------------------------------===// 13 14 #include "CoverageReport.h" 15 #include "SourceCoverageViewHTML.h" 16 #include "llvm/ADT/Optional.h" 17 #include "llvm/ADT/SmallString.h" 18 #include "llvm/ADT/StringExtras.h" 19 #include "llvm/Support/FileSystem.h" 20 #include "llvm/Support/Format.h" 21 #include "llvm/Support/Path.h" 22 23 using namespace llvm; 24 25 namespace { 26 27 // Return a string with the special characters in \p Str escaped. 28 std::string escape(StringRef Str, const CoverageViewOptions &Opts) { 29 std::string Result; 30 unsigned ColNum = 0; // Record the column number. 31 for (char C : Str) { 32 ++ColNum; 33 if (C == '&') 34 Result += "&"; 35 else if (C == '<') 36 Result += "<"; 37 else if (C == '>') 38 Result += ">"; 39 else if (C == '\"') 40 Result += """; 41 else if (C == '\n' || C == '\r') { 42 Result += C; 43 ColNum = 0; 44 } else if (C == '\t') { 45 // Replace '\t' with TabSize spaces. 46 unsigned NumSpaces = Opts.TabSize - (--ColNum % Opts.TabSize); 47 for (unsigned I = 0; I < NumSpaces; ++I) 48 Result += " "; 49 ColNum += NumSpaces; 50 } else 51 Result += C; 52 } 53 return Result; 54 } 55 56 // Create a \p Name tag around \p Str, and optionally set its \p ClassName. 57 std::string tag(const std::string &Name, const std::string &Str, 58 const std::string &ClassName = "") { 59 std::string Tag = "<" + Name; 60 if (ClassName != "") 61 Tag += " class='" + ClassName + "'"; 62 return Tag + ">" + Str + "</" + Name + ">"; 63 } 64 65 // Create an anchor to \p Link with the label \p Str. 66 std::string a(const std::string &Link, const std::string &Str, 67 const std::string &TargetType = "href") { 68 return "<a " + TargetType + "='" + Link + "'>" + Str + "</a>"; 69 } 70 71 const char *BeginHeader = 72 "<head>" 73 "<meta name='viewport' content='width=device-width,initial-scale=1'>" 74 "<meta charset='UTF-8'>"; 75 76 const char *CSSForCoverage = 77 R"(.red { 78 background-color: #ffd0d0; 79 } 80 .cyan { 81 background-color: cyan; 82 } 83 body { 84 font-family: -apple-system, sans-serif; 85 } 86 pre { 87 margin-top: 0px !important; 88 margin-bottom: 0px !important; 89 } 90 .source-name-title { 91 padding: 5px 10px; 92 border-bottom: 1px solid #dbdbdb; 93 background-color: #eee; 94 line-height: 35px; 95 } 96 .centered { 97 display: table; 98 margin-left: left; 99 margin-right: auto; 100 border: 1px solid #dbdbdb; 101 border-radius: 3px; 102 } 103 .expansion-view { 104 background-color: rgba(0, 0, 0, 0); 105 margin-left: 0px; 106 margin-top: 5px; 107 margin-right: 5px; 108 margin-bottom: 5px; 109 border: 1px solid #dbdbdb; 110 border-radius: 3px; 111 } 112 table { 113 border-collapse: collapse; 114 } 115 .light-row { 116 background: #ffffff; 117 border: 1px solid #dbdbdb; 118 } 119 .column-entry { 120 text-align: right; 121 } 122 .column-entry-left { 123 text-align: left; 124 } 125 .column-entry-yellow { 126 text-align: right; 127 background-color: #ffffd0; 128 } 129 .column-entry-red { 130 text-align: right; 131 background-color: #ffd0d0; 132 } 133 .column-entry-green { 134 text-align: right; 135 background-color: #d0ffd0; 136 } 137 .line-number { 138 text-align: right; 139 color: #aaa; 140 } 141 .covered-line { 142 text-align: right; 143 color: #0080ff; 144 } 145 .uncovered-line { 146 text-align: right; 147 color: #ff3300; 148 } 149 .tooltip { 150 position: relative; 151 display: inline; 152 background-color: #b3e6ff; 153 text-decoration: none; 154 } 155 .tooltip span.tooltip-content { 156 position: absolute; 157 width: 100px; 158 margin-left: -50px; 159 color: #FFFFFF; 160 background: #000000; 161 height: 30px; 162 line-height: 30px; 163 text-align: center; 164 visibility: hidden; 165 border-radius: 6px; 166 } 167 .tooltip span.tooltip-content:after { 168 content: ''; 169 position: absolute; 170 top: 100%; 171 left: 50%; 172 margin-left: -8px; 173 width: 0; height: 0; 174 border-top: 8px solid #000000; 175 border-right: 8px solid transparent; 176 border-left: 8px solid transparent; 177 } 178 :hover.tooltip span.tooltip-content { 179 visibility: visible; 180 opacity: 0.8; 181 bottom: 30px; 182 left: 50%; 183 z-index: 999; 184 } 185 th, td { 186 vertical-align: top; 187 padding: 2px 5px; 188 border-collapse: collapse; 189 border-right: solid 1px #eee; 190 border-left: solid 1px #eee; 191 } 192 td:first-child { 193 border-left: none; 194 } 195 td:last-child { 196 border-right: none; 197 } 198 )"; 199 200 const char *EndHeader = "</head>"; 201 202 const char *BeginCenteredDiv = "<div class='centered'>"; 203 204 const char *EndCenteredDiv = "</div>"; 205 206 const char *BeginSourceNameDiv = "<div class='source-name-title'>"; 207 208 const char *EndSourceNameDiv = "</div>"; 209 210 const char *BeginCodeTD = "<td class='code'>"; 211 212 const char *EndCodeTD = "</td>"; 213 214 const char *BeginPre = "<pre>"; 215 216 const char *EndPre = "</pre>"; 217 218 const char *BeginExpansionDiv = "<div class='expansion-view'>"; 219 220 const char *EndExpansionDiv = "</div>"; 221 222 const char *BeginTable = "<table>"; 223 224 const char *EndTable = "</table>"; 225 226 const char *ProjectTitleTag = "h1"; 227 228 const char *ReportTitleTag = "h2"; 229 230 const char *CreatedTimeTag = "h4"; 231 232 std::string getPathToStyle(StringRef ViewPath) { 233 std::string PathToStyle = ""; 234 std::string PathSep = sys::path::get_separator(); 235 unsigned NumSeps = ViewPath.count(PathSep); 236 for (unsigned I = 0, E = NumSeps; I < E; ++I) 237 PathToStyle += ".." + PathSep; 238 return PathToStyle + "style.css"; 239 } 240 241 void emitPrelude(raw_ostream &OS, const CoverageViewOptions &Opts, 242 const std::string &PathToStyle = "") { 243 OS << "<!doctype html>" 244 "<html>" 245 << BeginHeader; 246 247 // Link to a stylesheet if one is available. Otherwise, use the default style. 248 if (PathToStyle.empty()) 249 OS << "<style>" << CSSForCoverage << "</style>"; 250 else 251 OS << "<link rel='stylesheet' type='text/css' href='" 252 << escape(PathToStyle, Opts) << "'>"; 253 254 OS << EndHeader << "<body>"; 255 } 256 257 void emitEpilog(raw_ostream &OS) { 258 OS << "</body>" 259 << "</html>"; 260 } 261 262 } // anonymous namespace 263 264 Expected<CoveragePrinter::OwnedStream> 265 CoveragePrinterHTML::createViewFile(StringRef Path, bool InToplevel) { 266 auto OSOrErr = createOutputStream(Path, "html", InToplevel); 267 if (!OSOrErr) 268 return OSOrErr; 269 270 OwnedStream OS = std::move(OSOrErr.get()); 271 272 if (!Opts.hasOutputDirectory()) { 273 emitPrelude(*OS.get(), Opts); 274 } else { 275 std::string ViewPath = getOutputPath(Path, "html", InToplevel); 276 emitPrelude(*OS.get(), Opts, getPathToStyle(ViewPath)); 277 } 278 279 return std::move(OS); 280 } 281 282 void CoveragePrinterHTML::closeViewFile(OwnedStream OS) { 283 emitEpilog(*OS.get()); 284 } 285 286 /// Emit column labels for the table in the index. 287 static void emitColumnLabelsForIndex(raw_ostream &OS) { 288 SmallVector<std::string, 4> Columns; 289 Columns.emplace_back(tag("td", "Filename", "column-entry-left")); 290 for (const char *Label : 291 {"Function Coverage", "Line Coverage", "Region Coverage"}) 292 Columns.emplace_back(tag("td", Label, "column-entry")); 293 OS << tag("tr", join(Columns.begin(), Columns.end(), "")); 294 } 295 296 /// Render a file coverage summary (\p FCS) in a table row. If \p IsTotals is 297 /// false, link the summary to \p SF. 298 void CoveragePrinterHTML::emitFileSummary(raw_ostream &OS, StringRef SF, 299 const FileCoverageSummary &FCS, 300 bool IsTotals) const { 301 SmallVector<std::string, 4> Columns; 302 303 // Format a coverage triple and add the result to the list of columns. 304 auto AddCoverageTripleToColumn = [&Columns](unsigned Hit, unsigned Total, 305 float Pctg) { 306 std::string S; 307 { 308 raw_string_ostream RSO{S}; 309 RSO << format("%*.2f", 7, Pctg) << "% (" << Hit << '/' << Total << ')'; 310 } 311 const char *CellClass = "column-entry-yellow"; 312 if (Pctg < 80.0) 313 CellClass = "column-entry-red"; 314 else if (Hit == Total) 315 CellClass = "column-entry-green"; 316 Columns.emplace_back(tag("td", tag("pre", S), CellClass)); 317 }; 318 319 // Simplify the display file path, and wrap it in a link if requested. 320 std::string Filename; 321 SmallString<128> LinkTextStr(sys::path::relative_path(FCS.Name)); 322 sys::path::remove_dots(LinkTextStr, /*remove_dot_dots=*/true); 323 sys::path::native(LinkTextStr); 324 std::string LinkText = escape(LinkTextStr, Opts); 325 if (IsTotals) { 326 Filename = LinkText; 327 } else { 328 std::string LinkTarget = 329 escape(getOutputPath(SF, "html", /*InToplevel=*/false), Opts); 330 Filename = a(LinkTarget, LinkText); 331 } 332 333 Columns.emplace_back(tag("td", tag("pre", Filename))); 334 AddCoverageTripleToColumn(FCS.FunctionCoverage.Executed, 335 FCS.FunctionCoverage.NumFunctions, 336 FCS.FunctionCoverage.getPercentCovered()); 337 AddCoverageTripleToColumn( 338 FCS.LineCoverage.NumLines - FCS.LineCoverage.NotCovered, 339 FCS.LineCoverage.NumLines, FCS.LineCoverage.getPercentCovered()); 340 AddCoverageTripleToColumn( 341 FCS.RegionCoverage.NumRegions - FCS.RegionCoverage.NotCovered, 342 FCS.RegionCoverage.NumRegions, FCS.RegionCoverage.getPercentCovered()); 343 344 OS << tag("tr", join(Columns.begin(), Columns.end(), ""), "light-row"); 345 } 346 347 Error CoveragePrinterHTML::createIndexFile( 348 ArrayRef<StringRef> SourceFiles, 349 const coverage::CoverageMapping &Coverage) { 350 // Emit the default stylesheet. 351 auto CSSOrErr = createOutputStream("style", "css", /*InToplevel=*/true); 352 if (Error E = CSSOrErr.takeError()) 353 return E; 354 355 OwnedStream CSS = std::move(CSSOrErr.get()); 356 CSS->operator<<(CSSForCoverage); 357 358 // Emit a file index along with some coverage statistics. 359 auto OSOrErr = createOutputStream("index", "html", /*InToplevel=*/true); 360 if (Error E = OSOrErr.takeError()) 361 return E; 362 auto OS = std::move(OSOrErr.get()); 363 raw_ostream &OSRef = *OS.get(); 364 365 assert(Opts.hasOutputDirectory() && "No output directory for index file"); 366 emitPrelude(OSRef, Opts, getPathToStyle("")); 367 368 // Emit some basic information about the coverage report. 369 if (Opts.hasProjectTitle()) 370 OSRef << tag(ProjectTitleTag, escape(Opts.ProjectTitle, Opts)); 371 OSRef << tag(ReportTitleTag, "Coverage Report"); 372 if (Opts.hasCreatedTime()) 373 OSRef << tag(CreatedTimeTag, escape(Opts.CreatedTimeStr, Opts)); 374 375 // Emit a table containing links to reports for each file in the covmapping. 376 CoverageReport Report(Opts, Coverage); 377 OSRef << BeginCenteredDiv << BeginTable; 378 emitColumnLabelsForIndex(OSRef); 379 FileCoverageSummary Totals("TOTALS"); 380 auto FileReports = Report.prepareFileReports(Totals, SourceFiles); 381 for (unsigned I = 0, E = FileReports.size(); I < E; ++I) 382 emitFileSummary(OSRef, SourceFiles[I], FileReports[I]); 383 emitFileSummary(OSRef, "Totals", Totals, /*IsTotals=*/true); 384 OSRef << EndTable << EndCenteredDiv 385 << tag("h5", escape(Opts.getLLVMVersionString(), Opts)); 386 emitEpilog(OSRef); 387 388 return Error::success(); 389 } 390 391 void SourceCoverageViewHTML::renderViewHeader(raw_ostream &OS) { 392 OS << BeginCenteredDiv << BeginTable; 393 } 394 395 void SourceCoverageViewHTML::renderViewFooter(raw_ostream &OS) { 396 OS << EndTable << EndCenteredDiv 397 << tag("h5", escape(getOptions().getLLVMVersionString(), getOptions())); 398 } 399 400 void SourceCoverageViewHTML::renderSourceName(raw_ostream &OS, bool WholeFile) { 401 OS << BeginSourceNameDiv; 402 std::string ViewInfo = escape( 403 WholeFile ? getVerboseSourceName() : getSourceName(), getOptions()); 404 OS << tag("pre", ViewInfo); 405 OS << EndSourceNameDiv; 406 } 407 408 void SourceCoverageViewHTML::renderLinePrefix(raw_ostream &OS, unsigned) { 409 OS << "<tr>"; 410 } 411 412 void SourceCoverageViewHTML::renderLineSuffix(raw_ostream &OS, unsigned) { 413 // If this view has sub-views, renderLine() cannot close the view's cell. 414 // Take care of it here, after all sub-views have been rendered. 415 if (hasSubViews()) 416 OS << EndCodeTD; 417 OS << "</tr>"; 418 } 419 420 void SourceCoverageViewHTML::renderViewDivider(raw_ostream &, unsigned) { 421 // The table-based output makes view dividers unnecessary. 422 } 423 424 void SourceCoverageViewHTML::renderLine( 425 raw_ostream &OS, LineRef L, const coverage::CoverageSegment *WrappedSegment, 426 CoverageSegmentArray Segments, unsigned ExpansionCol, unsigned) { 427 StringRef Line = L.Line; 428 unsigned LineNo = L.LineNo; 429 430 // Steps for handling text-escaping, highlighting, and tooltip creation: 431 // 432 // 1. Split the line into N+1 snippets, where N = |Segments|. The first 433 // snippet starts from Col=1 and ends at the start of the first segment. 434 // The last snippet starts at the last mapped column in the line and ends 435 // at the end of the line. Both are required but may be empty. 436 437 SmallVector<std::string, 8> Snippets; 438 439 unsigned LCol = 1; 440 auto Snip = [&](unsigned Start, unsigned Len) { 441 Snippets.push_back(Line.substr(Start, Len)); 442 LCol += Len; 443 }; 444 445 Snip(LCol - 1, Segments.empty() ? 0 : (Segments.front()->Col - 1)); 446 447 for (unsigned I = 1, E = Segments.size(); I < E; ++I) 448 Snip(LCol - 1, Segments[I]->Col - LCol); 449 450 // |Line| + 1 is needed to avoid underflow when, e.g |Line| = 0 and LCol = 1. 451 Snip(LCol - 1, Line.size() + 1 - LCol); 452 453 // 2. Escape all of the snippets. 454 455 for (unsigned I = 0, E = Snippets.size(); I < E; ++I) 456 Snippets[I] = escape(Snippets[I], getOptions()); 457 458 // 3. Use \p WrappedSegment to set the highlight for snippet 0. Use segment 459 // 1 to set the highlight for snippet 2, segment 2 to set the highlight for 460 // snippet 3, and so on. 461 462 Optional<std::string> Color; 463 SmallVector<std::pair<unsigned, unsigned>, 2> HighlightedRanges; 464 auto Highlight = [&](const std::string &Snippet, unsigned LC, unsigned RC) { 465 if (getOptions().Debug) 466 HighlightedRanges.emplace_back(LC, RC); 467 return tag("span", Snippet, Color.getValue()); 468 }; 469 470 auto CheckIfUncovered = [](const coverage::CoverageSegment *S) { 471 return S && S->HasCount && S->Count == 0; 472 }; 473 474 if (CheckIfUncovered(WrappedSegment)) { 475 Color = "red"; 476 if (!Snippets[0].empty()) 477 Snippets[0] = Highlight(Snippets[0], 1, 1 + Snippets[0].size()); 478 } 479 480 for (unsigned I = 0, E = Segments.size(); I < E; ++I) { 481 const auto *CurSeg = Segments[I]; 482 if (CurSeg->Col == ExpansionCol) 483 Color = "cyan"; 484 else if (CheckIfUncovered(CurSeg)) 485 Color = "red"; 486 else 487 Color = None; 488 489 if (Color.hasValue()) 490 Snippets[I + 1] = Highlight(Snippets[I + 1], CurSeg->Col, 491 CurSeg->Col + Snippets[I + 1].size()); 492 } 493 494 if (Color.hasValue() && Segments.empty()) 495 Snippets.back() = Highlight(Snippets.back(), 1, 1 + Snippets.back().size()); 496 497 if (getOptions().Debug) { 498 for (const auto &Range : HighlightedRanges) { 499 errs() << "Highlighted line " << LineNo << ", " << Range.first << " -> "; 500 if (Range.second == 0) 501 errs() << "?"; 502 else 503 errs() << Range.second; 504 errs() << "\n"; 505 } 506 } 507 508 // 4. Snippets[1:N+1] correspond to \p Segments[0:N]: use these to generate 509 // sub-line region count tooltips if needed. 510 511 bool HasMultipleRegions = [&] { 512 unsigned RegionCount = 0; 513 for (const auto *S : Segments) 514 if (S->HasCount && S->IsRegionEntry) 515 if (++RegionCount > 1) 516 return true; 517 return false; 518 }(); 519 520 if (shouldRenderRegionMarkers(HasMultipleRegions)) { 521 for (unsigned I = 0, E = Segments.size(); I < E; ++I) { 522 const auto *CurSeg = Segments[I]; 523 if (!CurSeg->IsRegionEntry || !CurSeg->HasCount) 524 continue; 525 526 Snippets[I + 1] = 527 tag("div", Snippets[I + 1] + tag("span", formatCount(CurSeg->Count), 528 "tooltip-content"), 529 "tooltip"); 530 } 531 } 532 533 OS << BeginCodeTD; 534 OS << BeginPre; 535 for (const auto &Snippet : Snippets) 536 OS << Snippet; 537 OS << EndPre; 538 539 // If there are no sub-views left to attach to this cell, end the cell. 540 // Otherwise, end it after the sub-views are rendered (renderLineSuffix()). 541 if (!hasSubViews()) 542 OS << EndCodeTD; 543 } 544 545 void SourceCoverageViewHTML::renderLineCoverageColumn( 546 raw_ostream &OS, const LineCoverageStats &Line) { 547 std::string Count = ""; 548 if (Line.isMapped()) 549 Count = tag("pre", formatCount(Line.ExecutionCount)); 550 std::string CoverageClass = 551 (Line.ExecutionCount > 0) ? "covered-line" : "uncovered-line"; 552 OS << tag("td", Count, CoverageClass); 553 } 554 555 void SourceCoverageViewHTML::renderLineNumberColumn(raw_ostream &OS, 556 unsigned LineNo) { 557 std::string LineNoStr = utostr(uint64_t(LineNo)); 558 OS << tag("td", a("L" + LineNoStr, tag("pre", LineNoStr), "name"), 559 "line-number"); 560 } 561 562 void SourceCoverageViewHTML::renderRegionMarkers(raw_ostream &, 563 CoverageSegmentArray, 564 unsigned) { 565 // Region markers are rendered in-line using tooltips. 566 } 567 568 void SourceCoverageViewHTML::renderExpansionSite( 569 raw_ostream &OS, LineRef L, const coverage::CoverageSegment *WrappedSegment, 570 CoverageSegmentArray Segments, unsigned ExpansionCol, unsigned ViewDepth) { 571 // Render the line containing the expansion site. No extra formatting needed. 572 renderLine(OS, L, WrappedSegment, Segments, ExpansionCol, ViewDepth); 573 } 574 575 void SourceCoverageViewHTML::renderExpansionView(raw_ostream &OS, 576 ExpansionView &ESV, 577 unsigned ViewDepth) { 578 OS << BeginExpansionDiv; 579 ESV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/false, 580 ViewDepth + 1); 581 OS << EndExpansionDiv; 582 } 583 584 void SourceCoverageViewHTML::renderInstantiationView(raw_ostream &OS, 585 InstantiationView &ISV, 586 unsigned ViewDepth) { 587 OS << BeginExpansionDiv; 588 ISV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/true, ViewDepth); 589 OS << EndExpansionDiv; 590 } 591 592 void SourceCoverageViewHTML::renderCellInTitle(raw_ostream &OS, 593 StringRef CellText) { 594 if (getOptions().hasProjectTitle()) 595 OS << tag(ProjectTitleTag, escape(getOptions().ProjectTitle, getOptions())); 596 OS << tag(ReportTitleTag, escape(CellText, getOptions())); 597 if (getOptions().hasCreatedTime()) 598 OS << tag(CreatedTimeTag, 599 escape(getOptions().CreatedTimeStr, getOptions())); 600 } 601 602 void SourceCoverageViewHTML::renderTableHeader(raw_ostream &OS, 603 unsigned FirstUncoveredLineNo, 604 unsigned ViewDepth) { 605 std::string SourceLabel; 606 if (FirstUncoveredLineNo == 0) { 607 SourceLabel = tag("td", tag("pre", "Source")); 608 } else { 609 std::string LinkTarget = "#L" + utostr(uint64_t(FirstUncoveredLineNo)); 610 SourceLabel = 611 tag("td", tag("pre", "Source (" + 612 a(LinkTarget, "jump to first uncovered line") + 613 ")")); 614 } 615 616 renderLinePrefix(OS, ViewDepth); 617 OS << tag("td", tag("pre", "Line No.")) << tag("td", tag("pre", "Count")) 618 << SourceLabel; 619 renderLineSuffix(OS, ViewDepth); 620 } 621