Catch::Generators::GeneratorTracker Struct Reference

Inheritance diagram for Catch::Generators::GeneratorTracker:

Collaboration diagram for Catch::Generators::GeneratorTracker:

Public Member Functions
	GeneratorTracker (TestCaseTracking::NameAndLocation const &nameAndLocation, TrackerContext &ctx, ITracker *parent)
	~GeneratorTracker ()
bool	isGeneratorTracker () const override
auto	hasGenerator () const -> bool override
void	close () override
auto	getGenerator () const -> GeneratorBasePtr const &override
void	setGenerator (GeneratorBasePtr &&generator) override
Public Member Functions inherited from Catch::TestCaseTracking::TrackerBase
	TrackerBase (NameAndLocation const &nameAndLocation, TrackerContext &ctx, ITracker *parent)
NameAndLocation const &	nameAndLocation () const override
bool	isComplete () const override
bool	isSuccessfullyCompleted () const override
bool	isOpen () const override
bool	hasChildren () const override
void	addChild (ITrackerPtr const &child) override
ITrackerPtr	findChild (NameAndLocation const &nameAndLocation) override
ITracker &	parent () override
void	openChild () override
bool	isSectionTracker () const override
bool	isGeneratorTracker () const override
void	open ()
void	close () override
void	fail () override
void	markAsNeedingAnotherRun () override
Public Member Functions inherited from Catch::TestCaseTracking::ITracker
virtual	~ITracker ()
Public Member Functions inherited from Catch::IGeneratorTracker
virtual	~IGeneratorTracker ()
virtual	~IGeneratorTracker ()

Static Public Member Functions
static GeneratorTracker &	acquire (TrackerContext &ctx, TestCaseTracking::NameAndLocation const &nameAndLocation)

Public Attributes
GeneratorBasePtr	m_generator

Additional Inherited Members
Protected Types inherited from Catch::TestCaseTracking::TrackerBase
enum	CycleState {   NotStarted , Executing , ExecutingChildren , NeedsAnotherRun ,   CompletedSuccessfully , Failed }
using	Children = std::vector<ITrackerPtr>
Protected Attributes inherited from Catch::TestCaseTracking::TrackerBase
NameAndLocation	m_nameAndLocation
TrackerContext &	m_ctx
ITracker *	m_parent
Children	m_children
CycleState	m_runState = NotStarted

Detailed Description

Definition at line 16 of file catch_run_context.cpp.

Constructor & Destructor Documentation

GeneratorTracker()

Catch::Generators::GeneratorTracker::GeneratorTracker ( TestCaseTracking::NameAndLocation const & nameAndLocation, TrackerContext & ctx, ITracker * parent )

inline

Definition at line 19 of file catch_run_context.cpp.

            :   TrackerBase( nameAndLocation, ctx, parent )
            {}

~GeneratorTracker()

Catch::Generators::GeneratorTracker::~GeneratorTracker

(

)

Definition at line 67 of file catch_run_context.cpp.

{}

Member Function Documentation

acquire()

static GeneratorTracker & Catch::Generators::GeneratorTracker::acquire ( TrackerContext & ctx, TestCaseTracking::NameAndLocation const & nameAndLocation )

inlinestatic

Definition at line 24 of file catch_run_context.cpp.

                                                                                                                            {
                std::shared_ptr<GeneratorTracker> tracker;
 
                ITracker& currentTracker = ctx.currentTracker();
                if( TestCaseTracking::ITrackerPtr childTracker = currentTracker.findChild( nameAndLocation ) ) {
                    assert( childTracker );
                    assert( childTracker->isGeneratorTracker() );
                    tracker = std::static_pointer_cast<GeneratorTracker>( childTracker );
                }
                else {
                    tracker = std::make_shared<GeneratorTracker>( nameAndLocation, ctx, &currentTracker );
                    currentTracker.addChild( tracker );
                }
 
                if( !ctx.completedCycle() && !tracker->isComplete() ) {
                    tracker->open();
                }
 
                return *tracker;
            }

Here is the call graph for this function:

close()

void Catch::Generators::GeneratorTracker::close ( )

inlineoverridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 50 of file catch_run_context.cpp.

                                  {
                TrackerBase::close();
                // Generator interface only finds out if it has another item on atual move
                if (m_runState == CompletedSuccessfully && m_generator->next()) {
                    m_children.clear();
                    m_runState = Executing;
                }
            }

getGenerator()

auto Catch::Generators::GeneratorTracker::getGenerator ( ) const -> GeneratorBasePtr const&

inlineoverridevirtual

Implements Catch::IGeneratorTracker.

Definition at line 60 of file catch_run_context.cpp.

                                                                          {
                return m_generator;
            }

hasGenerator()

auto Catch::Generators::GeneratorTracker::hasGenerator ( ) const -> bool

inlineoverridevirtual

Implements Catch::IGeneratorTracker.

Definition at line 47 of file catch_run_context.cpp.

                                                       {
                return !!m_generator;
            }

isGeneratorTracker()

bool Catch::Generators::GeneratorTracker::isGeneratorTracker ( ) const

inlineoverridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 46 of file catch_run_context.cpp.

{ return true; }

setGenerator()

void Catch::Generators::GeneratorTracker::setGenerator ( GeneratorBasePtr && generator )

inlineoverridevirtual

Implements Catch::IGeneratorTracker.

Definition at line 63 of file catch_run_context.cpp.

                                                                       {
                m_generator = std::move( generator );
            }

Member Data Documentation

m_generator

GeneratorBasePtr Catch::Generators::GeneratorTracker::m_generator

Definition at line 17 of file catch_run_context.cpp.

---

The documentation for this struct was generated from the following file:

• libraries/sys-vm/external/Catch2/include/internal/catch_run_context.cpp