Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

CUnit.h File Reference


Detailed Description

Basic CUnit include file for user and system code.

Defines macros for assertions for use in user test cases. Basic system macro definitions also appear here.

#include <string.h>
#include <math.h>
#include "CUError.h"
#include "TestDB.h"
#include "TestRun.h"

Go to the source code of this file.

Defines

#define MAX_TEST_NAME_LENGTH   256
 Maximum length of a test name string.
#define MAX_SUITE_NAME_LENGTH   256
 Maximim length of a suite name string.
#define BOOL   int
 Boolean type for CUnit use.
#define TRUE   1
 Boolean TRUE for CUnit use.
#define FALSE   0
 Boolean FALSE for CUnit use.
#define CU_UNREFERENCED_PARAMETER(x)   (void)x
 Consistent approach to referencing unused parameters.
#define CU_PASS(msg)   { CU_assertImplementation(TRUE, __LINE__, ("CU_PASS(" #msg ")"), __FILE__, "", FALSE); }
 Record a pass condition without performing a logical test.
#define CU_ASSERT(value)   { CU_assertImplementation((value), __LINE__, #value, __FILE__, "", FALSE); }
 Simple assertion.
#define CU_ASSERT_FATAL(value)   { CU_assertImplementation((value), __LINE__, #value, __FILE__, "", TRUE); }
 Simple assertion.
#define CU_TEST(value)   { CU_assertImplementation((value), __LINE__, #value, __FILE__, "", FALSE); }
 Simple assertion.
#define CU_TEST_FATAL(value)   { CU_assertImplementation((value), __LINE__, #value, __FILE__, "", TRUE); }
 Simple assertion.
#define CU_FAIL(msg)   { CU_assertImplementation(FALSE, __LINE__, ("CU_FAIL(" #msg ")"), __FILE__, "", FALSE); }
 Record a failure without performing a logical test.
#define CU_FAIL_FATAL(msg)   { CU_assertImplementation(FALSE, __LINE__, ("CU_FAIL_FATAL(" #msg ")"), __FILE__, "", TRUE); }
 Record a failure without performing a logical test, and abort test.
#define CU_ASSERT_TRUE(value)   { CU_assertImplementation((value), __LINE__, ("CU_ASSERT_TRUE(" #value ")"), __FILE__, "", FALSE); }
 Asserts that value is TRUE.
#define CU_ASSERT_TRUE_FATAL(value)   { CU_assertImplementation((value), __LINE__, ("CU_ASSERT_TRUE_FATAL(" #value ")"), __FILE__, "", TRUE); }
 Asserts that value is TRUE.
#define CU_ASSERT_FALSE(value)   { CU_assertImplementation(!(value), __LINE__, ("CU_ASSERT_FALSE(" #value ")"), __FILE__, "", FALSE); }
 Asserts that value is FALSE.
#define CU_ASSERT_FALSE_FATAL(value)   { CU_assertImplementation(!(value), __LINE__, ("CU_ASSERT_FALSE_FATAL(" #value ")"), __FILE__, "", TRUE); }
 Asserts that value is FALSE.
#define CU_ASSERT_EQUAL(actual, expected)   { CU_assertImplementation(((actual) == (expected)), __LINE__, ("CU_ASSERT_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); }
 Asserts that actual == expected.
#define CU_ASSERT_EQUAL_FATAL(actual, expected)   { CU_assertImplementation(((actual) == (expected)), __LINE__, ("CU_ASSERT_EQUAL_FATAL(" #actual "," #expected ")"), __FILE__, "", TRUE); }
 Asserts that actual == expected.
#define CU_ASSERT_NOT_EQUAL(actual, expected)   { CU_assertImplementation(((actual) != (expected)), __LINE__, ("CU_ASSERT_NOT_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); }
 Asserts that actual != expected.
#define CU_ASSERT_NOT_EQUAL_FATAL(actual, expected)   { CU_assertImplementation(((actual) != (expected)), __LINE__, ("CU_ASSERT_NOT_EQUAL_FATAL(" #actual "," #expected ")"), __FILE__, "", TRUE); }
 Asserts that actual != expected.
#define CU_ASSERT_PTR_EQUAL(actual, expected)   { CU_assertImplementation(((void*)(actual) == (void*)(expected)), __LINE__, ("CU_ASSERT_PTR_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); }
 Asserts that pointers actual == expected.
#define CU_ASSERT_PTR_EQUAL_FATAL(actual, expected)   { CU_assertImplementation(((void*)(actual) == (void*)(expected)), __LINE__, ("CU_ASSERT_PTR_EQUAL_FATAL(" #actual "," #expected ")"), __FILE__, "", TRUE); }
 Asserts that pointers actual == expected.
