From 24c10b0b8d7673f2d5e04766b7e3e0e65f771127 Mon Sep 17 00:00:00 2001 From: Gatis Paeglis Date: Fri, 1 Mar 2013 12:55:42 +0100 Subject: Introducing QComposeInputContext MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit When switching from Xlib to xcb platform plugin it was agreed that XIM is deprecated. Users should be using QT_IM_MODULE to load input context plugin for a more advance input method framework support. The proposed solution is to parse the compose file directly from Qt. This approach removes the overhead of communication protocols used in Xlib and/or IBUS. TableGenerator class follows [1]. The compose file is searched for in the following order: 1) If the environment variable $XCOMPOSEFILE is set, its value is used as the name of the Compose file. 2) If the user’s home directory has a file named .XCompose, it is used as the Compose file. 3) The system provided compose file is used by mapping the locale to a compose file from the list in /usr/share/X11/locale/compose.dir. Regarding step 3 - TableGenerator searches in hard-coded locations for system-provided compose files. Here I have introcuded a new environment variable QTCOMPOSE which can be used to prepend an extra location to be searched. [1] http://www.x.org/archive/X11R7.7/doc/man/man5/Compose.5.xhtml Task-number: QTBUG-28183 Change-Id: I76dcfd454f3acc23db98192a3673c1ab2af4425f Reviewed-by: Samuel Rødal --- .../compose/qcomposeplatforminputcontext.cpp | 268 +++++++++++++++++++++ 1 file changed, 268 insertions(+) create mode 100644 src/plugins/platforminputcontexts/compose/qcomposeplatforminputcontext.cpp (limited to 'src/plugins/platforminputcontexts/compose/qcomposeplatforminputcontext.cpp') diff --git a/src/plugins/platforminputcontexts/compose/qcomposeplatforminputcontext.cpp b/src/plugins/platforminputcontexts/compose/qcomposeplatforminputcontext.cpp new file mode 100644 index 0000000000..433c9eec37 --- /dev/null +++ b/src/plugins/platforminputcontexts/compose/qcomposeplatforminputcontext.cpp @@ -0,0 +1,268 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). +** Contact: http://www.qt-project.org/legal +** +** 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 Digia. For licensing terms and +** conditions see http://qt.digia.com/licensing. For further information +** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Digia gives you certain additional +** rights. These rights are described in the Digia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qcomposeplatforminputcontext.h" + +#include +#include +#include + +QT_BEGIN_NAMESPACE + +//#define DEBUG_COMPOSING + +static const int ignoreKeys[] = { + Qt::Key_Shift, + Qt::Key_Control, + Qt::Key_Meta, + Qt::Key_Alt, + Qt::Key_CapsLock, + Qt::Key_Super_L, + Qt::Key_Super_R, + Qt::Key_Hyper_L, + Qt::Key_Hyper_R, + Qt::Key_Mode_switch +}; + +static const int composingKeys[] = { + Qt::Key_Multi_key, + Qt::Key_Dead_Grave, + Qt::Key_Dead_Acute, + Qt::Key_Dead_Circumflex, + Qt::Key_Dead_Tilde, + Qt::Key_Dead_Macron, + Qt::Key_Dead_Breve, + Qt::Key_Dead_Abovedot, + Qt::Key_Dead_Diaeresis, + Qt::Key_Dead_Abovering, + Qt::Key_Dead_Doubleacute, + Qt::Key_Dead_Caron, + Qt::Key_Dead_Cedilla, + Qt::Key_Dead_Ogonek, + Qt::Key_Dead_Iota, + Qt::Key_Dead_Voiced_Sound, + Qt::Key_Dead_Semivoiced_Sound, + Qt::Key_Dead_Belowdot, + Qt::Key_Dead_Hook, + Qt::Key_Dead_Horn +}; + +QComposeInputContext::QComposeInputContext() +{ + TableGenerator reader; + m_tableState = reader.tableState(); + + if ((m_tableState & TableGenerator::NoErrors) == TableGenerator::NoErrors) { + m_composeTable = reader.composeTable(); + clearComposeBuffer(); + } +} + +bool QComposeInputContext::filterEvent(const QEvent *event) +{ + // if there were errors when generating the compose table input + // context should not try to filter anything, simply return false + if ((m_tableState & TableGenerator::NoErrors) != TableGenerator::NoErrors) + return false; + + QKeyEvent *keyEvent = (QKeyEvent *)event; + // should pass only the key presses + if (keyEvent->type() != QEvent::KeyPress) { + return false; + } + + int keyval = keyEvent->key(); + int keysym = 0; + + if (ignoreKey(keyval)) + return false; + + QString text = keyEvent->text(); + if (!composeKey(keyval) && text.isEmpty()) + return false; + + keysym = keyEvent->nativeVirtualKey(); + + int nCompose = 0; + while (m_composeBuffer[nCompose] != 0 && nCompose < QT_KEYSEQUENCE_MAX_LEN) + nCompose++; + + if (nCompose == QT_KEYSEQUENCE_MAX_LEN) { + reset(); + nCompose = 0; + } + + m_composeBuffer[nCompose] = keysym; + // check sequence + if (checkComposeTable()) + return true; + + return false; +} + +bool QComposeInputContext::isValid() const +{ + return true; +} + +void QComposeInputContext::setFocusObject(QObject *object) +{ + m_focusObject = object; +} + +void QComposeInputContext::reset() +{ + clearComposeBuffer(); +} + +void QComposeInputContext::update(Qt::InputMethodQueries q) +{ + QPlatformInputContext::update(q); +} + +static bool isDuplicate(const QComposeTableElement &lhs, const QComposeTableElement &rhs) +{ + for (size_t i = 0; i < QT_KEYSEQUENCE_MAX_LEN; i++) { + if (lhs.keys[i] != rhs.keys[i]) + return false; + } + return true; +} + +bool QComposeInputContext::checkComposeTable() +{ + QList::iterator it = + qLowerBound(m_composeTable.begin(), m_composeTable.end(), m_composeBuffer, Compare()); + + // prevent dereferencing an 'end' iterator, which would result in a crash + if (it == m_composeTable.end()) + it -= 1; + + QComposeTableElement elem = *it; + // would be nicer if qLowerBound had API that tells if the item was actually found + if (m_composeBuffer[0] != elem.keys[0]) { +#ifdef DEBUG_COMPOSING + qDebug( "### no match ###" ); +#endif + reset(); + return false; + } + // check if compose buffer is matched + for (int i=0; i < QT_KEYSEQUENCE_MAX_LEN; i++) { + + // check if partial match + if (m_composeBuffer[i] == 0 && elem.keys[i]) { +#ifdef DEBUG_COMPOSING + qDebug("### partial match ###"); +#endif + return true; + } + + if (m_composeBuffer[i] != elem.keys[i]) { +#ifdef DEBUG_COMPOSING + qDebug("### different entry ###"); +#endif + reset(); + return i != 0; + } + } +#ifdef DEBUG_COMPOSING + qDebug("### match exactly ###"); +#endif + + // check if the key sequence is overwriten - see the comment in + // TableGenerator::orderComposeTable() + int next = 1; + do { + // if we are at the end of the table, then we have nothing to do here + if (it + next != m_composeTable.end()) { + QComposeTableElement nextElem = *(it + next); + if (isDuplicate(elem, nextElem)) { + elem = nextElem; + next++; + continue; + } else { + break; + } + } + break; + } while (true); + + commitText(elem.value); + reset(); + + return true; +} + +void QComposeInputContext::commitText(uint character) const +{ + QInputMethodEvent event; + event.setCommitString(QChar(character)); + QCoreApplication::sendEvent(m_focusObject, &event); +} + +bool QComposeInputContext::ignoreKey(int keyval) const +{ + for (uint i = 0; i < (sizeof(ignoreKeys) / sizeof(ignoreKeys[0])); i++) + if (keyval == ignoreKeys[i]) + return true; + + return false; +} + +bool QComposeInputContext::composeKey(int keyval) const +{ + for (uint i = 0; i < (sizeof(composingKeys) / sizeof(composingKeys[0])); i++) + if (keyval == composingKeys[i]) + return true; + + return false; +} + +void QComposeInputContext::clearComposeBuffer() +{ + for (uint i=0; i < (sizeof(m_composeBuffer) / sizeof(int)); i++) + m_composeBuffer[i] = 0; +} + +QComposeInputContext::~QComposeInputContext() {} + +QT_END_NAMESPACE -- cgit v1.2.3