1 //===- SourceCoverageViewText.h - A text-based code coverage view ---------===//
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 file defines the interface to the text-based coverage renderer.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
15 #define LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
17 #include "SourceCoverageView.h"
21 /// \brief A coverage printer for text output.
22 class CoveragePrinterText : public CoveragePrinter {
24 Expected<OwnedStream> createViewFile(StringRef Path,
25 bool InToplevel) override;
27 void closeViewFile(OwnedStream OS) override;
29 Error createIndexFile(ArrayRef<StringRef> SourceFiles) override;
31 CoveragePrinterText(const CoverageViewOptions &Opts)
32 : CoveragePrinter(Opts) {}
35 /// \brief A code coverage view which supports text-based rendering.
36 class SourceCoverageViewText : public SourceCoverageView {
37 void renderViewHeader(raw_ostream &OS) override;
39 void renderViewFooter(raw_ostream &OS) override;
41 void renderSourceName(raw_ostream &OS) override;
43 void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;
45 void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override;
47 void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;
49 void renderLine(raw_ostream &OS, LineRef L,
50 const coverage::CoverageSegment *WrappedSegment,
51 CoverageSegmentArray Segments, unsigned ExpansionCol,
52 unsigned ViewDepth) override;
54 void renderExpansionSite(raw_ostream &OS, LineRef L,
55 const coverage::CoverageSegment *WrappedSegment,
56 CoverageSegmentArray Segments, unsigned ExpansionCol,
57 unsigned ViewDepth) override;
59 void renderExpansionView(raw_ostream &OS, ExpansionView &ESV,
60 unsigned ViewDepth) override;
62 void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV,
63 unsigned ViewDepth) override;
65 void renderLineCoverageColumn(raw_ostream &OS,
66 const LineCoverageStats &Line) override;
68 void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override;
70 void renderRegionMarkers(raw_ostream &OS, CoverageSegmentArray Segments,
71 unsigned ViewDepth) override;
74 SourceCoverageViewText(StringRef SourceName, const MemoryBuffer &File,
75 const CoverageViewOptions &Options,
76 coverage::CoverageData &&CoverageInfo)
77 : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
83 #endif // LLVM_COV_SOURCECOVERAGEVIEWTEXT_H