Changeset 126298 in webkit

Timestamp:

Aug 22, 2012 6:34:13 AM (12 years ago)

Author:

Carlos Garcia Campos

Message:

[GTK] Preferred languages and spellchecker APIs are not consistent in WebKit2
​https://bugs.webkit.org/show_bug.cgi?id=94683

Reviewed by Alejandro G. Castro.

Source/WebCore:

Use a Vector<String> instead of a comma-separated string to
get/set languages.

• platform/text/gtk/TextCheckerEnchant.cpp:

(TextCheckerEnchant::updateSpellCheckingLanguages):
(TextCheckerEnchant::getSpellCheckingLanguages):

• platform/text/gtk/TextCheckerEnchant.h:

(TextCheckerEnchant):

Source/WebKit/gtk:

• webkit/webkitspellcheckerenchant.cpp:

(updateSpellCheckingLanguages): Split the languages string to pass a
Vector to updateSpellCheckingLanguages().

Source/WebKit2:

Change spell-checker and preferred languages API to use a GStrv
instead of a comma-separated string and GList. This makes the API
more consistent and convenient to use.

• UIProcess/API/gtk/WebKitTextChecker.cpp:

(WebKitTextChecker::getSpellCheckingLanguages): Return a
Vector<String> instead of a String.
(WebKitTextChecker::setSpellCheckingLanguages): Receive a
Vector<String> instead of a String.

• UIProcess/API/gtk/WebKitTextChecker.h:

(WebKitTextChecker): Use a GPtrArray to cache languages.

• UIProcess/API/gtk/WebKitWebContext.cpp:

(webkit_web_context_get_spell_checking_languages):
(webkit_web_context_set_spell_checking_languages):
(webkit_web_context_set_preferred_languages):

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

(testWebContextSpellChecker):
(testWebContextLanguages):

Location:

trunk/Source

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/platform/text/gtk/TextCheckerEnchant.cpp (modified) (3 diffs)
• WebCore/platform/text/gtk/TextCheckerEnchant.h (modified) (1 diff)
• WebKit/gtk/ChangeLog (modified) (1 diff)
• WebKit/gtk/webkit/webkitspellcheckerenchant.cpp (modified) (1 diff)
• WebKit2/ChangeLog (modified) (1 diff)
• WebKit2/UIProcess/API/gtk/WebKitTextChecker.cpp (modified) (2 diffs)
• WebKit2/UIProcess/API/gtk/WebKitTextChecker.h (modified) (3 diffs)
• WebKit2/UIProcess/API/gtk/WebKitWebContext.cpp (modified) (5 diffs)
• WebKit2/UIProcess/API/gtk/WebKitWebContext.h (modified) (1 diff)
• WebKit2/UIProcess/API/gtk/tests/TestWebKitWebContext.cpp (modified) (2 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2012-08-22  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Preferred languages and spellchecker APIs are not consistent in WebKit2
+        https://bugs.webkit.org/show_bug.cgi?id=94683
+
+        Reviewed by Alejandro G. Castro.
+
+        Use a Vector<String> instead of a comma-separated string to
+        get/set languages.
+
+        * platform/text/gtk/TextCheckerEnchant.cpp:
+        (TextCheckerEnchant::updateSpellCheckingLanguages):
+        (TextCheckerEnchant::getSpellCheckingLanguages):
+        * platform/text/gtk/TextCheckerEnchant.h:
+        (TextCheckerEnchant):
+
 2012-08-22  Pavel Feldman  <pfeldman@chromium.org>
 

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

@@ -156 +156 @@
 }
 
