#include <catch_test_case_info.h>

Inheritance diagram for Catch::TestCaseInfo:

[legend]

Collaboration diagram for Catch::TestCaseInfo:

[legend]

Public Types
enum	SpecialProperties { None = 0 , IsHidden = 1 << 1 , ShouldFail = 1 << 2 , MayFail = 1 << 3 , Throws = 1 << 4 , NonPortable = 1 << 5 , Benchmark = 1 << 6 , None = 0 , IsHidden = 1 << 1 , ShouldFail = 1 << 2 , MayFail = 1 << 3 , Throws = 1 << 4 , NonPortable = 1 << 5 , Benchmark = 1 << 6 }

enum	SpecialProperties { None = 0 , IsHidden = 1 << 1 , ShouldFail = 1 << 2 , MayFail = 1 << 3 , Throws = 1 << 4 , NonPortable = 1 << 5 , Benchmark = 1 << 6 , None = 0 , IsHidden = 1 << 1 , ShouldFail = 1 << 2 , MayFail = 1 << 3 , Throws = 1 << 4 , NonPortable = 1 << 5 , Benchmark = 1 << 6 }

Public Member Functions
	TestCaseInfo (std::string const &_name, std::string const &_className, std::string const &_description, std::vector< std::string > const &_tags, SourceLineInfo const &_lineInfo)

bool	isHidden () const

bool	throws () const

bool	okToFail () const

bool	expectedToFail () const

std::string	tagsAsString () const

	TestCaseInfo (std::string const &_name, std::string const &_className, std::string const &_description, std::vector< std::string > const &_tags, SourceLineInfo const &_lineInfo)

bool	isHidden () const

bool	throws () const

bool	okToFail () const

bool	expectedToFail () const

std::string	tagsAsString () const

Public Attributes
std::string	name

std::string	className

std::string	description

std::vector< std::string >	tags

std::vector< std::string >	lcaseTags

SourceLineInfo	lineInfo

SpecialProperties	properties

Friends
void	setTags (TestCaseInfo &testCaseInfo, std::vector< std::string > tags)

void	setTags (TestCaseInfo &testCaseInfo, std::vector< std::string > tags)

Detailed Description

Definition at line 4189 of file catch.hpp.

Member Enumeration Documentation

◆ SpecialProperties [1/2]

enum Catch::TestCaseInfo::SpecialProperties

Enumerator
None
IsHidden
ShouldFail
MayFail
Throws
NonPortable
Benchmark
None
IsHidden
ShouldFail
MayFail
Throws
NonPortable
Benchmark

Definition at line 28 of file catch_test_case_info.h.

                              {
            None = 0,
            IsHidden = 1 << 1,
            ShouldFail = 1 << 2,
            MayFail = 1 << 3,
            Throws = 1 << 4,
            NonPortable = 1 << 5,
            Benchmark = 1 << 6
        };

◆ SpecialProperties [2/2]

enum Catch::TestCaseInfo::SpecialProperties

Enumerator
None
IsHidden
ShouldFail
MayFail
Throws
NonPortable
Benchmark
None
IsHidden
ShouldFail
MayFail
Throws
NonPortable
Benchmark

Definition at line 4190 of file catch.hpp.

                              {
            None = 0,
            IsHidden = 1 << 1,
            ShouldFail = 1 << 2,
            MayFail = 1 << 3,
            Throws = 1 << 4,
            NonPortable = 1 << 5,
            Benchmark = 1 << 6
        };

Constructor & Destructor Documentation

◆ TestCaseInfo() [1/2]

Catch::TestCaseInfo::TestCaseInfo	(	std::string const &	_name,
		std::string const &	_className,
		std::string const &	_description,
		std::vector< std::string > const &	_tags,
		SourceLineInfo const &	_lineInfo )

Definition at line 113 of file catch_test_case_info.cpp.

    :   name( _name ),
        className( _className ),
        description( _description ),
        lineInfo( _lineInfo ),
        properties( None )
    {
        setTags( *this, _tags );
    }

◆ TestCaseInfo() [2/2]

Catch::TestCaseInfo::TestCaseInfo	(	std::string const &	_name,
		std::string const &	_className,
		std::string const &	_description,
		std::vector< std::string > const &	_tags,
		SourceLineInfo const &	_lineInfo )

Here is the call graph for this function:

Member Function Documentation

◆ expectedToFail() [1/2]

bool Catch::TestCaseInfo::expectedToFail ( ) const

Definition at line 136 of file catch_test_case_info.cpp.

                                            {
        return ( properties & (ShouldFail ) ) != 0;
    }

◆ expectedToFail() [2/2]

bool Catch::TestCaseInfo::expectedToFail ( ) const

◆ isHidden() [1/2]

bool Catch::TestCaseInfo::isHidden ( ) const

Definition at line 127 of file catch_test_case_info.cpp.

                                      {
        return ( properties & IsHidden ) != 0;
    }

◆ isHidden() [2/2]

bool Catch::TestCaseInfo::isHidden ( ) const

