Changeset 18366 in vbox for trunk/include/iprt

Timestamp:

Mar 27, 2009 3:13:28 AM (16 years ago)

Author:

vboxsync

Message:

RTTest: RTTEST_CHECK, doxygen.

File:

• trunk/include/iprt/test.h (modified) (4 diffs)

trunk/include/iprt/test.h

@@ -1 +1 @@
 /** @file
- * IPRT - Test.
+ * IPRT - Testcase Framework.
  */
 
@@ -35 +35 @@
 #include <iprt/stdarg.h>
 
+__BEGIN_DECLS
+
+/** @defgroup grp_rt_test       RTTest - Testcase Framework.
+ * @ingroup grp_rt
+ * @{
+ */
+
 /** A test handle. */
 typedef struct RTTESTINT *RTTEST;
@@ -46 +53 @@
 
 
-__BEGIN_DECLS
-
-
 /**
  * Creates a test instance.
@@ -204 +208 @@
 RTR3DECL(int) RTTestFailed(RTTEST hTest, const char *pszFormat, ...);
 
+
+/** @def RTTEST_CHECK
+ * Check whether a boolean expression holds true.
+ *
+ * If the expression is false, call RTTestFailed giving the line number and expression.
+ *
+ * @param   hTest       The test handle.
+ * @param   expr        The expression to evaluate.
+ */
+#define RTTEST_CHECK(hTest, expr) \
+    do { if (!(expr)) { RTTestFailed((hTest), "line %u: %s", __LINE__, #expr); } } while (0)
+
+
+/** @}  */
+
 __END_DECLS