af062818b47340eef15700d2f0211576ba3506eevboxsync * Definitions for Wine C unit tests.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Copyright (C) 2002 Alexandre Julliard
af062818b47340eef15700d2f0211576ba3506eevboxsync * This library is free software; you can redistribute it and/or
af062818b47340eef15700d2f0211576ba3506eevboxsync * modify it under the terms of the GNU Lesser General Public
af062818b47340eef15700d2f0211576ba3506eevboxsync * License as published by the Free Software Foundation; either
af062818b47340eef15700d2f0211576ba3506eevboxsync * version 2.1 of the License, or (at your option) any later version.
af062818b47340eef15700d2f0211576ba3506eevboxsync * This library is distributed in the hope that it will be useful,
af062818b47340eef15700d2f0211576ba3506eevboxsync * but WITHOUT ANY WARRANTY; without even the implied warranty of
af062818b47340eef15700d2f0211576ba3506eevboxsync * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
af062818b47340eef15700d2f0211576ba3506eevboxsync * Lesser General Public License for more details.
af062818b47340eef15700d2f0211576ba3506eevboxsync * You should have received a copy of the GNU Lesser General Public
af062818b47340eef15700d2f0211576ba3506eevboxsync * License along with this library; if not, write to the Free Software
af062818b47340eef15700d2f0211576ba3506eevboxsync * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
4b9d6701570cb98fd36e209314239d104ec584d3vboxsync * Oracle LGPL Disclaimer: For the avoidance of doubt, except that if any license choice
4b9d6701570cb98fd36e209314239d104ec584d3vboxsync * other than GPL or LGPL is available it will apply instead, Oracle elects to use only
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * the Lesser General Public License version 2.1 (LGPLv2) at this time for any software where
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * a choice of LGPL license versions is made available with the language indicating
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * that LGPLv2 or any later version may be used, or where a choice of which version
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * of the LGPL is applied is otherwise unspecified.
af062818b47340eef15700d2f0211576ba3506eevboxsync#error wine/library.h should not be used in Wine tests
af062818b47340eef15700d2f0211576ba3506eevboxsync#error wine/unicode.h should not be used in Wine tests
af062818b47340eef15700d2f0211576ba3506eevboxsync#error wine/debug.h should not be used in Wine tests
af062818b47340eef15700d2f0211576ba3506eevboxsync/* debug level */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* running in interactive mode? */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* current platform */
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern const char *winetest_platform;
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern void winetest_set_location( const char* file, int line );
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern void winetest_start_todo( const char* platform );
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern int winetest_loop_todo(void);
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern void winetest_end_todo( const char* platform );
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern void winetest_wait_child_process( HANDLE process );
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsyncextern const char *wine_dbgstr_wn( const WCHAR *str, int n );
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsyncstatic inline const char *wine_dbgstr_w( const WCHAR *s ) { return wine_dbgstr_wn( s, -1 ); }
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync/* strcmpW is avaiable for tests compiled under Wine, but not in standalone
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync * builds under Windows, so we reimplement it under a different name. */
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncstatic inline int winetest_strcmpW( const WCHAR *str1, const WCHAR *str2 )
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync while (*str1 && (*str1 == *str2)) { str1++; str2++; }
af062818b47340eef15700d2f0211576ba3506eevboxsync const struct test winetest_testlist[] = { { #name, func_##name }, { 0, 0 } }; \
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync#if defined(__x86_64__) && defined(__GNUC__) && defined(__WINE_USE_MSVCRT)
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern int winetest_vok( int condition, const char *msg, __winetest_va_list ap );
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void winetest_vskip( const char *msg, __winetest_va_list ap );
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void __winetest_cdecl winetest_ok( int condition, const char *msg, ... ) __attribute__((format (printf,2,3) ));
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void __winetest_cdecl winetest_skip( const char *msg, ... ) __attribute__((format (printf,1,2)));
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void __winetest_cdecl winetest_win_skip( const char *msg, ... ) __attribute__((format (printf,1,2)));
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void __winetest_cdecl winetest_trace( const char *msg, ... ) __attribute__((format (printf,1,2)));
af062818b47340eef15700d2f0211576ba3506eevboxsync#else /* __GNUC__ */
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void __winetest_cdecl winetest_ok( int condition, const char *msg, ... );
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void __winetest_cdecl winetest_skip( const char *msg, ... );
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void __winetest_cdecl winetest_win_skip( const char *msg, ... );
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncextern void __winetest_cdecl winetest_trace( const char *msg, ... );
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* __GNUC__ */
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync#define ok_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_ok
af062818b47340eef15700d2f0211576ba3506eevboxsync#define skip_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_skip
af062818b47340eef15700d2f0211576ba3506eevboxsync#define win_skip_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_win_skip
af062818b47340eef15700d2f0211576ba3506eevboxsync#define trace_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_trace
af062818b47340eef15700d2f0211576ba3506eevboxsync#define todo(platform) for (winetest_start_todo(platform); \
af062818b47340eef15700d2f0211576ba3506eevboxsync# define U(x) (x).u
af062818b47340eef15700d2f0211576ba3506eevboxsync# define U(x) (x)
af062818b47340eef15700d2f0211576ba3506eevboxsync# define S(x) (x).s
af062818b47340eef15700d2f0211576ba3506eevboxsync# define S(x) (x)
af062818b47340eef15700d2f0211576ba3506eevboxsync/************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Below is the implementation of the various functions, to be included
af062818b47340eef15700d2f0211576ba3506eevboxsync * directly into the generated testlist.c file.
af062818b47340eef15700d2f0211576ba3506eevboxsync * It is done that way so that the dlls can build the test routines with
af062818b47340eef15700d2f0211576ba3506eevboxsync * different includes or flags if needed.
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync#if defined(__x86_64__) && defined(__GNUC__) && defined(__WINE_USE_MSVCRT)
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync# define __winetest_va_start(list,arg) __builtin_ms_va_start(list,arg)
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync# define __winetest_va_end(list) __builtin_ms_va_end(list)
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsync# define __winetest_va_start(list,arg) va_start(list,arg)
af062818b47340eef15700d2f0211576ba3506eevboxsync/* debug level */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* interactive mode? */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* current platform */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* report successful tests (BOOL) */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* passing arguments around */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic const struct test *current_test; /* test currently being run */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic LONG successes; /* number of successful tests */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic LONG skipped; /* number of skipped test chunks */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic LONG todo_successes; /* number of successful tests inside todo block */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic LONG todo_failures; /* number of failures inside todo block */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* The following data must be kept track of on a per-thread basis */
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct
af062818b47340eef15700d2f0211576ba3506eevboxsync const char* current_file; /* file of current check */
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsync data=HeapAlloc(GetProcessHeap(), 0, sizeof(tls_data));
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsync/* allocate some tmp space for a string */
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsync if (res + n >= &data->strings[sizeof(data->strings)]) res = data->strings;
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsync/* release extra space that we requested in gimme1() */
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsyncstatic void release_temp_buffer( char *ptr, size_t size )
af062818b47340eef15700d2f0211576ba3506eevboxsyncvoid winetest_set_location( const char* file, int line )
af062818b47340eef15700d2f0211576ba3506eevboxsync return (strcmp(winetest_platform, "windows") == 0) && condition;
af062818b47340eef15700d2f0211576ba3506eevboxsync * Checks condition.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Parameters:
af062818b47340eef15700d2f0211576ba3506eevboxsync * - condition - condition to check;
af062818b47340eef15700d2f0211576ba3506eevboxsync * - msg test description;
af062818b47340eef15700d2f0211576ba3506eevboxsync * - file - test application source code file name of the check
af062818b47340eef15700d2f0211576ba3506eevboxsync * - line - test application source code file line number of the check
af062818b47340eef15700d2f0211576ba3506eevboxsync * 0 if condition does not have the expected value, 1 otherwise
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncint winetest_vok( int condition, const char *msg, __winetest_va_list args )
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync fprintf( stdout, "%s:%d: Test succeeded inside todo block: ",
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncvoid __winetest_cdecl winetest_ok( int condition, const char *msg, ... )
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncvoid __winetest_cdecl winetest_trace( const char *msg, ... )
af062818b47340eef15700d2f0211576ba3506eevboxsync fprintf( stdout, "%s:%d: ", data->current_file, data->current_line );
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncvoid winetest_vskip( const char *msg, __winetest_va_list args )
af062818b47340eef15700d2f0211576ba3506eevboxsync fprintf( stdout, "%s:%d: Tests skipped: ", data->current_file, data->current_line );
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncvoid __winetest_cdecl winetest_skip( const char *msg, ... )
ee6bcfc59fe3b0230aad85e2ef63d0402b7719b2vboxsyncvoid __winetest_cdecl winetest_win_skip( const char *msg, ... )
af062818b47340eef15700d2f0211576ba3506eevboxsync fprintf( stdout, "%s: child process wait failed\n", current_test->name );
af062818b47340eef15700d2f0211576ba3506eevboxsync fprintf( stdout, "%s: exception 0x%08x in child process\n", current_test->name, exit_code );
af062818b47340eef15700d2f0211576ba3506eevboxsync fprintf( stdout, "%s: %u failures in child process\n",
af062818b47340eef15700d2f0211576ba3506eevboxsync while (exit_code-- > 0)
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsyncconst char *wine_dbgstr_wn( const WCHAR *str, int n )
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsync if (n == -1)
a3133ef29cdf3656735d569fd64e54c9286effc0vboxsync if (n < 0) n = 0;
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Find a test by name */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic const struct test *find_test( const char *name )
af062818b47340eef15700d2f0211576ba3506eevboxsync const char *p;
af062818b47340eef15700d2f0211576ba3506eevboxsync if (len > 2 && !strcmp( name + len - 2, ".c" )) len -= 2;
af062818b47340eef15700d2f0211576ba3506eevboxsync if (!strncmp( test->name, name, len ) && !test->name[len]) break;
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Display list of valid tests */
af062818b47340eef15700d2f0211576ba3506eevboxsync for (test = winetest_testlist; test->name; test++) fprintf( stdout, " %s\n", test->name );
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Run a named test, and return exit status */
af062818b47340eef15700d2f0211576ba3506eevboxsync fprintf( stdout, "Fatal: test '%s' does not exist.\n", name );
af062818b47340eef15700d2f0211576ba3506eevboxsync successes = failures = todo_successes = todo_failures = 0;
af062818b47340eef15700d2f0211576ba3506eevboxsync fprintf( stdout, "%s: %d tests executed (%d marked as todo, %d %s), %d skipped.\n",
af062818b47340eef15700d2f0211576ba3506eevboxsync test->name, successes + failures + todo_successes + todo_failures,
af062818b47340eef15700d2f0211576ba3506eevboxsync (failures + todo_failures != 1) ? "failures" : "failure",
af062818b47340eef15700d2f0211576ba3506eevboxsync status = (failures + todo_failures < 255) ? failures + todo_failures : 255;
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Display usage and exit */
af062818b47340eef15700d2f0211576ba3506eevboxsync fprintf( stdout, "Usage: %s test_name\n\n", argv0 );
af062818b47340eef15700d2f0211576ba3506eevboxsync/* main function */
af062818b47340eef15700d2f0211576ba3506eevboxsync char p[128];
af062818b47340eef15700d2f0211576ba3506eevboxsync if (GetEnvironmentVariableA( "WINETEST_PLATFORM", p, sizeof(p) )) winetest_platform = strdup(p);
af062818b47340eef15700d2f0211576ba3506eevboxsync if (GetEnvironmentVariableA( "WINETEST_DEBUG", p, sizeof(p) )) winetest_debug = atoi(p);
af062818b47340eef15700d2f0211576ba3506eevboxsync if (GetEnvironmentVariableA( "WINETEST_INTERACTIVE", p, sizeof(p) )) winetest_interactive = atoi(p);
af062818b47340eef15700d2f0211576ba3506eevboxsync if (GetEnvironmentVariableA( "WINETEST_REPORT_SUCCESS", p, sizeof(p) )) report_success = atoi(p);
af062818b47340eef15700d2f0211576ba3506eevboxsync if (winetest_testlist[0].name && !winetest_testlist[1].name) /* only one test */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* STANDALONE */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* __WINE_WINE_TEST_H */