//===----------------------------------------------------------------------===//
#include "SourceCoverageView.h"
+#include "llvm/ADT/Optional.h"
#include "llvm/ADT/SmallString.h"
+#include "llvm/ADT/StringExtras.h"
#include "llvm/Support/LineIterator.h"
using namespace llvm;
-void SourceCoverageView::renderLine(raw_ostream &OS, StringRef Line,
- ArrayRef<HighlightRange> Ranges) {
- if (Ranges.empty()) {
- OS << Line << "\n";
- return;
- }
- if (Line.empty())
- Line = " ";
-
- unsigned PrevColumnStart = 0;
- unsigned Start = 1;
- for (const auto &Range : Ranges) {
- if (PrevColumnStart == Range.ColumnStart)
- continue;
-
- // Show the unhighlighted part
- unsigned ColumnStart = PrevColumnStart = Range.ColumnStart;
- OS << Line.substr(Start - 1, ColumnStart - Start);
-
- // Show the highlighted part
- auto Color = Range.Kind == HighlightRange::NotCovered ? raw_ostream::RED
- : raw_ostream::CYAN;
- OS.changeColor(Color, false, true);
- unsigned ColumnEnd = std::min(Range.ColumnEnd, (unsigned)Line.size() + 1);
- OS << Line.substr(ColumnStart - 1, ColumnEnd - ColumnStart);
- Start = ColumnEnd;
- OS.resetColor();
+void SourceCoverageView::renderLine(
+ raw_ostream &OS, StringRef Line, int64_t LineNumber,
+ const coverage::CoverageSegment *WrappedSegment,
+ ArrayRef<const coverage::CoverageSegment *> Segments,
+ unsigned ExpansionCol) {
+ Optional<raw_ostream::Colors> Highlight;
+ SmallVector<std::pair<unsigned, unsigned>, 2> HighlightedRanges;
+
+ // The first segment overlaps from a previous line, so we treat it specially.
+ if (WrappedSegment && WrappedSegment->HasCount && WrappedSegment->Count == 0)
+ Highlight = raw_ostream::RED;
+
+ // Output each segment of the line, possibly highlighted.
+ unsigned Col = 1;
+ for (const auto *S : Segments) {
+ unsigned End = std::min(S->Col, static_cast<unsigned>(Line.size()) + 1);
+ colored_ostream(OS, Highlight ? *Highlight : raw_ostream::SAVEDCOLOR,
+ Options.Colors && Highlight, /*Bold=*/false, /*BG=*/true)
+ << Line.substr(Col - 1, End - Col);
+ if (Options.Debug && Highlight)
+ HighlightedRanges.push_back(std::make_pair(Col, End));
+ Col = End;
+ if (Col == ExpansionCol)
+ Highlight = raw_ostream::CYAN;
+ else if (S->HasCount && S->Count == 0)
+ Highlight = raw_ostream::RED;
+ else
+ Highlight = None;
}
// Show the rest of the line
- OS << Line.substr(Start - 1, Line.size() - Start + 1);
+ colored_ostream(OS, Highlight ? *Highlight : raw_ostream::SAVEDCOLOR,
+ Options.Colors && Highlight, /*Bold=*/false, /*BG=*/true)
+ << Line.substr(Col - 1, Line.size() - Col + 1);
OS << "\n";
+
+ if (Options.Debug) {
+ for (const auto &Range : HighlightedRanges)
+ errs() << "Highlighted line " << LineNumber << ", " << Range.first
+ << " -> " << Range.second << "\n";
+ if (Highlight)
+ errs() << "Highlighted line " << LineNumber << ", " << Col << " -> ?\n";
+ }
}
-void SourceCoverageView::renderOffset(raw_ostream &OS, unsigned I) {
- for (unsigned J = 0; J < I; ++J)
+void SourceCoverageView::renderIndent(raw_ostream &OS, unsigned Level) {
+ for (unsigned I = 0; I < Level; ++I)
OS << " |";
}
-void SourceCoverageView::renderViewDivider(unsigned Offset, unsigned Length,
+void SourceCoverageView::renderViewDivider(unsigned Level, unsigned Length,
raw_ostream &OS) {
- for (unsigned J = 1; J < Offset; ++J)
- OS << " |";
- if (Offset != 0)
- OS.indent(2);
+ assert(Level != 0 && "Cannot render divider at top level");
+ renderIndent(OS, Level - 1);
+ OS.indent(2);
for (unsigned I = 0; I < Length; ++I)
OS << "-";
}
+/// Format a count using engineering notation with 3 significant digits.
+static std::string formatCount(uint64_t N) {
+ std::string Number = utostr(N);
+ int Len = Number.size();
+ if (Len <= 3)
+ return Number;
+ int IntLen = Len % 3 == 0 ? 3 : Len % 3;
+ std::string Result(Number.data(), IntLen);
+ if (IntLen != 3) {
+ Result.push_back('.');
+ Result += Number.substr(IntLen, 3 - IntLen);
+ }
+ Result.push_back(" kMGTPEZY"[(Len - 1) / 3]);
+ return Result;
+}
+
void
SourceCoverageView::renderLineCoverageColumn(raw_ostream &OS,
const LineCoverageInfo &Line) {
OS.indent(LineCoverageColumnWidth) << '|';
return;
}
- SmallString<32> Buffer;
- raw_svector_ostream BufferOS(Buffer);
- BufferOS << Line.ExecutionCount;
- auto Str = BufferOS.str();
- // Trim
- Str = Str.substr(0, std::min(Str.size(), (size_t)LineCoverageColumnWidth));
- // Align to the right
- OS.indent(LineCoverageColumnWidth - Str.size());
+ std::string C = formatCount(Line.ExecutionCount);
+ OS.indent(LineCoverageColumnWidth - C.size());
colored_ostream(OS, raw_ostream::MAGENTA,
Line.hasMultipleRegions() && Options.Colors)
- << Str;
+ << C;
OS << '|';
}
OS.indent(LineNumberColumnWidth - Str.size()) << Str << '|';
}
-void SourceCoverageView::renderRegionMarkers(raw_ostream &OS,
- ArrayRef<RegionMarker> Regions) {
- SmallString<32> Buffer;
- raw_svector_ostream BufferOS(Buffer);
-
+void SourceCoverageView::renderRegionMarkers(
+ raw_ostream &OS, ArrayRef<const coverage::CoverageSegment *> Segments) {
unsigned PrevColumn = 1;
- for (const auto &Region : Regions) {
+ for (const auto *S : Segments) {
+ if (!S->IsRegionEntry)
+ continue;
// Skip to the new region
- if (Region.Column > PrevColumn)
- OS.indent(Region.Column - PrevColumn);
- PrevColumn = Region.Column + 1;
- BufferOS << Region.ExecutionCount;
- StringRef Str = BufferOS.str();
- // Trim the execution count
- Str = Str.substr(0, std::min(Str.size(), (size_t)7));
- PrevColumn += Str.size();
- OS << '^' << Str;
- Buffer.clear();
+ if (S->Col > PrevColumn)
+ OS.indent(S->Col - PrevColumn);
+ PrevColumn = S->Col + 1;
+ std::string C = formatCount(S->Count);
+ PrevColumn += C.size();
+ OS << '^' << C;
}
OS << "\n";
-}
-
-/// \brief Insert a new highlighting range into the line's highlighting ranges
-/// Return line's new highlighting ranges in result.
-static void insertHighlightRange(
- ArrayRef<SourceCoverageView::HighlightRange> Ranges,
- SourceCoverageView::HighlightRange RangeToInsert,
- SmallVectorImpl<SourceCoverageView::HighlightRange> &Result) {
- Result.clear();
- size_t I = 0;
- auto E = Ranges.size();
- for (; I < E; ++I) {
- if (RangeToInsert.ColumnStart < Ranges[I].ColumnEnd) {
- const auto &Range = Ranges[I];
- bool NextRangeContainsInserted = false;
- // If the next range starts before the inserted range, move the end of the
- // next range to the start of the inserted range.
- if (Range.ColumnStart < RangeToInsert.ColumnStart) {
- if (RangeToInsert.ColumnStart != Range.ColumnStart)
- Result.push_back(SourceCoverageView::HighlightRange(
- Range.Line, Range.ColumnStart, RangeToInsert.ColumnStart,
- Range.Kind));
- // If the next range also ends after the inserted range, keep this range
- // and create a new range that starts at the inserted range and ends
- // at the next range later.
- if (Range.ColumnEnd > RangeToInsert.ColumnEnd)
- NextRangeContainsInserted = true;
- }
- if (!NextRangeContainsInserted) {
- ++I;
- // Ignore ranges that are contained in inserted range
- while (I < E && RangeToInsert.contains(Ranges[I]))
- ++I;
- }
- break;
- }
- Result.push_back(Ranges[I]);
- }
- Result.push_back(RangeToInsert);
- // If the next range starts before the inserted range end, move the start
- // of the next range to the end of the inserted range.
- if (I < E && Ranges[I].ColumnStart < RangeToInsert.ColumnEnd) {
- const auto &Range = Ranges[I];
- if (RangeToInsert.ColumnEnd != Range.ColumnEnd)
- Result.push_back(SourceCoverageView::HighlightRange(
- Range.Line, RangeToInsert.ColumnEnd, Range.ColumnEnd, Range.Kind));
- ++I;
- }
- // Add the remaining ranges that are located after the inserted range
- for (; I < E; ++I)
- Result.push_back(Ranges[I]);
-}
-
-void SourceCoverageView::sortChildren() {
- for (auto &I : Children)
- I->sortChildren();
- std::sort(Children.begin(), Children.end(),
- [](const std::unique_ptr<SourceCoverageView> &LHS,
- const std::unique_ptr<SourceCoverageView> &RHS) {
- return LHS->ExpansionRegion < RHS->ExpansionRegion;
- });
-}
-SourceCoverageView::HighlightRange
-SourceCoverageView::getExpansionHighlightRange() const {
- return HighlightRange(ExpansionRegion.LineStart, ExpansionRegion.ColumnStart,
- ExpansionRegion.ColumnEnd, HighlightRange::Expanded);
+ if (Options.Debug)
+ for (const auto *S : Segments)
+ errs() << "Marker at " << S->Line << ":" << S->Col << " = "
+ << formatCount(S->Count) << (S->IsRegionEntry ? "\n" : " (pop)\n");
}
-template <typename T>
-ArrayRef<T> gatherLineItems(size_t &CurrentIdx, const std::vector<T> &Items,
- unsigned LineNo) {
- auto PrevIdx = CurrentIdx;
- auto E = Items.size();
- while (CurrentIdx < E && Items[CurrentIdx].Line == LineNo)
- ++CurrentIdx;
- return ArrayRef<T>(Items.data() + PrevIdx, CurrentIdx - PrevIdx);
-}
-
-ArrayRef<std::unique_ptr<SourceCoverageView>>
-gatherLineSubViews(size_t &CurrentIdx,
- ArrayRef<std::unique_ptr<SourceCoverageView>> Items,
- unsigned LineNo) {
- auto PrevIdx = CurrentIdx;
- auto E = Items.size();
- while (CurrentIdx < E &&
- Items[CurrentIdx]->getSubViewsExpansionLine() == LineNo)
- ++CurrentIdx;
- return Items.slice(PrevIdx, CurrentIdx - PrevIdx);
-}
-
-void SourceCoverageView::render(raw_ostream &OS, unsigned Offset) {
- // Make sure that the children are in sorted order.
- sortChildren();
-
- SmallVector<HighlightRange, 8> AdjustedLineHighlightRanges;
- size_t CurrentChild = 0;
- size_t CurrentHighlightRange = 0;
- size_t CurrentRegionMarker = 0;
-
- line_iterator Lines(File);
- // Advance the line iterator to the first line.
- while (Lines.line_number() < LineStart)
- ++Lines;
-
+void SourceCoverageView::render(raw_ostream &OS, bool WholeFile,
+ unsigned IndentLevel) {
// The width of the leading columns
unsigned CombinedColumnWidth =
(Options.ShowLineStats ? LineCoverageColumnWidth + 1 : 0) +
// subviews.
unsigned DividerWidth = CombinedColumnWidth + 4;
- for (size_t I = 0; I < LineCount; ++I) {
- unsigned LineNo = I + LineStart;
-
- // Gather the child subviews that are visible on this line.
- auto LineSubViews = gatherLineSubViews(CurrentChild, Children, LineNo);
+ // We need the expansions and instantiations sorted so we can go through them
+ // while we iterate lines.
+ std::sort(ExpansionSubViews.begin(), ExpansionSubViews.end());
+ std::sort(InstantiationSubViews.begin(), InstantiationSubViews.end());
+ auto NextESV = ExpansionSubViews.begin();
+ auto EndESV = ExpansionSubViews.end();
+ auto NextISV = InstantiationSubViews.begin();
+ auto EndISV = InstantiationSubViews.end();
+
+ // Get the coverage information for the file.
+ auto NextSegment = CoverageInfo.begin();
+ auto EndSegment = CoverageInfo.end();
+
+ unsigned FirstLine = NextSegment != EndSegment ? NextSegment->Line : 0;
+ const coverage::CoverageSegment *WrappedSegment = nullptr;
+ SmallVector<const coverage::CoverageSegment *, 8> LineSegments;
+ for (line_iterator LI(File, /*SkipBlanks=*/false); !LI.is_at_eof(); ++LI) {
+ // If we aren't rendering the whole file, we need to filter out the prologue
+ // and epilogue.
+ if (!WholeFile) {
+ if (NextSegment == EndSegment)
+ break;
+ else if (LI.line_number() < FirstLine)
+ continue;
+ }
- renderOffset(OS, Offset);
+ // Collect the coverage information relevant to this line.
+ if (LineSegments.size())
+ WrappedSegment = LineSegments.back();
+ LineSegments.clear();
+ while (NextSegment != EndSegment && NextSegment->Line == LI.line_number())
+ LineSegments.push_back(&*NextSegment++);
+
+ // Calculate a count to be for the line as a whole.
+ LineCoverageInfo LineCount;
+ if (WrappedSegment && WrappedSegment->HasCount)
+ LineCount.addRegionCount(WrappedSegment->Count);
+ for (const auto *S : LineSegments)
+ if (S->HasCount && S->IsRegionEntry)
+ LineCount.addRegionStartCount(S->Count);
+
+ // Render the line prefix.
+ renderIndent(OS, IndentLevel);
if (Options.ShowLineStats)
- renderLineCoverageColumn(OS, LineStats[I]);
+ renderLineCoverageColumn(OS, LineCount);
if (Options.ShowLineNumbers)
- renderLineNumberColumn(OS, LineNo);
+ renderLineNumberColumn(OS, LI.line_number());
- // Gather highlighting ranges.
- auto LineHighlightRanges =
- gatherLineItems(CurrentHighlightRange, HighlightRanges, LineNo);
- auto LineRanges = LineHighlightRanges;
- // Highlight the expansion range if there is an expansion subview on this
- // line.
- if (!LineSubViews.empty() && LineSubViews.front()->isExpansionSubView() &&
- Options.Colors) {
- insertHighlightRange(LineHighlightRanges,
- LineSubViews.front()->getExpansionHighlightRange(),
- AdjustedLineHighlightRanges);
- LineRanges = AdjustedLineHighlightRanges;
- }
+ // If there are expansion subviews, we want to highlight the first one.
+ unsigned ExpansionColumn = 0;
+ if (NextESV != EndESV && NextESV->getLine() == LI.line_number() &&
+ Options.Colors)
+ ExpansionColumn = NextESV->getStartCol();
// Display the source code for the current line.
- StringRef Line = *Lines;
- // Check if the line is empty, as line_iterator skips blank lines.
- if (LineNo < Lines.line_number())
- Line = "";
- else if (!Lines.is_at_eof())
- ++Lines;
- renderLine(OS, Line, LineRanges);
+ renderLine(OS, *LI, LI.line_number(), WrappedSegment, LineSegments,
+ ExpansionColumn);
// Show the region markers.
- bool ShowMarkers = !Options.ShowLineStatsOrRegionMarkers ||
- LineStats[I].hasMultipleRegions();
- auto LineMarkers = gatherLineItems(CurrentRegionMarker, Markers, LineNo);
- if (ShowMarkers && !LineMarkers.empty()) {
- renderOffset(OS, Offset);
+ if (Options.ShowRegionMarkers && (!Options.ShowLineStatsOrRegionMarkers ||
+ LineCount.hasMultipleRegions()) &&
+ !LineSegments.empty()) {
+ renderIndent(OS, IndentLevel);
OS.indent(CombinedColumnWidth);
- renderRegionMarkers(OS, LineMarkers);
+ renderRegionMarkers(OS, LineSegments);
}
- // Show the line's expanded child subviews.
- bool FirstChildExpansion = true;
- if (LineSubViews.empty())
- continue;
- unsigned NewOffset = Offset + 1;
- renderViewDivider(NewOffset, DividerWidth, OS);
- OS << "\n";
- for (const auto &Child : LineSubViews) {
- // If this subview shows a function instantiation, render the function's
- // name.
- if (Child->isInstantiationSubView()) {
- renderOffset(OS, NewOffset);
- OS << ' ';
- Options.colored_ostream(OS, raw_ostream::CYAN) << Child->FunctionName
- << ":";
+ // Show the expansions and instantiations for this line.
+ unsigned NestedIndent = IndentLevel + 1;
+ bool RenderedSubView = false;
+ for (; NextESV != EndESV && NextESV->getLine() == LI.line_number();
+ ++NextESV) {
+ renderViewDivider(NestedIndent, DividerWidth, OS);
+ OS << "\n";
+ if (RenderedSubView) {
+ // Re-render the current line and highlight the expansion range for
+ // this subview.
+ ExpansionColumn = NextESV->getStartCol();
+ renderIndent(OS, IndentLevel);
+ OS.indent(CombinedColumnWidth + (IndentLevel == 0 ? 0 : 1));
+ renderLine(OS, *LI, LI.line_number(), WrappedSegment, LineSegments,
+ ExpansionColumn);
+ renderViewDivider(NestedIndent, DividerWidth, OS);
OS << "\n";
- } else {
- if (!FirstChildExpansion) {
- // Re-render the current line and highlight the expansion range for
- // this
- // subview.
- insertHighlightRange(LineHighlightRanges,
- Child->getExpansionHighlightRange(),
- AdjustedLineHighlightRanges);
- renderOffset(OS, Offset);
- OS.indent(CombinedColumnWidth + (Offset == 0 ? 0 : 1));
- renderLine(OS, Line, AdjustedLineHighlightRanges);
- renderViewDivider(NewOffset, DividerWidth, OS);
- OS << "\n";
- } else
- FirstChildExpansion = false;
}
// Render the child subview
- Child->render(OS, NewOffset);
- renderViewDivider(NewOffset, DividerWidth, OS);
- OS << "\n";
- }
- }
-}
-
-void
-SourceCoverageView::createLineCoverageInfo(SourceCoverageDataManager &Data) {
- LineStats.resize(LineCount);
- for (const auto &CR : Data.getSourceRegions()) {
- if (CR.Kind == coverage::CounterMappingRegion::SkippedRegion) {
- // Reset the line stats for skipped regions.
- for (unsigned Line = CR.LineStart; Line <= CR.LineEnd;
- ++Line)
- LineStats[Line - LineStart] = LineCoverageInfo();
- continue;
+ if (Options.Debug)
+ errs() << "Expansion at line " << NextESV->getLine() << ", "
+ << NextESV->getStartCol() << " -> " << NextESV->getEndCol()
+ << "\n";
+ NextESV->View->render(OS, false, NestedIndent);
+ RenderedSubView = true;
}
- LineStats[CR.LineStart - LineStart].addRegionStartCount(CR.ExecutionCount);
- for (unsigned Line = CR.LineStart + 1; Line <= CR.LineEnd; ++Line)
- LineStats[Line - LineStart].addRegionCount(CR.ExecutionCount);
- }
-}
-
-void
-SourceCoverageView::createHighlightRanges(SourceCoverageDataManager &Data) {
- auto CountedRegions = Data.getSourceRegions();
- std::vector<bool> AlreadyHighlighted;
- AlreadyHighlighted.resize(CountedRegions.size(), false);
-
- for (size_t I = 0, S = CountedRegions.size(); I < S; ++I) {
- const auto &CR = CountedRegions[I];
- if (CR.Kind == coverage::CounterMappingRegion::SkippedRegion ||
- CR.ExecutionCount != 0)
- continue;
- if (AlreadyHighlighted[I])
- continue;
- for (size_t J = 0; J < S; ++J) {
- if (CR.contains(CountedRegions[J])) {
- AlreadyHighlighted[J] = true;
- }
- }
- if (CR.LineStart == CR.LineEnd) {
- HighlightRanges.push_back(HighlightRange(
- CR.LineStart, CR.ColumnStart, CR.ColumnEnd));
- continue;
- }
- HighlightRanges.push_back(
- HighlightRange(CR.LineStart, CR.ColumnStart,
- std::numeric_limits<unsigned>::max()));
- HighlightRanges.push_back(
- HighlightRange(CR.LineEnd, 1, CR.ColumnEnd));
- for (unsigned Line = CR.LineStart + 1; Line < CR.LineEnd;
- ++Line) {
- HighlightRanges.push_back(
- HighlightRange(Line, 1, std::numeric_limits<unsigned>::max()));
- }
- }
-
- std::sort(HighlightRanges.begin(), HighlightRanges.end());
-
- if (Options.Debug) {
- for (const auto &Range : HighlightRanges) {
- outs() << "Highlighted line " << Range.Line << ", " << Range.ColumnStart
- << " -> ";
- if (Range.ColumnEnd == std::numeric_limits<unsigned>::max()) {
- outs() << "?\n";
- } else {
- outs() << Range.ColumnEnd << "\n";
- }
+ for (; NextISV != EndISV && NextISV->Line == LI.line_number(); ++NextISV) {
+ renderViewDivider(NestedIndent, DividerWidth, OS);
+ OS << "\n";
+ renderIndent(OS, NestedIndent);
+ OS << ' ';
+ Options.colored_ostream(OS, raw_ostream::CYAN) << NextISV->FunctionName
+ << ":";
+ OS << "\n";
+ NextISV->View->render(OS, false, NestedIndent);
+ RenderedSubView = true;
}
- }
-}
-
-void SourceCoverageView::createRegionMarkers(SourceCoverageDataManager &Data) {
- for (const auto &CR : Data.getSourceRegions()) {
- if (CR.Kind == coverage::CounterMappingRegion::SkippedRegion)
- continue;
- if (CR.LineStart >= LineStart)
- Markers.push_back(
- RegionMarker(CR.LineStart, CR.ColumnStart, CR.ExecutionCount));
- }
-
- if (Options.Debug) {
- for (const auto &Marker : Markers) {
- outs() << "Marker at " << Marker.Line << ":" << Marker.Column << " = "
- << Marker.ExecutionCount << "\n";
+ if (RenderedSubView) {
+ renderViewDivider(NestedIndent, DividerWidth, OS);
+ OS << "\n";
}
}
}
-
-void SourceCoverageView::load(SourceCoverageDataManager &Data) {
- if (Options.ShowLineStats)
- createLineCoverageInfo(Data);
- if (Options.Colors)
- createHighlightRanges(Data);
- if (Options.ShowRegionMarkers)
- createRegionMarkers(Data);
-}
projects / oota-llvm.git / blobdiff