Fix spellchecking for macOS

The change fixes spellchecking to work on macOS.
A new WebEngine configure option is available to allow spellchecking on
macOS to use either Hunspell like the other platforms, or the native
spellchecker that comes with the OS. The default is to use Hunspell.

Task-number: QTBUG-53135
Change-Id: I3e45b2e0d728b1bf2659c35f3d0a042b0ecd6239
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Michal Klocek <michal.klocek@qt.io>

4 files changed, 78 insertions, 11 deletions

diff --git a/src/core/chrome_qt.gyp b/src/core/chrome_qt.gyp
index 3fa2625a8..89f1fe188 100644
--- a/src/core/chrome_qt.gyp
+++ b/src/core/chrome_qt.gyp
@@ -132,6 +132,8 @@
               'sources!': [
                 '<(DEPTH)/chrome/renderer/spellchecker/platform_spelling_engine.cc',
                 '<(DEPTH)/chrome/renderer/spellchecker/platform_spelling_engine.h',
+                '<(DEPTH)/chrome/browser/spellchecker/spellcheck_message_filter_platform.h',
+                '<(DEPTH)/chrome/browser/spellchecker/spellcheck_message_filter_platform_mac.cc',
               ],
             }],
           ],
diff --git a/src/core/content_browser_client_qt.cpp b/src/core/content_browser_client_qt.cpp
index 64964dc09..a57c3b00f 100644
--- a/src/core/content_browser_client_qt.cpp
+++ b/src/core/content_browser_client_qt.cpp
@@ -44,6 +44,9 @@
 #include "base/threading/thread_restrictions.h"
 #if defined(ENABLE_SPELLCHECK)
 #include "chrome/browser/spellchecker/spellcheck_message_filter.h"
+#if defined(USE_BROWSER_SPELLCHECKER)
+#include "chrome/browser/spellchecker/spellcheck_message_filter_platform.h"
+#endif
 #endif
 #include "content/browser/renderer_host/render_view_host_delegate.h"
 #include "content/public/browser/browser_main_parts.h"
