Fix text-input support for new API

Update text input support to upstream text-input protocol v2 from
wayland-protocols. Remove support for input-method protocol for now.

Map text-input protocol on compositor side to the Qt input method API,
this allows to use any qt platform input method on compositor side
(especially qtvirtualkeyboard). Add support for qtvirtualkeyboard to
pure-qml example.

Implement all missing functions of the text-input protocol.

Change-Id: I597451ff65454a63dff86026b6a8d1ffbe07ce02
Done-with: Zeno Endemann <zeno.endemann@kdab.com>
Reviewed-by: Giulio Camuffo <giulio.camuffo@kdab.com>

1 files changed, 381 insertions, 125 deletions

diff --git a/src/client/qwaylandinputcontext.cpp b/src/client/qwaylandinputcontext.cpp
index 00f6a4303..aeaf415d2 100644
--- a/src/client/qwaylandinputcontext.cpp
+++ b/src/client/qwaylandinputcontext.cpp
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2016 Klarälvdalens Datakonsult AB (KDAB).
+** Copyright (C) 2016 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the QtWaylandClient module of the Qt Toolkit.
@@ -40,147 +40,358 @@
 
 #include "qwaylandinputcontext_p.h"
 
-#include <QGuiApplication>
-#include <QWindow>
-#ifndef QT_NO_WAYLAND_XKB
-#include <xkbcommon/xkbcommon.h>
-#endif
+#include <QtGui/QGuiApplication>
+#include <QtGui/QTextCharFormat>
+#include <QtGui/QWindow>
+#include <QtGui/private/qguiapplication_p.h>
+#include <QtGui/qpa/qplatformintegration.h>
 
 #include "qwaylanddisplay_p.h"
 #include "qwaylandinputdevice_p.h"
+#include "qwaylandinputmethodeventbuilder.h"
 #include "qwaylandwindow_p.h"
+#include "qwaylandxkb.h"
 
 QT_BEGIN_NAMESPACE
 
