1 //===- SourceCoverageViewHTML.h - A html 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 html coverage renderer.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_COV_SOURCECOVERAGEVIEWHTML_H
15 #define LLVM_COV_SOURCECOVERAGEVIEWHTML_H
17 #include "SourceCoverageView.h"
21 struct FileCoverageSummary;
23 /// \brief A coverage printer for html output.
24 class CoveragePrinterHTML : public CoveragePrinter {
26 Expected<OwnedStream> createViewFile(StringRef Path,
27 bool InToplevel) override;
29 void closeViewFile(OwnedStream OS) override;
31 Error createIndexFile(ArrayRef<std::string> SourceFiles,
32 const coverage::CoverageMapping &Coverage) override;
34 CoveragePrinterHTML(const CoverageViewOptions &Opts)
35 : CoveragePrinter(Opts) {}
38 void emitFileSummary(raw_ostream &OS, StringRef SF,
39 const FileCoverageSummary &FCS,
40 bool IsTotals = false) const;
43 /// \brief A code coverage view which supports html-based rendering.
44 class SourceCoverageViewHTML : public SourceCoverageView {
45 void renderViewHeader(raw_ostream &OS) override;
47 void renderViewFooter(raw_ostream &OS) override;
49 void renderSourceName(raw_ostream &OS, bool WholeFile) override;
51 void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;
53 void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override;
55 void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;
57 void renderLine(raw_ostream &OS, LineRef L,
58 const coverage::CoverageSegment *WrappedSegment,
59 CoverageSegmentArray Segments, unsigned ExpansionCol,
60 unsigned ViewDepth) override;
62 void renderExpansionSite(raw_ostream &OS, LineRef L,
63 const coverage::CoverageSegment *WrappedSegment,
64 CoverageSegmentArray Segments, unsigned ExpansionCol,
65 unsigned ViewDepth) override;
67 void renderExpansionView(raw_ostream &OS, ExpansionView &ESV,
68 unsigned ViewDepth) override;
70 void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV,
71 unsigned ViewDepth) override;
73 void renderLineCoverageColumn(raw_ostream &OS,
74 const LineCoverageStats &Line) override;
76 void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override;
78 void renderRegionMarkers(raw_ostream &OS, CoverageSegmentArray Segments,
79 unsigned ViewDepth) override;
81 void renderTitle(raw_ostream &OS, StringRef Title) override;
83 void renderTableHeader(raw_ostream &OS, unsigned FirstUncoveredLineNo,
84 unsigned IndentLevel) override;
87 SourceCoverageViewHTML(StringRef SourceName, const MemoryBuffer &File,
88 const CoverageViewOptions &Options,
89 coverage::CoverageData &&CoverageInfo)
90 : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
96 #endif // LLVM_COV_SOURCECOVERAGEVIEWHTML_H