xcb: remove xlib dependency from core keymap assembling

Remove the Xlib dependency by extracting XConvertCase
from libxkbcommon sources (xkbcommon/src/keysym.c).

libxkbcommon >= 0.8.0 exposes case conversion APIs, but
we should prefer using the slightly adjusted version (see
the patch for more details).

This change also is necessary for follow-up cleanups.

Change-Id: Icf1716e0ad26f46a7aefb23722cfc57957754d5e
Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>

4 files changed, 238 insertions, 24 deletions

diff --git a/src/plugins/platforms/xcb/qxcbkeyboard.cpp b/src/plugins/platforms/xcb/qxcbkeyboard.cpp
index 20b5fe039a..9b107b6633 100644
--- a/src/plugins/platforms/xcb/qxcbkeyboard.cpp
+++ b/src/plugins/platforms/xcb/qxcbkeyboard.cpp
@@ -39,6 +39,7 @@
 #include "qxcbkeyboard.h"
 #include "qxcbwindow.h"
 #include "qxcbscreen.h"
+#include "qxcbxkbcommon.h"
 
 #include <qpa/qwindowsysteminterface.h>
 #include <qpa/qplatforminputcontext.h>
@@ -59,12 +60,6 @@
 #undef KeyRelease
 #endif
 
-#if QT_CONFIG(xcb_xlib)
-#include <X11/Xutil.h>
-#undef KeyPress
-#undef KeyRelease
-#endif
-
 #ifndef XK_ISO_Left_Tab
 #define XK_ISO_Left_Tab         0xFE20
 #endif
@@ -775,7 +770,6 @@ void QXcbKeyboard::printKeymapError(const char *error) const
              "directory contains recent enough contents, to update please see http://cgit.freedesktop.org/xkeyboard-config/ .");
 }
 
-#if QT_CONFIG(xcb_xlib)
 /* Look at a pair of unshifted and shifted key symbols.
  * If the 'unshifted' symbol is uppercase and there is no shifted symbol,
  * return the matching lowercase symbol; otherwise return 0.
@@ -787,18 +781,15 @@ static xcb_keysym_t getUnshiftedXKey(xcb_keysym_t unshifted, xcb_keysym_t shifte
     if (shifted != XKB_KEY_NoSymbol) // Has a shifted symbol
         return 0;
 
-    KeySym xlower;
-    KeySym xupper;
-    /* libxkbcommon >= 0.8.0 will have public API functions providing
-     * functionality equivalent to XConvertCase(), use these once the
-     * minimal libxkbcommon version is high enough. After that the
-     * xcb-xlib dependency can be removed */
-    XConvertCase(static_cast<KeySym>(unshifted), &xlower, &xupper);
-
-    if (xlower != xupper                                     // Check if symbol is cased
-        && unshifted == static_cast<xcb_keysym_t>(xupper)) { // Unshifted must be upper case
-        return static_cast<xcb_keysym_t>(xlower);
+    xcb_keysym_t xlower;
+    xcb_keysym_t xupper;
+    xkbcommon_XConvertCase(unshifted, &xlower, &xupper);
+
+    if (xlower != xupper          // Check if symbol is cased
+        && unshifted == xupper) { // Unshifted must be upper case
+        return xlower;
     }
+
     return 0;
 }
 
@@ -1066,7 +1057,6 @@ struct xkb_keymap *QXcbKeyboard::keymapFromCore()
                                       XKB_KEYMAP_FORMAT_TEXT_V1,
                                       static_cast<xkb_keymap_compile_flags>(0));
 }
