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