xref: /freebsd/contrib/llvm-project/llvm/tools/llvm-cov/CoverageExporter.h (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1*0b57cec5SDimitry Andric //===- CoverageExporter.h - Code coverage exporter ------------------------===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric //
9*0b57cec5SDimitry Andric // This class defines a code coverage exporter interface.
10*0b57cec5SDimitry Andric //
11*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
12*0b57cec5SDimitry Andric 
13*0b57cec5SDimitry Andric #ifndef LLVM_COV_COVERAGEEXPORTER_H
14*0b57cec5SDimitry Andric #define LLVM_COV_COVERAGEEXPORTER_H
15*0b57cec5SDimitry Andric 
16*0b57cec5SDimitry Andric #include "CoverageFilters.h"
17*0b57cec5SDimitry Andric #include "CoverageSummaryInfo.h"
18*0b57cec5SDimitry Andric #include "CoverageViewOptions.h"
19*0b57cec5SDimitry Andric #include "llvm/ProfileData/Coverage/CoverageMapping.h"
20*0b57cec5SDimitry Andric 
21*0b57cec5SDimitry Andric namespace llvm {
22*0b57cec5SDimitry Andric 
23*0b57cec5SDimitry Andric /// Exports the code coverage information.
24*0b57cec5SDimitry Andric class CoverageExporter {
25*0b57cec5SDimitry Andric protected:
26*0b57cec5SDimitry Andric   /// The full CoverageMapping object to export.
27*0b57cec5SDimitry Andric   const coverage::CoverageMapping &Coverage;
28*0b57cec5SDimitry Andric 
29*0b57cec5SDimitry Andric   /// The options passed to the tool.
30*0b57cec5SDimitry Andric   const CoverageViewOptions &Options;
31*0b57cec5SDimitry Andric 
32*0b57cec5SDimitry Andric   /// Output stream to print to.
33*0b57cec5SDimitry Andric   raw_ostream &OS;
34*0b57cec5SDimitry Andric 
CoverageExporter(const coverage::CoverageMapping & CoverageMapping,const CoverageViewOptions & Options,raw_ostream & OS)35*0b57cec5SDimitry Andric   CoverageExporter(const coverage::CoverageMapping &CoverageMapping,
36*0b57cec5SDimitry Andric                    const CoverageViewOptions &Options, raw_ostream &OS)
37*0b57cec5SDimitry Andric       : Coverage(CoverageMapping), Options(Options), OS(OS) {}
38*0b57cec5SDimitry Andric 
39*0b57cec5SDimitry Andric public:
~CoverageExporter()40*0b57cec5SDimitry Andric   virtual ~CoverageExporter(){};
41*0b57cec5SDimitry Andric 
42*0b57cec5SDimitry Andric   /// Render the CoverageMapping object.
43*0b57cec5SDimitry Andric   virtual void renderRoot(const CoverageFilters &IgnoreFilters) = 0;
44*0b57cec5SDimitry Andric 
45*0b57cec5SDimitry Andric   /// Render the CoverageMapping object for specified source files.
46*0b57cec5SDimitry Andric   virtual void renderRoot(ArrayRef<std::string> SourceFiles) = 0;
47*0b57cec5SDimitry Andric };
48*0b57cec5SDimitry Andric 
49*0b57cec5SDimitry Andric } // end namespace llvm
50*0b57cec5SDimitry Andric 
51*0b57cec5SDimitry Andric #endif // LLVM_COV_COVERAGEEXPORTER_H
52