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