cpp::AssertExpression Class Reference

Implements a siplasplas assertion. More...

#include <siplasplas/utility/assert.hpp>

Public Member Functions
	AssertExpression (bool expressionResult, const std::string &message, const std::string &file, std::size_t line)
	Initializes an assertion expression. More...
	~AssertExpression () noexcept(false)
	Assertion destructor. More...
AssertExpression &	onFailure (const std::function< void()> &callback)
	Specifies an action to execute when the assertion fails. More...
template<typename String , typename... Args>
AssertExpression &	detail (String &&messageBody, Args &&...messageArgs)
	Adds detailed information to the assertion report. More...
template<typename String , typename... Args>
AssertExpression &	operator() (String &&messageBody, Args &&...args)
	Adds detailed information to the assertion report. Equivalent to detail().

Detailed Description

Implements a siplasplas assertion.

Siplasplas implements assertions as instances of AssertExpression class. An assert expression object takes the result (true or false) of the assertion, its source location (file, line) and a detailed message. The assertion is evaluated during the destruction of the assertion object. If the assertion failed (i.e. the value of the result was false) the AssertExpression destructor throws an AssertException exception.

Constructor & Destructor Documentation

cpp::AssertExpression::AssertExpression	(	bool	expressionResult,
		const std::string &	message,
		const std::string &	file,
		std::size_t	line
	)

Initializes an assertion expression.

Parameters

expressionResult	Result of the assertion expression evaluation. True if the assertion passed, false if the assertion failed.
message	Asseertion error message.
file	Line where the assertion is defined.
line	File where the assertion is defined.

cpp::AssertExpression::~AssertExpression ( )

noexcept

Assertion destructor.

The assertion result value is checked in the destructor body. If the result was true the assertion is considered passed and the program continues. If the result is false, the onFailure() callback is called (if any) and then an AssertExpression is thrown with detailed information about the assertion failure (Assertion message, location, etc). The assertion stack trace is logged to the error log (See cpp::exception()).

Member Function Documentation

template<typename String , typename... Args>

AssertExpression& cpp::AssertExpression::detail ( String &&  messageBody, Args &&...  messageArgs  )

inline

Adds detailed information to the assertion report.

Parameters

messageBody	Detail message string
messageArgs	Detail message arguments. The body may contain placeholders to fill with this values (See fmt::format()).

Returns

A reference to *this to implement the assertion expression fluent interface.

AssertExpression& cpp::AssertExpression::onFailure

(

const std::function< void()> &

callback

)

Specifies an action to execute when the assertion fails.

This function allows to install a callback on the assertion so an special action can be taken when the assertion fails. The callback is unique, i.e. two consecutive calls to onFailure() overwrite the assigned callback.

Parameters

callback

Function to execute when the assertion fails.

Returns

Reference to the assertion expresion (*this). Implements a fluent interface on the assertion expression.

static std::size_t failures = 0;

int sqrt(int n)
{
     SIPLASPLAS_ASSERT_BT(n, 0).onFailure([&]
     {
         // Increment the global failures count
         // if the assertion fails.
         failures++;
     });

     return 1 / finvsqrt(n);
}

Returns

A reference to *this to implement the assertion expression fluent interface.

---

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

• include/siplasplas/utility/assert.hpp