Inheritance diagram for Catch::StreamingReporterBase:

Public Member Functions
void	benchmarkPreparing (StringRef) override
	Called when user-code is being probed before the actual benchmark runs. More...

void	benchmarkStarting (BenchmarkInfo const &) override
	Called after probe but before the user-code is being benchmarked. More...

void	benchmarkEnded (BenchmarkStats<> const &) override
	Called with the benchmark results if benchmark successfully finishes. More...

void	benchmarkFailed (StringRef) override
	Called if running the benchmarks fails for any reason. More...

void	fatalErrorEncountered (StringRef) override
	Called if a fatal error (signal/structured exception) occured. More...

void	noMatchingTestCases (StringRef) override
	Called when no test cases match provided test spec. More...

void	reportInvalidTestSpec (StringRef) override
	Called for all invalid test specs from the cli. More...

void	testRunStarting (TestRunInfo const &_testRunInfo) override
	Called once in a testing run before tests are started. More...

void	testCaseStarting (TestCaseInfo const &_testInfo) override
	Called once for each TEST_CASE, no matter how many times it is entered. More...

void	testCasePartialStarting (TestCaseInfo const &, uint64_t) override
	Called every time a TEST_CASE is entered, including repeats (due to sections) More...

void	sectionStarting (SectionInfo const &_sectionInfo) override
	Called when a `SECTION` is being entered. Not called for skipped sections. More...

void	assertionStarting (AssertionInfo const &) override
	Called before assertion success/failure is evaluated. More...

void	assertionEnded (AssertionStats const &) override
	Called after assertion was fully evaluated. More...

void	sectionEnded (SectionStats const &) override
	Called after a `SECTION` has finished running. More...

void	testCasePartialEnded (TestCaseStats const &, uint64_t) override
	Called every time a TEST_CASE is entered, including repeats (due to sections) More...

void	testCaseEnded (TestCaseStats const &) override
	Called once for each TEST_CASE, no matter how many times it is entered. More...

void	testRunEnded (TestRunStats const &) override
	Called once after all tests in a testing run are finished. More...

void	skipTest (TestCaseInfo const &) override
	Called with test cases that are skipped due to the test run aborting. More...

	ReporterBase (ReporterConfig &&config)

Public Member Functions inherited from Catch::ReporterBase
	ReporterBase (ReporterConfig &&config)

void	listReporters (std::vector< ReporterDescription > const &descriptions) override
	Provides a simple default listing of reporters. More...

void	listListeners (std::vector< ListenerDescription > const &descriptions) override
	Provides a simple default listing of listeners. More...

void	listTests (std::vector< TestCaseHandle > const &tests) override
	Provides a simple default listing of tests. More...

void	listTags (std::vector< TagInfo > const &tags) override
	Provides a simple default listing of tags. More...

Public Member Functions inherited from Catch::IEventListener
	IEventListener (IConfig const *config)

ReporterPreferences const &	getPreferences () const

virtual void	noMatchingTestCases (StringRef unmatchedSpec)=0
	Called when no test cases match provided test spec. More...

virtual void	reportInvalidTestSpec (StringRef invalidArgument)=0
	Called for all invalid test specs from the cli. More...

virtual void	testRunStarting (TestRunInfo const &testRunInfo)=0
	Called once in a testing run before tests are started. More...

virtual void	testCaseStarting (TestCaseInfo const &testInfo)=0
	Called once for each TEST_CASE, no matter how many times it is entered. More...

virtual void	testCasePartialStarting (TestCaseInfo const &testInfo, uint64_t partNumber)=0
	Called every time a TEST_CASE is entered, including repeats (due to sections) More...

virtual void	sectionStarting (SectionInfo const &sectionInfo)=0
	Called when a `SECTION` is being entered. Not called for skipped sections. More...

virtual void	benchmarkPreparing (StringRef benchmarkName)=0
	Called when user-code is being probed before the actual benchmark runs. More...

virtual void	benchmarkStarting (BenchmarkInfo const &benchmarkInfo)=0
	Called after probe but before the user-code is being benchmarked. More...

virtual void	benchmarkEnded (BenchmarkStats<> const &benchmarkStats)=0
	Called with the benchmark results if benchmark successfully finishes. More...

virtual void	benchmarkFailed (StringRef benchmarkName)=0
	Called if running the benchmarks fails for any reason. More...

virtual void	assertionStarting (AssertionInfo const &assertionInfo)=0
	Called before assertion success/failure is evaluated. More...

virtual void	assertionEnded (AssertionStats const &assertionStats)=0
	Called after assertion was fully evaluated. More...

