#include <catch_test_case_tracker.h>

Inheritance diagram for Catch::TestCaseTracking::TrackerBase:

[legend]

Collaboration diagram for Catch::TestCaseTracking::TrackerBase:

[legend]

Public Member Functions
	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 ()

Protected Types
enum	CycleState { NotStarted , Executing , ExecutingChildren , NeedsAnotherRun , CompletedSuccessfully , Failed }

using	Children = std::vector<ITrackerPtr>

Protected Attributes
NameAndLocation	m_nameAndLocation

TrackerContext &	m_ctx

ITracker *	m_parent

Children	m_children

CycleState	m_runState = NotStarted

Detailed Description

Definition at line 85 of file catch_test_case_tracker.h.

Member Typedef Documentation

◆ Children

using Catch::TestCaseTracking::TrackerBase::Children = std::vector<ITrackerPtr>

protected

Definition at line 96 of file catch_test_case_tracker.h.

Member Enumeration Documentation

◆ CycleState

enum Catch::TestCaseTracking::TrackerBase::CycleState

protected

Enumerator
NotStarted
Executing
ExecutingChildren
NeedsAnotherRun
CompletedSuccessfully
Failed

Definition at line 87 of file catch_test_case_tracker.h.

                        {
            NotStarted,
            Executing,
            ExecutingChildren,
            NeedsAnotherRun,
            CompletedSuccessfully,
            Failed
        };

Constructor & Destructor Documentation

◆ TrackerBase()

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

Definition at line 67 of file catch_test_case_tracker.cpp.

    :   m_nameAndLocation( nameAndLocation ),
        m_ctx( ctx ),
        m_parent( parent )
    {}

Member Function Documentation

◆ addChild()

void Catch::TestCaseTracking::TrackerBase::addChild ( ITrackerPtr const & child )

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 90 of file catch_test_case_tracker.cpp.

                                                         {
        m_children.push_back( child );
    }

◆ close()

void Catch::TestCaseTracking::TrackerBase::close ( )

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 128 of file catch_test_case_tracker.cpp.

                            {
 
        // Close any still open children (e.g. generators)
        while( &m_ctx.currentTracker() != this )
            m_ctx.currentTracker().close();
 
        switch( m_runState ) {
            case NeedsAnotherRun:
                break;
 
            case Executing:
                m_runState = CompletedSuccessfully;
                break;
            case ExecutingChildren:
                if( m_children.empty() || m_children.back()->isComplete() )
                    m_runState = CompletedSuccessfully;
                break;
 
            case NotStarted:
            case CompletedSuccessfully:
            case Failed:
                CATCH_INTERNAL_ERROR( "Illogical state: " << m_runState );
 
            default:
                CATCH_INTERNAL_ERROR( "Unknown state: " << m_runState );
        }
        moveToParent();
        m_ctx.completeCycle();
    }

Here is the call graph for this function:

◆ fail()

void Catch::TestCaseTracking::TrackerBase::fail ( )

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 157 of file catch_test_case_tracker.cpp.

                           {
        m_runState = Failed;
        if( m_parent )
            m_parent->markAsNeedingAnotherRun();
        moveToParent();
        m_ctx.completeCycle();
    }

Here is the call graph for this function:

◆ findChild()

ITrackerPtr Catch::TestCaseTracking::TrackerBase::findChild ( NameAndLocation const & nameAndLocation )

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 94 of file catch_test_case_tracker.cpp.

                                                                               {
        auto it = std::find_if( m_children.begin(), m_children.end(),
            [&nameAndLocation]( ITrackerPtr const& tracker ){
                return
                    tracker->nameAndLocation().location == nameAndLocation.location &&
                    tracker->nameAndLocation().name == nameAndLocation.name;
            } );
        return( it != m_children.end() )
            ? *it
            : nullptr;
    }

Here is the call graph for this function:

◆ hasChildren()

bool Catch::TestCaseTracking::TrackerBase::hasChildren ( ) const

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 85 of file catch_test_case_tracker.cpp.

                                        {
        return !m_children.empty();
    }

◆ isComplete()

bool Catch::TestCaseTracking::TrackerBase::isComplete ( ) const

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 76 of file catch_test_case_tracker.cpp.

                                       {
        return m_runState == CompletedSuccessfully || m_runState == Failed;
    }

