RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-22 18:54:02 +01:00
Code Issues Projects Releases Wiki Activity
58371c32c8
llvm-mirror/tools/llvm-cov/SourceCoverageViewText.h

88 lines
3.1 KiB
C
Raw Normal View History

[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
//===- SourceCoverageViewText.h - A text-based code coverage view ---------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
[llvm-cov] Flesh out some doxygen comments, NFC llvm-svn: 273772
2016-06-25 07:48:54 +02:00
///
/// \file This file defines the interface to the text-based coverage renderer.
///
[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
//===----------------------------------------------------------------------===//
#ifndef LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
#define LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
#include "SourceCoverageView.h"
namespace llvm {
[llvm-cov] Create an index of reports in -output-dir mode This index lists the reports available in the 'coverage' sub-directory. This will help navigate coverage output from large projects. This commit factors the file creation code out of SourceCoverageView and into CoveragePrinter. llvm-svn: 274029
2016-06-28 18:12:24 +02:00
/// \brief A coverage printer for text output.
class CoveragePrinterText : public CoveragePrinter {
Reapply "[llvm-cov] Add an -output-dir option for the show sub-command"" Passing -output-dir path/to/dir to llvm-cov show creates path/to/dir if it doesn't already exist, and prints reports into that directory. In function view mode, all views are written into path/to/dir/functions.$EXTENSION. In file view mode, all views are written into path/to/dir/coverage/$PATH.$EXTENSION. Changes since the initial commit: - Avoid accidentally closing stdout twice. llvm-svn: 273985
2016-06-28 04:09:39 +02:00
public:
[llvm-cov] Create an index of reports in -output-dir mode This index lists the reports available in the 'coverage' sub-directory. This will help navigate coverage output from large projects. This commit factors the file creation code out of SourceCoverageView and into CoveragePrinter. llvm-svn: 274029
2016-06-28 18:12:24 +02:00
Expected<OwnedStream> createViewFile(StringRef Path,
bool InToplevel) override;
void closeViewFile(OwnedStream OS) override;
Reapply "[llvm-cov] Add an -output-dir option for the show sub-command"" Passing -output-dir path/to/dir to llvm-cov show creates path/to/dir if it doesn't already exist, and prints reports into that directory. In function view mode, all views are written into path/to/dir/functions.$EXTENSION. In file view mode, all views are written into path/to/dir/coverage/$PATH.$EXTENSION. Changes since the initial commit: - Avoid accidentally closing stdout twice. llvm-svn: 273985
2016-06-28 04:09:39 +02:00
[llvm-cov] Get rid of all invalid filename references We used to append filenames into a vector of std::string, and then append a reference to each string into a separate vector. This made it easier to work with the getUniqueSourceFiles API. But it's buggy. std::string has a small-string optimization, so you can't expect to capture a reference to one if you're copying it into a growing vector. Add a test that triggers this invalid reference to std::string scenario, and kill the issue with fire by just using ArrayRef<std::string> everywhere. llvm-svn: 282281
2016-09-23 20:57:32 +02:00
Error createIndexFile(ArrayRef<std::string> SourceFiles,
[llvm-cov] Create directory structure when filtering using -name*= options Before this change using any of the -name*= command line options with an output directory would result in a single file (functions.txt/functions.html) containing the coverage for those specific functions. Now you get the same directory structure as when not using any -name*= options. Differential Revision: https://reviews.llvm.org/D38280 llvm-svn: 314396
2017-09-28 12:07:30 +02:00
const coverage::CoverageMapping &Coverage,
[llvm-cov] Hide files with no coverage from the index when filtering by name Differential Revision: https://reviews.llvm.org/D38457 llvm-svn: 314782
2017-10-03 13:05:28 +02:00
const CoverageFiltersMatchAll &Filters) override;
Reapply "[llvm-cov] Add an -output-dir option for the show sub-command"" Passing -output-dir path/to/dir to llvm-cov show creates path/to/dir if it doesn't already exist, and prints reports into that directory. In function view mode, all views are written into path/to/dir/functions.$EXTENSION. In file view mode, all views are written into path/to/dir/coverage/$PATH.$EXTENSION. Changes since the initial commit: - Avoid accidentally closing stdout twice. llvm-svn: 273985
2016-06-28 04:09:39 +02:00
[llvm-cov] Create an index of reports in -output-dir mode This index lists the reports available in the 'coverage' sub-directory. This will help navigate coverage output from large projects. This commit factors the file creation code out of SourceCoverageView and into CoveragePrinter. llvm-svn: 274029
2016-06-28 18:12:24 +02:00
CoveragePrinterText(const CoverageViewOptions &Opts)
: CoveragePrinter(Opts) {}
};
/// \brief A code coverage view which supports text-based rendering.
class SourceCoverageViewText : public SourceCoverageView {
[llvm-cov] Minor cleanups to prepare for the html format patch - Add renderView{Header,Footer}, renderLineSuffix, and hasSubViews to support creating tables with nested views. - Move the 'Format' cl::opt to make it easier to extend. - Just create one function view file, instead of overwriting the same file for every new function. Add a regression test for this. llvm-svn: 274086
2016-06-29 02:38:21 +02:00
void renderViewHeader(raw_ostream &OS) override;
void renderViewFooter(raw_ostream &OS) override;
[llvm-cov] Move the 'jump to first unexecuted line' link Having it in the same row as the source name is jarring. Move it next to the "Source" column label. llvm-svn: 281146
2016-09-10 21:37:26 +02:00
void renderSourceName(raw_ostream &OS, bool WholeFile) override;
[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
void renderLinePrefix(raw_ostream &OS, unsigned ViewDepth) override;
[llvm-cov] Minor cleanups to prepare for the html format patch - Add renderView{Header,Footer}, renderLineSuffix, and hasSubViews to support creating tables with nested views. - Move the 'Format' cl::opt to make it easier to extend. - Just create one function view file, instead of overwriting the same file for every new function. Add a regression test for this. llvm-svn: 274086
2016-06-29 02:38:21 +02:00
void renderLineSuffix(raw_ostream &OS, unsigned ViewDepth) override;
[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
void renderViewDivider(raw_ostream &OS, unsigned ViewDepth) override;
[llvm-cov] Pass LineCoverageStats in SourceCoverageView. NFC. Instead of copying around the wrapped segment and the list of line segments, just pass a reference to a LineCoverageStats object. This simplifies the interface. It also makes an upcoming change to suppress distracting highlights possible. llvm-svn: 316108
2017-10-18 20:52:28 +02:00
void renderLine(raw_ostream &OS, LineRef L, const LineCoverageStats &LCS,
unsigned ExpansionCol, unsigned ViewDepth) override;
[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
[llvm-cov] Minor cleanups to prepare for the html format patch - Add renderView{Header,Footer}, renderLineSuffix, and hasSubViews to support creating tables with nested views. - Move the 'Format' cl::opt to make it easier to extend. - Just create one function view file, instead of overwriting the same file for every new function. Add a regression test for this. llvm-svn: 274086
2016-06-29 02:38:21 +02:00
void renderExpansionSite(raw_ostream &OS, LineRef L,
[llvm-cov] Pass LineCoverageStats in SourceCoverageView. NFC. Instead of copying around the wrapped segment and the list of line segments, just pass a reference to a LineCoverageStats object. This simplifies the interface. It also makes an upcoming change to suppress distracting highlights possible. llvm-svn: 316108
2017-10-18 20:52:28 +02:00
const LineCoverageStats &LCS, unsigned ExpansionCol,
[llvm-cov] Simplify the way expansion views are rendered (NFC) If a sub-view has already been rendered, it's helpful to re-render the expansion site before rendering the next expansion view. Make this fact explicit in the rendering interface, instead of hiding it behind an awkward Optional<LineRef> parameter. llvm-svn: 273789
2016-06-26 04:45:13 +02:00
unsigned ViewDepth) override;
void renderExpansionView(raw_ostream &OS, ExpansionView &ESV,
unsigned ViewDepth) override;
[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
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;
[llvm-cov] Pass LineCoverageStats in SourceCoverageView. NFC. Instead of copying around the wrapped segment and the list of line segments, just pass a reference to a LineCoverageStats object. This simplifies the interface. It also makes an upcoming change to suppress distracting highlights possible. llvm-svn: 316108
2017-10-18 20:52:28 +02:00
void renderRegionMarkers(raw_ostream &OS, const LineCoverageStats &Line,
[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
unsigned ViewDepth) override;
[llvm-cov] Make a method name more accurate (NFC) llvm-svn: 281581
2016-09-15 06:45:59 +02:00
void renderTitle(raw_ostream &OS, StringRef Title) override;
[llvm-cov] Add the project summary to each source file coverage report. This patch includes the following changes: - Included header "Code coverage report" and include the date that the report was created. - Included title (as specified in a command line option, (i.e llvm-cov -project-title="Simple Test") - In the summary, list the elf files that the source code file has contributed to. - Used column heading for "Line No.", "Count No.", Source". Differential Revision: https://reviews.llvm.org/D23345 llvm-svn: 279628
2016-08-24 16:27:23 +02:00
[llvm-cov] Move the 'jump to first unexecuted line' link Having it in the same row as the source name is jarring. Move it next to the "Source" column label. llvm-svn: 281146
2016-09-10 21:37:26 +02:00
void renderTableHeader(raw_ostream &OS, unsigned FirstUncoveredLineNo,
unsigned IndentLevel) override;
[llvm-cov] Add the project summary to each source file coverage report. This patch includes the following changes: - Included header "Code coverage report" and include the date that the report was created. - Included title (as specified in a command line option, (i.e llvm-cov -project-title="Simple Test") - In the summary, list the elf files that the source code file has contributed to. - Used column heading for "Line No.", "Count No.", Source". Differential Revision: https://reviews.llvm.org/D23345 llvm-svn: 279628
2016-08-24 16:27:23 +02:00
[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
public:
SourceCoverageViewText(StringRef SourceName, const MemoryBuffer &File,
const CoverageViewOptions &Options,
[llvm-cov] Use less space to describe source names In r279628, we made SourceCoverageView list the binary associated with a view and started adding labels (e.g "Source: foo" or "Function: bar") to everything. Condense this information a bit to unclutter reports. llvm-svn: 280896
2016-09-08 02:56:48 +02:00
coverage::CoverageData &&CoverageInfo)
: SourceCoverageView(SourceName, File, Options, std::move(CoverageInfo)) {
}
[llvm-cov] Separate presentation logic from formatting logic, NFC This makes it easier to add renderers for new kinds of output formats. - Define and document a pure-virtual coverage rendering interface. - Move the text-based rendering logic into its a new file. - Re-work the API to better reflect the presentation/formatting split. llvm-svn: 273767
2016-06-25 04:58:30 +02:00
};
} // namespace llvm
#endif // LLVM_COV_SOURCECOVERAGEVIEWTEXT_H
Reference in New Issue Copy Permalink