-#endif
 
 void QXcbKeyboard::updateKeymap()
 {
@@ -1107,7 +1097,7 @@ void QXcbKeyboard::updateKeymap()
     if (!xkb_keymap) {
         // Read xkb RMLVO (rules, models, layouts, variants and options) names
         readXKBConfig();
-#if QT_CONFIG(xcb_xlib)
+
         bool rmlvo_is_incomplete = !xkb_names.rules || !(*xkb_names.rules)
             || !xkb_names.model || !(*xkb_names.model)
             || !xkb_names.layout || !(*xkb_names.layout);
@@ -1116,7 +1106,7 @@ void QXcbKeyboard::updateKeymap()
             xkb_keymap = keymapFromCore();
             m_keymap_is_core = xkb_keymap != 0;
         }
-#endif
+
         if (!xkb_keymap) {
             // Compile a keymap from RMLVO
             xkb_keymap = xkb_keymap_new_from_names(xkb_context, &xkb_names,
diff --git a/src/plugins/platforms/xcb/qxcbkeyboard.h b/src/plugins/platforms/xcb/qxcbkeyboard.h
index 5cb91ed315..8ea16f099b 100644
--- a/src/plugins/platforms/xcb/qxcbkeyboard.h
+++ b/src/plugins/platforms/xcb/qxcbkeyboard.h
@@ -94,9 +94,8 @@ protected:
 
     void readXKBConfig();
     void clearXKBConfig();
-#if QT_CONFIG(xcb_xlib)
     struct xkb_keymap *keymapFromCore();
-#endif
+
     // when XKEYBOARD not present on the X server
     void updateModifiers();
     typedef QMap<xcb_keysym_t, int> KeysymModifierMap;
diff --git a/src/plugins/platforms/xcb/qxcbxkbcommon.h b/src/plugins/platforms/xcb/qxcbxkbcommon.h
new file mode 100644
index 0000000000..5f2404e98e
--- /dev/null
+++ b/src/plugins/platforms/xcb/qxcbxkbcommon.h
@@ -0,0 +1,224 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the plugins of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/* XConvertCase was copied from src/3rdparty/xkbcommon/src/keysym.c,
+   which contains the following license information:
+
+   Copyright 1985, 1987, 1990, 1998  The Open Group
+
+   Permission is hereby granted, free of charge, to any person obtaining a
+   copy of this software and associated documentation files (the "Software"),
+   to deal in the Software without restriction, including without limitation
+   the rights to use, copy, modify, merge, publish, distribute, sublicense,
+   and/or sell copies of the Software, and to permit persons to whom the
+   Software is furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice shall be included in
+   all copies or substantial portions of the Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+   ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+   Except as contained in this notice, the names of the authors or their
+   institutions shall not be used in advertising or otherwise to promote the
+   sale, use or other dealings in this Software without prior written
+   authorization from the authors.
+
+
+
+   Copyright © 2009 Dan Nicholson
+
+   Permission is hereby granted, free of charge, to any person obtaining a
+   copy of this software and associated documentation files (the "Software"),
+   to deal in the Software without restriction, including without limitation
+   the rights to use, copy, modify, merge, publish, distribute, sublicense,
+   and/or sell copies of the Software, and to permit persons to whom the
+   Software is furnished to do so, subject to the following conditions:
+
+   The above copyright notice and this permission notice (including the next
+   paragraph) shall be included in all copies or substantial portions of the
+   Software.
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+   DEALINGS IN THE SOFTWARE.
+*/
+
+/*
+ The following code modifications were applied:
+
+ XConvertCase() was renamed to xkbcommon_XConvertCase(), to not confuse it
+ with Xlib's XConvertCase().
+
+ UCSConvertCase() was renamed to qt_UCSConvertCase() and function's body was
+ replaced to use Qt APIs for doing case conversion, which should give us better
+ results instead of using the less complete version from keysym.c
+*/
+
+#include <xkbcommon/xkbcommon.h>
+#include <QtCore/QChar>
+
+QT_BEGIN_NAMESPACE
+
+static void qt_UCSConvertCase(uint32_t code, xkb_keysym_t *lower, xkb_keysym_t *upper)
+{
+    *lower = QChar::toLower(code);
+    *upper = QChar::toUpper(code);
+}
+
+void xkbcommon_XConvertCase(xkb_keysym_t sym, xkb_keysym_t *lower, xkb_keysym_t *upper)
+{
+    /* Latin 1 keysym */
+    if (sym < 0x100) {
+        qt_UCSConvertCase(sym, lower, upper);
+        return;
+    }
+
+    /* Unicode keysym */
+    if ((sym & 0xff000000) == 0x01000000) {
+        qt_UCSConvertCase((sym & 0x00ffffff), lower, upper);
+        *upper |= 0x01000000;
+        *lower |= 0x01000000;
+        return;
+    }
+
+    /* Legacy keysym */
+
+    *lower = sym;
+    *upper = sym;
+
+    switch (sym >> 8) {
+    case 1: /* Latin 2 */
+        /* Assume the KeySym is a legal value (ignore discontinuities) */
+        if (sym == XKB_KEY_Aogonek)
+            *lower = XKB_KEY_aogonek;
+        else if (sym >= XKB_KEY_Lstroke && sym <= XKB_KEY_Sacute)
+            *lower += (XKB_KEY_lstroke - XKB_KEY_Lstroke);
+        else if (sym >= XKB_KEY_Scaron && sym <= XKB_KEY_Zacute)
+            *lower += (XKB_KEY_scaron - XKB_KEY_Scaron);
+        else if (sym >= XKB_KEY_Zcaron && sym <= XKB_KEY_Zabovedot)
+            *lower += (XKB_KEY_zcaron - XKB_KEY_Zcaron);
+        else if (sym == XKB_KEY_aogonek)
+            *upper = XKB_KEY_Aogonek;
+        else if (sym >= XKB_KEY_lstroke && sym <= XKB_KEY_sacute)
+            *upper -= (XKB_KEY_lstroke - XKB_KEY_Lstroke);
+        else if (sym >= XKB_KEY_scaron && sym <= XKB_KEY_zacute)
+            *upper -= (XKB_KEY_scaron - XKB_KEY_Scaron);
+        else if (sym >= XKB_KEY_zcaron && sym <= XKB_KEY_zabovedot)
+            *upper -= (XKB_KEY_zcaron - XKB_KEY_Zcaron);
+        else if (sym >= XKB_KEY_Racute && sym <= XKB_KEY_Tcedilla)
+            *lower += (XKB_KEY_racute - XKB_KEY_Racute);
+        else if (sym >= XKB_KEY_racute && sym <= XKB_KEY_tcedilla)
+            *upper -= (XKB_KEY_racute - XKB_KEY_Racute);
+        break;
+    case 2: /* Latin 3 */
+        /* Assume the KeySym is a legal value (ignore discontinuities) */
+        if (sym >= XKB_KEY_Hstroke && sym <= XKB_KEY_Hcircumflex)
+            *lower += (XKB_KEY_hstroke - XKB_KEY_Hstroke);
+        else if (sym >= XKB_KEY_Gbreve && sym <= XKB_KEY_Jcircumflex)
+            *lower += (XKB_KEY_gbreve - XKB_KEY_Gbreve);
+        else if (sym >= XKB_KEY_hstroke && sym <= XKB_KEY_hcircumflex)
+            *upper -= (XKB_KEY_hstroke - XKB_KEY_Hstroke);
+        else if (sym >= XKB_KEY_gbreve && sym <= XKB_KEY_jcircumflex)
+            *upper -= (XKB_KEY_gbreve - XKB_KEY_Gbreve);
+        else if (sym >= XKB_KEY_Cabovedot && sym <= XKB_KEY_Scircumflex)
+            *lower += (XKB_KEY_cabovedot - XKB_KEY_Cabovedot);
+        else if (sym >= XKB_KEY_cabovedot && sym <= XKB_KEY_scircumflex)
+            *upper -= (XKB_KEY_cabovedot - XKB_KEY_Cabovedot);
+        break;
+    case 3: /* Latin 4 */
+        /* Assume the KeySym is a legal value (ignore discontinuities) */
+        if (sym >= XKB_KEY_Rcedilla && sym <= XKB_KEY_Tslash)
+            *lower += (XKB_KEY_rcedilla - XKB_KEY_Rcedilla);
+        else if (sym >= XKB_KEY_rcedilla && sym <= XKB_KEY_tslash)
+            *upper -= (XKB_KEY_rcedilla - XKB_KEY_Rcedilla);
+        else if (sym == XKB_KEY_ENG)
+            *lower = XKB_KEY_eng;
+        else if (sym == XKB_KEY_eng)
+            *upper = XKB_KEY_ENG;
+        else if (sym >= XKB_KEY_Amacron && sym <= XKB_KEY_Umacron)
+            *lower += (XKB_KEY_amacron - XKB_KEY_Amacron);
+        else if (sym >= XKB_KEY_amacron && sym <= XKB_KEY_umacron)
+            *upper -= (XKB_KEY_amacron - XKB_KEY_Amacron);
+        break;
+    case 6: /* Cyrillic */
+        /* Assume the KeySym is a legal value (ignore discontinuities) */
+        if (sym >= XKB_KEY_Serbian_DJE && sym <= XKB_KEY_Serbian_DZE)
+            *lower -= (XKB_KEY_Serbian_DJE - XKB_KEY_Serbian_dje);
+        else if (sym >= XKB_KEY_Serbian_dje && sym <= XKB_KEY_Serbian_dze)
+            *upper += (XKB_KEY_Serbian_DJE - XKB_KEY_Serbian_dje);
+        else if (sym >= XKB_KEY_Cyrillic_YU && sym <= XKB_KEY_Cyrillic_HARDSIGN)
+            *lower -= (XKB_KEY_Cyrillic_YU - XKB_KEY_Cyrillic_yu);
+        else if (sym >= XKB_KEY_Cyrillic_yu && sym <= XKB_KEY_Cyrillic_hardsign)
+            *upper += (XKB_KEY_Cyrillic_YU - XKB_KEY_Cyrillic_yu);
+        break;
+    case 7: /* Greek */
+        /* Assume the KeySym is a legal value (ignore discontinuities) */
+        if (sym >= XKB_KEY_Greek_ALPHAaccent && sym <= XKB_KEY_Greek_OMEGAaccent)
+            *lower += (XKB_KEY_Greek_alphaaccent - XKB_KEY_Greek_ALPHAaccent);
+        else if (sym >= XKB_KEY_Greek_alphaaccent && sym <= XKB_KEY_Greek_omegaaccent &&
+             sym != XKB_KEY_Greek_iotaaccentdieresis &&
+             sym != XKB_KEY_Greek_upsilonaccentdieresis)
+            *upper -= (XKB_KEY_Greek_alphaaccent - XKB_KEY_Greek_ALPHAaccent);
+        else if (sym >= XKB_KEY_Greek_ALPHA && sym <= XKB_KEY_Greek_OMEGA)
+            *lower += (XKB_KEY_Greek_alpha - XKB_KEY_Greek_ALPHA);
+        else if (sym >= XKB_KEY_Greek_alpha && sym <= XKB_KEY_Greek_omega &&
+             sym != XKB_KEY_Greek_finalsmallsigma)
+            *upper -= (XKB_KEY_Greek_alpha - XKB_KEY_Greek_ALPHA);
+        break;
+    case 0x13: /* Latin 9 */
+        if (sym == XKB_KEY_OE)
+            *lower = XKB_KEY_oe;
+        else if (sym == XKB_KEY_oe)
+            *upper = XKB_KEY_OE;
+        else if (sym == XKB_KEY_Ydiaeresis)
+            *lower = XKB_KEY_ydiaeresis;
+        break;
+    }
+}
+
+QT_END_NAMESPACE
diff --git a/src/plugins/platforms/xcb/xcb_qpa_lib.pro b/src/plugins/platforms/xcb/xcb_qpa_lib.pro
index 00cce13fd0..ffc8a29116 100644
--- a/src/plugins/platforms/xcb/xcb_qpa_lib.pro
+++ b/src/plugins/platforms/xcb/xcb_qpa_lib.pro
@@ -46,7 +46,8 @@ HEADERS = \
         qxcbcursor.h \
         qxcbimage.h \
         qxcbxsettings.h \
-        qxcbsystemtraytracker.h
+        qxcbsystemtraytracker.h \
+        qxcbxkbcommon.h
 
 load(qt_build_paths)