1 //===- SourceCoverageView.h - Code coverage view for source code ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 /// \file This class implements rendering for code coverage of source code.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_COV_SOURCECOVERAGEVIEW_H
15 #define LLVM_COV_SOURCECOVERAGEVIEW_H
17 #include "CoverageViewOptions.h"
18 #include "llvm/ProfileData/Coverage/CoverageMapping.h"
19 #include "llvm/Support/MemoryBuffer.h"
24 class SourceCoverageView;
26 /// \brief A view that represents a macro or include expansion.
27 struct ExpansionView {
28 coverage::CounterMappingRegion Region;
29 std::unique_ptr<SourceCoverageView> View;
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);
42 unsigned getLine() const { return Region.LineStart; }
43 unsigned getStartCol() const { return Region.ColumnStart; }
44 unsigned getEndCol() const { return Region.ColumnEnd; }
46 friend bool operator<(const ExpansionView &LHS, const ExpansionView &RHS) {
47 return LHS.Region.startLoc() < RHS.Region.startLoc();
51 /// \brief A view that represents a function instantiation.
52 struct InstantiationView {
53 StringRef FunctionName;
55 std::unique_ptr<SourceCoverageView> View;
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);
70 friend bool operator<(const InstantiationView &LHS,
71 const InstantiationView &RHS) {
72 return LHS.Line < RHS.Line;
76 /// \brief Coverage statistics for a single line.
77 struct LineCoverageStats {
78 uint64_t ExecutionCount;
82 LineCoverageStats() : ExecutionCount(0), RegionCount(0), Mapped(false) {}
84 bool isMapped() const { return Mapped; }
86 bool hasMultipleRegions() const { return RegionCount > 1; }
88 void addRegionStartCount(uint64_t Count) {
89 // The max of all region starts is the most interesting value.
90 addRegionCount(RegionCount ? std::max(ExecutionCount, Count) : Count);
94 void addRegionCount(uint64_t Count) {
96 ExecutionCount = Count;
100 /// \brief A file manager that handles format-aware file creation.
101 class CoveragePrinter {
102 const CoverageViewOptions &Opts;
105 struct StreamDestructor {
106 void operator()(raw_ostream *OS) const;
109 using OwnedStream = std::unique_ptr<raw_ostream, StreamDestructor>;
112 CoveragePrinter(const CoverageViewOptions &Opts) : Opts(Opts) {}
114 /// \brief Return `OutputDir/ToplevelDir/Path.Extension`. If \p InToplevel is
115 /// false, skip the ToplevelDir component. If \p Relative is false, skip the
116 /// OutputDir component.
117 std::string getOutputPath(StringRef Path, StringRef Extension,
118 bool InToplevel, bool Relative = true);
120 /// \brief If directory output is enabled, create a file in that directory
121 /// at the path given by getOutputPath(). Otherwise, return stdout.
122 Expected<OwnedStream> createOutputStream(StringRef Path, StringRef Extension,
125 /// \brief Return the sub-directory name for file coverage reports.
126 static StringRef getCoverageDir() { return "coverage"; }
129 static std::unique_ptr<CoveragePrinter>
130 create(const CoverageViewOptions &Opts);
132 virtual ~CoveragePrinter() {}
134 /// @name File Creation Interface
137 /// \brief Create a file to print a coverage view into.
138 virtual Expected<OwnedStream> createViewFile(StringRef Path,
139 bool InToplevel) = 0;
141 /// \brief Close a file which has been used to print a coverage view.
142 virtual void closeViewFile(OwnedStream OS) = 0;
144 /// \brief Create an index which lists reports for the given source files.
145 virtual Error createIndexFile(ArrayRef<StringRef> SourceFiles) = 0;
150 /// \brief A code coverage view of a source file or function.
152 /// A source coverage view and its nested sub-views form a file-oriented
153 /// representation of code coverage data. This view can be printed out by a
154 /// renderer which implements the Rendering Interface.
155 class SourceCoverageView {
156 /// A function or file name.
157 StringRef SourceName;
159 /// A memory buffer backing the source on display.
160 const MemoryBuffer &File;
162 /// Various options to guide the coverage renderer.
163 const CoverageViewOptions &Options;
165 /// Complete coverage information about the source on display.
166 coverage::CoverageData CoverageInfo;
168 /// A container for all expansions (e.g macros) in the source on display.
169 std::vector<ExpansionView> ExpansionSubViews;
171 /// A container for all instantiations (e.g template functions) in the source
173 std::vector<InstantiationView> InstantiationSubViews;
180 LineRef(StringRef Line, int64_t LineNo) : Line(Line), LineNo(LineNo) {}
183 using CoverageSegmentArray = ArrayRef<const coverage::CoverageSegment *>;
185 /// @name Rendering Interface
188 /// \brief Render a header for the view.
189 virtual void renderViewHeader(raw_ostream &OS) = 0;
191 /// \brief Render a footer for the view.
192 virtual void renderViewFooter(raw_ostream &OS) = 0;
194 /// \brief Render the source name for the view.
195 virtual void renderSourceName(raw_ostream &OS) = 0;
197 /// \brief Render the line prefix at the given \p ViewDepth.
198 virtual void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) = 0;
200 /// \brief Render the line suffix at the given \p ViewDepth.
201 virtual void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) = 0;
203 /// \brief Render a view divider at the given \p ViewDepth.
204 virtual void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) = 0;
206 /// \brief Render a source line with highlighting.
207 virtual void renderLine(raw_ostream &OS, LineRef L,
208 const coverage::CoverageSegment *WrappedSegment,
209 CoverageSegmentArray Segments, unsigned ExpansionCol,
210 unsigned ViewDepth) = 0;
212 /// \brief Render the line's execution count column.
213 virtual void renderLineCoverageColumn(raw_ostream &OS,
214 const LineCoverageStats &Line) = 0;
216 /// \brief Render the line number column.
217 virtual void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) = 0;
219 /// \brief Render all the region's execution counts on a line.
220 virtual void renderRegionMarkers(raw_ostream &OS,
221 CoverageSegmentArray Segments,
222 unsigned ViewDepth) = 0;
224 /// \brief Render the site of an expansion.
226 renderExpansionSite(raw_ostream &OS, LineRef L,
227 const coverage::CoverageSegment *WrappedSegment,
228 CoverageSegmentArray Segments, unsigned ExpansionCol,
229 unsigned ViewDepth) = 0;
231 /// \brief Render an expansion view and any nested views.
232 virtual void renderExpansionView(raw_ostream &OS, ExpansionView &ESV,
233 unsigned ViewDepth) = 0;
235 /// \brief Render an instantiation view and any nested views.
236 virtual void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV,
237 unsigned ViewDepth) = 0;
241 /// \brief Format a count using engineering notation with 3 significant
243 static std::string formatCount(uint64_t N);
245 /// \brief Check if region marker output is expected for a line.
246 bool shouldRenderRegionMarkers(bool LineHasMultipleRegions) const;
248 /// \brief Check if there are any sub-views attached to this view.
249 bool hasSubViews() const;
251 SourceCoverageView(StringRef SourceName, const MemoryBuffer &File,
252 const CoverageViewOptions &Options,
253 coverage::CoverageData &&CoverageInfo)
254 : SourceName(SourceName), File(File), Options(Options),
255 CoverageInfo(std::move(CoverageInfo)) {}
258 static std::unique_ptr<SourceCoverageView>
259 create(StringRef SourceName, const MemoryBuffer &File,
260 const CoverageViewOptions &Options,
261 coverage::CoverageData &&CoverageInfo);
263 virtual ~SourceCoverageView() {}
265 StringRef getSourceName() const { return SourceName; }
267 const CoverageViewOptions &getOptions() const { return Options; }
269 /// \brief Add an expansion subview to this view.
270 void addExpansion(const coverage::CounterMappingRegion &Region,
271 std::unique_ptr<SourceCoverageView> View);
273 /// \brief Add a function instantiation subview to this view.
274 void addInstantiation(StringRef FunctionName, unsigned Line,
275 std::unique_ptr<SourceCoverageView> View);
277 /// \brief Print the code coverage information for a specific portion of a
278 /// source file to the output stream.
279 void print(raw_ostream &OS, bool WholeFile, bool ShowSourceName,
280 unsigned ViewDepth = 0);
285 #endif // LLVM_COV_SOURCECOVERAGEVIEW_H