xContract - Contract Enforcement for C and C++ STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ... Synesis Software

Application Layer


Detailed Description

Remarks:
The names of these macros are intentionally long-winded in order that they are totally unambiguous. The intention is that you will define your own, shorter, macros specific to your library/application


Defines

#define XCONTRACT_ENFORCE_UNEXPECTED_CONDITION(msg)   ((void)0)
 Expresses an unexpected condition enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_0(expr, msg)   ((void)0)
 Expresses a precondition (logic) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_1(expr, msg)   ((void)0)
 Expresses a precondition (logic) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_2(expr, msg)   ((void)0)
 Expresses a precondition (logic) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_3(expr, msg)   ((void)0)
 Expresses a precondition (logic) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_4(expr, msg)   ((void)0)
 Expresses a precondition (logic) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_0(expr, msg)   ((void)0)
 Expresses a precondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_1(expr, msg)   ((void)0)
 Expresses a precondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_2(expr, msg)   ((void)0)
 Expresses a precondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_3(expr, msg)   ((void)0)
 Expresses a precondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_4(expr, msg)   ((void)0)
 Expresses a precondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_0(expr, msg)   ((void)0)
 Expresses a postcondition (return value) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_1(expr, msg)   ((void)0)
 Expresses a postcondition (return value) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_2(expr, msg)   ((void)0)
 Expresses a postcondition (return value) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_3(expr, msg)   ((void)0)
 Expresses a postcondition (return value) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_4(expr, msg)   ((void)0)
 Expresses a postcondition (return value) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_0(expr, msg)   ((void)0)
 Expresses a postcondition (logic) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_1(expr, msg)   ((void)0)
 Expresses a postcondition (logic) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_2(expr, msg)   ((void)0)
 Expresses a postcondition (logic) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_3(expr, msg)   ((void)0)
 Expresses a postcondition (logic) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_4(expr, msg)   ((void)0)
 Expresses a postcondition (logic) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_0(expr, msg)   ((void)0)
 Expresses a postcondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_1(expr, msg)   ((void)0)
 Expresses a postcondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_2(expr, msg)   ((void)0)
 Expresses a postcondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_3(expr, msg)   ((void)0)
 Expresses a postcondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_4(expr, msg)   ((void)0)
 Expresses a postcondition (parameters) enforcement.
#define XCONTRACT_ENFORCE_CLASS_INVARIANT_0(expr, msg)   ((void)0)
 Expresses class invariant enforcement.
#define XCONTRACT_ENFORCE_CLASS_INVARIANT_1(expr, msg)   ((void)0)
 Expresses class invariant enforcement.
#define XCONTRACT_ENFORCE_CLASS_INVARIANT_2(expr, msg)   ((void)0)
 Expresses class invariant enforcement.
#define XCONTRACT_ENFORCE_CLASS_INVARIANT_3(expr, msg)   ((void)0)
 Expresses class invariant enforcement.
#define XCONTRACT_ENFORCE_CLASS_INVARIANT_4(expr, msg)   ((void)0)
 Expresses class invariant enforcement.
#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_0(expr, msg)   ((void)0)
 Expresses global invariant enforcement.
#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_1(expr, msg)   ((void)0)
 Expresses global invariant enforcement.
#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_2(expr, msg)   ((void)0)
 Expresses global invariant enforcement.
#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_3(expr, msg)   ((void)0)
 Expresses global invariant enforcement.
#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_4(expr, msg)   ((void)0)
 Expresses global invariant enforcement.
#define XCONTRACT_ENFORCE_STATIC_DATA_0(expr, msg)   ((void)0)
 Expresses static data enforcement.
#define XCONTRACT_ENFORCE_STATIC_DATA_1(expr, msg)   ((void)0)
 Expresses static data enforcement.
#define XCONTRACT_ENFORCE_STATIC_DATA_2(expr, msg)   ((void)0)
 Expresses static data enforcement.
#define XCONTRACT_ENFORCE_STATIC_DATA_3(expr, msg)   ((void)0)
 Expresses static data enforcement.
#define XCONTRACT_ENFORCE_STATIC_DATA_4(expr, msg)   ((void)0)
 Expresses static data enforcement.
#define XCONTRACT_ENFORCE_ASSUMPTION_0(expr, msg)   ((void)0)
 Expresses an intermediate assumption enforcement.
#define XCONTRACT_ENFORCE_ASSUMPTION_1(expr, msg)   ((void)0)
 Expresses an intermediate assumption enforcement.
#define XCONTRACT_ENFORCE_ASSUMPTION_2(expr, msg)   ((void)0)
 Expresses an intermediate assumption enforcement.
#define XCONTRACT_ENFORCE_ASSUMPTION_3(expr, msg)   ((void)0)
 Expresses an intermediate assumption enforcement.
#define XCONTRACT_ENFORCE_ASSUMPTION_4(expr, msg)   ((void)0)
 Expresses an intermediate assumption enforcement.


