git.oblomov.eu Git - wine/blob - dlls/dinput/keyboard/main.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  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with this library; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  */
  21
  22 #include "config.h"
  23 #include "wine/port.h"
  24
  25 #include <string.h>
  26 #include "winbase.h"
  27 #include "winuser.h"
  28 #include "winerror.h"
  29 #include "dinput.h"
  30
  31 #include "dinput_private.h"
  32 #include "device_private.h"
  33 #include "wine/debug.h"
  34
  35 WINE_DEFAULT_DEBUG_CHANNEL(dinput);
  36
  37 static ICOM_VTABLE(IDirectInputDevice8A) SysKeyboardAvt;
  38
  39 typedef struct SysKeyboardAImpl SysKeyboardAImpl;
  40 struct SysKeyboardAImpl
  41 {
  42         LPVOID                          lpVtbl;
  43         DWORD                           ref;
  44         GUID                            guid;
  45
  46         IDirectInputAImpl *dinput;
  47
  48         HANDLE  hEvent;
  49         /* SysKeyboardAImpl */
  50         int                             acquired;
  51         int                             buffersize;  /* set in 'SetProperty'         */
  52         LPDIDEVICEOBJECTDATA            buffer;      /* buffer for 'GetDeviceData'.
  53                                                         Alloc at 'Acquire', Free at
  54                                                         'Unacquire'                  */
  55         int                             count;       /* number of objects in use in
  56                                                         'buffer'                     */
  57         int                             start;       /* 'buffer' rotates. This is the
  58                                                         first in use (if count > 0)  */
  59         BOOL                            overflow;    /* return DI_BUFFEROVERFLOW in
  60                                                         'GetDeviceData'              */
  61         CRITICAL_SECTION                crit;
  62 };
  63
  64 SysKeyboardAImpl *current; /* Today's acquired device
  65 FIXME: currently this can be only one.
  66 Maybe this should be a linked list or st.
  67 I don't know what the rules are for multiple acquired keyboards,
  68 but 'DI_LOSTFOCUS' and 'DI_UNACQUIRED' exist for a reason.
  69 */
  70
  71 static BYTE DInputKeyState[256]; /* array for 'GetDeviceState' */
  72
  73 static CRITICAL_SECTION keyboard_crit = CRITICAL_SECTION_INIT("dinput_keyboard");
  74 static DWORD keyboard_users;
  75 static HHOOK keyboard_hook;
  76
  77 LRESULT CALLBACK KeyboardCallback( int code, WPARAM wparam, LPARAM lparam )
  78 {
  79   TRACE("(%d,%d,%ld)\n", code, wparam, lparam);
  80
  81   if (code == HC_ACTION)
  82     {
  83       BYTE dik_code;
  84       BOOL down;
  85       DWORD timestamp;
  86
  87       {
  88         KBDLLHOOKSTRUCT *hook = (KBDLLHOOKSTRUCT *)lparam;
  89         dik_code = hook->scanCode;
  90         if (hook->flags & LLKHF_EXTENDED) dik_code |= 0x80;
  91         down = !(hook->flags & LLKHF_UP);
  92         timestamp = hook->time;
  93       }
  94
  95       DInputKeyState[dik_code] = (down ? 0x80 : 0);
  96
  97       if (current != NULL)
  98         {
  99           if (current->hEvent)
 100             SetEvent(current->hEvent);
 101
 102           if (current->buffer != NULL)
 103             {
 104               int n;
 105
 106               EnterCriticalSection(&(current->crit));
 107
 108               n = (current->start + current->count) % current->buffersize;
 109
 110               current->buffer[n].dwOfs = dik_code;
 111               current->buffer[n].dwData = down ? 0x80 : 0;
 112               current->buffer[n].dwTimeStamp = timestamp;
 113               current->buffer[n].dwSequence = current->dinput->evsequence++;
 114
 115               TRACE("Adding event at offset %d : %ld - %ld - %ld - %ld\n", n,
 116                     current->buffer[n].dwOfs, current->buffer[n].dwData, current->buffer[n].dwTimeStamp, current->buffer[n].dwSequence);
 117
 118               if (current->count == current->buffersize)
 119                 {
 120                   current->start++;
 121                   current->overflow = TRUE;
 122                 }
 123               else
 124                 current->count++;
 125
 126               LeaveCriticalSection(&(current->crit));
 127             }
 128         }
 129     }
 130
 131   return CallNextHookEx(keyboard_hook, code, wparam, lparam);
 132 }
 133
 134 static GUID DInput_Wine_Keyboard_GUID = { /* 0ab8648a-7735-11d2-8c73-71df54a96441 */
 135   0x0ab8648a,
 136   0x7735,
 137   0x11d2,
 138   {0x8c, 0x73, 0x71, 0xdf, 0x54, 0xa9, 0x64, 0x41}
 139 };
 140
 141 static void fill_keyboard_dideviceinstancea(LPDIDEVICEINSTANCEA lpddi) {
 142     DWORD dwSize;
 143     DIDEVICEINSTANCEA ddi;
 144
 145     dwSize = lpddi->dwSize;
 146
 147     TRACE("%ld %p\n", dwSize, lpddi);
 148
 149     memset(lpddi, 0, dwSize);
 150     memset(&ddi, 0, sizeof(ddi));
 151
 152     ddi.dwSize = dwSize;
 153     ddi.guidInstance = GUID_SysKeyboard;/* DInput's GUID */
 154     ddi.guidProduct = DInput_Wine_Keyboard_GUID; /* Vendor's GUID */
 155     ddi.dwDevType = DIDEVTYPE_KEYBOARD | (DIDEVTYPEKEYBOARD_UNKNOWN << 8);
 156     strcpy(ddi.tszInstanceName, "Keyboard");
 157     strcpy(ddi.tszProductName, "Wine Keyboard");
 158
 159     memcpy(lpddi, &ddi, (dwSize < sizeof(ddi) ? dwSize : sizeof(ddi)));
 160 }
 161
 162 static BOOL keyboarddev_enum_device(DWORD dwDevType, DWORD dwFlags, LPDIDEVICEINSTANCEA lpddi)
 163 {
 164   if ((dwDevType == 0) || (dwDevType == DIDEVTYPE_KEYBOARD)) {
 165     TRACE("Enumerating the Keyboard device\n");
 166
 167     fill_keyboard_dideviceinstancea(lpddi);
 168
 169     return TRUE;
 170   }
 171
 172   return FALSE;
 173 }
 174
 175 static SysKeyboardAImpl *alloc_device(REFGUID rguid, LPVOID kvt, IDirectInputAImpl *dinput)
 176 {
 177     SysKeyboardAImpl* newDevice;
 178     newDevice = HeapAlloc(GetProcessHeap(),HEAP_ZERO_MEMORY,sizeof(SysKeyboardAImpl));
 179     newDevice->lpVtbl = kvt;
 180     newDevice->ref = 1;
 181     memcpy(&(newDevice->guid),rguid,sizeof(*rguid));
 182     newDevice->dinput = dinput;
 183
 184     EnterCriticalSection(&keyboard_crit);
 185     if (!keyboard_users++)
 186         keyboard_hook = SetWindowsHookExW( WH_KEYBOARD_LL, KeyboardCallback, DINPUT_instance, 0 );
 187     LeaveCriticalSection(&keyboard_crit);
 188
 189     return newDevice;
 190 }
 191
 192
 193 static HRESULT keyboarddev_create_device(IDirectInputAImpl *dinput, REFGUID rguid, REFIID riid, LPDIRECTINPUTDEVICEA* pdev)
 194 {
 195   if ((IsEqualGUID(&GUID_SysKeyboard,rguid)) ||          /* Generic Keyboard */
 196       (IsEqualGUID(&DInput_Wine_Keyboard_GUID,rguid))) { /* Wine Keyboard */
 197     if ((riid == NULL) ||
 198         IsEqualGUID(&IID_IDirectInputDeviceA,riid) ||
 199         IsEqualGUID(&IID_IDirectInputDevice2A,riid) ||
 200         IsEqualGUID(&IID_IDirectInputDevice7A,riid) ||
 201         IsEqualGUID(&IID_IDirectInputDevice8A,riid)) {
 202       *pdev=(IDirectInputDeviceA*) alloc_device(rguid, &SysKeyboardAvt, dinput);
 203       TRACE("Creating a Keyboard device (%p)\n", *pdev);
 204       return DI_OK;
 205     } else
 206       return DIERR_NOINTERFACE;
 207   }
 208
 209   return DIERR_DEVICENOTREG;
 210 }
 211
 212 static dinput_device keyboarddev = {
 213   100,
 214   keyboarddev_enum_device,
 215   keyboarddev_create_device
 216 };
 217
 218 DECL_GLOBAL_CONSTRUCTOR(keyboarddev_register) { dinput_register_device(&keyboarddev); }
 219
 220 static ULONG WINAPI SysKeyboardAImpl_Release(LPDIRECTINPUTDEVICE8A iface)
 221 {
 222         ICOM_THIS(SysKeyboardAImpl,iface);
 223
 224         This->ref--;
 225         if (This->ref)
 226                 return This->ref;
 227
 228         EnterCriticalSection(&keyboard_crit);
 229         if (!--keyboard_users) {
 230             UnhookWindowsHookEx( keyboard_hook );
 231             keyboard_hook = 0;
 232         }
 233         LeaveCriticalSection(&keyboard_crit);
 234
 235         /* Free the data queue */
 236         if (This->buffer != NULL)
 237           HeapFree(GetProcessHeap(),0,This->buffer);
 238
 239         DeleteCriticalSection(&(This->crit));
 240
 241         HeapFree(GetProcessHeap(),0,This);
 242         return 0;
 243 }
 244
 245 static HRESULT WINAPI SysKeyboardAImpl_SetProperty(
 246         LPDIRECTINPUTDEVICE8A iface,REFGUID rguid,LPCDIPROPHEADER ph
 247 )
 248 {
 249         ICOM_THIS(SysKeyboardAImpl,iface);
 250
 251         TRACE("(this=%p,%s,%p)\n",This,debugstr_guid(rguid),ph);
 252         TRACE("(size=%ld,headersize=%ld,obj=%ld,how=%ld\n",
 253             ph->dwSize,ph->dwHeaderSize,ph->dwObj,ph->dwHow);
 254         if (!HIWORD(rguid)) {
 255                 switch ((DWORD)rguid) {
 256                 case (DWORD) DIPROP_BUFFERSIZE: {
 257                         LPCDIPROPDWORD  pd = (LPCDIPROPDWORD)ph;
 258
 259                         TRACE("(buffersize=%ld)\n",pd->dwData);
 260
 261                         if (This->acquired)
 262                            return DIERR_INVALIDPARAM;
 263
 264                         This->buffersize = pd->dwData;
 265
 266                         break;
 267                 }
 268                 default:
 269                         WARN("Unknown type %ld\n",(DWORD)rguid);
 270                         break;
 271                 }
 272         }
 273         return 0;
 274 }
 275
 276 static HRESULT WINAPI SysKeyboardAImpl_GetDeviceState(
 277         LPDIRECTINPUTDEVICE8A iface,DWORD len,LPVOID ptr
 278 )
 279 {
 280     /* Note: device does not need to be acquired */
 281     if (len != 256)
 282       return DIERR_INVALIDPARAM;
 283
 284     memcpy(ptr, DInputKeyState, 256);
 285     return DI_OK;
 286 }
 287
 288 static HRESULT WINAPI SysKeyboardAImpl_GetDeviceData(
 289         LPDIRECTINPUTDEVICE8A iface,DWORD dodsize,LPDIDEVICEOBJECTDATA dod,
 290         LPDWORD entries,DWORD flags
 291 )
 292 {
 293         ICOM_THIS(SysKeyboardAImpl,iface);
 294         int ret = DI_OK, i = 0;
 295
 296         TRACE("(this=%p,%ld,%p,%p(%ld)),0x%08lx)\n",
 297               This,dodsize,dod,entries,entries?*entries:0,flags);
 298
 299         if (This->acquired == 0)
 300           return DIERR_NOTACQUIRED;
 301
 302         if (This->buffer == NULL)
 303           return DIERR_NOTBUFFERED;
 304
 305         if (dodsize < sizeof(*dod))
 306           return DIERR_INVALIDPARAM;
 307
 308         EnterCriticalSection(&(This->crit));
 309
 310         /* Copy item at a time for the case dodsize > sizeof(buffer[n]) */
 311         while ((i < *entries || *entries == INFINITE) && i < This->count)
 312           {
 313             if (dod != NULL)
 314               {
 315                 int n = (This->start + i) % This->buffersize;
 316                 LPDIDEVICEOBJECTDATA pd
 317                    = (LPDIDEVICEOBJECTDATA)((BYTE *)dod + dodsize * i);
 318                 pd->dwOfs       = This->buffer[n].dwOfs;
 319                 pd->dwData      = This->buffer[n].dwData;
 320                 pd->dwTimeStamp = This->buffer[n].dwTimeStamp;
 321                 pd->dwSequence  = This->buffer[n].dwSequence;
 322               }
 323             i++;
 324           }
 325
 326         *entries = i;
 327
 328         if (This->overflow)
 329           ret = DI_BUFFEROVERFLOW;
 330
 331         if (!(flags & DIGDD_PEEK))
 332           {
 333             /* Empty buffer */
 334             This->count -= i;
 335             This->start = (This->start + i) % This->buffersize;
 336             This->overflow = FALSE;
 337           }
 338
 339         LeaveCriticalSection(&(This->crit));
 340
 341         TRACE("Returning %ld events queued\n", *entries);
 342
 343         return ret;
 344 }
 345
 346 static HRESULT WINAPI SysKeyboardAImpl_EnumObjects(
 347         LPDIRECTINPUTDEVICE8A iface,
 348         LPDIENUMDEVICEOBJECTSCALLBACKA lpCallback,
 349         LPVOID lpvRef,
 350         DWORD dwFlags)
 351 {
 352     ICOM_THIS(SysKeyboardAImpl,iface);
 353     DIDEVICEOBJECTINSTANCEA ddoi;
 354     int i;
 355
 356     TRACE("(this=%p,%p,%p,%08lx)\n", This, lpCallback, lpvRef, dwFlags);
 357     if (TRACE_ON(dinput)) {
 358         TRACE("  - flags = ");
 359         _dump_EnumObjects_flags(dwFlags);
 360         TRACE("\n");
 361     }
 362
 363     /* Only the fields till dwFFMaxForce are relevant */
 364     memset(&ddoi, 0, sizeof(ddoi));
 365     ddoi.dwSize = FIELD_OFFSET(DIDEVICEOBJECTINSTANCEA, dwFFMaxForce);
 366
 367     for (i = 0; i < 256; i++) {
 368         /* Report 255 keys :-) */
 369         ddoi.guidType = GUID_Key;
 370         ddoi.dwOfs = i;
 371         ddoi.dwType = DIDFT_MAKEINSTANCE(i) | DIDFT_BUTTON;
 372         GetKeyNameTextA(((i & 0x7f) << 16) | ((i & 0x80) << 17), ddoi.tszName, sizeof(ddoi.tszName));
 373         _dump_OBJECTINSTANCEA(&ddoi);
 374         if (lpCallback(&ddoi, lpvRef) != DIENUM_CONTINUE) return DI_OK;
 375     }
 376
 377     return DI_OK;
 378 }
 379
 380 static HRESULT WINAPI SysKeyboardAImpl_Unacquire(LPDIRECTINPUTDEVICE8A iface);
 381
 382 static HRESULT WINAPI SysKeyboardAImpl_Acquire(LPDIRECTINPUTDEVICE8A iface)
 383 {
 384         ICOM_THIS(SysKeyboardAImpl,iface);
 385
 386         TRACE("(this=%p)\n",This);
 387
 388         if (This->acquired)
 389           return S_FALSE;
 390
 391         This->acquired = 1;
 392
 393         if (current != NULL)
 394           {
 395             FIXME("Not more than one keyboard can be acquired at the same time.\n");
 396             SysKeyboardAImpl_Unacquire(iface);
 397           }
 398
 399         current = This;
 400
 401         if (This->buffersize > 0)
 402           {
 403             This->buffer = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY,
 404                                      This->buffersize * sizeof(*(This->buffer)));
 405             This->start = 0;
 406             This->count = 0;
 407             This->overflow = FALSE;
 408             InitializeCriticalSection(&(This->crit));
 409           }
 410         else
 411           This->buffer = NULL;
 412
 413         return DI_OK;
 414 }
 415
 416 static HRESULT WINAPI SysKeyboardAImpl_Unacquire(LPDIRECTINPUTDEVICE8A iface)
 417 {
 418         ICOM_THIS(SysKeyboardAImpl,iface);
 419         TRACE("(this=%p)\n",This);
 420
 421         if (This->acquired == 0)
 422           return DI_NOEFFECT;
 423
 424         if (current == This)
 425           current = NULL;
 426         else
 427           ERR("this != current\n");
 428
 429         This->acquired = 0;
 430
 431         if (This->buffersize >= 0)
 432           {
 433             HeapFree(GetProcessHeap(), 0, This->buffer);
 434             This->buffer = NULL;
 435             DeleteCriticalSection(&(This->crit));
 436           }
 437
 438         return DI_OK;
 439 }
 440
 441 static HRESULT WINAPI SysKeyboardAImpl_SetEventNotification(LPDIRECTINPUTDEVICE8A iface,
 442                                                             HANDLE hnd) {
 443   ICOM_THIS(SysKeyboardAImpl,iface);
 444
 445   TRACE("(this=%p,0x%08lx)\n",This,(DWORD)hnd);
 446
 447   This->hEvent = hnd;
 448   return DI_OK;
 449 }
 450
 451 /******************************************************************************
 452   *     GetCapabilities : get the device capablitites
 453   */
 454 static HRESULT WINAPI SysKeyboardAImpl_GetCapabilities(
 455         LPDIRECTINPUTDEVICE8A iface,
 456         LPDIDEVCAPS lpDIDevCaps)
 457 {
 458   ICOM_THIS(SysKeyboardAImpl,iface);
 459
 460   TRACE("(this=%p,%p)\n",This,lpDIDevCaps);
 461
 462   if (lpDIDevCaps->dwSize == sizeof(DIDEVCAPS)) {
 463     lpDIDevCaps->dwFlags = DIDC_ATTACHED;
 464     lpDIDevCaps->dwDevType = DIDEVTYPE_KEYBOARD;
 465     lpDIDevCaps->dwAxes = 0;
 466     lpDIDevCaps->dwButtons = 256;
 467     lpDIDevCaps->dwPOVs = 0;
 468     lpDIDevCaps->dwFFSamplePeriod = 0;
 469     lpDIDevCaps->dwFFMinTimeResolution = 0;
 470     lpDIDevCaps->dwFirmwareRevision = 100;
 471     lpDIDevCaps->dwHardwareRevision = 100;
 472     lpDIDevCaps->dwFFDriverVersion = 0;
 473   } else {
 474     /* DirectX 3.0 */
 475     FIXME("DirectX 3.0 not supported....\n");
 476   }
 477
 478   return DI_OK;
 479 }
 480
 481 /******************************************************************************
 482   *     GetObjectInfo : get information about a device object such as a button
 483   *                     or axis
 484   */
 485 static HRESULT WINAPI
 486 SysKeyboardAImpl_GetObjectInfo(
 487         LPDIRECTINPUTDEVICE8A iface,
 488         LPDIDEVICEOBJECTINSTANCEA pdidoi,
 489         DWORD dwObj,
 490         DWORD dwHow)
 491 {
 492     ICOM_THIS(SysKeyboardAImpl,iface);
 493     DIDEVICEOBJECTINSTANCEA ddoi;
 494     DWORD dwSize = pdidoi->dwSize;
 495
 496     TRACE("(this=%p,%p,%ld,0x%08lx)\n", This, pdidoi, dwObj, dwHow);
 497
 498     if (dwHow == DIPH_BYID) {
 499         WARN(" querying by id not supported yet...\n");
 500         return DI_OK;
 501     }
 502
 503     memset(pdidoi, 0, dwSize);
 504     memset(&ddoi, 0, sizeof(ddoi));
 505
 506     ddoi.dwSize = dwSize;
 507     ddoi.guidType = GUID_Key;
 508     ddoi.dwOfs = dwObj;
 509     ddoi.dwType = DIDFT_MAKEINSTANCE(dwObj) | DIDFT_BUTTON;
 510     GetKeyNameTextA(((dwObj & 0x7f) << 16) | ((dwObj & 0x80) << 17), ddoi.tszName, sizeof(ddoi.tszName));
 511
 512     /* And return our just filled device object instance structure */
 513     memcpy(pdidoi, &ddoi, (dwSize < sizeof(ddoi) ? dwSize : sizeof(ddoi)));
 514
 515     _dump_OBJECTINSTANCEA(pdidoi);
 516
 517     return DI_OK;
 518 }
 519
 520 /******************************************************************************
 521   *     GetDeviceInfo : get information about a device's identity
 522   */
 523 static HRESULT WINAPI SysKeyboardAImpl_GetDeviceInfo(
 524         LPDIRECTINPUTDEVICE8A iface,
 525         LPDIDEVICEINSTANCEA pdidi)
 526 {
 527     ICOM_THIS(SysKeyboardAImpl,iface);
 528     TRACE("(this=%p,%p)\n", This, pdidi);
 529
 530     if (pdidi->dwSize != sizeof(DIDEVICEINSTANCEA)) {
 531         WARN(" dinput3 not supporte yet...\n");
 532         return DI_OK;
 533     }
 534
 535     fill_keyboard_dideviceinstancea(pdidi);
 536
 537     return DI_OK;
 538 }
 539
 540
 541 static ICOM_VTABLE(IDirectInputDevice8A) SysKeyboardAvt =
 542 {
 543         ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
 544         IDirectInputDevice2AImpl_QueryInterface,
 545         IDirectInputDevice2AImpl_AddRef,
 546         SysKeyboardAImpl_Release,
 547         SysKeyboardAImpl_GetCapabilities,
 548         SysKeyboardAImpl_EnumObjects,
 549         IDirectInputDevice2AImpl_GetProperty,
 550         SysKeyboardAImpl_SetProperty,
 551         SysKeyboardAImpl_Acquire,
 552         SysKeyboardAImpl_Unacquire,
 553         SysKeyboardAImpl_GetDeviceState,
 554         SysKeyboardAImpl_GetDeviceData,
 555         IDirectInputDevice2AImpl_SetDataFormat,
 556         SysKeyboardAImpl_SetEventNotification,
 557         IDirectInputDevice2AImpl_SetCooperativeLevel,
 558         SysKeyboardAImpl_GetObjectInfo,
 559         SysKeyboardAImpl_GetDeviceInfo,
 560         IDirectInputDevice2AImpl_RunControlPanel,
 561         IDirectInputDevice2AImpl_Initialize,
 562         IDirectInputDevice2AImpl_CreateEffect,
 563         IDirectInputDevice2AImpl_EnumEffects,
 564         IDirectInputDevice2AImpl_GetEffectInfo,
 565         IDirectInputDevice2AImpl_GetForceFeedbackState,
 566         IDirectInputDevice2AImpl_SendForceFeedbackCommand,
 567         IDirectInputDevice2AImpl_EnumCreatedEffectObjects,
 568         IDirectInputDevice2AImpl_Escape,
 569         IDirectInputDevice2AImpl_Poll,
 570         IDirectInputDevice2AImpl_SendDeviceData,
 571         IDirectInputDevice7AImpl_EnumEffectsInFile,
 572         IDirectInputDevice7AImpl_WriteEffectToFile,
 573         IDirectInputDevice8AImpl_BuildActionMap,
 574         IDirectInputDevice8AImpl_SetActionMap,
 575         IDirectInputDevice8AImpl_GetImageInfo
 576 };