Another updated wine header to fix some synched winetest's build process.
[reactos.git] / reactos / include / reactos / wine / test.h
index 6e42cb3..8c07c7d 100644 (file)
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-#ifndef __WINE_TEST_H
-#define __WINE_TEST_H
+#ifndef __WINE_WINE_TEST_H
+#define __WINE_WINE_TEST_H
 
 #include <stdarg.h>
-#include "windows.h"
-
-/* prototype for dbgprint */
-ULONG CDECL DbgPrint(IN PCH  Format,IN ...);
+#include <stdlib.h>
+#include <windef.h>
+#include <winbase.h>
+
+#ifdef __WINE_CONFIG_H
+#error config.h should not be used in Wine tests
+#endif
+#ifdef __WINE_WINE_LIBRARY_H
+#error wine/library.h should not be used in Wine tests
+#endif
+#ifdef __WINE_WINE_UNICODE_H
+#error wine/unicode.h should not be used in Wine tests
+#endif
+#ifdef __WINE_WINE_DEBUG_H
+#error wine/debug.h should not be used in Wine tests
+#endif
+
+#ifndef INVALID_FILE_ATTRIBUTES
+#define INVALID_FILE_ATTRIBUTES  (~0u)
+#endif
+#ifndef INVALID_SET_FILE_POINTER
+#define INVALID_SET_FILE_POINTER (~0u)
+#endif
 
 /* debug level */
 extern int winetest_debug;
@@ -41,26 +60,65 @@ extern void winetest_start_todo( const char* platform );
 extern int winetest_loop_todo(void);
 extern void winetest_end_todo( const char* platform );
 extern int winetest_get_mainargs( char*** pargv );
+extern void winetest_wait_child_process( HANDLE process );
+
+extern const char *wine_dbgstr_wn( const WCHAR *str, int n );
+static inline const char *wine_dbgstr_w( const WCHAR *s ) { return wine_dbgstr_wn( s, -1 ); }
 
