1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2018 The Qt Company Ltd. 4 ** Contact: https://www.qt.io/licensing/ 5 ** 6 ** This file is part of the QtGui module of the Qt Toolkit. 7 ** 8 ** $QT_BEGIN_LICENSE:LGPL$ 9 ** Commercial License Usage 10 ** Licensees holding valid commercial Qt licenses may use this file in 11 ** accordance with the commercial license agreement provided with the 12 ** Software or, alternatively, in accordance with the terms contained in 13 ** a written agreement between you and The Qt Company. For licensing terms 14 ** and conditions see https://www.qt.io/terms-conditions. For further 15 ** information use the contact form at https://www.qt.io/contact-us. 16 ** 17 ** GNU Lesser General Public License Usage 18 ** Alternatively, this file may be used under the terms of the GNU Lesser 19 ** General Public License version 3 as published by the Free Software 20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the 21 ** packaging of this file. Please review the following information to 22 ** ensure the GNU Lesser General Public License version 3 requirements 23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. 24 ** 25 ** GNU General Public License Usage 26 ** Alternatively, this file may be used under the terms of the GNU 27 ** General Public License version 2.0 or (at your option) the GNU General 28 ** Public license version 3 or any later version approved by the KDE Free 29 ** Qt Foundation. The licenses are as published by the Free Software 30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 31 ** included in the packaging of this file. Please review the following 32 ** information to ensure the GNU General Public License requirements will 33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and 34 ** https://www.gnu.org/licenses/gpl-3.0.html. 35 ** 36 ** $QT_END_LICENSE$ 37 ** 38 ****************************************************************************/ 39 40 #ifndef QXKBCOMMON_P_H 41 #define QXKBCOMMON_P_H 42 43 // 44 // W A R N I N G 45 // ------------- 46 // 47 // This file is not part of the Qt API. It exists purely as an 48 // implementation detail. This header file may change from version to 49 // version without notice, or even be removed. 50 // 51 // We mean it. 52 // 53 54 #include <QtCore/QString> 55 #include <QtCore/QVector> 56 #include <QtCore/QLoggingCategory> 57 #include <QtCore/QList> 58 59 #include <xkbcommon/xkbcommon.h> 60 61 #include <memory> 62 63 QT_BEGIN_NAMESPACE 64 65 Q_DECLARE_LOGGING_CATEGORY(lcXkbcommon) 66 67 class QEvent; 68 class QKeyEvent; 69 class QPlatformInputContext; 70 71 class QXkbCommon 72 { 73 public: 74 static QString lookupString(struct xkb_state *state, xkb_keycode_t code); 75 static QString lookupStringNoKeysymTransformations(xkb_keysym_t keysym); 76 77 static QVector<xkb_keysym_t> toKeysym(QKeyEvent *event); 78 79 static int keysymToQtKey(xkb_keysym_t keysym, Qt::KeyboardModifiers modifiers); 80 static int keysymToQtKey(xkb_keysym_t keysym, Qt::KeyboardModifiers modifiers, 81 xkb_state *state, xkb_keycode_t code, 82 bool superAsMeta = false, bool hyperAsMeta = false); 83 84 // xkbcommon_* API is part of libxkbcommon internals, with modifications as 85 // desribed in the header of the implementation file. 86 static void xkbcommon_XConvertCase(xkb_keysym_t sym, xkb_keysym_t *lower, xkb_keysym_t *upper); 87 static xkb_keysym_t qxkbcommon_xkb_keysym_to_upper(xkb_keysym_t ks); 88 89 static Qt::KeyboardModifiers modifiers(struct xkb_state *state); 90 91 static QList<int> possibleKeys(xkb_state *state, const QKeyEvent *event, 92 bool superAsMeta = false, bool hyperAsMeta = false); 93 94 static void verifyHasLatinLayout(xkb_keymap *keymap); 95 static xkb_keysym_t lookupLatinKeysym(xkb_state *state, xkb_keycode_t keycode); 96 isLatin1(xkb_keysym_t sym)97 static bool isLatin1(xkb_keysym_t sym) { 98 return sym <= 0xff; 99 } isKeypad(xkb_keysym_t sym)100 static bool isKeypad(xkb_keysym_t sym) { 101 return sym >= XKB_KEY_KP_Space && sym <= XKB_KEY_KP_9; 102 } 103 104 static void setXkbContext(QPlatformInputContext *inputContext, struct xkb_context *context); 105 106 struct XKBStateDeleter { operatorXKBStateDeleter107 void operator()(struct xkb_state *state) const { return xkb_state_unref(state); } 108 }; 109 struct XKBKeymapDeleter { operatorXKBKeymapDeleter110 void operator()(struct xkb_keymap *keymap) const { return xkb_keymap_unref(keymap); } 111 }; 112 struct XKBContextDeleter { operatorXKBContextDeleter113 void operator()(struct xkb_context *context) const { return xkb_context_unref(context); } 114 }; 115 using ScopedXKBState = std::unique_ptr<struct xkb_state, XKBStateDeleter>; 116 using ScopedXKBKeymap = std::unique_ptr<struct xkb_keymap, XKBKeymapDeleter>; 117 using ScopedXKBContext = std::unique_ptr<struct xkb_context, XKBContextDeleter>; 118 }; 119 120 QT_END_NAMESPACE 121 122 #endif // QXKBCOMMON_P_H 123