1 //===- SourceCoverageViewHTML.h - A html 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 html coverage renderer.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_COV_SOURCECOVERAGEVIEWHTML_H
15 #define LLVM_COV_SOURCECOVERAGEVIEWHTML_H
16 
17 #include "SourceCoverageView.h"
18 
19 namespace llvm {
20 
21 struct FileCoverageSummary;
22 
23 /// \brief A coverage printer for html output.
24 class CoveragePrinterHTML : public CoveragePrinter {
25 public:
26   Expected<OwnedStream> createViewFile(StringRef Path,
27                                        bool InToplevel) override;
28 
29   void closeViewFile(OwnedStream OS) override;
30 
31   Error createIndexFile(ArrayRef<StringRef> SourceFiles,
32                         const coverage::CoverageMapping &Coverage) override;
33 
34   CoveragePrinterHTML(const CoverageViewOptions &Opts)
35       : CoveragePrinter(Opts) {}
36 
37 private:
38   void emitFileSummary(raw_ostream &OS, StringRef SF,
39                        const FileCoverageSummary &FCS,
40                        bool IsTotals = false) const;
41 };
42 
43 /// \brief A code coverage view which supports html-based rendering.
44 class SourceCoverageViewHTML : public SourceCoverageView {
45   void renderViewHeader(raw_ostream &OS) override;
46 
47   void renderViewFooter(raw_ostream &OS) override;
48 
49   void renderSourceName(raw_ostream &OS, bool WholeFile,
50                         unsigned FirstUncoveredLineNo) override;
51 
52   void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;
53 
54   void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override;
55 
56   void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;
57 
58   void renderLine(raw_ostream &OS, LineRef L,
59                   const coverage::CoverageSegment *WrappedSegment,
60                   CoverageSegmentArray Segments, unsigned ExpansionCol,
61                   unsigned ViewDepth) override;
62 
63   void renderExpansionSite(raw_ostream &OS, LineRef L,
64                            const coverage::CoverageSegment *WrappedSegment,
65                            CoverageSegmentArray Segments, unsigned ExpansionCol,
66                            unsigned ViewDepth) override;
67 
68   void renderExpansionView(raw_ostream &OS, ExpansionView &ESV,
69                            unsigned ViewDepth) override;
70 
71   void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV,
72                                unsigned ViewDepth) override;
73 
74   void renderLineCoverageColumn(raw_ostream &OS,
75                                 const LineCoverageStats &Line) override;
76 
77   void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override;
78 
79   void renderRegionMarkers(raw_ostream &OS, CoverageSegmentArray Segments,
80                            unsigned ViewDepth) override;
81 
82   void renderCellInTitle(raw_ostream &OS, StringRef CellText) override;
83 
84   void renderTableHeader(raw_ostream &OS, unsigned IndentLevel) override;
85 
86 public:
87   SourceCoverageViewHTML(StringRef SourceName, const MemoryBuffer &File,
88                          const CoverageViewOptions &Options,
89                          coverage::CoverageData &&CoverageInfo)
90       : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
91   }
92 };
93 
94 } // namespace llvm
95 
96 #endif // LLVM_COV_SOURCECOVERAGEVIEWHTML_H
97