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