77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
1 //===- SourceCoverageView.cpp - Code coverage view for source code --------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
2 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
3 // The LLVM Compiler Infrastructure
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
4 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
5 // This file is distributed under the University of Illinois Open Source
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
6 // License. See LICENSE.TXT for details.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
7 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
8 //===----------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
9 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
10 // This class implements rendering for code coverage of source code.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
11 //
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
12 //===----------------------------------------------------------------------===//
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
13
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
14 #include "SourceCoverageView.h"
|
83
|
15 #include "llvm/ADT/Optional.h"
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
16 #include "llvm/ADT/SmallString.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
17 #include "llvm/Support/LineIterator.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
18
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
19 using namespace llvm;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
20
|
83
|
21 void SourceCoverageView::renderLine(
|
|
22 raw_ostream &OS, StringRef Line, int64_t LineNumber,
|
|
23 const coverage::CoverageSegment *WrappedSegment,
|
|
24 ArrayRef<const coverage::CoverageSegment *> Segments,
|
|
25 unsigned ExpansionCol) {
|
|
26 Optional<raw_ostream::Colors> Highlight;
|
|
27 SmallVector<std::pair<unsigned, unsigned>, 2> HighlightedRanges;
|
|
28
|
|
29 // The first segment overlaps from a previous line, so we treat it specially.
|
|
30 if (WrappedSegment && WrappedSegment->HasCount && WrappedSegment->Count == 0)
|
|
31 Highlight = raw_ostream::RED;
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
32
|
83
|
33 // Output each segment of the line, possibly highlighted.
|
|
34 unsigned Col = 1;
|
|
35 for (const auto *S : Segments) {
|
|
36 unsigned End = std::min(S->Col, static_cast<unsigned>(Line.size()) + 1);
|
|
37 colored_ostream(OS, Highlight ? *Highlight : raw_ostream::SAVEDCOLOR,
|
|
38 Options.Colors && Highlight, /*Bold=*/false, /*BG=*/true)
|
|
39 << Line.substr(Col - 1, End - Col);
|
|
40 if (Options.Debug && Highlight)
|
|
41 HighlightedRanges.push_back(std::make_pair(Col, End));
|
|
42 Col = End;
|
|
43 if (Col == ExpansionCol)
|
|
44 Highlight = raw_ostream::CYAN;
|
|
45 else if (S->HasCount && S->Count == 0)
|
|
46 Highlight = raw_ostream::RED;
|
|
47 else
|
|
48 Highlight = None;
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
49 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
50
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
51 // Show the rest of the line
|
83
|
52 colored_ostream(OS, Highlight ? *Highlight : raw_ostream::SAVEDCOLOR,
|
|
53 Options.Colors && Highlight, /*Bold=*/false, /*BG=*/true)
|
|
54 << Line.substr(Col - 1, Line.size() - Col + 1);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
55 OS << "\n";
|
83
|
56
|
|
57 if (Options.Debug) {
|
|
58 for (const auto &Range : HighlightedRanges)
|
|
59 errs() << "Highlighted line " << LineNumber << ", " << Range.first
|
|
60 << " -> " << Range.second << "\n";
|
|
61 if (Highlight)
|
|
62 errs() << "Highlighted line " << LineNumber << ", " << Col << " -> ?\n";
|
|
63 }
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
64 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
65
|
83
|
66 void SourceCoverageView::renderIndent(raw_ostream &OS, unsigned Level) {
|
|
67 for (unsigned I = 0; I < Level; ++I)
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
68 OS << " |";
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
69 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
70
|
83
|
71 void SourceCoverageView::renderViewDivider(unsigned Level, unsigned Length,
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
72 raw_ostream &OS) {
|
83
|
73 assert(Level != 0 && "Cannot render divider at top level");
|
|
74 renderIndent(OS, Level - 1);
|
|
75 OS.indent(2);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
76 for (unsigned I = 0; I < Length; ++I)
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
77 OS << "-";
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
78 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
79
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
80 void
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
81 SourceCoverageView::renderLineCoverageColumn(raw_ostream &OS,
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
82 const LineCoverageInfo &Line) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
83 if (!Line.isMapped()) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
84 OS.indent(LineCoverageColumnWidth) << '|';
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
85 return;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
86 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
87 SmallString<32> Buffer;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
88 raw_svector_ostream BufferOS(Buffer);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
89 BufferOS << Line.ExecutionCount;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
90 auto Str = BufferOS.str();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
91 // Trim
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
92 Str = Str.substr(0, std::min(Str.size(), (size_t)LineCoverageColumnWidth));
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
93 // Align to the right
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
94 OS.indent(LineCoverageColumnWidth - Str.size());
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
95 colored_ostream(OS, raw_ostream::MAGENTA,
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
96 Line.hasMultipleRegions() && Options.Colors)
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
97 << Str;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
98 OS << '|';
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
99 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
100
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
101 void SourceCoverageView::renderLineNumberColumn(raw_ostream &OS,
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
102 unsigned LineNo) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
103 SmallString<32> Buffer;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
104 raw_svector_ostream BufferOS(Buffer);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
105 BufferOS << LineNo;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
106 auto Str = BufferOS.str();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
107 // Trim and align to the right
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
108 Str = Str.substr(0, std::min(Str.size(), (size_t)LineNumberColumnWidth));
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
109 OS.indent(LineNumberColumnWidth - Str.size()) << Str << '|';
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
110 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
111
|
83
|
112 void SourceCoverageView::renderRegionMarkers(
|
|
113 raw_ostream &OS, ArrayRef<const coverage::CoverageSegment *> Segments) {
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
114 SmallString<32> Buffer;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
115 raw_svector_ostream BufferOS(Buffer);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
116
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
117 unsigned PrevColumn = 1;
|
83
|
118 for (const auto *S : Segments) {
|
|
119 if (!S->IsRegionEntry)
|
|
120 continue;
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
121 // Skip to the new region
|
83
|
122 if (S->Col > PrevColumn)
|
|
123 OS.indent(S->Col - PrevColumn);
|
|
124 PrevColumn = S->Col + 1;
|
|
125 BufferOS << S->Count;
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
126 StringRef Str = BufferOS.str();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
127 // Trim the execution count
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
128 Str = Str.substr(0, std::min(Str.size(), (size_t)7));
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
129 PrevColumn += Str.size();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
130 OS << '^' << Str;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
131 Buffer.clear();
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
132 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
133 OS << "\n";
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
134
|
83
|
135 if (Options.Debug)
|
|
136 for (const auto *S : Segments)
|
|
137 errs() << "Marker at " << S->Line << ":" << S->Col << " = " << S->Count
|
|
138 << (S->IsRegionEntry ? "\n" : " (pop)\n");
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
139 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
140
|
83
|
141 void SourceCoverageView::render(raw_ostream &OS, bool WholeFile,
|
|
142 unsigned IndentLevel) {
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
143 // The width of the leading columns
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
144 unsigned CombinedColumnWidth =
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
145 (Options.ShowLineStats ? LineCoverageColumnWidth + 1 : 0) +
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
146 (Options.ShowLineNumbers ? LineNumberColumnWidth + 1 : 0);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
147 // The width of the line that is used to divide between the view and the
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
148 // subviews.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
149 unsigned DividerWidth = CombinedColumnWidth + 4;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
150
|
83
|
151 // We need the expansions and instantiations sorted so we can go through them
|
|
152 // while we iterate lines.
|
|
153 std::sort(ExpansionSubViews.begin(), ExpansionSubViews.end());
|
|
154 std::sort(InstantiationSubViews.begin(), InstantiationSubViews.end());
|
|
155 auto NextESV = ExpansionSubViews.begin();
|
|
156 auto EndESV = ExpansionSubViews.end();
|
|
157 auto NextISV = InstantiationSubViews.begin();
|
|
158 auto EndISV = InstantiationSubViews.end();
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
159
|
83
|
160 // Get the coverage information for the file.
|
|
161 auto NextSegment = CoverageInfo.begin();
|
|
162 auto EndSegment = CoverageInfo.end();
|
|
163
|
|
164 unsigned FirstLine = NextSegment != EndSegment ? NextSegment->Line : 0;
|
|
165 const coverage::CoverageSegment *WrappedSegment = nullptr;
|
|
166 SmallVector<const coverage::CoverageSegment *, 8> LineSegments;
|
|
167 for (line_iterator LI(File, /*SkipBlanks=*/false); !LI.is_at_eof(); ++LI) {
|
|
168 // If we aren't rendering the whole file, we need to filter out the prologue
|
|
169 // and epilogue.
|
|
170 if (!WholeFile) {
|
|
171 if (NextSegment == EndSegment)
|
|
172 break;
|
|
173 else if (LI.line_number() < FirstLine)
|
|
174 continue;
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
175 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
176
|
83
|
177 // Collect the coverage information relevant to this line.
|
|
178 if (LineSegments.size())
|
|
179 WrappedSegment = LineSegments.back();
|
|
180 LineSegments.clear();
|
|
181 while (NextSegment != EndSegment && NextSegment->Line == LI.line_number())
|
|
182 LineSegments.push_back(&*NextSegment++);
|
|
183
|
|
184 // Calculate a count to be for the line as a whole.
|
|
185 LineCoverageInfo LineCount;
|
|
186 if (WrappedSegment && WrappedSegment->HasCount)
|
|
187 LineCount.addRegionCount(WrappedSegment->Count);
|
|
188 for (const auto *S : LineSegments)
|
|
189 if (S->HasCount && S->IsRegionEntry)
|
|
190 LineCount.addRegionStartCount(S->Count);
|
|
191
|
|
192 // Render the line prefix.
|
|
193 renderIndent(OS, IndentLevel);
|
|
194 if (Options.ShowLineStats)
|
|
195 renderLineCoverageColumn(OS, LineCount);
|
|
196 if (Options.ShowLineNumbers)
|
|
197 renderLineNumberColumn(OS, LI.line_number());
|
|
198
|
|
199 // If there are expansion subviews, we want to highlight the first one.
|
|
200 unsigned ExpansionColumn = 0;
|
|
201 if (NextESV != EndESV && NextESV->getLine() == LI.line_number() &&
|
|
202 Options.Colors)
|
|
203 ExpansionColumn = NextESV->getStartCol();
|
|
204
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
205 // Display the source code for the current line.
|
83
|
206 renderLine(OS, *LI, LI.line_number(), WrappedSegment, LineSegments,
|
|
207 ExpansionColumn);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
208
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
209 // Show the region markers.
|
83
|
210 if (Options.ShowRegionMarkers && (!Options.ShowLineStatsOrRegionMarkers ||
|
|
211 LineCount.hasMultipleRegions()) &&
|
|
212 !LineSegments.empty()) {
|
|
213 renderIndent(OS, IndentLevel);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
214 OS.indent(CombinedColumnWidth);
|
83
|
215 renderRegionMarkers(OS, LineSegments);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
216 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
217
|
83
|
218 // Show the expansions and instantiations for this line.
|
|
219 unsigned NestedIndent = IndentLevel + 1;
|
|
220 bool RenderedSubView = false;
|
|
221 for (; NextESV != EndESV && NextESV->getLine() == LI.line_number();
|
|
222 ++NextESV) {
|
|
223 renderViewDivider(NestedIndent, DividerWidth, OS);
|
|
224 OS << "\n";
|
|
225 if (RenderedSubView) {
|
|
226 // Re-render the current line and highlight the expansion range for
|
|
227 // this subview.
|
|
228 ExpansionColumn = NextESV->getStartCol();
|
|
229 renderIndent(OS, IndentLevel);
|
|
230 OS.indent(CombinedColumnWidth + (IndentLevel == 0 ? 0 : 1));
|
|
231 renderLine(OS, *LI, LI.line_number(), WrappedSegment, LineSegments,
|
|
232 ExpansionColumn);
|
|
233 renderViewDivider(NestedIndent, DividerWidth, OS);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
234 OS << "\n";
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
235 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
236 // Render the child subview
|
83
|
237 if (Options.Debug)
|
|
238 errs() << "Expansion at line " << NextESV->getLine() << ", "
|
|
239 << NextESV->getStartCol() << " -> " << NextESV->getEndCol()
|
|
240 << "\n";
|
|
241 NextESV->View->render(OS, false, NestedIndent);
|
|
242 RenderedSubView = true;
|
|
243 }
|
|
244 for (; NextISV != EndISV && NextISV->Line == LI.line_number(); ++NextISV) {
|
|
245 renderViewDivider(NestedIndent, DividerWidth, OS);
|
|
246 OS << "\n";
|
|
247 renderIndent(OS, NestedIndent);
|
|
248 OS << ' ';
|
|
249 Options.colored_ostream(OS, raw_ostream::CYAN) << NextISV->FunctionName
|
|
250 << ":";
|
|
251 OS << "\n";
|
|
252 NextISV->View->render(OS, false, NestedIndent);
|
|
253 RenderedSubView = true;
|
|
254 }
|
|
255 if (RenderedSubView) {
|
|
256 renderViewDivider(NestedIndent, DividerWidth, OS);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
257 OS << "\n";
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
258 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
259 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
260 }
|