#define CU_ASSERT_PTR_NOT_EQUAL(actual, expected)   { CU_assertImplementation(((void*)(actual) != (void*)(expected)), __LINE__, ("CU_ASSERT_PTR_NOT_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); }
 Asserts that pointers actual != expected.
#define CU_ASSERT_PTR_NOT_EQUAL_FATAL(actual, expected)   { CU_assertImplementation(((void*)(actual) != (void*)(expected)), __LINE__, ("CU_ASSERT_PTR_NOT_EQUAL_FATAL(" #actual "," #expected ")"), __FILE__, "", TRUE); }
 Asserts that pointers actual != expected.
#define CU_ASSERT_PTR_NULL(value)   { CU_assertImplementation((NULL == (void*)(value)), __LINE__, ("CU_ASSERT_PTR_NULL(" #value")"), __FILE__, "", FALSE); }
 Asserts that pointer value is NULL.
#define CU_ASSERT_PTR_NULL_FATAL(value)   { CU_assertImplementation((NULL == (void*)(value)), __LINE__, ("CU_ASSERT_PTR_NULL_FATAL(" #value")"), __FILE__, "", TRUE); }
 Asserts that pointer value is NULL.
#define CU_ASSERT_PTR_NOT_NULL(value)   { CU_assertImplementation((NULL != (void*)(value)), __LINE__, ("CU_ASSERT_PTR_NOT_NULL(" #value")"), __FILE__, "", FALSE); }
 Asserts that pointer value is not NULL.
#define CU_ASSERT_PTR_NOT_NULL_FATAL(value)   { CU_assertImplementation((NULL != (void*)(value)), __LINE__, ("CU_ASSERT_PTR_NOT_NULL_FATAL(" #value")"), __FILE__, "", TRUE); }
 Asserts that pointer value is not NULL.
#define CU_ASSERT_STRING_EQUAL(actual, expected)   { CU_assertImplementation(!(strcmp((const char*)(actual), (const char*)(expected))), __LINE__, ("CU_ASSERT_STRING_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); }
 Asserts that string actual == expected.
#define CU_ASSERT_STRING_EQUAL_FATAL(actual, expected)   { CU_assertImplementation(!(strcmp((const char*)(actual), (const char*)(expected))), __LINE__, ("CU_ASSERT_STRING_EQUAL_FATAL(" #actual "," #expected ")"), __FILE__, "", TRUE); }
 Asserts that string actual == expected.
#define CU_ASSERT_STRING_NOT_EQUAL(actual, expected)   { CU_assertImplementation((strcmp((const char*)(actual), (const char*)(expected))), __LINE__, ("CU_ASSERT_STRING_NOT_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); }
 Asserts that string actual != expected.
#define CU_ASSERT_STRING_NOT_EQUAL_FATAL(actual, expected)   { CU_assertImplementation((strcmp((const char*)(actual), (const char*)(expected))), __LINE__, ("CU_ASSERT_STRING_NOT_EQUAL_FATAL(" #actual "," #expected ")"), __FILE__, "", TRUE); }
 Asserts that string actual != expected.
#define CU_ASSERT_NSTRING_EQUAL(actual, expected, count)   { CU_assertImplementation(!(strncmp((const char*)(actual), (const char*)(expected), (size_t)(count))), __LINE__, ("CU_ASSERT_NSTRING_EQUAL(" #actual "," #expected "," #count ")"), __FILE__, "", FALSE); }
 Asserts that string actual == expected with length specified.
#define CU_ASSERT_NSTRING_EQUAL_FATAL(actual, expected, count)   { CU_assertImplementation(!(strncmp((const char*)(actual), (const char*)(expected), (size_t)(count))), __LINE__, ("CU_ASSERT_NSTRING_EQUAL_FATAL(" #actual "," #expected "," #count ")"), __FILE__, "", TRUE); }
 Asserts that string actual == expected with length specified.
#define CU_ASSERT_NSTRING_NOT_EQUAL(actual, expected, count)   { CU_assertImplementation((strncmp((const char*)(actual), (const char*)(expected), (size_t)(count))), __LINE__, ("CU_ASSERT_NSTRING_NOT_EQUAL(" #actual "," #expected "," #count ")"), __FILE__, "", FALSE); }
 Asserts that string actual != expected with length specified.
