git.oblomov.eu Git - wine/blob - 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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 "wine/test.h"
  50 #include "winbase.h"
  51 #include "winuser.h"
  52
  53 #include <assert.h>
  54
  55 /* globals */
  56 HWND hWndTest;
  57 long timetag = 0x10000000;
  58
  59 static UINT (WINAPI *ptr_SendInput) (UINT, INPUT*, size_t);
  60
  61 #define MAXKEYEVENTS 6
  62 #define MAXKEYMESSAGES MAXKEYEVENTS /* assuming a key event generates one
  63                                        and only one message */
  64
  65 /* keyboard message names, sorted as their value */
  66 static const char *MSGNAME[]={"WM_KEYDOWN", "WM_KEYUP", "WM_CHAR","WM_DEADCHAR",
  67     "WM_SYSKEYDOWN", "WM_SYSKEYUP", "WM_SYSCHAR", "WM_SYSDEADCHAR" ,"WM_KEYLAST"};
  68
  69 /* keyevents, add more as needed */
  70 typedef enum KEVtag
  71 {  ALTDOWN = 1, ALTUP, XDOWN, XUP, SHIFTDOWN, SHIFTUP, CTRLDOWN, CTRLUP } KEV;
  72 /* matching VK's */
  73 int GETVKEY[]={0, VK_MENU, VK_MENU, 'X', 'X', VK_SHIFT, VK_SHIFT, VK_CONTROL, VK_CONTROL};
  74 /* matching scan codes */
  75 int GETSCAN[]={0, 0x38, 0x38, 0x2D, 0x2D, 0x2A, 0x2A, 0x1D, 0x1D };
  76 /* matching updown events */
  77 int GETUPDOWN[]={0, 0, KEYEVENTF_KEYUP, 0, KEYEVENTF_KEYUP, 0, KEYEVENTF_KEYUP, 0, KEYEVENTF_KEYUP};
  78 /* matching descripts */
  79 char *getdesc[]={"", "+alt","-alt","+X","-X","+shift","-shift","+ctrl","-ctrl"};
  80
  81 /* The MSVC headers ignore our NONAMELESSUNION requests so we have to define our own type */
  82 typedef struct
  83 {
  84     DWORD type;
  85     union
  86     {
  87         MOUSEINPUT      mi;
  88         KEYBDINPUT      ki;
  89         HARDWAREINPUT   hi;
  90     } u;
  91 } TEST_INPUT;
  92
  93 #define ADDTOINPUTS(kev) \
  94 inputs[evtctr].type = INPUT_KEYBOARD; \
  95     ((TEST_INPUT*)inputs)[evtctr].u.ki.wVk = GETVKEY[ kev]; \
  96     ((TEST_INPUT*)inputs)[evtctr].u.ki.wScan = GETSCAN[ kev]; \
  97     ((TEST_INPUT*)inputs)[evtctr].u.ki.dwFlags = GETUPDOWN[ kev]; \
  98     ((TEST_INPUT*)inputs)[evtctr].u.ki.dwExtraInfo = 0; \
  99     ((TEST_INPUT*)inputs)[evtctr].u.ki.time = ++timetag; \
 100     if( kev) evtctr++;
 101
 102 typedef struct {
 103     UINT    message;
 104     WPARAM  wParam;
 105     LPARAM  lParam;
 106 } KMSG;
 107
 108 /*******************************************
 109  * add new test sets here
 110  * the software will make all combinations of the
 111  * keyevent defined here
 112  */
 113 struct { int nrkev;
 114     KEV keydwn[MAXKEYEVENTS];
 115     KEV keyup[MAXKEYEVENTS];
 116 } testkeyset[]= {
 117     { 2, { ALTDOWN, XDOWN }, { ALTUP, XUP}},
 118     { 3, { ALTDOWN, XDOWN , SHIFTDOWN}, { ALTUP, XUP, SHIFTUP}},
 119     { 3, { ALTDOWN, XDOWN , CTRLDOWN}, { ALTUP, XUP, CTRLUP}},
 120     { 3, { SHIFTDOWN, XDOWN , CTRLDOWN}, { SHIFTUP, XUP, CTRLUP}},
 121     { 0 } /* mark the end */
 122 };
 123
 124 /**********************adapted from input.c **********************************/
 125
 126 BYTE InputKeyStateTable[256];
 127 BYTE AsyncKeyStateTable[256];
 128 BYTE TrackSysKey = 0; /* determine whether ALT key up will cause a WM_SYSKEYUP
 129                          or a WM_KEYUP message */
 130 typedef union
 131 {
 132     struct
 133     {
 134         unsigned long count : 16;
 135         unsigned long code : 8;
 136         unsigned long extended : 1;
 137         unsigned long unused : 2;
 138         unsigned long win_internal : 2;
 139         unsigned long context : 1;
 140         unsigned long previous : 1;
 141         unsigned long transition : 1;
 142     } lp1;
 143     unsigned long lp2;
 144 } KEYLP;
 145
 146 int KbdMessage( KEV kev, WPARAM *pwParam, LPARAM *plParam )
 147 {
 148     UINT message;
 149     int VKey = GETVKEY[kev];
 150     KEYLP keylp;
 151
 152     keylp.lp2 = 0;
 153
 154     keylp.lp1.count = 1;
 155     keylp.lp1.code = GETSCAN[kev];
 156     keylp.lp1.extended = 0 ;/*  FIXME (ki->dwFlags & KEYEVENTF_EXTENDEDKEY) != 0; */
 157     keylp.lp1.win_internal = 0;
 158
 159     if (GETUPDOWN[kev] & KEYEVENTF_KEYUP )
 160     {
 161         message = WM_KEYUP;
 162         if( (InputKeyStateTable[VK_MENU] & 0x80) && (
 163                 (VKey == VK_MENU) || (VKey == VK_CONTROL) ||
 164                  !(InputKeyStateTable[VK_CONTROL] & 0x80))) {
 165             if(  TrackSysKey == VK_MENU || /* <ALT>-down/<ALT>-up sequence */
 166                     (VKey != VK_MENU)) /* <ALT>-down...<something else>-up */
 167                 message = WM_SYSKEYUP;
 168                 TrackSysKey = 0;
 169         }
 170         InputKeyStateTable[VKey] &= ~0x80;
 171         keylp.lp1.previous = 1;
 172         keylp.lp1.transition = 1;
 173     }
 174     else
 175     {
 176         keylp.lp1.previous = (InputKeyStateTable[VKey] & 0x80) != 0;
 177         keylp.lp1.transition = 0;
 178         if (!(InputKeyStateTable[VKey] & 0x80)) InputKeyStateTable[VKey] ^= 0x01;
 179         InputKeyStateTable[VKey] |= 0x80;
 180         AsyncKeyStateTable[VKey] |= 0x80;
 181
 182         message = WM_KEYDOWN;
 183         if( (InputKeyStateTable[VK_MENU] & 0x80) &&
 184                 !(InputKeyStateTable[VK_CONTROL] & 0x80)) {
 185             message = WM_SYSKEYDOWN;
 186             TrackSysKey = VKey;
 187         }
 188     }
 189
 190     keylp.lp1.context = (InputKeyStateTable[VK_MENU] & 0x80) != 0; /* 1 if alt */
 191
 192     if( plParam) *plParam = keylp.lp2;
 193     if( pwParam) *pwParam = VKey;
 194     return message;
 195 }
 196
 197 /****************************** end copy input.c ****************************/
 198
 199 /*
 200  * . prepare the keyevents for SendInputs
 201  * . calculate the "expected" messages
 202  * . Send the events to our window
 203  * . retrieve the messages from the input queue
 204  * . verify
 205  */
 206 void do_test( HWND hwnd, int seqnr, KEV td[] )
 207 {
 208     HMODULE module;
 209     INPUT inputs[MAXKEYEVENTS];
 210     KMSG expmsg[MAXKEYEVENTS];
 211     MSG msg;
 212     char buf[100];
 213     UINT evtctr=0;
 214     int kmctr, i;
 215
 216     module = GetModuleHandleA("user32");
 217     if (!module) return;
 218     ptr_SendInput = (void *)GetProcAddress(module, "SendInput");
 219     if (!ptr_SendInput) return;
 220
 221     buf[0]='\0';
 222     TrackSysKey=0; /* see input.c */
 223     for( i = 0; i < MAXKEYEVENTS; i++) {
 224         ADDTOINPUTS(td[i])
 225         strcat(buf, getdesc[td[i]]);
 226         if(td[i])
 227             expmsg[i].message = KbdMessage(td[i], &(expmsg[i].wParam), &(expmsg[i].lParam)); /* see queue_kbd_event() */
 228         else
 229             expmsg[i].message = 0;
 230     }
 231     for( kmctr = 0; kmctr < MAXKEYEVENTS && expmsg[kmctr].message; kmctr++)
 232         ;
 233     assert( evtctr <= MAXKEYEVENTS );
 234     assert( evtctr == ptr_SendInput(evtctr, &inputs[0], sizeof(INPUT)));
 235     i = 0;
 236     trace("======== key stroke sequence #%d: %s =============\n",
 237             seqnr + 1, buf);
 238     while( PeekMessage(&msg,hwnd,WM_KEYFIRST,WM_KEYLAST,PM_REMOVE) ) {
 239         trace("message[%d] %-15s wParam %04x lParam %08lx time %lx\n", i,
 240                 MSGNAME[msg.message - WM_KEYFIRST], msg.wParam, msg.lParam, msg.time);
 241         if( i < kmctr ) {
 242             ok( msg.message == expmsg[i].message &&
 243                     msg.wParam == expmsg[i].wParam &&
 244                     msg.lParam == expmsg[i].lParam,
 245                     "wrong message! expected:\n"
 246                     "message[%d] %-15s wParam %04x lParam %08lx\n",i,
 247                     MSGNAME[(expmsg[i]).message - WM_KEYFIRST],
 248                     expmsg[i].wParam, expmsg[i].lParam );
 249         }
 250         i++;
 251     }
 252     trace("%d messages retrieved\n", i);
 253     ok( i == kmctr, "message count is wrong: got %d expected: %d\n", i, kmctr);
 254 }
 255
 256 /* test all combinations of the specified key events */
 257 void TestASet( HWND hWnd, int nrkev, KEV kevdwn[], KEV kevup[] )
 258 {
 259     int i,j,k,l,m,n;
 260     static int count=0;
 261     KEV kbuf[MAXKEYEVENTS];
 262     assert( nrkev==2 || nrkev==3);
 263     for(i=0;i<MAXKEYEVENTS;i++) kbuf[i]=0;
 264     /* two keys involved gives 4 test cases */
 265     if(nrkev==2) {
 266         for(i=0;i<nrkev;i++) {
 267             for(j=0;j<nrkev;j++) {
 268                 kbuf[0] = kevdwn[i];
 269                 kbuf[1] = kevdwn[1-i];
 270                 kbuf[2] = kevup[j];
 271                 kbuf[3] = kevup[1-j];
 272                 do_test( hWnd, count++, kbuf);
 273             }
 274         }
 275     }
 276     /* three keys involved gives 36 test cases */
 277     if(nrkev==3){
 278         for(i=0;i<nrkev;i++){
 279             for(j=0;j<nrkev;j++){
 280                 if(j==i) continue;
 281                 for(k=0;k<nrkev;k++){
 282                     if(k==i || k==j) continue;
 283                     for(l=0;l<nrkev;l++){
 284                         for(m=0;m<nrkev;m++){
 285                             if(m==l) continue;
 286                             for(n=0;n<nrkev;n++){
 287                                 if(n==l ||n==m) continue;
 288                                 kbuf[0] = kevdwn[i];
 289                                 kbuf[1] = kevdwn[j];
 290                                 kbuf[2] = kevdwn[k];
 291                                 kbuf[3] = kevup[l];
 292                                 kbuf[4] = kevup[m];
 293                                 kbuf[5] = kevup[n];
 294                                 do_test( hWnd, count++, kbuf);
 295                             }
 296                         }
 297                     }
 298                 }
 299             }
 300         }
 301     }
 302 }
 303
 304 /* test each set specified in the global testkeyset array */
 305 void TestSysKeys( HWND hWnd)
 306 {
 307     int i;
 308     for(i=0; testkeyset[i].nrkev;i++)
 309         TestASet( hWnd, testkeyset[i].nrkev, testkeyset[i].keydwn,
 310                 testkeyset[i].keyup);
 311
 312 }
 313
 314 static LRESULT CALLBACK WndProc( HWND hWnd, UINT msg, WPARAM wParam,
 315         LPARAM lParam )
 316 {
 317     switch (msg) {
 318         case WM_SETFOCUS:
 319             /* window has focus, now do the test */
 320             if( hWnd == hWndTest) TestSysKeys( hWnd);
 321             /* finished :-) */
 322             DestroyWindow(hWnd);
 323             break;
 324
 325         case WM_DESTROY:
 326             PostQuitMessage( 0 );
 327             break;
 328
 329         default:
 330             return( DefWindowProcA( hWnd, msg, wParam, lParam ) );
 331     }
 332
 333     return 0;
 334 }
 335
 336 START_TEST(input)
 337 {
 338     MSG msg;
 339     WNDCLASSA  wclass;
 340     HANDLE hInstance = GetModuleHandleA( NULL );
 341
 342     wclass.lpszClassName = "InputSysKeyTestClass";
 343     wclass.style         = CS_HREDRAW | CS_VREDRAW;
 344     wclass.lpfnWndProc   = (WNDPROC)WndProc;
 345     wclass.hInstance     = hInstance;
 346     wclass.hIcon         = LoadIconA( 0, (LPSTR)IDI_APPLICATION );
 347     wclass.hCursor       = LoadCursorA( NULL, IDC_ARROW);
 348     wclass.hbrBackground = (HBRUSH)( COLOR_WINDOW + 1);
 349     wclass.lpszMenuName = 0;
 350     wclass.cbClsExtra    = 0;
 351     wclass.cbWndExtra    = 0;
 352     assert (RegisterClassA( &wclass ));
 353     /* create the test window that will receive the keystrokes */
 354     assert ( hWndTest = CreateWindowA( wclass.lpszClassName, "InputSysKeyTest",
 355                 WS_OVERLAPPEDWINDOW, CW_USEDEFAULT, 0, 100, 100,
 356                 NULL, NULL, hInstance, NULL) );
 357     ShowWindow( hWndTest, SW_SHOW);
 358     UpdateWindow( hWndTest);
 359     /* message loop */
 360     while( GetMessageA( &msg, 0, 0, 0 )) {
 361         TranslateMessage( &msg );
 362         DispatchMessageA( &msg );
 363     }
 364 }