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 coverage printer for text output. 22 class CoveragePrinterText : public CoveragePrinter { 23 public: 24 Expected<OwnedStream> createViewFile(StringRef Path, 25 bool InToplevel) override; 26 27 void closeViewFile(OwnedStream OS) override; 28 29 Error createIndexFile(ArrayRef<std::string> SourceFiles, 30 const coverage::CoverageMapping &Coverage, 31 const CoverageFiltersMatchAll &Filters) override; 32 33 CoveragePrinterText(const CoverageViewOptions &Opts) 34 : CoveragePrinter(Opts) {} 35 }; 36 37 /// \brief A code coverage view which supports text-based rendering. 38 class SourceCoverageViewText : public SourceCoverageView { 39 void renderViewHeader(raw_ostream &OS) override; 40 41 void renderViewFooter(raw_ostream &OS) override; 42 43 void renderSourceName(raw_ostream &OS, bool WholeFile) override; 44 45 void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override; 46 47 void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override; 48 49 void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override; 50 51 void renderLine(raw_ostream &OS, LineRef L, const LineCoverageStats &LCS, 52 unsigned ExpansionCol, unsigned ViewDepth) override; 53 54 void renderExpansionSite(raw_ostream &OS, LineRef L, 55 const LineCoverageStats &LCS, unsigned ExpansionCol, 56 unsigned ViewDepth) override; 57 58 void renderExpansionView(raw_ostream &OS, ExpansionView &ESV, 59 unsigned ViewDepth) override; 60 61 void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV, 62 unsigned ViewDepth) override; 63 64 void renderLineCoverageColumn(raw_ostream &OS, 65 const LineCoverageStats &Line) override; 66 67 void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override; 68 69 void renderRegionMarkers(raw_ostream &OS, const LineCoverageStats &Line, 70 unsigned ViewDepth) override; 71 72 void renderTitle(raw_ostream &OS, StringRef Title) override; 73 74 void renderTableHeader(raw_ostream &OS, unsigned FirstUncoveredLineNo, 75 unsigned IndentLevel) override; 76 77 public: 78 SourceCoverageViewText(StringRef SourceName, const MemoryBuffer &File, 79 const CoverageViewOptions &Options, 80 coverage::CoverageData &&CoverageInfo) 81 : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) { 82 } 83 }; 84 85 } // namespace llvm 86 87 #endif // LLVM_COV_SOURCECOVERAGEVIEWTEXT_H 88