Changeset 124763 in webkit

Timestamp:

Aug 6, 2012 6:43:07 AM (12 years ago)

Author:

mario@webkit.org

Message:

[WK2][GTK] Improvements for the new spell-checking API
​https://bugs.webkit.org/show_bug.cgi?id=93262

Reviewed by Carlos Garcia Campos.

Source/WebCore:

Provide a way to ask TextCheckerEnchant helper class for the list
of languages currently available for the spell checking feature.

• platform/text/gtk/TextCheckerEnchant.cpp:

(enchantDictDescribeCallback): Renamed from
getAvailableDictionariesCallback, for consistency.
(TextCheckerEnchant::updateSpellCheckingLanguages): Updated usage
of getAvailableDictionariesCallback to enchantDictDescribeCallback.
(TextCheckerEnchant::getSpellCheckingLanguages): New. Will build
and return a String with a comma-separated list of languages
currently in use by the spell checking feature.

• platform/text/gtk/TextCheckerEnchant.h:

(TextCheckerEnchant): Added new function getSpellCheckingLanguages.

Source/WebKit2:

Improve the way the new spell-checking API is implemented, by
using better internal representations for data, documenting better
the new functions and using better unit tests.

• UIProcess/API/gtk/WebKitTextChecker.cpp:

(WebKitTextChecker::getSpellCheckingLanguages): Just return the
value previously cached when calling to the setter function.
(WebKitTextChecker::setSpellCheckingLanguages): Update the text
checker in WebCore and cache the value returned from it.

• UIProcess/API/gtk/WebKitTextChecker.h:

(WebKitTextChecker): Use a CString instead of an String to cache
the list of spell checking languages. Update getter and setter.

• UIProcess/API/gtk/WebKitWebContext.cpp:

(_WebKitWebContextPrivate): No need to cache the spell checking
languages here anymore.
(webkit_web_context_get_spell_checking_languages): Improve
both implementation and documentation to be more consistent.
(webkit_web_context_set_spell_checking_languages): Make
'languages' a mandatory (non-NULL) parameter. Update documentation.

• UIProcess/API/gtk/tests/TestWebKitWebContext.cpp:

