Add support for Android spellcheck menu in Chrome/WebViews

content/browser/android/text_suggestion_host_android.cc

+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "content/browser/android/text_suggestion_host_android.h"
+
+#include "base/android/jni_android.h"
+#include "base/android/jni_array.h"
+#include "base/android/jni_string.h"
+#include "content/browser/android/text_suggestion_host_mojo_impl_android.h"
+#include "content/browser/renderer_host/render_widget_host_impl.h"
+#include "content/public/browser/browser_thread.h"
+#include "content/public/browser/render_frame_host.h"
+#include "content/public/browser/web_contents.h"
+#include "jni/TextSuggestionHost_jni.h"
+#include "services/service_manager/public/cpp/interface_provider.h"
+
+using base::android::AttachCurrentThread;
+using base::android::ConvertUTF8ToJavaString;
+using base::android::JavaParamRef;
+using base::android::ScopedJavaLocalRef;
+using base::android::ToJavaArrayOfStrings;
+
+namespace content {
+namespace {
+
+const int kDoubleTapTimeoutInMilliseconds = 300;

[Ted C, 2017/06/21 17:59:21]

Is this supposed to match
https://developer.android.com/reference/android/view/ViewConfiguration.html#g...
 Should we be pulling from there?

gfx::ViewConfiguration::GetDoubleTapTimeoutInMs(); ?

[rlanday, 2017/06/28 01:35:33]

Ok, I'll do that

+
+}  // namespace
+
+bool RegisterTextSuggestionHost(JNIEnv* env) {
+  return RegisterNativesImpl(env);
+}
+
+jlong Init(JNIEnv* env,
+           const JavaParamRef<jobject>& obj,
+           const JavaParamRef<jobject>& jweb_contents) {
+  WebContents* web_contents = WebContents::FromJavaWebContents(jweb_contents);
+  DCHECK(web_contents);
+  auto* text_suggestion_host =
+      new TextSuggestionHostAndroid(env, obj, web_contents);
+  text_suggestion_host->Initialize();
+  return reinterpret_cast<intptr_t>(text_suggestion_host);
+}
+
+TextSuggestionHostAndroid::TextSuggestionHostAndroid(
+    JNIEnv* env,
+    const JavaParamRef<jobject>& obj,
+    WebContents* web_contents)
+    : RenderWidgetHostConnector(web_contents),
+      rwhva_(nullptr),
+      spellcheck_menu_timeout_(
+          base::Bind(&TextSuggestionHostAndroid::OnSpellCheckMenuTimeout,
+                     base::Unretained(this))) {
+  java_text_suggestion_host_ = JavaObjectWeakGlobalRef(env, obj);

[rlanday, 2017/06/28 01:35:33]

This can go in the initializer list

+
+  RenderFrameHost* rfh = GetFocusedFrame();

[Ted C, 2017/06/21 17:59:21]

should we call FocusedNodeChanged() here instead of these lines?

[rlanday, 2017/06/28 01:35:33]

I guess it avoids some code duplication, I'll do that

[rlanday, 2017/06/28 01:35:33]

I guess it avoids some code duplication, I'll do that

+  if (!rfh)
+    return;
+
+  rfh->GetInterfaceRegistry()->AddInterface(base::Bind(
+      &TextSuggestionHostMojoImplAndroid::Create, base::Unretained(this)));
+}
+
+TextSuggestionHostAndroid::~TextSuggestionHostAndroid() {
+  JNIEnv* env = AttachCurrentThread();
+  ScopedJavaLocalRef<jobject> obj = java_text_suggestion_host_.get(env);
+  if (!obj.is_null())
+    Java_TextSuggestionHost_destroy(env, obj);
+}
+
+void TextSuggestionHostAndroid::UpdateRenderProcessConnection(
+    RenderWidgetHostViewAndroid* old_rwhva,
+    RenderWidgetHostViewAndroid* new_rwhva) {
+  text_suggestion_backend_ = nullptr;
+  if (old_rwhva)
+    old_rwhva->set_text_suggestion_host(nullptr);
+  if (new_rwhva)
+    new_rwhva->set_text_suggestion_host(this);
+  rwhva_ = new_rwhva;
+}
+
+void TextSuggestionHostAndroid::ApplySpellCheckSuggestion(
+    JNIEnv* env,
+    const JavaParamRef<jobject>&,
+    const base::android::JavaParamRef<jstring>& replacement) {
+  const blink::mojom::TextSuggestionBackendPtr& text_suggestion_backend =
+      GetTextSuggestionBackend();
+  if (!text_suggestion_backend)
+    return;
+  text_suggestion_backend->ApplySpellCheckSuggestion(
+      ConvertJavaStringToUTF8(env, replacement));
+}
+
+void TextSuggestionHostAndroid::DeleteActiveSuggestionRange(
+    JNIEnv*,
+    const JavaParamRef<jobject>&) {
+  const blink::mojom::TextSuggestionBackendPtr& text_suggestion_backend =
+      GetTextSuggestionBackend();
+  if (!text_suggestion_backend)
+    return;
+  text_suggestion_backend->DeleteActiveSuggestionRange();
+}
+
+void TextSuggestionHostAndroid::NewWordAddedToDictionary(
+    JNIEnv* env,
+    const JavaParamRef<jobject>&,
+    const base::android::JavaParamRef<jstring>& word) {
+  const blink::mojom::TextSuggestionBackendPtr& text_suggestion_backend =
+      GetTextSuggestionBackend();
+  if (!text_suggestion_backend)
+    return;
+  text_suggestion_backend->NewWordAddedToDictionary(
+      ConvertJavaStringToUTF8(env, word));
+}
+void TextSuggestionHostAndroid::SuggestionMenuClosed(

[Ted C, 2017/06/21 17:59:21]

add blank line above this

+    JNIEnv*,
+    const JavaParamRef<jobject>&) {
+  const blink::mojom::TextSuggestionBackendPtr& text_suggestion_backend =
+      GetTextSuggestionBackend();
+  if (!text_suggestion_backend)
+    return;
+  text_suggestion_backend->SuggestionMenuClosed();
+}
+
+void TextSuggestionHostAndroid::ShowSpellCheckSuggestionMenu(
+    double caret_x,
+    double caret_y,
+    const std::string& marked_text,
+    const std::vector<blink::mojom::SpellCheckSuggestionPtr>& suggestions) {
+  std::vector<std::string> suggestion_strings;
+  for (const auto& suggestion_ptr : suggestions)
+    suggestion_strings.push_back(suggestion_ptr->suggestion);
+  JNIEnv* env = AttachCurrentThread();
+  ScopedJavaLocalRef<jobject> obj = java_text_suggestion_host_.get(env);

[Ted C, 2017/06/21 17:59:20]

should you check that obj is non-null here?

[rlanday, 2017/06/28 01:35:33]

I think so...this class is set up pretty similarly to ImeAdapterAndroid, and I
see that class is full of "if (obj.is_null())" checks

+  Java_TextSuggestionHost_showSpellCheckSuggestionMenu(
+      env, obj, caret_x, caret_y, ConvertUTF8ToJavaString(env, marked_text),
+      ToJavaArrayOfStrings(env, suggestion_strings));
+}
+
+void TextSuggestionHostAndroid::FocusedNodeChanged() {
+  RenderFrameHost* rfh = GetFocusedFrame();
+  if (!rfh)
+    return;
+
+  rfh->GetInterfaceRegistry()->AddInterface(base::Bind(

[Ted C, 2017/06/21 17:59:21]

does there need to be a corresponding RemoveInterface on the previous rfh?

[rlanday, 2017/06/28 01:35:33]

I don't think so, I think this object is shared between RenderFrameHosts.
Looking at other code, this seems to be a common pattern. E.g.:
https://chromium.googlesource.com/chromium/src/+/e13b5cad035abf6c2d0d75f26303...

"AutofillAgent is guaranteed to outlive |render_frame|." seems to be a
justification for not ever calling RemoveInterface().


If we did want to call RemoveInterface(), would it actually be safe to hold onto
a pointer to the RenderFrameHost or service_manager::BinderRegistry? I'm not
sure how else we would do this.

+      &TextSuggestionHostMojoImplAndroid::Create, base::Unretained(this)));
+}
+
+void TextSuggestionHostAndroid::StartSpellCheckMenuTimer() {
+  spellcheck_menu_timeout_.Stop();
+  spellcheck_menu_timeout_.Start(
+      base::TimeDelta::FromMilliseconds(kDoubleTapTimeoutInMilliseconds));
+}
+
+void TextSuggestionHostAndroid::StopSpellCheckMenuTimer() {
+  spellcheck_menu_timeout_.Stop();
+}
+
+RenderFrameHost* TextSuggestionHostAndroid::GetFocusedFrame() {
+  DCHECK_CURRENTLY_ON(BrowserThread::UI);
+  // We get the focused frame from the WebContents of the page. Although
+  // |rwhva_->GetFocusedWidget()| does a similar thing, there is no direct way
+  // to get a RenderFrameHost from its RWH.
+  if (!rwhva_)
+    return nullptr;
+  RenderWidgetHostImpl* rwh =
+      RenderWidgetHostImpl::From(rwhva_->GetRenderWidgetHost());
+  if (!rwh || !rwh->delegate())
+    return nullptr;
+
+  if (auto* contents = rwh->delegate()->GetAsWebContents())
+    return contents->GetFocusedFrame();
+
+  return nullptr;
+}
+
+const blink::mojom::TextSuggestionBackendPtr&
+TextSuggestionHostAndroid::GetTextSuggestionBackend() {
+  if (!text_suggestion_backend_) {
+    if (RenderFrameHost* rfh = GetFocusedFrame()) {
+      rfh->GetRemoteInterfaces()->GetInterface(
+          mojo::MakeRequest(&text_suggestion_backend_));
+    }
+  }
+  return text_suggestion_backend_;
+}
+
+void TextSuggestionHostAndroid::OnSpellCheckMenuTimeout() {
+  const blink::mojom::TextSuggestionBackendPtr& text_suggestion_backend =
+      GetTextSuggestionBackend();
+  if (!text_suggestion_backend)
+    return;
+  text_suggestion_backend->SpellCheckMenuTimeoutCallback();
+}
+
+}  // namespace content