Let ImeAdapterAndroid have the same lifecycle as its Java peer

content/browser/renderer_host/ime_adapter_android.cc

 // Copyright (c) 2012 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/renderer_host/ime_adapter_android.h"
 
 #include <algorithm>
 #include <android/input.h>
 #include <vector>
 
@@ skipping 13 matching lines @@
 #include "content/public/browser/native_web_keyboard_event.h"
 #include "content/public/browser/web_contents.h"
 #include "jni/ImeAdapter_jni.h"
 #include "third_party/WebKit/public/platform/WebInputEvent.h"
 #include "third_party/WebKit/public/platform/WebTextInputType.h"
 #include "third_party/WebKit/public/web/WebCompositionUnderline.h"
 
 using base::android::AttachCurrentThread;
 using base::android::ConvertJavaStringToUTF16;
 using base::android::JavaParamRef;
+using base::android::ScopedJavaLocalRef;
+using base::WeakPtr;
 
 namespace content {
 namespace {
 
 // Maps a java KeyEvent into a NativeWebKeyboardEvent.
 // |java_key_event| is used to maintain a globalref for KeyEvent.
 // |type| will determine the WebInputEvent type.
 // type, |modifiers|, |time_ms|, |key_code|, |unicode_char| is used to create
 // WebKeyboardEvent. |key_code| is also needed ad need to treat the enter key
 // as a key press of character \r.
@@ skipping 12 matching lines @@
                                 modifiers, time_ms / 1000.0, key_code,
                                 scan_code, unicode_char, is_system_key);
 }
 
 }  // anonymous namespace
 
 bool RegisterImeAdapter(JNIEnv* env) {
   return RegisterNativesImpl(env);
 }
 
+jlong Init(JNIEnv* env, const JavaParamRef<jobject>& obj) {
+  ImeAdapterAndroid* adapter = new ImeAdapterAndroid(env, obj);
+  return reinterpret_cast<intptr_t>(adapter);
+}
+
 // Callback from Java to convert BackgroundColorSpan data to a
 // blink::WebCompositionUnderline instance, and append it to |underlines_ptr|.
 void AppendBackgroundColorSpan(JNIEnv*,
                                const JavaParamRef<jclass>&,
                                jlong underlines_ptr,
                                jint start,
                                jint end,
                                jint background_color) {
   DCHECK_GE(start, 0);
   DCHECK_GE(end, 0);
@@ skipping 22 matching lines @@
       reinterpret_cast<std::vector<blink::WebCompositionUnderline>*>(
           underlines_ptr);
   underlines->push_back(
       blink::WebCompositionUnderline(static_cast<unsigned>(start),
                                      static_cast<unsigned>(end),
                                      SK_ColorBLACK,
                                      false,
                                      SK_ColorTRANSPARENT));
 }
 
