Merge lp:~michael-sheldon/ubuntu-keyboard/fix-1448019 into lp:ubuntu-keyboard

[Michael Sheldon]

Discard spellcheck words that arrive whilst still processing outside of the spellcheck worker thread instead of as part of that thread

Discard spellcheck words that arrive whilst still processing outside of the spellcheck worker thread instead of as part of that thread

[Michael Sheldon (michael-sheldon)]

Are there any related MPs required for this MP to build/function as expected? Please list.

 * No

Is your branch in sync with latest trunk (e.g. bzr pull lp:trunk -> no changes)

 * Yes

Did you perform an exploratory manual test run of your code change and any related functionality on device or emulator?

 * Yes

Did you successfully run all tests found in your component's Test Plan (https://wiki.ubuntu.com/Process/Merges/TestPlan/ubuntu-keyboard) on device or emulator?

 * Yes

If you changed the UI, was the change specified/approved by design?

 * No change

If you changed UI labels, did you update the pot file?

 * No change

If you changed the packaging (debian), did you add a core-dev as a reviewer to this MP?

 * No change

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:359
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/589/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/2533
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-amd64-ci/90
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/90
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-armhf-ci/90/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-vivid-i386-ci/90
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-vivid-mako/2194
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/2531
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/2531/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/20031

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-keyboard-ci/589/rebuild

review: Approve (continuous-integration)