@@ -377,8 +380,12 @@ void ContentBrowserClientQt::RenderProcessWillLaunch(content::RenderProcessHost*
     host->AddFilter(new BrowserMessageFilterQt(id));
 #endif
 #if defined(ENABLE_SPELLCHECK)
+    // SpellCheckMessageFilter is required for both Hunspell and Native configurations.
     host->AddFilter(new SpellCheckMessageFilter(id));
 #endif
+#if defined(Q_OS_MACOS) && defined(USE_BROWSER_SPELLCHECKER)
+  host->AddFilter(new SpellCheckMessageFilterPlatform(id));
+#endif
 #if defined(ENABLE_BASIC_PRINTING)
     host->AddFilter(new PrintingMessageFilterQt(host->GetID()));
 #endif // defined(ENABLE_BASIC_PRINTING)
diff --git a/src/core/gyp_run.pro b/src/core/gyp_run.pro
index 89b751c4a..1c62c0cfd 100644
--- a/src/core/gyp_run.pro
+++ b/src/core/gyp_run.pro
@@ -124,10 +124,16 @@ contains(WEBENGINE_CONFIG, reduce_binary_size): GYP_CONFIG += release_optimize=s
 
 contains(WEBENGINE_CONFIG, no_spellcheck): {
     GYP_CONFIG += enable_spellcheck=0
-    osx: GYP_CONFIG += use_browser_spellchecker=0
+    macos: GYP_CONFIG += use_browser_spellchecker=0
 } else {
     GYP_CONFIG += enable_spellcheck=1
-    osx: GYP_CONFIG += use_browser_spellchecker=1
+    macos {
+        contains(WEBENGINE_CONFIG, use_native_spellchecker) {
+            GYP_CONFIG += use_browser_spellchecker=1
+        } else {
+            GYP_CONFIG += use_browser_spellchecker=0
+        }
+    }
 }
 
 !qtConfig(framework):qtConfig(private_tests) {
diff --git a/src/core/web_engine_library_info.cpp b/src/core/web_engine_library_info.cpp
index 2be59d1c6..40977812d 100644
--- a/src/core/web_engine_library_info.cpp
+++ b/src/core/web_engine_library_info.cpp
@@ -69,7 +69,7 @@ QString fallbackDir() {
     return directory;
 }
 
-#if defined(OS_MACOSX)
+#if defined(OS_MACOSX) && defined(QT_MAC_FRAMEWORK_BUILD)
 static inline CFBundleRef frameworkBundle()
 {
     return CFBundleGetBundleWithIdentifier(CFSTR("org.qt-project.Qt.QtWebEngineCore"));
@@ -112,6 +112,34 @@ static QString getResourcesPath(CFBundleRef frameworkBundle)
 }
 #endif
 
+#if defined(OS_MACOSX)
+static QString getMainApplicationResourcesPath()
+{
+    QString resourcesPath;
+    CFBundleRef mainBundle = CFBundleGetMainBundle();
+    if (!mainBundle)
+        return resourcesPath;
+
+    // Will point to Resources inside an app bundle, or in case if the application is not packaged
+    // as a bundle, will point to the application directory, where the resources are assumed to be
+    // found.
+    CFURLRef resourcesRelativeUrl = CFBundleCopyResourcesDirectoryURL(mainBundle);
+    if (!resourcesRelativeUrl)
+        return resourcesPath;
+
+    CFURLRef resourcesAbsoluteUrl = CFURLCopyAbsoluteURL(resourcesRelativeUrl);
+    CFStringRef resourcesAbolutePath = CFURLCopyFileSystemPath(resourcesAbsoluteUrl,
+                                                                kCFURLPOSIXPathStyle);
+    resourcesPath = QString::fromCFString(resourcesAbolutePath);
+    CFRelease(resourcesAbolutePath);
+    CFRelease(resourcesAbsoluteUrl);
+    CFRelease(resourcesRelativeUrl);
+
+    return resourcesPath;
+}
+
+#endif
+
 QString subProcessPath()
 {
     static QString processPath;
@@ -181,18 +209,42 @@ QString localesPath()
 #if defined(ENABLE_SPELLCHECK)
 QString dictionariesPath()
 {
+    static QString potentialDictionariesPath;
+    static bool initialized = false;
+    QStringList candidatePaths;
+    if (!initialized) {
+        initialized = true;
+
+        // First try to find dictionaries near the application.
+#ifdef OS_MACOSX
+        QString resourcesDictionariesPath = getMainApplicationResourcesPath()
+                % QDir::separator() % QLatin1String("qtwebengine_dictionaries");
+        candidatePaths << resourcesDictionariesPath;
+#endif
+        QString applicationDictionariesPath = QCoreApplication::applicationDirPath()
+                % QDir::separator() % QLatin1String("qtwebengine_dictionaries");
+        candidatePaths << applicationDictionariesPath;
+
+        // Then try to find dictionaries near the installed library.
 #if defined(OS_MACOSX) && defined(QT_MAC_FRAMEWORK_BUILD)
-    return getResourcesPath(frameworkBundle()) % QLatin1String("/qtwebengine_dictionaries");
-#else
-    // first local path
-    static QString potentialDictionariesPath = QCoreApplication::applicationDirPath() % QDir::separator() % QLatin1String("qtwebengine_dictionaries");
+        QString frameworkDictionariesPath = getResourcesPath(frameworkBundle())
+                % QLatin1String("/qtwebengine_dictionaries");
+        candidatePaths << frameworkDictionariesPath;
+#endif
+
+        QString libraryDictionariesPath = QLibraryInfo::location(QLibraryInfo::DataPath)
+                % QDir::separator() % QLatin1String("qtwebengine_dictionaries");
+        candidatePaths << libraryDictionariesPath;
 
-    // now global one
-    if (!QFileInfo::exists(potentialDictionariesPath))
-        potentialDictionariesPath = QLibraryInfo::location(QLibraryInfo::DataPath) % QDir::separator() % QLatin1String("qtwebengine_dictionaries");
+        Q_FOREACH (const QString &candidate, candidatePaths) {
+            if (QFileInfo::exists(candidate)) {
+                potentialDictionariesPath = candidate;
+                break;
+            }
+        }
+    }
 
     return potentialDictionariesPath;
-#endif
 }
 #endif // ENABLE_SPELLCHECK