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

Test Functions


Detailed Description

Functions that are used to exercise tests.


Defines

#define XTESTS_TEST_FAIL_WITH_QUALIFIER(msg, qualifier)
 Causes a test failure to be expressed, passing an explanatory message and a message qualifier.
#define XTESTS_TEST_FAIL(msg)
 Causes a test failure to be expressed, passing an explanatory message.
#define XTESTS_TEST_PASSED()
 Causes a test success to be expressed.
#define XTESTS_TEST_WITH_MESSAGE(expr, msg)
 Causes a test to be exercised, passing an explanatory message to be used in the case of failure.
#define XTESTS_TEST(expr)
 Causes a test to be exercised.
#define XTESTS_TEST_ENUM_EQUAL(expected, actual)   XTESTS_TEST_INTEGER_EQUAL_EXACT(stlsoft_static_cast(int, (expected)), stlsoft_static_cast(int, (actual)))
 Tests that two enumerator values are exactly equal.
#define XTESTS_TEST_ENUM_NOT_EQUAL(expected, actual)   XTESTS_TEST_INTEGER_NOT_EQUAL(stlsoft_static_cast(int, (expected)), stlsoft_static_cast(int, (actual)))
 Tests that two enumerator values are not equal.
#define XTESTS_TEST_INTEGER_EQUAL_EXACT(expected, actual)
 Tests that two integer values are exactly equal.
#define XTESTS_TEST_INTEGER_NOT_EQUAL(expected, actual)
 Tests that two integer values are not equal.
#define XTESTS_TEST_INTEGER_GREATER(expected, actual)
 Tests that the actual integer value is greater than the expected value.
#define XTESTS_TEST_INTEGER_LESS(expected, actual)
 Tests that the actual integer value is less than the expected value.
#define XTESTS_TEST_INTEGER_GREATER_OR_EQUAL(expected, actual)
 Tests that the actual integer value is greater than or equal to the expected value.
#define XTESTS_TEST_INTEGER_LESS_OR_EQUAL(expected, actual)
 Tests that the actual integer value is less than or equal to the expected value.
#define XTESTS_TEST_BOOLEAN_EQUAL(expected, actual)
 Tests that two boolean values are exactly equal.
#define XTESTS_TEST_BOOLEAN_NOT_EQUAL(expected, actual)
 Tests that two boolean values are not equal.
#define XTESTS_TEST_BOOLEAN_TRUE(actual)
 Tests that an expression is true.
#define XTESTS_TEST_BOOLEAN_FALSE(actual)
 Tests that an expression is false.
#define XTESTS_TEST_CHARACTER_EQUAL_EXACT(expected, actual)
 Tests that two character values are exactly equal.
#define XTESTS_TEST_CHARACTER_NOT_EQUAL(expected, actual)
 Tests that two character values are not equal.
#define XTESTS_TEST_CHARACTER_GREATER(expected, actual)
 Tests that the actual character value is greater than the expected value.
#define XTESTS_TEST_CHARACTER_LESS(expected, actual)
 Tests that the actual character value is less than the expected value.
#define XTESTS_TEST_CHARACTER_GREATER_OR_EQUAL(expected, actual)
 Tests that the actual character value is greater than or equal to the expected value.
#define XTESTS_TEST_CHARACTER_LESS_OR_EQUAL(expected, actual)
 Tests that the actual character value is less than or equal to the expected value.
#define XTESTS_TEST_FLOATINGPOINT_EQUAL_EXACT(expected, actual)
 Tests that two floating point values are exactly equal.
#define XTESTS_TEST_FLOATINGPOINT_EQUAL_APPROX(expected, actual)
 Tests that two floating point values are approximately equal (as defined by XTESTS_FP_APPROXIMATE_FACTOR).
#define XTESTS_TEST_INTEGER_EQUAL(expected, actual)   XTESTS_TEST_INTEGER_EQUAL_EXACT(expected, actual)
 Tests that two integer values (of the same type) are equal.
