Imported Upstream version 2.81
[platform/upstream/libbullet.git] / Test / README.txt
1 1) Add a .cpp and .h file for your test function.  The function should conform to:
2
3     #ifdef __cplusplus
4         extern "C" {
5     #endif
6
7         #include "Utils.h"
8         #include "main.h"
9         #include "vector.h"
10
11         // Your test function
12         int MyTestFunc(void);
13
14     #ifdef __cplusplus
15         }
16     #endif
17
18     The rest of the program doesn't care or know what you do in MyTestFunc, except that MyTestFunc should return non-zero in case of failure in MyTestFunc. There are some handy functions in Utils.h that you might want to use. Please use vlog instead of printf to print stuff, and random_number32/64() in place of rand(), so I can multithread later if it comes to that.  There are some read-only globals that you may wish to respond to, declared in Utils.h:
19
20         gReportAverageTimes     if you do timing, report times as averages instead of best times if non-zero
21         gExitOnError            if non-zero, return non-zero immediately if you encounter an error
22         gAppName                        (const char*) the name of the application
23
24     As a convenience, vector.h has some cross platform vector types declared and will correctly include various vector headers according to compiler flag.
25
26
27 2) Add an entry to gTestList in TestList.cpp for your test function, so the rest of the app knows to call it
28