Added touch subsystem locking

Fixes https://github.com/libsdl-org/SDL/issues/14563
This commit is contained in:
Sam Lantinga
2025-12-01 22:17:18 -08:00
parent 22decf4783
commit e1edeab0c9
2 changed files with 371 additions and 261 deletions

View File

@@ -25,8 +25,21 @@
#include "SDL_events_c.h"
#include "../video/SDL_sysvideo.h"
static int SDL_num_touch = 0;
static SDL_Touch **SDL_touchDevices = NULL;
static SDL_Mutex *SDL_touch_lock = NULL; // This needs to support recursive locks
static int SDL_touch_locked = 0;
struct SDL_Touch
{
SDL_TouchID id SDL_GUARDED_BY(SDL_touch_lock);
SDL_TouchDeviceType type SDL_GUARDED_BY(SDL_touch_lock);
int num_fingers SDL_GUARDED_BY(SDL_touch_lock);
int max_fingers SDL_GUARDED_BY(SDL_touch_lock);
SDL_Finger **fingers SDL_GUARDED_BY(SDL_touch_lock);
char *name SDL_GUARDED_BY(SDL_touch_lock);
};
static int SDL_num_touch SDL_GUARDED_BY(SDL_touch_lock) = 0;
static SDL_Touch **SDL_touchDevices SDL_GUARDED_BY(SDL_touch_lock) = NULL;
// for mapping touch events to mice
static bool finger_touching = false;
@@ -36,22 +49,52 @@ static SDL_TouchID track_touchid;
// Public functions
bool SDL_InitTouch(void)
{
SDL_touch_lock = SDL_CreateMutex();
return true;
}
static void SDL_LockTouch(void) SDL_ACQUIRE(SDL_touch_lock)
{
SDL_LockMutex(SDL_touch_lock);
++SDL_touch_locked;
}
static void SDL_UnlockTouch(void) SDL_RELEASE(SDL_touch_lock)
{
--SDL_touch_locked;
SDL_UnlockMutex(SDL_touch_lock);
}
static void SDL_AssertTouchLocked(void) SDL_ASSERT_CAPABILITY(SDL_touch_lock)
{
SDL_assert(SDL_touch_locked > 0);
}
bool SDL_TouchDevicesAvailable(void)
{
return SDL_num_touch > 0;
bool available;
SDL_LockTouch();
{
available = (SDL_num_touch > 0);
}
SDL_UnlockTouch();
return available;
}
SDL_TouchID *SDL_GetTouchDevices(int *count)
{
SDL_TouchID *result;
if (count) {
*count = 0;
}
SDL_LockTouch();
{
const int total = SDL_num_touch;
SDL_TouchID *result = (SDL_TouchID *) SDL_malloc(sizeof (SDL_TouchID) * (total + 1));
result = (SDL_TouchID *)SDL_malloc(sizeof (SDL_TouchID) * (total + 1));
if (result) {
for (int i = 0; i < total; i++) {
result[i] = SDL_touchDevices[i]->id;
@@ -61,6 +104,8 @@ SDL_TouchID *SDL_GetTouchDevices(int *count)
*count = SDL_num_touch;
}
}
}
SDL_UnlockTouch();
return result;
}
@@ -70,6 +115,8 @@ static int SDL_GetTouchIndex(SDL_TouchID id)
int index;
SDL_Touch *touch;
SDL_AssertTouchLocked();
for (index = 0; index < SDL_num_touch; ++index) {
touch = SDL_touchDevices[index];
if (touch->id == id) {
@@ -81,6 +128,8 @@ static int SDL_GetTouchIndex(SDL_TouchID id)
SDL_Touch *SDL_GetTouch(SDL_TouchID id)
{
SDL_AssertTouchLocked();
int index = SDL_GetTouchIndex(id);
if (index < 0 || index >= SDL_num_touch) {
if ((id == SDL_MOUSE_TOUCHID) || (id == SDL_PEN_TOUCHID)) {
@@ -98,21 +147,40 @@ SDL_Touch *SDL_GetTouch(SDL_TouchID id)
const char *SDL_GetTouchDeviceName(SDL_TouchID id)
{
const char *name = NULL;
SDL_LockTouch();
{
SDL_Touch *touch = SDL_GetTouch(id);
if (!touch) {
return NULL;
if (touch) {
name = SDL_GetPersistentString(touch->name);
}
return SDL_GetPersistentString(touch->name);
}
SDL_UnlockTouch();
return name;
}
SDL_TouchDeviceType SDL_GetTouchDeviceType(SDL_TouchID id)
{
SDL_TouchDeviceType type = SDL_TOUCH_DEVICE_INVALID;
SDL_LockTouch();
{
SDL_Touch *touch = SDL_GetTouch(id);
return touch ? touch->type : SDL_TOUCH_DEVICE_INVALID;
if (touch) {
type = touch->type;
}
}
SDL_UnlockTouch();
return type;
}
static int SDL_GetFingerIndex(const SDL_Touch *touch, SDL_FingerID fingerid)
{
SDL_AssertTouchLocked();
int index;
for (index = 0; index < touch->num_fingers; ++index) {
if (touch->fingers[index]->id == fingerid) {
@@ -124,6 +192,8 @@ static int SDL_GetFingerIndex(const SDL_Touch *touch, SDL_FingerID fingerid)
static SDL_Finger *SDL_GetFinger(const SDL_Touch *touch, SDL_FingerID id)
{
SDL_AssertTouchLocked();
int index = SDL_GetFingerIndex(touch, id);
if (index < 0 || index >= touch->num_fingers) {
return NULL;
@@ -140,14 +210,18 @@ SDL_Finger **SDL_GetTouchFingers(SDL_TouchID touchID, int *count)
*count = 0;
}
SDL_LockTouch();
{
SDL_Touch *touch = SDL_GetTouch(touchID);
if (!touch) {
SDL_UnlockTouch();
return NULL;
}
// Create a snapshot of the current finger state
fingers = (SDL_Finger **)SDL_malloc((touch->num_fingers + 1) * sizeof(*fingers) + touch->num_fingers * sizeof(**fingers));
if (!fingers) {
SDL_UnlockTouch();
return NULL;
}
finger_data = (SDL_Finger *)(fingers + (touch->num_fingers + 1));
@@ -161,6 +235,9 @@ SDL_Finger **SDL_GetTouchFingers(SDL_TouchID touchID, int *count)
if (count) {
*count = touch->num_fingers;
}
}
SDL_UnlockTouch();
return fingers;
}
@@ -171,8 +248,11 @@ int SDL_AddTouch(SDL_TouchID touchID, SDL_TouchDeviceType type, const char *name
SDL_assert(touchID != 0);
SDL_LockTouch();
{
index = SDL_GetTouchIndex(touchID);
if (index >= 0) {
SDL_UnlockTouch();
return index;
}
@@ -180,6 +260,7 @@ int SDL_AddTouch(SDL_TouchID touchID, SDL_TouchDeviceType type, const char *name
touchDevices = (SDL_Touch **)SDL_realloc(SDL_touchDevices,
(SDL_num_touch + 1) * sizeof(*touchDevices));
if (!touchDevices) {
SDL_UnlockTouch();
return -1;
}
@@ -188,6 +269,7 @@ int SDL_AddTouch(SDL_TouchID touchID, SDL_TouchDeviceType type, const char *name
SDL_touchDevices[index] = (SDL_Touch *)SDL_malloc(sizeof(*SDL_touchDevices[index]));
if (!SDL_touchDevices[index]) {
SDL_UnlockTouch();
return -1;
}
@@ -201,6 +283,8 @@ int SDL_AddTouch(SDL_TouchID touchID, SDL_TouchDeviceType type, const char *name
SDL_touchDevices[index]->max_fingers = 0;
SDL_touchDevices[index]->fingers = NULL;
SDL_touchDevices[index]->name = SDL_strdup(name ? name : "");
}
SDL_UnlockTouch();
return index;
}
@@ -211,6 +295,8 @@ static bool SDL_AddFinger(SDL_Touch *touch, SDL_FingerID fingerid, float x, floa
SDL_assert(fingerid != 0);
SDL_AssertTouchLocked();
if (touch->num_fingers == touch->max_fingers) {
SDL_Finger **new_fingers;
new_fingers = (SDL_Finger **)SDL_realloc(touch->fingers, (touch->max_fingers + 1) * sizeof(*touch->fingers));
@@ -235,6 +321,8 @@ static bool SDL_AddFinger(SDL_Touch *touch, SDL_FingerID fingerid, float x, floa
static void SDL_DelFinger(SDL_Touch *touch, SDL_FingerID fingerid)
{
SDL_AssertTouchLocked();
int index = SDL_GetFingerIndex(touch, fingerid);
if (index < 0) {
return;
@@ -256,8 +344,11 @@ void SDL_SendTouch(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid, SDL_
SDL_Finger *finger;
bool down = (type == SDL_EVENT_FINGER_DOWN);
SDL_LockTouch();
{
SDL_Touch *touch = SDL_GetTouch(id);
if (!touch) {
SDL_UnlockTouch();
return;
}
@@ -268,11 +359,11 @@ void SDL_SendTouch(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid, SDL_
{
// FIXME: maybe we should only restrict to a few SDL_TouchDeviceType
if ((id != SDL_MOUSE_TOUCHID) && (id != SDL_PEN_TOUCHID)) {
#ifdef SDL_PLATFORM_VITA
#ifdef SDL_PLATFORM_VITA
if (mouse->touch_mouse_events && ((mouse->vita_touch_mouse_device == id) || (mouse->vita_touch_mouse_device == 3))) {
#else
#else
if (mouse->touch_mouse_events) {
#endif
#endif
if (window) {
if (down) {
if (finger_touching == false) {
@@ -316,8 +407,10 @@ void SDL_SendTouch(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid, SDL_
// SDL_HINT_MOUSE_TOUCH_EVENTS: if not set, discard synthetic touch events coming from platform layer
if (!mouse->mouse_touch_events && (id == SDL_MOUSE_TOUCHID)) {
SDL_UnlockTouch();
return;
} else if (!mouse->pen_touch_events && (id == SDL_PEN_TOUCHID)) {
SDL_UnlockTouch();
return;
}
@@ -330,6 +423,7 @@ void SDL_SendTouch(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid, SDL_
}
if (!SDL_AddFinger(touch, fingerid, x, y, pressure)) {
SDL_UnlockTouch();
return;
}
@@ -350,6 +444,7 @@ void SDL_SendTouch(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid, SDL_
} else {
if (!finger) {
// This finger is already up
SDL_UnlockTouch();
return;
}
@@ -371,6 +466,8 @@ void SDL_SendTouch(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid, SDL_
SDL_DelFinger(touch, fingerid);
}
}
SDL_UnlockTouch();
}
void SDL_SendTouchMotion(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid, SDL_Window *window,
@@ -380,8 +477,11 @@ void SDL_SendTouchMotion(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid
SDL_Finger *finger;
float xrel, yrel, prel;
SDL_LockTouch();
{
touch = SDL_GetTouch(id);
if (!touch) {
SDL_UnlockTouch();
return;
}
@@ -417,6 +517,7 @@ void SDL_SendTouchMotion(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid
// SDL_HINT_MOUSE_TOUCH_EVENTS: if not set, discard synthetic touch events coming from platform layer
if (!mouse->mouse_touch_events) {
if (id == SDL_MOUSE_TOUCHID) {
SDL_UnlockTouch();
return;
}
}
@@ -424,6 +525,7 @@ void SDL_SendTouchMotion(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid
finger = SDL_GetFinger(touch, fingerid);
if (!finger) {
SDL_SendTouch(timestamp, id, fingerid, window, SDL_EVENT_FINGER_DOWN, x, y, pressure);
SDL_UnlockTouch();
return;
}
@@ -433,9 +535,10 @@ void SDL_SendTouchMotion(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid
// Drop events that don't change state
if (xrel == 0.0f && yrel == 0.0f && prel == 0.0f) {
#if 0
#if 0
printf("Touch event didn't change state - dropped!\n");
#endif
#endif
SDL_UnlockTouch();
return;
}
@@ -459,6 +562,8 @@ void SDL_SendTouchMotion(Uint64 timestamp, SDL_TouchID id, SDL_FingerID fingerid
event.tfinger.windowID = window ? SDL_GetWindowID(window) : 0;
SDL_PushEvent(&event);
}
}
SDL_UnlockTouch();
}
void SDL_DelTouch(SDL_TouchID id)
@@ -466,14 +571,18 @@ void SDL_DelTouch(SDL_TouchID id)
int i, index;
SDL_Touch *touch;
SDL_LockTouch();
{
if (SDL_num_touch == 0) {
// We've already cleaned up, we won't find this device
SDL_UnlockTouch();
return;
}
index = SDL_GetTouchIndex(id);
touch = SDL_GetTouch(id);
if (!touch) {
SDL_UnlockTouch();
return;
}
@@ -486,12 +595,16 @@ void SDL_DelTouch(SDL_TouchID id)
SDL_num_touch--;
SDL_touchDevices[index] = SDL_touchDevices[SDL_num_touch];
}
SDL_UnlockTouch();
}
void SDL_QuitTouch(void)
{
int i;
SDL_LockTouch();
{
for (i = SDL_num_touch; i--;) {
SDL_DelTouch(SDL_touchDevices[i]->id);
}
@@ -499,6 +612,11 @@ void SDL_QuitTouch(void)
SDL_free(SDL_touchDevices);
SDL_touchDevices = NULL;
}
SDL_UnlockTouch();
SDL_DestroyMutex(SDL_touch_lock);
SDL_touch_lock = NULL;
}
int SDL_SendPinch(SDL_EventType type, Uint64 timestamp, SDL_Window *window, float scale)

View File

@@ -23,15 +23,7 @@
#ifndef SDL_touch_c_h_
#define SDL_touch_c_h_
typedef struct SDL_Touch
{
SDL_TouchID id;
SDL_TouchDeviceType type;
int num_fingers;
int max_fingers;
SDL_Finger **fingers;
char *name;
} SDL_Touch;
typedef struct SDL_Touch SDL_Touch;
// Initialize the touch subsystem
extern bool SDL_InitTouch(void);