◆ okToFail() [1/2]

bool Catch::TestCaseInfo::okToFail ( ) const

Definition at line 133 of file catch_test_case_info.cpp.

                                      {
        return ( properties & (ShouldFail | MayFail ) ) != 0;
    }

Here is the caller graph for this function:

◆ okToFail() [2/2]

bool Catch::TestCaseInfo::okToFail ( ) const

◆ tagsAsString() [1/2]

std::string Catch::TestCaseInfo::tagsAsString ( ) const

Definition at line 140 of file catch_test_case_info.cpp.

                                               {
        std::string ret;
        // '[' and ']' per tag
        std::size_t full_size = 2 * tags.size();
        for (const auto& tag : tags) {
            full_size += tag.size();
        }
        ret.reserve(full_size);
        for (const auto& tag : tags) {
            ret.push_back('[');
            ret.append(tag);
            ret.push_back(']');
        }
 
        return ret;
    }

Here is the caller graph for this function:

◆ tagsAsString() [2/2]

std::string Catch::TestCaseInfo::tagsAsString ( ) const

◆ throws() [1/2]

bool Catch::TestCaseInfo::throws ( ) const

Definition at line 130 of file catch_test_case_info.cpp.

                                    {
        return ( properties & Throws ) != 0;
    }

Here is the caller graph for this function:

◆ throws() [2/2]

bool Catch::TestCaseInfo::throws ( ) const

Friends And Related Symbol Documentation

◆ setTags [1/2]

void setTags	(	TestCaseInfo &	testCaseInfo,
		std::vector< std::string >	tags )

friend

Definition at line 100 of file catch_test_case_info.cpp.

                                                                          {
        std::sort(begin(tags), end(tags));
        tags.erase(std::unique(begin(tags), end(tags)), end(tags));
        testCaseInfo.lcaseTags.clear();
 
        for( auto const& tag : tags ) {
            std::string lcaseTag = toLower( tag );
            testCaseInfo.properties = static_cast<TestCaseInfo::SpecialProperties>( testCaseInfo.properties | parseSpecialTag( lcaseTag ) );
            testCaseInfo.lcaseTags.push_back( lcaseTag );
        }
        testCaseInfo.tags = std::move(tags);
    }

◆ setTags [2/2]

void setTags	(	TestCaseInfo &	testCaseInfo,
		std::vector< std::string >	tags )

friend

Definition at line 100 of file catch_test_case_info.cpp.

                                                                          {
        std::sort(begin(tags), end(tags));
        tags.erase(std::unique(begin(tags), end(tags)), end(tags));
        testCaseInfo.lcaseTags.clear();
 
        for( auto const& tag : tags ) {
            std::string lcaseTag = toLower( tag );
            testCaseInfo.properties = static_cast<TestCaseInfo::SpecialProperties>( testCaseInfo.properties | parseSpecialTag( lcaseTag ) );
            testCaseInfo.lcaseTags.push_back( lcaseTag );
        }
        testCaseInfo.tags = std::move(tags);
    }

Member Data Documentation

◆ className

std::string Catch::TestCaseInfo::className

Definition at line 54 of file catch_test_case_info.h.

◆ description

std::string Catch::TestCaseInfo::description

Definition at line 55 of file catch_test_case_info.h.

◆ lcaseTags

std::vector< std::string > Catch::TestCaseInfo::lcaseTags

Definition at line 57 of file catch_test_case_info.h.

◆ lineInfo

SourceLineInfo Catch::TestCaseInfo::lineInfo

Definition at line 58 of file catch_test_case_info.h.

◆ name

std::string Catch::TestCaseInfo::name

Definition at line 53 of file catch_test_case_info.h.

◆ properties

SpecialProperties Catch::TestCaseInfo::properties

Definition at line 59 of file catch_test_case_info.h.

◆ tags

std::vector< std::string > Catch::TestCaseInfo::tags

Definition at line 56 of file catch_test_case_info.h.

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

libraries/sys-vm/external/Catch2/include/internal/catch_test_case_info.h
libraries/sys-vm/external/Catch2/single_include/catch2/catch.hpp
libraries/sys-vm/external/Catch2/include/internal/catch_test_case_info.cpp

Public Types

Public Member Functions

Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ SpecialProperties [1/2]

◆ SpecialProperties [2/2]

Constructor & Destructor Documentation

◆ TestCaseInfo() [1/2]

◆ TestCaseInfo() [2/2]

Member Function Documentation

◆ expectedToFail() [1/2]

◆ expectedToFail() [2/2]

◆ isHidden() [1/2]

◆ isHidden() [2/2]

◆ okToFail() [1/2]

◆ okToFail() [2/2]

◆ tagsAsString() [1/2]

◆ tagsAsString() [2/2]

◆ throws() [1/2]

◆ throws() [2/2]

Friends And Related Symbol Documentation

◆ setTags [1/2]

◆ setTags [2/2]

Member Data Documentation

◆ className

◆ description

◆ lcaseTags

◆ lineInfo

◆ name

◆ properties

◆ tags