virtual void	sectionEnded (SectionStats const &sectionStats)=0
	Called after a `SECTION` has finished running. More...

virtual void	testCasePartialEnded (TestCaseStats const &testCaseStats, uint64_t partNumber)=0
	Called every time a TEST_CASE is entered, including repeats (due to sections) More...

virtual void	testCaseEnded (TestCaseStats const &testCaseStats)=0
	Called once for each TEST_CASE, no matter how many times it is entered. More...

virtual void	testRunEnded (TestRunStats const &testRunStats)=0
	Called once after all tests in a testing run are finished. More...

virtual void	skipTest (TestCaseInfo const &testInfo)=0
	Called with test cases that are skipped due to the test run aborting. More...

virtual void	fatalErrorEncountered (StringRef error)=0
	Called if a fatal error (signal/structured exception) occured. More...

virtual void	listReporters (std::vector< ReporterDescription > const &descriptions)=0
	Writes out information about provided reporters using reporter-specific format. More...

virtual void	listListeners (std::vector< ListenerDescription > const &descriptions)=0
	Writes out the provided listeners descriptions using reporter-specific format. More...

virtual void	listTests (std::vector< TestCaseHandle > const &tests)=0
	Writes out information about provided tests using reporter-specific format. More...

virtual void	listTags (std::vector< TagInfo > const &tags)=0
	Writes out information about the provided tags using reporter-specific format. More...

Protected Attributes
TestRunInfo	currentTestRunInfo { "test run has not started yet"_sr }

TestCaseInfo const *	currentTestCaseInfo = nullptr

std::vector< SectionInfo >	m_sectionStack
	Stack of all active sections in the current test case.

Protected Attributes inherited from Catch::ReporterBase
Detail::unique_ptr< IStream >	m_wrapped_stream
	The stream wrapper as passed to us by outside code.

std::ostream &	m_stream
	Cached output stream from `m_wrapped_stream` to reduce number of indirect calls needed to write output.

Detail::unique_ptr< ColourImpl >	m_colour
	Colour implementation this reporter was configured for.

std::map< std::string, std::string >	m_customOptions
	The custom reporter options user passed down to the reporter.

Protected Attributes inherited from Catch::IEventListener
ReporterPreferences	m_preferences
	Derived classes can set up their preferences here.

IConfig const *	m_config
	The test run's config as filled in from CLI and defaults.

Member Function Documentation

◆ assertionEnded()

void Catch::StreamingReporterBase::assertionEnded ( AssertionStats const & assertionStats )

inlineoverridevirtual

Called after assertion was fully evaluated.

Implements Catch::IEventListener.

Reimplemented in Catch::CompactReporter, Catch::ConsoleReporter, Catch::TAPReporter, Catch::TeamCityReporter, and Catch::XmlReporter.

◆ assertionStarting()

void Catch::StreamingReporterBase::assertionStarting ( AssertionInfo const & assertionInfo )

inlineoverridevirtual

Called before assertion success/failure is evaluated.

Implements Catch::IEventListener.

Reimplemented in Catch::ConsoleReporter, and Catch::XmlReporter.

◆ benchmarkEnded()

void Catch::StreamingReporterBase::benchmarkEnded ( BenchmarkStats<> const & benchmarkStats )

inlineoverridevirtual

Called with the benchmark results if benchmark successfully finishes.

Implements Catch::IEventListener.

Reimplemented in Catch::XmlReporter, and Catch::ConsoleReporter.

◆ benchmarkFailed()

void Catch::StreamingReporterBase::benchmarkFailed ( StringRef benchmarkName )

inlineoverridevirtual

Called if running the benchmarks fails for any reason.

Implements Catch::IEventListener.

Reimplemented in Catch::ConsoleReporter, and Catch::XmlReporter.

◆ benchmarkPreparing()

void Catch::StreamingReporterBase::benchmarkPreparing ( StringRef benchmarkName )

inlineoverridevirtual

Called when user-code is being probed before the actual benchmark runs.

Implements Catch::IEventListener.

Reimplemented in Catch::ConsoleReporter, and Catch::XmlReporter.

◆ benchmarkStarting()

void Catch::StreamingReporterBase::benchmarkStarting ( BenchmarkInfo const & benchmarkInfo )

inlineoverridevirtual

Called after probe but before the user-code is being benchmarked.

Implements Catch::IEventListener.

Reimplemented in Catch::XmlReporter, and Catch::ConsoleReporter.

◆ fatalErrorEncountered()

void Catch::StreamingReporterBase::fatalErrorEncountered ( StringRef error )

inlineoverridevirtual

Called if a fatal error (signal/structured exception) occured.

Implements Catch::IEventListener.

◆ noMatchingTestCases()

