mirror of
https://github.com/gnif/LookingGlass.git
synced 2026-08-10 01:01:30 +00:00
[client] input: abstract guest input backends
Introduce LG_InputOps and route keyboard and mouse input through the active video transport when it provides an input backend. Keep SPICE as the fallback and force it while the SPICE display is active. Add atomic shared/exclusive locking for safe backend changes.
This commit is contained in:
Geoffrey McRae
362
client/src/input.c
Normal file
362
client/src/input.c
Normal file
@@ -0,0 +1,362 @@
|
||||
/**
|
||||
* Looking Glass
|
||||
* Copyright © 2017-2026 The Looking Glass Authors
|
||||
* https://looking-glass.io
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify it
|
||||
* under the terms of the GNU General Public License as published by the Free
|
||||
* Software Foundation; either version 2 of the License, or (at your option)
|
||||
* any later version.
|
||||
*
|
||||
* This program 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 General Public License for
|
||||
* more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License along
|
||||
* with this program; if not, write to the Free Software Foundation, Inc., 59
|
||||
* Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*/
|
||||
|
||||
#include "input.h"
|
||||
|
||||
#include "common/debug.h"
|
||||
#include "common/locking.h"
|
||||
|
||||
#include <linux/input.h>
|
||||
#include <stdatomic.h>
|
||||
|
||||
struct InputBinding
|
||||
{
|
||||
const LG_InputOps * ops;
|
||||
void * opaque;
|
||||
bool mouseAbsolute;
|
||||
};
|
||||
|
||||
static struct
|
||||
{
|
||||
LG_RWLock activeLock;
|
||||
|
||||
struct InputBinding fallback;
|
||||
struct InputBinding transport;
|
||||
struct InputBinding active;
|
||||
bool useTransport;
|
||||
|
||||
_Atomic(bool) keys[KEY_MAX];
|
||||
_Atomic(uint32_t) buttons;
|
||||
}
|
||||
l_input;
|
||||
|
||||
static bool validOps(const LG_InputOps * ops)
|
||||
{
|
||||
return
|
||||
ops &&
|
||||
ops->name &&
|
||||
ops->supports &&
|
||||
ops->keyDown &&
|
||||
ops->keyUp &&
|
||||
ops->mouseMotion &&
|
||||
ops->mousePress &&
|
||||
ops->mouseRelease;
|
||||
}
|
||||
|
||||
static struct InputBinding makeBinding(const LG_InputOps * ops,
|
||||
void * opaque)
|
||||
{
|
||||
return (struct InputBinding)
|
||||
{
|
||||
.ops = ops,
|
||||
.opaque = opaque,
|
||||
.mouseAbsolute = ops && ops->mousePosition &&
|
||||
ops->supports(opaque, LG_INPUT_SUPPORT_MOUSE_ABSOLUTE),
|
||||
};
|
||||
}
|
||||
|
||||
static void releaseKeysNL(void)
|
||||
{
|
||||
for (int key = 0; key < KEY_MAX; ++key)
|
||||
if (atomic_exchange_explicit(&l_input.keys[key], false,
|
||||
memory_order_relaxed) && l_input.active.ops)
|
||||
l_input.active.ops->keyUp(l_input.active.opaque, key);
|
||||
}
|
||||
|
||||
static void releaseButtonsNL(void)
|
||||
{
|
||||
const uint32_t buttons = atomic_exchange_explicit(
|
||||
&l_input.buttons, 0, memory_order_relaxed);
|
||||
|
||||
if (!l_input.active.ops)
|
||||
return;
|
||||
|
||||
for (unsigned int button = 1; button < 32; ++button)
|
||||
if (buttons & (UINT32_C(1) << button))
|
||||
l_input.active.ops->mouseRelease(l_input.active.opaque, button);
|
||||
}
|
||||
|
||||
static void resetActiveNL(void)
|
||||
{
|
||||
releaseKeysNL();
|
||||
releaseButtonsNL();
|
||||
if (l_input.active.ops && l_input.active.ops->reset)
|
||||
l_input.active.ops->reset(l_input.active.opaque);
|
||||
}
|
||||
|
||||
static void clearStateNL(void)
|
||||
{
|
||||
for (int key = 0; key < KEY_MAX; ++key)
|
||||
atomic_store_explicit(&l_input.keys[key], false, memory_order_relaxed);
|
||||
|
||||
atomic_store_explicit(&l_input.buttons, 0, memory_order_relaxed);
|
||||
}
|
||||
|
||||
static void updateActiveNL(void)
|
||||
{
|
||||
const struct InputBinding next =
|
||||
l_input.useTransport && l_input.transport.ops ?
|
||||
l_input.transport : l_input.fallback;
|
||||
|
||||
if (next.ops == l_input.active.ops &&
|
||||
next.opaque == l_input.active.opaque)
|
||||
return;
|
||||
|
||||
resetActiveNL();
|
||||
l_input.active = next;
|
||||
|
||||
if (l_input.active.ops)
|
||||
{
|
||||
if (l_input.active.ops->reset)
|
||||
l_input.active.ops->reset(l_input.active.opaque);
|
||||
DEBUG_INFO("Using Input: %s", l_input.active.ops->name);
|
||||
}
|
||||
else
|
||||
DEBUG_INFO("Input is unavailable");
|
||||
}
|
||||
|
||||
void lgInput_init(void)
|
||||
{
|
||||
l_input.fallback = (struct InputBinding) { 0 };
|
||||
l_input.transport = (struct InputBinding) { 0 };
|
||||
l_input.active = (struct InputBinding) { 0 };
|
||||
l_input.useTransport = true;
|
||||
|
||||
for (int key = 0; key < KEY_MAX; ++key)
|
||||
atomic_init(&l_input.keys[key], false);
|
||||
atomic_init(&l_input.buttons, 0);
|
||||
|
||||
LG_RWLOCK_INIT(l_input.activeLock);
|
||||
}
|
||||
|
||||
void lgInput_free(void)
|
||||
{
|
||||
LG_LOCK_EXCLUSIVE(l_input.activeLock);
|
||||
resetActiveNL();
|
||||
l_input.active = (struct InputBinding) { 0 };
|
||||
l_input.fallback = (struct InputBinding) { 0 };
|
||||
l_input.transport = (struct InputBinding) { 0 };
|
||||
LG_UNLOCK_EXCLUSIVE(l_input.activeLock);
|
||||
LG_RWLOCK_FREE(l_input.activeLock);
|
||||
}
|
||||
|
||||
void lgInput_setFallback(const LG_InputOps * ops, void * opaque)
|
||||
{
|
||||
if (ops && !validOps(ops))
|
||||
{
|
||||
DEBUG_ERROR("Invalid fallback input operations");
|
||||
ops = NULL;
|
||||
opaque = NULL;
|
||||
}
|
||||
|
||||
LG_LOCK_EXCLUSIVE(l_input.activeLock);
|
||||
l_input.fallback = makeBinding(ops, opaque);
|
||||
updateActiveNL();
|
||||
LG_UNLOCK_EXCLUSIVE(l_input.activeLock);
|
||||
}
|
||||
|
||||
void lgInput_setTransport(const LG_InputOps * ops, void * opaque)
|
||||
{
|
||||
if (ops && !validOps(ops))
|
||||
{
|
||||
DEBUG_ERROR("Invalid transport input operations");
|
||||
ops = NULL;
|
||||
opaque = NULL;
|
||||
}
|
||||
|
||||
LG_LOCK_EXCLUSIVE(l_input.activeLock);
|
||||
l_input.transport = makeBinding(ops, opaque);
|
||||
updateActiveNL();
|
||||
LG_UNLOCK_EXCLUSIVE(l_input.activeLock);
|
||||
}
|
||||
|
||||
void lgInput_dropTransport(void)
|
||||
{
|
||||
LG_LOCK_EXCLUSIVE(l_input.activeLock);
|
||||
if (l_input.useTransport && l_input.active.ops == l_input.transport.ops &&
|
||||
l_input.active.opaque == l_input.transport.opaque)
|
||||
{
|
||||
l_input.active = (struct InputBinding) { 0 };
|
||||
clearStateNL();
|
||||
}
|
||||
|
||||
l_input.transport = (struct InputBinding) { 0 };
|
||||
updateActiveNL();
|
||||
LG_UNLOCK_EXCLUSIVE(l_input.activeLock);
|
||||
}
|
||||
|
||||
void lgInput_useTransport(bool enable)
|
||||
{
|
||||
LG_LOCK_EXCLUSIVE(l_input.activeLock);
|
||||
l_input.useTransport = enable;
|
||||
updateActiveNL();
|
||||
LG_UNLOCK_EXCLUSIVE(l_input.activeLock);
|
||||
}
|
||||
|
||||
bool lgInput_available(void)
|
||||
{
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
const bool result = l_input.active.ops != NULL;
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
|
||||
bool lgInput_supports(LG_InputSupport support)
|
||||
{
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
bool result;
|
||||
switch (support)
|
||||
{
|
||||
case LG_INPUT_SUPPORT_MOUSE_ABSOLUTE:
|
||||
result = l_input.active.mouseAbsolute;
|
||||
break;
|
||||
|
||||
default:
|
||||
result = false;
|
||||
break;
|
||||
}
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
|
||||
bool lgInput_keyDown(int key)
|
||||
{
|
||||
if (key < 0 || key >= KEY_MAX)
|
||||
return false;
|
||||
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
if (atomic_exchange_explicit(
|
||||
&l_input.keys[key], true, memory_order_relaxed))
|
||||
{
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return true;
|
||||
}
|
||||
|
||||
const bool result = l_input.active.ops &&
|
||||
l_input.active.ops->keyDown(l_input.active.opaque, key);
|
||||
if (!result)
|
||||
atomic_store_explicit(&l_input.keys[key], false, memory_order_relaxed);
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
|
||||
bool lgInput_keyUp(int key)
|
||||
{
|
||||
if (key < 0 || key >= KEY_MAX)
|
||||
return false;
|
||||
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
if (!atomic_exchange_explicit(
|
||||
&l_input.keys[key], false, memory_order_relaxed))
|
||||
{
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return true;
|
||||
}
|
||||
|
||||
const bool result = l_input.active.ops &&
|
||||
l_input.active.ops->keyUp(l_input.active.opaque, key);
|
||||
if (!result)
|
||||
atomic_store_explicit(&l_input.keys[key], true, memory_order_relaxed);
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
|
||||
bool lgInput_keyboardLEDs(bool numLock, bool capsLock, bool scrollLock)
|
||||
{
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
const bool result = l_input.active.ops &&
|
||||
(!l_input.active.ops->keyboardLEDs ||
|
||||
l_input.active.ops->keyboardLEDs(l_input.active.opaque,
|
||||
numLock, capsLock, scrollLock));
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
|
||||
void lgInput_releaseKeys(void)
|
||||
{
|
||||
LG_LOCK_EXCLUSIVE(l_input.activeLock);
|
||||
releaseKeysNL();
|
||||
LG_UNLOCK_EXCLUSIVE(l_input.activeLock);
|
||||
}
|
||||
|
||||
bool lgInput_mouseMotion(int32_t x, int32_t y)
|
||||
{
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
const bool result = l_input.active.ops &&
|
||||
l_input.active.ops->mouseMotion(l_input.active.opaque, x, y);
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
|
||||
bool lgInput_mousePosition(uint32_t x, uint32_t y, uint32_t width,
|
||||
uint32_t height)
|
||||
{
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
const bool result = l_input.active.mouseAbsolute &&
|
||||
l_input.active.ops->mousePosition(l_input.active.opaque,
|
||||
x, y, width, height);
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
|
||||
bool lgInput_mousePress(unsigned int button)
|
||||
{
|
||||
if (button == 0 || button >= 32)
|
||||
return false;
|
||||
|
||||
const uint32_t mask = UINT32_C(1) << button;
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
if (atomic_fetch_or_explicit(
|
||||
&l_input.buttons, mask, memory_order_relaxed) & mask)
|
||||
{
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return true;
|
||||
}
|
||||
|
||||
const bool result = l_input.active.ops &&
|
||||
l_input.active.ops->mousePress(l_input.active.opaque, button);
|
||||
if (!result)
|
||||
atomic_fetch_and_explicit(
|
||||
&l_input.buttons, ~mask, memory_order_relaxed);
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
|
||||
bool lgInput_mouseRelease(unsigned int button)
|
||||
{
|
||||
if (button == 0 || button >= 32)
|
||||
return false;
|
||||
|
||||
const uint32_t mask = UINT32_C(1) << button;
|
||||
LG_LOCK_SHARED(l_input.activeLock);
|
||||
if (!(atomic_fetch_and_explicit(
|
||||
&l_input.buttons, ~mask, memory_order_relaxed) & mask))
|
||||
{
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return true;
|
||||
}
|
||||
|
||||
const bool result = l_input.active.ops &&
|
||||
l_input.active.ops->mouseRelease(l_input.active.opaque, button);
|
||||
if (!result)
|
||||
atomic_fetch_or_explicit(&l_input.buttons, mask, memory_order_relaxed);
|
||||
LG_UNLOCK_SHARED(l_input.activeLock);
|
||||
return result;
|
||||
}
|
||||
Reference in New Issue
Block a user