-
Kalle Viironen authored
Change-Id: I0dc6af72a3ae52a0b97b704df84fb1a8197aeeb8 Reviewed-by:
Jani Heikkinen <jani.heikkinen@theqtcompany.com> Reviewed-by:
Rainer Keller <rainer.keller@theqtcompany.com>
bfd9b67b
/******************************************************************************** Copyright (C) 2016 The Qt Company Ltd.** Contact: https://www.qt.io/licensing/**** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit.**** $QT_BEGIN_LICENSE:GPL$** 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 General Public License Usage** Alternatively, this file may be used under the terms of the GNU** General Public License version 3 or (at your option) 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.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-3.0.html.**** $QT_END_LICENSE$******************************************************************************/#include "pinyininputmethod.h"#include "pinyindecoderservice.h"#include "inputcontext.h"#include "virtualkeyboarddebug.h"namespace QtVirtualKeyboard {class PinyinInputMethodPrivate : public AbstractInputMethodPrivate{ Q_DECLARE_PUBLIC(PinyinInputMethod)public: enum State { Idle, Input, Predict }; PinyinInputMethodPrivate(PinyinInputMethod *q_ptr) : q_ptr(q_ptr), inputMode(InputEngine::Pinyin), pinyinDecoderService(PinyinDecoderService::getInstance()), state(Idle), surface(), totalChoicesNum(0), candidatesList(), fixedLen(0), composingStr(), activeCmpsLen(0), finishSelection(true), posDelSpl(-1), isPosInSpl(false) { } void resetToIdleState() { Q_Q(PinyinInputMethod); InputContext *inputContext = q->inputContext();7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
// Disable the user dictionary when entering sensitive data
if (inputContext) {
bool userDictionaryEnabled = !inputContext->inputMethodHints().testFlag(Qt::ImhSensitiveData);
if (userDictionaryEnabled != pinyinDecoderService->isUserDictionaryEnabled())
pinyinDecoderService->setUserDictionary(userDictionaryEnabled);
}
if (state == Idle)
return;
state = Idle;
surface.clear();
fixedLen = 0;
finishSelection = true;
composingStr.clear();
if (inputContext)
inputContext->setPreeditText("");
activeCmpsLen = 0;
posDelSpl = -1;
isPosInSpl = false;
resetCandidates();
}
bool addSpellingChar(QChar ch, bool reset)
{
if (reset) {
surface.clear();
pinyinDecoderService->resetSearch();
}
if (ch == Qt::Key_Apostrophe) {
if (surface.isEmpty())
return false;
if (surface.endsWith(ch))
return true;
}
surface.append(ch);
return true;
}
bool removeSpellingChar()
{
if (surface.isEmpty())
return false;
QVector<int> splStart = pinyinDecoderService->spellingStartPositions();
isPosInSpl = (surface.length() <= splStart[fixedLen + 1]);
posDelSpl = isPosInSpl ? fixedLen - 1 : surface.length() - 1;
return true;
}
void chooseAndUpdate(int candId)
{
Q_Q(PinyinInputMethod);
if (state == Predict)
choosePredictChoice(candId);
else
chooseDecodingCandidate(candId);
if (composingStr.length() > 0) {
if ((candId >= 0 || finishSelection) && composingStr.length() == fixedLen) {
QString resultStr = getComposingStrActivePart();
tryPredict();
q->inputContext()->commit(resultStr);
} else if (state == Idle) {
state = Input;
}
} else {
tryPredict();
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
}
}
bool chooseAndFinish()
{
if (state == Predict || !totalChoicesNum)
return false;
chooseAndUpdate(0);
if (state != Predict && totalChoicesNum > 0)
chooseAndUpdate(0);
return true;
}
int candidatesCount()
{
return totalChoicesNum;
}
QString candidateAt(int index)
{
if (index < 0 || index >= totalChoicesNum)
return QString();
if (index >= candidatesList.size()) {
int fetchMore = qMin(index + 20, totalChoicesNum - candidatesList.size());
candidatesList.append(pinyinDecoderService->fetchCandidates(candidatesList.size(), fetchMore, fixedLen));
if (index == 0 && totalChoicesNum == 1) {
int surfaceDecodedLen = pinyinDecoderService->pinyinStringLength(true);
if (surfaceDecodedLen < surface.length())
candidatesList[0] = candidatesList[0] + surface.mid(surfaceDecodedLen).toLower();
}
}
return index < candidatesList.size() ? candidatesList[index] : QString();
}
void chooseDecodingCandidate(int candId)
{
Q_Q(PinyinInputMethod);
Q_ASSERT(state != Predict);
int result = 0;
if (candId < 0) {
if (surface.length() > 0) {
if (posDelSpl < 0) {
result = pinyinDecoderService->search(surface);
} else {
result = pinyinDecoderService->deleteSearch(posDelSpl, isPosInSpl, false);
posDelSpl = -1;
}
}
} else {
if (totalChoicesNum > 1) {
result = pinyinDecoderService->chooceCandidate(candId);
} else {
QString resultStr;
if (totalChoicesNum == 1) {
QString undecodedStr = candId < candidatesList.length() ? candidatesList.at(candId) : QString();
resultStr = pinyinDecoderService->candidateAt(0).mid(0, fixedLen) + undecodedStr;
}
resetToIdleState();
if (!resultStr.isEmpty())
q->inputContext()->commit(resultStr);
return;
}
}
resetCandidates();
totalChoicesNum = result;
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
surface = pinyinDecoderService->pinyinString(false);
QVector<int> splStart = pinyinDecoderService->spellingStartPositions();
QString fullSent = pinyinDecoderService->candidateAt(0);
fixedLen = pinyinDecoderService->fixedLength();
composingStr = fullSent.mid(0, fixedLen) + surface.mid(splStart[fixedLen + 1]);
activeCmpsLen = composingStr.length();
// Prepare the display string.
QString composingStrDisplay;
int surfaceDecodedLen = pinyinDecoderService->pinyinStringLength(true);
if (!surfaceDecodedLen) {
composingStrDisplay = composingStr.toLower();
if (!totalChoicesNum)
totalChoicesNum = 1;
} else {
activeCmpsLen = activeCmpsLen - (surface.length() - surfaceDecodedLen);
composingStrDisplay = fullSent.mid(0, fixedLen);
for (int pos = fixedLen + 1; pos < splStart.size() - 1; pos++) {
composingStrDisplay += surface.mid(splStart[pos], splStart[pos + 1] - splStart[pos]).toUpper();
if (splStart[pos + 1] < surfaceDecodedLen)
composingStrDisplay += " ";
}
if (surfaceDecodedLen < surface.length())
composingStrDisplay += surface.mid(surfaceDecodedLen).toLower();
}
q->inputContext()->setPreeditText(composingStrDisplay);
finishSelection = splStart.size() == (fixedLen + 2);
if (!finishSelection)
candidateAt(0);
}
void choosePredictChoice(int choiceId)
{
Q_ASSERT(state == Predict);
if (choiceId < 0 || choiceId >= totalChoicesNum)
return;
QString tmp = candidatesList.at(choiceId);
resetCandidates();
candidatesList.append(tmp);
totalChoicesNum = 1;
surface.clear();
fixedLen = tmp.length();
composingStr = tmp;
activeCmpsLen = fixedLen;
finishSelection = true;
}
QString getComposingStrActivePart()
{
return composingStr.mid(0, activeCmpsLen);
}
void resetCandidates()
{
candidatesList.clear();
if (totalChoicesNum) {
totalChoicesNum = 0;
}
}
void updateCandidateList()
{
Q_Q(PinyinInputMethod);
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
emit q->selectionListChanged(SelectionListModel::WordCandidateList);
emit q->selectionListActiveItemChanged(SelectionListModel::WordCandidateList,
totalChoicesNum > 0 && state == PinyinInputMethodPrivate::Input ? 0 : -1);
}
bool canDoPrediction()
{
Q_Q(PinyinInputMethod);
InputContext *inputContext = q->inputContext();
return inputMode == InputEngine::Pinyin &&
composingStr.length() == fixedLen &&
inputContext &&
!inputContext->inputMethodHints().testFlag(Qt::ImhNoPredictiveText);
}
void tryPredict()
{
// Try to get the prediction list.
if (canDoPrediction()) {
Q_Q(PinyinInputMethod);
if (state != Predict)
resetToIdleState();
InputContext *inputContext = q->inputContext();
int cursorPosition = inputContext->cursorPosition();
int historyStart = qMax(0, cursorPosition - 3);
QString history = inputContext->surroundingText().mid(historyStart, cursorPosition - historyStart);
candidatesList = pinyinDecoderService->predictionList(history);
totalChoicesNum = candidatesList.size();
finishSelection = false;
state = Predict;
} else {
resetCandidates();
}
if (!candidatesCount())
resetToIdleState();
}
PinyinInputMethod *q_ptr;
InputEngine::InputMode inputMode;
QPointer<PinyinDecoderService> pinyinDecoderService;
State state;
QString surface;
int totalChoicesNum;
QList<QString> candidatesList;
int fixedLen;
QString composingStr;
int activeCmpsLen;
bool finishSelection;
int posDelSpl;
bool isPosInSpl;
};
class ScopedCandidateListUpdate
{
Q_DISABLE_COPY(ScopedCandidateListUpdate)
public:
inline explicit ScopedCandidateListUpdate(PinyinInputMethodPrivate *d) :
d(d),
candidatesList(d->candidatesList),
totalChoicesNum(d->totalChoicesNum),
state(d->state)
{
}
inline ~ScopedCandidateListUpdate()
{
if (totalChoicesNum != d->totalChoicesNum || state != d->state || candidatesList != d->candidatesList)
d->updateCandidateList();
}
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
private:
PinyinInputMethodPrivate *d;
QList<QString> candidatesList;
int totalChoicesNum;
PinyinInputMethodPrivate::State state;
};
/*!
\class QtVirtualKeyboard::PinyinInputMethod
\internal
*/
PinyinInputMethod::PinyinInputMethod(QObject *parent) :
AbstractInputMethod(*new PinyinInputMethodPrivate(this), parent)
{
}
PinyinInputMethod::~PinyinInputMethod()
{
}
QList<InputEngine::InputMode> PinyinInputMethod::inputModes(const QString &locale)
{
Q_UNUSED(locale)
Q_D(PinyinInputMethod);
QList<InputEngine::InputMode> result;
if (d->pinyinDecoderService)
result << InputEngine::Pinyin;
result << InputEngine::Latin;
return result;
}
bool PinyinInputMethod::setInputMode(const QString &locale, InputEngine::InputMode inputMode)
{
Q_UNUSED(locale)
Q_D(PinyinInputMethod);
reset();
if (inputMode == InputEngine::Pinyin && !d->pinyinDecoderService)
return false;
d->inputMode = inputMode;
return true;
}
bool PinyinInputMethod::setTextCase(InputEngine::TextCase textCase)
{
Q_UNUSED(textCase)
return true;
}
bool PinyinInputMethod::keyEvent(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers)
{
Q_UNUSED(modifiers)
Q_D(PinyinInputMethod);
if (d->inputMode == InputEngine::Pinyin) {
ScopedCandidateListUpdate scopedCandidateListUpdate(d);
Q_UNUSED(scopedCandidateListUpdate)
if ((key >= Qt::Key_A && key <= Qt::Key_Z) || (key == Qt::Key_Apostrophe)) {
if (d->state == PinyinInputMethodPrivate::Predict)
d->resetToIdleState();
if (d->addSpellingChar(text.at(0), d->state == PinyinInputMethodPrivate::Idle)) {
d->chooseAndUpdate(-1);
return true;
}
} else if (key == Qt::Key_Space) {
if (d->state != PinyinInputMethodPrivate::Predict && d->candidatesCount() > 0) {
d->chooseAndUpdate(0);
return true;
}
} else if (key == Qt::Key_Return) {
421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
if (d->state != PinyinInputMethodPrivate::Predict && d->candidatesCount() > 0) {
QString surface = d->surface;
d->resetToIdleState();
inputContext()->commit(surface);
return true;
}
} else if (key == Qt::Key_Backspace) {
if (d->removeSpellingChar()) {
d->chooseAndUpdate(-1);
return true;
}
} else if (!text.isEmpty()) {
d->chooseAndFinish();
}
}
return false;
}
QList<SelectionListModel::Type> PinyinInputMethod::selectionLists()
{
return QList<SelectionListModel::Type>() << SelectionListModel::WordCandidateList;
}
int PinyinInputMethod::selectionListItemCount(SelectionListModel::Type type)
{
Q_UNUSED(type)
Q_D(PinyinInputMethod);
return d->candidatesCount();
}
QVariant PinyinInputMethod::selectionListData(SelectionListModel::Type type, int index, int role)
{
QVariant result;
Q_UNUSED(type)
Q_D(PinyinInputMethod);
switch (role) {
case SelectionListModel::DisplayRole:
result = QVariant(d->candidateAt(index));
break;
case SelectionListModel::WordCompletionLengthRole:
result.setValue(0);
break;
default:
result = AbstractInputMethod::selectionListData(type, index, role);
break;
}
return result;
}
void PinyinInputMethod::selectionListItemSelected(SelectionListModel::Type type, int index)
{
Q_UNUSED(type)
Q_D(PinyinInputMethod);
ScopedCandidateListUpdate scopedCandidateListUpdate(d);
Q_UNUSED(scopedCandidateListUpdate)
d->chooseAndUpdate(index);
}
void PinyinInputMethod::reset()
{
Q_D(PinyinInputMethod);
ScopedCandidateListUpdate scopedCandidateListUpdate(d);
Q_UNUSED(scopedCandidateListUpdate)
d->resetToIdleState();
}
void PinyinInputMethod::update()
{
Q_D(PinyinInputMethod);
ScopedCandidateListUpdate scopedCandidateListUpdate(d);
491492493494495496497
Q_UNUSED(scopedCandidateListUpdate)
d->chooseAndFinish();
d->tryPredict();
}
} // namespace QtVirtualKeyboard