Core API

---

Detailed Description

The core API functions are used by the Application Layer macros.

Functions
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.

---

Function Documentation

XCONTRACT_NORETURN void xcontract::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.

Parameters:

	file	The file in which the violation occurred
	line	The line at which the violation occurred
	expression	The expression that caused the violation
	message	The message associated with the enforcement that experienced the violation
	type	The violation type (one of xContract_violation_type_t)

XCONTRACT_NORETURN void xcontract::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.

Parameters:

	file	The file in which the violation occurred
	line	The line at which the violation occurred
	function	The function within which the violation occurred. Will be NULL for compilers that do not support the standard __FUNCTION__ symbol
	expression	The expression that caused the violation
	message	The message associated with the enforcement that experienced the violation
	qualifier	A qualifier to the message. May be NULL
	type	The violation type (one of xContract_violation_type_t)
	level	The abstraction level of the enforcement
	pfnReport	Reporting function

char const* xcontract::xContract_getViolationTypeString

(

xContract_violation_type_t

type

)

C-style string corresponding to the given violation type.

Parameters:

type

The violation type

size_t xcontract::xContract_getViolationTypeStringLength

(

xContract_violation_type_t

type

)

Length of the C-style string corresponding to the given violation type.

Parameters:

type

The violation type

void xcontract::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.

Parameters:

	file	The file in which the violation occurred
	line	The line at which the violation occurred
	function	The function within which the violation occurred. Will be NULL for compilers that do not support the standard __FUNCTION__ symbol
	expression	The expression that caused the violation
	message	The message associated with the enforcement that experienced the violation
	qualifier	A qualifier to the message. May be NULL
	type	The violation type (one of xContract_violation_type_t)
	level	The abstraction level of the enforcement

Remarks:

This function writes a detailed informative statement about the contract violation to the standard error stream, and to appropriate platform-specific outputs. On UNIX it writes to syslog(), and on Windows it writes to the system debugger (via OutputDebugString()) and to the Event Log.