Here is the caller graph for this function:

◆ isGeneratorTracker()

bool Catch::TestCaseTracking::TrackerBase::isGeneratorTracker ( ) const

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 119 of file catch_test_case_tracker.cpp.

119{ return false; }

◆ isOpen()

bool Catch::TestCaseTracking::TrackerBase::isOpen ( ) const

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 82 of file catch_test_case_tracker.cpp.

                                   {
        return m_runState != NotStarted && !isComplete();
    }

Here is the call graph for this function:

◆ isSectionTracker()

bool Catch::TestCaseTracking::TrackerBase::isSectionTracker ( ) const

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 118 of file catch_test_case_tracker.cpp.

118{ return false; }

◆ isSuccessfullyCompleted()

bool Catch::TestCaseTracking::TrackerBase::isSuccessfullyCompleted ( ) const

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 79 of file catch_test_case_tracker.cpp.

                                                    {
        return m_runState == CompletedSuccessfully;
    }

◆ markAsNeedingAnotherRun()

void Catch::TestCaseTracking::TrackerBase::markAsNeedingAnotherRun ( )

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 164 of file catch_test_case_tracker.cpp.

                                              {
        m_runState = NeedsAnotherRun;
    }

◆ nameAndLocation()

NameAndLocation const & Catch::TestCaseTracking::TrackerBase::nameAndLocation ( ) const

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 73 of file catch_test_case_tracker.cpp.

                                                              {
        return m_nameAndLocation;
    }

Here is the caller graph for this function:

◆ open()

void Catch::TestCaseTracking::TrackerBase::open ( )

Definition at line 121 of file catch_test_case_tracker.cpp.

                           {
        m_runState = Executing;
        moveToThis();
        if( m_parent )
            m_parent->openChild();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ openChild()

void Catch::TestCaseTracking::TrackerBase::openChild ( )

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 110 of file catch_test_case_tracker.cpp.

                                {
        if( m_runState != ExecutingChildren ) {
            m_runState = ExecutingChildren;
            if( m_parent )
                m_parent->openChild();
        }
    }

Here is the call graph for this function:

◆ parent()

ITracker & Catch::TestCaseTracking::TrackerBase::parent ( )

overridevirtual

Implements Catch::TestCaseTracking::ITracker.

Definition at line 105 of file catch_test_case_tracker.cpp.

                                  {
        assert( m_parent ); // Should always be non-null except for root
        return *m_parent;
    }

Member Data Documentation

◆ m_children

Children Catch::TestCaseTracking::TrackerBase::m_children

protected

Definition at line 100 of file catch_test_case_tracker.h.

◆ m_ctx

TrackerContext& Catch::TestCaseTracking::TrackerBase::m_ctx

protected

Definition at line 98 of file catch_test_case_tracker.h.

◆ m_nameAndLocation

NameAndLocation Catch::TestCaseTracking::TrackerBase::m_nameAndLocation

protected

Definition at line 97 of file catch_test_case_tracker.h.

◆ m_parent

ITracker* Catch::TestCaseTracking::TrackerBase::m_parent

protected

Definition at line 99 of file catch_test_case_tracker.h.

◆ m_runState

CycleState Catch::TestCaseTracking::TrackerBase::m_runState = NotStarted

protected

Definition at line 101 of file catch_test_case_tracker.h.

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

libraries/sys-vm/external/Catch2/include/internal/catch_test_case_tracker.h
libraries/sys-vm/external/Catch2/include/internal/catch_test_case_tracker.cpp

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Children

Member Enumeration Documentation

◆ CycleState

Constructor & Destructor Documentation

◆ TrackerBase()

Member Function Documentation

◆ addChild()

◆ close()

◆ fail()

◆ findChild()

◆ hasChildren()

◆ isComplete()

◆ isGeneratorTracker()

◆ isOpen()

◆ isSectionTracker()

◆ isSuccessfullyCompleted()

◆ markAsNeedingAnotherRun()

◆ nameAndLocation()

◆ open()

◆ openChild()

◆ parent()

Member Data Documentation

◆ m_children

◆ m_ctx

◆ m_nameAndLocation

◆ m_parent

◆ m_runState