=== modified file 'plugins/pinyin/src/pinyinadapter.cpp'
--- plugins/pinyin/src/pinyinadapter.cpp	2015-02-17 17:23:09 +0000
+++ plugins/pinyin/src/pinyinadapter.cpp	2015-04-29 15:50:17 +0000
@@ -45,22 +45,6 @@
 
 void PinyinAdapter::parse(const QString& string)
 {
-    // Run through all the words queued in the event loop
-    // so we only fetch suggestions for the latest word
-    bool setProcessingWords = false;
-    if(m_processingWords == false) {
-        setProcessingWords = true;
-        m_processingWords = true;
-    }
-    QCoreApplication::processEvents();
-    if(setProcessingWords == true) {
-        m_processingWords = false;
-    }
-
-    if(m_processingWords) {
-        return;
-    }
-
     pinyin_parse_more_full_pinyins(m_instance, string.toLatin1().data());
 
 #ifdef PINYIN_DEBUG

=== modified file 'plugins/pinyin/src/pinyinplugin.cpp'
--- plugins/pinyin/src/pinyinplugin.cpp	2015-02-17 18:15:29 +0000
+++ plugins/pinyin/src/pinyinplugin.cpp	2015-04-29 15:50:17 +0000
@@ -6,12 +6,13 @@
 PinyinPlugin::PinyinPlugin(QObject *parent) :
     AbstractLanguagePlugin(parent)
   , m_chineseLanguageFeatures(new ChineseLanguageFeatures)
+  , m_processingWord(false)
 {
     m_pinyinThread = new QThread();
     m_pinyinAdapter = new PinyinAdapter();
     m_pinyinAdapter->moveToThread(m_pinyinThread);
 
-    connect(m_pinyinAdapter, SIGNAL(newPredictionSuggestions(QString, QStringList)), this, SIGNAL(newPredictionSuggestions(QString, QStringList)));
+    connect(m_pinyinAdapter, SIGNAL(newPredictionSuggestions(QString, QStringList)), this, SLOT(finishedProcessing(QString, QStringList)));
     connect(this, SIGNAL(parsePredictionText(QString)), m_pinyinAdapter, SLOT(parse(QString)));
     connect(this, SIGNAL(candidateSelected(QString)), m_pinyinAdapter, SLOT(wordCandidateSelected(QString)));
     m_pinyinThread->start();
@@ -27,7 +28,11 @@
 void PinyinPlugin::predict(const QString& surroundingLeft, const QString& preedit)
 {
     Q_UNUSED(surroundingLeft);
-    Q_EMIT parsePredictionText(preedit);
+    m_nextWord = preedit;
+    if (!m_processingWord) {
+        m_processingWord = true;
+        Q_EMIT parsePredictionText(preedit);
+    }
 }
 
 void PinyinPlugin::wordCandidateSelected(QString word)
@@ -39,3 +44,13 @@
 {
     return m_chineseLanguageFeatures;
 }
+
+void PinyinPlugin::finishedProcessing(QString word, QStringList suggestions)
+{
+    Q_EMIT newPredictionSuggestions(word, suggestions);
+    if (word != m_nextWord) {
+        Q_EMIT(parsePredictionText(word));
+    } else {
+        m_processingWord = false;
+    }
+}

=== modified file 'plugins/pinyin/src/pinyinplugin.h'
--- plugins/pinyin/src/pinyinplugin.h	2015-04-13 10:54:12 +0000
+++ plugins/pinyin/src/pinyinplugin.h	2015-04-29 15:50:17 +0000
@@ -38,11 +38,14 @@
     void candidateSelected(QString word);
     
 public slots:
+    void finishedProcessing(QString word, QStringList suggestions);
     
 private:
     QThread *m_pinyinThread;
     PinyinAdapter *m_pinyinAdapter;
     ChineseLanguageFeatures* m_chineseLanguageFeatures;
+    QString m_nextWord;
+    bool m_processingWord;
 };
 
 #endif // PINYINPLUGIN_H

=== modified file 'plugins/westernsupport/spellpredictworker.cpp'
--- plugins/westernsupport/spellpredictworker.cpp	2015-04-13 10:54:12 +0000
+++ plugins/westernsupport/spellpredictworker.cpp	2015-04-29 15:50:17 +0000
@@ -35,9 +35,7 @@
     , m_presageCandidates(CandidatesCallback(m_candidatesContext))
     , m_presage(&m_presageCandidates)
     , m_spellChecker()
-    , m_word()
     , m_limit(5)
-    , m_processingWords(false)
 {
     m_presage.config("Presage.Selector.SUGGESTIONS", "6");
     m_presage.config("Presage.Selector.REPEAT_SUGGESTIONS", "yes");
@@ -102,31 +100,18 @@
 
 void SpellPredictWorker::suggest(const QString& word, int limit)
 {
+    QStringList suggestions;
     if(!m_spellChecker.spell(word)) {
-        QStringList suggestions = m_spellChecker.suggest(word, limit);
-        Q_EMIT newSpellingSuggestions(word, suggestions);
+        suggestions = m_spellChecker.suggest(word, limit);
     }
+    // If spelt correctly still send empty suggestions so the plugin knows we
+    // have finished processing.
+    Q_EMIT newSpellingSuggestions(word, suggestions);
 }
 
 void SpellPredictWorker::newSpellCheckWord(QString word)
 {
-    // Run through all the words queued in the event loop
-    // so we only fetch suggestions for the latest word
-    bool setProcessingWords = false;
-    if(m_processingWords == false) {
-        setProcessingWords = true;
-        m_processingWords = true;
-    }
-    QCoreApplication::processEvents();
-    if(setProcessingWords == true) {
-        m_processingWords = false;
-    }
-
-    m_word = word;
-
-    if(!m_processingWords) {
-        suggest(m_word, m_limit);
-    }
+    suggest(word, m_limit);
 }
 
 void SpellPredictWorker::addToUserWordList(const QString& word)

=== modified file 'plugins/westernsupport/spellpredictworker.h'
--- plugins/westernsupport/spellpredictworker.h	2015-04-13 10:54:12 +0000
+++ plugins/westernsupport/spellpredictworker.h	2015-04-29 15:50:17 +0000
@@ -63,9 +63,7 @@
     CandidatesCallback m_presageCandidates;
     Presage m_presage;
     SpellChecker m_spellChecker;
-    QString m_word;
     int m_limit;
-    bool m_processingWords;
     QMap<QString, QString> m_overrides;
 };
 

=== modified file 'plugins/westernsupport/westernlanguagesplugin.cpp'
--- plugins/westernsupport/westernlanguagesplugin.cpp	2015-04-13 10:54:12 +0000
+++ plugins/westernsupport/westernlanguagesplugin.cpp	2015-04-29 15:50:17 +0000
@@ -8,12 +8,13 @@
     AbstractLanguagePlugin(parent)
   , m_languageFeatures(new WesternLanguageFeatures)
   , m_spellCheckEnabled(false)
+  , m_processingSpelling(false)
 {
     m_spellPredictThread = new QThread();
     m_spellPredictWorker = new SpellPredictWorker();
     m_spellPredictWorker->moveToThread(m_spellPredictThread);
 
-    connect(m_spellPredictWorker, SIGNAL(newSpellingSuggestions(QString, QStringList)), this, SIGNAL(newSpellingSuggestions(QString, QStringList)));
+    connect(m_spellPredictWorker, SIGNAL(newSpellingSuggestions(QString, QStringList)), this, SLOT(spellCheckFinishedProcessing(QString, QStringList)));
     connect(m_spellPredictWorker, SIGNAL(newPredictionSuggestions(QString, QStringList)), this, SIGNAL(newPredictionSuggestions(QString, QStringList)));
     connect(this, SIGNAL(newSpellCheckWord(QString)), m_spellPredictWorker, SLOT(newSpellCheckWord(QString)));
     connect(this, SIGNAL(setSpellPredictLanguage(QString, QString)), m_spellPredictWorker, SLOT(setLanguage(QString, QString)));
@@ -48,8 +49,14 @@
 
 void WesternLanguagesPlugin::spellCheckerSuggest(const QString& word, int limit)
 {
-    Q_EMIT setSpellCheckLimit(limit);
-    Q_EMIT newSpellCheckWord(word);
+    m_nextSpellWord = word;
+    // Don't accept new words whilst we're processing, so we only process the
+    // most recent input once the current processing has completed
+    if (!m_processingSpelling) {
+        m_processingSpelling = true;
+        Q_EMIT setSpellCheckLimit(limit);
+        Q_EMIT newSpellCheckWord(word);
+    }
 }
 
 void WesternLanguagesPlugin::addToSpellCheckerUserWordList(const QString& word)
@@ -82,3 +89,12 @@
         }
     }
 }
+
+void WesternLanguagesPlugin::spellCheckFinishedProcessing(QString word, QStringList suggestions) {
+    Q_EMIT newSpellingSuggestions(word, suggestions);
+    if (word != m_nextSpellWord) {
+        Q_EMIT newSpellCheckWord(m_nextSpellWord);
+    } else {
+        m_processingSpelling = false;
+    }
+}

=== modified file 'plugins/westernsupport/westernlanguagesplugin.h'
--- plugins/westernsupport/westernlanguagesplugin.h	2015-04-13 10:54:12 +0000
+++ plugins/westernsupport/westernlanguagesplugin.h	2015-04-29 15:50:17 +0000
@@ -47,12 +47,15 @@
     void addOverride(const QString& orig, const QString& overriden);
 
 public slots:
+    void spellCheckFinishedProcessing(QString word, QStringList suggestions);
 
 private:
     WesternLanguageFeatures* m_languageFeatures;
     SpellPredictWorker *m_spellPredictWorker;
     QThread *m_spellPredictThread;
     bool m_spellCheckEnabled;
+    QString m_nextSpellWord;
+    bool m_processingSpelling;
 };
 
 #endif // WESTERNLANGUAGESPLUGIN_H