content/browser/renderer_host/ime_adapter_android.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "content/browser/renderer_host/ime_adapter_android.h"
   6
   7 #include <android/input.h>
   8
   9 #include "base/android/jni_android.h"
  10 #include "base/android/jni_string.h"
  11 #include "base/android/scoped_java_ref.h"
  12 #include "base/strings/utf_string_conversions.h"
  13 #include "base/time/time.h"
  14 #include "content/browser/frame_host/frame_tree.h"
  15 #include "content/browser/frame_host/frame_tree_node.h"
  16 #include "content/browser/frame_host/render_frame_host_impl.h"
  17 #include "content/browser/renderer_host/render_view_host_delegate.h"
  18 #include "content/browser/renderer_host/render_view_host_impl.h"
  19 #include "content/browser/renderer_host/render_widget_host_impl.h"
  20 #include "content/browser/renderer_host/render_widget_host_view_android.h"
  21 #include "content/common/frame_messages.h"
  22 #include "content/common/view_messages.h"
  23 #include "content/public/browser/browser_thread.h"
  24 #include "content/public/browser/native_web_keyboard_event.h"
  25 #include "content/public/browser/web_contents.h"
  26 #include "jni/ImeAdapter_jni.h"
  27 #include "third_party/WebKit/public/web/WebCompositionUnderline.h"
  28 #include "third_party/WebKit/public/web/WebInputEvent.h"
  29
  30 using base::android::AttachCurrentThread;
  31 using base::android::ConvertJavaStringToUTF16;
  32
  33 namespace content {
  34 namespace {
  35
  36 // Maps a java KeyEvent into a NativeWebKeyboardEvent.
  37 // |java_key_event| is used to maintain a globalref for KeyEvent.
  38 // |action| will help determine the WebInputEvent type.
  39 // type, |modifiers|, |time_ms|, |key_code|, |unicode_char| is used to create
  40 // WebKeyboardEvent. |key_code| is also needed ad need to treat the enter key
  41 // as a key press of character \r.
  42 NativeWebKeyboardEvent NativeWebKeyboardEventFromKeyEvent(
  43     JNIEnv* env,
  44     jobject java_key_event,
  45     int action,
  46     int modifiers,
  47     long time_ms,
  48     int key_code,
  49     bool is_system_key,
  50     int unicode_char) {
  51   blink::WebInputEvent::Type type = blink::WebInputEvent::Undefined;
  52   if (action == AKEY_EVENT_ACTION_DOWN)
  53     type = blink::WebInputEvent::RawKeyDown;
  54   else if (action == AKEY_EVENT_ACTION_UP)
  55     type = blink::WebInputEvent::KeyUp;
  56   return NativeWebKeyboardEvent(java_key_event, type, modifiers,
  57       time_ms / 1000.0, key_code, unicode_char, is_system_key);
  58 }
  59
  60 }  // anonymous namespace
  61
  62 bool RegisterImeAdapter(JNIEnv* env) {
  63   if (!RegisterNativesImpl(env))
  64     return false;
  65
  66   Java_ImeAdapter_initializeWebInputEvents(env,
  67                                            blink::WebInputEvent::RawKeyDown,
  68                                            blink::WebInputEvent::KeyUp,
  69                                            blink::WebInputEvent::Char,
  70                                            blink::WebInputEvent::ShiftKey,
  71                                            blink::WebInputEvent::AltKey,
  72                                            blink::WebInputEvent::ControlKey,
  73                                            blink::WebInputEvent::CapsLockOn,
  74                                            blink::WebInputEvent::NumLockOn);
  75   Java_ImeAdapter_initializeTextInputTypes(
  76       env,
  77       ui::TEXT_INPUT_TYPE_NONE,
  78       ui::TEXT_INPUT_TYPE_TEXT,
  79       ui::TEXT_INPUT_TYPE_TEXT_AREA,
  80       ui::TEXT_INPUT_TYPE_PASSWORD,
  81       ui::TEXT_INPUT_TYPE_SEARCH,
  82       ui::TEXT_INPUT_TYPE_URL,
  83       ui::TEXT_INPUT_TYPE_EMAIL,
  84       ui::TEXT_INPUT_TYPE_TELEPHONE,
  85       ui::TEXT_INPUT_TYPE_NUMBER,
  86       ui::TEXT_INPUT_TYPE_CONTENT_EDITABLE);
  87   return true;
  88 }
  89
  90 ImeAdapterAndroid::ImeAdapterAndroid(RenderWidgetHostViewAndroid* rwhva)
  91     : rwhva_(rwhva) {
  92 }
  93
  94 ImeAdapterAndroid::~ImeAdapterAndroid() {
  95   JNIEnv* env = AttachCurrentThread();
  96   base::android::ScopedJavaLocalRef<jobject> obj = java_ime_adapter_.get(env);
  97   if (!obj.is_null())
  98     Java_ImeAdapter_detach(env, obj.obj());
  99 }
 100
 101 bool ImeAdapterAndroid::SendSyntheticKeyEvent(JNIEnv*,
 102                                               jobject,
 103                                               int type,
 104                                               long time_ms,
 105                                               int key_code,
 106                                               int text) {
 107   NativeWebKeyboardEvent event(static_cast<blink::WebInputEvent::Type>(type),
 108                                0 /* modifiers */, time_ms / 1000.0, key_code,
 109                                text, false /* is_system_key */);
 110   rwhva_->SendKeyEvent(event);
 111   return true;
 112 }
 113
 114 bool ImeAdapterAndroid::SendKeyEvent(JNIEnv* env, jobject,
 115                                      jobject original_key_event,
 116                                      int action, int modifiers,
 117                                      long time_ms, int key_code,
 118                                      bool is_system_key, int unicode_char) {
 119   NativeWebKeyboardEvent event = NativeWebKeyboardEventFromKeyEvent(
 120           env, original_key_event, action, modifiers,
 121           time_ms, key_code, is_system_key, unicode_char);
 122   bool key_down_text_insertion =
 123       event.type == blink::WebInputEvent::RawKeyDown && event.text[0];
 124   // If we are going to follow up with a synthetic Char event, then that's the
 125   // one we expect to test if it's handled or unhandled, so skip handling the
 126   // "real" event in the browser.
 127   event.skip_in_browser = key_down_text_insertion;
 128   rwhva_->SendKeyEvent(event);
 129   if (key_down_text_insertion) {
 130     // Send a Char event, but without an os_event since we don't want to
 131     // roundtrip back to java such synthetic event.
 132     NativeWebKeyboardEvent char_event(blink::WebInputEvent::Char, modifiers,
 133                                       time_ms / 1000.0, key_code, unicode_char,
 134                                       is_system_key);
 135     char_event.skip_in_browser = key_down_text_insertion;
 136     rwhva_->SendKeyEvent(char_event);
 137   }
 138   return true;
 139 }
 140
 141 void ImeAdapterAndroid::SetComposingText(JNIEnv* env, jobject, jstring text,
 142                                          int new_cursor_pos) {
 143   RenderWidgetHostImpl* rwhi = GetRenderWidgetHostImpl();
 144   if (!rwhi)
 145     return;
 146
 147   base::string16 text16 = ConvertJavaStringToUTF16(env, text);
 148   std::vector<blink::WebCompositionUnderline> underlines;
 149   underlines.push_back(
 150       blink::WebCompositionUnderline(0, text16.length(), SK_ColorBLACK,
 151                                       false));
 152   // new_cursor_position is as described in the Android API for
 153   // InputConnection#setComposingText, whereas the parameters for
 154   // ImeSetComposition are relative to the start of the composition.
 155   if (new_cursor_pos > 0)
 156     new_cursor_pos = text16.length() + new_cursor_pos - 1;
 157
 158   rwhi->ImeSetComposition(text16, underlines, new_cursor_pos, new_cursor_pos);
 159 }
 160
 161 void ImeAdapterAndroid::CommitText(JNIEnv* env, jobject, jstring text) {
 162   RenderWidgetHostImpl* rwhi = GetRenderWidgetHostImpl();
 163   if (!rwhi)
 164     return;
 165
 166   base::string16 text16 = ConvertJavaStringToUTF16(env, text);
 167   rwhi->ImeConfirmComposition(text16, gfx::Range::InvalidRange(), false);
 168 }
 169
 170 void ImeAdapterAndroid::FinishComposingText(JNIEnv* env, jobject) {
 171   RenderWidgetHostImpl* rwhi = GetRenderWidgetHostImpl();
 172   if (!rwhi)
 173     return;
 174
 175   rwhi->ImeConfirmComposition(base::string16(), gfx::Range::InvalidRange(),
 176                               true);
 177 }
 178
 179 void ImeAdapterAndroid::AttachImeAdapter(JNIEnv* env, jobject java_object) {
 180   java_ime_adapter_ = JavaObjectWeakGlobalRef(env, java_object);
 181 }
 182
 183 void ImeAdapterAndroid::CancelComposition() {
 184   base::android::ScopedJavaLocalRef<jobject> obj =
 185       java_ime_adapter_.get(AttachCurrentThread());
 186   if (!obj.is_null())
 187     Java_ImeAdapter_cancelComposition(AttachCurrentThread(), obj.obj());
 188 }
 189
 190 void ImeAdapterAndroid::FocusedNodeChanged(bool is_editable_node) {
 191   base::android::ScopedJavaLocalRef<jobject> obj =
 192       java_ime_adapter_.get(AttachCurrentThread());
 193   if (!obj.is_null()) {
 194     Java_ImeAdapter_focusedNodeChanged(AttachCurrentThread(),
 195                                        obj.obj(),
 196                                        is_editable_node);
 197   }
 198 }
 199
 200 void ImeAdapterAndroid::SetEditableSelectionOffsets(JNIEnv*, jobject,
 201                                                     int start, int end) {
 202   RenderFrameHost* rfh = GetFocusedFrame();
 203   if (!rfh)
 204     return;
 205
 206   rfh->Send(new FrameMsg_SetEditableSelectionOffsets(rfh->GetRoutingID(),
 207                                                      start, end));
 208 }
 209
 210 void ImeAdapterAndroid::SetComposingRegion(JNIEnv*, jobject,
 211                                            int start, int end) {
 212   RenderFrameHost* rfh = GetFocusedFrame();
 213   if (!rfh)
 214     return;
 215
 216   std::vector<blink::WebCompositionUnderline> underlines;
 217   underlines.push_back(
 218       blink::WebCompositionUnderline(0, end - start, SK_ColorBLACK, false));
 219
 220   rfh->Send(new FrameMsg_SetCompositionFromExistingText(
 221       rfh->GetRoutingID(), start, end, underlines));
 222 }
 223
 224 void ImeAdapterAndroid::DeleteSurroundingText(JNIEnv*, jobject,
 225                                               int before, int after) {
 226   RenderFrameHostImpl* rfh =
 227       static_cast<RenderFrameHostImpl*>(GetFocusedFrame());
 228   if (rfh)
 229     rfh->ExtendSelectionAndDelete(before, after);
 230 }
 231
 232 void ImeAdapterAndroid::Unselect(JNIEnv* env, jobject) {
 233   WebContents* wc = GetWebContents();
 234   if (wc)
 235     wc->Unselect();
 236 }
 237
 238 void ImeAdapterAndroid::SelectAll(JNIEnv* env, jobject) {
 239   WebContents* wc = GetWebContents();
 240   if (wc)
 241     wc->SelectAll();
 242 }
 243
 244 void ImeAdapterAndroid::Cut(JNIEnv* env, jobject) {
 245   WebContents* wc = GetWebContents();
 246   if (wc)
 247     wc->Cut();
 248 }
 249
 250 void ImeAdapterAndroid::Copy(JNIEnv* env, jobject) {
 251   WebContents* wc = GetWebContents();
 252   if (wc)
 253     wc->Copy();
 254 }
 255
 256 void ImeAdapterAndroid::Paste(JNIEnv* env, jobject) {
 257   WebContents* wc = GetWebContents();
 258   if (wc)
 259     wc->Paste();
 260 }
 261
 262 void ImeAdapterAndroid::ResetImeAdapter(JNIEnv* env, jobject) {
 263   java_ime_adapter_.reset();
 264 }
 265
 266 RenderWidgetHostImpl* ImeAdapterAndroid::GetRenderWidgetHostImpl() {
 267   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 268   DCHECK(rwhva_);
 269   RenderWidgetHost* rwh = rwhva_->GetRenderWidgetHost();
 270   if (!rwh)
 271     return NULL;
 272
 273   return RenderWidgetHostImpl::From(rwh);
 274 }
 275
 276 RenderFrameHost* ImeAdapterAndroid::GetFocusedFrame() {
 277   RenderWidgetHostImpl* rwh = GetRenderWidgetHostImpl();
 278   if (!rwh)
 279     return NULL;
 280   if (!rwh->IsRenderView())
 281     return NULL;
 282   RenderViewHost* rvh = RenderViewHost::From(rwh);
 283   FrameTreeNode* focused_frame =
 284       rvh->GetDelegate()->GetFrameTree()->GetFocusedFrame();
 285   if (!focused_frame)
 286     return NULL;
 287
 288   return focused_frame->current_frame_host();
 289 }
 290
 291 WebContents* ImeAdapterAndroid::GetWebContents() {
 292   RenderWidgetHostImpl* rwh = GetRenderWidgetHostImpl();
 293   if (!rwh)
 294     return NULL;
 295   if (!rwh->IsRenderView())
 296     return NULL;
 297   return WebContents::FromRenderViewHost(RenderViewHost::From(rwh));
 298 }
 299
 300 }  // namespace content