+/* strcmpW is avaiable for tests compiled under Wine, but not in standalone
+ * builds under Windows, so we reimplement it under a different name. */
+static inline int winetest_strcmpW( const WCHAR *str1, const WCHAR *str2 )
+{
+    while (*str1 && (*str1 == *str2)) { str1++; str2++; }
+    return *str1 - *str2;
+}
+
+#ifdef STANDALONE
+#define START_TEST(name) \
+  static void func_##name(void); \
+  const struct test winetest_testlist[] = { { #name, func_##name }, { 0, 0 } }; \
+  static void func_##name(void)
+#else
 #define START_TEST(name) void func_##name(void)
+#endif
+
+#if defined(__x86_64__) && defined(__GNUC__) && defined(__WINE_USE_MSVCRT)
+#define __winetest_cdecl __cdecl
+#define __winetest_va_list __builtin_ms_va_list
+#else
+#define __winetest_cdecl
+#define __winetest_va_list va_list
+#endif
+
+extern int broken( int condition );
+extern int winetest_vok( int condition, const char *msg, __winetest_va_list ap );
+extern void winetest_vskip( const char *msg, __winetest_va_list ap );
 
 #ifdef __GNUC__
 
-extern int winetest_ok( int condition, const char *msg, ... ) __attribute__((format (printf,2,3) ));
-extern void winetest_trace( const char *msg, ... ) __attribute__((format (printf,1,2)));
+extern void __winetest_cdecl winetest_ok( int condition, const char *msg, ... ) __attribute__((format (printf,2,3) ));
+extern void __winetest_cdecl winetest_skip( const char *msg, ... ) __attribute__((format (printf,1,2)));
+extern void __winetest_cdecl winetest_win_skip( const char *msg, ... ) __attribute__((format (printf,1,2)));
+extern void __winetest_cdecl winetest_trace( const char *msg, ... ) __attribute__((format (printf,1,2)));
 
 #else /* __GNUC__ */
 
-extern int winetest_ok( int condition, const char *msg, ... );
-extern void winetest_trace( const char *msg, ... );
+extern void __winetest_cdecl winetest_ok( int condition, const char *msg, ... );
+extern void __winetest_cdecl winetest_skip( const char *msg, ... );
+extern void __winetest_cdecl winetest_win_skip( const char *msg, ... );
+extern void __winetest_cdecl winetest_trace( const char *msg, ... );
 
 #endif /* __GNUC__ */
 
-#define ok_(file, line)     (winetest_set_location(file, line), 0) ? 0 : winetest_ok
-#define trace_(file, line)  (winetest_set_location(file, line), 0) ? (void)0 : winetest_trace
+#define ok_(file, line)       (winetest_set_location(file, line), 0) ? (void)0 : winetest_ok
+#define skip_(file, line)     (winetest_set_location(file, line), 0) ? (void)0 : winetest_skip
+#define win_skip_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_win_skip
+#define trace_(file, line)    (winetest_set_location(file, line), 0) ? (void)0 : winetest_trace
 
-#define ok     ok_(__FILE__, __LINE__)
-#define trace  trace_(__FILE__, __LINE__)
+#define ok       ok_(__FILE__, __LINE__)
+#define skip     skip_(__FILE__, __LINE__)
+#define win_skip win_skip_(__FILE__, __LINE__)
+#define trace    trace_(__FILE__, __LINE__)
 
 #define todo(platform) for (winetest_start_todo(platform); \
                             winetest_loop_todo(); \
@@ -68,6 +126,45 @@ extern void winetest_trace( const char *msg, ... );
 #define todo_wine      todo("wine")
 
 
+#ifdef NONAMELESSUNION
+# define U(x)  (x).u
+# define U1(x) (x).u1
+# define U2(x) (x).u2
+# define U3(x) (x).u3
+# define U4(x) (x).u4
+# define U5(x) (x).u5
+# define U6(x) (x).u6
+# define U7(x) (x).u7
+# define U8(x) (x).u8
+#else
+# define U(x)  (x)
+# define U1(x) (x)
+# define U2(x) (x)
+# define U3(x) (x)
+# define U4(x) (x)
+# define U5(x) (x)
+# define U6(x) (x)
+# define U7(x) (x)
+# define U8(x) (x)
+#endif
+
+#ifdef NONAMELESSSTRUCT
+# define S(x)  (x).s
+# define S1(x) (x).s1
+# define S2(x) (x).s2
+# define S3(x) (x).s3
+# define S4(x) (x).s4
+# define S5(x) (x).s5
+#else
+# define S(x)  (x)
+# define S1(x) (x)
+# define S2(x) (x)
+# define S3(x) (x)
+# define S4(x) (x)
+# define S5(x) (x)
+#endif
+
+
 /************************************************************************/
 /* Below is the implementation of the various functions, to be included
  * directly into the generated testlist.c file.
@@ -75,7 +172,25 @@ extern void winetest_trace( const char *msg, ... );
  * different includes or flags if needed.
  */
 
-#ifdef WINETEST_WANT_MAIN
+#ifdef STANDALONE
+
+#include <stdio.h>
+
+#if defined(__x86_64__) && defined(__GNUC__) && defined(__WINE_USE_MSVCRT)
+# define __winetest_va_start(list,arg) __builtin_ms_va_start(list,arg)
+# define __winetest_va_end(list) __builtin_ms_va_end(list)
+#else
+# define __winetest_va_start(list,arg) va_start(list,arg)
+# define __winetest_va_end(list) va_end(list)
+#endif
+
+struct test
+{
+    const char *name;
+    void (*func)(void);
+};
+
+extern const struct test winetest_testlist[];
 
 /* debug level */
 int winetest_debug = 1;
@@ -97,6 +212,7 @@ static const struct test *current_test; /* test currently being run */
 
 static LONG successes;       /* number of successful tests */
 static LONG failures;        /* number of failures */
+static LONG skipped;         /* number of skipped test chunks */
 static LONG todo_successes;  /* number of successful tests inside todo block */
 static LONG todo_failures;   /* number of failures inside todo block */
 
@@ -107,6 +223,8 @@ typedef struct
     int current_line;                /* line of current check */
     int todo_level;                  /* current todo nesting level */
     int todo_do_loop;
+    char *str_pos;                   /* position in debug buffer */
+    char strings[2000];              /* buffer for debug strings */
 } tls_data;
 static DWORD tls_index;
 
@@ -119,13 +237,33 @@ static tls_data* get_tls_data(void)
     data=TlsGetValue(tls_index);
     if (!data)
     {
-        data=HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(tls_data));
+        data=HeapAlloc(GetProcessHeap(), 0, sizeof(tls_data));
+        data->todo_level = 0;
+        data->str_pos = data->strings;
         TlsSetValue(tls_index,data);
     }
     SetLastError(last_error);
     return data;
 }
 
