77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
1 //===- SourceCoverageView.h - 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 #ifndef LLVM_COV_SOURCECOVERAGEVIEW_H
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
15 #define LLVM_COV_SOURCECOVERAGEVIEW_H
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
16
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
17 #include "CoverageViewOptions.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
18 #include "llvm/ProfileData/CoverageMapping.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
19 #include "llvm/Support/MemoryBuffer.h"
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
20 #include <vector>
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
21
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
22 namespace llvm {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
23
|
83
|
24 class SourceCoverageView;
|
|
25
|
|
26 /// \brief A view that represents a macro or include expansion
|
|
27 struct ExpansionView {
|
|
28 coverage::CounterMappingRegion Region;
|
|
29 std::unique_ptr<SourceCoverageView> View;
|
|
30
|
|
31 ExpansionView(const coverage::CounterMappingRegion &Region,
|
|
32 std::unique_ptr<SourceCoverageView> View)
|
|
33 : Region(Region), View(std::move(View)) {}
|
|
34 ExpansionView(ExpansionView &&RHS)
|
|
35 : Region(std::move(RHS.Region)), View(std::move(RHS.View)) {}
|
|
36 ExpansionView &operator=(ExpansionView &&RHS) {
|
|
37 Region = std::move(RHS.Region);
|
|
38 View = std::move(RHS.View);
|
|
39 return *this;
|
|
40 }
|
|
41
|
|
42 unsigned getLine() const { return Region.LineStart; }
|
|
43 unsigned getStartCol() const { return Region.ColumnStart; }
|
|
44 unsigned getEndCol() const { return Region.ColumnEnd; }
|
|
45
|
|
46 friend bool operator<(const ExpansionView &LHS, const ExpansionView &RHS) {
|
|
47 return LHS.Region.startLoc() < RHS.Region.startLoc();
|
|
48 }
|
|
49 };
|
|
50
|
|
51 /// \brief A view that represents a function instantiation
|
|
52 struct InstantiationView {
|
|
53 StringRef FunctionName;
|
|
54 unsigned Line;
|
|
55 std::unique_ptr<SourceCoverageView> View;
|
|
56
|
|
57 InstantiationView(StringRef FunctionName, unsigned Line,
|
|
58 std::unique_ptr<SourceCoverageView> View)
|
|
59 : FunctionName(FunctionName), Line(Line), View(std::move(View)) {}
|
|
60 InstantiationView(InstantiationView &&RHS)
|
|
61 : FunctionName(std::move(RHS.FunctionName)), Line(std::move(RHS.Line)),
|
|
62 View(std::move(RHS.View)) {}
|
|
63 InstantiationView &operator=(InstantiationView &&RHS) {
|
|
64 FunctionName = std::move(RHS.FunctionName);
|
|
65 Line = std::move(RHS.Line);
|
|
66 View = std::move(RHS.View);
|
|
67 return *this;
|
|
68 }
|
|
69
|
|
70 friend bool operator<(const InstantiationView &LHS,
|
|
71 const InstantiationView &RHS) {
|
|
72 return LHS.Line < RHS.Line;
|
|
73 }
|
|
74 };
|
|
75
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
76 /// \brief A code coverage view of a specific source file.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
77 /// It can have embedded coverage views.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
78 class SourceCoverageView {
|
83
|
79 private:
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
80 /// \brief Coverage information for a single line.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
81 struct LineCoverageInfo {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
82 uint64_t ExecutionCount;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
83 unsigned RegionCount;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
84 bool Mapped;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
85
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
86 LineCoverageInfo() : ExecutionCount(0), RegionCount(0), Mapped(false) {}
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
87
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
88 bool isMapped() const { return Mapped; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
89
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
90 bool hasMultipleRegions() const { return RegionCount > 1; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
91
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
92 void addRegionStartCount(uint64_t Count) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
93 Mapped = true;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
94 ExecutionCount = Count;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
95 ++RegionCount;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
96 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
97
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
98 void addRegionCount(uint64_t Count) {
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
99 Mapped = true;
|
83
|
100 if (!RegionCount)
|
|
101 ExecutionCount = Count;
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
102 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
103 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
104
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
105 const MemoryBuffer &File;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
106 const CoverageViewOptions &Options;
|
83
|
107 coverage::CoverageData CoverageInfo;
|
|
108 std::vector<ExpansionView> ExpansionSubViews;
|
|
109 std::vector<InstantiationView> InstantiationSubViews;
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
110
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
111 /// \brief Render a source line with highlighting.
|
83
|
112 void renderLine(raw_ostream &OS, StringRef Line, int64_t LineNumber,
|
|
113 const coverage::CoverageSegment *WrappedSegment,
|
|
114 ArrayRef<const coverage::CoverageSegment *> Segments,
|
|
115 unsigned ExpansionCol);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
116
|
83
|
117 void renderIndent(raw_ostream &OS, unsigned Level);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
118
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
119 void renderViewDivider(unsigned Offset, unsigned Length, raw_ostream &OS);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
120
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
121 /// \brief Render the line's execution count column.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
122 void renderLineCoverageColumn(raw_ostream &OS, const LineCoverageInfo &Line);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
123
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
124 /// \brief Render the line number column.
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
125 void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo);
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
126
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
127 /// \brief Render all the region's execution counts on a line.
|
83
|
128 void
|
|
129 renderRegionMarkers(raw_ostream &OS,
|
|
130 ArrayRef<const coverage::CoverageSegment *> Segments);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
131
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
132 static const unsigned LineCoverageColumnWidth = 7;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
133 static const unsigned LineNumberColumnWidth = 5;
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
134
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
135 public:
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
136 SourceCoverageView(const MemoryBuffer &File,
|
83
|
137 const CoverageViewOptions &Options,
|
|
138 coverage::CoverageData &&CoverageInfo)
|
|
139 : File(File), Options(Options), CoverageInfo(std::move(CoverageInfo)) {}
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
140
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
141 const CoverageViewOptions &getOptions() const { return Options; }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
142
|
83
|
143 /// \brief Add an expansion subview to this view.
|
|
144 void addExpansion(const coverage::CounterMappingRegion &Region,
|
|
145 std::unique_ptr<SourceCoverageView> View) {
|
|
146 ExpansionSubViews.emplace_back(Region, std::move(View));
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
147 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
148
|
83
|
149 /// \brief Add a function instantiation subview to this view.
|
|
150 void addInstantiation(StringRef FunctionName, unsigned Line,
|
|
151 std::unique_ptr<SourceCoverageView> View) {
|
|
152 InstantiationSubViews.emplace_back(FunctionName, Line, std::move(View));
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
153 }
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
154
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
155 /// \brief Print the code coverage information for a specific
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
156 /// portion of a source file to the output stream.
|
83
|
157 void render(raw_ostream &OS, bool WholeFile, unsigned IndentLevel = 0);
|
77
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
158 };
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
159
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
160 } // namespace llvm
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
161
|
Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
162 #endif // LLVM_COV_SOURCECOVERAGEVIEW_H
|