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" 145f757f3fSDimitry 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" 195f757f3fSDimitry 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. 535f757f3fSDimitry Andric std::string tag(StringRef Name, StringRef Str, StringRef ClassName = "") { 545f757f3fSDimitry Andric std::string Tag = "<"; 555f757f3fSDimitry Andric Tag += Name; 565f757f3fSDimitry Andric if (!ClassName.empty()) { 575f757f3fSDimitry Andric Tag += " class='"; 585f757f3fSDimitry Andric Tag += ClassName; 595f757f3fSDimitry Andric Tag += "'"; 605f757f3fSDimitry Andric } 615f757f3fSDimitry Andric Tag += ">"; 625f757f3fSDimitry Andric Tag += Str; 635f757f3fSDimitry Andric Tag += "</"; 645f757f3fSDimitry Andric Tag += Name; 655f757f3fSDimitry Andric Tag += ">"; 665f757f3fSDimitry Andric return Tag; 670b57cec5SDimitry Andric } 680b57cec5SDimitry Andric 690b57cec5SDimitry Andric // Create an anchor to \p Link with the label \p Str. 705f757f3fSDimitry Andric std::string a(StringRef Link, StringRef Str, StringRef TargetName = "") { 715f757f3fSDimitry Andric std::string Tag; 725f757f3fSDimitry Andric Tag += "<a "; 735f757f3fSDimitry Andric if (!TargetName.empty()) { 745f757f3fSDimitry Andric Tag += "name='"; 755f757f3fSDimitry Andric Tag += TargetName; 765f757f3fSDimitry Andric Tag += "' "; 775f757f3fSDimitry Andric } 785f757f3fSDimitry Andric Tag += "href='"; 795f757f3fSDimitry Andric Tag += Link; 805f757f3fSDimitry Andric Tag += "'>"; 815f757f3fSDimitry Andric Tag += Str; 825f757f3fSDimitry Andric Tag += "</a>"; 835f757f3fSDimitry 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 91*0fca6ea1SDimitry Andric const char *JSForCoverage = 92*0fca6ea1SDimitry Andric R"javascript( 93*0fca6ea1SDimitry Andric 94*0fca6ea1SDimitry Andric function next_uncovered(selector, reverse, scroll_selector) { 95*0fca6ea1SDimitry Andric function visit_element(element) { 96*0fca6ea1SDimitry Andric element.classList.add("seen"); 97*0fca6ea1SDimitry Andric element.classList.add("selected"); 98*0fca6ea1SDimitry Andric 99*0fca6ea1SDimitry Andric if (!scroll_selector) { 100*0fca6ea1SDimitry Andric scroll_selector = "tr:has(.selected) td.line-number" 101*0fca6ea1SDimitry Andric } 102*0fca6ea1SDimitry Andric 103*0fca6ea1SDimitry Andric const scroll_to = document.querySelector(scroll_selector); 104*0fca6ea1SDimitry Andric if (scroll_to) { 105*0fca6ea1SDimitry Andric scroll_to.scrollIntoView({behavior: "smooth", block: "center", inline: "end"}); 106*0fca6ea1SDimitry Andric } 107*0fca6ea1SDimitry Andric 108*0fca6ea1SDimitry Andric } 109*0fca6ea1SDimitry Andric 110*0fca6ea1SDimitry Andric function select_one() { 111*0fca6ea1SDimitry Andric if (!reverse) { 112*0fca6ea1SDimitry Andric const previously_selected = document.querySelector(".selected"); 113*0fca6ea1SDimitry Andric 114*0fca6ea1SDimitry Andric if (previously_selected) { 115*0fca6ea1SDimitry Andric previously_selected.classList.remove("selected"); 116*0fca6ea1SDimitry Andric } 117*0fca6ea1SDimitry Andric 118*0fca6ea1SDimitry Andric return document.querySelector(selector + ":not(.seen)"); 119*0fca6ea1SDimitry Andric } else { 120*0fca6ea1SDimitry Andric const previously_selected = document.querySelector(".selected"); 121*0fca6ea1SDimitry Andric 122*0fca6ea1SDimitry Andric if (previously_selected) { 123*0fca6ea1SDimitry Andric previously_selected.classList.remove("selected"); 124*0fca6ea1SDimitry Andric previously_selected.classList.remove("seen"); 125*0fca6ea1SDimitry Andric } 126*0fca6ea1SDimitry Andric 127*0fca6ea1SDimitry Andric const nodes = document.querySelectorAll(selector + ".seen"); 128*0fca6ea1SDimitry Andric if (nodes) { 129*0fca6ea1SDimitry Andric const last = nodes[nodes.length - 1]; // last 130*0fca6ea1SDimitry Andric return last; 131*0fca6ea1SDimitry Andric } else { 132*0fca6ea1SDimitry Andric return undefined; 133*0fca6ea1SDimitry Andric } 134*0fca6ea1SDimitry Andric } 135*0fca6ea1SDimitry Andric } 136*0fca6ea1SDimitry Andric 137*0fca6ea1SDimitry Andric function reset_all() { 138*0fca6ea1SDimitry Andric if (!reverse) { 139*0fca6ea1SDimitry Andric const all_seen = document.querySelectorAll(selector + ".seen"); 140*0fca6ea1SDimitry Andric 141*0fca6ea1SDimitry Andric if (all_seen) { 142*0fca6ea1SDimitry Andric all_seen.forEach(e => e.classList.remove("seen")); 143*0fca6ea1SDimitry Andric } 144*0fca6ea1SDimitry Andric } else { 145*0fca6ea1SDimitry Andric const all_seen = document.querySelectorAll(selector + ":not(.seen)"); 146*0fca6ea1SDimitry Andric 147*0fca6ea1SDimitry Andric if (all_seen) { 148*0fca6ea1SDimitry Andric all_seen.forEach(e => e.classList.add("seen")); 149*0fca6ea1SDimitry Andric } 150*0fca6ea1SDimitry Andric } 151*0fca6ea1SDimitry Andric 152*0fca6ea1SDimitry Andric } 153*0fca6ea1SDimitry Andric 154*0fca6ea1SDimitry Andric const uncovered = select_one(); 155*0fca6ea1SDimitry Andric 156*0fca6ea1SDimitry Andric if (uncovered) { 157*0fca6ea1SDimitry Andric visit_element(uncovered); 158*0fca6ea1SDimitry Andric } else { 159*0fca6ea1SDimitry Andric reset_all(); 160*0fca6ea1SDimitry Andric 161*0fca6ea1SDimitry Andric 162*0fca6ea1SDimitry Andric const uncovered = select_one(); 163*0fca6ea1SDimitry Andric 164*0fca6ea1SDimitry Andric if (uncovered) { 165*0fca6ea1SDimitry Andric visit_element(uncovered); 166*0fca6ea1SDimitry Andric } 167*0fca6ea1SDimitry Andric } 168*0fca6ea1SDimitry Andric } 169*0fca6ea1SDimitry Andric 170*0fca6ea1SDimitry Andric function next_line(reverse) { 171*0fca6ea1SDimitry Andric next_uncovered("td.uncovered-line", reverse) 172*0fca6ea1SDimitry Andric } 173*0fca6ea1SDimitry Andric 174*0fca6ea1SDimitry Andric function next_region(reverse) { 175*0fca6ea1SDimitry Andric next_uncovered("span.red.region", reverse); 176*0fca6ea1SDimitry Andric } 177*0fca6ea1SDimitry Andric 178*0fca6ea1SDimitry Andric function next_branch(reverse) { 179*0fca6ea1SDimitry Andric next_uncovered("span.red.branch", reverse); 180*0fca6ea1SDimitry Andric } 181*0fca6ea1SDimitry Andric 182*0fca6ea1SDimitry Andric document.addEventListener("keypress", function(event) { 183*0fca6ea1SDimitry Andric console.log(event); 184*0fca6ea1SDimitry Andric const reverse = event.shiftKey; 185*0fca6ea1SDimitry Andric if (event.code == "KeyL") { 186*0fca6ea1SDimitry Andric next_line(reverse); 187*0fca6ea1SDimitry Andric } 188*0fca6ea1SDimitry Andric if (event.code == "KeyB") { 189*0fca6ea1SDimitry Andric next_branch(reverse); 190*0fca6ea1SDimitry Andric } 191*0fca6ea1SDimitry Andric if (event.code == "KeyR") { 192*0fca6ea1SDimitry Andric next_region(reverse); 193*0fca6ea1SDimitry Andric } 194*0fca6ea1SDimitry Andric 195*0fca6ea1SDimitry Andric }); 196*0fca6ea1SDimitry Andric )javascript"; 197*0fca6ea1SDimitry Andric 1980b57cec5SDimitry Andric const char *CSSForCoverage = 1990b57cec5SDimitry Andric R"(.red { 200*0fca6ea1SDimitry Andric background-color: #f004; 2010b57cec5SDimitry Andric } 2020b57cec5SDimitry Andric .cyan { 2030b57cec5SDimitry Andric background-color: cyan; 2040b57cec5SDimitry Andric } 205*0fca6ea1SDimitry Andric html { 206*0fca6ea1SDimitry Andric scroll-behavior: smooth; 207*0fca6ea1SDimitry Andric } 2080b57cec5SDimitry Andric body { 2090b57cec5SDimitry Andric font-family: -apple-system, sans-serif; 2100b57cec5SDimitry Andric } 2110b57cec5SDimitry Andric pre { 2120b57cec5SDimitry Andric margin-top: 0px !important; 2130b57cec5SDimitry Andric margin-bottom: 0px !important; 2140b57cec5SDimitry Andric } 2150b57cec5SDimitry Andric .source-name-title { 2160b57cec5SDimitry Andric padding: 5px 10px; 217*0fca6ea1SDimitry Andric border-bottom: 1px solid #8888; 218*0fca6ea1SDimitry Andric background-color: #0002; 2190b57cec5SDimitry Andric line-height: 35px; 2200b57cec5SDimitry Andric } 2210b57cec5SDimitry Andric .centered { 2220b57cec5SDimitry Andric display: table; 2230b57cec5SDimitry Andric margin-left: left; 2240b57cec5SDimitry Andric margin-right: auto; 225*0fca6ea1SDimitry Andric border: 1px solid #8888; 2260b57cec5SDimitry Andric border-radius: 3px; 2270b57cec5SDimitry Andric } 2280b57cec5SDimitry Andric .expansion-view { 2290b57cec5SDimitry Andric margin-left: 0px; 2300b57cec5SDimitry Andric margin-top: 5px; 2310b57cec5SDimitry Andric margin-right: 5px; 2320b57cec5SDimitry Andric margin-bottom: 5px; 233*0fca6ea1SDimitry Andric border: 1px solid #8888; 2340b57cec5SDimitry Andric border-radius: 3px; 2350b57cec5SDimitry Andric } 2360b57cec5SDimitry Andric table { 2370b57cec5SDimitry Andric border-collapse: collapse; 2380b57cec5SDimitry Andric } 2390b57cec5SDimitry Andric .light-row { 240*0fca6ea1SDimitry Andric border: 1px solid #8888; 241cb14a3feSDimitry Andric border-left: none; 242cb14a3feSDimitry Andric border-right: none; 2430b57cec5SDimitry Andric } 2440b57cec5SDimitry Andric .light-row-bold { 245*0fca6ea1SDimitry Andric border: 1px solid #8888; 246cb14a3feSDimitry Andric border-left: none; 247cb14a3feSDimitry Andric border-right: none; 2480b57cec5SDimitry Andric font-weight: bold; 2490b57cec5SDimitry Andric } 2500b57cec5SDimitry Andric .column-entry { 2510b57cec5SDimitry Andric text-align: left; 2520b57cec5SDimitry Andric } 2530b57cec5SDimitry Andric .column-entry-bold { 2540b57cec5SDimitry Andric font-weight: bold; 2550b57cec5SDimitry Andric text-align: left; 2560b57cec5SDimitry Andric } 2570b57cec5SDimitry Andric .column-entry-yellow { 2580b57cec5SDimitry Andric text-align: left; 259*0fca6ea1SDimitry Andric background-color: #ff06; 2600b57cec5SDimitry Andric } 2610b57cec5SDimitry Andric .column-entry-red { 2620b57cec5SDimitry Andric text-align: left; 263*0fca6ea1SDimitry Andric background-color: #f004; 2640b57cec5SDimitry Andric } 265cb14a3feSDimitry Andric .column-entry-gray { 266cb14a3feSDimitry Andric text-align: left; 267*0fca6ea1SDimitry Andric background-color: #fff4; 268cb14a3feSDimitry Andric } 2690b57cec5SDimitry Andric .column-entry-green { 2700b57cec5SDimitry Andric text-align: left; 271*0fca6ea1SDimitry Andric background-color: #0f04; 2720b57cec5SDimitry Andric } 2730b57cec5SDimitry Andric .line-number { 2740b57cec5SDimitry Andric text-align: right; 2750b57cec5SDimitry Andric } 2760b57cec5SDimitry Andric .covered-line { 2770b57cec5SDimitry Andric text-align: right; 278*0fca6ea1SDimitry Andric color: #06d; 2790b57cec5SDimitry Andric } 2800b57cec5SDimitry Andric .uncovered-line { 2810b57cec5SDimitry Andric text-align: right; 282*0fca6ea1SDimitry Andric color: #d00; 283*0fca6ea1SDimitry Andric } 284*0fca6ea1SDimitry Andric .uncovered-line.selected { 285*0fca6ea1SDimitry Andric color: #f00; 286*0fca6ea1SDimitry Andric font-weight: bold; 287*0fca6ea1SDimitry Andric } 288*0fca6ea1SDimitry Andric .region.red.selected { 289*0fca6ea1SDimitry Andric background-color: #f008; 290*0fca6ea1SDimitry Andric font-weight: bold; 291*0fca6ea1SDimitry Andric } 292*0fca6ea1SDimitry Andric .branch.red.selected { 293*0fca6ea1SDimitry Andric background-color: #f008; 294*0fca6ea1SDimitry Andric font-weight: bold; 2950b57cec5SDimitry Andric } 2960b57cec5SDimitry Andric .tooltip { 2970b57cec5SDimitry Andric position: relative; 2980b57cec5SDimitry Andric display: inline; 299*0fca6ea1SDimitry Andric background-color: #bef; 3000b57cec5SDimitry Andric text-decoration: none; 3010b57cec5SDimitry Andric } 3020b57cec5SDimitry Andric .tooltip span.tooltip-content { 3030b57cec5SDimitry Andric position: absolute; 3040b57cec5SDimitry Andric width: 100px; 3050b57cec5SDimitry Andric margin-left: -50px; 3060b57cec5SDimitry Andric color: #FFFFFF; 3070b57cec5SDimitry Andric background: #000000; 3080b57cec5SDimitry Andric height: 30px; 3090b57cec5SDimitry Andric line-height: 30px; 3100b57cec5SDimitry Andric text-align: center; 3110b57cec5SDimitry Andric visibility: hidden; 3120b57cec5SDimitry Andric border-radius: 6px; 3130b57cec5SDimitry Andric } 3140b57cec5SDimitry Andric .tooltip span.tooltip-content:after { 3150b57cec5SDimitry Andric content: ''; 3160b57cec5SDimitry Andric position: absolute; 3170b57cec5SDimitry Andric top: 100%; 3180b57cec5SDimitry Andric left: 50%; 3190b57cec5SDimitry Andric margin-left: -8px; 3200b57cec5SDimitry Andric width: 0; height: 0; 3210b57cec5SDimitry Andric border-top: 8px solid #000000; 3220b57cec5SDimitry Andric border-right: 8px solid transparent; 3230b57cec5SDimitry Andric border-left: 8px solid transparent; 3240b57cec5SDimitry Andric } 3250b57cec5SDimitry Andric :hover.tooltip span.tooltip-content { 3260b57cec5SDimitry Andric visibility: visible; 3270b57cec5SDimitry Andric opacity: 0.8; 3280b57cec5SDimitry Andric bottom: 30px; 3290b57cec5SDimitry Andric left: 50%; 3300b57cec5SDimitry Andric z-index: 999; 3310b57cec5SDimitry Andric } 3320b57cec5SDimitry Andric th, td { 3330b57cec5SDimitry Andric vertical-align: top; 3340b57cec5SDimitry Andric padding: 2px 8px; 3350b57cec5SDimitry Andric border-collapse: collapse; 336*0fca6ea1SDimitry Andric border-right: 1px solid #8888; 337*0fca6ea1SDimitry Andric border-left: 1px solid #8888; 3380b57cec5SDimitry Andric text-align: left; 3390b57cec5SDimitry Andric } 3400b57cec5SDimitry Andric td pre { 3410b57cec5SDimitry Andric display: inline-block; 342*0fca6ea1SDimitry Andric text-decoration: inherit; 3430b57cec5SDimitry Andric } 3440b57cec5SDimitry Andric td:first-child { 3450b57cec5SDimitry Andric border-left: none; 3460b57cec5SDimitry Andric } 3470b57cec5SDimitry Andric td:last-child { 3480b57cec5SDimitry Andric border-right: none; 3490b57cec5SDimitry Andric } 3500b57cec5SDimitry Andric tr:hover { 351*0fca6ea1SDimitry Andric background-color: #eee; 3520b57cec5SDimitry Andric } 353cb14a3feSDimitry Andric tr:last-child { 354cb14a3feSDimitry Andric border-bottom: none; 355cb14a3feSDimitry Andric } 356*0fca6ea1SDimitry Andric tr:has(> td >a:target), tr:has(> td.uncovered-line.selected) { 357*0fca6ea1SDimitry Andric background-color: #8884; 358*0fca6ea1SDimitry Andric } 359*0fca6ea1SDimitry Andric a { 360*0fca6ea1SDimitry Andric color: inherit; 361*0fca6ea1SDimitry Andric } 362*0fca6ea1SDimitry Andric .control { 363*0fca6ea1SDimitry Andric position: fixed; 364*0fca6ea1SDimitry Andric top: 0em; 365*0fca6ea1SDimitry Andric right: 0em; 366*0fca6ea1SDimitry Andric padding: 1em; 367*0fca6ea1SDimitry Andric background: #FFF8; 368*0fca6ea1SDimitry Andric } 369*0fca6ea1SDimitry Andric @media (prefers-color-scheme: dark) { 370*0fca6ea1SDimitry Andric body { 371*0fca6ea1SDimitry Andric background-color: #222; 372*0fca6ea1SDimitry Andric color: whitesmoke; 373*0fca6ea1SDimitry Andric } 374*0fca6ea1SDimitry Andric tr:hover { 375*0fca6ea1SDimitry Andric background-color: #111; 376*0fca6ea1SDimitry Andric } 377*0fca6ea1SDimitry Andric .covered-line { 378*0fca6ea1SDimitry Andric color: #39f; 379*0fca6ea1SDimitry Andric } 380*0fca6ea1SDimitry Andric .uncovered-line { 381*0fca6ea1SDimitry Andric color: #f55; 382*0fca6ea1SDimitry Andric } 383*0fca6ea1SDimitry Andric .tooltip { 384*0fca6ea1SDimitry Andric background-color: #068; 385*0fca6ea1SDimitry Andric } 386*0fca6ea1SDimitry Andric .control { 387*0fca6ea1SDimitry Andric background: #2228; 388*0fca6ea1SDimitry Andric } 389*0fca6ea1SDimitry Andric tr:has(> td >a:target), tr:has(> td.uncovered-line.selected) { 390*0fca6ea1SDimitry Andric background-color: #8884; 391*0fca6ea1SDimitry Andric } 3924c2d3b02SDimitry Andric } 3930b57cec5SDimitry Andric )"; 3940b57cec5SDimitry Andric 3950b57cec5SDimitry Andric const char *EndHeader = "</head>"; 3960b57cec5SDimitry Andric 3970b57cec5SDimitry Andric const char *BeginCenteredDiv = "<div class='centered'>"; 3980b57cec5SDimitry Andric 3990b57cec5SDimitry Andric const char *EndCenteredDiv = "</div>"; 4000b57cec5SDimitry Andric 4010b57cec5SDimitry Andric const char *BeginSourceNameDiv = "<div class='source-name-title'>"; 4020b57cec5SDimitry Andric 4030b57cec5SDimitry Andric const char *EndSourceNameDiv = "</div>"; 4040b57cec5SDimitry Andric 4050b57cec5SDimitry Andric const char *BeginCodeTD = "<td class='code'>"; 4060b57cec5SDimitry Andric 4070b57cec5SDimitry Andric const char *EndCodeTD = "</td>"; 4080b57cec5SDimitry Andric 4090b57cec5SDimitry Andric const char *BeginPre = "<pre>"; 4100b57cec5SDimitry Andric 4110b57cec5SDimitry Andric const char *EndPre = "</pre>"; 4120b57cec5SDimitry Andric 4130b57cec5SDimitry Andric const char *BeginExpansionDiv = "<div class='expansion-view'>"; 4140b57cec5SDimitry Andric 4150b57cec5SDimitry Andric const char *EndExpansionDiv = "</div>"; 4160b57cec5SDimitry Andric 4170b57cec5SDimitry Andric const char *BeginTable = "<table>"; 4180b57cec5SDimitry Andric 4190b57cec5SDimitry Andric const char *EndTable = "</table>"; 4200b57cec5SDimitry Andric 4210b57cec5SDimitry Andric const char *ProjectTitleTag = "h1"; 4220b57cec5SDimitry Andric 4230b57cec5SDimitry Andric const char *ReportTitleTag = "h2"; 4240b57cec5SDimitry Andric 4250b57cec5SDimitry Andric const char *CreatedTimeTag = "h4"; 4260b57cec5SDimitry Andric 4270b57cec5SDimitry Andric std::string getPathToStyle(StringRef ViewPath) { 428e8d8bef9SDimitry Andric std::string PathToStyle; 4295ffd83dbSDimitry Andric std::string PathSep = std::string(sys::path::get_separator()); 4300b57cec5SDimitry Andric unsigned NumSeps = ViewPath.count(PathSep); 4310b57cec5SDimitry Andric for (unsigned I = 0, E = NumSeps; I < E; ++I) 4320b57cec5SDimitry Andric PathToStyle += ".." + PathSep; 4330b57cec5SDimitry Andric return PathToStyle + "style.css"; 4340b57cec5SDimitry Andric } 4350b57cec5SDimitry Andric 436*0fca6ea1SDimitry Andric std::string getPathToJavaScript(StringRef ViewPath) { 437*0fca6ea1SDimitry Andric std::string PathToJavaScript; 438*0fca6ea1SDimitry Andric std::string PathSep = std::string(sys::path::get_separator()); 439*0fca6ea1SDimitry Andric unsigned NumSeps = ViewPath.count(PathSep); 440*0fca6ea1SDimitry Andric for (unsigned I = 0, E = NumSeps; I < E; ++I) 441*0fca6ea1SDimitry Andric PathToJavaScript += ".." + PathSep; 442*0fca6ea1SDimitry Andric return PathToJavaScript + "control.js"; 443*0fca6ea1SDimitry Andric } 444*0fca6ea1SDimitry Andric 4450b57cec5SDimitry Andric void emitPrelude(raw_ostream &OS, const CoverageViewOptions &Opts, 446*0fca6ea1SDimitry Andric const std::string &PathToStyle = "", 447*0fca6ea1SDimitry Andric const std::string &PathToJavaScript = "") { 4480b57cec5SDimitry Andric OS << "<!doctype html>" 4490b57cec5SDimitry Andric "<html>" 4500b57cec5SDimitry Andric << BeginHeader; 4510b57cec5SDimitry Andric 4520b57cec5SDimitry Andric // Link to a stylesheet if one is available. Otherwise, use the default style. 4530b57cec5SDimitry Andric if (PathToStyle.empty()) 4540b57cec5SDimitry Andric OS << "<style>" << CSSForCoverage << "</style>"; 4550b57cec5SDimitry Andric else 4560b57cec5SDimitry Andric OS << "<link rel='stylesheet' type='text/css' href='" 4570b57cec5SDimitry Andric << escape(PathToStyle, Opts) << "'>"; 4580b57cec5SDimitry Andric 459*0fca6ea1SDimitry Andric // Link to a JavaScript if one is available 460*0fca6ea1SDimitry Andric if (PathToJavaScript.empty()) 461*0fca6ea1SDimitry Andric OS << "<script>" << JSForCoverage << "</script>"; 462*0fca6ea1SDimitry Andric else 463*0fca6ea1SDimitry Andric OS << "<script src='" << escape(PathToJavaScript, Opts) << "'></script>"; 464*0fca6ea1SDimitry Andric 4650b57cec5SDimitry Andric OS << EndHeader << "<body>"; 4660b57cec5SDimitry Andric } 4670b57cec5SDimitry Andric 4685f757f3fSDimitry Andric void emitTableRow(raw_ostream &OS, const CoverageViewOptions &Opts, 4695f757f3fSDimitry Andric const std::string &FirstCol, const FileCoverageSummary &FCS, 4705f757f3fSDimitry Andric bool IsTotals) { 4715f757f3fSDimitry Andric SmallVector<std::string, 8> Columns; 4725f757f3fSDimitry Andric 4735f757f3fSDimitry Andric // Format a coverage triple and add the result to the list of columns. 4745f757f3fSDimitry Andric auto AddCoverageTripleToColumn = 4755f757f3fSDimitry Andric [&Columns, &Opts](unsigned Hit, unsigned Total, float Pctg) { 4765f757f3fSDimitry Andric std::string S; 4775f757f3fSDimitry Andric { 4785f757f3fSDimitry Andric raw_string_ostream RSO{S}; 4795f757f3fSDimitry Andric if (Total) 4805f757f3fSDimitry Andric RSO << format("%*.2f", 7, Pctg) << "% "; 4815f757f3fSDimitry Andric else 4825f757f3fSDimitry Andric RSO << "- "; 4835f757f3fSDimitry Andric RSO << '(' << Hit << '/' << Total << ')'; 4845f757f3fSDimitry Andric } 4855f757f3fSDimitry Andric const char *CellClass = "column-entry-yellow"; 486cb14a3feSDimitry Andric if (!Total) 487cb14a3feSDimitry Andric CellClass = "column-entry-gray"; 488cb14a3feSDimitry Andric else if (Pctg >= Opts.HighCovWatermark) 4895f757f3fSDimitry Andric CellClass = "column-entry-green"; 4905f757f3fSDimitry Andric else if (Pctg < Opts.LowCovWatermark) 4915f757f3fSDimitry Andric CellClass = "column-entry-red"; 4925f757f3fSDimitry Andric Columns.emplace_back(tag("td", tag("pre", S), CellClass)); 4935f757f3fSDimitry Andric }; 4945f757f3fSDimitry Andric 4955f757f3fSDimitry Andric Columns.emplace_back(tag("td", tag("pre", FirstCol))); 4965f757f3fSDimitry Andric AddCoverageTripleToColumn(FCS.FunctionCoverage.getExecuted(), 4975f757f3fSDimitry Andric FCS.FunctionCoverage.getNumFunctions(), 4985f757f3fSDimitry Andric FCS.FunctionCoverage.getPercentCovered()); 4995f757f3fSDimitry Andric if (Opts.ShowInstantiationSummary) 5005f757f3fSDimitry Andric AddCoverageTripleToColumn(FCS.InstantiationCoverage.getExecuted(), 5015f757f3fSDimitry Andric FCS.InstantiationCoverage.getNumFunctions(), 5025f757f3fSDimitry Andric FCS.InstantiationCoverage.getPercentCovered()); 5035f757f3fSDimitry Andric AddCoverageTripleToColumn(FCS.LineCoverage.getCovered(), 5045f757f3fSDimitry Andric FCS.LineCoverage.getNumLines(), 5055f757f3fSDimitry Andric FCS.LineCoverage.getPercentCovered()); 5065f757f3fSDimitry Andric if (Opts.ShowRegionSummary) 5075f757f3fSDimitry Andric AddCoverageTripleToColumn(FCS.RegionCoverage.getCovered(), 5085f757f3fSDimitry Andric FCS.RegionCoverage.getNumRegions(), 5095f757f3fSDimitry Andric FCS.RegionCoverage.getPercentCovered()); 5105f757f3fSDimitry Andric if (Opts.ShowBranchSummary) 5115f757f3fSDimitry Andric AddCoverageTripleToColumn(FCS.BranchCoverage.getCovered(), 5125f757f3fSDimitry Andric FCS.BranchCoverage.getNumBranches(), 5135f757f3fSDimitry Andric FCS.BranchCoverage.getPercentCovered()); 5145f757f3fSDimitry Andric if (Opts.ShowMCDCSummary) 5155f757f3fSDimitry Andric AddCoverageTripleToColumn(FCS.MCDCCoverage.getCoveredPairs(), 5165f757f3fSDimitry Andric FCS.MCDCCoverage.getNumPairs(), 5175f757f3fSDimitry Andric FCS.MCDCCoverage.getPercentCovered()); 5185f757f3fSDimitry Andric 5195f757f3fSDimitry Andric if (IsTotals) 5205f757f3fSDimitry Andric OS << tag("tr", join(Columns.begin(), Columns.end(), ""), "light-row-bold"); 5215f757f3fSDimitry Andric else 5225f757f3fSDimitry Andric OS << tag("tr", join(Columns.begin(), Columns.end(), ""), "light-row"); 5235f757f3fSDimitry Andric } 5245f757f3fSDimitry Andric 5250b57cec5SDimitry Andric void emitEpilog(raw_ostream &OS) { 5260b57cec5SDimitry Andric OS << "</body>" 5270b57cec5SDimitry Andric << "</html>"; 5280b57cec5SDimitry Andric } 5290b57cec5SDimitry Andric 5300b57cec5SDimitry Andric } // anonymous namespace 5310b57cec5SDimitry Andric 5320b57cec5SDimitry Andric Expected<CoveragePrinter::OwnedStream> 5330b57cec5SDimitry Andric CoveragePrinterHTML::createViewFile(StringRef Path, bool InToplevel) { 5340b57cec5SDimitry Andric auto OSOrErr = createOutputStream(Path, "html", InToplevel); 5350b57cec5SDimitry Andric if (!OSOrErr) 5360b57cec5SDimitry Andric return OSOrErr; 5370b57cec5SDimitry Andric 5380b57cec5SDimitry Andric OwnedStream OS = std::move(OSOrErr.get()); 5390b57cec5SDimitry Andric 5400b57cec5SDimitry Andric if (!Opts.hasOutputDirectory()) { 5410b57cec5SDimitry Andric emitPrelude(*OS.get(), Opts); 5420b57cec5SDimitry Andric } else { 5430b57cec5SDimitry Andric std::string ViewPath = getOutputPath(Path, "html", InToplevel); 544*0fca6ea1SDimitry Andric emitPrelude(*OS.get(), Opts, getPathToStyle(ViewPath), 545*0fca6ea1SDimitry Andric getPathToJavaScript(ViewPath)); 5460b57cec5SDimitry Andric } 5470b57cec5SDimitry Andric 5480b57cec5SDimitry Andric return std::move(OS); 5490b57cec5SDimitry Andric } 5500b57cec5SDimitry Andric 5510b57cec5SDimitry Andric void CoveragePrinterHTML::closeViewFile(OwnedStream OS) { 5520b57cec5SDimitry Andric emitEpilog(*OS.get()); 5530b57cec5SDimitry Andric } 5540b57cec5SDimitry Andric 5550b57cec5SDimitry Andric /// Emit column labels for the table in the index. 5560b57cec5SDimitry Andric static void emitColumnLabelsForIndex(raw_ostream &OS, 5570b57cec5SDimitry Andric const CoverageViewOptions &Opts) { 5580b57cec5SDimitry Andric SmallVector<std::string, 4> Columns; 5590b57cec5SDimitry Andric Columns.emplace_back(tag("td", "Filename", "column-entry-bold")); 5600b57cec5SDimitry Andric Columns.emplace_back(tag("td", "Function Coverage", "column-entry-bold")); 5610b57cec5SDimitry Andric if (Opts.ShowInstantiationSummary) 5620b57cec5SDimitry Andric Columns.emplace_back( 5630b57cec5SDimitry Andric tag("td", "Instantiation Coverage", "column-entry-bold")); 5640b57cec5SDimitry Andric Columns.emplace_back(tag("td", "Line Coverage", "column-entry-bold")); 5650b57cec5SDimitry Andric if (Opts.ShowRegionSummary) 5660b57cec5SDimitry Andric Columns.emplace_back(tag("td", "Region Coverage", "column-entry-bold")); 567e8d8bef9SDimitry Andric if (Opts.ShowBranchSummary) 568e8d8bef9SDimitry Andric Columns.emplace_back(tag("td", "Branch Coverage", "column-entry-bold")); 5695f757f3fSDimitry Andric if (Opts.ShowMCDCSummary) 5705f757f3fSDimitry Andric Columns.emplace_back(tag("td", "MC/DC", "column-entry-bold")); 5710b57cec5SDimitry Andric OS << tag("tr", join(Columns.begin(), Columns.end(), "")); 5720b57cec5SDimitry Andric } 5730b57cec5SDimitry Andric 5740b57cec5SDimitry Andric std::string 5750b57cec5SDimitry Andric CoveragePrinterHTML::buildLinkToFile(StringRef SF, 5760b57cec5SDimitry Andric const FileCoverageSummary &FCS) const { 5770b57cec5SDimitry Andric SmallString<128> LinkTextStr(sys::path::relative_path(FCS.Name)); 57804eeddc0SDimitry Andric sys::path::remove_dots(LinkTextStr, /*remove_dot_dot=*/true); 5790b57cec5SDimitry Andric sys::path::native(LinkTextStr); 5800b57cec5SDimitry Andric std::string LinkText = escape(LinkTextStr, Opts); 5810b57cec5SDimitry Andric std::string LinkTarget = 5820b57cec5SDimitry Andric escape(getOutputPath(SF, "html", /*InToplevel=*/false), Opts); 5830b57cec5SDimitry Andric return a(LinkTarget, LinkText); 5840b57cec5SDimitry Andric } 5850b57cec5SDimitry Andric 5865f757f3fSDimitry Andric Error CoveragePrinterHTML::emitStyleSheet() { 5870b57cec5SDimitry Andric auto CSSOrErr = createOutputStream("style", "css", /*InToplevel=*/true); 5880b57cec5SDimitry Andric if (Error E = CSSOrErr.takeError()) 5890b57cec5SDimitry Andric return E; 5900b57cec5SDimitry Andric 5910b57cec5SDimitry Andric OwnedStream CSS = std::move(CSSOrErr.get()); 5920b57cec5SDimitry Andric CSS->operator<<(CSSForCoverage); 5930b57cec5SDimitry Andric 5945f757f3fSDimitry Andric return Error::success(); 5955f757f3fSDimitry Andric } 5960b57cec5SDimitry Andric 597*0fca6ea1SDimitry Andric Error CoveragePrinterHTML::emitJavaScript() { 598*0fca6ea1SDimitry Andric auto JSOrErr = createOutputStream("control", "js", /*InToplevel=*/true); 599*0fca6ea1SDimitry Andric if (Error E = JSOrErr.takeError()) 600*0fca6ea1SDimitry Andric return E; 601*0fca6ea1SDimitry Andric 602*0fca6ea1SDimitry Andric OwnedStream JS = std::move(JSOrErr.get()); 603*0fca6ea1SDimitry Andric JS->operator<<(JSForCoverage); 604*0fca6ea1SDimitry Andric 605*0fca6ea1SDimitry Andric return Error::success(); 606*0fca6ea1SDimitry Andric } 607*0fca6ea1SDimitry Andric 6085f757f3fSDimitry Andric void CoveragePrinterHTML::emitReportHeader(raw_ostream &OSRef, 6095f757f3fSDimitry Andric const std::string &Title) { 6100b57cec5SDimitry Andric // Emit some basic information about the coverage report. 6110b57cec5SDimitry Andric if (Opts.hasProjectTitle()) 6120b57cec5SDimitry Andric OSRef << tag(ProjectTitleTag, escape(Opts.ProjectTitle, Opts)); 6135f757f3fSDimitry Andric OSRef << tag(ReportTitleTag, Title); 6140b57cec5SDimitry Andric if (Opts.hasCreatedTime()) 6150b57cec5SDimitry Andric OSRef << tag(CreatedTimeTag, escape(Opts.CreatedTimeStr, Opts)); 6160b57cec5SDimitry Andric 6170b57cec5SDimitry Andric // Emit a link to some documentation. 6180b57cec5SDimitry Andric OSRef << tag("p", "Click " + 6190b57cec5SDimitry Andric a("http://clang.llvm.org/docs/" 6200b57cec5SDimitry Andric "SourceBasedCodeCoverage.html#interpreting-reports", 6210b57cec5SDimitry Andric "here") + 6220b57cec5SDimitry Andric " for information about interpreting this report."); 6230b57cec5SDimitry Andric 6240b57cec5SDimitry Andric // Emit a table containing links to reports for each file in the covmapping. 6250b57cec5SDimitry Andric // Exclude files which don't contain any regions. 6260b57cec5SDimitry Andric OSRef << BeginCenteredDiv << BeginTable; 6270b57cec5SDimitry Andric emitColumnLabelsForIndex(OSRef, Opts); 6285f757f3fSDimitry Andric } 6295f757f3fSDimitry Andric 6305f757f3fSDimitry Andric /// Render a file coverage summary (\p FCS) in a table row. If \p IsTotals is 6315f757f3fSDimitry Andric /// false, link the summary to \p SF. 6325f757f3fSDimitry Andric void CoveragePrinterHTML::emitFileSummary(raw_ostream &OS, StringRef SF, 6335f757f3fSDimitry Andric const FileCoverageSummary &FCS, 6345f757f3fSDimitry Andric bool IsTotals) const { 6355f757f3fSDimitry Andric // Simplify the display file path, and wrap it in a link if requested. 6365f757f3fSDimitry Andric std::string Filename; 6375f757f3fSDimitry Andric if (IsTotals) { 6385f757f3fSDimitry Andric Filename = std::string(SF); 6395f757f3fSDimitry Andric } else { 6405f757f3fSDimitry Andric Filename = buildLinkToFile(SF, FCS); 6415f757f3fSDimitry Andric } 6425f757f3fSDimitry Andric 6435f757f3fSDimitry Andric emitTableRow(OS, Opts, Filename, FCS, IsTotals); 6445f757f3fSDimitry Andric } 6455f757f3fSDimitry Andric 6465f757f3fSDimitry Andric Error CoveragePrinterHTML::createIndexFile( 6475f757f3fSDimitry Andric ArrayRef<std::string> SourceFiles, const CoverageMapping &Coverage, 6485f757f3fSDimitry Andric const CoverageFiltersMatchAll &Filters) { 6495f757f3fSDimitry Andric // Emit the default stylesheet. 6505f757f3fSDimitry Andric if (Error E = emitStyleSheet()) 6515f757f3fSDimitry Andric return E; 6525f757f3fSDimitry Andric 653*0fca6ea1SDimitry Andric // Emit the JavaScript UI implementation 654*0fca6ea1SDimitry Andric if (Error E = emitJavaScript()) 655*0fca6ea1SDimitry Andric return E; 656*0fca6ea1SDimitry Andric 6575f757f3fSDimitry Andric // Emit a file index along with some coverage statistics. 6585f757f3fSDimitry Andric auto OSOrErr = createOutputStream("index", "html", /*InToplevel=*/true); 6595f757f3fSDimitry Andric if (Error E = OSOrErr.takeError()) 6605f757f3fSDimitry Andric return E; 6615f757f3fSDimitry Andric auto OS = std::move(OSOrErr.get()); 6625f757f3fSDimitry Andric raw_ostream &OSRef = *OS.get(); 6635f757f3fSDimitry Andric 6645f757f3fSDimitry Andric assert(Opts.hasOutputDirectory() && "No output directory for index file"); 665*0fca6ea1SDimitry Andric emitPrelude(OSRef, Opts, getPathToStyle(""), getPathToJavaScript("")); 6665f757f3fSDimitry Andric 6675f757f3fSDimitry Andric emitReportHeader(OSRef, "Coverage Report"); 6685f757f3fSDimitry Andric 6690b57cec5SDimitry Andric FileCoverageSummary Totals("TOTALS"); 6700b57cec5SDimitry Andric auto FileReports = CoverageReport::prepareFileReports( 6710b57cec5SDimitry Andric Coverage, Totals, SourceFiles, Opts, Filters); 6720b57cec5SDimitry Andric bool EmptyFiles = false; 6730b57cec5SDimitry Andric for (unsigned I = 0, E = FileReports.size(); I < E; ++I) { 6740b57cec5SDimitry Andric if (FileReports[I].FunctionCoverage.getNumFunctions()) 6750b57cec5SDimitry Andric emitFileSummary(OSRef, SourceFiles[I], FileReports[I]); 6760b57cec5SDimitry Andric else 6770b57cec5SDimitry Andric EmptyFiles = true; 6780b57cec5SDimitry Andric } 6790b57cec5SDimitry Andric emitFileSummary(OSRef, "Totals", Totals, /*IsTotals=*/true); 6800b57cec5SDimitry Andric OSRef << EndTable << EndCenteredDiv; 6810b57cec5SDimitry Andric 6820b57cec5SDimitry Andric // Emit links to files which don't contain any functions. These are normally 6830b57cec5SDimitry Andric // not very useful, but could be relevant for code which abuses the 6840b57cec5SDimitry Andric // preprocessor. 6850b57cec5SDimitry Andric if (EmptyFiles && Filters.empty()) { 6860b57cec5SDimitry Andric OSRef << tag("p", "Files which contain no functions. (These " 6870b57cec5SDimitry Andric "files contain code pulled into other files " 6880b57cec5SDimitry Andric "by the preprocessor.)\n"); 6890b57cec5SDimitry Andric OSRef << BeginCenteredDiv << BeginTable; 6900b57cec5SDimitry Andric for (unsigned I = 0, E = FileReports.size(); I < E; ++I) 6910b57cec5SDimitry Andric if (!FileReports[I].FunctionCoverage.getNumFunctions()) { 6920b57cec5SDimitry Andric std::string Link = buildLinkToFile(SourceFiles[I], FileReports[I]); 6930b57cec5SDimitry Andric OSRef << tag("tr", tag("td", tag("pre", Link)), "light-row") << '\n'; 6940b57cec5SDimitry Andric } 6950b57cec5SDimitry Andric OSRef << EndTable << EndCenteredDiv; 6960b57cec5SDimitry Andric } 6970b57cec5SDimitry Andric 6980b57cec5SDimitry Andric OSRef << tag("h5", escape(Opts.getLLVMVersionString(), Opts)); 6990b57cec5SDimitry Andric emitEpilog(OSRef); 7000b57cec5SDimitry Andric 7010b57cec5SDimitry Andric return Error::success(); 7020b57cec5SDimitry Andric } 7030b57cec5SDimitry Andric 7045f757f3fSDimitry Andric struct CoveragePrinterHTMLDirectory::Reporter : public DirectoryCoverageReport { 7055f757f3fSDimitry Andric CoveragePrinterHTMLDirectory &Printer; 7065f757f3fSDimitry Andric 7075f757f3fSDimitry Andric Reporter(CoveragePrinterHTMLDirectory &Printer, 7085f757f3fSDimitry Andric const coverage::CoverageMapping &Coverage, 7095f757f3fSDimitry Andric const CoverageFiltersMatchAll &Filters) 7105f757f3fSDimitry Andric : DirectoryCoverageReport(Printer.Opts, Coverage, Filters), 7115f757f3fSDimitry Andric Printer(Printer) {} 7125f757f3fSDimitry Andric 7135f757f3fSDimitry Andric Error generateSubDirectoryReport(SubFileReports &&SubFiles, 7145f757f3fSDimitry Andric SubDirReports &&SubDirs, 7155f757f3fSDimitry Andric FileCoverageSummary &&SubTotals) override { 7165f757f3fSDimitry Andric auto &LCPath = SubTotals.Name; 7175f757f3fSDimitry Andric assert(Options.hasOutputDirectory() && 7185f757f3fSDimitry Andric "No output directory for index file"); 7195f757f3fSDimitry Andric 7205f757f3fSDimitry Andric SmallString<128> OSPath = LCPath; 7215f757f3fSDimitry Andric sys::path::append(OSPath, "index"); 7225f757f3fSDimitry Andric auto OSOrErr = Printer.createOutputStream(OSPath, "html", 7235f757f3fSDimitry Andric /*InToplevel=*/false); 7245f757f3fSDimitry Andric if (auto E = OSOrErr.takeError()) 7255f757f3fSDimitry Andric return E; 7265f757f3fSDimitry Andric auto OS = std::move(OSOrErr.get()); 7275f757f3fSDimitry Andric raw_ostream &OSRef = *OS.get(); 7285f757f3fSDimitry Andric 7295f757f3fSDimitry Andric auto IndexHtmlPath = Printer.getOutputPath((LCPath + "index").str(), "html", 7305f757f3fSDimitry Andric /*InToplevel=*/false); 731*0fca6ea1SDimitry Andric emitPrelude(OSRef, Options, getPathToStyle(IndexHtmlPath), 732*0fca6ea1SDimitry Andric getPathToJavaScript(IndexHtmlPath)); 7335f757f3fSDimitry Andric 7345f757f3fSDimitry Andric auto NavLink = buildTitleLinks(LCPath); 7355f757f3fSDimitry Andric Printer.emitReportHeader(OSRef, "Coverage Report (" + NavLink + ")"); 7365f757f3fSDimitry Andric 7375f757f3fSDimitry Andric std::vector<const FileCoverageSummary *> EmptyFiles; 7385f757f3fSDimitry Andric 7395f757f3fSDimitry Andric // Make directories at the top of the table. 7405f757f3fSDimitry Andric for (auto &&SubDir : SubDirs) { 7415f757f3fSDimitry Andric auto &Report = SubDir.second.first; 7425f757f3fSDimitry Andric if (!Report.FunctionCoverage.getNumFunctions()) 7435f757f3fSDimitry Andric EmptyFiles.push_back(&Report); 7445f757f3fSDimitry Andric else 7455f757f3fSDimitry Andric emitTableRow(OSRef, Options, buildRelLinkToFile(Report.Name), Report, 7465f757f3fSDimitry Andric /*IsTotals=*/false); 7475f757f3fSDimitry Andric } 7485f757f3fSDimitry Andric 7495f757f3fSDimitry Andric for (auto &&SubFile : SubFiles) { 7505f757f3fSDimitry Andric auto &Report = SubFile.second; 7515f757f3fSDimitry Andric if (!Report.FunctionCoverage.getNumFunctions()) 7525f757f3fSDimitry Andric EmptyFiles.push_back(&Report); 7535f757f3fSDimitry Andric else 7545f757f3fSDimitry Andric emitTableRow(OSRef, Options, buildRelLinkToFile(Report.Name), Report, 7555f757f3fSDimitry Andric /*IsTotals=*/false); 7565f757f3fSDimitry Andric } 7575f757f3fSDimitry Andric 7585f757f3fSDimitry Andric // Emit the totals row. 7595f757f3fSDimitry Andric emitTableRow(OSRef, Options, "Totals", SubTotals, /*IsTotals=*/false); 7605f757f3fSDimitry Andric OSRef << EndTable << EndCenteredDiv; 7615f757f3fSDimitry Andric 7625f757f3fSDimitry Andric // Emit links to files which don't contain any functions. These are normally 7635f757f3fSDimitry Andric // not very useful, but could be relevant for code which abuses the 7645f757f3fSDimitry Andric // preprocessor. 7655f757f3fSDimitry Andric if (!EmptyFiles.empty()) { 7665f757f3fSDimitry Andric OSRef << tag("p", "Files which contain no functions. (These " 7675f757f3fSDimitry Andric "files contain code pulled into other files " 7685f757f3fSDimitry Andric "by the preprocessor.)\n"); 7695f757f3fSDimitry Andric OSRef << BeginCenteredDiv << BeginTable; 7705f757f3fSDimitry Andric for (auto FCS : EmptyFiles) { 7715f757f3fSDimitry Andric auto Link = buildRelLinkToFile(FCS->Name); 7725f757f3fSDimitry Andric OSRef << tag("tr", tag("td", tag("pre", Link)), "light-row") << '\n'; 7735f757f3fSDimitry Andric } 7745f757f3fSDimitry Andric OSRef << EndTable << EndCenteredDiv; 7755f757f3fSDimitry Andric } 7765f757f3fSDimitry Andric 7775f757f3fSDimitry Andric // Emit epilog. 7785f757f3fSDimitry Andric OSRef << tag("h5", escape(Options.getLLVMVersionString(), Options)); 7795f757f3fSDimitry Andric emitEpilog(OSRef); 7805f757f3fSDimitry Andric 7815f757f3fSDimitry Andric return Error::success(); 7825f757f3fSDimitry Andric } 7835f757f3fSDimitry Andric 7845f757f3fSDimitry Andric /// Make a title with hyperlinks to the index.html files of each hierarchy 7855f757f3fSDimitry Andric /// of the report. 7865f757f3fSDimitry Andric std::string buildTitleLinks(StringRef LCPath) const { 7875f757f3fSDimitry Andric // For each report level in LCPStack, extract the path component and 7885f757f3fSDimitry Andric // calculate the number of "../" relative to current LCPath. 7895f757f3fSDimitry Andric SmallVector<std::pair<SmallString<128>, unsigned>, 16> Components; 7905f757f3fSDimitry Andric 7915f757f3fSDimitry Andric auto Iter = LCPStack.begin(), IterE = LCPStack.end(); 7925f757f3fSDimitry Andric SmallString<128> RootPath; 7935f757f3fSDimitry Andric if (*Iter == 0) { 7945f757f3fSDimitry Andric // If llvm-cov works on relative coverage mapping data, the LCP of 7955f757f3fSDimitry Andric // all source file paths can be 0, which makes the title path empty. 7965f757f3fSDimitry Andric // As we like adding a slash at the back of the path to indicate a 7975f757f3fSDimitry Andric // directory, in this case, we use "." as the root path to make it 7985f757f3fSDimitry Andric // not be confused with the root path "/". 7995f757f3fSDimitry Andric RootPath = "."; 8005f757f3fSDimitry Andric } else { 8015f757f3fSDimitry Andric RootPath = LCPath.substr(0, *Iter); 8025f757f3fSDimitry Andric sys::path::native(RootPath); 8035f757f3fSDimitry Andric sys::path::remove_dots(RootPath, /*remove_dot_dot=*/true); 8045f757f3fSDimitry Andric } 8055f757f3fSDimitry Andric Components.emplace_back(std::move(RootPath), 0); 8065f757f3fSDimitry Andric 8075f757f3fSDimitry Andric for (auto Last = *Iter; ++Iter != IterE; Last = *Iter) { 8085f757f3fSDimitry Andric SmallString<128> SubPath = LCPath.substr(Last, *Iter - Last); 8095f757f3fSDimitry Andric sys::path::native(SubPath); 8105f757f3fSDimitry Andric sys::path::remove_dots(SubPath, /*remove_dot_dot=*/true); 8115f757f3fSDimitry Andric auto Level = unsigned(SubPath.count(sys::path::get_separator())) + 1; 8125f757f3fSDimitry Andric Components.back().second += Level; 8135f757f3fSDimitry Andric Components.emplace_back(std::move(SubPath), Level); 8145f757f3fSDimitry Andric } 8155f757f3fSDimitry Andric 8165f757f3fSDimitry Andric // Then we make the title accroding to Components. 8175f757f3fSDimitry Andric std::string S; 8185f757f3fSDimitry Andric for (auto I = Components.begin(), E = Components.end();;) { 8195f757f3fSDimitry Andric auto &Name = I->first; 8205f757f3fSDimitry Andric if (++I == E) { 8215f757f3fSDimitry Andric S += a("./index.html", Name); 8225f757f3fSDimitry Andric S += sys::path::get_separator(); 8235f757f3fSDimitry Andric break; 8245f757f3fSDimitry Andric } 8255f757f3fSDimitry Andric 8265f757f3fSDimitry Andric SmallString<128> Link; 8275f757f3fSDimitry Andric for (unsigned J = I->second; J > 0; --J) 8285f757f3fSDimitry Andric Link += "../"; 8295f757f3fSDimitry Andric Link += "index.html"; 8305f757f3fSDimitry Andric S += a(Link, Name); 8315f757f3fSDimitry Andric S += sys::path::get_separator(); 8325f757f3fSDimitry Andric } 8335f757f3fSDimitry Andric return S; 8345f757f3fSDimitry Andric } 8355f757f3fSDimitry Andric 8365f757f3fSDimitry Andric std::string buildRelLinkToFile(StringRef RelPath) const { 8375f757f3fSDimitry Andric SmallString<128> LinkTextStr(RelPath); 8385f757f3fSDimitry Andric sys::path::native(LinkTextStr); 8395f757f3fSDimitry Andric 8405f757f3fSDimitry Andric // remove_dots will remove trailing slash, so we need to check before it. 8415f757f3fSDimitry Andric auto IsDir = LinkTextStr.ends_with(sys::path::get_separator()); 8425f757f3fSDimitry Andric sys::path::remove_dots(LinkTextStr, /*remove_dot_dot=*/true); 8435f757f3fSDimitry Andric 8445f757f3fSDimitry Andric SmallString<128> LinkTargetStr(LinkTextStr); 8455f757f3fSDimitry Andric if (IsDir) { 8465f757f3fSDimitry Andric LinkTextStr += sys::path::get_separator(); 8475f757f3fSDimitry Andric sys::path::append(LinkTargetStr, "index.html"); 8485f757f3fSDimitry Andric } else { 8495f757f3fSDimitry Andric LinkTargetStr += ".html"; 8505f757f3fSDimitry Andric } 8515f757f3fSDimitry Andric 8525f757f3fSDimitry Andric auto LinkText = escape(LinkTextStr, Options); 8535f757f3fSDimitry Andric auto LinkTarget = escape(LinkTargetStr, Options); 8545f757f3fSDimitry Andric return a(LinkTarget, LinkText); 8555f757f3fSDimitry Andric } 8565f757f3fSDimitry Andric }; 8575f757f3fSDimitry Andric 8585f757f3fSDimitry Andric Error CoveragePrinterHTMLDirectory::createIndexFile( 8595f757f3fSDimitry Andric ArrayRef<std::string> SourceFiles, const CoverageMapping &Coverage, 8605f757f3fSDimitry Andric const CoverageFiltersMatchAll &Filters) { 8615f757f3fSDimitry Andric // The createSubIndexFile function only works when SourceFiles is 8625f757f3fSDimitry Andric // more than one. So we fallback to CoveragePrinterHTML when it is. 8635f757f3fSDimitry Andric if (SourceFiles.size() <= 1) 8645f757f3fSDimitry Andric return CoveragePrinterHTML::createIndexFile(SourceFiles, Coverage, Filters); 8655f757f3fSDimitry Andric 8665f757f3fSDimitry Andric // Emit the default stylesheet. 8675f757f3fSDimitry Andric if (Error E = emitStyleSheet()) 8685f757f3fSDimitry Andric return E; 8695f757f3fSDimitry Andric 870*0fca6ea1SDimitry Andric // Emit the JavaScript UI implementation 871*0fca6ea1SDimitry Andric if (Error E = emitJavaScript()) 872*0fca6ea1SDimitry Andric return E; 873*0fca6ea1SDimitry Andric 8745f757f3fSDimitry Andric // Emit index files in every subdirectory. 8755f757f3fSDimitry Andric Reporter Report(*this, Coverage, Filters); 8765f757f3fSDimitry Andric auto TotalsOrErr = Report.prepareDirectoryReports(SourceFiles); 8775f757f3fSDimitry Andric if (auto E = TotalsOrErr.takeError()) 8785f757f3fSDimitry Andric return E; 8795f757f3fSDimitry Andric auto &LCPath = TotalsOrErr->Name; 8805f757f3fSDimitry Andric 8815f757f3fSDimitry Andric // Emit the top level index file. Top level index file is just a redirection 8825f757f3fSDimitry Andric // to the index file in the LCP directory. 8835f757f3fSDimitry Andric auto OSOrErr = createOutputStream("index", "html", /*InToplevel=*/true); 8845f757f3fSDimitry Andric if (auto E = OSOrErr.takeError()) 8855f757f3fSDimitry Andric return E; 8865f757f3fSDimitry Andric auto OS = std::move(OSOrErr.get()); 8875f757f3fSDimitry Andric auto LCPIndexFilePath = 8885f757f3fSDimitry Andric getOutputPath((LCPath + "index").str(), "html", /*InToplevel=*/false); 8895f757f3fSDimitry Andric *OS.get() << R"(<!DOCTYPE html> 8905f757f3fSDimitry Andric <html> 8915f757f3fSDimitry Andric <head> 8925f757f3fSDimitry Andric <meta http-equiv="Refresh" content="0; url=')" 8935f757f3fSDimitry Andric << LCPIndexFilePath << R"('" /> 8945f757f3fSDimitry Andric </head> 8955f757f3fSDimitry Andric <body></body> 8965f757f3fSDimitry Andric </html> 8975f757f3fSDimitry Andric )"; 8985f757f3fSDimitry Andric 8995f757f3fSDimitry Andric return Error::success(); 9005f757f3fSDimitry Andric } 9015f757f3fSDimitry Andric 9020b57cec5SDimitry Andric void SourceCoverageViewHTML::renderViewHeader(raw_ostream &OS) { 9030b57cec5SDimitry Andric OS << BeginCenteredDiv << BeginTable; 9040b57cec5SDimitry Andric } 9050b57cec5SDimitry Andric 9060b57cec5SDimitry Andric void SourceCoverageViewHTML::renderViewFooter(raw_ostream &OS) { 9070b57cec5SDimitry Andric OS << EndTable << EndCenteredDiv; 9080b57cec5SDimitry Andric } 9090b57cec5SDimitry Andric 9100b57cec5SDimitry Andric void SourceCoverageViewHTML::renderSourceName(raw_ostream &OS, bool WholeFile) { 9110b57cec5SDimitry Andric OS << BeginSourceNameDiv << tag("pre", escape(getSourceName(), getOptions())) 9120b57cec5SDimitry Andric << EndSourceNameDiv; 9130b57cec5SDimitry Andric } 9140b57cec5SDimitry Andric 9150b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLinePrefix(raw_ostream &OS, unsigned) { 9160b57cec5SDimitry Andric OS << "<tr>"; 9170b57cec5SDimitry Andric } 9180b57cec5SDimitry Andric 9190b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLineSuffix(raw_ostream &OS, unsigned) { 9200b57cec5SDimitry Andric // If this view has sub-views, renderLine() cannot close the view's cell. 9210b57cec5SDimitry Andric // Take care of it here, after all sub-views have been rendered. 9220b57cec5SDimitry Andric if (hasSubViews()) 9230b57cec5SDimitry Andric OS << EndCodeTD; 9240b57cec5SDimitry Andric OS << "</tr>"; 9250b57cec5SDimitry Andric } 9260b57cec5SDimitry Andric 9270b57cec5SDimitry Andric void SourceCoverageViewHTML::renderViewDivider(raw_ostream &, unsigned) { 9280b57cec5SDimitry Andric // The table-based output makes view dividers unnecessary. 9290b57cec5SDimitry Andric } 9300b57cec5SDimitry Andric 9310b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLine(raw_ostream &OS, LineRef L, 9320b57cec5SDimitry Andric const LineCoverageStats &LCS, 9330b57cec5SDimitry Andric unsigned ExpansionCol, unsigned) { 9340b57cec5SDimitry Andric StringRef Line = L.Line; 9350b57cec5SDimitry Andric unsigned LineNo = L.LineNo; 9360b57cec5SDimitry Andric 9370b57cec5SDimitry Andric // Steps for handling text-escaping, highlighting, and tooltip creation: 9380b57cec5SDimitry Andric // 9390b57cec5SDimitry Andric // 1. Split the line into N+1 snippets, where N = |Segments|. The first 9400b57cec5SDimitry Andric // snippet starts from Col=1 and ends at the start of the first segment. 9410b57cec5SDimitry Andric // The last snippet starts at the last mapped column in the line and ends 9420b57cec5SDimitry Andric // at the end of the line. Both are required but may be empty. 9430b57cec5SDimitry Andric 9440b57cec5SDimitry Andric SmallVector<std::string, 8> Snippets; 9450b57cec5SDimitry Andric CoverageSegmentArray Segments = LCS.getLineSegments(); 9460b57cec5SDimitry Andric 9470b57cec5SDimitry Andric unsigned LCol = 1; 9480b57cec5SDimitry Andric auto Snip = [&](unsigned Start, unsigned Len) { 9495ffd83dbSDimitry Andric Snippets.push_back(std::string(Line.substr(Start, Len))); 9500b57cec5SDimitry Andric LCol += Len; 9510b57cec5SDimitry Andric }; 9520b57cec5SDimitry Andric 9530b57cec5SDimitry Andric Snip(LCol - 1, Segments.empty() ? 0 : (Segments.front()->Col - 1)); 9540b57cec5SDimitry Andric 9550b57cec5SDimitry Andric for (unsigned I = 1, E = Segments.size(); I < E; ++I) 9560b57cec5SDimitry Andric Snip(LCol - 1, Segments[I]->Col - LCol); 9570b57cec5SDimitry Andric 9580b57cec5SDimitry Andric // |Line| + 1 is needed to avoid underflow when, e.g |Line| = 0 and LCol = 1. 9590b57cec5SDimitry Andric Snip(LCol - 1, Line.size() + 1 - LCol); 9600b57cec5SDimitry Andric 9610b57cec5SDimitry Andric // 2. Escape all of the snippets. 9620b57cec5SDimitry Andric 9630b57cec5SDimitry Andric for (unsigned I = 0, E = Snippets.size(); I < E; ++I) 9640b57cec5SDimitry Andric Snippets[I] = escape(Snippets[I], getOptions()); 9650b57cec5SDimitry Andric 9660b57cec5SDimitry Andric // 3. Use \p WrappedSegment to set the highlight for snippet 0. Use segment 9670b57cec5SDimitry Andric // 1 to set the highlight for snippet 2, segment 2 to set the highlight for 9680b57cec5SDimitry Andric // snippet 3, and so on. 9690b57cec5SDimitry Andric 970bdd1243dSDimitry Andric std::optional<StringRef> Color; 9710b57cec5SDimitry Andric SmallVector<std::pair<unsigned, unsigned>, 2> HighlightedRanges; 9720b57cec5SDimitry Andric auto Highlight = [&](const std::string &Snippet, unsigned LC, unsigned RC) { 9730b57cec5SDimitry Andric if (getOptions().Debug) 9740b57cec5SDimitry Andric HighlightedRanges.emplace_back(LC, RC); 975*0fca6ea1SDimitry Andric if (Snippet.empty()) 97681ad6265SDimitry Andric return tag("span", Snippet, std::string(*Color)); 977*0fca6ea1SDimitry Andric else 978*0fca6ea1SDimitry Andric return tag("span", Snippet, "region " + std::string(*Color)); 9790b57cec5SDimitry Andric }; 9800b57cec5SDimitry Andric 9810b57cec5SDimitry Andric auto CheckIfUncovered = [&](const CoverageSegment *S) { 9820b57cec5SDimitry Andric return S && (!S->IsGapRegion || (Color && *Color == "red")) && 9830b57cec5SDimitry Andric S->HasCount && S->Count == 0; 9840b57cec5SDimitry Andric }; 9850b57cec5SDimitry Andric 9860b57cec5SDimitry Andric if (CheckIfUncovered(LCS.getWrappedSegment())) { 9870b57cec5SDimitry Andric Color = "red"; 9880b57cec5SDimitry Andric if (!Snippets[0].empty()) 9890b57cec5SDimitry Andric Snippets[0] = Highlight(Snippets[0], 1, 1 + Snippets[0].size()); 9900b57cec5SDimitry Andric } 9910b57cec5SDimitry Andric 9920b57cec5SDimitry Andric for (unsigned I = 0, E = Segments.size(); I < E; ++I) { 9930b57cec5SDimitry Andric const auto *CurSeg = Segments[I]; 9940b57cec5SDimitry Andric if (CheckIfUncovered(CurSeg)) 9950b57cec5SDimitry Andric Color = "red"; 9960b57cec5SDimitry Andric else if (CurSeg->Col == ExpansionCol) 9970b57cec5SDimitry Andric Color = "cyan"; 9980b57cec5SDimitry Andric else 999bdd1243dSDimitry Andric Color = std::nullopt; 10000b57cec5SDimitry Andric 100181ad6265SDimitry Andric if (Color) 10020b57cec5SDimitry Andric Snippets[I + 1] = Highlight(Snippets[I + 1], CurSeg->Col, 10030b57cec5SDimitry Andric CurSeg->Col + Snippets[I + 1].size()); 10040b57cec5SDimitry Andric } 10050b57cec5SDimitry Andric 100681ad6265SDimitry Andric if (Color && Segments.empty()) 10070b57cec5SDimitry Andric Snippets.back() = Highlight(Snippets.back(), 1, 1 + Snippets.back().size()); 10080b57cec5SDimitry Andric 10090b57cec5SDimitry Andric if (getOptions().Debug) { 10100b57cec5SDimitry Andric for (const auto &Range : HighlightedRanges) { 10110b57cec5SDimitry Andric errs() << "Highlighted line " << LineNo << ", " << Range.first << " -> "; 10120b57cec5SDimitry Andric if (Range.second == 0) 10130b57cec5SDimitry Andric errs() << "?"; 10140b57cec5SDimitry Andric else 10150b57cec5SDimitry Andric errs() << Range.second; 10160b57cec5SDimitry Andric errs() << "\n"; 10170b57cec5SDimitry Andric } 10180b57cec5SDimitry Andric } 10190b57cec5SDimitry Andric 10200b57cec5SDimitry Andric // 4. Snippets[1:N+1] correspond to \p Segments[0:N]: use these to generate 10210b57cec5SDimitry Andric // sub-line region count tooltips if needed. 10220b57cec5SDimitry Andric 10230b57cec5SDimitry Andric if (shouldRenderRegionMarkers(LCS)) { 10240b57cec5SDimitry Andric // Just consider the segments which start *and* end on this line. 10250b57cec5SDimitry Andric for (unsigned I = 0, E = Segments.size() - 1; I < E; ++I) { 10260b57cec5SDimitry Andric const auto *CurSeg = Segments[I]; 10270b57cec5SDimitry Andric if (!CurSeg->IsRegionEntry) 10280b57cec5SDimitry Andric continue; 10290b57cec5SDimitry Andric if (CurSeg->Count == LCS.getExecutionCount()) 10300b57cec5SDimitry Andric continue; 10310b57cec5SDimitry Andric 10320b57cec5SDimitry Andric Snippets[I + 1] = 10330b57cec5SDimitry Andric tag("div", Snippets[I + 1] + tag("span", formatCount(CurSeg->Count), 10340b57cec5SDimitry Andric "tooltip-content"), 10350b57cec5SDimitry Andric "tooltip"); 10360b57cec5SDimitry Andric 10370b57cec5SDimitry Andric if (getOptions().Debug) 10380b57cec5SDimitry Andric errs() << "Marker at " << CurSeg->Line << ":" << CurSeg->Col << " = " 10390b57cec5SDimitry Andric << formatCount(CurSeg->Count) << "\n"; 10400b57cec5SDimitry Andric } 10410b57cec5SDimitry Andric } 10420b57cec5SDimitry Andric 10430b57cec5SDimitry Andric OS << BeginCodeTD; 10440b57cec5SDimitry Andric OS << BeginPre; 10450b57cec5SDimitry Andric for (const auto &Snippet : Snippets) 10460b57cec5SDimitry Andric OS << Snippet; 10470b57cec5SDimitry Andric OS << EndPre; 10480b57cec5SDimitry Andric 10490b57cec5SDimitry Andric // If there are no sub-views left to attach to this cell, end the cell. 10500b57cec5SDimitry Andric // Otherwise, end it after the sub-views are rendered (renderLineSuffix()). 10510b57cec5SDimitry Andric if (!hasSubViews()) 10520b57cec5SDimitry Andric OS << EndCodeTD; 10530b57cec5SDimitry Andric } 10540b57cec5SDimitry Andric 10550b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLineCoverageColumn( 10560b57cec5SDimitry Andric raw_ostream &OS, const LineCoverageStats &Line) { 1057e8d8bef9SDimitry Andric std::string Count; 10580b57cec5SDimitry Andric if (Line.isMapped()) 10590b57cec5SDimitry Andric Count = tag("pre", formatCount(Line.getExecutionCount())); 10600b57cec5SDimitry Andric std::string CoverageClass = 1061*0fca6ea1SDimitry Andric (Line.getExecutionCount() > 0) 1062*0fca6ea1SDimitry Andric ? "covered-line" 1063*0fca6ea1SDimitry Andric : (Line.isMapped() ? "uncovered-line" : "skipped-line"); 10640b57cec5SDimitry Andric OS << tag("td", Count, CoverageClass); 10650b57cec5SDimitry Andric } 10660b57cec5SDimitry Andric 10670b57cec5SDimitry Andric void SourceCoverageViewHTML::renderLineNumberColumn(raw_ostream &OS, 10680b57cec5SDimitry Andric unsigned LineNo) { 10690b57cec5SDimitry Andric std::string LineNoStr = utostr(uint64_t(LineNo)); 10700b57cec5SDimitry Andric std::string TargetName = "L" + LineNoStr; 10710b57cec5SDimitry Andric OS << tag("td", a("#" + TargetName, tag("pre", LineNoStr), TargetName), 10720b57cec5SDimitry Andric "line-number"); 10730b57cec5SDimitry Andric } 10740b57cec5SDimitry Andric 10750b57cec5SDimitry Andric void SourceCoverageViewHTML::renderRegionMarkers(raw_ostream &, 10760b57cec5SDimitry Andric const LineCoverageStats &Line, 10770b57cec5SDimitry Andric unsigned) { 10780b57cec5SDimitry Andric // Region markers are rendered in-line using tooltips. 10790b57cec5SDimitry Andric } 10800b57cec5SDimitry Andric 10810b57cec5SDimitry Andric void SourceCoverageViewHTML::renderExpansionSite(raw_ostream &OS, LineRef L, 10820b57cec5SDimitry Andric const LineCoverageStats &LCS, 10830b57cec5SDimitry Andric unsigned ExpansionCol, 10840b57cec5SDimitry Andric unsigned ViewDepth) { 10850b57cec5SDimitry Andric // Render the line containing the expansion site. No extra formatting needed. 10860b57cec5SDimitry Andric renderLine(OS, L, LCS, ExpansionCol, ViewDepth); 10870b57cec5SDimitry Andric } 10880b57cec5SDimitry Andric 10890b57cec5SDimitry Andric void SourceCoverageViewHTML::renderExpansionView(raw_ostream &OS, 10900b57cec5SDimitry Andric ExpansionView &ESV, 10910b57cec5SDimitry Andric unsigned ViewDepth) { 10920b57cec5SDimitry Andric OS << BeginExpansionDiv; 10930b57cec5SDimitry Andric ESV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/false, 10940b57cec5SDimitry Andric /*ShowTitle=*/false, ViewDepth + 1); 10950b57cec5SDimitry Andric OS << EndExpansionDiv; 10960b57cec5SDimitry Andric } 10970b57cec5SDimitry Andric 1098e8d8bef9SDimitry Andric void SourceCoverageViewHTML::renderBranchView(raw_ostream &OS, BranchView &BRV, 1099e8d8bef9SDimitry Andric unsigned ViewDepth) { 1100e8d8bef9SDimitry Andric // Render the child subview. 1101e8d8bef9SDimitry Andric if (getOptions().Debug) 1102e8d8bef9SDimitry Andric errs() << "Branch at line " << BRV.getLine() << '\n'; 1103e8d8bef9SDimitry Andric 1104e8d8bef9SDimitry Andric OS << BeginExpansionDiv; 1105e8d8bef9SDimitry Andric OS << BeginPre; 1106e8d8bef9SDimitry Andric for (const auto &R : BRV.Regions) { 1107e8d8bef9SDimitry Andric // Calculate TruePercent and False Percent. 1108e8d8bef9SDimitry Andric double TruePercent = 0.0; 1109e8d8bef9SDimitry Andric double FalsePercent = 0.0; 11105f757f3fSDimitry Andric // FIXME: It may overflow when the data is too large, but I have not 11115f757f3fSDimitry Andric // encountered it in actual use, and not sure whether to use __uint128_t. 11125f757f3fSDimitry Andric uint64_t Total = R.ExecutionCount + R.FalseExecutionCount; 1113e8d8bef9SDimitry Andric 1114e8d8bef9SDimitry Andric if (!getOptions().ShowBranchCounts && Total != 0) { 1115e8d8bef9SDimitry Andric TruePercent = ((double)(R.ExecutionCount) / (double)Total) * 100.0; 1116e8d8bef9SDimitry Andric FalsePercent = ((double)(R.FalseExecutionCount) / (double)Total) * 100.0; 1117e8d8bef9SDimitry Andric } 1118e8d8bef9SDimitry Andric 1119e8d8bef9SDimitry Andric // Display Line + Column. 1120e8d8bef9SDimitry Andric std::string LineNoStr = utostr(uint64_t(R.LineStart)); 1121e8d8bef9SDimitry Andric std::string ColNoStr = utostr(uint64_t(R.ColumnStart)); 1122e8d8bef9SDimitry Andric std::string TargetName = "L" + LineNoStr; 1123e8d8bef9SDimitry Andric 1124e8d8bef9SDimitry Andric OS << " Branch ("; 1125e8d8bef9SDimitry Andric OS << tag("span", 1126e8d8bef9SDimitry Andric a("#" + TargetName, tag("span", LineNoStr + ":" + ColNoStr), 1127e8d8bef9SDimitry Andric TargetName), 1128e8d8bef9SDimitry Andric "line-number") + 1129e8d8bef9SDimitry Andric "): ["; 1130e8d8bef9SDimitry Andric 1131e8d8bef9SDimitry Andric if (R.Folded) { 1132e8d8bef9SDimitry Andric OS << "Folded - Ignored]\n"; 1133e8d8bef9SDimitry Andric continue; 1134e8d8bef9SDimitry Andric } 1135e8d8bef9SDimitry Andric 1136e8d8bef9SDimitry Andric // Display TrueCount or TruePercent. 1137*0fca6ea1SDimitry Andric std::string TrueColor = R.ExecutionCount ? "None" : "red branch"; 1138e8d8bef9SDimitry Andric std::string TrueCovClass = 1139e8d8bef9SDimitry Andric (R.ExecutionCount > 0) ? "covered-line" : "uncovered-line"; 1140e8d8bef9SDimitry Andric 1141e8d8bef9SDimitry Andric OS << tag("span", "True", TrueColor); 1142e8d8bef9SDimitry Andric OS << ": "; 1143e8d8bef9SDimitry Andric if (getOptions().ShowBranchCounts) 1144e8d8bef9SDimitry Andric OS << tag("span", formatCount(R.ExecutionCount), TrueCovClass) << ", "; 1145e8d8bef9SDimitry Andric else 1146e8d8bef9SDimitry Andric OS << format("%0.2f", TruePercent) << "%, "; 1147e8d8bef9SDimitry Andric 1148e8d8bef9SDimitry Andric // Display FalseCount or FalsePercent. 1149*0fca6ea1SDimitry Andric std::string FalseColor = R.FalseExecutionCount ? "None" : "red branch"; 1150e8d8bef9SDimitry Andric std::string FalseCovClass = 1151e8d8bef9SDimitry Andric (R.FalseExecutionCount > 0) ? "covered-line" : "uncovered-line"; 1152e8d8bef9SDimitry Andric 1153e8d8bef9SDimitry Andric OS << tag("span", "False", FalseColor); 1154e8d8bef9SDimitry Andric OS << ": "; 1155e8d8bef9SDimitry Andric if (getOptions().ShowBranchCounts) 1156e8d8bef9SDimitry Andric OS << tag("span", formatCount(R.FalseExecutionCount), FalseCovClass); 1157e8d8bef9SDimitry Andric else 1158e8d8bef9SDimitry Andric OS << format("%0.2f", FalsePercent) << "%"; 1159e8d8bef9SDimitry Andric 1160e8d8bef9SDimitry Andric OS << "]\n"; 1161e8d8bef9SDimitry Andric } 1162e8d8bef9SDimitry Andric OS << EndPre; 1163e8d8bef9SDimitry Andric OS << EndExpansionDiv; 1164e8d8bef9SDimitry Andric } 1165e8d8bef9SDimitry Andric 11665f757f3fSDimitry Andric void SourceCoverageViewHTML::renderMCDCView(raw_ostream &OS, MCDCView &MRV, 11675f757f3fSDimitry Andric unsigned ViewDepth) { 11685f757f3fSDimitry Andric for (auto &Record : MRV.Records) { 11695f757f3fSDimitry Andric OS << BeginExpansionDiv; 11705f757f3fSDimitry Andric OS << BeginPre; 11715f757f3fSDimitry Andric OS << " MC/DC Decision Region ("; 11725f757f3fSDimitry Andric 11735f757f3fSDimitry Andric // Display Line + Column information. 11745f757f3fSDimitry Andric const CounterMappingRegion &DecisionRegion = Record.getDecisionRegion(); 11755f757f3fSDimitry Andric std::string LineNoStr = Twine(DecisionRegion.LineStart).str(); 11765f757f3fSDimitry Andric std::string ColNoStr = Twine(DecisionRegion.ColumnStart).str(); 11775f757f3fSDimitry Andric std::string TargetName = "L" + LineNoStr; 11785f757f3fSDimitry Andric OS << tag("span", 11794c2d3b02SDimitry Andric a("#" + TargetName, tag("span", LineNoStr + ":" + ColNoStr)), 11805f757f3fSDimitry Andric "line-number") + 11815f757f3fSDimitry Andric ") to ("; 11825f757f3fSDimitry Andric LineNoStr = utostr(uint64_t(DecisionRegion.LineEnd)); 11835f757f3fSDimitry Andric ColNoStr = utostr(uint64_t(DecisionRegion.ColumnEnd)); 11845f757f3fSDimitry Andric OS << tag("span", 11854c2d3b02SDimitry Andric a("#" + TargetName, tag("span", LineNoStr + ":" + ColNoStr)), 11865f757f3fSDimitry Andric "line-number") + 11875f757f3fSDimitry Andric ")\n\n"; 11885f757f3fSDimitry Andric 11895f757f3fSDimitry Andric // Display MC/DC Information. 11905f757f3fSDimitry Andric OS << " Number of Conditions: " << Record.getNumConditions() << "\n"; 11915f757f3fSDimitry Andric for (unsigned i = 0; i < Record.getNumConditions(); i++) { 11925f757f3fSDimitry Andric OS << " " << Record.getConditionHeaderString(i); 11935f757f3fSDimitry Andric } 11945f757f3fSDimitry Andric OS << "\n"; 11955f757f3fSDimitry Andric OS << " Executed MC/DC Test Vectors:\n\n "; 11965f757f3fSDimitry Andric OS << Record.getTestVectorHeaderString(); 11975f757f3fSDimitry Andric for (unsigned i = 0; i < Record.getNumTestVectors(); i++) 11985f757f3fSDimitry Andric OS << Record.getTestVectorString(i); 11995f757f3fSDimitry Andric OS << "\n"; 12005f757f3fSDimitry Andric for (unsigned i = 0; i < Record.getNumConditions(); i++) 12015f757f3fSDimitry Andric OS << Record.getConditionCoverageString(i); 12025f757f3fSDimitry Andric OS << " MC/DC Coverage for Expression: "; 12035f757f3fSDimitry Andric OS << format("%0.2f", Record.getPercentCovered()) << "%\n"; 12045f757f3fSDimitry Andric OS << EndPre; 12055f757f3fSDimitry Andric OS << EndExpansionDiv; 12065f757f3fSDimitry Andric } 12075f757f3fSDimitry Andric return; 12085f757f3fSDimitry Andric } 12095f757f3fSDimitry Andric 12100b57cec5SDimitry Andric void SourceCoverageViewHTML::renderInstantiationView(raw_ostream &OS, 12110b57cec5SDimitry Andric InstantiationView &ISV, 12120b57cec5SDimitry Andric unsigned ViewDepth) { 12130b57cec5SDimitry Andric OS << BeginExpansionDiv; 12140b57cec5SDimitry Andric if (!ISV.View) 12150b57cec5SDimitry Andric OS << BeginSourceNameDiv 12160b57cec5SDimitry Andric << tag("pre", 12170b57cec5SDimitry Andric escape("Unexecuted instantiation: " + ISV.FunctionName.str(), 12180b57cec5SDimitry Andric getOptions())) 12190b57cec5SDimitry Andric << EndSourceNameDiv; 12200b57cec5SDimitry Andric else 12210b57cec5SDimitry Andric ISV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/true, 12220b57cec5SDimitry Andric /*ShowTitle=*/false, ViewDepth); 12230b57cec5SDimitry Andric OS << EndExpansionDiv; 12240b57cec5SDimitry Andric } 12250b57cec5SDimitry Andric 12260b57cec5SDimitry Andric void SourceCoverageViewHTML::renderTitle(raw_ostream &OS, StringRef Title) { 12270b57cec5SDimitry Andric if (getOptions().hasProjectTitle()) 12280b57cec5SDimitry Andric OS << tag(ProjectTitleTag, escape(getOptions().ProjectTitle, getOptions())); 12290b57cec5SDimitry Andric OS << tag(ReportTitleTag, escape(Title, getOptions())); 12300b57cec5SDimitry Andric if (getOptions().hasCreatedTime()) 12310b57cec5SDimitry Andric OS << tag(CreatedTimeTag, 12320b57cec5SDimitry Andric escape(getOptions().CreatedTimeStr, getOptions())); 1233*0fca6ea1SDimitry Andric 1234*0fca6ea1SDimitry Andric OS << tag("span", 1235*0fca6ea1SDimitry Andric a("javascript:next_line()", "next uncovered line (L)") + ", " + 1236*0fca6ea1SDimitry Andric a("javascript:next_region()", "next uncovered region (R)") + 1237*0fca6ea1SDimitry Andric ", " + 1238*0fca6ea1SDimitry Andric a("javascript:next_branch()", "next uncovered branch (B)"), 1239*0fca6ea1SDimitry Andric "control"); 12400b57cec5SDimitry Andric } 12410b57cec5SDimitry Andric 12420b57cec5SDimitry Andric void SourceCoverageViewHTML::renderTableHeader(raw_ostream &OS, 12430b57cec5SDimitry Andric unsigned ViewDepth) { 1244*0fca6ea1SDimitry Andric std::string Links; 12450b57cec5SDimitry Andric 12460b57cec5SDimitry Andric renderLinePrefix(OS, ViewDepth); 1247*0fca6ea1SDimitry Andric OS << tag("td", tag("pre", "Line")) << tag("td", tag("pre", "Count")); 1248*0fca6ea1SDimitry Andric OS << tag("td", tag("pre", "Source" + Links)); 12490b57cec5SDimitry Andric renderLineSuffix(OS, ViewDepth); 12500b57cec5SDimitry Andric } 1251