SourceCoverageViewText.h

//===- SourceCoverageViewText.h - A text-based code coverage view ---------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file This file defines the interface to the text-based coverage renderer.
///
//===----------------------------------------------------------------------===//

#ifndef LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
#defineLLVM_COV_SOURCECOVERAGEVIEWTEXT_H

#include"SourceCoverageView.h"

namespacellvm {

usingnamespacecoverage;

/// A coverage printer for text output.
classCoveragePrinterText : publicCoveragePrinter {
public:
 Expected<OwnedStream> createViewFile(StringRef Path,
bool InToplevel) override;

voidcloseViewFile(OwnedStream OS) override;

 Error createIndexFile(ArrayRef<std::string> SourceFiles,
const CoverageMapping &Coverage,
const CoverageFiltersMatchAll &Filters) override;

CoveragePrinterText(const CoverageViewOptions &Opts)
 : CoveragePrinter(Opts) {}
};

/// A code coverage view which supports text-based rendering.
classSourceCoverageViewText : publicSourceCoverageView {
voidrenderViewHeader(raw_ostream &OS) override;

voidrenderViewFooter(raw_ostream &OS) override;

voidrenderSourceName(raw_ostream &OS, bool WholeFile) override;

voidrenderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;

voidrenderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override;

voidrenderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;

voidrenderLine(raw_ostream &OS, LineRef L, const LineCoverageStats &LCS,
unsigned ExpansionCol, unsigned ViewDepth) override;

voidrenderExpansionSite(raw_ostream &OS, LineRef L,
const LineCoverageStats &LCS, unsigned ExpansionCol,
unsigned ViewDepth) override;

voidrenderExpansionView(raw_ostream &OS, ExpansionView &ESV,
unsigned ViewDepth) override;

voidrenderInstantiationView(raw_ostream &OS, InstantiationView &ISV,
unsigned ViewDepth) override;

voidrenderLineCoverageColumn(raw_ostream &OS,
const LineCoverageStats &Line) override;

voidrenderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override;

voidrenderRegionMarkers(raw_ostream &OS, const LineCoverageStats &Line,
unsigned ViewDepth) override;

voidrenderTitle(raw_ostream &OS, StringRef Title) override;

voidrenderTableHeader(raw_ostream &OS, unsigned FirstUncoveredLineNo,
unsigned IndentLevel) override;

public:
SourceCoverageViewText(StringRef SourceName, const MemoryBuffer &File,
const CoverageViewOptions &Options,
 CoverageData &&CoverageInfo)
 : SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
 }
};

} // namespace llvm

#endif// LLVM_COV_SOURCECOVERAGEVIEWTEXT_H