Define Documentation

#define XCONTRACT_ENFORCE_ASSUMPTION_0 ( expr,
msg   )     ((void)0)

Expresses an intermediate assumption enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_ASSUMPTION_1 ( expr,
msg   )     ((void)0)

Expresses an intermediate assumption enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_ASSUMPTION_2 ( expr,
msg   )     ((void)0)

Expresses an intermediate assumption enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_ASSUMPTION_3 ( expr,
msg   )     ((void)0)

Expresses an intermediate assumption enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_ASSUMPTION_4 ( expr,
msg   )     ((void)0)

Expresses an intermediate assumption enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_CLASS_INVARIANT_0 ( expr,
msg   )     ((void)0)

Expresses class invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_CLASS_INVARIANT_1 ( expr,
msg   )     ((void)0)

Expresses class invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement
Examples:
cpp/example.cpp.class.1/example.cpp.class.1.cpp.

#define XCONTRACT_ENFORCE_CLASS_INVARIANT_2 ( expr,
msg   )     ((void)0)

Expresses class invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_CLASS_INVARIANT_3 ( expr,
msg   )     ((void)0)

Expresses class invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_CLASS_INVARIANT_4 ( expr,
msg   )     ((void)0)

Expresses class invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_0 ( expr,
msg   )     ((void)0)

Expresses global invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_1 ( expr,
msg   )     ((void)0)

Expresses global invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_2 ( expr,
msg   )     ((void)0)

Expresses global invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_3 ( expr,
msg   )     ((void)0)

Expresses global invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_GLOBAL_INVARIANT_4 ( expr,
msg   )     ((void)0)

Expresses global invariant enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_0 ( expr,
msg   )     ((void)0)

Expresses a postcondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_1 ( expr,
msg   )     ((void)0)

Expresses a postcondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_2 ( expr,
msg   )     ((void)0)

Expresses a postcondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_3 ( expr,
msg   )     ((void)0)

Expresses a postcondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_LOGIC_4 ( expr,
msg   )     ((void)0)

Expresses a postcondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_0 ( expr,
msg   )     ((void)0)

Expresses a postcondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_1 ( expr,
msg   )     ((void)0)

Expresses a postcondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_2 ( expr,
msg   )     ((void)0)

Expresses a postcondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_3 ( expr,
msg   )     ((void)0)

Expresses a postcondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_PARAMETERS_4 ( expr,
msg   )     ((void)0)

Expresses a postcondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_0 ( expr,
msg   )     ((void)0)

Expresses a postcondition (return value) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_1 ( expr,
msg   )     ((void)0)

Expresses a postcondition (return value) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement
Examples:
cpp/example.cpp.class.1/example.cpp.class.1.cpp.

#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_2 ( expr,
msg   )     ((void)0)

Expresses a postcondition (return value) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_3 ( expr,
msg   )     ((void)0)

Expresses a postcondition (return value) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_POSTCONDITION_RETURN_4 ( expr,
msg   )     ((void)0)

Expresses a postcondition (return value) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_0 ( expr,
msg   )     ((void)0)

Expresses a precondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_1 ( expr,
msg   )     ((void)0)

Expresses a precondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_2 ( expr,
msg   )     ((void)0)

Expresses a precondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_3 ( expr,
msg   )     ((void)0)

Expresses a precondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_LOGIC_4 ( expr,
msg   )     ((void)0)

Expresses a precondition (logic) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_0 ( expr,
msg   )     ((void)0)

Expresses a precondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_1 ( expr,
msg   )     ((void)0)

Expresses a precondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement
Examples:
cpp/example.cpp.class.1/example.cpp.class.1.cpp.

#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_2 ( expr,
msg   )     ((void)0)

Expresses a precondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_3 ( expr,
msg   )     ((void)0)

Expresses a precondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_PRECONDITION_PARAMETERS_4 ( expr,
msg   )     ((void)0)

Expresses a precondition (parameters) enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_STATIC_DATA_0 ( expr,
msg   )     ((void)0)

Expresses static data enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_STATIC_DATA_1 ( expr,
msg   )     ((void)0)

Expresses static data enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_STATIC_DATA_2 ( expr,
msg   )     ((void)0)

Expresses static data enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_STATIC_DATA_3 ( expr,
msg   )     ((void)0)

Expresses static data enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_STATIC_DATA_4 ( expr,
msg   )     ((void)0)

Expresses static data enforcement.

Parameters:
expr The expression whose truth is enforced
msg The message associated with the enforcement

#define XCONTRACT_ENFORCE_UNEXPECTED_CONDITION ( msg   )     ((void)0)

Expresses an unexpected condition enforcement.

Parameters:
msg The message associated with the enforcement
Examples:
examples/c/example.c.unexpected_condition/example.c.unexpected_condition.c.


xContract Library documentation © Matthew Wilson and Synesis Software Pty Ltd, 2001-2008 SourceForge.net Logo