CppSpec::Matchers::MatcherBase< Actual, Expected > Class Template Reference

the base class for all Matcher classes and objects More...

#include <matcher_base.hpp>

Inheritance diagram for CppSpec::Matchers::MatcherBase< Actual, Expected >:

Collaboration diagram for CppSpec::Matchers::MatcherBase< Actual, Expected >:

Public Types
using	expected_t = Expected

Public Member Functions
	MatcherBase (MatcherBase< Actual, Expected > const &copy)=default
	MatcherBase (Expectation< Actual > &expectation)
	MatcherBase (Expectation< Actual > &expectation, Expected expected)
virtual std::string	failure_message ()
	Get message to give on match failure.
virtual std::string	failure_message_when_negated ()
	Get message to give on match failure when negated.
virtual std::string	description ()
	Get the description of the Matcher.
virtual std::string	verb ()
constexpr Actual &	actual ()
Expected &	expected ()
Expectation< Actual > &	expectation ()
virtual MatcherBase &	set_message (std::string message)
	Set a custom failure message.
std::source_location	get_location () const
Result	run ()
	Run the Matcher object.
virtual bool	match ()=0
virtual bool	negated_match ()
Public Member Functions inherited from CppSpec::Pretty
std::string	name (const std::string &name) const
std::string	name_to_sentence (const std::string &name) const
template<typename O>
std::string	inspect_object (const O &o)
	Generate a string of the class and data of an object.

Protected Attributes
Expected	expected_
Expectation< Actual > &	expectation_

Additional Inherited Members
Static Public Member Functions inherited from CppSpec::Pretty
static std::string	split_words (const std::string &sym)
static std::string	underscore (const std::string &camel_cased_word)
static std::string	last (const std::string &s, char delim)
static std::string	improve_hash_formatting (const std::string &inspect_string)
template<Util::is_streamable T>
static std::string	to_word (const T &item)
	Formats an object as a string when operator<< is available.
template<typename T>
static std::string	to_word (const T &item)
template<typename T>
static std::string	to_word_type (const T &item)
template<typename A, typename E>
static std::string	to_word (const Matchers::MatcherBase< A, E > &matcher)
template<class T>
static std::string	to_sentence (const T &item)
	Take a single object and format it as a sentance.
template<class T>
static std::string	to_sentence (const std::vector< T > &words)
template<typename T>
static std::string	inspect_object (const T &object)
template<>
std::string	to_word (const bool &item)
template<>
std::string	inspect_object (const char *const &o)
	Specialization for C-style strings.
Public Attributes inherited from CppSpec::Pretty
std::string	_name

Detailed Description

template<typename Actual, typename Expected>
class CppSpec::Matchers::MatcherBase< Actual, Expected >

the base class for all Matcher classes and objects

Template Parameters

Actual	the type of Actual 'thing' to match against in the context of expect(2), it would be int
Expected	the type of Expected 'thing' to match for in the contet of expect(2).to_equal(2.0), it would be float

Member Function Documentation

description()

template<typename A, typename E>

std::string CppSpec::Matchers::MatcherBase< A, E >::description ( )

virtual

Get the description of the Matcher.

Returns

the description

Reimplemented in CppSpec::Matchers::BeBetween< A, E >, CppSpec::Matchers::BeNullptr< A >, CppSpec::Matchers::BeWithin< A, E >, CppSpec::Matchers::ContainBase< A, E, U >, CppSpec::Matchers::ContainBase< A, U, U >, CppSpec::Matchers::FailWith< A >, CppSpec::Matchers::HaveError< T >, CppSpec::Matchers::HaveValue< T >, CppSpec::Matchers::MatchPartial< A >, and CppSpec::Matchers::Throw< A, Ex >.

failure_message()

template<typename A, typename E>

std::string CppSpec::Matchers::MatcherBase< A, E >::failure_message ( )

virtual

Get message to give on match failure.

Returns

the message

Reimplemented in CppSpec::Matchers::BeWithin< A, E >, CppSpec::Matchers::ContainBase< A, E, U >, CppSpec::Matchers::ContainBase< A, U, U >, CppSpec::Matchers::Equal< A, E >, CppSpec::Matchers::Equal< T, E >, CppSpec::Matchers::Satisfy< A >, and CppSpec::Matchers::Throw< A, Ex >.

failure_message_when_negated()

template<typename A, typename E>

std::string CppSpec::Matchers::MatcherBase< A, E >::failure_message_when_negated ( )

virtual

Get message to give on match failure when negated.

Returns

the message

Reimplemented in CppSpec::Matchers::BeWithin< A, E >, CppSpec::Matchers::ContainBase< A, E, U >, CppSpec::Matchers::ContainBase< A, U, U >, CppSpec::Matchers::Equal< A, E >, CppSpec::Matchers::Equal< T, E >, CppSpec::Matchers::Satisfy< A >, and CppSpec::Matchers::Throw< A, Ex >.

run()

template<typename A, typename E>

Result CppSpec::Matchers::MatcherBase< A, E >::run

(

)

Run the Matcher object.

Parameters

printer

the formatter to print using

Returns

the Result of running the Matcher

set_message()

template<typename A, typename E>

MatcherBase< A, E > & CppSpec::Matchers::MatcherBase< A, E >::set_message ( std::string message )

virtual

Set a custom failure message.

Parameters

message

the message to give

Returns

the modified Matcher

---

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

• include/matchers/matcher_base.hpp