1 //===- SourceCoverageViewText.cpp - A text-based 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 text-based coverage renderer. 11 /// 12 //===----------------------------------------------------------------------===// 13 14 #include "CoverageReport.h" 15 #include "SourceCoverageViewText.h" 16 #include "llvm/ADT/Optional.h" 17 #include "llvm/ADT/SmallString.h" 18 #include "llvm/ADT/StringExtras.h" 19 20 using namespace llvm; 21 22 Expected<CoveragePrinter::OwnedStream> 23 CoveragePrinterText::createViewFile(StringRef Path, bool InToplevel) { 24 return createOutputStream(Path, "txt", InToplevel); 25 } 26 27 void CoveragePrinterText::closeViewFile(OwnedStream OS) { 28 OS->operator<<('\n'); 29 } 30 31 Error CoveragePrinterText::createIndexFile( 32 ArrayRef<std::string> SourceFiles, 33 const coverage::CoverageMapping &Coverage, 34 const CoverageFiltersMatchAll &Filters) { 35 auto OSOrErr = createOutputStream("index", "txt", /*InToplevel=*/true); 36 if (Error E = OSOrErr.takeError()) 37 return E; 38 auto OS = std::move(OSOrErr.get()); 39 raw_ostream &OSRef = *OS.get(); 40 41 CoverageReport Report(Opts, Coverage); 42 Report.renderFileReports(OSRef, SourceFiles, Filters); 43 44 Opts.colored_ostream(OSRef, raw_ostream::CYAN) << "\n" 45 << Opts.getLLVMVersionString(); 46 47 return Error::success(); 48 } 49 50 namespace { 51 52 static const unsigned LineCoverageColumnWidth = 7; 53 static const unsigned LineNumberColumnWidth = 5; 54 55 /// \brief Get the width of the leading columns. 56 unsigned getCombinedColumnWidth(const CoverageViewOptions &Opts) { 57 return (Opts.ShowLineStats ? LineCoverageColumnWidth + 1 : 0) + 58 (Opts.ShowLineNumbers ? LineNumberColumnWidth + 1 : 0); 59 } 60 61 /// \brief The width of the line that is used to divide between the view and 62 /// the subviews. 63 unsigned getDividerWidth(const CoverageViewOptions &Opts) { 64 return getCombinedColumnWidth(Opts) + 4; 65 } 66 67 } // anonymous namespace 68 69 void SourceCoverageViewText::renderViewHeader(raw_ostream &) {} 70 71 void SourceCoverageViewText::renderViewFooter(raw_ostream &) {} 72 73 void SourceCoverageViewText::renderSourceName(raw_ostream &OS, bool WholeFile) { 74 getOptions().colored_ostream(OS, raw_ostream::CYAN) << getSourceName() 75 << ":\n"; 76 } 77 78 void SourceCoverageViewText::renderLinePrefix(raw_ostream &OS, 79 unsigned ViewDepth) { 80 for (unsigned I = 0; I < ViewDepth; ++I) 81 OS << " |"; 82 } 83 84 void SourceCoverageViewText::renderLineSuffix(raw_ostream &, unsigned) {} 85 86 void SourceCoverageViewText::renderViewDivider(raw_ostream &OS, 87 unsigned ViewDepth) { 88 assert(ViewDepth != 0 && "Cannot render divider at top level"); 89 renderLinePrefix(OS, ViewDepth - 1); 90 OS.indent(2); 91 unsigned Length = getDividerWidth(getOptions()); 92 for (unsigned I = 0; I < Length; ++I) 93 OS << '-'; 94 OS << '\n'; 95 } 96 97 void SourceCoverageViewText::renderLine(raw_ostream &OS, LineRef L, 98 const LineCoverageStats &LCS, 99 unsigned ExpansionCol, 100 unsigned ViewDepth) { 101 StringRef Line = L.Line; 102 unsigned LineNumber = L.LineNo; 103 auto *WrappedSegment = LCS.getWrappedSegment(); 104 CoverageSegmentArray Segments = LCS.getLineSegments(); 105 106 Optional<raw_ostream::Colors> Highlight; 107 SmallVector<std::pair<unsigned, unsigned>, 2> HighlightedRanges; 108 109 // The first segment overlaps from a previous line, so we treat it specially. 110 if (WrappedSegment && WrappedSegment->HasCount && WrappedSegment->Count == 0) 111 Highlight = raw_ostream::RED; 112 113 // Output each segment of the line, possibly highlighted. 114 unsigned Col = 1; 115 for (const auto *S : Segments) { 116 unsigned End = std::min(S->Col, static_cast<unsigned>(Line.size()) + 1); 117 colored_ostream(OS, Highlight ? *Highlight : raw_ostream::SAVEDCOLOR, 118 getOptions().Colors && Highlight, /*Bold=*/false, 119 /*BG=*/true) 120 << Line.substr(Col - 1, End - Col); 121 if (getOptions().Debug && Highlight) 122 HighlightedRanges.push_back(std::make_pair(Col, End)); 123 Col = End; 124 if (Col == ExpansionCol) 125 Highlight = raw_ostream::CYAN; 126 else if ((!S->IsGapRegion || Highlight == raw_ostream::RED) && 127 S->HasCount && S->Count == 0) 128 Highlight = raw_ostream::RED; 129 else 130 Highlight = None; 131 } 132 133 // Show the rest of the line. 134 colored_ostream(OS, Highlight ? *Highlight : raw_ostream::SAVEDCOLOR, 135 getOptions().Colors && Highlight, /*Bold=*/false, /*BG=*/true) 136 << Line.substr(Col - 1, Line.size() - Col + 1); 137 OS << '\n'; 138 139 if (getOptions().Debug) { 140 for (const auto &Range : HighlightedRanges) 141 errs() << "Highlighted line " << LineNumber << ", " << Range.first 142 << " -> " << Range.second << '\n'; 143 if (Highlight) 144 errs() << "Highlighted line " << LineNumber << ", " << Col << " -> ?\n"; 145 } 146 } 147 148 void SourceCoverageViewText::renderLineCoverageColumn( 149 raw_ostream &OS, const LineCoverageStats &Line) { 150 if (!Line.isMapped()) { 151 OS.indent(LineCoverageColumnWidth) << '|'; 152 return; 153 } 154 std::string C = formatCount(Line.getExecutionCount()); 155 OS.indent(LineCoverageColumnWidth - C.size()); 156 colored_ostream(OS, raw_ostream::MAGENTA, 157 Line.hasMultipleRegions() && getOptions().Colors) 158 << C; 159 OS << '|'; 160 } 161 162 void SourceCoverageViewText::renderLineNumberColumn(raw_ostream &OS, 163 unsigned LineNo) { 164 SmallString<32> Buffer; 165 raw_svector_ostream BufferOS(Buffer); 166 BufferOS << LineNo; 167 auto Str = BufferOS.str(); 168 // Trim and align to the right. 169 Str = Str.substr(0, std::min(Str.size(), (size_t)LineNumberColumnWidth)); 170 OS.indent(LineNumberColumnWidth - Str.size()) << Str << '|'; 171 } 172 173 void SourceCoverageViewText::renderRegionMarkers(raw_ostream &OS, 174 const LineCoverageStats &Line, 175 unsigned ViewDepth) { 176 renderLinePrefix(OS, ViewDepth); 177 OS.indent(getCombinedColumnWidth(getOptions())); 178 179 CoverageSegmentArray Segments = Line.getLineSegments(); 180 181 // Just consider the segments which start *and* end on this line. 182 if (Segments.size() > 1) 183 Segments = Segments.drop_back(); 184 185 unsigned PrevColumn = 1; 186 for (const auto *S : Segments) { 187 if (!S->IsRegionEntry) 188 continue; 189 if (S->Count == Line.getExecutionCount()) 190 continue; 191 // Skip to the new region. 192 if (S->Col > PrevColumn) 193 OS.indent(S->Col - PrevColumn); 194 PrevColumn = S->Col + 1; 195 std::string C = formatCount(S->Count); 196 PrevColumn += C.size(); 197 OS << '^' << C; 198 199 if (getOptions().Debug) 200 errs() << "Marker at " << S->Line << ":" << S->Col << " = " 201 << formatCount(S->Count) << "\n"; 202 } 203 OS << '\n'; 204 } 205 206 void SourceCoverageViewText::renderExpansionSite(raw_ostream &OS, LineRef L, 207 const LineCoverageStats &LCS, 208 unsigned ExpansionCol, 209 unsigned ViewDepth) { 210 renderLinePrefix(OS, ViewDepth); 211 OS.indent(getCombinedColumnWidth(getOptions()) + (ViewDepth == 0 ? 0 : 1)); 212 renderLine(OS, L, LCS, ExpansionCol, ViewDepth); 213 } 214 215 void SourceCoverageViewText::renderExpansionView(raw_ostream &OS, 216 ExpansionView &ESV, 217 unsigned ViewDepth) { 218 // Render the child subview. 219 if (getOptions().Debug) 220 errs() << "Expansion at line " << ESV.getLine() << ", " << ESV.getStartCol() 221 << " -> " << ESV.getEndCol() << '\n'; 222 ESV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/false, 223 /*ShowTitle=*/false, ViewDepth + 1); 224 } 225 226 void SourceCoverageViewText::renderInstantiationView(raw_ostream &OS, 227 InstantiationView &ISV, 228 unsigned ViewDepth) { 229 renderLinePrefix(OS, ViewDepth); 230 OS << ' '; 231 if (!ISV.View) 232 getOptions().colored_ostream(OS, raw_ostream::RED) 233 << "Unexecuted instantiation: " << ISV.FunctionName << "\n"; 234 else 235 ISV.View->print(OS, /*WholeFile=*/false, /*ShowSourceName=*/true, 236 /*ShowTitle=*/false, ViewDepth); 237 } 238 239 void SourceCoverageViewText::renderTitle(raw_ostream &OS, StringRef Title) { 240 if (getOptions().hasProjectTitle()) 241 getOptions().colored_ostream(OS, raw_ostream::CYAN) 242 << getOptions().ProjectTitle << "\n"; 243 244 getOptions().colored_ostream(OS, raw_ostream::CYAN) << Title << "\n"; 245 246 if (getOptions().hasCreatedTime()) 247 getOptions().colored_ostream(OS, raw_ostream::CYAN) 248 << getOptions().CreatedTimeStr << "\n"; 249 } 250 251 void SourceCoverageViewText::renderTableHeader(raw_ostream &, unsigned, 252 unsigned) {} 253