(testWebContextSpellChecker): Test even more situations.

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/platform/text/gtk/TextCheckerEnchant.cpp (modified) (4 diffs)
• WebCore/platform/text/gtk/TextCheckerEnchant.h (modified) (1 diff)
• WebKit2/ChangeLog (modified) (1 diff)
• WebKit2/UIProcess/API/gtk/WebKitTextChecker.cpp (modified) (1 diff)
• WebKit2/UIProcess/API/gtk/WebKitTextChecker.h (modified) (3 diffs)
• WebKit2/UIProcess/API/gtk/WebKitWebContext.cpp (modified) (6 diffs)
• WebKit2/UIProcess/API/gtk/tests/TestWebKitWebContext.cpp (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2012-08-06  Mario Sanchez Prada  <msanchez@igalia.com>
+
+        [WK2][GTK] Improvements for the new spell-checking API
+        https://bugs.webkit.org/show_bug.cgi?id=93262
+
+        Reviewed by Carlos Garcia Campos.
+
+        Provide a way to ask TextCheckerEnchant helper class for the list
+        of languages currently available for the spell checking feature.
+
+        * platform/text/gtk/TextCheckerEnchant.cpp:
+        (enchantDictDescribeCallback): Renamed from
+        getAvailableDictionariesCallback, for consistency.
+        (TextCheckerEnchant::updateSpellCheckingLanguages): Updated usage
+        of getAvailableDictionariesCallback to enchantDictDescribeCallback.
+        (TextCheckerEnchant::getSpellCheckingLanguages): New. Will build
+        and return a String with a comma-separated list of languages
+        currently in use by the spell checking feature.
+        * platform/text/gtk/TextCheckerEnchant.h:
+        (TextCheckerEnchant): Added new function getSpellCheckingLanguages.
+
 2012-08-06  Andreas Kling  <kling@webkit.org>
 

trunk/Source/WebCore/platform/text/gtk/TextCheckerEnchant.cpp

@@ -25 +25 @@
 #include <wtf/gobject/GOwnPtr.h>
 #include <wtf/text/CString.h>
+#include <wtf/text/StringBuilder.h>
 
 using namespace WebCore;
@@ -30 +31 @@
 static const size_t maximumNumberOfSuggestions = 10;
 
-static void getAvailableDictionariesCallback(const char* const languageTag, const char* const, const char* const, const char* const, void* data)
+static void enchantDictDescribeCallback(const char* const languageTag, const char* const, const char* const, const char* const, void* data)
 {
     Vector<CString>* dictionaries = static_cast<Vector<CString>*>(data);
@@ -177 +178 @@
             // No dictionaries selected, we get one from the list.
             Vector<CString> allDictionaries;
-            enchant_broker_list_dicts(m_broker, getAvailableDictionariesCallback, &allDictionaries);
+            enchant_broker_list_dicts(m_broker, enchantDictDescribeCallback, &allDictionaries);
             if (!allDictionaries.isEmpty()) {
                 EnchantDict* dict = enchant_broker_request_dict(m_broker, allDictionaries[0].data());
@@ -188 +189 @@
 }
 
+String TextCheckerEnchant::getSpellCheckingLanguages()
+{
+    if (m_enchantDictionaries.isEmpty())
+        return String();
+
+    // Get a Vector<CString> with the list of languages in use.
+    Vector<CString> currentDictionaries;
+    for (Vector<EnchantDict*>::const_iterator iter = m_enchantDictionaries.begin(); iter != m_enchantDictionaries.end(); ++iter)
+        enchant_dict_describe(*iter, enchantDictDescribeCallback, &currentDictionaries);
+
+    // Build the result String;
+    StringBuilder builder;
+    for (Vector<CString>::const_iterator iter = currentDictionaries.begin(); iter != currentDictionaries.end(); ++iter) {
+        if (iter != currentDictionaries.begin())
+            builder.append(",");
+        builder.append(String::fromUTF8(iter->data()));
+    }
+    return builder.toString();
+}
+
 void TextCheckerEnchant::freeEnchantBrokerDictionaries()
 {

trunk/Source/WebCore/platform/text/gtk/TextCheckerEnchant.h

@@ -43 +43 @@
     Vector<String> getGuessesForWord(const String&);
     void updateSpellCheckingLanguages(const String& languages);
+    String getSpellCheckingLanguages();
 
 private:

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2012-08-06  Mario Sanchez Prada  <msanchez@igalia.com>
+
+        [WK2][GTK] Improvements for the new spell-checking API
+        https://bugs.webkit.org/show_bug.cgi?id=93262
+
+        Reviewed by Carlos Garcia Campos.
+
+        Improve the way the new spell-checking API is implemented, by
+        using better internal representations for data, documenting better
+        the new functions and using better unit tests.
+
+        * UIProcess/API/gtk/WebKitTextChecker.cpp:
+        (WebKitTextChecker::getSpellCheckingLanguages): Just return the
+        value previously cached when calling to the setter function.
+        (WebKitTextChecker::setSpellCheckingLanguages): Update the text
+        checker in WebCore and cache the value returned from it.
+        * UIProcess/API/gtk/WebKitTextChecker.h:
+        (WebKitTextChecker): Use a CString instead of an String to cache
+        the list of spell checking languages. Update getter and setter.
+        * UIProcess/API/gtk/WebKitWebContext.cpp:
+        (_WebKitWebContextPrivate): No need to cache the spell checking
+        languages here anymore.
+        (webkit_web_context_get_spell_checking_languages): Improve
+        both implementation and documentation to be more consistent.
+        (webkit_web_context_set_spell_checking_languages): Make
+        'languages' a mandatory (non-NULL) parameter. Update documentation.
+        * UIProcess/API/gtk/tests/TestWebKitWebContext.cpp:
+        (testWebContextSpellChecker): Test even more situations.
+
 2012-08-06  Andras Becsi  <andras.becsi@nokia.com>
 

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitTextChecker.cpp

@@ -141 +141 @@
 }
 
-void WebKitTextChecker::setSpellCheckingLanguages(const String& languages)
+const CString& WebKitTextChecker::getSpellCheckingLanguages()
 {
-    if (m_spellCheckingLanguages == languages)
-        return;
-    m_spellCheckingLanguages = languages;
+    String spellCheckingLanguages = m_textChecker->getSpellCheckingLanguages();
+    m_spellCheckingLanguages = spellCheckingLanguages.isEmpty() ? CString() : spellCheckingLanguages.utf8();
+    return m_spellCheckingLanguages;
+}
 
-    // We need to update the languages in the enchant-based checker too.
-    m_textChecker->updateSpellCheckingLanguages(languages);
+void WebKitTextChecker::setSpellCheckingLanguages(const CString& languages)
+{
+    m_textChecker->updateSpellCheckingLanguages(String::fromUTF8(languages.data()));
 }
 #endif // ENABLE(SPELLCHECK)

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitTextChecker.h

@@ -27 +27 @@
 #include <wtf/PassOwnPtr.h>
 #include <wtf/Vector.h>
+#include <wtf/text/CString.h>
 
 class WebKitTextChecker {
@@ -44 +45 @@
 
     // To be called from WebKitWebContext only.
-    const String getSpellCheckingLanguages() { return m_spellCheckingLanguages; }
-    void setSpellCheckingLanguages(const String& spellCheckingLanguages);
+    const CString& getSpellCheckingLanguages();
+    void setSpellCheckingLanguages(const CString& spellCheckingLanguages);
 
 private:
@@ -51 +52 @@
 
     OwnPtr<WebCore::TextCheckerEnchant> m_textChecker;
-    String m_spellCheckingLanguages;
+    CString m_spellCheckingLanguages;
     bool m_spellCheckingEnabled;
 };

trunk/Source/WebKit2/UIProcess/API/gtk/WebKitWebContext.cpp

@@ -78 +78 @@
 #if ENABLE(SPELLCHECK)
     OwnPtr<WebKitTextChecker> textChecker;
-    GOwnPtr<gchar> spellCheckingLanguages;
 #endif
 };
@@ -433 +432 @@
  * @context: a #WebKitWebContext
  *
- * Get the current status of the spell checking feature.
+ * Get whether spell checking feature is currently enabled.
  *
  * Returns: %TRUE If spell checking is enabled, or %FALSE otherwise.
@@ -469 +468 @@
  *
  * Get the the list of spell checking languages associated with
- * @context, separated by commas. See
- * webkit_web_context_set_spell_checking_languages() for more details
- * on the format of the languages in the list.
- *
- * Returns: (transfer none): A comma separated list of languages.
+ * @context separated by commas, or %NULL if no languages have been
+ * previously set.
+
+ * See webkit_web_context_set_spell_checking_languages() for more
+ * details on the format of the languages in the list.
+ *
+ * Returns: (transfer none): A comma separated list of languages if
+ * available, or %NULL otherwise.
  */
 const gchar* webkit_web_context_get_spell_checking_languages(WebKitWebContext* context)
@@ -480 +482 @@
 
 #if ENABLE(SPELLCHECK)
-    return context->priv->spellCheckingLanguages.get();
+    CString spellCheckingLanguages = context->priv->textChecker->getSpellCheckingLanguages();
+    if (spellCheckingLanguages.isNull())
+        return 0;
+    return spellCheckingLanguages.data();
 #else
     return 0;
@@ -489 +494 @@
  * webkit_web_context_set_spell_checking_languages:
  * @context: a #WebKitWebContext
- * @languages: (allow-none): new list of spell checking
- * languages separated by commas, or %NULL
+ * @languages: new list of spell checking languages separated by
+ * commas
  *
  * Set the list of spell checking languages to be used for spell
- * checking, separated by commas. In case %NULL is passed, the default
- * value as returned by gtk_get_default_language() will be used.
+ * checking, separated by commas.
  *
  * The locale string typically is in the form lang_COUNTRY, where lang
@@ -500 +504 @@
  * For instance, sv_FI for Swedish as written in Finland or pt_BR
  * for Portuguese as written in Brazil.
+ *
+ * You need to call this function with a valid list of languages at
+ * least once in order to properly enable the spell checking feature
+ * in WebKit.
  */
 void webkit_web_context_set_spell_checking_languages(WebKitWebContext* context, const gchar* languages)
 {
     g_return_if_fail(WEBKIT_IS_WEB_CONTEXT(context));
+    g_return_if_fail(languages);
 
 #if ENABLE(SPELLCHECK)
-    context->priv->textChecker->setSpellCheckingLanguages(String(languages));
-    context->priv->spellCheckingLanguages.set(g_strdup(languages));
+    context->priv->textChecker->setSpellCheckingLanguages(languages);
 #endif
 }

trunk/Source/WebKit2/UIProcess/API/gtk/tests/TestWebKitWebContext.cpp

@@ -234 +234 @@
 static void testWebContextSpellChecker(Test* test, gconstpointer)
 {
-    GRefPtr<WebKitWebContext> webContext(webkit_web_context_get_default());
-
-    // Set the language to a specific one, an empty one and a list of them.
-    webkit_web_context_set_spell_checking_languages(webContext.get(), "en_US");
-    const gchar* currentLanguage(webkit_web_context_get_spell_checking_languages(webContext.get()));
+    WebKitWebContext* webContext = webkit_web_context_get_default();
+
+    // Check what happens if no spell checking language has been set.
+    const gchar* currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
+    g_assert(!currentLanguage);
+
+    // Set the language to a specific one.
+    webkit_web_context_set_spell_checking_languages(webContext, "en_US");
+    currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
     g_assert_cmpstr(currentLanguage, ==, "en_US");
 
-    webkit_web_context_set_spell_checking_languages(webContext.get(), 0);
-    currentLanguage = webkit_web_context_get_spell_checking_languages(webContext.get());
-    g_assert_cmpstr(currentLanguage, ==, 0);
-
-    webkit_web_context_set_spell_checking_languages(webContext.get(), "es_ES,en_US");
-    currentLanguage = webkit_web_context_get_spell_checking_languages(webContext.get());
-    g_assert_cmpstr(currentLanguage, ==, "es_ES,en_US");
+    // Set the language string to list of valid languages.
+    webkit_web_context_set_spell_checking_languages(webContext, "en_GB,en_US");
+    currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
+    g_assert_cmpstr(currentLanguage, ==, "en_GB,en_US");
+
+    // Try passing a wrong language along with good ones.
+    webkit_web_context_set_spell_checking_languages(webContext, "bd_WR,en_US,en_GB");
+    currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
+    g_assert_cmpstr(currentLanguage, ==, "en_US,en_GB");
+
+    // Try passing a list with only wrong languages.
+    webkit_web_context_set_spell_checking_languages(webContext, "bd_WR,wr_BD");
+    currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
+    g_assert(!currentLanguage);
 
     // Check disabling and re-enabling spell checking.
-    webkit_web_context_set_spell_checking_enabled(webContext.get(), FALSE);
-    gboolean isSpellCheckingEnabled = webkit_web_context_get_spell_checking_enabled(webContext.get());
-    g_assert(!isSpellCheckingEnabled);
-    webkit_web_context_set_spell_checking_enabled(webContext.get(), TRUE);
-    isSpellCheckingEnabled = webkit_web_context_get_spell_checking_enabled(webContext.get());
-    g_assert(isSpellCheckingEnabled);
+    webkit_web_context_set_spell_checking_enabled(webContext, FALSE);
+    g_assert(!webkit_web_context_get_spell_checking_enabled(webContext));
+    webkit_web_context_set_spell_checking_enabled(webContext, TRUE);
+    g_assert(webkit_web_context_get_spell_checking_enabled(webContext));
 }