Skip to content

Commit

Permalink
Move keyboard tracking to CConnection
Browse files Browse the repository at this point in the history 
This is a general thing so move it in to the core library instead,
letting vncviewer focus on just translation of system events to VNC
ones.
  • Loading branch information
@CendioOssman
CendioOssman committed Oct 16, 2024
1 parent 16f9878 commit d4b64f4
Show file tree
Hide file tree
Showing 4 changed files with 129 additions and 84 deletions.
87 changes: 87 additions & 0 deletions common/rfb/CConnection.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@
#include <rfb/CConnection.h>
#include <rfb/util.h>

#define XK_MISCELLANY
#define XK_XKB_KEYS
#include <rfb/keysymdef.h>

#include <rfb/LogWriter.h>

#include <rdr/InStream.h>
Expand Down Expand Up @@ -693,6 +697,89 @@ void CConnection::sendClipboardData(const char* data)
}
}

void CConnection::sendKeyPress(int systemKeyCode,
uint32_t keyCode, uint32_t keySym)
{
// For the first few years, there wasn't a good consensus on what the
// Windows keys should be mapped to for X11. So we need to help out a
// bit and map all variants to the same key...
switch (keySym) {
case XK_Hyper_L:
keySym = XK_Super_L;
break;
case XK_Hyper_R:
keySym = XK_Super_R;
break;
// There has been several variants for Shift-Tab over the years.
// RFB states that we should always send a normal tab.
case XK_ISO_Left_Tab:
keySym = XK_Tab;
break;
}

#ifdef __APPLE__
// Alt on OS X behaves more like AltGr on other systems, and to get
// sane behaviour we should translate things in that manner for the
// remote VNC server. However that means we lose the ability to use
// Alt as a shortcut modifier. Do what RealVNC does and hijack the
// left command key as an Alt replacement.
switch (keySym) {
case XK_Super_L:
keySym = XK_Alt_L;
break;
case XK_Super_R:
keySym = XK_Super_L;
break;
case XK_Alt_L:
keySym = XK_Mode_switch;
break;
case XK_Alt_R:
keySym = XK_ISO_Level3_Shift;
break;
}
#endif

// Because of the way keyboards work, we cannot expect to have the same
// symbol on release as when pressed. This breaks the VNC protocol however,
// so we need to keep track of what keysym a key _code_ generated on press
// and send the same on release.
downKeys[systemKeyCode].keyCode = keyCode;
downKeys[systemKeyCode].keySym = keySym;

vlog.debug("Key pressed: %d => 0x%02x / XK_%s (0x%04x)",
systemKeyCode, keyCode, KeySymName(keySym), keySym);

writer()->writeKeyEvent(keySym, keyCode, true);
}

void CConnection::sendKeyRelease(int systemKeyCode)
{
DownMap::iterator iter;

iter = downKeys.find(systemKeyCode);
if (iter == downKeys.end()) {
// These occur somewhat frequently so let's not spam them unless
// logging is turned up.
vlog.debug("Unexpected release of key code %d", systemKeyCode);
return;
}

vlog.debug("Key released: %d => 0x%02x / XK_%s (0x%04x)",
systemKeyCode, iter->second.keyCode,
KeySymName(iter->second.keySym), iter->second.keySym);

writer()->writeKeyEvent(iter->second.keySym,
iter->second.keyCode, false);

downKeys.erase(iter);
}

void CConnection::releaseAllKeys()
{
while (!downKeys.empty())
sendKeyRelease(downKeys.begin()->first);
}