#define XTESTS_TEST_FLOATINGPOINT_EQUAL(expected, actual)   XTESTS_TEST_FLOATINGPOINT_EQUAL_APPROX(expected, actual)
 Tests that two floating point values (of the same type) are equal.
#define XTESTS_TEST_CHARACTER_EQUAL(expected, actual)   XTESTS_TEST_CHARACTER_EQUAL_EXACT(expected, actual)
 Tests that two character values (of the same type) are equal.
#define XTESTS_TEST_MULTIBYTE_STRING_EQUAL(expected, actual)
 Tests that two (multibyte) strings are equal.
#define XTESTS_TEST_MULTIBYTE_STRING_EQUAL_APPROX(expected, actual)
 Tests that two (multibyte) strings are approximately equal (by ignoring case).
#define XTESTS_TEST_MULTIBYTE_STRING_NOT_EQUAL(expected, actual)
 Tests that two (multibyte) strings are not equal.
#define XTESTS_TEST_MULTIBYTE_STRING_NOT_EQUAL_APPROX(expected, actual)
 Tests that two (multibyte) strings are not equal (when ignoring case).
#define XTESTS_TEST_MULTIBYTE_STRING_EQUAL_N(expected, actual, n)
 Tests that two (multibyte) strings are equal up to a given limit.
#define XTESTS_TEST_MULTIBYTE_STRING_EQUAL_N_APPROX(expected, actual, n)
 Tests that two (multibyte) strings are approximately equal (by ignoring case), up to a given limit.
#define XTESTS_TEST_MULTIBYTE_STRING_NOT_EQUAL_N(expected, actual, n)
 Tests that two (multibyte) strings are not equal.
#define XTESTS_TEST_MULTIBYTE_STRING_NOT_EQUAL_N_APPROX(expected, actual, n)
 Tests that two (multibyte) strings are not equal (when ignoring case).
#define XTESTS_TEST_WIDE_STRING_EQUAL(expected, actual)
 Tests that two (wide) strings are equal.
#define XTESTS_TEST_WIDE_STRING_EQUAL_APPROX(expected, actual)
 Tests that two (wide) strings are approximately equal (by ignoring case).
#define XTESTS_TEST_WIDE_STRING_NOT_EQUAL(expected, actual)
 Tests that two (wide) strings are not equal.
#define XTESTS_TEST_WIDE_STRING_NOT_EQUAL_APPROX(expected, actual)
 Tests that two (wide) strings are not equal (when ignoring case).
#define XTESTS_TEST_WIDE_STRING_EQUAL_N(expected, actual, n)
 Tests that two (wide) strings are equal up to a given limit.
#define XTESTS_TEST_WIDE_STRING_EQUAL_N_APPROX(expected, actual, n)
 Tests that two (wide) strings are approximately equal (by ignoring case), up to a given limit.
#define XTESTS_TEST_WIDE_STRING_NOT_EQUAL_N(expected, actual, n)
 Tests that two (wide) strings are not equal.
#define XTESTS_TEST_WIDE_STRING_NOT_EQUAL_N_APPROX(expected, actual, n)
 Tests that two (wide) strings are not equal (when ignoring case).
#define XTESTS_TEST_MULTIBYTE_STRING_CONTAIN(expected, actual)
 Tests that the string contains the expected sub-sequence.
#define XTESTS_TEST_MULTIBYTE_STRING_CONTAIN_APPROX(expected, actual)
 Tests that the string contains the expected sub-sequence (disregarding case).
#define XTESTS_TEST_MULTIBYTE_STRING_NOT_CONTAIN(expected, actual)
 Tests that the string does not contain the expected sub-sequence.
#define XTESTS_TEST_MULTIBYTE_STRING_NOT_CONTAIN_APPROX(expected, actual)
 Tests that the string does not contain the expected sub-sequence (disregarding case).
