1 /* DirectInput Keyboard device
3 * Copyright 1998 Marcus Meissner
4 * Copyright 1998,1999 Lionel Ulmer
5 * Copyright 2000-2001 TransGaming Technologies Inc.
6 * Copyright 2005 Raphael Junqueira
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.
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.
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
24 #include "wine/port.h"
34 #include "dinput_private.h"
35 #include "device_private.h"
36 #include "wine/debug.h"
37 #include "wine/unicode.h"
39 WINE_DEFAULT_DEBUG_CHANNEL(dinput);
41 #define WINE_DINPUT_KEYBOARD_MAX_KEYS 256
43 static const IDirectInputDevice8AVtbl SysKeyboardAvt;
44 static const IDirectInputDevice8WVtbl SysKeyboardWvt;
46 typedef struct SysKeyboardImpl SysKeyboardImpl;
47 struct SysKeyboardImpl
49 struct IDirectInputDevice2AImpl base;
50 BYTE DInputKeyState[WINE_DINPUT_KEYBOARD_MAX_KEYS];
53 static BYTE map_dik_code(DWORD scanCode, DWORD vkCode)
55 static const BYTE asciiCodes[] =
56 {/*32*/ DIK_SPACE,0,0,0,0,0,0,DIK_APOSTROPHE, \
57 /*40*/ 0,0,0,0,DIK_COMMA,DIK_MINUS,DIK_PERIOD,DIK_SLASH, \
58 /*48*/ DIK_0,DIK_1,DIK_2,DIK_3,DIK_4,DIK_5,DIK_6,DIK_7, \
59 /*56*/ DIK_8,DIK_9,DIK_COLON,DIK_SEMICOLON,0,DIK_EQUALS,0,0, \
60 /*64*/ DIK_AT,DIK_A,DIK_B,DIK_C,DIK_D,DIK_E,DIK_F,DIK_G, \
61 /*72*/ DIK_H,DIK_I,DIK_J,DIK_K,DIK_L,DIK_M,DIK_N,DIK_O, \
62 /*80*/ DIK_P,DIK_Q,DIK_R,DIK_S,DIK_T,DIK_U,DIK_V,DIK_W, \
63 /*88*/ DIK_X,DIK_Y,DIK_Z,DIK_LBRACKET,0,DIK_RBRACKET,DIK_CIRCUMFLEX,DIK_UNDERLINE} /*95*/ ;
66 WCHAR c = MapVirtualKeyW(vkCode,MAPVK_VK_TO_CHAR);
69 out_code = asciiCodes[c - 32];
77 static void KeyboardCallback( LPDIRECTINPUTDEVICE8A iface, WPARAM wparam, LPARAM lparam )
79 SysKeyboardImpl *This = (SysKeyboardImpl *)iface;
81 KBDLLHOOKSTRUCT *hook = (KBDLLHOOKSTRUCT *)lparam;
84 if (wparam != WM_KEYDOWN && wparam != WM_KEYUP &&
85 wparam != WM_SYSKEYDOWN && wparam != WM_SYSKEYUP)
88 TRACE("(%p) %ld,%ld\n", iface, wparam, lparam);
90 dik_code = map_dik_code(hook->scanCode & 0xff,hook->vkCode);
91 /* R-Shift is special - it is an extended key with separate scan code */
92 if (hook->flags & LLKHF_EXTENDED && dik_code != 0x36)
95 new_diks = hook->flags & LLKHF_UP ? 0 : 0x80;
97 /* returns now if key event already known */
98 if (new_diks == This->DInputKeyState[dik_code])
101 This->DInputKeyState[dik_code] = new_diks;
102 TRACE(" setting %02X to %02X\n", dik_code, This->DInputKeyState[dik_code]);
104 dik_code = id_to_offset(&This->base.data_format, DIDFT_MAKEINSTANCE(dik_code) | DIDFT_PSHBUTTON);
105 EnterCriticalSection(&This->base.crit);
106 queue_event((LPDIRECTINPUTDEVICE8A)This, dik_code, new_diks, hook->time, This->base.dinput->evsequence++);
107 LeaveCriticalSection(&This->base.crit);
110 const GUID DInput_Wine_Keyboard_GUID = { /* 0ab8648a-7735-11d2-8c73-71df54a96441 */
111 0x0ab8648a, 0x7735, 0x11d2, {0x8c, 0x73, 0x71, 0xdf, 0x54, 0xa9, 0x64, 0x41}
114 static void fill_keyboard_dideviceinstanceA(LPDIDEVICEINSTANCEA lpddi, DWORD version) {
116 DIDEVICEINSTANCEA ddi;
118 dwSize = lpddi->dwSize;
120 TRACE("%d %p\n", dwSize, lpddi);
122 memset(lpddi, 0, dwSize);
123 memset(&ddi, 0, sizeof(ddi));
126 ddi.guidInstance = GUID_SysKeyboard;/* DInput's GUID */
127 ddi.guidProduct = DInput_Wine_Keyboard_GUID; /* Vendor's GUID */
128 if (version >= 0x0800)
129 ddi.dwDevType = DI8DEVTYPE_KEYBOARD | (DI8DEVTYPEKEYBOARD_UNKNOWN << 8);
131 ddi.dwDevType = DIDEVTYPE_KEYBOARD | (DIDEVTYPEKEYBOARD_UNKNOWN << 8);
132 strcpy(ddi.tszInstanceName, "Keyboard");
133 strcpy(ddi.tszProductName, "Wine Keyboard");
135 memcpy(lpddi, &ddi, (dwSize < sizeof(ddi) ? dwSize : sizeof(ddi)));
138 static void fill_keyboard_dideviceinstanceW(LPDIDEVICEINSTANCEW lpddi, DWORD version) {
140 DIDEVICEINSTANCEW ddi;
142 dwSize = lpddi->dwSize;
144 TRACE("%d %p\n", dwSize, lpddi);
146 memset(lpddi, 0, dwSize);
147 memset(&ddi, 0, sizeof(ddi));
150 ddi.guidInstance = GUID_SysKeyboard;/* DInput's GUID */
151 ddi.guidProduct = DInput_Wine_Keyboard_GUID; /* Vendor's GUID */
152 if (version >= 0x0800)
153 ddi.dwDevType = DI8DEVTYPE_KEYBOARD | (DI8DEVTYPEKEYBOARD_UNKNOWN << 8);
155 ddi.dwDevType = DIDEVTYPE_KEYBOARD | (DIDEVTYPEKEYBOARD_UNKNOWN << 8);
156 MultiByteToWideChar(CP_ACP, 0, "Keyboard", -1, ddi.tszInstanceName, MAX_PATH);
157 MultiByteToWideChar(CP_ACP, 0, "Wine Keyboard", -1, ddi.tszProductName, MAX_PATH);
159 memcpy(lpddi, &ddi, (dwSize < sizeof(ddi) ? dwSize : sizeof(ddi)));
162 static BOOL keyboarddev_enum_deviceA(DWORD dwDevType, DWORD dwFlags, LPDIDEVICEINSTANCEA lpddi, DWORD version, int id)
167 if ((dwDevType == 0) ||
168 ((dwDevType == DIDEVTYPE_KEYBOARD) && (version < 0x0800)) ||
169 (((dwDevType == DI8DEVCLASS_KEYBOARD) || (dwDevType == DI8DEVTYPE_KEYBOARD)) && (version >= 0x0800))) {
170 TRACE("Enumerating the Keyboard device\n");
172 fill_keyboard_dideviceinstanceA(lpddi, version);
180 static BOOL keyboarddev_enum_deviceW(DWORD dwDevType, DWORD dwFlags, LPDIDEVICEINSTANCEW lpddi, DWORD version, int id)
185 if ((dwDevType == 0) ||
186 ((dwDevType == DIDEVTYPE_KEYBOARD) && (version < 0x0800)) ||
187 (((dwDevType == DI8DEVCLASS_KEYBOARD) || (dwDevType == DI8DEVTYPE_KEYBOARD)) && (version >= 0x0800))) {
188 TRACE("Enumerating the Keyboard device\n");
190 fill_keyboard_dideviceinstanceW(lpddi, version);
198 static SysKeyboardImpl *alloc_device(REFGUID rguid, const void *kvt, IDirectInputImpl *dinput)
200 SysKeyboardImpl* newDevice;
201 LPDIDATAFORMAT df = NULL;
204 newDevice = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(SysKeyboardImpl));
205 newDevice->base.lpVtbl = kvt;
206 newDevice->base.ref = 1;
207 memcpy(&newDevice->base.guid, rguid, sizeof(*rguid));
208 newDevice->base.dinput = dinput;
209 newDevice->base.event_proc = KeyboardCallback;
210 InitializeCriticalSection(&newDevice->base.crit);
211 newDevice->base.crit.DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": SysKeyboardImpl*->base.crit");
213 /* Create copy of default data format */
214 if (!(df = HeapAlloc(GetProcessHeap(), 0, c_dfDIKeyboard.dwSize))) goto failed;
215 memcpy(df, &c_dfDIKeyboard, c_dfDIKeyboard.dwSize);
216 if (!(df->rgodf = HeapAlloc(GetProcessHeap(), 0, df->dwNumObjs * df->dwObjSize))) goto failed;
218 for (i = 0; i < df->dwNumObjs; i++)
222 if (!GetKeyNameTextA(((i & 0x7f) << 16) | ((i & 0x80) << 17), buf, sizeof(buf)))
225 memcpy(&df->rgodf[idx], &c_dfDIKeyboard.rgodf[i], df->dwObjSize);
226 df->rgodf[idx++].dwType = DIDFT_MAKEINSTANCE(i) | DIDFT_PSHBUTTON;
230 newDevice->base.data_format.wine_df = df;
231 IDirectInput_AddRef((LPDIRECTINPUTDEVICE8A)newDevice->base.dinput);
235 if (df) HeapFree(GetProcessHeap(), 0, df->rgodf);
236 HeapFree(GetProcessHeap(), 0, df);
237 HeapFree(GetProcessHeap(), 0, newDevice);
242 static HRESULT keyboarddev_create_deviceA(IDirectInputImpl *dinput, REFGUID rguid, REFIID riid, LPDIRECTINPUTDEVICEA* pdev)
244 if ((IsEqualGUID(&GUID_SysKeyboard,rguid)) || /* Generic Keyboard */
245 (IsEqualGUID(&DInput_Wine_Keyboard_GUID,rguid))) { /* Wine Keyboard */
246 if ((riid == NULL) ||
247 IsEqualGUID(&IID_IDirectInputDeviceA,riid) ||
248 IsEqualGUID(&IID_IDirectInputDevice2A,riid) ||
249 IsEqualGUID(&IID_IDirectInputDevice7A,riid) ||
250 IsEqualGUID(&IID_IDirectInputDevice8A,riid)) {
251 *pdev = (IDirectInputDeviceA*) alloc_device(rguid, &SysKeyboardAvt, dinput);
252 TRACE("Creating a Keyboard device (%p)\n", *pdev);
253 if (!*pdev) return DIERR_OUTOFMEMORY;
256 return DIERR_NOINTERFACE;
258 return DIERR_DEVICENOTREG;
261 static HRESULT keyboarddev_create_deviceW(IDirectInputImpl *dinput, REFGUID rguid, REFIID riid, LPDIRECTINPUTDEVICEW* pdev)
263 if ((IsEqualGUID(&GUID_SysKeyboard,rguid)) || /* Generic Keyboard */
264 (IsEqualGUID(&DInput_Wine_Keyboard_GUID,rguid))) { /* Wine Keyboard */
265 if ((riid == NULL) ||
266 IsEqualGUID(&IID_IDirectInputDeviceW,riid) ||
267 IsEqualGUID(&IID_IDirectInputDevice2W,riid) ||
268 IsEqualGUID(&IID_IDirectInputDevice7W,riid) ||
269 IsEqualGUID(&IID_IDirectInputDevice8W,riid)) {
270 *pdev = (IDirectInputDeviceW*) alloc_device(rguid, &SysKeyboardWvt, dinput);
271 TRACE("Creating a Keyboard device (%p)\n", *pdev);
272 if (!*pdev) return DIERR_OUTOFMEMORY;
275 return DIERR_NOINTERFACE;
277 return DIERR_DEVICENOTREG;
280 const struct dinput_device keyboard_device = {
281 "Wine keyboard driver",
282 keyboarddev_enum_deviceA,
283 keyboarddev_enum_deviceW,
284 keyboarddev_create_deviceA,
285 keyboarddev_create_deviceW
288 static HRESULT WINAPI SysKeyboardAImpl_GetDeviceState(
289 LPDIRECTINPUTDEVICE8A iface,DWORD len,LPVOID ptr
292 SysKeyboardImpl *This = (SysKeyboardImpl *)iface;
293 TRACE("(%p)->(%d,%p)\n", This, len, ptr);
295 if (!This->base.acquired) return DIERR_NOTACQUIRED;
297 if (len != This->base.data_format.user_df->dwDataSize )
298 return DIERR_INVALIDPARAM;
300 EnterCriticalSection(&This->base.crit);
302 if (TRACE_ON(dinput)) {
304 for (i = 0; i < WINE_DINPUT_KEYBOARD_MAX_KEYS; i++) {
305 if (This->DInputKeyState[i] != 0x00)
306 TRACE(" - %02X: %02x\n", i, This->DInputKeyState[i]);
310 fill_DataFormat(ptr, len, This->DInputKeyState, &This->base.data_format);
311 LeaveCriticalSection(&This->base.crit);
316 /******************************************************************************
317 * GetCapabilities : get the device capabilities
319 static HRESULT WINAPI SysKeyboardAImpl_GetCapabilities(
320 LPDIRECTINPUTDEVICE8A iface,
321 LPDIDEVCAPS lpDIDevCaps)
323 SysKeyboardImpl *This = (SysKeyboardImpl *)iface;
326 TRACE("(this=%p,%p)\n",This,lpDIDevCaps);
328 if ((lpDIDevCaps->dwSize != sizeof(DIDEVCAPS)) && (lpDIDevCaps->dwSize != sizeof(DIDEVCAPS_DX3))) {
329 WARN("invalid parameter\n");
330 return DIERR_INVALIDPARAM;
333 devcaps.dwSize = lpDIDevCaps->dwSize;
334 devcaps.dwFlags = DIDC_ATTACHED;
335 if (This->base.dinput->dwVersion >= 0x0800)
336 devcaps.dwDevType = DI8DEVTYPE_KEYBOARD | (DI8DEVTYPEKEYBOARD_UNKNOWN << 8);
338 devcaps.dwDevType = DIDEVTYPE_KEYBOARD | (DIDEVTYPEKEYBOARD_UNKNOWN << 8);
340 devcaps.dwButtons = This->base.data_format.wine_df->dwNumObjs;
342 devcaps.dwFFSamplePeriod = 0;
343 devcaps.dwFFMinTimeResolution = 0;
344 devcaps.dwFirmwareRevision = 100;
345 devcaps.dwHardwareRevision = 100;
346 devcaps.dwFFDriverVersion = 0;
348 memcpy(lpDIDevCaps, &devcaps, lpDIDevCaps->dwSize);
353 /******************************************************************************
354 * GetObjectInfo : get information about a device object such as a button
357 static HRESULT WINAPI
358 SysKeyboardAImpl_GetObjectInfo(
359 LPDIRECTINPUTDEVICE8A iface,
360 LPDIDEVICEOBJECTINSTANCEA pdidoi,
366 res = IDirectInputDevice2AImpl_GetObjectInfo(iface, pdidoi, dwObj, dwHow);
367 if (res != DI_OK) return res;
369 if (!GetKeyNameTextA((DIDFT_GETINSTANCE(pdidoi->dwType) & 0x80) << 17 |
370 (DIDFT_GETINSTANCE(pdidoi->dwType) & 0x7f) << 16,
371 pdidoi->tszName, sizeof(pdidoi->tszName)))
372 return DIERR_OBJECTNOTFOUND;
374 _dump_OBJECTINSTANCEA(pdidoi);
378 static HRESULT WINAPI SysKeyboardWImpl_GetObjectInfo(LPDIRECTINPUTDEVICE8W iface,
379 LPDIDEVICEOBJECTINSTANCEW pdidoi,
385 res = IDirectInputDevice2WImpl_GetObjectInfo(iface, pdidoi, dwObj, dwHow);
386 if (res != DI_OK) return res;
388 if (!GetKeyNameTextW((DIDFT_GETINSTANCE(pdidoi->dwType) & 0x80) << 17 |
389 (DIDFT_GETINSTANCE(pdidoi->dwType) & 0x7f) << 16,
391 sizeof(pdidoi->tszName)/sizeof(pdidoi->tszName[0])))
392 return DIERR_OBJECTNOTFOUND;
394 _dump_OBJECTINSTANCEW(pdidoi);
398 /******************************************************************************
399 * GetDeviceInfo : get information about a device's identity
401 static HRESULT WINAPI SysKeyboardAImpl_GetDeviceInfo(
402 LPDIRECTINPUTDEVICE8A iface,
403 LPDIDEVICEINSTANCEA pdidi)
405 SysKeyboardImpl *This = (SysKeyboardImpl *)iface;
406 TRACE("(this=%p,%p)\n", This, pdidi);
408 if (pdidi->dwSize != sizeof(DIDEVICEINSTANCEA)) {
409 WARN(" dinput3 not supported yet...\n");
413 fill_keyboard_dideviceinstanceA(pdidi, This->base.dinput->dwVersion);
418 static HRESULT WINAPI SysKeyboardWImpl_GetDeviceInfo(LPDIRECTINPUTDEVICE8W iface, LPDIDEVICEINSTANCEW pdidi)
420 SysKeyboardImpl *This = (SysKeyboardImpl *)iface;
421 TRACE("(this=%p,%p)\n", This, pdidi);
423 if (pdidi->dwSize != sizeof(DIDEVICEINSTANCEW)) {
424 WARN(" dinput3 not supported yet...\n");
428 fill_keyboard_dideviceinstanceW(pdidi, This->base.dinput->dwVersion);
433 static const IDirectInputDevice8AVtbl SysKeyboardAvt =
435 IDirectInputDevice2AImpl_QueryInterface,
436 IDirectInputDevice2AImpl_AddRef,
437 IDirectInputDevice2AImpl_Release,
438 SysKeyboardAImpl_GetCapabilities,
439 IDirectInputDevice2AImpl_EnumObjects,
440 IDirectInputDevice2AImpl_GetProperty,
441 IDirectInputDevice2AImpl_SetProperty,
442 IDirectInputDevice2AImpl_Acquire,
443 IDirectInputDevice2AImpl_Unacquire,
444 SysKeyboardAImpl_GetDeviceState,
445 IDirectInputDevice2AImpl_GetDeviceData,
446 IDirectInputDevice2AImpl_SetDataFormat,
447 IDirectInputDevice2AImpl_SetEventNotification,
448 IDirectInputDevice2AImpl_SetCooperativeLevel,
449 SysKeyboardAImpl_GetObjectInfo,
450 SysKeyboardAImpl_GetDeviceInfo,
451 IDirectInputDevice2AImpl_RunControlPanel,
452 IDirectInputDevice2AImpl_Initialize,
453 IDirectInputDevice2AImpl_CreateEffect,
454 IDirectInputDevice2AImpl_EnumEffects,
455 IDirectInputDevice2AImpl_GetEffectInfo,
456 IDirectInputDevice2AImpl_GetForceFeedbackState,
457 IDirectInputDevice2AImpl_SendForceFeedbackCommand,
458 IDirectInputDevice2AImpl_EnumCreatedEffectObjects,
459 IDirectInputDevice2AImpl_Escape,
460 IDirectInputDevice2AImpl_Poll,
461 IDirectInputDevice2AImpl_SendDeviceData,
462 IDirectInputDevice7AImpl_EnumEffectsInFile,
463 IDirectInputDevice7AImpl_WriteEffectToFile,
464 IDirectInputDevice8AImpl_BuildActionMap,
465 IDirectInputDevice8AImpl_SetActionMap,
466 IDirectInputDevice8AImpl_GetImageInfo
469 #if !defined(__STRICT_ANSI__) && defined(__GNUC__)
470 # define XCAST(fun) (typeof(SysKeyboardWvt.fun))
472 # define XCAST(fun) (void*)
475 static const IDirectInputDevice8WVtbl SysKeyboardWvt =
477 IDirectInputDevice2WImpl_QueryInterface,
478 XCAST(AddRef)IDirectInputDevice2AImpl_AddRef,
479 XCAST(Release)IDirectInputDevice2AImpl_Release,
480 XCAST(GetCapabilities)SysKeyboardAImpl_GetCapabilities,
481 IDirectInputDevice2WImpl_EnumObjects,
482 XCAST(GetProperty)IDirectInputDevice2AImpl_GetProperty,
483 XCAST(SetProperty)IDirectInputDevice2AImpl_SetProperty,
484 XCAST(Acquire)IDirectInputDevice2AImpl_Acquire,
485 XCAST(Unacquire)IDirectInputDevice2AImpl_Unacquire,
486 XCAST(GetDeviceState)SysKeyboardAImpl_GetDeviceState,
487 XCAST(GetDeviceData)IDirectInputDevice2AImpl_GetDeviceData,
488 XCAST(SetDataFormat)IDirectInputDevice2AImpl_SetDataFormat,
489 XCAST(SetEventNotification)IDirectInputDevice2AImpl_SetEventNotification,
490 XCAST(SetCooperativeLevel)IDirectInputDevice2AImpl_SetCooperativeLevel,
491 SysKeyboardWImpl_GetObjectInfo,
492 SysKeyboardWImpl_GetDeviceInfo,
493 XCAST(RunControlPanel)IDirectInputDevice2AImpl_RunControlPanel,
494 XCAST(Initialize)IDirectInputDevice2AImpl_Initialize,
495 XCAST(CreateEffect)IDirectInputDevice2AImpl_CreateEffect,
496 IDirectInputDevice2WImpl_EnumEffects,
497 IDirectInputDevice2WImpl_GetEffectInfo,
498 XCAST(GetForceFeedbackState)IDirectInputDevice2AImpl_GetForceFeedbackState,
499 XCAST(SendForceFeedbackCommand)IDirectInputDevice2AImpl_SendForceFeedbackCommand,
500 XCAST(EnumCreatedEffectObjects)IDirectInputDevice2AImpl_EnumCreatedEffectObjects,
501 XCAST(Escape)IDirectInputDevice2AImpl_Escape,
502 XCAST(Poll)IDirectInputDevice2AImpl_Poll,
503 XCAST(SendDeviceData)IDirectInputDevice2AImpl_SendDeviceData,
504 IDirectInputDevice7WImpl_EnumEffectsInFile,
505 IDirectInputDevice7WImpl_WriteEffectToFile,
506 IDirectInputDevice8WImpl_BuildActionMap,
507 IDirectInputDevice8WImpl_SetActionMap,
508 IDirectInputDevice8WImpl_GetImageInfo