bea39c5443
This is a GSoC 2023 project ([discourse link](https://discourse.llvm.org/t/coverage-support-a-hierarchical-directory-structure-in-generated-coverage-html-reports/68239)). llvm-cov currently generates a single top-level index HTML file, which causes rendering scalability issues in large projects. This patch adds support for hierarchical directory structure into the HTML reports to solve scalability issues by introducing the following changes: - Added a new command line option `--show-directory-coverage` for `llvm-cov show`. It works both for `--format=html` and `--format=text`. - Two new classes: `CoveragePrinterHTMLDirectory` and `CoveragePrinterTextDirectory` was added to support the new option. - A tool class `DirectoryCoverageReport` was added to support the two classes above. - Updated the document. - Added a new regression test for `--show-directory-coverage`. Reviewed By: phosek, gulfem Differential Revision: https://reviews.llvm.org/D151283
121 lines
4.2 KiB
C++
121 lines
4.2 KiB
C++
//===- SourceCoverageViewHTML.h - A html 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 html coverage renderer.
|
|
///
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_COV_SOURCECOVERAGEVIEWHTML_H
|
|
#define LLVM_COV_SOURCECOVERAGEVIEWHTML_H
|
|
|
|
#include "SourceCoverageView.h"
|
|
|
|
namespace llvm {
|
|
|
|
using namespace coverage;
|
|
|
|
class ThreadPool;
|
|
|
|
struct FileCoverageSummary;
|
|
|
|
/// A coverage printer for html output.
|
|
class CoveragePrinterHTML : public CoveragePrinter {
|
|
public:
|
|
Expected<OwnedStream> createViewFile(StringRef Path,
|
|
bool InToplevel) override;
|
|
|
|
void closeViewFile(OwnedStream OS) override;
|
|
|
|
Error createIndexFile(ArrayRef<std::string> SourceFiles,
|
|
const coverage::CoverageMapping &Coverage,
|
|
const CoverageFiltersMatchAll &Filters) override;
|
|
|
|
CoveragePrinterHTML(const CoverageViewOptions &Opts)
|
|
: CoveragePrinter(Opts) {}
|
|
|
|
protected:
|
|
Error emitStyleSheet();
|
|
void emitReportHeader(raw_ostream &OSRef, const std::string &Title);
|
|
|
|
private:
|
|
void emitFileSummary(raw_ostream &OS, StringRef SF,
|
|
const FileCoverageSummary &FCS,
|
|
bool IsTotals = false) const;
|
|
std::string buildLinkToFile(StringRef SF,
|
|
const FileCoverageSummary &FCS) const;
|
|
};
|
|
|
|
/// A coverage printer for html output, but generates index files in every
|
|
/// subdirectory to show a hierarchical view.
|
|
class CoveragePrinterHTMLDirectory : public CoveragePrinterHTML {
|
|
public:
|
|
using CoveragePrinterHTML::CoveragePrinterHTML;
|
|
|
|
Error createIndexFile(ArrayRef<std::string> SourceFiles,
|
|
const coverage::CoverageMapping &Coverage,
|
|
const CoverageFiltersMatchAll &Filters) override;
|
|
|
|
private:
|
|
struct Reporter;
|
|
};
|
|
|
|
/// A code coverage view which supports html-based rendering.
|
|
class SourceCoverageViewHTML : public SourceCoverageView {
|
|
void renderViewHeader(raw_ostream &OS) override;
|
|
|
|
void renderViewFooter(raw_ostream &OS) override;
|
|
|
|
void renderSourceName(raw_ostream &OS, bool WholeFile) override;
|
|
|
|
void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;
|
|
|
|
void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override;
|
|
|
|
void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;
|
|
|
|
void renderLine(raw_ostream &OS, LineRef L, const LineCoverageStats &LCS,
|
|
unsigned ExpansionCol, unsigned ViewDepth) override;
|
|
|
|
void renderExpansionSite(raw_ostream &OS, LineRef L,
|
|
const LineCoverageStats &LCS, unsigned ExpansionCol,
|
|
unsigned ViewDepth) override;
|
|
|
|
void renderExpansionView(raw_ostream &OS, ExpansionView &ESV,
|
|
unsigned ViewDepth) override;
|
|
|
|
void renderBranchView(raw_ostream &OS, BranchView &BRV,
|
|
unsigned ViewDepth) override;
|
|
|
|
void renderInstantiationView(raw_ostream &OS, InstantiationView &ISV,
|
|
unsigned ViewDepth) override;
|
|
|
|
void renderLineCoverageColumn(raw_ostream &OS,
|
|
const LineCoverageStats &Line) override;
|
|
|
|
void renderLineNumberColumn(raw_ostream &OS, unsigned LineNo) override;
|
|
|
|
void renderRegionMarkers(raw_ostream &OS, const LineCoverageStats &Line,
|
|
unsigned ViewDepth) override;
|
|
|
|
void renderTitle(raw_ostream &OS, StringRef Title) override;
|
|
|
|
void renderTableHeader(raw_ostream &OS, unsigned FirstUncoveredLineNo,
|
|
unsigned IndentLevel) override;
|
|
|
|
public:
|
|
SourceCoverageViewHTML(StringRef SourceName, const MemoryBuffer &File,
|
|
const CoverageViewOptions &Options,
|
|
coverage::CoverageData &&CoverageInfo)
|
|
: SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
|
|
}
|
|
};
|
|
|
|
} // namespace llvm
|
|
|
|
#endif // LLVM_COV_SOURCECOVERAGEVIEWHTML_H
|