dlls/dinput/keyboard.c

   1 /*              DirectInput Keyboard device
   2  *
   3  * Copyright 1998 Marcus Meissner
   4  * Copyright 1998,1999 Lionel Ulmer
   5  * Copyright 2000-2001 TransGaming Technologies Inc.
   6  * Copyright 2005 Raphael Junqueira
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  21  */
  22
  23 #include "config.h"
  24 #include "wine/port.h"
  25
  26 #include <stdarg.h>
  27 #include <string.h>
  28 #include "windef.h"
  29 #include "winbase.h"
  30 #include "winuser.h"
  31 #include "winerror.h"
  32 #include "dinput.h"
  33
  34 #include "dinput_private.h"
  35 #include "device_private.h"
  36 #include "wine/debug.h"
  37 #include "wine/unicode.h"
  38
  39 WINE_DEFAULT_DEBUG_CHANNEL(dinput);
  40
  41 #define WINE_DINPUT_KEYBOARD_MAX_KEYS 256
  42
  43 static const IDirectInputDevice8WVtbl SysKeyboardWvt;
  44
  45 typedef struct SysKeyboardImpl SysKeyboardImpl;
  46 struct SysKeyboardImpl
  47 {
  48     struct IDirectInputDeviceImpl base;
  49     BYTE DInputKeyState[WINE_DINPUT_KEYBOARD_MAX_KEYS];
  50     DWORD subtype;
  51 };
  52
  53 static inline SysKeyboardImpl *impl_from_IDirectInputDevice8W(IDirectInputDevice8W *iface)
  54 {
  55     return CONTAINING_RECORD(CONTAINING_RECORD(iface, IDirectInputDeviceImpl, IDirectInputDevice8W_iface), SysKeyboardImpl, base);
  56 }
  57
  58 static BYTE map_dik_code(DWORD scanCode, DWORD vkCode, DWORD subType, DWORD version)
  59 {
  60     if (!scanCode && version < 0x0800)
  61         scanCode = MapVirtualKeyW(vkCode, MAPVK_VK_TO_VSC);
  62
  63     if (subType == DIDEVTYPEKEYBOARD_JAPAN106)
  64     {
  65         switch (scanCode)
  66         {
  67         case 0x0d: /* ^ */
  68             scanCode = DIK_CIRCUMFLEX;
  69             break;
  70         case 0x1a: /* @ */
  71             scanCode = DIK_AT;
  72             break;
  73         case 0x1b: /* [ */
  74             scanCode = DIK_LBRACKET;
  75             break;
  76         case 0x28: /* : */
  77             scanCode = DIK_COLON;
  78             break;
  79         case 0x29: /* Hankaku/Zenkaku */
  80             scanCode = DIK_KANJI;
  81             break;
  82         case 0x2b: /* ] */
  83             scanCode = DIK_RBRACKET;
  84             break;
  85         case 0x73: /* \ */
  86             scanCode = DIK_BACKSLASH;
  87             break;
  88         }
  89     }
  90     return scanCode;
  91 }
  92
  93 int dinput_keyboard_hook( IDirectInputDevice8W *iface, WPARAM wparam, LPARAM lparam )
  94 {
  95     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W( iface );
  96     int dik_code, ret = This->base.dwCoopLevel & DISCL_EXCLUSIVE;
  97     KBDLLHOOKSTRUCT *hook = (KBDLLHOOKSTRUCT *)lparam;
  98     BYTE new_diks;
  99
 100     if (wparam != WM_KEYDOWN && wparam != WM_KEYUP &&
 101         wparam != WM_SYSKEYDOWN && wparam != WM_SYSKEYUP)
 102         return 0;
 103
 104     TRACE("(%p) wp %08lx, lp %08lx, vk %02x, scan %02x\n",
 105           iface, wparam, lparam, hook->vkCode, hook->scanCode);
 106
 107     switch (hook->vkCode)
 108     {
 109         /* R-Shift is special - it is an extended key with separate scan code */
 110         case VK_RSHIFT  : dik_code = DIK_RSHIFT; break;
 111         case VK_PAUSE   : dik_code = DIK_PAUSE; break;
 112         case VK_NUMLOCK : dik_code = DIK_NUMLOCK; break;
 113         case VK_SUBTRACT: dik_code = DIK_SUBTRACT; break;
 114         default:
 115             dik_code = map_dik_code(hook->scanCode & 0xff, hook->vkCode, This->subtype, This->base.dinput->dwVersion);
 116             if (hook->flags & LLKHF_EXTENDED) dik_code |= 0x80;
 117     }
 118     new_diks = hook->flags & LLKHF_UP ? 0 : 0x80;
 119
 120     /* returns now if key event already known */
 121     if (new_diks == This->DInputKeyState[dik_code])
 122         return ret;
 123
 124     This->DInputKeyState[dik_code] = new_diks;
 125     TRACE(" setting %02X to %02X\n", dik_code, This->DInputKeyState[dik_code]);
 126
 127     EnterCriticalSection(&This->base.crit);
 128     queue_event(iface, DIDFT_MAKEINSTANCE(dik_code) | DIDFT_PSHBUTTON,
 129                 new_diks, GetCurrentTime(), This->base.dinput->evsequence++);
 130     LeaveCriticalSection(&This->base.crit);
 131
 132     return ret;
 133 }
 134
 135 static DWORD get_keyboard_subtype(void)
 136 {
 137     DWORD kbd_type, kbd_subtype, dev_subtype;
 138     kbd_type = GetKeyboardType(0);
 139     kbd_subtype = GetKeyboardType(1);
 140
 141     if (kbd_type == 4 || (kbd_type == 7 && kbd_subtype == 0))
 142         dev_subtype = DIDEVTYPEKEYBOARD_PCENH;
 143     else if (kbd_type == 7 && kbd_subtype == 2)
 144         dev_subtype = DIDEVTYPEKEYBOARD_JAPAN106;
 145     else {
 146         FIXME("Unknown keyboard type=%u, subtype=%u\n", kbd_type, kbd_subtype);
 147         dev_subtype = DIDEVTYPEKEYBOARD_PCENH;
 148     }
 149     return dev_subtype;
 150 }
 151
 152 static void fill_keyboard_dideviceinstanceW(LPDIDEVICEINSTANCEW lpddi, DWORD version, DWORD subtype) {
 153     DWORD dwSize;
 154     DIDEVICEINSTANCEW ddi;
 155
 156     dwSize = lpddi->dwSize;
 157
 158     TRACE("%d %p\n", dwSize, lpddi);
 159
 160     memset(lpddi, 0, dwSize);
 161     memset(&ddi, 0, sizeof(ddi));
 162
 163     ddi.dwSize = dwSize;
 164     ddi.guidInstance = GUID_SysKeyboard;/* DInput's GUID */
 165     ddi.guidProduct = GUID_SysKeyboard;
 166     if (version >= 0x0800)
 167         ddi.dwDevType = DI8DEVTYPE_KEYBOARD | (subtype << 8);
 168     else
 169         ddi.dwDevType = DIDEVTYPE_KEYBOARD | (subtype << 8);
 170     MultiByteToWideChar(CP_ACP, 0, "Keyboard", -1, ddi.tszInstanceName, MAX_PATH);
 171     MultiByteToWideChar(CP_ACP, 0, "Wine Keyboard", -1, ddi.tszProductName, MAX_PATH);
 172
 173     memcpy(lpddi, &ddi, (dwSize < sizeof(ddi) ? dwSize : sizeof(ddi)));
 174 }
 175
 176 static HRESULT keyboarddev_enum_device(DWORD dwDevType, DWORD dwFlags, LPDIDEVICEINSTANCEW lpddi, DWORD version, int id)
 177 {
 178   if (id != 0)
 179     return E_FAIL;
 180
 181   if (dwFlags & DIEDFL_FORCEFEEDBACK)
 182     return S_FALSE;
 183
 184   if ((dwDevType == 0) ||
 185       ((dwDevType == DIDEVTYPE_KEYBOARD) && (version < 0x0800)) ||
 186       (((dwDevType == DI8DEVCLASS_KEYBOARD) || (dwDevType == DI8DEVTYPE_KEYBOARD)) && (version >= 0x0800))) {
 187     TRACE("Enumerating the Keyboard device\n");
 188
 189     fill_keyboard_dideviceinstanceW(lpddi, version, get_keyboard_subtype());
 190
 191     return S_OK;
 192   }
 193
 194   return S_FALSE;
 195 }
 196
 197 static HRESULT alloc_device( REFGUID rguid, IDirectInputImpl *dinput, SysKeyboardImpl **out )
 198 {
 199     SysKeyboardImpl* newDevice;
 200     LPDIDATAFORMAT df = NULL;
 201     int i, idx = 0;
 202     HRESULT hr;
 203
 204     if (FAILED(hr = direct_input_device_alloc( sizeof(SysKeyboardImpl), &SysKeyboardWvt, rguid, dinput, (void **)&newDevice )))
 205         return hr;
 206     newDevice->base.crit.DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": SysKeyboardImpl*->base.crit");
 207
 208     newDevice->subtype = get_keyboard_subtype();
 209
 210     /* Create copy of default data format */
 211     if (!(df = HeapAlloc(GetProcessHeap(), 0, c_dfDIKeyboard.dwSize))) goto failed;
 212     memcpy(df, &c_dfDIKeyboard, c_dfDIKeyboard.dwSize);
 213     if (!(df->rgodf = HeapAlloc(GetProcessHeap(), 0, df->dwNumObjs * df->dwObjSize))) goto failed;
 214
 215     for (i = 0; i < df->dwNumObjs; i++)
 216     {
 217         char buf[MAX_PATH];
 218         BYTE dik_code;
 219
 220         if (!GetKeyNameTextA(((i & 0x7f) << 16) | ((i & 0x80) << 17), buf, sizeof(buf)))
 221             continue;
 222
 223         dik_code = map_dik_code(i, 0, newDevice->subtype, dinput->dwVersion);
 224         memcpy(&df->rgodf[idx], &c_dfDIKeyboard.rgodf[dik_code], df->dwObjSize);
 225         df->rgodf[idx++].dwType = DIDFT_MAKEINSTANCE(dik_code) | DIDFT_PSHBUTTON;
 226     }
 227     df->dwNumObjs = idx;
 228
 229     newDevice->base.data_format.wine_df = df;
 230
 231     *out = newDevice;
 232     return DI_OK;
 233
 234 failed:
 235     if (df) HeapFree(GetProcessHeap(), 0, df->rgodf);
 236     HeapFree(GetProcessHeap(), 0, df);
 237     HeapFree(GetProcessHeap(), 0, newDevice);
 238     return DIERR_OUTOFMEMORY;
 239 }
 240
 241 static HRESULT keyboarddev_create_device( IDirectInputImpl *dinput, REFGUID rguid, IDirectInputDevice8W **out )
 242 {
 243     TRACE( "%p %s %p\n", dinput, debugstr_guid( rguid ), out );
 244     *out = NULL;
 245
 246     if (IsEqualGUID(&GUID_SysKeyboard, rguid)) /* Wine Keyboard */
 247     {
 248         SysKeyboardImpl *This;
 249         HRESULT hr;
 250
 251         if (FAILED(hr = alloc_device( rguid, dinput, &This ))) return hr;
 252
 253         TRACE( "Created a Keyboard device (%p)\n", This );
 254
 255         *out = &This->base.IDirectInputDevice8W_iface;
 256         return DI_OK;
 257     }
 258
 259     return DIERR_DEVICENOTREG;
 260 }
 261
 262 const struct dinput_device keyboard_device = {
 263   "Wine keyboard driver",
 264   keyboarddev_enum_device,
 265   keyboarddev_create_device
 266 };
 267
 268 static HRESULT WINAPI SysKeyboardWImpl_GetDeviceState(LPDIRECTINPUTDEVICE8W iface, DWORD len, LPVOID ptr)
 269 {
 270     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W(iface);
 271     TRACE("(%p)->(%d,%p)\n", This, len, ptr);
 272
 273     if (!This->base.acquired) return DIERR_NOTACQUIRED;
 274
 275     if (len != This->base.data_format.user_df->dwDataSize )
 276         return DIERR_INVALIDPARAM;
 277
 278     check_dinput_events();
 279
 280     EnterCriticalSection(&This->base.crit);
 281
 282     if (TRACE_ON(dinput)) {
 283         int i;
 284         for (i = 0; i < WINE_DINPUT_KEYBOARD_MAX_KEYS; i++) {
 285             if (This->DInputKeyState[i] != 0x00)
 286                 TRACE(" - %02X: %02x\n", i, This->DInputKeyState[i]);
 287         }
 288     }
 289
 290     fill_DataFormat(ptr, len, This->DInputKeyState, &This->base.data_format);
 291     LeaveCriticalSection(&This->base.crit);
 292
 293     return DI_OK;
 294 }
 295
 296 /******************************************************************************
 297   *     GetCapabilities : get the device capabilities
 298   */
 299 static HRESULT WINAPI SysKeyboardWImpl_GetCapabilities(LPDIRECTINPUTDEVICE8W iface, LPDIDEVCAPS lpDIDevCaps)
 300 {
 301     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W(iface);
 302     DIDEVCAPS devcaps;
 303
 304     TRACE("(this=%p,%p)\n",This,lpDIDevCaps);
 305
 306     if ((lpDIDevCaps->dwSize != sizeof(DIDEVCAPS)) && (lpDIDevCaps->dwSize != sizeof(DIDEVCAPS_DX3))) {
 307         WARN("invalid parameter\n");
 308         return DIERR_INVALIDPARAM;
 309     }
 310
 311     devcaps.dwSize = lpDIDevCaps->dwSize;
 312     devcaps.dwFlags = DIDC_ATTACHED | DIDC_EMULATED;
 313     if (This->base.dinput->dwVersion >= 0x0800)
 314         devcaps.dwDevType = DI8DEVTYPE_KEYBOARD | (This->subtype << 8);
 315     else
 316         devcaps.dwDevType = DIDEVTYPE_KEYBOARD | (This->subtype << 8);
 317     devcaps.dwAxes = 0;
 318     devcaps.dwButtons = This->base.data_format.wine_df->dwNumObjs;
 319     devcaps.dwPOVs = 0;
 320     devcaps.dwFFSamplePeriod = 0;
 321     devcaps.dwFFMinTimeResolution = 0;
 322     devcaps.dwFirmwareRevision = 100;
 323     devcaps.dwHardwareRevision = 100;
 324     devcaps.dwFFDriverVersion = 0;
 325
 326     memcpy(lpDIDevCaps, &devcaps, lpDIDevCaps->dwSize);
 327
 328     return DI_OK;
 329 }
 330
 331 static DWORD map_dik_to_scan(DWORD dik_code, DWORD subtype)
 332 {
 333     if (dik_code == DIK_PAUSE || dik_code == DIK_NUMLOCK) dik_code ^= 0x80;
 334     if (subtype == DIDEVTYPEKEYBOARD_JAPAN106)
 335     {
 336         switch (dik_code)
 337         {
 338         case DIK_CIRCUMFLEX:
 339             dik_code = 0x0d;
 340             break;
 341         case DIK_AT:
 342             dik_code = 0x1a;
 343             break;
 344         case DIK_LBRACKET:
 345             dik_code = 0x1b;
 346             break;
 347         case DIK_COLON:
 348             dik_code = 0x28;
 349             break;
 350         case DIK_KANJI:
 351             dik_code = 0x29;
 352             break;
 353         case DIK_RBRACKET:
 354             dik_code = 0x2b;
 355             break;
 356         case DIK_BACKSLASH:
 357             dik_code = 0x73;
 358             break;
 359         }
 360     }
 361
 362     return dik_code;
 363 }
 364
 365 /******************************************************************************
 366   *     GetObjectInfo : get information about a device object such as a button
 367   *                     or axis
 368   */
 369 static HRESULT WINAPI SysKeyboardWImpl_GetObjectInfo(LPDIRECTINPUTDEVICE8W iface,
 370                                                      LPDIDEVICEOBJECTINSTANCEW pdidoi,
 371                                                      DWORD dwObj,
 372                                                      DWORD dwHow)
 373 {
 374     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W(iface);
 375     HRESULT res;
 376     LONG scan;
 377
 378     res = IDirectInputDevice2WImpl_GetObjectInfo(iface, pdidoi, dwObj, dwHow);
 379     if (res != DI_OK) return res;
 380
 381     scan = map_dik_to_scan(DIDFT_GETINSTANCE(pdidoi->dwType), This->subtype);
 382     if (!GetKeyNameTextW((scan & 0x80) << 17 | (scan & 0x7f) << 16,
 383                          pdidoi->tszName, ARRAY_SIZE(pdidoi->tszName)))
 384         return DIERR_OBJECTNOTFOUND;
 385
 386     _dump_OBJECTINSTANCEW(pdidoi);
 387     return res;
 388 }
 389
 390 /******************************************************************************
 391   *     GetDeviceInfo : get information about a device's identity
 392   */
 393 static HRESULT WINAPI SysKeyboardWImpl_GetDeviceInfo(LPDIRECTINPUTDEVICE8W iface, LPDIDEVICEINSTANCEW pdidi)
 394 {
 395     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W(iface);
 396     TRACE("(this=%p,%p)\n", This, pdidi);
 397
 398     if (pdidi->dwSize != sizeof(DIDEVICEINSTANCEW)) {
 399         WARN(" dinput3 not supported yet...\n");
 400         return DI_OK;
 401     }
 402
 403     fill_keyboard_dideviceinstanceW(pdidi, This->base.dinput->dwVersion, This->subtype);
 404
 405     return DI_OK;
 406 }
 407
 408 /******************************************************************************
 409  *      GetProperty : Retrieves information about the input device.
 410  */
 411 static HRESULT WINAPI SysKeyboardWImpl_GetProperty(LPDIRECTINPUTDEVICE8W iface,
 412                                                    REFGUID rguid, LPDIPROPHEADER pdiph)
 413 {
 414     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W(iface);
 415
 416     TRACE("(%p)->(%s,%p)\n", This, debugstr_guid(rguid), pdiph);
 417     _dump_DIPROPHEADER(pdiph);
 418
 419     if (!IS_DIPROP(rguid)) return DI_OK;
 420
 421     switch (LOWORD(rguid))
 422     {
 423         case (DWORD_PTR)DIPROP_KEYNAME:
 424         {
 425             HRESULT hr;
 426             LPDIPROPSTRING ps = (LPDIPROPSTRING)pdiph;
 427             DIDEVICEOBJECTINSTANCEW didoi;
 428
 429             if (pdiph->dwSize != sizeof(DIPROPSTRING))
 430                 return DIERR_INVALIDPARAM;
 431
 432             didoi.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW);
 433
 434             hr = SysKeyboardWImpl_GetObjectInfo(iface, &didoi, ps->diph.dwObj, ps->diph.dwHow);
 435             if (hr == DI_OK)
 436                 memcpy(ps->wsz, didoi.tszName, sizeof(ps->wsz));
 437             return hr;
 438         }
 439         case (DWORD_PTR) DIPROP_VIDPID:
 440         case (DWORD_PTR) DIPROP_RANGE:
 441             return DIERR_UNSUPPORTED;
 442         default:
 443             return IDirectInputDevice2WImpl_GetProperty( iface, rguid, pdiph );
 444     }
 445     return DI_OK;
 446 }
 447
 448 static HRESULT WINAPI SysKeyboardWImpl_Acquire(LPDIRECTINPUTDEVICE8W iface)
 449 {
 450     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W(iface);
 451     HRESULT res;
 452
 453     TRACE("(%p)\n", This);
 454
 455     res = IDirectInputDevice2WImpl_Acquire(iface);
 456     if (res == DI_OK)
 457     {
 458         TRACE("clearing keystate\n");
 459         memset(This->DInputKeyState, 0, sizeof(This->DInputKeyState));
 460     }
 461
 462     return res;
 463 }
 464
 465 static HRESULT WINAPI SysKeyboardWImpl_BuildActionMap(LPDIRECTINPUTDEVICE8W iface,
 466                                                       LPDIACTIONFORMATW lpdiaf,
 467                                                       LPCWSTR lpszUserName,
 468                                                       DWORD dwFlags)
 469 {
 470     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W(iface);
 471     FIXME("(%p)->(%p,%s,%08x): semi-stub !\n", This, lpdiaf, debugstr_w(lpszUserName), dwFlags);
 472
 473     return  _build_action_map(iface, lpdiaf, lpszUserName, dwFlags, DIKEYBOARD_MASK, &c_dfDIKeyboard);
 474 }
 475
 476 static HRESULT WINAPI SysKeyboardWImpl_SetActionMap(LPDIRECTINPUTDEVICE8W iface,
 477                                                     LPDIACTIONFORMATW lpdiaf,
 478                                                     LPCWSTR lpszUserName,
 479                                                     DWORD dwFlags)
 480 {
 481     SysKeyboardImpl *This = impl_from_IDirectInputDevice8W(iface);
 482     FIXME("(%p)->(%p,%s,%08x): semi-stub !\n", This, lpdiaf, debugstr_w(lpszUserName), dwFlags);
 483
 484     return _set_action_map(iface, lpdiaf, lpszUserName, dwFlags, &c_dfDIKeyboard);
 485 }
 486
 487 static const IDirectInputDevice8WVtbl SysKeyboardWvt =
 488 {
 489     IDirectInputDevice2WImpl_QueryInterface,
 490     IDirectInputDevice2WImpl_AddRef,
 491     IDirectInputDevice2WImpl_Release,
 492     SysKeyboardWImpl_GetCapabilities,
 493     IDirectInputDevice2WImpl_EnumObjects,
 494     SysKeyboardWImpl_GetProperty,
 495     IDirectInputDevice2WImpl_SetProperty,
 496     SysKeyboardWImpl_Acquire,
 497     IDirectInputDevice2WImpl_Unacquire,
 498     SysKeyboardWImpl_GetDeviceState,
 499     IDirectInputDevice2WImpl_GetDeviceData,
 500     IDirectInputDevice2WImpl_SetDataFormat,
 501     IDirectInputDevice2WImpl_SetEventNotification,
 502     IDirectInputDevice2WImpl_SetCooperativeLevel,
 503     SysKeyboardWImpl_GetObjectInfo,
 504     SysKeyboardWImpl_GetDeviceInfo,
 505     IDirectInputDevice2WImpl_RunControlPanel,
 506     IDirectInputDevice2WImpl_Initialize,
 507     IDirectInputDevice2WImpl_CreateEffect,
 508     IDirectInputDevice2WImpl_EnumEffects,
 509     IDirectInputDevice2WImpl_GetEffectInfo,
 510     IDirectInputDevice2WImpl_GetForceFeedbackState,
 511     IDirectInputDevice2WImpl_SendForceFeedbackCommand,
 512     IDirectInputDevice2WImpl_EnumCreatedEffectObjects,
 513     IDirectInputDevice2WImpl_Escape,
 514     IDirectInputDevice2WImpl_Poll,
 515     IDirectInputDevice2WImpl_SendDeviceData,
 516     IDirectInputDevice7WImpl_EnumEffectsInFile,
 517     IDirectInputDevice7WImpl_WriteEffectToFile,
 518     SysKeyboardWImpl_BuildActionMap,
 519     SysKeyboardWImpl_SetActionMap,
 520     IDirectInputDevice8WImpl_GetImageInfo
 521 };