+/* allocate some tmp space for a string */
+static char *get_temp_buffer( size_t n )
+{
+    tls_data *data = get_tls_data();
+    char *res = data->str_pos;
+
+    if (res + n >= &data->strings[sizeof(data->strings)]) res = data->strings;
+    data->str_pos = res + n;
+    return res;
+}
+
+/* release extra space that we requested in gimme1() */
+static void release_temp_buffer( char *ptr, size_t size )
+{
+    tls_data *data = get_tls_data();
+    data->str_pos = ptr + size;
+}
+
 static void exit_process( int code )
 {
     fflush( stdout );
@@ -146,6 +284,11 @@ void winetest_set_location( const char* file, int line )
     data->current_line=line;
 }
 
+int broken( int condition )
+{
+    return (strcmp(winetest_platform, "windows") == 0) && condition;
+}
+
 /*
  * Checks condition.
  * Parameters:
@@ -156,53 +299,39 @@ void winetest_set_location( const char* file, int line )
  * Return:
  *   0 if condition does not have the expected value, 1 otherwise
  */
-int winetest_ok( int condition, const char *msg, ... )
+int winetest_vok( int condition, const char *msg, __winetest_va_list args )
 {
-    va_list valist;
     tls_data* data=get_tls_data();
 
     if (data->todo_level)
     {
         if (condition)
         {
-            fprintf( stdout, "%s:%d: Test succeeded inside todo block",
+            fprintf( stdout, "%s:%d: Test succeeded inside todo block",
                      data->current_file, data->current_line );
-            if (msg && msg[0])
-            {
-                va_start(valist, msg);
-                fprintf(stdout,": ");
-                vfprintf(stdout, msg, valist);
-                va_end(valist);
-            }
-            fputc( '\n', stdout );
+            vfprintf(stdout, msg, args);
             InterlockedIncrement(&todo_failures);
             return 0;
         }
-        else InterlockedIncrement(&todo_successes);
+        else
+        {
+            if (winetest_debug > 0)
+            {
+                fprintf( stdout, "%s:%d: Test marked todo: ",
+                         data->current_file, data->current_line );
+                vfprintf(stdout, msg, args);
+            }
+            InterlockedIncrement(&todo_successes);
+            return 1;
+        }
     }
     else
     {
         if (!condition)
         {
-            fprintf( stdout, "%s:%d: Test failed",
+            fprintf( stdout, "%s:%d: Test failed",
                      data->current_file, data->current_line );
-            if (msg && msg[0])
-            {
-                char string[1024];
-                va_start(valist, msg);
-                fprintf( stdout,": ");
-                vfprintf(stdout, msg, valist);
-                vsprintf(string, msg, valist);
-                DbgPrint( "%s:%d: Test failed: %s\n",
-                          data->current_file, data->current_line, string );
-                va_end(valist);
-            }
-            else
-            {
-                DbgPrint( "%s:%d: Test failed\n",
-                          data->current_file, data->current_line );
-            }
-            fputc( '\n', stdout );
+            vfprintf(stdout, msg, args);
             InterlockedIncrement(&failures);
             return 0;
         }
@@ -212,28 +341,62 @@ int winetest_ok( int condition, const char *msg, ... )
                 fprintf( stdout, "%s:%d: Test succeeded\n",
                          data->current_file, data->current_line);
             InterlockedIncrement(&successes);
+            return 1;
         }
     }
-    return 1;
 }
 
-void winetest_trace( const char *msg, ... )
+void __winetest_cdecl winetest_ok( int condition, const char *msg, ... )
+{
+    __winetest_va_list valist;
+
+    __winetest_va_start(valist, msg);
+    winetest_vok(condition, msg, valist);
+    __winetest_va_end(valist);
+}
+
+void __winetest_cdecl winetest_trace( const char *msg, ... )
 {
-    va_list valist;
+    __winetest_va_list valist;
     tls_data* data=get_tls_data();
 
     if (winetest_debug > 0)
     {
-        char string[1024];
-        fprintf( stdout, "%s:%d:", data->current_file, data->current_line );
-        va_start(valist, msg);
+        fprintf( stdout, "%s:%d: ", data->current_file, data->current_line );
+        __winetest_va_start(valist, msg);
         vfprintf(stdout, msg, valist);
-        vsprintf(string, msg, valist);
-        DbgPrint( "%s:%d: %s", data->current_file, data->current_line, string);
-        va_end(valist);
+        __winetest_va_end(valist);
     }
 }
 
+void winetest_vskip( const char *msg, __winetest_va_list args )
+{
+    tls_data* data=get_tls_data();
+
+    fprintf( stdout, "%s:%d: Tests skipped: ", data->current_file, data->current_line );
+    vfprintf(stdout, msg, args);
+    skipped++;
+}
+
+void __winetest_cdecl winetest_skip( const char *msg, ... )
+{
+    __winetest_va_list valist;
+    __winetest_va_start(valist, msg);
+    winetest_vskip(msg, valist);
+    __winetest_va_end(valist);
+}
+
+void __winetest_cdecl winetest_win_skip( const char *msg, ... )
+{
+    __winetest_va_list valist;
+    __winetest_va_start(valist, msg);
+    if (strcmp(winetest_platform, "windows") == 0)
+        winetest_vskip(msg, valist);
+    else
+        winetest_vok(0, msg, valist);
+    __winetest_va_end(valist);
+}
+
 void winetest_start_todo( const char* platform )
 {
     tls_data* data=get_tls_data();
@@ -265,12 +428,94 @@ int winetest_get_mainargs( char*** pargv )
     return winetest_argc;
 }
 
+void winetest_wait_child_process( HANDLE process )
+{
+    DWORD exit_code = 1;
+
+    if (WaitForSingleObject( process, 30000 ))
+        fprintf( stdout, "%s: child process wait failed\n", current_test->name );
+    else
+        GetExitCodeProcess( process, &exit_code );
+
+    if (exit_code)
+    {
+        if (exit_code > 255)
+        {
+            fprintf( stdout, "%s: exception 0x%08x in child process\n", current_test->name, exit_code );
+            InterlockedIncrement( &failures );
+        }
+        else
+        {
+            fprintf( stdout, "%s: %u failures in child process\n",
+                     current_test->name, exit_code );
+            while (exit_code-- > 0)
+                InterlockedIncrement(&failures);
+        }
+    }
+}
+
+const char *wine_dbgstr_wn( const WCHAR *str, int n )
+{
+    char *dst, *res;
+    size_t size;
+
+    if (!((ULONG_PTR)str >> 16))
+    {
+        if (!str) return "(null)";
+        res = get_temp_buffer( 6 );
+        sprintf( res, "#%04x", LOWORD(str) );
+        return res;
+    }
+    if (n == -1)
+    {
+        const WCHAR *end = str;
+        while (*end) end++;
+        n = end - str;
+    }
+    if (n < 0) n = 0;
+    size = 12 + min( 300, n * 5 );
+    dst = res = get_temp_buffer( size );
+    *dst++ = 'L';
+    *dst++ = '"';
+    while (n-- > 0 && dst <= res + size - 10)
+    {
+        WCHAR c = *str++;
+        switch (c)
+        {
+        case '\n': *dst++ = '\\'; *dst++ = 'n'; break;
+        case '\r': *dst++ = '\\'; *dst++ = 'r'; break;
+        case '\t': *dst++ = '\\'; *dst++ = 't'; break;
+        case '"':  *dst++ = '\\'; *dst++ = '"'; break;
+        case '\\': *dst++ = '\\'; *dst++ = '\\'; break;
+        default:
+            if (c >= ' ' && c <= 126)
+                *dst++ = c;
+            else
+            {
+                *dst++ = '\\';
+                sprintf(dst,"%04x",c);
+                dst+=4;
+            }
+        }
+    }
+    *dst++ = '"';
+    if (n > 0)
+    {
+        *dst++ = '.';
+        *dst++ = '.';
+        *dst++ = '.';
+    }
+    *dst++ = 0;
+    release_temp_buffer( res, dst - res );
+    return res;
+}
+
 /* Find a test by name */
 static const struct test *find_test( const char *name )
 {
     const struct test *test;
     const char *p;
-    int len;
+    size_t len;
 
     if ((p = strrchr( name, '/' ))) name = p + 1;
     if ((p = strrchr( name, '\\' ))) name = p + 1;
@@ -285,6 +530,16 @@ static const struct test *find_test( const char *name )
 }
 
 
+/* Display list of valid tests */
+static void list_tests(void)
+{
+    const struct test *test;
+
+    fprintf( stdout, "Valid test names:\n" );
+    for (test = winetest_testlist; test->name; test++) fprintf( stdout, "    %s\n", test->name );
+}
+
+
 /* Run a named test, and return exit status */
 static int run_test( const char *name )
 {
@@ -303,10 +558,11 @@ static int run_test( const char *name )
 
     if (winetest_debug)
     {
-        fprintf( stdout, "%s: %ld tests executed, %ld marked as todo, %ld %s.\n",
-                 name, successes + failures + todo_successes + todo_failures,
+        fprintf( stdout, "%s: %d tests executed (%d marked as todo, %d %s), %d skipped.\n",
+                 test->name, successes + failures + todo_successes + todo_failures,
                  todo_successes, failures + todo_failures,
-                 (failures + todo_failures != 1) ? "failures" : "failure" );
+                 (failures + todo_failures != 1) ? "failures" : "failure",
+                 skipped );
     }
     status = (failures + todo_failures < 255) ? failures + todo_failures : 255;
     return status;
@@ -316,11 +572,8 @@ static int run_test( const char *name )
 /* Display usage and exit */
 static void usage( const char *argv0 )
 {
-    const struct test *test;
-
-    fprintf( stdout, "Usage: %s test_name\n", argv0 );
-    fprintf( stdout, "\nValid test names:\n" );
-    for (test = winetest_testlist; test->name; test++) fprintf( stdout, "    %s\n", test->name );
+    fprintf( stdout, "Usage: %s test_name\n\n", argv0 );
+    list_tests();
     exit_process(1);
 }
 
@@ -328,20 +581,32 @@ static void usage( const char *argv0 )
 /* main function */
 int main( int argc, char **argv )
 {
-    char *p;
+    char p[128];
+
+    setvbuf (stdout, NULL, _IONBF, 0);
 
     winetest_argc = argc;
     winetest_argv = argv;
 
-    if ((p = getenv( "WINETEST_PLATFORM" ))) winetest_platform = p;
-    if ((p = getenv( "WINETEST_DEBUG" ))) winetest_debug = atoi(p);
-    if ((p = getenv( "WINETEST_INTERACTIVE" ))) winetest_interactive = atoi(p);
-    if ((p = getenv( "WINETEST_REPORT_SUCCESS"))) report_success = atoi(p);
-    if (!argv[1]) usage( argv[0] );
+    if (GetEnvironmentVariableA( "WINETEST_PLATFORM", p, sizeof(p) )) winetest_platform = _strdup(p);
+    if (GetEnvironmentVariableA( "WINETEST_DEBUG", p, sizeof(p) )) winetest_debug = atoi(p);
+    if (GetEnvironmentVariableA( "WINETEST_INTERACTIVE", p, sizeof(p) )) winetest_interactive = atoi(p);
+    if (GetEnvironmentVariableA( "WINETEST_REPORT_SUCCESS", p, sizeof(p) )) report_success = atoi(p);
 
+    if (!argv[1])
+    {
+        if (winetest_testlist[0].name && !winetest_testlist[1].name)  /* only one test */
+            return run_test( winetest_testlist[0].name );
+        usage( argv[0] );
+    }
+    if (!strcmp( argv[1], "--list" ))
+    {
+        list_tests();
+        return 0;
+    }
     return run_test(argv[1]);
 }
 
-#endif  /* WINETEST_WANT_MAIN */
+#endif  /* STANDALONE */
 
-#endif  /* __WINE_TEST_H */
+#endif  /* __WINE_WINE_TEST_H */