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

[Michael Sheldon]

Don't show word candidates arriving after a word has been committed and allow candidates to remain on the word ribbon until a new set has been calculated prior to commit.

Don't show word candidates arriving after a word has been committed and allow candidates to remain on the word ribbon until a new set has been calculated prior to commit.

[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:235
http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-ci/491/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-utopic-amd64-ci/117
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-utopic-armhf-ci/116
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-utopic-armhf-ci/116/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-keyboard-utopic-i386-ci/116

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

review: Approve (continuous-integration)

[Bill Filler (bfiller)]

tested, works

review: Approve

=== modified file 'src/lib/logic/abstractwordengine.h'
--- src/lib/logic/abstractwordengine.h	2014-07-25 14:08:51 +0000
+++ src/lib/logic/abstractwordengine.h	2014-10-29 13:59:35 +0000
@@ -66,7 +66,7 @@
     Q_SLOT virtual void setSpellcheckerEnabled(bool on);
     Q_SLOT virtual void setAutoCorrectEnabled(bool on);
 
-    void clearCandidates();
+    virtual void clearCandidates();
     void computeCandidates(Model::Text *text);
     Q_SIGNAL void candidatesChanged(const WordCandidateList &candidates);
 

=== modified file 'src/lib/logic/wordengine.cpp'
--- src/lib/logic/wordengine.cpp	2014-08-07 17:04:01 +0000
+++ src/lib/logic/wordengine.cpp	2014-10-29 13:59:35 +0000
@@ -58,13 +58,15 @@
 
     bool calculated_primary_candidate;
 
+    bool clear_candidates_on_incoming;
+
     LanguagePluginInterface* languagePlugin;
 
     QPluginLoader pluginLoader;
 
     WordCandidateList* candidates;
 
-    QString currentPreedit;
+    Model::Text *currentText;
 
     explicit WordEnginePrivate();
 
@@ -110,6 +112,7 @@
     , is_preedit_capitalized(false)
     , auto_correct_enabled(false)
     , calculated_primary_candidate(false)
+    , clear_candidates_on_incoming(false)
     , languagePlugin(0)
 {
     loadPlugin(DEFAULT_PLUGIN);
@@ -226,15 +229,15 @@
 
     d->calculated_primary_candidate = false;
 
-    d->currentPreedit = text->preedit();
-
-    d->candidates = new WordCandidateList();
+    // Allow the current candidates to remain on the word ribbon until
+    // a new set have been calculated.
+    d->clear_candidates_on_incoming = true;
+
+    d->currentText = text;
+
     const QString &preedit(text->preedit());
     d->is_preedit_capitalized = not preedit.isEmpty() && preedit.at(0).isUpper();
 
-    WordCandidate userCandidate(WordCandidate::SourceUser, preedit); 
-    d->candidates->append(userCandidate);
-
     Q_EMIT candidatesChanged(*d->candidates);
 
     Q_EMIT primaryCandidateChanged(QString());
@@ -252,7 +255,7 @@
 {
     Q_D(WordEngine);
 
-    if (word != d->currentPreedit) {
+    if (d->currentText && word != d->currentText->preedit()) {
         // Don't add suggestions coming in for a previous word
         return;
     }
@@ -261,6 +264,11 @@
     // So we need to ensure only one primary candidate is selected
     suggestionMutex.lock();
 
+    if (d->clear_candidates_on_incoming) {
+        clearCandidates();
+        d->clear_candidates_on_incoming = false;
+    }
+
     Q_FOREACH(const QString &correction, suggestions) {
         appendToCandidates(d->candidates, WordCandidate::SourceSpellChecking, correction);
     }
@@ -276,7 +284,7 @@
 {
     Q_D(WordEngine);
 
-    if (word != d->currentPreedit) {
+    if (d->currentText && word != d->currentText->preedit()) {
         // Don't add suggestions coming in for a previous word
         return;
     }
@@ -285,8 +293,13 @@
     // So we need to ensure only one primary candidate is selected
     suggestionMutex.lock();
 
+    if (d->clear_candidates_on_incoming) {
+        clearCandidates();
+        d->clear_candidates_on_incoming = false;
+    }
+
     Q_FOREACH(const QString &correction, suggestions) {
-        appendToCandidates(d->candidates, WordCandidate::SourceSpellChecking, correction);
+        appendToCandidates(d->candidates, WordCandidate::SourcePrediction, correction);
     }
 
     calculatePrimaryCandidate();
@@ -406,4 +419,17 @@
     return d->languagePlugin->languageFeature();
 }
 
+void WordEngine::clearCandidates()
+{
+    Q_D(WordEngine);
+    if(isEnabled()) {
+        d->candidates = new WordCandidateList();
+        if (d->currentText) {
+            WordCandidate userCandidate(WordCandidate::SourceUser, d->currentText->preedit()); 
+            d->candidates->append(userCandidate);
+        }
+        Q_EMIT candidatesChanged(*d->candidates);
+    }
+}
+
 }} // namespace Logic, MaliitKeyboard

=== modified file 'src/lib/logic/wordengine.h'
--- src/lib/logic/wordengine.h	2014-08-01 15:40:48 +0000
+++ src/lib/logic/wordengine.h	2014-10-29 13:59:35 +0000
@@ -63,6 +63,7 @@
     virtual void addToUserDictionary(const QString &word);
     virtual void setSpellcheckerEnabled(bool enabled);
     virtual void setAutoCorrectEnabled(bool enabled);
+    virtual void clearCandidates();
     //! \reimp_end
 
     void appendToCandidates(WordCandidateList *candidates,