xcontract Namespace Reference

---

Detailed Description

The xContract namespace.

All types and functions are defined within this namespace in C++

Typedefs
typedef enum xContract_violation_type_t	violation_type_t
	Alias for xContract_violation_type_t.
typedef void(XCONTRACT_CALLCONV *	xContract_violationReport_fn_t )(char const *file, unsigned line, char const *function, char const *expression, char const *message, char const *qualifier, xContract_violation_type_t type, int level)
	Reporting function prototype.
typedef xContract_violationReport_fn_t	violationReport_fn_t
	Alias for xContract_violationReport_fn_t.
Enumerations
enum	xContract_violation_type_t {   xContract_unexpectedCondition,   xContract_precondition_logic,   xContract_precondition_parameters,   xContract_postcondition_returnValue,   xContract_postcondition_logic,   xContract_postcondition_parameters,   xContract_invariant_class,   xContract_invariant_global,   xContract_staticData,   xContract_intermediateAssumption,   xContract_maximum_value }
	The possible violation types. More...
Functions
int	xContract_isConditionVerified (xContract_violation_type_t type, int level, char const *file, unsigned line, char const *function, char const *expression)
	Application-defined function that determines whether a test for a given violation type at a given level should be verified.
void	xContract_violationReport (char const *file, unsigned line, char const *function, char const *expression, char const *message, char const *qualifier, xContract_violation_type_t type, int level)
	Stock reporting function, invoked when a custom function is not specified.
XCONTRACT_NORETURN void	xContract_contract_violation (char const *file, unsigned line, char const *expression, char const *message, xContract_violation_type_t type)
	Invoked to report and respond to a contract violation.
XCONTRACT_NORETURN void	xContract_contract_violation2 (char const *file, unsigned line, char const *function, char const *expression, char const *message, char const *qualifier, xContract_violation_type_t type, int level, xContract_violationReport_fn_t pfnReport)
	Invoked to report and respond to a contract violation.
char const *	xContract_getViolationTypeString (xContract_violation_type_t type)
	C-style string corresponding to the given violation type.
size_t	xContract_getViolationTypeStringLength (xContract_violation_type_t type)
	Length of the C-style string corresponding to the given violation type.

---

Typedef Documentation

typedef xContract_violation_type_t violation_type_t

Alias for xContract_violation_type_t.

typedef xContract_violationReport_fn_t violationReport_fn_t

Alias for xContract_violationReport_fn_t.

typedef void(XCONTRACT_CALLCONV * xContract_violationReport_fn_t)(char const *file, unsigned line, char const *function, char const *expression, char const *message, char const *qualifier, xContract_violation_type_t type, int level)

Reporting function prototype.

---

Enumeration Type Documentation

enum xContract_violation_type_t

The possible violation types.

See also:

xContract_getViolationTypeString, xContract_getViolationTypeStringLength

Enumerator:

xContract_unexpectedCondition	Indicates an unexpected condition
xContract_precondition_logic	Indicates a precondition logic violation
xContract_precondition_parameters	Indicates a precondition parameter violation
xContract_postcondition_returnValue	Indicates a postcondition return-value violation
xContract_postcondition_logic	Indicates a postcondition logic violation
xContract_postcondition_parameters	Indicates a postcondition parameter violation
xContract_invariant_class	Indicates a class invariant violation
xContract_invariant_global	Indicates a global invariant violation
xContract_staticData	Indicates that static data is in violatation
xContract_intermediateAssumption	Indicates an immediate assumption violatation