Merge lp:~michael-sheldon/ubuntu-keyboard/fix-1372948-rtm into lp:ubuntu-keyboard/rtm-14.09

[Michael Sheldon]

Automatically correct 'i' to 'I' when using the English language plugin.

Automatically correct 'i' to 'I' when using the English language plugin.

[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)

 * In sync with rtm-14.09 branch

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, except for last test in word prediction section as this isn't implemented in the 14.09 branch.

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

[Bill Filler (bfiller)]

approved

review: Approve

=== modified file 'plugins/en/src/englishplugin.h'
--- plugins/en/src/englishplugin.h	2014-05-19 11:53:27 +0000
+++ plugins/en/src/englishplugin.h	2014-12-03 17:17:29 +0000
@@ -17,6 +17,7 @@
     explicit EnglishPlugin(QObject* parent = 0)
         : WesternLanguagesPlugin(parent)
     {
+        addOverride("i", "I");
     }
 
     virtual ~EnglishPlugin()
 
=== modified file 'plugins/westernsupport/spellpredictworker.cpp'
--- plugins/westernsupport/spellpredictworker.cpp	2014-08-07 17:04:01 +0000
+++ plugins/westernsupport/spellpredictworker.cpp	2014-12-03 17:17:29 +0000
@@ -43,14 +43,23 @@
     m_presage.config("Presage.Selector.REPEAT_SUGGESTIONS", "yes");
 }
 
-void SpellPredictWorker::parsePredictionText(const QString& surroundingLeft, const QString& preedit)
+void SpellPredictWorker::parsePredictionText(const QString& surroundingLeft, const QString& origPreedit)
 {
-    m_candidatesContext = (surroundingLeft.toStdString() + preedit.toStdString());
+    m_candidatesContext = (surroundingLeft.toStdString() + origPreedit.toStdString());
 
     QStringList list;
 
-    // If the user input is spelt correctly add it to the start of the predictions
-    if(m_spellChecker.spell(preedit)) {
+    QString preedit = origPreedit;
+
+    // Allow plugins to override certain words such as ('i' -> 'I')
+    if(m_overrides.contains(preedit)) {
+        preedit = m_overrides[preedit];
+        list << preedit;
+        // Emit the override corrections instantly so they're always up-to-date
+        // as they're often used for short words like 'I'
+        Q_EMIT newPredictionSuggestions(origPreedit, list);
+    } else if(m_spellChecker.spell(preedit)) {
+        // If the user input is spelt correctly add it to the start of the predictions
         list << preedit;
     }
 
@@ -74,7 +83,7 @@
         qWarning() << "An exception was thrown in libpresage when calling predict(), exception nr: " << error;
     }
 
-    Q_EMIT newPredictionSuggestions(preedit, list);
+    Q_EMIT newPredictionSuggestions(origPreedit, list);
 }
 
 void SpellPredictWorker::setLanguage(QString locale)
@@ -131,3 +140,7 @@
     m_limit = limit;
 }
 
+void SpellPredictWorker::addOverride(const QString& orig, const QString& overriden)
+{
+    m_overrides[orig] = overriden;
+}
 
=== modified file 'plugins/westernsupport/spellpredictworker.h'
--- plugins/westernsupport/spellpredictworker.h	2014-08-07 17:04:01 +0000
+++ plugins/westernsupport/spellpredictworker.h	2014-12-03 17:17:29 +0000
@@ -34,6 +34,7 @@
 
 #include <QObject>
 #include <QStringList>
+#include <QMap>
 
 class CandidatesCallback;
 
@@ -51,6 +52,7 @@
     void setLanguage(QString language);
     void setSpellCheckLimit(int limit);
     void addToUserWordList(const QString& word);
+    void addOverride(const QString& orig, const QString& overriden);
 
 signals:
     void newSpellingSuggestions(QString word, QStringList suggestions);
@@ -64,7 +66,7 @@
     QString m_word;
     int m_limit;
     bool m_processingWords;
-
+    QMap<QString, QString> m_overrides;
 };
 
 #endif // SPELLPREDICTWORKER_H
 
=== modified file 'plugins/westernsupport/westernlanguagesplugin.cpp'
--- plugins/westernsupport/westernlanguagesplugin.cpp	2014-08-07 17:04:01 +0000
+++ plugins/westernsupport/westernlanguagesplugin.cpp	2014-12-03 17:17:29 +0000
@@ -20,6 +20,7 @@
     connect(this, SIGNAL(setSpellCheckLimit(int)), spellPredictWorker, SLOT(setSpellCheckLimit(int)));
     connect(this, SIGNAL(parsePredictionText(QString, QString)), spellPredictWorker, SLOT(parsePredictionText(QString, QString)));
     connect(this, SIGNAL(addToUserWordList(QString)), spellPredictWorker, SLOT(addToUserWordList(QString)));
+    connect(this, SIGNAL(addOverride(QString, QString)), spellPredictWorker, SLOT(addOverride(QString, QString)));
     m_spellPredictThread->start();
 }
 
@@ -59,3 +60,8 @@
     Q_EMIT setSpellPredictLanguage(languageId);
     return true;
 }
+
+void WesternLanguagesPlugin::addSpellingOverride(const QString& orig, const QString& overriden)
+{
+    Q_EMIT addOverride(orig, overriden);
+}
 
=== modified file 'plugins/westernsupport/westernlanguagesplugin.h'
--- plugins/westernsupport/westernlanguagesplugin.h	2014-08-07 17:04:01 +0000
+++ plugins/westernsupport/westernlanguagesplugin.h	2014-12-03 17:17:29 +0000
@@ -31,6 +31,7 @@
     virtual void spellCheckerSuggest(const QString& word, int limit);
     virtual void addToSpellCheckerUserWordList(const QString& word);
     virtual bool setLanguage(const QString& languageId);
+    virtual void addSpellingOverride(const QString& orig, const QString& overriden);
 
 signals:
     void newSpellingSuggestions(QString word, QStringList suggestions);
@@ -41,6 +42,7 @@
     void parsePredictionText(QString surroundingLeft, QString preedit);
     void setPredictionLanguage(QString language);
     void addToUserWordList(const QString& word);
+    void addOverride(const QString& orig, const QString& overriden);
 
 public slots: