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

Core API


Detailed Description

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


Functions

 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.


Function Documentation

xcontract::XCONTRACT_CALL ( size_t   ) 

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

Parameters:
type The violation type

xcontract::XCONTRACT_CALL ( char const *   ) 

C-style string corresponding to the given violation type.

Parameters:
type The violation type

XCONTRACT_NORETURN XCONTRACT_CALL ( void   )  const

Stock reporting function, invoked when a custom function is not specified.

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


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