user/tests: Win64 printf format warning fixes.
[wine] / dlls / user / tests / input.c
1 /* Test Key event to Key message translation
2  *
3  * Copyright 2003 Rein Klazes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
18  */
19
20 /* test whether the right type of messages:
21  * WM_KEYUP/DOWN vs WM_SYSKEYUP/DOWN  are sent in case of combined
22  * keystrokes.
23  *
24  * For instance <ALT>-X can be accompished by
25  * the sequence ALT-KEY-DOWN, X-KEY-DOWN, ALT-KEY-UP, X-KEY-UP
26  * but also X-KEY-DOWN, ALT-KEY-DOWN, X-KEY-UP, ALT-KEY-UP
27  * Whether a KEY or a SYSKEY message is sent is not always clear, it is
28  * also not the same in WINNT as in WIN9X */
29
30 /* NOTE that there will be test failures under WIN9X
31  * No applications are known to me that rely on this
32  * so I don't fix it */
33
34 /* TODO:
35  * 1. extend it to the wm_command and wm_syscommand notifications
36  * 2. add some more tests with special cases like dead keys or right (alt) key
37  * 3. there is some adapted code from input.c in here. Should really
38  *    make that code exactly the same.
39  * 4. resolve the win9x case when there is a need or the testing frame work
40  *    offers a nice way.
41  * 5. The test app creates a window, the user should not take the focus
42  *    away during its short existence. I could do something to prevent that
43  *    if it is a problem.
44  *
45  */
46
47 #define _WIN32_WINNT 0x401
48
49 #include <stdarg.h>
50 #include <assert.h>
51
52 #include "windef.h"
53 #include "winbase.h"
54 #include "winuser.h"
55
56 #include "wine/test.h"
57
58 /* globals */
59 static HWND hWndTest;
60 static long timetag = 0x10000000;
61
62 static UINT (WINAPI *ptr_SendInput) (UINT, INPUT*, size_t);
63
64 #define MAXKEYEVENTS 6
65 #define MAXKEYMESSAGES MAXKEYEVENTS /* assuming a key event generates one
66                                        and only one message */
67
68 /* keyboard message names, sorted as their value */
69 static const char *MSGNAME[]={"WM_KEYDOWN", "WM_KEYUP", "WM_CHAR","WM_DEADCHAR",
70     "WM_SYSKEYDOWN", "WM_SYSKEYUP", "WM_SYSCHAR", "WM_SYSDEADCHAR" ,"WM_KEYLAST"};
71
72 /* keyevents, add more as needed */
73 typedef enum KEVtag
74 {  ALTDOWN = 1, ALTUP, XDOWN, XUP, SHIFTDOWN, SHIFTUP, CTRLDOWN, CTRLUP } KEV;
75 /* matching VK's */
76 static const int GETVKEY[]={0, VK_MENU, VK_MENU, 'X', 'X', VK_SHIFT, VK_SHIFT, VK_CONTROL, VK_CONTROL};
77 /* matching scan codes */
78 static const int GETSCAN[]={0, 0x38, 0x38, 0x2D, 0x2D, 0x2A, 0x2A, 0x1D, 0x1D };
79 /* matching updown events */
80 static const int GETUPDOWN[]={0, 0, KEYEVENTF_KEYUP, 0, KEYEVENTF_KEYUP, 0, KEYEVENTF_KEYUP, 0, KEYEVENTF_KEYUP};
81 /* matching descripts */
82 static const char *getdesc[]={"", "+alt","-alt","+X","-X","+shift","-shift","+ctrl","-ctrl"};
83
84 /* The MSVC headers ignore our NONAMELESSUNION requests so we have to define our own type */
85 typedef struct
86 {
87     DWORD type;
88     union
89     {
90         MOUSEINPUT      mi;
91         KEYBDINPUT      ki;
92         HARDWAREINPUT   hi;
93     } u;
94 } TEST_INPUT;
95
96 #define ADDTOINPUTS(kev) \
97 inputs[evtctr].type = INPUT_KEYBOARD; \
98     ((TEST_INPUT*)inputs)[evtctr].u.ki.wVk = GETVKEY[ kev]; \
99     ((TEST_INPUT*)inputs)[evtctr].u.ki.wScan = GETSCAN[ kev]; \
100     ((TEST_INPUT*)inputs)[evtctr].u.ki.dwFlags = GETUPDOWN[ kev]; \
101     ((TEST_INPUT*)inputs)[evtctr].u.ki.dwExtraInfo = 0; \
102     ((TEST_INPUT*)inputs)[evtctr].u.ki.time = ++timetag; \
103     if( kev) evtctr++;
104
105 typedef struct {
106     UINT    message;
107     WPARAM  wParam;
108     LPARAM  lParam;
109 } KMSG;
110
111 /*******************************************
112  * add new test sets here
113  * the software will make all combinations of the
114  * keyevent defined here
115  */
116 static const struct {
117     int nrkev;
118     KEV keydwn[MAXKEYEVENTS];
119     KEV keyup[MAXKEYEVENTS];
120 } testkeyset[]= {
121     { 2, { ALTDOWN, XDOWN }, { ALTUP, XUP}},
122     { 3, { ALTDOWN, XDOWN , SHIFTDOWN}, { ALTUP, XUP, SHIFTUP}},
123     { 3, { ALTDOWN, XDOWN , CTRLDOWN}, { ALTUP, XUP, CTRLUP}},
124     { 3, { SHIFTDOWN, XDOWN , CTRLDOWN}, { SHIFTUP, XUP, CTRLUP}},
125     { 0 } /* mark the end */
126 };
127
128 /**********************adapted from input.c **********************************/
129
130 static BYTE InputKeyStateTable[256];
131 static BYTE AsyncKeyStateTable[256];
132 static BYTE TrackSysKey = 0; /* determine whether ALT key up will cause a WM_SYSKEYUP
133                          or a WM_KEYUP message */
134 typedef union
135 {
136     struct
137     {
138         unsigned long count : 16;
139         unsigned long code : 8;
140         unsigned long extended : 1;
141         unsigned long unused : 2;
142         unsigned long win_internal : 2;
143         unsigned long context : 1;
144         unsigned long previous : 1;
145         unsigned long transition : 1;
146     } lp1;
147     unsigned long lp2;
148 } KEYLP;
149
150 static int KbdMessage( KEV kev, WPARAM *pwParam, LPARAM *plParam )
151 {
152     UINT message;
153     int VKey = GETVKEY[kev];
154     KEYLP keylp;
155
156     keylp.lp2 = 0;
157
158     keylp.lp1.count = 1;
159     keylp.lp1.code = GETSCAN[kev];
160     keylp.lp1.extended = 0 ;/*  FIXME (ki->dwFlags & KEYEVENTF_EXTENDEDKEY) != 0; */
161     keylp.lp1.win_internal = 0;
162
163     if (GETUPDOWN[kev] & KEYEVENTF_KEYUP )
164     {
165         message = WM_KEYUP;
166         if( (InputKeyStateTable[VK_MENU] & 0x80) && (
167                 (VKey == VK_MENU) || (VKey == VK_CONTROL) ||
168                  !(InputKeyStateTable[VK_CONTROL] & 0x80))) {
169             if(  TrackSysKey == VK_MENU || /* <ALT>-down/<ALT>-up sequence */
170                     (VKey != VK_MENU)) /* <ALT>-down...<something else>-up */
171                 message = WM_SYSKEYUP;
172                 TrackSysKey = 0;
173         }
174         InputKeyStateTable[VKey] &= ~0x80;
175         keylp.lp1.previous = 1;
176         keylp.lp1.transition = 1;
177     }
178     else
179     {
180         keylp.lp1.previous = (InputKeyStateTable[VKey] & 0x80) != 0;
181         keylp.lp1.transition = 0;
182         if (!(InputKeyStateTable[VKey] & 0x80)) InputKeyStateTable[VKey] ^= 0x01;
183         InputKeyStateTable[VKey] |= 0x80;
184         AsyncKeyStateTable[VKey] |= 0x80;
185
186         message = WM_KEYDOWN;
187         if( (InputKeyStateTable[VK_MENU] & 0x80) &&
188                 !(InputKeyStateTable[VK_CONTROL] & 0x80)) {
189             message = WM_SYSKEYDOWN;
190             TrackSysKey = VKey;
191         }
192     }
193
194     keylp.lp1.context = (InputKeyStateTable[VK_MENU] & 0x80) != 0; /* 1 if alt */
195
196     if( plParam) *plParam = keylp.lp2;
197     if( pwParam) *pwParam = VKey;
198     return message;
199 }
200
201 /****************************** end copy input.c ****************************/
202
203 /*
204  * . prepare the keyevents for SendInputs
205  * . calculate the "expected" messages
206  * . Send the events to our window
207  * . retrieve the messages from the input queue
208  * . verify
209  */
210 static void do_test( HWND hwnd, int seqnr, const KEV td[] )
211 {
212     HMODULE module;
213     INPUT inputs[MAXKEYEVENTS];
214     KMSG expmsg[MAXKEYEVENTS];
215     MSG msg;
216     char buf[100];
217     UINT evtctr=0;
218     int kmctr, i;
219
220     module = GetModuleHandleA("user32");
221     if (!module) return;
222     ptr_SendInput = (void *)GetProcAddress(module, "SendInput");
223     if (!ptr_SendInput) return;
224
225     buf[0]='\0';
226     TrackSysKey=0; /* see input.c */
227     for( i = 0; i < MAXKEYEVENTS; i++) {
228         ADDTOINPUTS(td[i])
229         strcat(buf, getdesc[td[i]]);
230         if(td[i])
231             expmsg[i].message = KbdMessage(td[i], &(expmsg[i].wParam), &(expmsg[i].lParam)); /* see queue_kbd_event() */
232         else
233             expmsg[i].message = 0;
234     }
235     for( kmctr = 0; kmctr < MAXKEYEVENTS && expmsg[kmctr].message; kmctr++)
236         ;
237     assert( evtctr <= MAXKEYEVENTS );
238     assert( evtctr == ptr_SendInput(evtctr, &inputs[0], sizeof(INPUT)));
239     i = 0;
240     trace("======== key stroke sequence #%d: %s =============\n",
241             seqnr + 1, buf);
242     while( PeekMessage(&msg,hwnd,WM_KEYFIRST,WM_KEYLAST,PM_REMOVE) ) {
243         trace("message[%d] %-15s wParam %04x lParam %08lx time %x\n", i,
244                 MSGNAME[msg.message - WM_KEYFIRST], msg.wParam, msg.lParam, msg.time);
245         if( i < kmctr ) {
246             ok( msg.message == expmsg[i].message &&
247                     msg.wParam == expmsg[i].wParam &&
248                     msg.lParam == expmsg[i].lParam,
249                     "wrong message! expected:\n"
250                     "message[%d] %-15s wParam %04x lParam %08lx\n",i,
251                     MSGNAME[(expmsg[i]).message - WM_KEYFIRST],
252                     expmsg[i].wParam, expmsg[i].lParam );
253         }
254         i++;
255     }
256     trace("%d messages retrieved\n", i);
257     ok( i == kmctr, "message count is wrong: got %d expected: %d\n", i, kmctr);
258 }
259
260 /* test all combinations of the specified key events */
261 static void TestASet( HWND hWnd, int nrkev, const KEV kevdwn[], const KEV kevup[] )
262 {
263     int i,j,k,l,m,n;
264     static int count=0;
265     KEV kbuf[MAXKEYEVENTS];
266     assert( nrkev==2 || nrkev==3);
267     for(i=0;i<MAXKEYEVENTS;i++) kbuf[i]=0;
268     /* two keys involved gives 4 test cases */
269     if(nrkev==2) {
270         for(i=0;i<nrkev;i++) {
271             for(j=0;j<nrkev;j++) {
272                 kbuf[0] = kevdwn[i];
273                 kbuf[1] = kevdwn[1-i];
274                 kbuf[2] = kevup[j];
275                 kbuf[3] = kevup[1-j];
276                 do_test( hWnd, count++, kbuf);
277             }
278         }
279     }
280     /* three keys involved gives 36 test cases */
281     if(nrkev==3){
282         for(i=0;i<nrkev;i++){
283             for(j=0;j<nrkev;j++){
284                 if(j==i) continue;
285                 for(k=0;k<nrkev;k++){
286                     if(k==i || k==j) continue;
287                     for(l=0;l<nrkev;l++){
288                         for(m=0;m<nrkev;m++){
289                             if(m==l) continue;
290                             for(n=0;n<nrkev;n++){
291                                 if(n==l ||n==m) continue;
292                                 kbuf[0] = kevdwn[i];
293                                 kbuf[1] = kevdwn[j];
294                                 kbuf[2] = kevdwn[k];
295                                 kbuf[3] = kevup[l];
296                                 kbuf[4] = kevup[m];
297                                 kbuf[5] = kevup[n];
298                                 do_test( hWnd, count++, kbuf);
299                             }
300                         }
301                     }
302                 }
303             }
304         }
305     }
306 }
307
308 /* test each set specified in the global testkeyset array */
309 static void TestSysKeys( HWND hWnd)
310 {
311     int i;
312     for(i=0; testkeyset[i].nrkev;i++)
313         TestASet( hWnd, testkeyset[i].nrkev, testkeyset[i].keydwn,
314                 testkeyset[i].keyup);
315 }
316
317 static LRESULT CALLBACK WndProc( HWND hWnd, UINT msg, WPARAM wParam,
318         LPARAM lParam )
319 {
320     switch (msg) {
321         case WM_USER:
322             SetFocus(hWnd);
323             /* window has focus, now do the test */
324             if( hWnd == hWndTest) TestSysKeys( hWnd);
325             /* finished :-) */
326             break;
327
328         case WM_DESTROY:
329             PostQuitMessage( 0 );
330             break;
331
332         default:
333             return( DefWindowProcA( hWnd, msg, wParam, lParam ) );
334     }
335
336     return 0;
337 }
338
339 static void test_Input_whitebox(void)
340 {
341     MSG msg;
342     WNDCLASSA  wclass;
343     HANDLE hInstance = GetModuleHandleA( NULL );
344
345     wclass.lpszClassName = "InputSysKeyTestClass";
346     wclass.style         = CS_HREDRAW | CS_VREDRAW;
347     wclass.lpfnWndProc   = WndProc;
348     wclass.hInstance     = hInstance;
349     wclass.hIcon         = LoadIconA( 0, (LPSTR)IDI_APPLICATION );
350     wclass.hCursor       = LoadCursorA( NULL, IDC_ARROW);
351     wclass.hbrBackground = (HBRUSH)( COLOR_WINDOW + 1);
352     wclass.lpszMenuName = 0;
353     wclass.cbClsExtra    = 0;
354     wclass.cbWndExtra    = 0;
355     assert (RegisterClassA( &wclass ));
356     /* create the test window that will receive the keystrokes */
357     assert ( hWndTest = CreateWindowA( wclass.lpszClassName, "InputSysKeyTest",
358                 WS_OVERLAPPEDWINDOW, CW_USEDEFAULT, 0, 100, 100,
359                 NULL, NULL, hInstance, NULL) );
360     ShowWindow( hWndTest, SW_SHOW);
361     UpdateWindow( hWndTest);
362
363     /* flush pending messages */
364     while (PeekMessage( &msg, 0, 0, 0, PM_REMOVE )) DispatchMessageA( &msg );
365
366     SendMessageA(hWndTest, WM_USER, 0, 0);
367     DestroyWindow(hWndTest);
368 }
369
370 static void empty_message_queue(void) {
371     MSG msg;
372     while(PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
373         TranslateMessage(&msg);
374         DispatchMessage(&msg);
375     }
376 }
377
378 struct transition_s {
379     WORD wVk;
380     BYTE before_state;
381     BOOL _todo_wine;
382 };
383
384 struct sendinput_test_s {
385     WORD wVk;
386     DWORD dwFlags;
387     struct transition_s expected_transitions[MAXKEYEVENTS+1];
388     UINT expected_messages[MAXKEYMESSAGES+1];
389 } sendinput_test[] = {
390     /* test ALT+F */
391     {VK_LMENU, 0, {{VK_MENU, 0x00, 0}, {VK_LMENU, 0x00, 0}, {0}},
392         {WM_SYSKEYDOWN, 0}},
393     {'F', 0, {{'F', 0x00, 0}, {0}},
394         {WM_SYSKEYDOWN, WM_SYSCHAR, WM_SYSCOMMAND, 0}},
395     {'F', KEYEVENTF_KEYUP, {{'F', 0x80, 0}, {0}}, {WM_SYSKEYUP, 0}},
396     {VK_LMENU, KEYEVENTF_KEYUP, {{VK_MENU, 0x80, 0}, {VK_LMENU, 0x80, 0}, {0}},
397         {WM_KEYUP, 0}},
398
399     /* test CTRL+O */
400     {VK_LCONTROL, 0, {{VK_CONTROL, 0x00, 0}, {VK_LCONTROL, 0x00, 0}, {0}},
401         {WM_KEYDOWN, 0}},
402     {'O', 0, {{'O', 0x00, 0}, {0}}, {WM_KEYDOWN, WM_CHAR, 0}},
403     {'O', KEYEVENTF_KEYUP, {{'O', 0x80, 0}, {0}}, {WM_KEYUP, 0}},
404     {VK_LCONTROL, KEYEVENTF_KEYUP,
405         {{VK_CONTROL, 0x80, 0}, {VK_LCONTROL, 0x80, 0}, {0}}, {WM_KEYUP, 0}},
406
407     /* test ALT+CTRL+X */
408     {VK_LMENU, 0, {{VK_MENU, 0x00, 0}, {VK_LMENU, 0x00, 0}, {0}},
409         {WM_SYSKEYDOWN, 0}},
410     {VK_LCONTROL, 0, {{VK_CONTROL, 0x00, 0}, {VK_LCONTROL, 0x00, 0}, {0}},
411         {WM_KEYDOWN, 0}},
412     {'X', 0, {{'X', 0x00, 0}, {0}}, {WM_KEYDOWN, 0}},
413     {'X', KEYEVENTF_KEYUP, {{'X', 0x80, 0}, {0}}, {WM_KEYUP, 0}},
414     {VK_LCONTROL, KEYEVENTF_KEYUP,
415         {{VK_CONTROL, 0x80, 0}, {VK_LCONTROL, 0x80, 0}, {0}},
416         {WM_SYSKEYUP, 0}},
417     {VK_LMENU, KEYEVENTF_KEYUP, {{VK_MENU, 0x80, 0}, {VK_LMENU, 0x80, 0}, {0}},
418         {WM_KEYUP, 0}},
419
420     /* test SHIFT+A */
421     {VK_LSHIFT, 0,
422         {{VK_SHIFT, 0x00, 0}, {VK_LSHIFT, 0x00, 0}, {0}}, {WM_KEYDOWN, 0}},
423     {'A', 0, {{'A', 0x00, 0}, {0}}, {WM_KEYDOWN, WM_CHAR, 0}},
424     {'A', KEYEVENTF_KEYUP, {{'A', 0x80, 0}, {0}}, {WM_KEYUP, 0}},
425     {VK_LSHIFT, KEYEVENTF_KEYUP,
426         {{VK_SHIFT, 0x80, 0}, {VK_LSHIFT, 0x80, 0}, {0}}, {WM_KEYUP, 0}},
427
428     {0, 0, {{0}}, {0}} /* end */
429 };
430
431 static struct sendinput_test_s *pTest = sendinput_test;
432 static UINT *pMsg = sendinput_test[0].expected_messages;
433
434 /* Verify that only specified key state transitions occur */
435 static void compare_and_check(int id, BYTE *ks1, BYTE *ks2, struct transition_s *t) {
436     int i;
437     while (t->wVk) {
438         int matched = ((ks1[t->wVk]&0x80) == (t->before_state&0x80)
439                        && (ks2[t->wVk]&0x80) == (~t->before_state&0x80));
440         if (t->_todo_wine) {
441             todo_wine {
442                 ok(matched, "%02d: %02x from %02x -> %02x "
443                    "instead of %02x -> %02x\n", id, t->wVk,
444                    ks1[t->wVk]&0x80, ks2[t->wVk]&0x80, t->before_state,
445                    ~t->before_state&0x80);
446             }
447         } else {
448             ok(matched, "%02d: %02x from %02x -> %02x "
449                "instead of %02x -> %02x\n", id, t->wVk,
450                ks1[t->wVk]&0x80, ks2[t->wVk]&0x80, t->before_state,
451                ~t->before_state&0x80);
452         }
453         ks2[t->wVk] = ks1[t->wVk]; /* clear the match */
454         t++;
455     }
456     for (i = 0; i < 256; i++)
457         ok(ks2[i] == ks1[i], "%02d: %02x from %02x -> %02x unexpected\n",
458            id, i, ks1[i], ks2[i]);
459 }
460
461 /* WndProc2 checks that we get at least the messages specified */
462 static LRESULT CALLBACK WndProc2(HWND hWnd, UINT Msg, WPARAM wParam,
463                                    LPARAM lParam)
464 {
465     if (pTest->wVk != 0) { /* not end */
466         while(pTest->wVk != 0 && *pMsg == 0) {
467             pTest++;
468             pMsg = pTest->expected_messages;
469         }
470         if (Msg == *pMsg)
471             pMsg++;
472     }
473     return DefWindowProc(hWnd, Msg, wParam, lParam);
474 }
475
476 static void test_Input_blackbox(void)
477 {
478     TEST_INPUT i;
479     int ii;
480     BYTE ks1[256], ks2[256];
481     LONG_PTR prevWndProc;
482
483     HWND window;
484     window = CreateWindow("Static", NULL, WS_POPUP|WS_HSCROLL|WS_VSCROLL
485         |WS_VISIBLE, 0, 0, 200, 60, NULL, NULL,
486         NULL, NULL);
487     ok(window != NULL, "error: %d\n", (int) GetLastError());
488
489     /* must process all initial messages, otherwise X11DRV_KeymapNotify unsets
490      * key state set by SendInput(). */
491     empty_message_queue();
492
493     prevWndProc = SetWindowLongPtr(window, GWLP_WNDPROC, (LONG_PTR) WndProc2);
494     ok(prevWndProc != 0 || (prevWndProc == 0 && GetLastError() == 0),
495        "error: %d\n", (int) GetLastError());
496
497     i.type = INPUT_KEYBOARD;
498     i.u.ki.wScan = 0;
499     i.u.ki.time = 0;
500     i.u.ki.dwExtraInfo = 0;
501
502     for (ii = 0; ii < sizeof(sendinput_test)/sizeof(struct sendinput_test_s)-1;
503          ii++) {
504         GetKeyboardState(ks1);
505         i.u.ki.dwFlags = sendinput_test[ii].dwFlags;
506         i.u.ki.wVk = sendinput_test[ii].wVk;
507         SendInput(1, (INPUT*)&i, sizeof(TEST_INPUT));
508         empty_message_queue();
509         GetKeyboardState(ks2);
510         compare_and_check(ii, ks1, ks2,
511                           sendinput_test[ii].expected_transitions);
512     }
513
514     /* *pMsg should be 0 and (++pTest)->wVk should be 0 */
515     if (pTest->wVk && *pMsg == 0) pTest++;
516     while(pTest->wVk && pTest->expected_messages[0] == 0) {
517         ++pTest;
518     }
519     ok(*pMsg == 0 && pTest->wVk == 0,
520        "not enough messages found; looking for %x\n", *pMsg);
521     DestroyWindow(window);
522 }
523
524 static void test_keynames(void)
525 {
526     int i, len;
527     char buff[256];
528
529     for (i = 0; i < 512; i++)
530     {
531         strcpy(buff, "----");
532         len = GetKeyNameTextA(i << 16, buff, sizeof(buff));
533         ok(len || !buff[0], "%d: Buffer is not zeroed\n", i);
534     }
535 }
536
537 START_TEST(input)
538 {
539     test_Input_whitebox();
540     test_Input_blackbox();
541     test_keynames();
542 }