#define XTESTS_TEST_WIDE_STRING_CONTAIN(expected, actual)
 Tests that the string contains the expected sub-sequence.
#define XTESTS_TEST_WIDE_STRING_CONTAIN_APPROX(expected, actual)
 Tests that the string contains the expected sub-sequence (disregarding case).
#define XTESTS_TEST_WIDE_STRING_NOT_CONTAIN(expected, actual)
 Tests that the string does not contain the expected sub-sequence.
#define XTESTS_TEST_WIDE_STRING_NOT_CONTAIN_APPROX(expected, actual)
 Tests that the string does not contain the expected sub-sequence.
#define XTESTS_TEST_POINTER_EQUAL(expected, actual)
 Tests that two pointers are equal.
#define XTESTS_TEST_POINTER_NOT_EQUAL(expected, actual)
 Tests that two pointer values are not equal.
#define XTESTS_TEST_POINTER_GREATER(expected, actual)
 Tests that the actual pointer value is greater than the expected value.
#define XTESTS_TEST_POINTER_LESS(expected, actual)
 Tests that the actual pointer value is less than the expected value.
#define XTESTS_TEST_POINTER_GREATER_OR_EQUAL(expected, actual)
 Tests that the actual pointer value is greater than or equal to the expected value.
#define XTESTS_TEST_POINTER_LESS_OR_EQUAL(expected, actual)
 Tests that the actual pointer value is less than or equal to the expected value.


Define Documentation

#define XTESTS_TEST ( expr   ) 

Value:

\
    XTESTS_TEST_WITH_MESSAGE(expr, #expr)
Causes a test to be exercised.

Parameters:
expr The expression whose truth is to be evaluated
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_BOOLEAN_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual)))
Tests that two boolean values are exactly equal.

Parameters:
expected The expected boolean value
actual The actual boolean value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_BOOLEAN_FALSE ( actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", false, (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual)))
Tests that an expression is false.

Parameters:
actual The boolean expression that is expected to be false
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_BOOLEAN_NOT_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonNotEqual)))
Tests that two boolean values are not equal.

Parameters:
expected The expected boolean value
actual The actual boolean value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_BOOLEAN_TRUE ( actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", true, (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual)))
Tests that an expression is true.

Parameters:
actual The boolean expression that is expected to be true
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_CHARACTER_EQUAL ( expected,
actual   )     XTESTS_TEST_CHARACTER_EQUAL_EXACT(expected, actual)

Tests that two character values (of the same type) are equal.

Parameters:
expected The expected character value
actual The actual character value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_CHARACTER_EQUAL_EXACT ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_character(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual)))
Tests that two character values are exactly equal.

Parameters:
expected The expected character value
actual The actual character value
Remarks:
The characters should be of the same type
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_CHARACTER_GREATER ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_character(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonGreaterThan)))
Tests that the actual character value is greater than the expected value.

Parameters:
expected The expected character value
actual The actual character value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_CHARACTER_GREATER_OR_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_character(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonGreaterThanOrEqual)))
Tests that the actual character value is greater than or equal to the expected value.

Parameters:
expected The expected character value
actual The actual character value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_CHARACTER_LESS ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_character(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonLessThan)))
Tests that the actual character value is less than the expected value.

Parameters:
expected The expected character value
actual The actual character value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_CHARACTER_LESS_OR_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_character(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonLessThanOrEqual)))
Tests that the actual character value is less than or equal to the expected value.

Parameters:
expected The expected character value
actual The actual character value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_CHARACTER_NOT_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_character(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonNotEqual)))
Tests that two character values are not equal.

Parameters:
expected The expected character value
actual The actual character value
Remarks:
The characters should be of the same type
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_ENUM_EQUAL ( expected,
actual   )     XTESTS_TEST_INTEGER_EQUAL_EXACT(stlsoft_static_cast(int, (expected)), stlsoft_static_cast(int, (actual)))