#define CU_ASSERT_NSTRING_NOT_EQUAL_FATAL(actual, expected, count)   { CU_assertImplementation((strncmp((const char*)(actual), (const char*)(expected), (size_t)(count))), __LINE__, ("CU_ASSERT_NSTRING_NOT_EQUAL_FATAL(" #actual "," #expected "," #count ")"), __FILE__, "", TRUE); }
 Asserts that string actual != expected with length specified.
#define CU_ASSERT_DOUBLE_EQUAL(actual, expected, granularity)   { CU_assertImplementation(((fabs((double)(actual) - (expected)) <= fabs((double)(granularity)))), __LINE__, ("CU_ASSERT_DOUBLE_EQUAL(" #actual "," #expected "," #granularity ")"), __FILE__, "", FALSE); }
 Asserts that double actual == expected within the specified tolerance.
#define CU_ASSERT_DOUBLE_EQUAL_FATAL(actual, expected, granularity)   { CU_assertImplementation(((fabs((double)(actual) - (expected)) <= fabs((double)(granularity)))), __LINE__, ("CU_ASSERT_DOUBLE_EQUAL_FATAL(" #actual "," #expected "," #granularity ")"), __FILE__, "", TRUE); }
 Asserts that double actual == expected within the specified tolerance.
#define CU_ASSERT_DOUBLE_NOT_EQUAL(actual, expected, granularity)   { CU_assertImplementation(((fabs((double)(actual) - (expected)) > fabs((double)(granularity)))), __LINE__, ("CU_ASSERT_DOUBLE_NOT_EQUAL(" #actual "," #expected "," #granularity ")"), __FILE__, "", FALSE); }
 Asserts that double actual != expected within the specified tolerance.
#define CU_ASSERT_DOUBLE_NOT_EQUAL_FATAL(actual, expected, granularity)   { CU_assertImplementation(((fabs((double)(actual) - (expected)) > fabs((double)(granularity)))), __LINE__, ("CU_ASSERT_DOUBLE_NOT_EQUAL_FATAL(" #actual "," #expected "," #granularity ")"), __FILE__, "", TRUE); }
 Asserts that double actual != expected within the specified tolerance.
#define ASSERT(value)   { if (FALSE == (int)(value)) { CU_assertImplementation((BOOL)value, __LINE__, #value, __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_TRUE(value)   { if (FALSE == (value)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_TRUE(" #value ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_FALSE(value)   { if (FALSE != (value)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_FALSE(" #value ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_EQUAL(actual, expected)   { if ((actual) != (expected)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_NOT_EQUAL(actual, expected)   { if ((void*)(actual) == (void*)(expected)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_NOT_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_PTR_EQUAL(actual, expected)   { if ((void*)(actual) != (void*)(expected)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_PTR_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_PTR_NOT_EQUAL(actual, expected)   { if ((void*)(actual) == (void*)(expected)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_PTR_NOT_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_PTR_NULL(value)   { if (NULL != (void*)(value)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_PTR_NULL(" #value")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_PTR_NOT_NULL(value)   { if (NULL == (void*)(value)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_PTR_NOT_NULL(" #value")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_STRING_EQUAL(actual, expected)   { if (strcmp((const char*)actual, (const char*)expected)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_STRING_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_STRING_NOT_EQUAL(actual, expected)   { if (!strcmp((const char*)actual, (const char*)expected)) { CU_assertImplementation(TRUE, __LINE__, ("ASSERT_STRING_NOT_EQUAL(" #actual "," #expected ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_NSTRING_EQUAL(actual, expected, count)   { if (strncmp((const char*)actual, (const char*)expected, (size_t)count)) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_NSTRING_EQUAL(" #actual "," #expected "," #count ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_NSTRING_NOT_EQUAL(actual, expected, count)   { if (!strncmp((const char*)actual, (const char*)expected, (size_t)count)) { CU_assertImplementation(TRUE, __LINE__, ("ASSERT_NSTRING_NOT_EQUAL(" #actual "," #expected "," #count ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_DOUBLE_EQUAL(actual, expected, granularity)   { if ((fabs((double)actual - expected) > fabs((double)granularity))) { CU_assertImplementation(FALSE, __LINE__, ("ASSERT_DOUBLE_EQUAL(" #actual "," #expected "," #granularity ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).
#define ASSERT_DOUBLE_NOT_EQUAL(actual, expected, granularity)   { if ((fabs((double)actual - expected) <= fabs((double)granularity))) { CU_assertImplementation(TRUE, __LINE__, ("ASSERT_DOUBLE_NOT_EQUAL(" #actual "," #expected "," #granularity ")"), __FILE__, "", FALSE); return; }}
 Deprecated (version 1).


Generated on Thu Apr 28 12:36:09 2005 for CUnit by  doxygen 1.3.9.1