void Catch::StreamingReporterBase::noMatchingTestCases ( StringRef unmatchedSpec )

inlineoverridevirtual

Called when no test cases match provided test spec.

Implements Catch::IEventListener.

Reimplemented in Catch::CompactReporter, Catch::ConsoleReporter, and Catch::TAPReporter.

◆ reportInvalidTestSpec()

void Catch::StreamingReporterBase::reportInvalidTestSpec ( StringRef invalidArgument )

inlineoverridevirtual

Called for all invalid test specs from the cli.

Implements Catch::IEventListener.

Reimplemented in Catch::ConsoleReporter.

◆ sectionEnded()

void Catch::StreamingReporterBase::sectionEnded ( SectionStats const & sectionStats )

inlineoverridevirtual

Called after a SECTION has finished running.

Implements Catch::IEventListener.

Reimplemented in Catch::CompactReporter, Catch::ConsoleReporter, and Catch::XmlReporter.

◆ sectionStarting()

void Catch::StreamingReporterBase::sectionStarting ( SectionInfo const & sectionInfo )

inlineoverridevirtual

Called when a SECTION is being entered. Not called for skipped sections.

Implements Catch::IEventListener.

Reimplemented in Catch::ConsoleReporter, Catch::TeamCityReporter, and Catch::XmlReporter.

◆ skipTest()

void Catch::StreamingReporterBase::skipTest ( TestCaseInfo const & testInfo )

inlineoverridevirtual

Called with test cases that are skipped due to the test run aborting.

Implements Catch::IEventListener.

Reimplemented in Catch::AutomakeReporter.

◆ testCaseEnded()

void Catch::StreamingReporterBase::testCaseEnded ( TestCaseStats const & testCaseStats )

inlineoverridevirtual

Called once for each TEST_CASE, no matter how many times it is entered.

Implements Catch::IEventListener.

Reimplemented in Catch::AutomakeReporter, Catch::ConsoleReporter, Catch::TeamCityReporter, and Catch::XmlReporter.

◆ testCasePartialEnded()

void Catch::StreamingReporterBase::testCasePartialEnded	(	TestCaseStats const &	testCaseStats,
		uint64_t	partNumber
	)

inlineoverridevirtual

Called every time a TEST_CASE is entered, including repeats (due to sections)

Implements Catch::IEventListener.

◆ testCasePartialStarting()

void Catch::StreamingReporterBase::testCasePartialStarting	(	TestCaseInfo const &	testInfo,
		uint64_t	partNumber
	)

inlineoverridevirtual

Called every time a TEST_CASE is entered, including repeats (due to sections)

Implements Catch::IEventListener.

◆ testCaseStarting()

void Catch::StreamingReporterBase::testCaseStarting ( TestCaseInfo const & testInfo )

inlineoverridevirtual

Called once for each TEST_CASE, no matter how many times it is entered.

Implements Catch::IEventListener.

Reimplemented in Catch::TeamCityReporter, and Catch::XmlReporter.

◆ testRunEnded()

void Catch::StreamingReporterBase::testRunEnded ( TestRunStats const & testRunStats )

overridevirtual

Called once after all tests in a testing run are finished.

Not called if tests weren't run (e.g. only listings happened)

Implements Catch::IEventListener.

Reimplemented in Catch::CompactReporter, Catch::ConsoleReporter, Catch::TAPReporter, Catch::TeamCityReporter, and Catch::XmlReporter.

◆ testRunStarting()

void Catch::StreamingReporterBase::testRunStarting ( TestRunInfo const & testRunInfo )

overridevirtual

Called once in a testing run before tests are started.

Not called if tests won't be run (e.g. only listing will happen)

Implements Catch::IEventListener.

Reimplemented in Catch::CompactReporter, Catch::ConsoleReporter, Catch::TeamCityReporter, Catch::TAPReporter, and Catch::XmlReporter.

The documentation for this class was generated from the following files:

3rd_party/catch2/catch_amalgamated.hpp
3rd_party/catch2/catch_amalgamated.cpp

Public Member Functions

Protected Attributes

Member Function Documentation

◆ assertionEnded()

◆ assertionStarting()

◆ benchmarkEnded()

◆ benchmarkFailed()

◆ benchmarkPreparing()

◆ benchmarkStarting()

◆ fatalErrorEncountered()

◆ noMatchingTestCases()

◆ reportInvalidTestSpec()

◆ sectionEnded()

◆ sectionStarting()

◆ skipTest()

◆ testCaseEnded()

◆ testCasePartialEnded()

◆ testCasePartialStarting()

◆ testCaseStarting()

◆ testRunEnded()

◆ testRunStarting()