Tests that two enumerator values are exactly equal.

Parameters:
expected The expected enumerator value
actual The actual enumerator value
Remarks:
The enumerators should be of the same type
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_ENUM_NOT_EQUAL ( expected,
actual   )     XTESTS_TEST_INTEGER_NOT_EQUAL(stlsoft_static_cast(int, (expected)), stlsoft_static_cast(int, (actual)))

Tests that two enumerator values are not equal.

Parameters:
expected The expected enumerator value
actual The actual enumerator value
Remarks:
The enumerators should be of the same type
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_FAIL ( msg   ) 

Value:

\
    XTESTS_TEST_FAIL_WITH_QUALIFIER(msg, stlsoft_static_cast(char const*, NULL))
Causes a test failure to be expressed, passing an explanatory message.

Parameters:
msg The message explaining the failure condition
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_FAIL_WITH_QUALIFIER ( msg,
qualifier   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_writeFailMessage)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), msg, qualifier)
Causes a test failure to be expressed, passing an explanatory message and a message qualifier.

Parameters:
msg The message explaining the failure condition
qualifier The message qualifier.
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_FLOATINGPOINT_EQUAL ( expected,
actual   )     XTESTS_TEST_FLOATINGPOINT_EQUAL_APPROX(expected, actual)

Tests that two floating point values (of the same type) are equal.

Parameters:
expected The expected floating point value
actual The actual floating point value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_FLOATINGPOINT_EQUAL_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_floating_point(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxEqual)))
Tests that two floating point values are approximately equal (as defined by XTESTS_FP_APPROXIMATE_FACTOR).

Parameters:
expected The expected floating point value
actual The actual floating point value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_FLOATINGPOINT_EQUAL_EXACT ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_floating_point(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual)))
Tests that two floating point values are exactly equal.

Parameters:
expected The expected floating point value
actual The actual floating point value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_INTEGER_EQUAL ( expected,
actual   )     XTESTS_TEST_INTEGER_EQUAL_EXACT(expected, actual)

Tests that two integer values (of the same type) are equal.

Parameters:
expected The expected integer value
actual The actual integer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().
Examples:
c/example.c.tests/example.c.tests.c.

#define XTESTS_TEST_INTEGER_EQUAL_EXACT ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual)))
Tests that two integer values are exactly equal.

Parameters:
expected The expected integer value
actual The actual integer value
Remarks:
The integers should be of the same type
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().
Examples:
c/example.c.runner/example.c.runner.c, and c/example.c.tests/example.c.tests.c.

#define XTESTS_TEST_INTEGER_GREATER ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonGreaterThan)))
Tests that the actual integer value is greater than the expected value.

Parameters:
expected The expected integer value
actual The actual integer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().
Examples:
c/example.c.tests/example.c.tests.c.

#define XTESTS_TEST_INTEGER_GREATER_OR_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonGreaterThanOrEqual)))
Tests that the actual integer value is greater than or equal to the expected value.

Parameters:
expected The expected integer value
actual The actual integer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().
Examples:
c/example.c.tests/example.c.tests.c.

#define XTESTS_TEST_INTEGER_LESS ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonLessThan)))
Tests that the actual integer value is less than the expected value.

Parameters:
expected The expected integer value
actual The actual integer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().
Examples:
c/example.c.tests/example.c.tests.c.

#define XTESTS_TEST_INTEGER_LESS_OR_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonLessThanOrEqual)))
Tests that the actual integer value is less than or equal to the expected value.

Parameters:
expected The expected integer value
actual The actual integer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().
Examples:
c/example.c.runner/example.c.runner.c, and c/example.c.tests/example.c.tests.c.

#define XTESTS_TEST_INTEGER_NOT_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_CPP_QUAL(xtests_test_integer(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonNotEqual)))
Tests that two integer values are not equal.

