Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 1 | //===- SourceCoverageView.h - Code coverage view for source code ----------===// |
| 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 | // This class implements rendering for code coverage of source code. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
| 14 | #ifndef LLVM_COV_SOURCECOVERAGEVIEW_H |
| 15 | #define LLVM_COV_SOURCECOVERAGEVIEW_H |
| 16 | |
| 17 | #include "CoverageViewOptions.h" |
Easwaran Raman | dc70712 | 2016-04-29 18:53:05 +0000 | [diff] [blame^] | 18 | #include "llvm/ProfileData/Coverage/CoverageMapping.h" |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 19 | #include "llvm/Support/MemoryBuffer.h" |
| 20 | #include <vector> |
| 21 | |
| 22 | namespace llvm { |
| 23 | |
Justin Bogner | 5e1400a | 2014-09-17 05:33:20 +0000 | [diff] [blame] | 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)) {} |
Justin Bogner | 99e9518 | 2014-09-17 06:32:48 +0000 | [diff] [blame] | 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 | } |
Justin Bogner | 5e1400a | 2014-09-17 05:33:20 +0000 | [diff] [blame] | 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)) {} |
Justin Bogner | 99e9518 | 2014-09-17 06:32:48 +0000 | [diff] [blame] | 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 | } |
Justin Bogner | 5e1400a | 2014-09-17 05:33:20 +0000 | [diff] [blame] | 69 | |
| 70 | friend bool operator<(const InstantiationView &LHS, |
| 71 | const InstantiationView &RHS) { |
| 72 | return LHS.Line < RHS.Line; |
| 73 | } |
| 74 | }; |
| 75 | |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 76 | /// \brief A code coverage view of a specific source file. |
| 77 | /// It can have embedded coverage views. |
| 78 | class SourceCoverageView { |
Justin Bogner | fe357c0 | 2014-09-17 18:23:47 +0000 | [diff] [blame] | 79 | private: |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 80 | /// \brief Coverage information for a single line. |
| 81 | struct LineCoverageInfo { |
| 82 | uint64_t ExecutionCount; |
| 83 | unsigned RegionCount; |
| 84 | bool Mapped; |
| 85 | |
| 86 | LineCoverageInfo() : ExecutionCount(0), RegionCount(0), Mapped(false) {} |
| 87 | |
| 88 | bool isMapped() const { return Mapped; } |
| 89 | |
| 90 | bool hasMultipleRegions() const { return RegionCount > 1; } |
| 91 | |
| 92 | void addRegionStartCount(uint64_t Count) { |
Justin Bogner | 4d7aae9 | 2015-02-23 21:21:34 +0000 | [diff] [blame] | 93 | // The max of all region starts is the most interesting value. |
| 94 | addRegionCount(RegionCount ? std::max(ExecutionCount, Count) : Count); |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 95 | ++RegionCount; |
| 96 | } |
| 97 | |
| 98 | void addRegionCount(uint64_t Count) { |
| 99 | Mapped = true; |
Justin Bogner | 4d7aae9 | 2015-02-23 21:21:34 +0000 | [diff] [blame] | 100 | ExecutionCount = Count; |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 101 | } |
| 102 | }; |
| 103 | |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 104 | const MemoryBuffer &File; |
| 105 | const CoverageViewOptions &Options; |
Justin Bogner | 953e240 | 2014-09-20 15:31:56 +0000 | [diff] [blame] | 106 | coverage::CoverageData CoverageInfo; |
Justin Bogner | 5e1400a | 2014-09-17 05:33:20 +0000 | [diff] [blame] | 107 | std::vector<ExpansionView> ExpansionSubViews; |
| 108 | std::vector<InstantiationView> InstantiationSubViews; |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 109 | |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 110 | /// \brief Render a source line with highlighting. |
Justin Bogner | fe357c0 | 2014-09-17 18:23:47 +0000 | [diff] [blame] | 111 | void renderLine(raw_ostream &OS, StringRef Line, int64_t LineNumber, |
Justin Bogner | 953e240 | 2014-09-20 15:31:56 +0000 | [diff] [blame] | 112 | const coverage::CoverageSegment *WrappedSegment, |
| 113 | ArrayRef<const coverage::CoverageSegment *> Segments, |
Justin Bogner | fe357c0 | 2014-09-17 18:23:47 +0000 | [diff] [blame] | 114 | unsigned ExpansionCol); |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 115 | |
Justin Bogner | 76e251c | 2014-09-16 06:21:57 +0000 | [diff] [blame] | 116 | void renderIndent(raw_ostream &OS, unsigned Level); |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 117 | |
| 118 | void renderViewDivider(unsigned Offset, unsigned Length, raw_ostream &OS); |
| 119 | |
| 120 | /// \brief Render the line's execution count column. |
| 121 | void renderLineCoverageColumn(raw_ostream &OS, const LineCoverageInfo &Line); |
| 122 | |
| 123 | /// \brief Render the line number column. |
| 124 | void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo); |
| 125 | |
| 126 | /// \brief Render all the region's execution counts on a line. |
Justin Bogner | 953e240 | 2014-09-20 15:31:56 +0000 | [diff] [blame] | 127 | void |
| 128 | renderRegionMarkers(raw_ostream &OS, |
| 129 | ArrayRef<const coverage::CoverageSegment *> Segments); |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 130 | |
| 131 | static const unsigned LineCoverageColumnWidth = 7; |
| 132 | static const unsigned LineNumberColumnWidth = 5; |
| 133 | |
| 134 | public: |
| 135 | SourceCoverageView(const MemoryBuffer &File, |
Justin Bogner | 953e240 | 2014-09-20 15:31:56 +0000 | [diff] [blame] | 136 | const CoverageViewOptions &Options, |
| 137 | coverage::CoverageData &&CoverageInfo) |
| 138 | : File(File), Options(Options), CoverageInfo(std::move(CoverageInfo)) {} |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 139 | |
| 140 | const CoverageViewOptions &getOptions() const { return Options; } |
| 141 | |
Justin Bogner | 5e1400a | 2014-09-17 05:33:20 +0000 | [diff] [blame] | 142 | /// \brief Add an expansion subview to this view. |
| 143 | void addExpansion(const coverage::CounterMappingRegion &Region, |
| 144 | std::unique_ptr<SourceCoverageView> View) { |
| 145 | ExpansionSubViews.emplace_back(Region, std::move(View)); |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 146 | } |
| 147 | |
Justin Bogner | 5e1400a | 2014-09-17 05:33:20 +0000 | [diff] [blame] | 148 | /// \brief Add a function instantiation subview to this view. |
| 149 | void addInstantiation(StringRef FunctionName, unsigned Line, |
| 150 | std::unique_ptr<SourceCoverageView> View) { |
| 151 | InstantiationSubViews.emplace_back(FunctionName, Line, std::move(View)); |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 152 | } |
| 153 | |
| 154 | /// \brief Print the code coverage information for a specific |
| 155 | /// portion of a source file to the output stream. |
Justin Bogner | fe357c0 | 2014-09-17 18:23:47 +0000 | [diff] [blame] | 156 | void render(raw_ostream &OS, bool WholeFile, unsigned IndentLevel = 0); |
Alex Lorenz | e82d89c | 2014-08-22 22:56:03 +0000 | [diff] [blame] | 157 | }; |
| 158 | |
| 159 | } // namespace llvm |
| 160 | |
| 161 | #endif // LLVM_COV_SOURCECOVERAGEVIEW_H |