2 * Definitions for Wine C unit tests.
4 * Copyright (C) 2002 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #ifndef __WINE_WINE_TEST_H
22 #define __WINE_WINE_TEST_H
29 #ifdef __WINE_CONFIG_H
30 #error config.h should not be used in Wine tests
32 #ifdef __WINE_WINE_LIBRARY_H
33 #error wine/library.h should not be used in Wine tests
35 #ifdef __WINE_WINE_UNICODE_H
36 #error wine/unicode.h should not be used in Wine tests
38 #ifdef __WINE_WINE_DEBUG_H
39 #error wine/debug.h should not be used in Wine tests
46 #ifndef INVALID_FILE_ATTRIBUTES
47 #define INVALID_FILE_ATTRIBUTES (~0u)
49 #ifndef INVALID_SET_FILE_POINTER
50 #define INVALID_SET_FILE_POINTER (~0u)
54 extern int winetest_debug
;
56 /* running in interactive mode? */
57 extern int winetest_interactive
;
59 /* current platform */
60 extern const char *winetest_platform
;
62 extern void winetest_set_location( const char* file
, int line
);
63 extern void winetest_start_todo( const char* platform
);
64 extern int winetest_loop_todo(void);
65 extern void winetest_end_todo( const char* platform
);
66 extern int winetest_get_mainargs( char*** pargv
);
67 extern LONG
winetest_get_failures(void);
68 extern void winetest_add_failures( LONG new_failures
);
69 extern void winetest_wait_child_process( HANDLE process
);
71 extern const char *wine_dbgstr_wn( const WCHAR
*str
, intptr_t n
);
72 extern const char *wine_dbgstr_guid( const GUID
*guid
);
73 static inline const char *wine_dbgstr_w( const WCHAR
*s
) { return wine_dbgstr_wn( s
, -1 ); }
75 /* strcmpW is available for tests compiled under Wine, but not in standalone
76 * builds under Windows, so we reimplement it under a different name. */
77 static inline int winetest_strcmpW( const WCHAR
*str1
, const WCHAR
*str2
)
79 while (*str1
&& (*str1
== *str2
)) { str1
++; str2
++; }
85 #define START_TEST(name) \
86 static void func_##name(void); \
87 const struct test winetest_testlist[] = { { #name, func_##name }, { 0, 0 } }; \
88 static void func_##name(void)
90 #else /* STANDALONE */
93 #define START_TEST(name) extern "C" void func_##name(void)
95 #define START_TEST(name) void func_##name(void)
98 #endif /* STANDALONE */
100 #if defined(__x86_64__) && defined(__GNUC__) && defined(__WINE_USE_MSVCRT)
101 #define __winetest_cdecl __cdecl
102 #define __winetest_va_list __builtin_ms_va_list
104 #define __winetest_cdecl
105 #define __winetest_va_list va_list
108 extern int broken( int condition
);
109 extern int winetest_vok( int condition
, const char *msg
, __winetest_va_list ap
);
110 extern void winetest_vskip( const char *msg
, __winetest_va_list ap
);
114 extern void __winetest_cdecl
winetest_ok( int condition
, const char *msg
, ... ) __attribute__((format (printf
,2,3) ));
115 extern void __winetest_cdecl
winetest_skip( const char *msg
, ... ) __attribute__((format (printf
,1,2)));
116 extern void __winetest_cdecl
winetest_win_skip( const char *msg
, ... ) __attribute__((format (printf
,1,2)));
117 extern void __winetest_cdecl
winetest_trace( const char *msg
, ... ) __attribute__((format (printf
,1,2)));
121 extern void __winetest_cdecl
winetest_ok( int condition
, const char *msg
, ... );
122 extern void __winetest_cdecl
winetest_skip( const char *msg
, ... );
123 extern void __winetest_cdecl
winetest_win_skip( const char *msg
, ... );
124 extern void __winetest_cdecl
winetest_trace( const char *msg
, ... );
126 #endif /* __GNUC__ */
128 #define ok_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_ok
129 #define skip_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_skip
130 #define win_skip_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_win_skip
131 #define trace_(file, line) (winetest_set_location(file, line), 0) ? (void)0 : winetest_trace
133 #define ok ok_(__FILE__, __LINE__)
134 #define skip skip_(__FILE__, __LINE__)
135 #define win_skip win_skip_(__FILE__, __LINE__)
136 #define trace trace_(__FILE__, __LINE__)
138 #define todo(platform) for (winetest_start_todo(platform); \
139 winetest_loop_todo(); \
140 winetest_end_todo(platform))
142 #define todo_ros todo("reactos")
143 #ifdef USE_WINE_TODOS
144 #define todo_wine todo_ros
146 #define todo_wine todo("wine")
150 #ifdef NONAMELESSUNION
152 # define U1(x) (x).u1
153 # define U2(x) (x).u2
154 # define U3(x) (x).u3
155 # define U4(x) (x).u4
156 # define U5(x) (x).u5
157 # define U6(x) (x).u6
158 # define U7(x) (x).u7
159 # define U8(x) (x).u8
172 #ifdef NONAMELESSSTRUCT
174 # define S1(x) (x).s1
175 # define S2(x) (x).s2
176 # define S3(x) (x).s3
177 # define S4(x) (x).s4
178 # define S5(x) (x).s5
189 /************************************************************************/
190 /* Below is the implementation of the various functions, to be included
191 * directly into the generated testlist.c file.
192 * It is done that way so that the dlls can build the test routines with
193 * different includes or flags if needed.
200 #if defined(__x86_64__) && defined(__GNUC__) && defined(__WINE_USE_MSVCRT)
201 # define __winetest_va_start(list,arg) __builtin_ms_va_start(list,arg)
202 # define __winetest_va_end(list) __builtin_ms_va_end(list)
204 # define __winetest_va_start(list,arg) va_start(list,arg)
205 # define __winetest_va_end(list) va_end(list)
208 /* Define WINETEST_MSVC_IDE_FORMATTING to alter the output format winetest will use for file/line numbers.
209 This alternate format makes the file/line numbers clickable in visual studio, to directly jump to them. */
210 #if defined(WINETEST_MSVC_IDE_FORMATTING)
211 # define __winetest_file_line_prefix "%s(%d)"
213 # define __winetest_file_line_prefix "%s:%d"
222 extern const struct test winetest_testlist
[];
225 int winetest_debug
= 1;
227 /* interactive mode? */
228 int winetest_interactive
= 0;
230 /* current platform */
231 const char *winetest_platform
= "windows";
233 /* report successful tests (BOOL) */
234 static int report_success
= 0;
236 /* passing arguments around */
237 static int winetest_argc
;
238 static char** winetest_argv
;
240 static const struct test
*current_test
; /* test currently being run */
242 static LONG successes
; /* number of successful tests */
243 static LONG failures
; /* number of failures */
244 static LONG skipped
; /* number of skipped test chunks */
245 static LONG todo_successes
; /* number of successful tests inside todo block */
246 static LONG todo_failures
; /* number of failures inside todo block */
248 /* The following data must be kept track of on a per-thread basis */
251 const char* current_file
; /* file of current check */
252 int current_line
; /* line of current check */
253 int todo_level
; /* current todo nesting level */
255 char *str_pos
; /* position in debug buffer */
256 char strings
[2000]; /* buffer for debug strings */
258 static DWORD tls_index
;
260 static tls_data
* get_tls_data(void)
265 last_error
=GetLastError();
266 data
=(tls_data
*)TlsGetValue(tls_index
);
269 data
=(tls_data
*)HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, sizeof(tls_data
));
270 data
->str_pos
= data
->strings
;
271 TlsSetValue(tls_index
,data
);
273 SetLastError(last_error
);
277 /* allocate some tmp space for a string */
278 static char *get_temp_buffer( size_t n
)
280 tls_data
*data
= get_tls_data();
281 char *res
= data
->str_pos
;
283 if (res
+ n
>= &data
->strings
[sizeof(data
->strings
)]) res
= data
->strings
;
284 data
->str_pos
= res
+ n
;
288 /* release extra space that we requested in gimme1() */
289 static void release_temp_buffer( char *ptr
, size_t size
)
291 tls_data
*data
= get_tls_data();
292 data
->str_pos
= ptr
+ size
;
295 static void exit_process( int code
)
302 void winetest_set_location( const char* file
, int line
)
304 tls_data
* data
=get_tls_data();
305 #if defined(WINETEST_MSVC_IDE_FORMATTING)
306 data
->current_file
= file
;
308 data
->current_file
=strrchr(file
,'/');
309 if (data
->current_file
==NULL
)
310 data
->current_file
=strrchr(file
,'\\');
311 if (data
->current_file
==NULL
)
312 data
->current_file
=file
;
314 data
->current_file
++;
316 data
->current_line
=line
;
319 int broken( int condition
)
321 return ((strcmp(winetest_platform
, "windows") == 0)
322 #ifndef USE_WINE_TODOS
323 || (strcmp(winetest_platform
, "reactos") == 0)
331 * - condition - condition to check;
332 * - msg test description;
333 * - file - test application source code file name of the check
334 * - line - test application source code file line number of the check
336 * 0 if condition does not have the expected value, 1 otherwise
338 int winetest_vok( int condition
, const char *msg
, __winetest_va_list args
)
340 tls_data
* data
=get_tls_data();
342 if (data
->todo_level
)
346 fprintf( stdout
, __winetest_file_line_prefix
": Test succeeded inside todo block: ",
347 data
->current_file
, data
->current_line
);
348 vfprintf(stdout
, msg
, args
);
349 InterlockedIncrement(&todo_failures
);
354 /* show todos even if traces are disabled*/
355 /*if (winetest_debug > 0)*/
357 fprintf( stdout
, __winetest_file_line_prefix
": Test marked todo: ",
358 data
->current_file
, data
->current_line
);
359 vfprintf(stdout
, msg
, args
);
361 InterlockedIncrement(&todo_successes
);
369 fprintf( stdout
, __winetest_file_line_prefix
": Test failed: ",
370 data
->current_file
, data
->current_line
);
371 vfprintf(stdout
, msg
, args
);
372 InterlockedIncrement(&failures
);
378 fprintf( stdout
, __winetest_file_line_prefix
": Test succeeded\n",
379 data
->current_file
, data
->current_line
);
380 InterlockedIncrement(&successes
);
386 void __winetest_cdecl
winetest_ok( int condition
, const char *msg
, ... )
388 __winetest_va_list valist
;
390 __winetest_va_start(valist
, msg
);
391 winetest_vok(condition
, msg
, valist
);
392 __winetest_va_end(valist
);
395 void __winetest_cdecl
winetest_trace( const char *msg
, ... )
397 __winetest_va_list valist
;
398 tls_data
* data
=get_tls_data();
400 if (winetest_debug
> 0)
402 fprintf( stdout
, __winetest_file_line_prefix
": ", data
->current_file
, data
->current_line
);
403 __winetest_va_start(valist
, msg
);
404 vfprintf(stdout
, msg
, valist
);
405 __winetest_va_end(valist
);
409 void winetest_vskip( const char *msg
, __winetest_va_list args
)
411 tls_data
* data
=get_tls_data();
413 fprintf( stdout
, __winetest_file_line_prefix
": Tests skipped: ", data
->current_file
, data
->current_line
);
414 vfprintf(stdout
, msg
, args
);
418 void __winetest_cdecl
winetest_skip( const char *msg
, ... )
420 __winetest_va_list valist
;
421 __winetest_va_start(valist
, msg
);
422 winetest_vskip(msg
, valist
);
423 __winetest_va_end(valist
);
426 void __winetest_cdecl
winetest_win_skip( const char *msg
, ... )
428 __winetest_va_list valist
;
429 __winetest_va_start(valist
, msg
);
430 if ((strcmp(winetest_platform
, "windows") == 0)
431 #ifndef USE_WINE_TODOS
432 || (strcmp(winetest_platform
, "reactos") == 0)
435 winetest_vskip(msg
, valist
);
437 winetest_vok(0, msg
, valist
);
438 __winetest_va_end(valist
);
441 void winetest_start_todo( const char* platform
)
443 tls_data
* data
=get_tls_data();
444 if (strcmp(winetest_platform
,platform
)==0)
446 data
->todo_do_loop
=1;
449 int winetest_loop_todo(void)
451 tls_data
* data
=get_tls_data();
452 int do_loop
=data
->todo_do_loop
;
453 data
->todo_do_loop
=0;
457 void winetest_end_todo( const char* platform
)
459 if (strcmp(winetest_platform
,platform
)==0)
461 tls_data
* data
=get_tls_data();
466 int winetest_get_mainargs( char*** pargv
)
468 *pargv
= winetest_argv
;
469 return winetest_argc
;
472 LONG
winetest_get_failures(void)
477 void winetest_add_failures( LONG new_failures
)
479 while (new_failures
-- > 0)
480 InterlockedIncrement( &failures
);
483 void winetest_wait_child_process( HANDLE process
)
487 if (WaitForSingleObject( process
, 30000 ))
488 fprintf( stdout
, "%s: child process wait failed\n", current_test
->name
);
490 GetExitCodeProcess( process
, &exit_code
);
496 fprintf( stdout
, "%s: exception 0x%08x in child process\n", current_test
->name
, (unsigned)exit_code
);
497 InterlockedIncrement( &failures
);
501 fprintf( stdout
, "%s: %u failures in child process\n",
502 current_test
->name
, (unsigned)exit_code
);
503 while (exit_code
-- > 0)
504 InterlockedIncrement(&failures
);
509 const char *wine_dbgstr_wn( const WCHAR
*str
, intptr_t n
)
514 if (!((ULONG_PTR
)str
>> 16))
516 if (!str
) return "(null)";
517 res
= get_temp_buffer( 6 );
518 sprintf( res
, "#%04x", LOWORD(str
) );
523 const WCHAR
*end
= str
;
528 size
= 12 + min( 300, n
* 5 );
529 dst
= res
= get_temp_buffer( size
);
532 while (n
-- > 0 && dst
<= res
+ size
- 10)
537 case '\n': *dst
++ = '\\'; *dst
++ = 'n'; break;
538 case '\r': *dst
++ = '\\'; *dst
++ = 'r'; break;
539 case '\t': *dst
++ = '\\'; *dst
++ = 't'; break;
540 case '"': *dst
++ = '\\'; *dst
++ = '"'; break;
541 case '\\': *dst
++ = '\\'; *dst
++ = '\\'; break;
543 if (c
>= ' ' && c
<= 126)
548 sprintf(dst
,"%04x",c
);
561 release_temp_buffer( res
, dst
- res
);
565 const char *wine_dbgstr_guid( const GUID
*guid
)
569 if (!guid
) return "(null)";
570 res
= get_temp_buffer( 39 ); /* CHARS_IN_GUID */
571 sprintf( res
, "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
572 guid
->Data1
, guid
->Data2
, guid
->Data3
, guid
->Data4
[0],
573 guid
->Data4
[1], guid
->Data4
[2], guid
->Data4
[3], guid
->Data4
[4],
574 guid
->Data4
[5], guid
->Data4
[6], guid
->Data4
[7] );
578 /* Find a test by name */
579 static const struct test
*find_test( const char *name
)
581 const struct test
*test
;
585 if ((p
= strrchr( name
, '/' ))) name
= p
+ 1;
586 if ((p
= strrchr( name
, '\\' ))) name
= p
+ 1;
588 if (len
> 2 && !strcmp( name
+ len
- 2, ".c" )) len
-= 2;
590 for (test
= winetest_testlist
; test
->name
; test
++)
592 if (!strncmp( test
->name
, name
, len
) && !test
->name
[len
]) break;
594 return test
->name
? test
: NULL
;
598 /* Display list of valid tests */
599 static void list_tests(void)
601 const struct test
*test
;
603 fprintf( stdout
, "Valid test names:\n" );
604 for (test
= winetest_testlist
; test
->name
; test
++) fprintf( stdout
, " %s\n", test
->name
);
607 /* Disable false-positive claiming "test" would be NULL-dereferenced */
608 #if defined(_MSC_VER)
609 #pragma warning(push)
610 #pragma warning(disable:28182)
613 /* Run a named test, and return exit status */
614 static int run_test( const char *name
)
616 const struct test
*test
;
619 if (!(test
= find_test( name
)))
621 fprintf( stdout
, "Fatal: test '%s' does not exist.\n", name
);
624 successes
= failures
= todo_successes
= todo_failures
= 0;
625 tls_index
=TlsAlloc();
629 /* show test results even if traces are disabled */
630 /*if (winetest_debug)*/
632 fprintf( stdout
, "\n%s: %d tests executed (%d marked as todo, %d %s), %d skipped.\n",
633 test
->name
, (int)(successes
+ failures
+ todo_successes
+ todo_failures
),
634 (int)todo_successes
, (int)(failures
+ todo_failures
),
635 (failures
+ todo_failures
!= 1) ? "failures" : "failure",
638 status
= (failures
+ todo_failures
< 255) ? failures
+ todo_failures
: 255;
642 #if defined(_MSC_VER)
646 /* Display usage and exit */
647 static void usage( const char *argv0
)
649 fprintf( stdout
, "Usage: %s test_name\n\n", argv0
);
656 int main( int argc
, char **argv
)
660 setvbuf (stdout
, NULL
, _IONBF
, 0);
662 winetest_argc
= argc
;
663 winetest_argv
= argv
;
665 if (GetEnvironmentVariableA( "WINETEST_PLATFORM", p
, sizeof(p
) )) winetest_platform
= _strdup(p
);
666 if (GetEnvironmentVariableA( "WINETEST_DEBUG", p
, sizeof(p
) )) winetest_debug
= atoi(p
);
667 if (GetEnvironmentVariableA( "WINETEST_INTERACTIVE", p
, sizeof(p
) )) winetest_interactive
= atoi(p
);
668 if (GetEnvironmentVariableA( "WINETEST_REPORT_SUCCESS", p
, sizeof(p
) )) report_success
= atoi(p
);
670 if (!winetest_interactive
) SetErrorMode( SEM_FAILCRITICALERRORS
| SEM_NOGPFAULTERRORBOX
);
674 if (winetest_testlist
[0].name
&& !winetest_testlist
[1].name
) /* only one test */
675 return run_test( winetest_testlist
[0].name
);
678 if (!strcmp( argv
[1], "--list" ))
683 return run_test(argv
[1]);
686 #endif /* STANDALONE */
688 // hack for ntdll winetest (this is defined in excpt.h)
689 #undef exception_info
691 // Some helpful definitions
693 #define ok_hex(expression, result) \
695 int _value = (expression); \
696 ok(_value == (result), "Wrong value for '%s', expected: " #result " (0x%x), got: 0x%x\n", \
697 #expression, (int)(result), _value); \
700 #define ok_dec(expression, result) \
702 int _value = (expression); \
703 ok(_value == (result), "Wrong value for '%s', expected: " #result " (%d), got: %d\n", \
704 #expression, (int)(result), _value); \
707 #define ok_ptr(expression, result) \
709 void *_value = (expression); \
710 ok(_value == (result), "Wrong value for '%s', expected: " #result " (%p), got: %p\n", \
711 #expression, (void*)(result), _value); \
714 #define ok_size_t(expression, result) \
716 size_t _value = (expression); \
717 ok(_value == (result), "Wrong value for '%s', expected: " #result " (%Ix), got: %Ix\n", \
718 #expression, (size_t)(result), _value); \
721 #define ok_char(expression, result) ok_hex(expression, result)
723 #define ok_err(error) \
724 ok(GetLastError() == (error), "Wrong last error. Expected " #error ", got 0x%lx\n", GetLastError())
726 #define ok_str(x, y) \
727 ok(strcmp(x, y) == 0, "Wrong string. Expected '%s', got '%s'\n", y, x)
729 #define ok_wstr(x, y) \
730 ok(wcscmp(x, y) == 0, "Wrong string. Expected '%S', got '%S'\n", y, x)
732 #define ok_long(expression, result) ok_hex(expression, result)
733 #define ok_int(expression, result) ok_dec(expression, result)
734 #define ok_ntstatus(status, expected) ok_hex(status, expected)
735 #define ok_hdl ok_ptr
741 #endif /* __WINE_WINE_TEST_H */