Parameters:
expected The expected integer value
actual The actual integer value
Remarks:
The integers should be of the same type
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().
Examples:
c/example.c.tests/example.c.tests.c.

#define XTESTS_TEST_MULTIBYTE_STRING_CONTAIN ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStringContains)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual))
Tests that the string contains the expected sub-sequence.

Parameters:
expected The substring to find with the actual string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_CONTAIN_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStringContains)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxEqual))
Tests that the string contains the expected sub-sequence (disregarding case).

Parameters:
expected The substring to find with the actual string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStrings)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual))
Tests that two (multibyte) strings are equal.

Parameters:
expected The expected value of the string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_EQUAL_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStrings)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxEqual))
Tests that two (multibyte) strings are approximately equal (by ignoring case).

Parameters:
expected The expected value of the string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_EQUAL_N ( expected,
actual,
 ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStringsN)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), n, XTESTS_NS_C_QUAL(xtestsComparisonEqual))
Tests that two (multibyte) strings are equal up to a given limit.

Parameters:
expected The expected value of the string
actual The actual value of the string
n The maximum number of characters to compare
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_EQUAL_N_APPROX ( expected,
actual,
 ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStringsN)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), n, XTESTS_NS_C_QUAL(xtestsComparisonApproxEqual))
Tests that two (multibyte) strings are approximately equal (by ignoring case), up to a given limit.

Parameters:
expected The expected value of the string
actual The actual value of the string
n The maximum number of characters to compare
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_NOT_CONTAIN ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStringContains)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonNotEqual))
Tests that the string does not contain the expected sub-sequence.

Parameters:
expected The substring to find with the actual string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_NOT_CONTAIN_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStringContains)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxNotEqual))
Tests that the string does not contain the expected sub-sequence (disregarding case).

Parameters:
expected The substring to find with the actual string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_NOT_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStrings)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonNotEqual))
Tests that two (multibyte) strings are not equal.

Parameters:
expected The expected value of the string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_NOT_EQUAL_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStrings)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxNotEqual))
Tests that two (multibyte) strings are not equal (when ignoring case).

Parameters:
expected The expected value of the string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_NOT_EQUAL_N ( expected,
actual,
 ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStringsN)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), n, XTESTS_NS_C_QUAL(xtestsComparisonNotEqual))
Tests that two (multibyte) strings are not equal.

Parameters:
expected The expected value of the string
actual The actual value of the string
n The maximum number of characters to compare
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_MULTIBYTE_STRING_NOT_EQUAL_N_APPROX ( expected,
actual,
 ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testMultibyteStringsN)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), n, XTESTS_NS_C_QUAL(xtestsComparisonApproxNotEqual))
Tests that two (multibyte) strings are not equal (when ignoring case).

Parameters:
expected The expected value of the string
actual The actual value of the string
n The maximum number of characters to compare
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

 
#define XTESTS_TEST_PASSED (  ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testPassed)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "")
Causes a test success to be expressed.

Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().
Examples:
c/example.c.runner/example.c.runner.c, and c/example.c.tests/example.c.tests.c.

#define XTESTS_TEST_POINTER_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testPointers)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual))
Tests that two pointers are equal.

Parameters:
expected The expected value of the pointer
actual The actual value of the pointer
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_POINTER_GREATER ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testPointers)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonGreaterThan))
Tests that the actual pointer value is greater than the expected value.

Parameters:
expected The expected pointer value
actual The actual pointer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_POINTER_GREATER_OR_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testPointers)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonGreaterThanOrEqual))
Tests that the actual pointer value is greater than or equal to the expected value.

Parameters:
expected The expected pointer value
actual The actual pointer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_POINTER_LESS ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testPointers)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonLessThan))
Tests that the actual pointer value is less than the expected value.

Parameters:
expected The expected pointer value
actual The actual pointer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_POINTER_LESS_OR_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testPointers)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonLessThanOrEqual))
Tests that the actual pointer value is less than or equal to the expected value.