-void TextCheckerEnchant::updateSpellCheckingLanguages(const String& languages)
+void TextCheckerEnchant::updateSpellCheckingLanguages(const Vector<String>& languages)
 {
     Vector<EnchantDict*> spellDictionaries;
 
     if (!languages.isEmpty()) {
-        Vector<String> languagesVector;
-        languages.split(static_cast<UChar>(','), languagesVector);
-        for (Vector<String>::const_iterator iter = languagesVector.begin(); iter != languagesVector.end(); ++iter) {
+        for (Vector<String>::const_iterator iter = languages.begin(); iter != languages.end(); ++iter) {
             CString currentLanguage = iter->utf8();
             if (enchant_broker_dict_exists(m_broker, currentLanguage.data())) {
@@ -189 +187 @@
 }
 
-String TextCheckerEnchant::getSpellCheckingLanguages()
-{
+Vector<String> TextCheckerEnchant::getSpellCheckingLanguages()
+{
+    Vector<String> languages;
     if (m_enchantDictionaries.isEmpty())
-        return String();
+        return languages;
 
     // Get a Vector<CString> with the list of languages in use.
@@ -199 +198 @@
         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();
+    for (Vector<CString>::const_iterator iter = currentDictionaries.begin(); iter != currentDictionaries.end(); ++iter)
+        languages.append(String::fromUTF8(iter->data()));
+
+    return languages;
 }
 

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

@@ -42 +42 @@
     void checkSpellingOfString(const String&, int& misspellingLocation, int& misspellingLength);
     Vector<String> getGuessesForWord(const String&);
-    void updateSpellCheckingLanguages(const String& languages);
-    String getSpellCheckingLanguages();
+    void updateSpellCheckingLanguages(const Vector<String>& languages);
+    Vector<String> getSpellCheckingLanguages();
 
 private:

trunk/Source/WebKit/gtk/ChangeLog

@@ +1 @@
+2012-08-22  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Preferred languages and spellchecker APIs are not consistent in WebKit2
+        https://bugs.webkit.org/show_bug.cgi?id=94683
+
+        Reviewed by Alejandro G. Castro.
+
+        * webkit/webkitspellcheckerenchant.cpp:
+        (updateSpellCheckingLanguages): Split the languages string to pass a
+        Vector to updateSpellCheckingLanguages().
+
 2012-08-21  Joanmarie Diggs  <jdiggs@igalia.com>
         [Gtk] No accessible caret-moved events found in certain content

trunk/Source/WebKit/gtk/webkit/webkitspellcheckerenchant.cpp

@@ -100 +100 @@
 {
     WebKitSpellCheckerEnchantPrivate* priv = WEBKIT_SPELL_CHECKER_ENCHANT(checker)->priv;
-    priv->textCheckerEnchant->updateSpellCheckingLanguages(String::fromUTF8(languages));
+
+    Vector<String> languagesVector;
+    String::fromUTF8(languages).split(static_cast<UChar>(','), languagesVector);
+    priv->textCheckerEnchant->updateSpellCheckingLanguages(languagesVector);
 }
 

trunk/Source/WebKit2/ChangeLog

@@ +1 @@
+2012-08-22  Carlos Garcia Campos  <cgarcia@igalia.com>
+
+        [GTK] Preferred languages and spellchecker APIs are not consistent in WebKit2
+        https://bugs.webkit.org/show_bug.cgi?id=94683
+
+        Reviewed by Alejandro G. Castro.
+
+        Change spell-checker and preferred languages API to use a GStrv
+        instead of a comma-separated string and GList. This makes the API
+        more consistent and convenient to use.
+
+        * UIProcess/API/gtk/WebKitTextChecker.cpp:
+        (WebKitTextChecker::getSpellCheckingLanguages): Return a
+        Vector<String> instead of a String.
+        (WebKitTextChecker::setSpellCheckingLanguages): Receive a
+        Vector<String> instead of a String.
+        * UIProcess/API/gtk/WebKitTextChecker.h:
+        (WebKitTextChecker): Use a GPtrArray to cache languages.
+        * UIProcess/API/gtk/WebKitWebContext.cpp:
+        (webkit_web_context_get_spell_checking_languages):
+        (webkit_web_context_set_spell_checking_languages):
+        (webkit_web_context_set_preferred_languages):
+        * UIProcess/API/gtk/WebKitWebContext.h:
+        * UIProcess/API/gtk/tests/TestWebKitWebContext.cpp:
+        (testWebContextSpellChecker):
+        (testWebContextLanguages):
+
 2012-08-22  Csaba Osztrogonác  <ossy@webkit.org>
 

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

@@ -30 +30 @@
 
 #include "WebKitPrivate.h"
-#include <wtf/Vector.h>
-#include <wtf/text/CString.h>
 
 using namespace WebKit;
@@ -141 +139 @@
 }
 
-const CString& WebKitTextChecker::getSpellCheckingLanguages()
+const char* const* WebKitTextChecker::getSpellCheckingLanguages()
 {
-    String spellCheckingLanguages = m_textChecker->getSpellCheckingLanguages();
-    m_spellCheckingLanguages = spellCheckingLanguages.isEmpty() ? CString() : spellCheckingLanguages.utf8();
-    return m_spellCheckingLanguages;
+    Vector<String> spellCheckingLanguages = m_textChecker->getSpellCheckingLanguages();
+    if (spellCheckingLanguages.isEmpty())
+        return 0;
+
+    m_spellCheckingLanguages = adoptGRef(g_ptr_array_new_with_free_func(g_free));
+    for (size_t i = 0; i < spellCheckingLanguages.size(); ++i)
+        g_ptr_array_add(m_spellCheckingLanguages.get(), g_strdup(spellCheckingLanguages[i].utf8().data()));
+    g_ptr_array_add(m_spellCheckingLanguages.get(), 0);
+
+    return reinterpret_cast<char**>(m_spellCheckingLanguages->pdata);
 }
 
-void WebKitTextChecker::setSpellCheckingLanguages(const CString& languages)
+void WebKitTextChecker::setSpellCheckingLanguages(const char* const* languages)
 {
-    m_textChecker->updateSpellCheckingLanguages(String::fromUTF8(languages.data()));
+    Vector<String> spellCheckingLanguages;
+    for (size_t i = 0; languages[i]; ++i)
+        spellCheckingLanguages.append(String::fromUTF8(languages[i]));
+    m_textChecker->updateSpellCheckingLanguages(spellCheckingLanguages);
 }
 #endif // ENABLE(SPELLCHECK)

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

@@ -27 +27 @@
 #include <wtf/PassOwnPtr.h>
 #include <wtf/Vector.h>
+#include <wtf/gobject/GRefPtr.h>
 #include <wtf/text/CString.h>
 
@@ -45 +46 @@
 
     // To be called from WebKitWebContext only.
-    const CString& getSpellCheckingLanguages();
-    void setSpellCheckingLanguages(const CString& spellCheckingLanguages);
+    const char* const* getSpellCheckingLanguages();
+    void setSpellCheckingLanguages(const char* const* spellCheckingLanguages);
 
 private:
@@ -52 +53 @@
 
     OwnPtr<WebCore::TextCheckerEnchant> m_textChecker;
-    CString m_spellCheckingLanguages;
+    GRefPtr<GPtrArray> m_spellCheckingLanguages;
     bool m_spellCheckingEnabled;
 };

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

@@ -496 +496 @@
  *
  * Get the the list of spell checking languages associated with
- * @context separated by commas, or %NULL if no languages have been
- * previously set.
-
+ * @context, 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)
+ * Returns: (array zero-terminated=1) (element-type utf8) (transfer none): A %NULL-terminated
+ *    array of languages if available, or %NULL otherwise.
+ */
+const gchar* const* webkit_web_context_get_spell_checking_languages(WebKitWebContext* context)
 {
     g_return_val_if_fail(WEBKIT_IS_WEB_CONTEXT(context), 0);
 
 #if ENABLE(SPELLCHECK)
-    CString spellCheckingLanguages = context->priv->textChecker->getSpellCheckingLanguages();
-    if (spellCheckingLanguages.isNull())
-        return 0;
-    return spellCheckingLanguages.data();
+    return context->priv->textChecker->getSpellCheckingLanguages();
 #else
     return 0;
@@ -522 +518 @@
  * webkit_web_context_set_spell_checking_languages:
  * @context: a #WebKitWebContext
- * @languages: new list of spell checking languages separated by
- * commas
+ * @languages: (array zero-terminated=1) (transfer none): a %NULL-terminated list of spell checking languages
  *
  * Set the list of spell checking languages to be used for spell
- * checking, separated by commas.
+ * checking.
  *
  * The locale string typically is in the form lang_COUNTRY, where lang
@@ -537 +532 @@
  * in WebKit.
  */
-void webkit_web_context_set_spell_checking_languages(WebKitWebContext* context, const gchar* languages)
+void webkit_web_context_set_spell_checking_languages(WebKitWebContext* context, const gchar* const* languages)
 {
     g_return_if_fail(WEBKIT_IS_WEB_CONTEXT(context));
@@ -550 +545 @@
  * webkit_web_context_set_preferred_languages:
  * @context: a #WebKitWebContext
- * @languages: (element-type utf8): a #GList of language identifiers
+ * @languages: (allow-none) (array zero-terminated=1) (element-type utf8) (transfer none): a %NULL-terminated list of language identifiers
  *
  * Set the list of preferred languages, sorted from most desirable
@@ -557 +552 @@
  * the #WebKitWebContext.
  */
-void webkit_web_context_set_preferred_languages(WebKitWebContext* context, GList* languageList)
-{
-    g_return_if_fail(WEBKIT_IS_WEB_CONTEXT(context));
-
-    if (!languageList)
+void webkit_web_context_set_preferred_languages(WebKitWebContext* context, const gchar* const* languageList)
+{
+    g_return_if_fail(WEBKIT_IS_WEB_CONTEXT(context));
+
+    if (!languageList || !g_strv_length(const_cast<char**>(languageList)))
         return;
 
     Vector<String> languages;
-    for (GList* iter = languageList; iter; iter = g_list_next(iter))
-        languages.append(String::fromUTF8(static_cast<char*>(iter->data)).lower().replace("_", "-"));
+    for (size_t i = 0; languageList[i]; ++i)
+        languages.append(String::fromUTF8(languageList[i]).lower().replace("_", "-"));
 
     WebCore::overrideUserPreferredLanguages(languages);

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

@@ -141 +141 @@
 webkit_web_context_set_spell_checking_enabled       (WebKitWebContext              *context,
                                                      gboolean                       enabled);
-WEBKIT_API const gchar *
+WEBKIT_API const gchar * const *
 webkit_web_context_get_spell_checking_languages     (WebKitWebContext              *context);
 
 WEBKIT_API void
 webkit_web_context_set_spell_checking_languages     (WebKitWebContext              *context,
-                                                     const gchar                   *languages);
+                                                     const gchar * const           *languages);
 
 WEBKIT_API void
 webkit_web_context_set_preferred_languages          (WebKitWebContext              *context,
-                                                     GList                         *languages);
+                                                     const gchar * const           *languages);
 
 G_END_DECLS

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

@@ -211 +211 @@
 
     // Check what happens if no spell checking language has been set.
-    const gchar* currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
+    const gchar* const* 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");
+    GRefPtr<GPtrArray> languages = adoptGRef(g_ptr_array_new());
+    g_ptr_array_add(languages.get(), const_cast<gpointer>(static_cast<const void*>("en_US")));
+    g_ptr_array_add(languages.get(), 0);
+    webkit_web_context_set_spell_checking_languages(webContext, reinterpret_cast<const char* const*>(languages->pdata));
     currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
-    g_assert_cmpstr(currentLanguage, ==, "en_US");
+    g_assert_cmpuint(g_strv_length(const_cast<char**>(currentLanguage)), ==, 1);
+    g_assert_cmpstr(currentLanguage[0], ==, "en_US");
 
     // Set the language string to list of valid languages.
-    webkit_web_context_set_spell_checking_languages(webContext, "en_GB,en_US");
+    g_ptr_array_remove_index_fast(languages.get(), languages->len - 1);
+    g_ptr_array_add(languages.get(), const_cast<gpointer>(static_cast<const void*>("en_GB")));
+    g_ptr_array_add(languages.get(), 0);
+    webkit_web_context_set_spell_checking_languages(webContext, reinterpret_cast<const char* const*>(languages->pdata));
     currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
-    g_assert_cmpstr(currentLanguage, ==, "en_GB,en_US");
+    g_assert_cmpuint(g_strv_length(const_cast<char**>(currentLanguage)), ==, 2);
+    g_assert_cmpstr(currentLanguage[0], ==, "en_US");
+    g_assert_cmpstr(currentLanguage[1], ==, "en_GB");
 
     // Try passing a wrong language along with good ones.
-    webkit_web_context_set_spell_checking_languages(webContext, "bd_WR,en_US,en_GB");
+    g_ptr_array_remove_index_fast(languages.get(), languages->len - 1);
+    g_ptr_array_add(languages.get(), const_cast<gpointer>(static_cast<const void*>("bd_WR")));
+    g_ptr_array_add(languages.get(), 0);
+    webkit_web_context_set_spell_checking_languages(webContext, reinterpret_cast<const char* const*>(languages->pdata));
     currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
-    g_assert_cmpstr(currentLanguage, ==, "en_US,en_GB");
+    g_assert_cmpuint(g_strv_length(const_cast<char**>(currentLanguage)), ==, 2);
+    g_assert_cmpstr(currentLanguage[0], ==, "en_US");
+    g_assert_cmpstr(currentLanguage[1], ==, "en_GB");
 
     // Try passing a list with only wrong languages.
-    webkit_web_context_set_spell_checking_languages(webContext, "bd_WR,wr_BD");
+    languages = adoptGRef(g_ptr_array_new());
+    g_ptr_array_add(languages.get(), const_cast<gpointer>(static_cast<const void*>("bd_WR")));
+    g_ptr_array_add(languages.get(), const_cast<gpointer>(static_cast<const void*>("wr_BD")));
+    g_ptr_array_add(languages.get(), 0);
+    webkit_web_context_set_spell_checking_languages(webContext, reinterpret_cast<const char* const*>(languages->pdata));
     currentLanguage = webkit_web_context_get_spell_checking_languages(webContext);
     g_assert(!currentLanguage);
@@ -251 +269 @@
     g_assert(!strncmp(mainResourceData, expectedDefaultLanguage, mainResourceDataSize));
 
-    GList* languages = g_list_prepend(0, const_cast<gpointer>(static_cast<const void*>("dE")));
-    languages = g_list_prepend(languages, const_cast<gpointer>(static_cast<const void*>("ES_es")));
-    languages = g_list_prepend(languages, const_cast<gpointer>(static_cast<const void*>("en")));
-    webkit_web_context_set_preferred_languages(webkit_web_context_get_default(), languages);
-    g_list_free(languages);
+    GRefPtr<GPtrArray> languages = adoptGRef(g_ptr_array_new());
+    g_ptr_array_add(languages.get(), const_cast<gpointer>(static_cast<const void*>("en")));
+    g_ptr_array_add(languages.get(), const_cast<gpointer>(static_cast<const void*>("ES_es")));
+    g_ptr_array_add(languages.get(), const_cast<gpointer>(static_cast<const void*>("dE")));
+    g_ptr_array_add(languages.get(), 0);
+    webkit_web_context_set_preferred_languages(webkit_web_context_get_default(), reinterpret_cast<const char* const*>(languages->pdata));
 
     static const char* expectedLanguages = "en, es-es;q=0.90, de;q=0.80";