-ImeAdapterAndroid::ImeAdapterAndroid(RenderWidgetHostViewAndroid* rwhva)
-    : rwhva_(rwhva) {
-  DCHECK(rwhva_);
+ImeAdapterAndroid::ImeAdapterAndroid(JNIEnv* env,
+                                     const JavaParamRef<jobject>& obj) {
+  java_ime_adapter_ = JavaObjectWeakGlobalRef(env, obj);
+}
+
+void ImeAdapterAndroid::Destroy(JNIEnv* env, const JavaParamRef<jobject>& obj) {
+  delete this;
+}
+
+void ImeAdapterAndroid::SetRenderWidgetHostViewAndroid(
+    const WeakPtr<RenderWidgetHostViewAndroid> rwhva) {
+  rwhva_.reset();
+  rwhva_ = rwhva;
+  JNIEnv* env = AttachCurrentThread();
+  ScopedJavaLocalRef<jobject> obj = java_ime_adapter_.get(env);
+  if (!obj.is_null())
+    Java_ImeAdapter_onConnectedToRenderProcess(env, obj);
 }
 
 ImeAdapterAndroid::~ImeAdapterAndroid() {
-  JNIEnv* env = AttachCurrentThread();
-  base::android::ScopedJavaLocalRef<jobject> obj = java_ime_adapter_.get(env);
-  if (!obj.is_null())
-    Java_ImeAdapter_detach(env, obj);
+  if (rwhva_)
+    rwhva_->ConnectImeAdapter(nullptr);
 }
 
 bool ImeAdapterAndroid::SendKeyEvent(
     JNIEnv* env,
     const JavaParamRef<jobject>&,
     const JavaParamRef<jobject>& original_key_event,
     int type,
     int modifiers,
     jlong time_ms,
     int key_code,
     int scan_code,
     bool is_system_key,
     int unicode_char) {
+  if (!rwhva_)
+    return false;
   NativeWebKeyboardEvent event = NativeWebKeyboardEventFromKeyEvent(
       env, original_key_event, type, modifiers, time_ms, key_code, scan_code,
       is_system_key, unicode_char);
   rwhva_->SendKeyEvent(event);
   return true;
 }
 
 void ImeAdapterAndroid::SetComposingText(JNIEnv* env,
                                          const JavaParamRef<jobject>& obj,
                                          const JavaParamRef<jobject>& text,
@@ skipping 52 matching lines @@
 
 void ImeAdapterAndroid::FinishComposingText(JNIEnv* env,
                                             const JavaParamRef<jobject>&) {
   RenderWidgetHostImpl* rwhi = GetFocusedWidget();
   if (!rwhi)
     return;
 
   rwhi->ImeFinishComposingText(true);
 }
 
-void ImeAdapterAndroid::AttachImeAdapter(
-    JNIEnv* env,
-    const JavaParamRef<jobject>& java_object) {
-  java_ime_adapter_ = JavaObjectWeakGlobalRef(env, java_object);
-}
-
 void ImeAdapterAndroid::CancelComposition() {
-  base::android::ScopedJavaLocalRef<jobject> obj =
-      java_ime_adapter_.get(AttachCurrentThread());
+  JNIEnv* env = AttachCurrentThread();
+  ScopedJavaLocalRef<jobject> obj = java_ime_adapter_.get(env);
   if (!obj.is_null())
-    Java_ImeAdapter_cancelComposition(AttachCurrentThread(), obj);
+    Java_ImeAdapter_cancelComposition(env, obj);
 }
 
 void ImeAdapterAndroid::FocusedNodeChanged(bool is_editable_node) {
-  base::android::ScopedJavaLocalRef<jobject> obj =
-      java_ime_adapter_.get(AttachCurrentThread());
+  JNIEnv* env = AttachCurrentThread();
+  ScopedJavaLocalRef<jobject> obj = java_ime_adapter_.get(env);
   if (!obj.is_null()) {
-    Java_ImeAdapter_focusedNodeChanged(AttachCurrentThread(), obj,
-                                       is_editable_node);
+    Java_ImeAdapter_focusedNodeChanged(env, obj, is_editable_node);
   }
 }
 
 void ImeAdapterAndroid::SetEditableSelectionOffsets(
     JNIEnv*,
     const JavaParamRef<jobject>&,
     int start,
     int end) {
   RenderFrameHost* rfh = GetFocusedFrame();
   if (!rfh)
     return;
 
   rfh->Send(new InputMsg_SetEditableSelectionOffsets(rfh->GetRoutingID(), start,
                                                      end));
 }
 
 void ImeAdapterAndroid::SetCharacterBounds(
     const std::vector<gfx::RectF>& character_bounds) {
   JNIEnv* env = AttachCurrentThread();
-  base::android::ScopedJavaLocalRef<jobject> obj = java_ime_adapter_.get(env);
+  ScopedJavaLocalRef<jobject> obj = java_ime_adapter_.get(env);
   if (obj.is_null())
     return;
 
   const size_t coordinates_array_size = character_bounds.size() * 4;
   std::unique_ptr<float[]> coordinates_array(new float[coordinates_array_size]);
   for (size_t i = 0; i < character_bounds.size(); ++i) {
     const gfx::RectF& rect = character_bounds[i];
     const size_t coordinates_array_index = i * 4;
     coordinates_array[coordinates_array_index + 0] = rect.x();
     coordinates_array[coordinates_array_index + 1] = rect.y();
@@ skipping 57 matching lines @@
     const base::android::JavaParamRef<jobject>& obj,
     bool immediate_request,
     bool monitor_request) {
   RenderWidgetHostImpl* rwhi = GetFocusedWidget();
   if (!rwhi)
     return;
   rwhi->Send(new InputMsg_RequestCompositionUpdate(
       rwhi->GetRoutingID(), immediate_request, monitor_request));
 }
 
-void ImeAdapterAndroid::ResetImeAdapter(JNIEnv* env,
-                                        const JavaParamRef<jobject>&) {
-  java_ime_adapter_.reset();
-}
-
 RenderWidgetHostImpl* ImeAdapterAndroid::GetFocusedWidget() {
   DCHECK_CURRENTLY_ON(BrowserThread::UI);
-  return rwhva_->GetFocusedWidget();
+  return rwhva_ ? rwhva_->GetFocusedWidget() : nullptr;

[boliu, 2017/03/23 04:17:01]

changwan: does everything here run on the UI thread? weakptrs are not thread
safe

[Jinsuk Kim, 2017/03/23 07:25:10]

I read that everything runs on UI thread. ThreadedInputConnection which runs on
IME thread posts every request onto UI thread before reaching here(I guess the
missing DCHECK for UI thread in |::SendKeyEvent| is just a mistake). But I'll
wait for changwan@ to confirm.

[Changwan Ryu, 2017/03/23 23:45:19]

Correct. Everything from ThreadedInput* to ImeAdapter should be on UI thread.
One exception is updateSelection() which goes directly to Android framework.

[Jinsuk Kim, 2017/03/24 02:34:23]

Thanks!

 }
 
 RenderFrameHost* ImeAdapterAndroid::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;
 }
@@ skipping 11 matching lines @@
   Java_ImeAdapter_populateUnderlinesFromSpans(
       env, obj, text, reinterpret_cast<jlong>(&underlines));
 
   // Sort spans by |.startOffset|.
   std::sort(underlines.begin(), underlines.end());
 
   return underlines;
 }
 
 }  // namespace content