Fix documentation.
[bertos.git] / bertos / cfg / test.h
index 507ec17e8a9c22bc628e31629365e8a5e7263226..048ff57b8855b3de2192f10f90e0399ec5869474 100644 (file)
  * All of these should return 0 if ok or a value != 0 on errors.
  *
  * Then, at the end of your module_test you can write:
- * #include TEST_ONLY(whatuneed.h)
- * #include TEST_ONLY(whatuneed.c)
- * #include TEST_ONLY(...)
+ * \code
+ * #if UNIT_TEST
+ *     #include <whatuneed.h>
+ *     #include <whatuneed.c>
+ *     #include <...>
  *
- * TEST_MAIN(module);
+ *     TEST_MAIN(module);
+ * #endif
+ * \endcode
  *
- * The macro TEST_ONLY expand to nothing in non-TEST mode or to
- * the specified filename if _TEST is defined.
  * Including directly into your module the file.c you need to
  * run the test allows you to build and run the test compiling
  * only one file.
 #ifndef CFG_TEST_H
 #define CFG_TEST_H
 
-#ifdef _TEST
+#include "cfg/cfg_arch.h"
 
-       /**
-        * Macro used to generate a main() for a test to be compiled
-        * on hosted platform.
-        */
-       #define TEST_MAIN(module) \
-       int main(void) \
-       { \
-               if (module##_testSetup() != 0) \
-                       return 1; \
-               if (module##_testRun() != 0) \
-                       return 2; \
-               if (module##_testTearDown() != 0) \
-                       return 3; \
-               return 0; \
-       }
+#if defined(ARCH_UNITTEST) && (ARCH & ARCH_UNITTEST)
+       #define UNIT_TEST 1
+#else /* !TEST */
+       #define UNIT_TEST 0
+#endif /* TEST */
 
-       /** This macro will include the specified file only in test-mode */
-       #define TEST_ONLY(file) PP_STRINGIZE(file)
-
-#else /* !_TEST */
-
-       #define TEST_MAIN(module)  /* nothing */
-       #define TEST_ONLY(file)    <cfg/nothing.h>
-
-#endif /* _TEST */
+/**
+ * Macro used to generate a main() for a test to be compiled
+ * on hosted platform.
+ */
+#define TEST_MAIN(module) \
+int main(void) \
+{ \
+       if (module##_testSetup() != 0) \
+               return 1; \
+       if (module##_testRun() != 0) \
+               return 2; \
+       if (module##_testTearDown() != 0) \
+               return 3; \
+       return 0; \
+}
 
 /**
  * Silent an assert in a test.