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 std::string LinkText = escape(sys::path::relative_path(SF), Opts); 312 std::string LinkTarget = 313 escape(getOutputPath(SF, "html", /*InToplevel=*/false), Opts); 314 OSRef << tag("tr", tag("td", tag("pre", a(LinkTarget, LinkText), "code"))); 315 } 316 OSRef << EndTable << EndCenteredDiv; 317 emitEpilog(OSRef); 318 319 // Emit the default stylesheet. 320 auto CSSOrErr = createOutputStream("style", "css", /*InToplevel=*/true); 321 if (Error E = CSSOrErr.takeError()) 322 return E; 323 324 OwnedStream CSS = std::move(CSSOrErr.get()); 325 CSS->operator<<(CSSForCoverage); 326 327 return Error::success(); 328 } 329 330 void SourceCoverageViewHTML::renderViewHeader(raw_ostream &OS) { 331 OS << LineBreak << BeginCenteredDiv << BeginTable; 332 } 333 334 void SourceCoverageViewHTML::renderViewFooter(raw_ostream &OS) { 335 OS << EndTable << EndCenteredDiv; 336 } 337 338 void SourceCoverageViewHTML::renderSourceName(raw_ostream &OS, bool WholeFile) { 339 OS << BeginSourceNameDiv; 340 // Render the source name for the view. 341 std::string SourceFile = isFunctionView() ? "Function: " : "Source: "; 342 SourceFile += getSourceName().str(); 343 OS << tag("pre", escape(SourceFile, getOptions())); 344 // Render the object file name for the view. 345 if (WholeFile) 346 OS << tag("pre", 347 escape("Binary: " + getOptions().ObjectFilename, getOptions())); 348 OS << EndSourceNameDiv; 349 } 350 351 void SourceCoverageViewHTML::renderLinePrefix(raw_ostream &OS, unsigned) { 352 OS << "<tr>"; 353 } 354 355 void SourceCoverageViewHTML::renderLineSuffix(raw_ostream &OS, unsigned) { 356 // If this view has sub-views, renderLine() cannot close the view's cell. 357 // Take care of it here, after all sub-views have been rendered. 358 if (hasSubViews()) 359 OS << EndCodeTD; 360 OS << "</tr>"; 361 } 362 363 void SourceCoverageViewHTML::renderViewDivider(raw_ostream &, unsigned) { 364 // The table-based output makes view dividers unnecessary. 365 } 366 367 void SourceCoverageViewHTML::renderLine( 368 raw_ostream &OS, LineRef L, const coverage::CoverageSegment *WrappedSegment, 369 CoverageSegmentArray Segments, unsigned ExpansionCol, unsigned) { 370 StringRef Line = L.Line; 371 unsigned LineNo = L.LineNo; 372 373 // Steps for handling text-escaping, highlighting, and tooltip creation: 374 // 375 // 1. Split the line into N+1 snippets, where N = |Segments|. The first 376 // snippet starts from Col=1 and ends at the start of the first segment. 377 // The last snippet starts at the last mapped column in the line and ends 378 // at the end of the line. Both are required but may be empty. 379 380 SmallVector<std::string, 8> Snippets; 381 382 unsigned LCol = 1; 383 auto Snip = [&](unsigned Start, unsigned Len) { 384 assert(Start + Len <= Line.size() && "Snippet extends past the EOL"); 385 Snippets.push_back(Line.substr(Start, Len)); 386 LCol += Len; 387 }; 388 389 Snip(LCol - 1, Segments.empty() ? 0 : (Segments.front()->Col - 1)); 390 391 for (unsigned I = 1, E = Segments.size(); I < E; ++I) { 392 assert(LCol == Segments[I - 1]->Col && "Snippet start position is wrong"); 393 Snip(LCol - 1, Segments[I]->Col - LCol); 394 } 395 396 // |Line| + 1 is needed to avoid underflow when, e.g |Line| = 0 and LCol = 1. 397 Snip(LCol - 1, Line.size() + 1 - LCol); 398 assert(LCol == Line.size() + 1 && "Final snippet doesn't reach the EOL"); 399 400 // 2. Escape all of the snippets. 401 402 for (unsigned I = 0, E = Snippets.size(); I < E; ++I) 403 Snippets[I] = escape(Snippets[I], getOptions()); 404 405 // 3. Use \p WrappedSegment to set the highlight for snippet 0. Use segment 406 // 1 to set the highlight for snippet 2, segment 2 to set the highlight for 407 // snippet 3, and so on. 408 409 Optional<std::string> Color; 410 SmallVector<std::pair<unsigned, unsigned>, 4> HighlightedRanges; 411 auto Highlight = [&](const std::string &Snippet, unsigned LC, unsigned RC) { 412 if (getOptions().Debug) { 413 if (!HighlightedRanges.empty() && 414 HighlightedRanges.back().second == LC - 1) { 415 HighlightedRanges.back().second = RC; 416 } else 417 HighlightedRanges.emplace_back(LC, RC); 418 } 419 return tag("span", Snippet, Color.getValue()); 420 }; 421 422 auto CheckIfUncovered = [](const coverage::CoverageSegment *S) { 423 return S && (S->HasCount && S->Count == 0); 424 }; 425 426 if (CheckIfUncovered(WrappedSegment) || 427 CheckIfUncovered(Segments.empty() ? nullptr : Segments.front())) { 428 Color = "red"; 429 Snippets[0] = Highlight(Snippets[0], 0, Snippets[0].size()); 430 } 431 432 for (unsigned I = 0, E = Segments.size(); I < E; ++I) { 433 const auto *CurSeg = Segments[I]; 434 if (CurSeg->Col == ExpansionCol) 435 Color = "cyan"; 436 else if (CheckIfUncovered(CurSeg)) 437 Color = "red"; 438 else 439 Color = None; 440 441 if (Color.hasValue()) 442 Snippets[I + 1] = Highlight(Snippets[I + 1], CurSeg->Col, 443 CurSeg->Col + Snippets[I + 1].size()); 444 } 445 446 if (Color.hasValue() && Segments.empty()) 447 Snippets.back() = Highlight(Snippets.back(), Snippets[0].size(), 0); 448 449 if (getOptions().Debug) { 450 for (const auto &Range : HighlightedRanges) { 451 errs() << "Highlighted line " << LineNo << ", " << Range.first + 1 452 << " -> "; 453 if (Range.second == 0) 454 errs() << "?"; 455 else 456 errs() << Range.second + 1; 457 errs() << "\n"; 458 } 459 } 460 461 // 4. Snippets[1:N+1] correspond to \p Segments[0:N]: use these to generate 462 // sub-line region count tooltips if needed. 463 464 bool HasMultipleRegions = [&] { 465 unsigned RegionCount = 0; 466 for (const auto *S : Segments) 467 if (S->HasCount && S->IsRegionEntry) 468 if (++RegionCount > 1) 469 return true; 470 return false; 471 }(); 472 473 if (shouldRenderRegionMarkers(HasMultipleRegions)) { 474 for (unsigned I = 0, E = Segments.size(); I < E; ++I) { 475 const auto *CurSeg = Segments[I]; 476 if (!CurSeg->IsRegionEntry || !CurSeg->HasCount) 477 continue; 478 479 Snippets[I + 1] = 480 tag("div", Snippets[I + 1] + tag("span", formatCount(CurSeg->Count), 481 "tooltip-content"), 482 "tooltip"); 483 } 484 } 485 486 OS << BeginCodeTD; 487 OS << BeginPre; 488 for (const auto &Snippet : Snippets) 489 OS << Snippet; 490 OS << EndPre; 491 492 // If there are no sub-views left to attach to this cell, end the cell. 493 // Otherwise, end it after the sub-views are rendered (renderLineSuffix()). 494 if (!hasSubViews()) 495 OS << EndCodeTD; 496 } 497 498 void SourceCoverageViewHTML::renderLineCoverageColumn( 499 raw_ostream &OS, const LineCoverageStats &Line) { 500 std::string Count = ""; 501 if (Line.isMapped()) 502 Count = tag("pre", formatCount(Line.ExecutionCount)); 503 std::string CoverageClass = 504 (Line.ExecutionCount > 0) ? "covered-line" : "uncovered-line"; 505 OS << tag("td", Count, CoverageClass); 506 } 507 508 void SourceCoverageViewHTML::renderLineNumberColumn(raw_ostream &OS, 509 unsigned LineNo) { 510 std::string LineNoStr = utostr(uint64_t(LineNo)); 511 OS << tag("td", a("L" + LineNoStr, tag("pre", LineNoStr), "name"), 512 "line-number"); 513 } 514 515 void SourceCoverageViewHTML::renderRegionMarkers(raw_ostream &, 516 CoverageSegmentArray, 517 unsigned) { 518 // Region markers are rendered in-line using tooltips. 519 } 520 521 void SourceCoverageViewHTML::renderExpansionSite( 522 raw_ostream &OS, LineRef L, const coverage::CoverageSegment *WrappedSegment, 523 CoverageSegmentArray Segments, unsigned ExpansionCol, unsigned ViewDepth) { 524 // Render the line containing the expansion site. No extra formatting needed. 525 renderLine(OS, L, WrappedSegment, Segments, ExpansionCol, ViewDepth); 526 } 527 528 void SourceCoverageViewHTML::renderExpansionView(raw_ostream &OS, 529 ExpansionView &ESV, 530 unsigned ViewDepth) { 531 OS << BeginExpansionDiv; 532 ESV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/false, 533 ViewDepth + 1); 534 OS << EndExpansionDiv; 535 } 536 537 void SourceCoverageViewHTML::renderInstantiationView(raw_ostream &OS, 538 InstantiationView &ISV, 539 unsigned ViewDepth) { 540 OS << BeginExpansionDiv; 541 ISV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/true, ViewDepth); 542 OS << EndExpansionDiv; 543 } 544 545 void SourceCoverageViewHTML::renderCellInTitle(raw_ostream &OS, 546 StringRef CellText) { 547 if (getOptions().hasProjectTitle()) 548 OS << BeginProjectTitleDiv 549 << tag("span", escape(getOptions().ProjectTitle, getOptions())) 550 << EndProjectTitleDiv; 551 552 OS << BeginReportTitleDiv << tag("span", escape(CellText, getOptions())) 553 << EndReportTitleDiv; 554 555 if (getOptions().hasCreatedTime()) 556 OS << BeginCreatedTimeDiv 557 << tag("span", escape(getOptions().CreatedTimeStr, getOptions())) 558 << EndCreatedTimeDiv; 559 } 560 561 void SourceCoverageViewHTML::renderTableHeader(raw_ostream &OS, 562 unsigned ViewDepth) { 563 renderLinePrefix(OS, ViewDepth); 564 OS << tag("td", tag("span", tag("pre", escape("Line No.", getOptions())))) 565 << tag("td", tag("span", tag("pre", escape("Count No.", getOptions())))) 566 << tag("td", tag("span", tag("pre", escape("Source", getOptions())))); 567 renderLineSuffix(OS, ViewDepth); 568 } 569