Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

xcontract/xcontract.h File Reference


Detailed Description

[C, C++] Main header file for the xContract library.

#include <stlsoft/stlsoft.h>
#include <new>
#include <stdexcept>

Go to the source code of this file.

Namespaces

namespace  xcontract

Defines

#define XCONTRACT_VER_MAJOR   0
 The Major version number of the xContract library.
#define XCONTRACT_VER_MINOR   3
 Minor version number of the xContract library.
#define XCONTRACT_VER_REVISION   3
 The revision number of the xContract library.
#define XCONTRACT_VER   0x000303ff
 The composite version of the xContract library.
#define XCONTRACT_ENFORCING_UNEXPECTED_CONDITION   (1)
 
Parameters:
msg The message associated with the enforcement


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
}
 The possible violation types. More...

Functions

 XCONTRACT_CALL (int) xContract_isConditionVerified(xContract_violation_type_t type
 Application-defined function that determines whether a test for a given violation type at a given level should be verified.
 XCONTRACT_CALL (void) xContract_violationReport(char const *file
 Stock reporting function, invoked when a custom function is not specified.
 XCONTRACT_CALL (char const *) xContract_getViolationTypeString(xContract_violation_type_t type)
 C-style string corresponding to the given violation type.
 XCONTRACT_CALL (size_t) xContract_getViolationTypeStringLength(xContract_violation_type_t type)
 Length of the C-style string corresponding to the given violation type.


Define Documentation

#define XCONTRACT_VER   0x000303ff

The composite version of the xContract library.

#define XCONTRACT_VER_MAJOR   0

The Major version number of the xContract library.

#define XCONTRACT_VER_MINOR   3

Minor version number of the xContract library.

#define XCONTRACT_VER_REVISION   3

The revision number of the xContract library.


b64 Library documentation © Synesis Software Pty Ltd, 2004-2007