Horizon
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Catch::EventListenerBase Class Reference

Base class to simplify implementing listeners. More...

#include <catch_amalgamated.hpp>

Inheritance diagram for Catch::EventListenerBase:
Catch::IEventListener

Public Member Functions

void reportInvalidTestSpec (StringRef unmatchedSpec) override
 Called for all invalid test specs from the cli.
 
void fatalErrorEncountered (StringRef error) override
 Called if a fatal error (signal/structured exception) occured.
 
void benchmarkPreparing (StringRef name) override
 Called when user-code is being probed before the actual benchmark runs.
 
void benchmarkStarting (BenchmarkInfo const &benchmarkInfo) override
 Called after probe but before the user-code is being benchmarked.
 
void benchmarkEnded (BenchmarkStats<> const &benchmarkStats) override
 Called with the benchmark results if benchmark successfully finishes.
 
void benchmarkFailed (StringRef error) override
 Called if running the benchmarks fails for any reason.
 
void assertionStarting (AssertionInfo const &assertionInfo) override
 Called before assertion success/failure is evaluated.
 
void assertionEnded (AssertionStats const &assertionStats) override
 Called after assertion was fully evaluated.
 
void listReporters (std::vector< ReporterDescription > const &descriptions) override
 Writes out information about provided reporters using reporter-specific format.
 
void listListeners (std::vector< ListenerDescription > const &descriptions) override
 Writes out the provided listeners descriptions using reporter-specific format.
 
void listTests (std::vector< TestCaseHandle > const &tests) override
 Writes out information about provided tests using reporter-specific format.
 
void listTags (std::vector< TagInfo > const &tagInfos) override
 Writes out information about the provided tags using reporter-specific format.
 
void noMatchingTestCases (StringRef unmatchedSpec) override
 Called when no test cases match provided test spec.
 
void testRunStarting (TestRunInfo const &testRunInfo) override
 Called once in a testing run before tests are started.
 
void testCaseStarting (TestCaseInfo const &testInfo) override
 Called once for each TEST_CASE, no matter how many times it is entered.
 
void testCasePartialStarting (TestCaseInfo const &testInfo, uint64_t partNumber) override
 Called every time a TEST_CASE is entered, including repeats (due to sections)
 
void sectionStarting (SectionInfo const &sectionInfo) override
 Called when a SECTION is being entered. Not called for skipped sections.
 
void sectionEnded (SectionStats const &sectionStats) override
 Called after a SECTION has finished running.
 
void testCasePartialEnded (TestCaseStats const &testCaseStats, uint64_t partNumber) override
 Called every time a TEST_CASE is entered, including repeats (due to sections)
 
void testCaseEnded (TestCaseStats const &testCaseStats) override
 Called once for each TEST_CASE, no matter how many times it is entered.
 
void testRunEnded (TestRunStats const &testRunStats) override
 Called once after all tests in a testing run are finished.
 
void skipTest (TestCaseInfo const &testInfo) override
 Called with test cases that are skipped due to the test run aborting.
 
 IEventListener (IConfig const *config)
 
- Public Member Functions inherited from Catch::IEventListener
 IEventListener (IConfig const *config)
 
ReporterPreferences const & getPreferences () const
 

Additional Inherited Members

- 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.
 

Detailed Description

Base class to simplify implementing listeners.

Provides empty default implementation for all IEventListener member functions, so that a listener implementation can pick which member functions it actually cares about.

Member Function Documentation

◆ assertionEnded()

void Catch::EventListenerBase::assertionEnded ( AssertionStats const &  assertionStats)
overridevirtual

Called after assertion was fully evaluated.

Implements Catch::IEventListener.

◆ assertionStarting()

void Catch::EventListenerBase::assertionStarting ( AssertionInfo const &  assertionInfo)
overridevirtual

Called before assertion success/failure is evaluated.

Implements Catch::IEventListener.

◆ benchmarkEnded()

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

Called with the benchmark results if benchmark successfully finishes.

Implements Catch::IEventListener.

◆ benchmarkFailed()

void Catch::EventListenerBase::benchmarkFailed ( StringRef  benchmarkName)
overridevirtual

Called if running the benchmarks fails for any reason.

Implements Catch::IEventListener.

◆ benchmarkPreparing()

void Catch::EventListenerBase::benchmarkPreparing ( StringRef  benchmarkName)
overridevirtual

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

Implements Catch::IEventListener.

◆ benchmarkStarting()

void Catch::EventListenerBase::benchmarkStarting ( BenchmarkInfo const &  benchmarkInfo)
overridevirtual

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

Implements Catch::IEventListener.

◆ fatalErrorEncountered()

void Catch::EventListenerBase::fatalErrorEncountered ( StringRef  error)
overridevirtual

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

Implements Catch::IEventListener.

◆ listListeners()

void Catch::EventListenerBase::listListeners ( std::vector< ListenerDescription > const &  descriptions)
overridevirtual

Writes out the provided listeners descriptions using reporter-specific format.

Implements Catch::IEventListener.

◆ listReporters()

void Catch::EventListenerBase::listReporters ( std::vector< ReporterDescription > const &  descriptions)
overridevirtual

Writes out information about provided reporters using reporter-specific format.

Implements Catch::IEventListener.

◆ listTags()

void Catch::EventListenerBase::listTags ( std::vector< TagInfo > const &  tags)
overridevirtual

Writes out information about the provided tags using reporter-specific format.

Implements Catch::IEventListener.

◆ listTests()

void Catch::EventListenerBase::listTests ( std::vector< TestCaseHandle > const &  tests)
overridevirtual

Writes out information about provided tests using reporter-specific format.

Implements Catch::IEventListener.

◆ noMatchingTestCases()

void Catch::EventListenerBase::noMatchingTestCases ( StringRef  unmatchedSpec)
overridevirtual

Called when no test cases match provided test spec.

Implements Catch::IEventListener.

◆ reportInvalidTestSpec()

void Catch::EventListenerBase::reportInvalidTestSpec ( StringRef  invalidArgument)
overridevirtual

Called for all invalid test specs from the cli.

Implements Catch::IEventListener.

◆ sectionEnded()

void Catch::EventListenerBase::sectionEnded ( SectionStats const &  sectionStats)
overridevirtual

Called after a SECTION has finished running.

Implements Catch::IEventListener.

◆ sectionStarting()

void Catch::EventListenerBase::sectionStarting ( SectionInfo const &  sectionInfo)
overridevirtual

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

Implements Catch::IEventListener.

◆ skipTest()

void Catch::EventListenerBase::skipTest ( TestCaseInfo const &  testInfo)
overridevirtual

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

Implements Catch::IEventListener.

◆ testCaseEnded()

void Catch::EventListenerBase::testCaseEnded ( TestCaseStats const &  testCaseStats)
overridevirtual

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

Implements Catch::IEventListener.

◆ testCasePartialEnded()

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

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

Implements Catch::IEventListener.

◆ testCasePartialStarting()

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

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

Implements Catch::IEventListener.

◆ testCaseStarting()

void Catch::EventListenerBase::testCaseStarting ( TestCaseInfo const &  testInfo)
overridevirtual

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

Implements Catch::IEventListener.

◆ testRunEnded()

void Catch::EventListenerBase::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.

◆ testRunStarting()

void Catch::EventListenerBase::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.


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