Parameters:
expected The expected pointer value
actual The actual pointer value
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_POINTER_NOT_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testPointers)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonNotEqual))
Tests that two pointer values are not equal.

Parameters:
expected The expected pointer value
actual The actual pointer value
Remarks:
The pointers should be of the same type
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_CONTAIN ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStringContains)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual))
Tests that the string contains the expected sub-sequence.

Parameters:
expected The substring to find with the actual string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_CONTAIN_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStringContains)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxEqual))
Tests that the string contains the expected sub-sequence (disregarding case).

Parameters:
expected The substring to find with the actual string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStrings)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonEqual))
Tests that two (wide) strings are equal.

Parameters:
expected The expected value of the string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_EQUAL_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStrings)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxEqual))
Tests that two (wide) strings are approximately equal (by ignoring case).

Parameters:
expected The expected value of the string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_EQUAL_N ( expected,
actual,
 ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStringsN)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), n, XTESTS_NS_C_QUAL(xtestsComparisonEqual))
Tests that two (wide) strings are equal up to a given limit.

Parameters:
expected The expected value of the string
actual The actual value of the string
n The maximum number of characters to compare
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_EQUAL_N_APPROX ( expected,
actual,
 ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStringsN)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), n, XTESTS_NS_C_QUAL(xtestsComparisonApproxEqual))
Tests that two (wide) strings are approximately equal (by ignoring case), up to a given limit.

Parameters:
expected The expected value of the string
actual The actual value of the string
n The maximum number of characters to compare
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_NOT_CONTAIN ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStringContains)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonNotEqual))
Tests that the string does not contain the expected sub-sequence.

Parameters:
expected The substring to find with the actual string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_NOT_CONTAIN_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStringContains)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxNotEqual))
Tests that the string does not contain the expected sub-sequence.

Parameters:
expected The substring to find with the actual string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_NOT_EQUAL ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStrings)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonNotEqual))
Tests that two (wide) strings are not equal.

Parameters:
expected The expected value of the string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_NOT_EQUAL_APPROX ( expected,
actual   ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStrings)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), XTESTS_NS_C_QUAL(xtestsComparisonApproxNotEqual))
Tests that two (wide) strings are not equal (when ignoring case).

Parameters:
expected The expected value of the string
actual The actual value of the string
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_NOT_EQUAL_N ( expected,
actual,
 ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStringsN)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), n, XTESTS_NS_C_QUAL(xtestsComparisonNotEqual))
Tests that two (wide) strings are not equal.

Parameters:
expected The expected value of the string
actual The actual value of the string
n The maximum number of characters to compare
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WIDE_STRING_NOT_EQUAL_N_APPROX ( expected,
actual,
 ) 

Value:

\
    XTESTS_NS_C_QUAL(xtests_testWideStringsN)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), "", (expected), (actual), n, XTESTS_NS_C_QUAL(xtestsComparisonApproxNotEqual))
Tests that two (wide) strings are not equal (when ignoring case).

Parameters:
expected The expected value of the string
actual The actual value of the string
n The maximum number of characters to compare
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().

#define XTESTS_TEST_WITH_MESSAGE ( expr,
msg   ) 

Value:

\
    ((expr)                                                                             \
        ? XTESTS_NS_C_QUAL(xtests_testPassed)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), msg)   \
        : XTESTS_NS_C_QUAL(xtests_testFailed)(__FILE__, __LINE__, XTESTS_GET_FUNCTION_(), msg))
Causes a test to be exercised, passing an explanatory message to be used in the case of failure.

Parameters:
expr The expression whose truth is to be evaluated
msg The message explaining the failure condition
Note:
This can only be invoked after a successful invocation of XTESTS_CASE_BEGIN() and before invocation of XTESTS_CASE_END().


xTests Library documentation Matthew Wilson and Synesis Software Pty Ltd, 1999-2009 SourceForge.net Logo