xref: /llvm-project/llvm/tools/llvm-cov/SourceCoverageViewText.h (revision a48d9fe86a627c88a21398db6c18a0108b131444)
1 //===- SourceCoverageViewText.h - A text-based code coverage view ---------===//
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 /// \file This file defines the interface to the text-based coverage renderer.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
15 #define LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
16 
17 #include "SourceCoverageView.h"
18 
19 namespace llvm {
20 
21 /// \brief A code coverage view which supports text-based rendering.
22 class SourceCoverageViewText : public SourceCoverageView {
23   void renderSourceName(raw_ostream &OS) override;
24 
25   void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;
26 
27   void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;
28 
29   void renderLine(raw_ostream &OS, LineRef L,
30                   const coverage::CoverageSegment *WrappedSegment,
31                   CoverageSegmentArray Segments, unsigned ExpansionCol,
32                   unsigned ViewDepth) override;
33 
34   void renderExpansionSite(raw_ostream &OS, ExpansionView &ESV, LineRef L,
35                            const coverage::CoverageSegment *WrappedSegment,
36                            CoverageSegmentArray Segments, unsigned ExpansionCol,
37                            unsigned ViewDepth) override;
38 
39   void renderExpansionView(raw_ostream &OS, ExpansionView &ESV,
40                            unsigned ViewDepth) override;
41 
42   void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV,
43                                unsigned ViewDepth) override;
44 
45   void renderLineCoverageColumn(raw_ostream &OS,
46                                 const LineCoverageStats &Line) override;
47 
48   void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override;
49 
50   void renderRegionMarkers(raw_ostream &OS, CoverageSegmentArray Segments,
51                            unsigned ViewDepth) override;
52 
53 public:
54   SourceCoverageViewText(StringRef SourceName, const MemoryBuffer &File,
55                          const CoverageViewOptions &Options,
56                          coverage::CoverageData &&CoverageInfo)
57       : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
58   }
59 };
60 
61 } // namespace llvm
62 
63 #endif // LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
64