Revision control
Copy as Markdown
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qvxkeyboardhandler_p.h"
#include "qoutputmapping_p.h"
#include <qplatformdefs.h>
#include <QFile>
#include <QSocketNotifier>
#include <QStringList>
#include <QCoreApplication>
#include <QLoggingCategory>
#include <qpa/qwindowsysteminterface.h>
#include <private/qcore_unix_p.h>
#include <QtGui/private/qguiapplication_p.h>
#include <QtGui/private/qinputdevicemanager_p.h>
#include <evdevLib.h>
#ifndef input_event_sec
#define input_event_sec time.tv_sec
#endif
#ifndef input_event_usec
#define input_event_usec time.tv_usec
#endif
QT_BEGIN_NAMESPACE
using namespace Qt::StringLiterals;
Q_LOGGING_CATEGORY(qLcVxKey, "qt.qpa.input")
Q_STATIC_LOGGING_CATEGORY(qLcVxKeyMap, "qt.qpa.input.keymap")
// simple builtin US keymap
#include "qvxkeyboard_defaultmap_p.h"
QVxKeyboardHandler::QVxKeyboardHandler(const QString &device, QFdContainer &fd, bool disableZap, bool enableCompose, const QString &keymapFile)
: m_device(device), m_fd(fd.release()), m_notify(nullptr),
m_modifiers(0), m_composing(0), m_dead_unicode(0xffff),
m_langLock(0), m_no_zap(disableZap), m_do_compose(enableCompose),
m_keymap(0), m_keymap_size(0), m_keycompose(0), m_keycompose_size(0)
{
qCDebug(qLcVxKey) << "Create keyboard handler with for device" << device;
setObjectName("VxWorksInput Keyboard Handler"_L1);
memset(m_locks, 0, sizeof(m_locks));
if (keymapFile.isEmpty() || !loadKeymap(keymapFile))
unloadKeymap();
// socket notifier for events on the keyboard device
m_notify = new QSocketNotifier(m_fd.get(), QSocketNotifier::Read, this);
connect(m_notify, &QSocketNotifier::activated, this, &QVxKeyboardHandler::readKeycode);
}
QVxKeyboardHandler::~QVxKeyboardHandler()
{
unloadKeymap();
}
std::unique_ptr<QVxKeyboardHandler> QVxKeyboardHandler::create(const QString &device,
const QString &specification,
const QString &defaultKeymapFile)
{
qCDebug(qLcVxKey, "Try to create keyboard handler for \"%ls\" \"%ls\"",
qUtf16Printable(device), qUtf16Printable(specification));
QString keymapFile = defaultKeymapFile;
int repeatDelay = 400;
int repeatRate = 80;
bool disableZap = false;
bool enableCompose = false;
int grab = 0;
const auto args = QStringView{specification}.split(u':');
for (const auto &arg : args) {
if (arg.startsWith("keymap="_L1))
keymapFile = arg.mid(7).toString();
else if (arg == "disable-zap"_L1)
disableZap = true;
else if (arg == "enable-compose"_L1)
enableCompose = true;
else if (arg.startsWith("repeat-delay="_L1))
repeatDelay = arg.mid(13).toInt();
else if (arg.startsWith("repeat-rate="_L1))
repeatRate = arg.mid(12).toInt();
else if (arg.startsWith("grab="_L1))
grab = arg.mid(5).toInt();
}
qCDebug(qLcVxKey, "Opening keyboard at %ls", qUtf16Printable(device));
QFdContainer fd(qt_safe_open(device.toLocal8Bit().constData(), O_RDWR | O_NDELAY, 0));
if (fd.get() < 0) {
qCDebug(qLcVxKey, "Keyboard device could not be opened as read-write, trying read-only");
fd.reset(qt_safe_open(device.toLocal8Bit().constData(), O_RDONLY | O_NDELAY, 0));
}
if (fd.get() >= 0) {
UINT32 kbdMode = EV_DEV_KBD_KEYCODE_MODE;
if (ERROR == ioctl (fd.get(), EV_DEV_IO_SET_KBD_MODE, (char *)&kbdMode)) {
qWarning("Cannot set keyboard mapping mode to KEYCODE mode: %s", strerror(errno));
return nullptr;
}
return std::unique_ptr<QVxKeyboardHandler>(new QVxKeyboardHandler(device, fd, disableZap, enableCompose, keymapFile));
} else {
qErrnoWarning("Cannot open keyboard input device '%ls'", qUtf16Printable(device));
return nullptr;
}
}
void QVxKeyboardHandler::readKeycode()
{
EV_DEV_EVENT ev;
int n = ERROR;
while (n == ERROR) {
n = qt_safe_read(m_fd.get(), (char *)(&ev), sizeof(EV_DEV_EVENT));
if (n == 0) {
qWarning("vxkeyboard: Got EOF from the input device");
return;
}
if (n == ERROR) {
if (errno == EINTR || errno == EAGAIN)
continue;
qErrnoWarning("vxkeyboard: Could not read from input device");
if (errno == ENXIO) {
delete m_notify;
m_notify = nullptr;
m_fd.reset();
}
return;
}
}
if (n < sizeof(EV_DEV_EVENT)) return;
if (ev.type != EV_DEV_KEY) return;
quint16 code = ev.code;
qint32 value = ev.value;
processKeycode(code, value != 0, value == 2);
}
void QVxKeyboardHandler::processKeyEvent(int nativecode, int unicode, int qtcode,
Qt::KeyboardModifiers modifiers, bool isPress, bool autoRepeat)
{
if (!autoRepeat)
QGuiApplicationPrivate::inputDeviceManager()->setKeyboardModifiers(QVxKeyboardHandler::toQtModifiers(m_modifiers));
QWindow *window = nullptr;
QWindowSystemInterface::handleExtendedKeyEvent(window, (isPress ? QEvent::KeyPress : QEvent::KeyRelease),
qtcode, modifiers, nativecode + 8, 0, int(modifiers),
(unicode != 0xffff ) ? QString(QChar(unicode)) : QString(), autoRepeat);
}
QKeycodeAction QVxKeyboardHandler::processKeycode(quint16 keycode, bool pressed, bool autorepeat)
{
QKeycodeAction result = QKeycodeAction::None;
bool first_press = pressed && !autorepeat;
const QKeyboardMap::Mapping *map_plain = nullptr;
const QKeyboardMap::Mapping *map_withmod = nullptr;
quint8 modifiers = m_modifiers;
// get a specific and plain mapping for the keycode and the current modifiers
for (int i = 0; i < m_keymap_size && !(map_plain && map_withmod); ++i) {
const QKeyboardMap::Mapping *m = m_keymap + i;
if (m->keycode == keycode) {
if (m->modifiers == 0)
map_plain = m;
quint8 testmods = m_modifiers;
if (m_locks[0] /*CapsLock*/ && (m->flags & QKeyboardMap::IsLetter))
testmods ^= QKeyboardMap::ModShift;
if (m_langLock)
testmods ^= QKeyboardMap::ModAltGr;
if (m->modifiers == testmods)
map_withmod = m;
}
}
if (m_locks[0] && map_withmod && (map_withmod->flags & QKeyboardMap::IsLetter))
modifiers ^= QKeyboardMap::ModShift;
qCDebug(qLcVxKeyMap, "Processing key event: keycode=%3d, modifiers=%02x pressed=%d, autorepeat=%d | plain=%d, withmod=%d, size=%d",
keycode, modifiers, pressed ? 1 : 0, autorepeat ? 1 : 0,
int(map_plain ? map_plain - m_keymap : -1),
int(map_withmod ? map_withmod - m_keymap : -1),
m_keymap_size);
const QKeyboardMap::Mapping *it = map_withmod ? map_withmod : map_plain;
if (!it) {
// we couldn't even find a plain mapping
qCDebug(qLcVxKeyMap, "Could not find a suitable mapping for keycode: %3d, modifiers: %02x", keycode, modifiers);
return result;
}
bool skip = false;
quint16 unicode = it->unicode;
quint32 qtcode = it->qtcode;
if ((it->flags & QKeyboardMap::IsModifier) && it->special) {
// this is a modifier, i.e. Shift, Alt, ...
if (pressed)
m_modifiers |= quint8(it->special);
else
m_modifiers &= ~quint8(it->special);
} else if (qtcode >= Qt::Key_CapsLock && qtcode <= Qt::Key_ScrollLock) {
// (Caps|Num|Scroll)Lock
if (first_press) {
quint8 &lock = m_locks[qtcode - Qt::Key_CapsLock];
lock ^= 1;
switch (qtcode) {
case Qt::Key_CapsLock : result = lock ? QKeycodeAction::CapsLockOn : QKeycodeAction::CapsLockOff; break;
case Qt::Key_NumLock : result = lock ? QKeycodeAction::NumLockOn : QKeycodeAction::NumLockOff; break;
case Qt::Key_ScrollLock: result = lock ? QKeycodeAction::ScrollLockOn : QKeycodeAction::ScrollLockOff; break;
default : break;
}
}
} else if ((it->flags & QKeyboardMap::IsSystem) && it->special && first_press) {
switch (it->special) {
case QKeyboardMap::SystemReboot:
result = QKeycodeAction::Reboot;
break;
case QKeyboardMap::SystemZap:
if (!m_no_zap)
qApp->quit();
break;
case QKeyboardMap::SystemConsolePrevious:
result = QKeycodeAction::PreviousConsole;
break;
case QKeyboardMap::SystemConsoleNext:
result = QKeycodeAction::NextConsole;
break;
default:
if (it->special >= QKeyboardMap::SystemConsoleFirst &&
it->special <= QKeyboardMap::SystemConsoleLast) {
result = QKeycodeAction(
static_cast<int>(QKeycodeAction::SwitchConsoleFirst)
+ ((it->special & static_cast<int>(QKeyboardMap::SystemConsoleMask))
& static_cast<int>(QKeycodeAction::SwitchConsoleMask)));
}
break;
}
skip = true; // no need to tell Qt about it
} else if ((qtcode == Qt::Key_Multi_key) && m_do_compose) {
// the Compose key was pressed
if (first_press)
m_composing = 2;
skip = true;
} else if ((it->flags & QKeyboardMap::IsDead) && m_do_compose) {
// a Dead key was pressed
if (first_press && m_composing == 1 && m_dead_unicode == unicode) { // twice
m_composing = 0;
qtcode = Qt::Key_unknown; // otherwise it would be Qt::Key_Dead...
} else if (first_press && unicode != 0xffff) {
m_dead_unicode = unicode;
m_composing = 1;
skip = true;
} else {
skip = true;
}
}
if (!skip) {
// a normal key was pressed
const int modmask = Qt::ShiftModifier | Qt::ControlModifier | Qt::AltModifier | Qt::MetaModifier | Qt::KeypadModifier;
// we couldn't find a specific mapping for the current modifiers,
// or that mapping didn't have special modifiers:
// so just report the plain mapping with additional modifiers.
if ((it == map_plain && it != map_withmod) ||
(map_withmod && !(map_withmod->qtcode & modmask))) {
qtcode |= QVxKeyboardHandler::toQtModifiers(modifiers);
}
if (m_composing == 2 && first_press && !(it->flags & QKeyboardMap::IsModifier)) {
// the last key press was the Compose key
if (unicode != 0xffff) {
int idx = 0;
// check if this code is in the compose table at all
for ( ; idx < m_keycompose_size; ++idx) {
if (m_keycompose[idx].first == unicode)
break;
}
if (idx < m_keycompose_size) {
// found it -> simulate a Dead key press
m_dead_unicode = unicode;
unicode = 0xffff;
m_composing = 1;
skip = true;
} else {
m_composing = 0;
}
} else {
m_composing = 0;
}
} else if (m_composing == 1 && first_press && !(it->flags & QKeyboardMap::IsModifier)) {
// the last key press was a Dead key
bool valid = false;
if (unicode != 0xffff) {
int idx = 0;
// check if this code is in the compose table at all
for ( ; idx < m_keycompose_size; ++idx) {
if (m_keycompose[idx].first == m_dead_unicode && m_keycompose[idx].second == unicode)
break;
}
if (idx < m_keycompose_size) {
quint16 composed = m_keycompose[idx].result;
if (composed != 0xffff) {
unicode = composed;
qtcode = Qt::Key_unknown;
valid = true;
}
}
}
if (!valid) {
unicode = m_dead_unicode;
qtcode = Qt::Key_unknown;
}
m_composing = 0;
}
if (!skip) {
// Up until now qtcode contained both the key and modifiers. Split it.
Qt::KeyboardModifiers qtmods = Qt::KeyboardModifiers(qtcode & modmask);
qtcode &= ~modmask;
// qtmods here is the modifier state before the event, i.e. not
// including the current key in case it is a modifier.
qCDebug(qLcVxKeyMap, "Processing: uni=%04x, qt=%08x, qtmod=%08x", unicode, qtcode, int(qtmods));
// If NumLockOff and keypad key pressed remap event sent
if (!m_locks[1] && (qtmods & Qt::KeypadModifier) &&
keycode >= 71 &&
keycode <= 83 &&
keycode != 74 &&
keycode != 78) {
unicode = 0xffff;
switch (keycode) {
case 71: //7 --> Home
qtcode = Qt::Key_Home;
break;
case 72: //8 --> Up
qtcode = Qt::Key_Up;
break;
case 73: //9 --> PgUp
qtcode = Qt::Key_PageUp;
break;
case 75: //4 --> Left
qtcode = Qt::Key_Left;
break;
case 76: //5 --> Clear
qtcode = Qt::Key_Clear;
break;
case 77: //6 --> right
qtcode = Qt::Key_Right;
break;
case 79: //1 --> End
qtcode = Qt::Key_End;
break;
case 80: //2 --> Down
qtcode = Qt::Key_Down;
break;
case 81: //3 --> PgDn
qtcode = Qt::Key_PageDown;
break;
case 82: //0 --> Ins
qtcode = Qt::Key_Insert;
break;
case 83: //, --> Del
qtcode = Qt::Key_Delete;
break;
}
}
// Map SHIFT + Tab to SHIFT + Backtab, QShortcutMap knows about this translation
if (qtcode == Qt::Key_Tab && (qtmods & Qt::ShiftModifier) == Qt::ShiftModifier)
qtcode = Qt::Key_Backtab;
// Generate the QPA event.
processKeyEvent(keycode, unicode, qtcode, qtmods, pressed, autorepeat);
}
}
return result;
}
void QVxKeyboardHandler::unloadKeymap()
{
qCDebug(qLcVxKey, "Unload current keymap and restore built-in");
if (m_keymap && m_keymap != s_keymap_default)
delete [] m_keymap;
if (m_keycompose && m_keycompose != s_keycompose_default)
delete [] m_keycompose;
m_keymap = s_keymap_default;
m_keymap_size = sizeof(s_keymap_default) / sizeof(s_keymap_default[0]);
m_keycompose = s_keycompose_default;
m_keycompose_size = sizeof(s_keycompose_default) / sizeof(s_keycompose_default[0]);
// reset state, so we could switch keymaps at runtime
m_modifiers = 0;
memset(m_locks, 0, sizeof(m_locks));
m_composing = 0;
m_dead_unicode = 0xffff;
m_langLock = 0;
}
bool QVxKeyboardHandler::loadKeymap(const QString &file)
{
qCDebug(qLcVxKey, "Loading keymap %ls", qUtf16Printable(file));
QFile f(file);
if (!f.open(QIODevice::ReadOnly)) {
qWarning("Could not open keymap file '%ls'", qUtf16Printable(file));
return false;
}
// .qmap files have a very simple structure:
// quint32 magic (QKeyboard::FileMagic)
// quint32 version (1)
// quint32 keymap_size (# of struct QKeyboard::Mappings)
// quint32 keycompose_size (# of struct QKeyboard::Composings)
// all QKeyboard::Mappings via QDataStream::operator(<<|>>)
// all QKeyboard::Composings via QDataStream::operator(<<|>>)
quint32 qmap_magic, qmap_version, qmap_keymap_size, qmap_keycompose_size;
QDataStream ds(&f);
ds >> qmap_magic >> qmap_version >> qmap_keymap_size >> qmap_keycompose_size;
if (ds.status() != QDataStream::Ok || qmap_magic != QKeyboardMap::FileMagic || qmap_version != 1 || qmap_keymap_size == 0) {
qWarning("'%ls' is not a valid .qmap keymap file", qUtf16Printable(file));
return false;
}
QKeyboardMap::Mapping *qmap_keymap = new QKeyboardMap::Mapping[qmap_keymap_size];
QKeyboardMap::Composing *qmap_keycompose = qmap_keycompose_size ? new QKeyboardMap::Composing[qmap_keycompose_size] : 0;
for (quint32 i = 0; i < qmap_keymap_size; ++i)
ds >> qmap_keymap[i];
for (quint32 i = 0; i < qmap_keycompose_size; ++i)
ds >> qmap_keycompose[i];
if (ds.status() != QDataStream::Ok) {
delete [] qmap_keymap;
delete [] qmap_keycompose;
qWarning("Keymap file '%ls' cannot be loaded.", qUtf16Printable(file));
return false;
}
// unload currently active and clear state
unloadKeymap();
m_keymap = qmap_keymap;
m_keymap_size = qmap_keymap_size;
m_keycompose = qmap_keycompose;
m_keycompose_size = qmap_keycompose_size;
m_do_compose = true;
return true;
}
void QVxKeyboardHandler::switchLang()
{
m_langLock ^= 1;
}
QT_END_NAMESPACE