+Q_LOGGING_CATEGORY(qLcQpaInputMethods, "qt.qpa.input.methods")
+
 namespace QtWaylandClient {
 
-static Qt::Key toQtKey(uint32_t sym)
-{
-#ifndef QT_NO_WAYLAND_XKB
-    switch (static_cast<xkb_keysym_t>(sym)) {
-    case XKB_KEY_BackSpace:
-        return Qt::Key_Backspace;
-    case XKB_KEY_Return:
-        return Qt::Key_Return;
-    case XKB_KEY_Left:
-        return Qt::Key_Left;
-    case XKB_KEY_Up:
-        return Qt::Key_Up;
-    case XKB_KEY_Right:
-        return Qt::Key_Right;
-    case XKB_KEY_Down:
-        return Qt::Key_Down;
-    default:
-        return Qt::Key_unknown;
-    }
-#else
-    Q_UNUSED(sym)
-    return Qt::Key_unknown;
-#endif
+namespace {
+const Qt::InputMethodQueries supportedQueries = Qt::ImEnabled |
+                                                Qt::ImSurroundingText |
+                                                Qt::ImCursorPosition |
+                                                Qt::ImAnchorPosition |
+                                                Qt::ImHints |
+                                                Qt::ImCursorRectangle |
+                                                Qt::ImPreferredLanguage;
 }
 
-static QEvent::Type toQEventType(uint32_t state)
+QWaylandTextInput::QWaylandTextInput(QWaylandDisplay *display, struct ::zwp_text_input_v2 *text_input)
+    : QtWayland::zwp_text_input_v2(text_input)
+    , m_display(display)
+    , m_builder()
+    , m_serial(0)
+    , m_surface(nullptr)
+    , m_preeditCommit()
+    , m_inputPanelVisible(false)
+    , m_keyboardRectangle()
+    , m_locale()
+    , m_inputDirection(Qt::LayoutDirectionAuto)
+    , m_resetCallback(nullptr)
 {
-    switch (static_cast<wl_keyboard_key_state>(state)) {
-    default:
-    case WL_KEYBOARD_KEY_STATE_PRESSED:
-        return QEvent::KeyPress;
-    case WL_KEYBOARD_KEY_STATE_RELEASED:
-        return QEvent::KeyRelease;
-    }
 }
 
-QWaylandTextInput::QWaylandTextInput(struct ::wl_text_input *text_input)
-    : QtWayland::wl_text_input(text_input)
-    , m_commit()
-    , m_serial(0)
-    , m_resetSerial(0)
+QWaylandTextInput::~QWaylandTextInput()
 {
+    if (m_resetCallback)
+        wl_callback_destroy(m_resetCallback);
 }
 
-QString QWaylandTextInput::commitString() const
+void QWaylandTextInput::reset()
 {
-    return m_commit;
+    m_builder.reset();
+    m_preeditCommit = QString();
+    updateState(Qt::ImQueryAll, update_state_reset);
 }
 
-void QWaylandTextInput::reset()
+void QWaylandTextInput::commit()
 {
-    wl_text_input::reset();
-    updateState();
-    m_resetSerial = m_serial;
+    if (QObject *o = QGuiApplication::focusObject()) {
+        QInputMethodEvent event;
+        event.setCommitString(m_preeditCommit);
+        QCoreApplication::sendEvent(o, &event);
+    }
+
+    reset();
 }
 
-void QWaylandTextInput::updateState()
+const wl_callback_listener QWaylandTextInput::callbackListener = {
+    QWaylandTextInput::resetCallback
+};
+
+void QWaylandTextInput::resetCallback(void *data, wl_callback *, uint32_t)
+{
+    QWaylandTextInput *self = static_cast<QWaylandTextInput*>(data);
+
+    if (self->m_resetCallback) {
+        wl_callback_destroy(self->m_resetCallback);
+        self->m_resetCallback = nullptr;
+    }
+}
+
+void QWaylandTextInput::updateState(Qt::InputMethodQueries queries, uint32_t flags)
 {
     if (!QGuiApplication::focusObject())
         return;
 
-    QInputMethodQueryEvent event(Qt::ImQueryAll);
+    if (!QGuiApplication::focusWindow() || !QGuiApplication::focusWindow()->handle())
+        return;
+
+    struct ::wl_surface *surface = static_cast<QWaylandWindow *>(QGuiApplication::focusWindow()->handle())->object();
+    if (!surface || (surface != m_surface))
+        return;
+
+    queries &= supportedQueries;
+
+    // Surrounding text, cursor and anchor positions are transferred together
+    if ((queries & Qt::ImSurroundingText) || (queries & Qt::ImCursorPosition) || (queries & Qt::ImAnchorPosition))
+        queries |= Qt::ImSurroundingText | Qt::ImCursorPosition | Qt::ImAnchorPosition;
+
+    QInputMethodQueryEvent event(queries);
     QCoreApplication::sendEvent(QGuiApplication::focusObject(), &event);
 
-    const QString &text = event.value(Qt::ImSurroundingText).toString();
-    const int cursor = event.value(Qt::ImCursorPosition).toInt();
-    const int anchor = event.value(Qt::ImAnchorPosition).toInt();
+    if ((queries & Qt::ImSurroundingText) || (queries & Qt::ImCursorPosition) || (queries & Qt::ImAnchorPosition)) {
+        QString text = event.value(Qt::ImSurroundingText).toString();
+        int cursor = event.value(Qt::ImCursorPosition).toInt();
+        int anchor = event.value(Qt::ImAnchorPosition).toInt();
+
+        // Make sure text is not too big
+        if (text.toUtf8().size() > 2048) {
+            int c = qAbs(cursor - anchor) <= 512 ? qMin(cursor, anchor) + qAbs(cursor - anchor) / 2: cursor;
+
+            const int offset = c - qBound(0, c, 512 - qMin(text.size() - c, 256));
+            text = text.mid(offset + c - 256, 512);
+            cursor -= offset;
+            anchor -= offset;
+        }
+
+        set_surrounding_text(text, text.leftRef(cursor).toUtf8().size(), text.leftRef(anchor).toUtf8().size());
+    }
+
+    if (queries & Qt::ImHints) {
+        QWaylandInputMethodContentType contentType = QWaylandInputMethodContentType::convert(static_cast<Qt::InputMethodHints>(event.value(Qt::ImHints).toInt()));
+        set_content_type(contentType.hint, contentType.purpose);
+    }
+
+    if (queries & Qt::ImCursorRectangle) {
+        const QRect &cRect = event.value(Qt::ImCursorRectangle).toRect();
+        const QRect &tRect = QGuiApplication::inputMethod()->inputItemTransform().mapRect(cRect);
+        set_cursor_rectangle(tRect.x(), tRect.y(), tRect.width(), tRect.height());
+    }
+
+    if (queries & Qt::ImPreferredLanguage) {
+        const QString &language = event.value(Qt::ImPreferredLanguage).toString();
+        set_preferred_language(language);
+    }
+
+    update_state(m_serial, flags);
+    if (flags != update_state_change) {
+        if (m_resetCallback)
+            wl_callback_destroy(m_resetCallback);
+        m_resetCallback = wl_display_sync(m_display->wl_display());
+        wl_callback_add_listener(m_resetCallback, &QWaylandTextInput::callbackListener, this);
+    }
+}
+
+bool QWaylandTextInput::isInputPanelVisible() const
+{
+    return m_inputPanelVisible;
+}
+
+QRectF QWaylandTextInput::keyboardRect() const
+{
+    return m_keyboardRectangle;
+}
+
+QLocale QWaylandTextInput::locale() const
+{
+    return m_locale;
+}
+
+Qt::LayoutDirection QWaylandTextInput::inputDirection() const
+{
+    return m_inputDirection;
+}
 
-    set_surrounding_text(text, text.leftRef(cursor).toUtf8().size(), text.leftRef(anchor).toUtf8().size());
+void QWaylandTextInput::zwp_text_input_v2_enter(uint32_t serial, ::wl_surface *surface)
+{
+    m_serial = serial;
+    m_surface = surface;
 
-    commit_state(++m_serial);
+    updateState(Qt::ImQueryAll, update_state_enter);
 }
 
-void QWaylandTextInput::text_input_preedit_string(uint32_t serial, const QString &text, const QString &commit)
+void QWaylandTextInput::zwp_text_input_v2_leave(uint32_t serial, ::wl_surface *surface)
 {
-    Q_UNUSED(serial)
+    m_serial = serial;
+
+    if (m_surface != surface) {
+        qCDebug(qLcQpaInputMethods()) << Q_FUNC_INFO << "Got leave event for surface" << surface << "focused surface" << m_surface;
+    }
+
+    m_surface = nullptr;
+}
+
+void QWaylandTextInput::zwp_text_input_v2_modifiers_map(wl_array *map)
+{
+    QList<QByteArray> modifiersMap = QByteArray::fromRawData(static_cast<const char*>(map->data), map->size).split('\0');
+
+    m_modifiersMap.clear();
+
+    Q_FOREACH (const QByteArray &modifier, modifiersMap) {
+        if (modifier == "Shift")
+            m_modifiersMap.append(Qt::ShiftModifier);
+        else if (modifier == "Control")
+            m_modifiersMap.append(Qt::ControlModifier);
+        else if (modifier == "Alt")
+            m_modifiersMap.append(Qt::AltModifier);
+        else if (modifier == "Mod1")
+            m_modifiersMap.append(Qt::AltModifier);
+        else if (modifier == "Mod4")
+            m_modifiersMap.append(Qt::MetaModifier);
+        else
+            m_modifiersMap.append(Qt::NoModifier);
+    }
+}
+
+void QWaylandTextInput::zwp_text_input_v2_input_panel_state(uint32_t visible, int32_t x, int32_t y, int32_t width, int32_t height)
+{
+    const bool inputPanelVisible = (visible == input_panel_visibility_visible);
+    if (m_inputPanelVisible != inputPanelVisible) {
+        m_inputPanelVisible = inputPanelVisible;
+        QGuiApplicationPrivate::platformIntegration()->inputContext()->emitInputPanelVisibleChanged();
+    }
+    const QRectF keyboardRectangle(x, y, width, height);
+    if (m_keyboardRectangle != keyboardRectangle) {
+        m_keyboardRectangle = keyboardRectangle;
+        QGuiApplicationPrivate::platformIntegration()->inputContext()->emitKeyboardRectChanged();
+    }
+}
+
+void QWaylandTextInput::zwp_text_input_v2_preedit_string(const QString &text, const QString &commit)
+{
+    if (m_resetCallback) {
+        qCDebug(qLcQpaInputMethods()) << "discard preedit_string: reset not confirmed";
+        m_builder.reset();
+        return;
+    }
+
     if (!QGuiApplication::focusObject())
         return;
 
-    m_commit = commit;
-    QList<QInputMethodEvent::Attribute> attributes;
-    QInputMethodEvent event(text, attributes);
+    QInputMethodEvent event = m_builder.buildPreedit(text);
+
+    m_builder.reset();
+    m_preeditCommit = commit;
+
     QCoreApplication::sendEvent(QGuiApplication::focusObject(), &event);
 }
 
-void QWaylandTextInput::text_input_commit_string(uint32_t serial, const QString &text)
+void QWaylandTextInput::zwp_text_input_v2_preedit_styling(uint32_t index, uint32_t length, uint32_t style)
+{
+    m_builder.addPreeditStyling(index, length, style);
+}
+
+void QWaylandTextInput::zwp_text_input_v2_preedit_cursor(int32_t index)
 {
-    Q_UNUSED(serial);
+    m_builder.setPreeditCursor(index);
+}
+
+void QWaylandTextInput::zwp_text_input_v2_commit_string(const QString &text)
+{
+    if (m_resetCallback) {
+        qCDebug(qLcQpaInputMethods()) << "discard commit_string: reset not confirmed";
+        m_builder.reset();
+        return;
+    }
+
     if (!QGuiApplication::focusObject())
         return;
 
-    QInputMethodEvent event;
-    event.setCommitString(text);
+    QInputMethodEvent event = m_builder.buildCommit(text);
+
+    m_builder.reset();
+
     QCoreApplication::sendEvent(QGuiApplication::focusObject(), &event);
+}
 
-    m_commit = QString();
+void QWaylandTextInput::zwp_text_input_v2_cursor_position(int32_t index, int32_t anchor)
+{
+    m_builder.setCursorPosition(index, anchor);
 }
 
-void QWaylandTextInput::text_input_enter(wl_surface *)
+void QWaylandTextInput::zwp_text_input_v2_delete_surrounding_text(uint32_t before_length, uint32_t after_length)
 {
-    updateState();
-    m_resetSerial = m_serial;
+    m_builder.setDeleteSurroundingText(before_length, after_length);
 }
 
-void QWaylandTextInput::text_input_leave()
+void QWaylandTextInput::zwp_text_input_v2_keysym(uint32_t time, uint32_t sym, uint32_t state, uint32_t modifiers)
 {
-    if (!m_commit.isEmpty())
-        text_input_commit_string(0, m_commit);
+    if (m_resetCallback) {
+        qCDebug(qLcQpaInputMethods()) << "discard keysym: reset not confirmed";
+        return;
+    }
+
+    if (!QGuiApplication::focusWindow())
+        return;
+
+    Qt::KeyboardModifiers qtModifiers = modifiersToQtModifiers(modifiers);
+
+    QEvent::Type type = QWaylandXkb::toQtEventType(state);
+    const QString &text = QWaylandXkb::textFromKeysym(sym, qtModifiers);
+    int qtkey = QWaylandXkb::keysymToQtKey(sym, qtModifiers, text);
+
+    QWindowSystemInterface::handleKeyEvent(QGuiApplication::focusWindow(),
+                                           time, type, qtkey, qtModifiers, text);
 }
 
-void QWaylandTextInput::text_input_keysym(uint32_t serial, uint32_t time, uint32_t sym, uint32_t state, uint32_t modifiers)
+void QWaylandTextInput::zwp_text_input_v2_language(const QString &language)
 {
-    Q_UNUSED(serial);
-    Q_UNUSED(time);
-    Q_UNUSED(modifiers);
-    if (!QGuiApplication::focusObject())
+    if (m_resetCallback) {
+        qCDebug(qLcQpaInputMethods()) << "discard language: reset not confirmed";
         return;
+    }
 
-    // TODO: Convert modifiers to Qt::KeyboardModifiers.
-    QKeyEvent event(toQEventType(state), toQtKey(sym), Qt::NoModifier);
-    QCoreApplication::sendEvent(qGuiApp->focusWindow(), &event);
+    const QLocale locale(language);
+    if (m_locale != locale) {
+        m_locale = locale;
+        QGuiApplicationPrivate::platformIntegration()->inputContext()->emitLocaleChanged();
+    }
+}
+
+void QWaylandTextInput::zwp_text_input_v2_text_direction(uint32_t direction)
+{
+    if (m_resetCallback) {
+        qCDebug(qLcQpaInputMethods()) << "discard text_direction: reset not confirmed";
+        return;
+    }
+
+    const Qt::LayoutDirection inputDirection = (direction == text_direction_auto) ? Qt::LayoutDirectionAuto :
+                                               (direction == text_direction_ltr) ? Qt::LeftToRight :
+                                               (direction == text_direction_rtl) ? Qt::RightToLeft : Qt::LayoutDirectionAuto;
+    if (m_inputDirection != inputDirection) {
+        m_inputDirection = inputDirection;
+        QGuiApplicationPrivate::platformIntegration()->inputContext()->emitInputDirectionChanged(m_inputDirection);
+    }
+}
+
+void QWaylandTextInput::zwp_text_input_v2_input_method_changed(uint32_t serial, uint32_t flags)
+{
+    Q_UNUSED(flags);
+
+    m_serial = serial;
+    updateState(Qt::ImQueryAll, update_state_full);
+}
+
+Qt::KeyboardModifiers QWaylandTextInput::modifiersToQtModifiers(uint32_t modifiers)
+{
+    Qt::KeyboardModifiers ret = Qt::NoModifier;
+    for (int i = 0; modifiers >>= 1; ++i) {
+        ret |= m_modifiersMap[i];
+    }
+    return ret;
 }
 
 QWaylandInputContext::QWaylandInputContext(QWaylandDisplay *display)
     : QPlatformInputContext()
     , mDisplay(display)
-    , mTextInput()
+    , mCurrentWindow()
+{
+}
+
+QWaylandInputContext::~QWaylandInputContext()
 {
 }
 
@@ -191,96 +402,141 @@ bool QWaylandInputContext::isValid() const
 
 void QWaylandInputContext::reset()
 {
-    if (!ensureTextInput())
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
+
+    QPlatformInputContext::reset();
+
+    if (!textInput())
         return;
 
-    mTextInput->reset();
+    textInput()->reset();
 }
 
 void QWaylandInputContext::commit()
 {
-    if (!ensureTextInput())
-        return;
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
 
-    if (!QGuiApplication::focusObject())
+    if (!textInput())
         return;
 
-    QInputMethodEvent event;
-    event.setCommitString(mTextInput->commitString());
-    QCoreApplication::sendEvent(QGuiApplication::focusObject(), &event);
-
-    mTextInput->reset();
+    textInput()->commit();
 }
 
 void QWaylandInputContext::update(Qt::InputMethodQueries queries)
 {
-    Q_UNUSED(queries);
-    if (!ensureTextInput())
-        return;
-
-    mTextInput->updateState();
-}
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO << queries;
 
-void QWaylandInputContext::invokeAction(QInputMethod::Action, int cursorPosition)
-{
-    if (!ensureTextInput())
+    if (!QGuiApplication::focusObject() || !textInput())
         return;
 
-    mTextInput->invoke_action(0, cursorPosition); // FIXME button, to UTF8 cursor position
+    if (mCurrentWindow && mCurrentWindow->handle() && !inputMethodAccepted()) {
+        struct ::wl_surface *surface = static_cast<QWaylandWindow *>(mCurrentWindow->handle())->object();
+        textInput()->disable(surface);
+        mCurrentWindow.clear();
+    } else if (!mCurrentWindow && inputMethodAccepted()) {
+        QWindow *window = QGuiApplication::focusWindow();
+        if (window && window->handle()) {
+            struct ::wl_surface *surface = static_cast<QWaylandWindow *>(window->handle())->object();
+            textInput()->enable(surface);
+            mCurrentWindow = window;
+        }
+    }
+
+    textInput()->updateState(queries, QtWayland::zwp_text_input_v2::update_state_change);
 }
 
 void QWaylandInputContext::showInputPanel()
 {
-    if (!ensureTextInput())
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
+
+    if (!textInput())
         return;
 
-    mTextInput->show_input_panel();
+    textInput()->show_input_panel();
 }
 
 void QWaylandInputContext::hideInputPanel()
 {
-    if (!ensureTextInput())
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
+
+    if (!textInput())
         return;
 
-    mTextInput->hide_input_panel();
+    textInput()->hide_input_panel();
 }
 
 bool QWaylandInputContext::isInputPanelVisible() const
 {
-    return false;
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
+
+    if (!textInput())
+        return QPlatformInputContext::isInputPanelVisible();
+
+    return textInput()->isInputPanelVisible();
 }
 
-void QWaylandInputContext::setFocusObject(QObject *object)
+QRectF QWaylandInputContext::keyboardRect() const
 {
-    if (!ensureTextInput())
-        return;
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
 
-    if (!object) {
-        mTextInput->deactivate(mDisplay->defaultInputDevice()->wl_seat());
-        return;
-    }
+    if (!textInput())
+        return QPlatformInputContext::keyboardRect();
 
-    QWindow *window = QGuiApplication::focusWindow();
-    if (!window || !window->handle())
-        return;
+    return textInput()->keyboardRect();
+}
 
-    struct ::wl_surface *surface = static_cast<QWaylandWindow *>(window->handle())->object();
-    mTextInput->activate(mDisplay->defaultInputDevice()->wl_seat(), surface);
+QLocale QWaylandInputContext::locale() const
+{
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
+
+    if (!textInput())
+        return QPlatformInputContext::locale();
+
+    return textInput()->locale();
 }
 
-bool QWaylandInputContext::ensureTextInput()
+Qt::LayoutDirection QWaylandInputContext::inputDirection() const
 {
-    if (mTextInput)
-        return true;
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
+
+    if (!textInput())
+        return QPlatformInputContext::inputDirection();
+
+    return textInput()->inputDirection();
+}
+
+void QWaylandInputContext::setFocusObject(QObject *)
+{
+    qCDebug(qLcQpaInputMethods) << Q_FUNC_INFO;
+
+    if (!textInput())
+        return;
 
-    if (!isValid())
-        return false;
+    QWindow *window = QGuiApplication::focusWindow();
 
-    mTextInput.reset(new QWaylandTextInput(mDisplay->textInputManager()->create_text_input()));
-    return true;
+    if (mCurrentWindow && mCurrentWindow->handle()) {
+        if (mCurrentWindow.data() != window || !inputMethodAccepted()) {
+            struct ::wl_surface *surface = static_cast<QWaylandWindow *>(mCurrentWindow->handle())->object();
+            textInput()->disable(surface);
+            mCurrentWindow.clear();
+        }
+    }
+
+    if (window && window->handle() && inputMethodAccepted()) {
+        if (mCurrentWindow.data() != window) {
+            struct ::wl_surface *surface = static_cast<QWaylandWindow *>(window->handle())->object();
+            textInput()->enable(surface);
+            mCurrentWindow = window;
+        }
+        textInput()->updateState(Qt::ImQueryAll, QtWayland::zwp_text_input_v2::update_state_enter);
+    }
 }
 
+QWaylandTextInput *QWaylandInputContext::textInput() const
+{
+    return mDisplay->defaultInputDevice()->textInput();
 }
 
-QT_END_NAMESPACE
+}
 
+QT_END_NAMESPACE