wine/dlls/dinput/mouse.c

570 lines
19 KiB
C

/* DirectInput Mouse device
*
* Copyright 1998 Marcus Meissner
* Copyright 1998,1999 Lionel Ulmer
* Copyright 2000-2001 TransGaming Technologies Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
*/
#include <stdarg.h>
#include <string.h>
#include "windef.h"
#include "winbase.h"
#include "wingdi.h"
#include "winternl.h"
#include "winuser.h"
#include "winerror.h"
#include "winreg.h"
#include "dinput.h"
#include "dinput_private.h"
#include "device_private.h"
#include "wine/debug.h"
WINE_DEFAULT_DEBUG_CHANNEL(dinput);
static const struct dinput_device_vtbl mouse_vtbl;
typedef enum
{
WARP_DEFAULT,
WARP_DISABLE,
WARP_FORCE_ON
} WARP_MOUSE;
struct mouse
{
struct dinput_device base;
/* These are used in case of relative -> absolute transitions */
POINT org_coords;
BOOL clipped;
/* warping: whether we need to move mouse back to middle once we
* reach window borders (for e.g. shooters, "surface movement" games) */
BOOL need_warp;
DWORD last_warped;
WARP_MOUSE warp_override;
};
static inline struct mouse *impl_from_IDirectInputDevice8W( IDirectInputDevice8W *iface )
{
return CONTAINING_RECORD( CONTAINING_RECORD( iface, struct dinput_device, IDirectInputDevice8W_iface ), struct mouse, base );
}
HRESULT mouse_enum_device( DWORD type, DWORD flags, DIDEVICEINSTANCEW *instance, DWORD version )
{
DWORD size;
TRACE( "type %#lx, flags %#lx, instance %p, version %#lx\n", type, flags, instance, version );
size = instance->dwSize;
memset( instance, 0, size );
instance->dwSize = size;
instance->guidInstance = GUID_SysMouse;
instance->guidProduct = GUID_SysMouse;
if (version >= 0x0800) instance->dwDevType = DI8DEVTYPE_MOUSE | (DI8DEVTYPEMOUSE_TRADITIONAL << 8);
else instance->dwDevType = DIDEVTYPE_MOUSE | (DIDEVTYPEMOUSE_TRADITIONAL << 8);
MultiByteToWideChar( CP_ACP, 0, "Mouse", -1, instance->tszInstanceName, MAX_PATH );
MultiByteToWideChar( CP_ACP, 0, "Wine Mouse", -1, instance->tszProductName, MAX_PATH );
return DI_OK;
}
static BOOL init_object_properties( struct dinput_device *device, UINT index, struct hid_value_caps *caps,
const DIDEVICEOBJECTINSTANCEW *instance, void *data )
{
struct object_properties *properties;
if (index == -1) return DIENUM_STOP;
properties = device->object_properties + index;
/* The z-axis (wheel) has a different granularity */
if (instance->dwOfs == DIMOFS_Z) properties->granularity = WHEEL_DELTA;
return DIENUM_CONTINUE;
}
void dinput_mouse_rawinput_hook( IDirectInputDevice8W *iface, WPARAM wparam, LPARAM lparam, RAWINPUT *ri )
{
struct mouse *impl = impl_from_IDirectInputDevice8W( iface );
DIMOUSESTATE2 *state = (DIMOUSESTATE2 *)impl->base.device_state;
POINT rel, pt;
DWORD seq;
BOOL notify = FALSE;
int i;
static const USHORT mouse_button_flags[] =
{
RI_MOUSE_BUTTON_1_DOWN, RI_MOUSE_BUTTON_1_UP,
RI_MOUSE_BUTTON_2_DOWN, RI_MOUSE_BUTTON_2_UP,
RI_MOUSE_BUTTON_3_DOWN, RI_MOUSE_BUTTON_3_UP,
RI_MOUSE_BUTTON_4_DOWN, RI_MOUSE_BUTTON_4_UP,
RI_MOUSE_BUTTON_5_DOWN, RI_MOUSE_BUTTON_5_UP
};
TRACE( "iface %p, wparam %#Ix, lparam %#Ix, ri %p.\n", iface, wparam, lparam, ri );
if (ri->data.mouse.usFlags & MOUSE_VIRTUAL_DESKTOP)
FIXME( "Unimplemented MOUSE_VIRTUAL_DESKTOP flag\n" );
if (ri->data.mouse.usFlags & MOUSE_ATTRIBUTES_CHANGED)
FIXME( "Unimplemented MOUSE_ATTRIBUTES_CHANGED flag\n" );
EnterCriticalSection( &impl->base.crit );
seq = impl->base.dinput->evsequence++;
rel.x = ri->data.mouse.lLastX;
rel.y = ri->data.mouse.lLastY;
if (ri->data.mouse.usFlags & MOUSE_MOVE_ABSOLUTE)
{
GetCursorPos( &pt );
rel.x -= pt.x;
rel.y -= pt.y;
}
state->lX += rel.x;
state->lY += rel.y;
if (impl->base.user_format.dwFlags & DIDF_ABSAXIS)
{
pt.x = state->lX;
pt.y = state->lY;
}
else
{
pt = rel;
}
if (rel.x)
{
queue_event( iface, 0, pt.x, GetCurrentTime(), seq );
notify = TRUE;
}
if (rel.y)
{
queue_event( iface, 1, pt.y, GetCurrentTime(), seq );
notify = TRUE;
}
if (rel.x || rel.y)
{
if ((impl->warp_override == WARP_FORCE_ON) ||
(impl->warp_override != WARP_DISABLE && (impl->base.dwCoopLevel & DISCL_EXCLUSIVE)))
impl->need_warp = TRUE;
}
if (ri->data.mouse.usButtonFlags & RI_MOUSE_WHEEL)
{
state->lZ += (SHORT)ri->data.mouse.usButtonData;
queue_event( iface, 2, (SHORT)ri->data.mouse.usButtonData, GetCurrentTime(), seq );
notify = TRUE;
}
for (i = 0; i < ARRAY_SIZE(mouse_button_flags); ++i)
{
if (ri->data.mouse.usButtonFlags & mouse_button_flags[i])
{
state->rgbButtons[i / 2] = 0x80 - (i % 2) * 0x80;
queue_event( iface, 3 + (i / 2), state->rgbButtons[i / 2], GetCurrentTime(), seq );
notify = TRUE;
}
}
TRACE( "buttons %02x %02x %02x %02x %02x, x %+ld, y %+ld, w %+ld\n", state->rgbButtons[0],
state->rgbButtons[1], state->rgbButtons[2], state->rgbButtons[3], state->rgbButtons[4],
state->lX, state->lY, state->lZ );
if (notify && impl->base.hEvent) SetEvent( impl->base.hEvent );
LeaveCriticalSection( &impl->base.crit );
}
int dinput_mouse_hook( IDirectInputDevice8W *iface, WPARAM wparam, LPARAM lparam )
{
MSLLHOOKSTRUCT *hook = (MSLLHOOKSTRUCT *)lparam;
struct mouse *impl = impl_from_IDirectInputDevice8W( iface );
DIMOUSESTATE2 *state = (DIMOUSESTATE2 *)impl->base.device_state;
BOOL notify = FALSE;
int ret = 0;
DWORD seq;
TRACE( "iface %p, msg %#Ix, x %+ld, y %+ld\n", iface, wparam, hook->pt.x, hook->pt.y );
EnterCriticalSection( &impl->base.crit );
seq = impl->base.dinput->evsequence++;
switch(wparam) {
case WM_MOUSEMOVE:
{
POINT pt, pt1;
GetCursorPos(&pt);
state->lX += pt.x = hook->pt.x - pt.x;
state->lY += pt.y = hook->pt.y - pt.y;
if (impl->base.user_format.dwFlags & DIDF_ABSAXIS)
{
pt1.x = state->lX;
pt1.y = state->lY;
} else
pt1 = pt;
if (pt.x)
{
queue_event( iface, 0, pt1.x, GetCurrentTime(), seq );
notify = TRUE;
}
if (pt.y)
{
queue_event( iface, 1, pt1.y, GetCurrentTime(), seq );
notify = TRUE;
}
if (pt.x || pt.y)
{
if ((impl->warp_override == WARP_FORCE_ON) ||
(impl->warp_override != WARP_DISABLE && (impl->base.dwCoopLevel & DISCL_EXCLUSIVE)))
impl->need_warp = TRUE;
}
break;
}
case WM_MOUSEWHEEL:
state->lZ += (short)HIWORD( hook->mouseData );
queue_event( iface, 2, state->lZ, GetCurrentTime(), seq );
/* FarCry crashes if it gets a mouse wheel message */
/* FIXME: should probably filter out other messages too */
ret = impl->clipped;
break;
case WM_LBUTTONDOWN:
state->rgbButtons[0] = 0x80;
queue_event( iface, 3, 0x80, GetCurrentTime(), seq );
notify = TRUE;
break;
case WM_LBUTTONUP:
state->rgbButtons[0] = 0x00;
queue_event( iface, 3, 0x00, GetCurrentTime(), seq );
notify = TRUE;
break;
case WM_RBUTTONDOWN:
state->rgbButtons[1] = 0x80;
queue_event( iface, 4, 0x80, GetCurrentTime(), seq );
notify = TRUE;
break;
case WM_RBUTTONUP:
state->rgbButtons[1] = 0x00;
queue_event( iface, 4, 0x00, GetCurrentTime(), seq );
notify = TRUE;
break;
case WM_MBUTTONDOWN:
state->rgbButtons[2] = 0x80;
queue_event( iface, 5, 0x80, GetCurrentTime(), seq );
notify = TRUE;
break;
case WM_MBUTTONUP:
state->rgbButtons[2] = 0x00;
queue_event( iface, 5, 0x00, GetCurrentTime(), seq );
notify = TRUE;
break;
case WM_XBUTTONDOWN:
state->rgbButtons[2 + HIWORD( hook->mouseData )] = 0x80;
queue_event( iface, 5 + HIWORD(hook->mouseData), 0x80, GetCurrentTime(), seq );
notify = TRUE;
break;
case WM_XBUTTONUP:
state->rgbButtons[2 + HIWORD( hook->mouseData )] = 0x00;
queue_event( iface, 5 + HIWORD(hook->mouseData), 0x00, GetCurrentTime(), seq );
notify = TRUE;
break;
}
TRACE( "buttons %02x %02x %02x %02x %02x, x %+ld, y %+ld, w %+ld\n", state->rgbButtons[0],
state->rgbButtons[1], state->rgbButtons[2], state->rgbButtons[3], state->rgbButtons[4],
state->lX, state->lY, state->lZ );
if (notify && impl->base.hEvent) SetEvent( impl->base.hEvent );
LeaveCriticalSection( &impl->base.crit );
return ret;
}
static void warp_check( struct mouse *impl, BOOL force )
{
DWORD now = GetCurrentTime();
const DWORD interval = impl->clipped ? 500 : 10;
if (force || (impl->need_warp && (now - impl->last_warped > interval)))
{
RECT rect, new_rect;
POINT mapped_center;
impl->last_warped = now;
impl->need_warp = FALSE;
if (!GetClientRect( impl->base.win, &rect )) return;
MapWindowPoints( impl->base.win, 0, (POINT *)&rect, 2 );
if (!impl->clipped)
{
mapped_center.x = (rect.left + rect.right) / 2;
mapped_center.y = (rect.top + rect.bottom) / 2;
TRACE( "Warping mouse to x %+ld, y %+ld.\n", mapped_center.x, mapped_center.y );
SetCursorPos( mapped_center.x, mapped_center.y );
}
if (impl->base.dwCoopLevel & DISCL_EXCLUSIVE)
{
/* make sure we clip even if the window covers the whole screen */
rect.left = max( rect.left, GetSystemMetrics( SM_XVIRTUALSCREEN ) + 1 );
rect.top = max( rect.top, GetSystemMetrics( SM_YVIRTUALSCREEN ) + 1 );
rect.right = min( rect.right, rect.left + GetSystemMetrics( SM_CXVIRTUALSCREEN ) - 2 );
rect.bottom = min( rect.bottom, rect.top + GetSystemMetrics( SM_CYVIRTUALSCREEN ) - 2 );
TRACE("Clipping mouse to %s\n", wine_dbgstr_rect( &rect ));
ClipCursor( &rect );
impl->clipped = GetClipCursor( &new_rect ) && EqualRect( &rect, &new_rect );
}
}
}
static HRESULT mouse_poll( IDirectInputDevice8W *iface )
{
struct mouse *impl = impl_from_IDirectInputDevice8W( iface );
check_dinput_events();
warp_check( impl, FALSE );
return DI_OK;
}
static HRESULT mouse_acquire( IDirectInputDevice8W *iface )
{
struct mouse *impl = impl_from_IDirectInputDevice8W( iface );
DIMOUSESTATE2 *state = (DIMOUSESTATE2 *)impl->base.device_state;
POINT point;
GetCursorPos( &point );
if (impl->base.user_format.dwFlags & DIDF_ABSAXIS)
{
state->lX = point.x;
state->lY = point.y;
}
else
{
state->lX = 0;
state->lY = 0;
impl->org_coords = point;
}
state->lZ = 0;
state->rgbButtons[0] = GetKeyState( VK_LBUTTON ) & 0x80;
state->rgbButtons[1] = GetKeyState( VK_RBUTTON ) & 0x80;
state->rgbButtons[2] = GetKeyState( VK_MBUTTON ) & 0x80;
if (impl->base.dwCoopLevel & DISCL_EXCLUSIVE)
{
ShowCursor( FALSE );
warp_check( impl, TRUE );
}
else if (impl->warp_override == WARP_FORCE_ON)
{
/* Need a window to warp mouse in. */
if (!impl->base.win) impl->base.win = GetDesktopWindow();
warp_check( impl, TRUE );
}
else if (impl->clipped)
{
ClipCursor( NULL );
impl->clipped = FALSE;
}
return DI_OK;
}
static HRESULT mouse_unacquire( IDirectInputDevice8W *iface )
{
struct mouse *impl = impl_from_IDirectInputDevice8W( iface );
if (impl->base.dwCoopLevel & DISCL_EXCLUSIVE)
{
ClipCursor( NULL );
ShowCursor( TRUE );
impl->clipped = FALSE;
}
/* And put the mouse cursor back where it was at acquire time */
if (impl->base.dwCoopLevel & DISCL_EXCLUSIVE || impl->warp_override == WARP_FORCE_ON)
{
TRACE( "warping mouse back to %s\n", wine_dbgstr_point( &impl->org_coords ) );
SetCursorPos( impl->org_coords.x, impl->org_coords.y );
}
return DI_OK;
}
static BOOL try_enum_object( struct dinput_device *impl, const DIPROPHEADER *filter, DWORD flags, enum_object_callback callback,
UINT index, DIDEVICEOBJECTINSTANCEW *instance, void *data )
{
if (flags != DIDFT_ALL && !(flags & DIDFT_GETTYPE( instance->dwType ))) return DIENUM_CONTINUE;
switch (filter->dwHow)
{
case DIPH_DEVICE:
return callback( impl, index, NULL, instance, data );
case DIPH_BYOFFSET:
if (filter->dwObj != instance->dwOfs) return DIENUM_CONTINUE;
return callback( impl, index, NULL, instance, data );
case DIPH_BYID:
if ((filter->dwObj & 0x00ffffff) != (instance->dwType & 0x00ffffff)) return DIENUM_CONTINUE;
return callback( impl, index, NULL, instance, data );
}
return DIENUM_CONTINUE;
}
static HRESULT mouse_enum_objects( IDirectInputDevice8W *iface, const DIPROPHEADER *filter,
DWORD flags, enum_object_callback callback, void *context )
{
struct mouse *impl = impl_from_IDirectInputDevice8W( iface );
DIDEVICEOBJECTINSTANCEW instances[] =
{
{
.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW),
.guidType = GUID_XAxis,
.dwOfs = DIMOFS_X,
.dwType = DIDFT_RELAXIS|DIDFT_MAKEINSTANCE(0),
.dwFlags = DIDOI_ASPECTPOSITION,
.tszName = L"X-axis",
},
{
.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW),
.guidType = GUID_YAxis,
.dwOfs = DIMOFS_Y,
.dwType = DIDFT_RELAXIS|DIDFT_MAKEINSTANCE(1),
.dwFlags = DIDOI_ASPECTPOSITION,
.tszName = L"Y-axis",
},
{
.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW),
.guidType = GUID_ZAxis,
.dwOfs = DIMOFS_Z,
.dwType = DIDFT_RELAXIS|DIDFT_MAKEINSTANCE(2),
.dwFlags = DIDOI_ASPECTPOSITION,
.tszName = L"Wheel",
},
{
.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW),
.guidType = GUID_Button,
.dwOfs = DIMOFS_BUTTON0,
.dwType = DIDFT_PSHBUTTON|DIDFT_MAKEINSTANCE(3),
.tszName = L"Button 0",
},
{
.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW),
.guidType = GUID_Button,
.dwOfs = DIMOFS_BUTTON1,
.dwType = DIDFT_PSHBUTTON|DIDFT_MAKEINSTANCE(4),
.tszName = L"Button 1",
},
{
.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW),
.guidType = GUID_Button,
.dwOfs = DIMOFS_BUTTON2,
.dwType = DIDFT_PSHBUTTON|DIDFT_MAKEINSTANCE(5),
.tszName = L"Button 2",
},
{
.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW),
.guidType = GUID_Button,
.dwOfs = DIMOFS_BUTTON3,
.dwType = DIDFT_PSHBUTTON|DIDFT_MAKEINSTANCE(6),
.tszName = L"Button 3",
},
{
.dwSize = sizeof(DIDEVICEOBJECTINSTANCEW),
.guidType = GUID_Button,
.dwOfs = DIMOFS_BUTTON4,
.dwType = DIDFT_PSHBUTTON|DIDFT_MAKEINSTANCE(7),
.tszName = L"Button 4",
},
};
BOOL ret;
DWORD i;
for (i = 0; i < ARRAY_SIZE(instances); ++i)
{
ret = try_enum_object( &impl->base, filter, flags, callback, i, instances + i, context );
if (ret != DIENUM_CONTINUE) return DIENUM_STOP;
}
return DIENUM_CONTINUE;
}
HRESULT mouse_create_device( struct dinput *dinput, const GUID *guid, IDirectInputDevice8W **out )
{
static const DIPROPHEADER filter =
{
.dwSize = sizeof(filter),
.dwHeaderSize = sizeof(filter),
.dwHow = DIPH_DEVICE,
};
struct mouse *impl;
HKEY hkey, appkey;
WCHAR buffer[20];
HRESULT hr;
TRACE( "dinput %p, guid %s, out %p\n", dinput, debugstr_guid( guid ), out );
*out = NULL;
if (!IsEqualGUID( &GUID_SysMouse, guid )) return DIERR_DEVICENOTREG;
if (!(impl = calloc( 1, sizeof(*impl) ))) return E_OUTOFMEMORY;
dinput_device_init( &impl->base, &mouse_vtbl, guid, dinput );
impl->base.crit.DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": struct mouse*->base.crit");
mouse_enum_device( 0, 0, &impl->base.instance, dinput->dwVersion );
impl->base.caps.dwDevType = impl->base.instance.dwDevType;
impl->base.caps.dwFirmwareRevision = 100;
impl->base.caps.dwHardwareRevision = 100;
impl->base.dwCoopLevel = DISCL_NONEXCLUSIVE | DISCL_BACKGROUND;
if (dinput->dwVersion >= 0x0800) impl->base.use_raw_input = TRUE;
if (FAILED(hr = dinput_device_init_device_format( &impl->base.IDirectInputDevice8W_iface ))) goto failed;
mouse_enum_objects( &impl->base.IDirectInputDevice8W_iface, &filter, DIDFT_AXIS, init_object_properties, NULL );
get_app_key(&hkey, &appkey);
if (!get_config_key( hkey, appkey, L"MouseWarpOverride", buffer, sizeof(buffer) ))
{
if (!wcsnicmp( buffer, L"disable", -1 )) impl->warp_override = WARP_DISABLE;
else if (!wcsnicmp( buffer, L"force", -1 )) impl->warp_override = WARP_FORCE_ON;
}
if (appkey) RegCloseKey(appkey);
if (hkey) RegCloseKey(hkey);
*out = &impl->base.IDirectInputDevice8W_iface;
return DI_OK;
failed:
IDirectInputDevice_Release( &impl->base.IDirectInputDevice8W_iface );
return hr;
}
static const struct dinput_device_vtbl mouse_vtbl =
{
NULL,
mouse_poll,
NULL,
mouse_acquire,
mouse_unacquire,
mouse_enum_objects,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
};