void CConnection::refreshFramebuffer()
{
forceNonincremental = true;
Expand Down
20 changes: 20 additions & 0 deletions common/rfb/CConnection.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
#ifndef __RFB_CCONNECTION_H__
#define __RFB_CCONNECTION_H__

#include <map>
#include <string>

#include <rfb/CMsgHandler.h>
Expand Down Expand Up @@ -196,6 +197,18 @@ namespace rfb {
// clipboard via handleClipboardRequest().
virtual void sendClipboardData(const char* data);

// sendKeyPress()/sendKeyRelease() send keyboard events to the
// server
void sendKeyPress(int systemKeyCode, uint32_t keyCode, uint32_t keySym);
void sendKeyRelease(int systemKeyCode);

// releaseAllKeys() sends keyboard release events to the server for
// all keys that are currently pressed down by this client,
// avoiding keys getting stuck. This can be useful if the client
// loses keyboard focus or otherwise no longer gets keyboard events
// from the system.
void releaseAllKeys();

// refreshFramebuffer() forces a complete refresh of the entire
// framebuffer
void refreshFramebuffer();
Expand Down Expand Up @@ -313,6 +326,13 @@ namespace rfb {
bool hasRemoteClipboard;
bool hasLocalClipboard;
bool unsolicitedClipboardAttempt;

struct DownKey {
uint32_t keyCode;
uint32_t keySym;
};
typedef std::map<int, DownKey> DownMap;
DownMap downKeys;
};
}
#endif
94 changes: 19 additions & 75 deletions vncviewer/Viewport.cxx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
#include <rfb/CMsgWriter.h>
#include <rfb/LogWriter.h>
#include <rfb/Exception.h>
#include <rfb/KeysymStr.h>
#include <rfb/ledStates.h>
#include <rfb/util.h>

Expand Down Expand Up @@ -127,7 +126,7 @@ Viewport::Viewport(int w, int h, const rfb::PixelFormat& /*serverPF*/, CConn* cc
: Fl_Widget(0, 0, w, h), cc(cc_), frameBuffer(nullptr),
lastPointerPos(0, 0), lastButtonMask(0),
#ifdef WIN32
altGrArmed(false),
altGrArmed(false), leftShiftDown(false), rightShiftDown(false),
#endif
firstLEDState(true), pendingClientClipboard(false),
menuCtrlKey(false), menuAltKey(false), cursor(nullptr)
Expand Down Expand Up @@ -568,7 +567,6 @@ int Viewport::handle(int event)
{
std::string filtered;
int buttonMask, wheelMask;
DownMap::const_iterator iter;

switch (event) {
case FL_PASTE:
Expand Down Expand Up @@ -830,8 +828,12 @@ void Viewport::handlePointerTimeout(void *data)

void Viewport::resetKeyboard()
{
while (!downKeys.empty())
handleKeyRelease(downKeys.begin()->first);
try {
cc->releaseAllKeys();
} catch (rdr::Exception& e) {
vlog.error("%s", e.str());
abort_connection_with_unexpected_error(e);
}
}


Expand All @@ -852,40 +854,8 @@ void Viewport::handleKeyPress(int systemKeyCode,
if (viewOnly)
return;

#ifdef __APPLE__
// Alt on OS X behaves more like AltGr on other systems, and to get
// sane behaviour we should translate things in that manner for the
// remote VNC server. However that means we lose the ability to use
// Alt as a shortcut modifier. Do what RealVNC does and hijack the
// left command key as an Alt replacement.
switch (keySym) {
case XK_Super_L:
keySym = XK_Alt_L;
break;
case XK_Super_R:
keySym = XK_Super_L;
break;
case XK_Alt_L:
keySym = XK_Mode_switch;
break;
case XK_Alt_R:
keySym = XK_ISO_Level3_Shift;
break;
}
#endif

// Because of the way keyboards work, we cannot expect to have the same
// symbol on release as when pressed. This breaks the VNC protocol however,
// so we need to keep track of what keysym a key _code_ generated on press
// and send the same on release.
downKeys[systemKeyCode].keyCode = keyCode;
downKeys[systemKeyCode].keySym = keySym;

vlog.debug("Key pressed: %d => 0x%02x / XK_%s (0x%04x)",
systemKeyCode, keyCode, KeySymName(keySym), keySym);

try {
cc->writer()->writeKeyEvent(keySym, keyCode, true);
cc->sendKeyPress(systemKeyCode, keyCode, keySym);
} catch (rdr::Exception& e) {
vlog.error("%s", e.str());
abort_connection_with_unexpected_error(e);
Expand All @@ -895,32 +865,15 @@ void Viewport::handleKeyPress(int systemKeyCode,

void Viewport::handleKeyRelease(int systemKeyCode)
{
DownMap::iterator iter;

if (viewOnly)
return;

iter = downKeys.find(systemKeyCode);
if (iter == downKeys.end()) {
// These occur somewhat frequently so let's not spam them unless
// logging is turned up.
vlog.debug("Unexpected release of key code %d", systemKeyCode);
return;
}

vlog.debug("Key released: %d => 0x%02x / XK_%s (0x%04x)",
systemKeyCode, iter->second.keyCode,
KeySymName(iter->second.keySym), iter->second.keySym);

try {
cc->writer()->writeKeyEvent(iter->second.keySym,
iter->second.keyCode, false);
cc->sendKeyRelease(systemKeyCode);
} catch (rdr::Exception& e) {
vlog.error("%s", e.str());
abort_connection_with_unexpected_error(e);
}

downKeys.erase(iter);
}


Expand Down Expand Up @@ -1069,6 +1022,12 @@ int Viewport::handleSystemEvent(void *event, void *data)
self->handleKeyRelease(keyCode);
}

// Shift key tracking, see below
if (keyCode == 0x2a)
self->leftShiftDown = true;
if (keyCode == 0x36)
self->rightShiftDown = true;

return 1;
} else if ((msg->message == WM_KEYUP) || (msg->message == WM_SYSKEYUP)) {
UINT vKey;
Expand Down Expand Up @@ -1112,10 +1071,12 @@ int Viewport::handleSystemEvent(void *event, void *data)
// Windows has a rather nasty bug where it won't send key release
// events for a Shift button if the other Shift is still pressed
if ((keyCode == 0x2a) || (keyCode == 0x36)) {
if (self->downKeys.count(0x2a))
if (self->leftShiftDown)
self->handleKeyRelease(0x2a);
if (self->downKeys.count(0x36))
if (self->rightShiftDown)
self->handleKeyRelease(0x36);
self->leftShiftDown = false;
self->rightShiftDown = false;
}

return 1;
Expand Down Expand Up @@ -1175,23 +1136,6 @@ int Viewport::handleSystemEvent(void *event, void *data)
(int)xevent->xkey.keycode);
}

switch (keysym) {
// For the first few years, there wasn't a good consensus on what the
// Windows keys should be mapped to for X11. So we need to help out a
// bit and map all variants to the same key...
case XK_Hyper_L:
keysym = XK_Super_L;
break;
case XK_Hyper_R:
keysym = XK_Super_R;
break;
// There has been several variants for Shift-Tab over the years.
// RFB states that we should always send a normal tab.
case XK_ISO_Left_Tab:
keysym = XK_Tab;
break;
}

self->handleKeyPress(xevent->xkey.keycode, keycode, keysym);
return 1;
} else if (xevent->type == KeyRelease) {
Expand Down
12 changes: 3 additions & 9 deletions vncviewer/Viewport.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@
#ifndef __VIEWPORT_H__
#define __VIEWPORT_H__

#include <map>

#include <rfb/Rect.h>

#include <FL/Fl_Widget.H>
Expand Down Expand Up @@ -114,16 +112,12 @@ class Viewport : public Fl_Widget, public EmulateMB {
rfb::Point lastPointerPos;
uint8_t lastButtonMask;

struct DownKey {
uint32_t keyCode;
uint32_t keySym;
};
typedef std::map<int, DownKey> DownMap;
DownMap downKeys;

#ifdef WIN32
bool altGrArmed;
unsigned int altGrCtrlTime;

bool leftShiftDown;
bool rightShiftDown;
#endif

bool firstLEDState;
Expand Down

0 comments on commit d4b64f4

Please sign in to comment.