Hook up InputMethodWinTSF with IME extension on Windows.

This CL hooks up InputMethodWinTsf with IME extension. Since ui::TSFBridge
may be null for unit tests, this Cl also adds protection in InputMethodWinTSF.

Bug: 657623
Change-Id: I608ceba376f0fdba537339030d35c11993e16822
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1507234Reviewed-by: Shu Chen <shuchen@chromium.org>
Reviewed-by: Navid Zolghadr <nzolghadr@chromium.org>
Reviewed-by: Sadrul Chowdhury <sadrul@chromium.org>
Commit-Queue: Siye Liu <siliu@microsoft.com>
Cr-Commit-Position: refs/heads/master@{#641127}

ui/base/ime/input_method_win_base.cc

@@ -517,4 +517,48 @@ ui::EventDispatchDetails InputMethodWinBase::ProcessUnhandledKeyEvent(
   return details;
 }
 
+void InputMethodWinBase::UpdateCompositionBoundsForEngine(
+    const TextInputClient* client) {
+  TextInputType text_input_type = GetTextInputType();
+  if (client == GetTextInputClient() &&
+      text_input_type != TEXT_INPUT_TYPE_NONE &&
+      text_input_type != TEXT_INPUT_TYPE_PASSWORD && GetEngine()) {
+    GetEngine()->SetCompositionBounds(GetCompositionBounds(client));
+  }
+}
+
+void InputMethodWinBase::ResetEngine() {
+  if (GetEngine())
+    GetEngine()->Reset();
+}
+
+void InputMethodWinBase::CancelCompositionForEngine() {
+  TextInputType text_input_type = GetTextInputType();
+  if (text_input_type != TEXT_INPUT_TYPE_NONE &&
+      text_input_type != TEXT_INPUT_TYPE_PASSWORD) {
+    InputMethodWinBase::ResetEngine();
+  }
+}
+
+void InputMethodWinBase::UpdateEngineFocusAndInputContext() {
+  if (!ui::IMEBridge::Get())  // IMEBridge could be null for tests.
+    return;
+
+  const TextInputType old_text_input_type =
+      ui::IMEBridge::Get()->GetCurrentInputContext().type;
+  ui::IMEEngineHandlerInterface::InputContext context(
+      GetTextInputType(), GetTextInputMode(), GetTextInputFlags(),
+      ui::TextInputClient::FOCUS_REASON_OTHER, GetClientShouldDoLearning());
+  ui::IMEBridge::Get()->SetCurrentInputContext(context);
+
+  // Update IME Engine state.
+  ui::IMEEngineHandlerInterface* engine = GetEngine();
+  if (engine) {
+    if (old_text_input_type != ui::TEXT_INPUT_TYPE_NONE)
+      engine->FocusOut();
+    if (GetTextInputType() != ui::TEXT_INPUT_TYPE_NONE)
+      engine->FocusIn(context);
+  }
+}
+
 }  // namespace ui

ui/base/ime/input_method_win_base.h

@@ -60,6 +60,19 @@ class UI_BASE_IME_EXPORT InputMethodWinBase : public InputMethodBase {
       ui::KeyEvent* event,
       const std::vector<MSG>* char_msgs);
 
+  // Update composition bounds for Chromium IME extension.
+  void UpdateCompositionBoundsForEngine(const TextInputClient* client);
+
+  // Reset composition status for Chromium IME extension.
+  void ResetEngine();
+
+  // Cancel composition for Chromium IME extension.
+  void CancelCompositionForEngine();
+
+  // Update focus state for Chromium IME extension and update input context in
+  // ui::IMEBridge.
+  void UpdateEngineFocusAndInputContext();
+
   // The toplevel window handle.
   const HWND toplevel_window_handle_;
 

ui/base/ime/input_method_win_imm32.cc

@@ -100,14 +100,7 @@ void InputMethodWinImm32::OnCaretBoundsChanged(const TextInputClient* client) {
   if (!IsTextInputClientFocused(client) || !IsWindowFocused(client))
     return;
   NotifyTextInputCaretBoundsChanged(client);
-  TextInputType text_input_type = GetTextInputType();
-  if (client == GetTextInputClient() &&
-      text_input_type != TEXT_INPUT_TYPE_NONE &&
-      text_input_type != TEXT_INPUT_TYPE_PASSWORD && GetEngine()) {
-    // |enabled_| == false could be faked, and the engine should rely on the
-    // real type from GetTextInputType().
-    GetEngine()->SetCompositionBounds(GetCompositionBounds(client));
-  }
+  InputMethodWinBase::UpdateCompositionBoundsForEngine(client);
   if (!enabled_)
     return;
 
@@ -135,11 +128,7 @@ void InputMethodWinImm32::CancelComposition(const TextInputClient* client) {
   if (IsTextInputClientFocused(client)) {
     // |enabled_| == false could be faked, and the engine should rely on the
     // real type get from GetTextInputType().
-    TextInputType text_input_type = GetTextInputType();
-    if (text_input_type != TEXT_INPUT_TYPE_NONE &&
-        text_input_type != TEXT_INPUT_TYPE_PASSWORD && GetEngine()) {
-      GetEngine()->Reset();
-    }
+    InputMethodWinBase::CancelCompositionForEngine();
 
     if (enabled_)
       imm32_manager_.CancelIME(toplevel_window_handle_);
@@ -340,8 +329,7 @@ void InputMethodWinImm32::ConfirmCompositionText() {
   if (!IsTextInputTypeNone() && GetTextInputClient()->HasCompositionText()) {
     GetTextInputClient()->ConfirmCompositionText();
 
-    if (GetEngine())
-      GetEngine()->Reset();
+    InputMethodWinBase::ResetEngine();
   }
 }
 
@@ -370,23 +358,7 @@ void InputMethodWinImm32::UpdateIMEState() {
   tsf_inputscope::SetInputScopeForTsfUnawareWindow(
       window_handle, text_input_type, text_input_mode);
 
-  if (!ui::IMEBridge::Get())  // IMEBridge could be null for tests.
-    return;
-
-  const TextInputType old_text_input_type =
-      ui::IMEBridge::Get()->GetCurrentInputContext().type;
-  ui::IMEEngineHandlerInterface::InputContext context(
-      GetTextInputType(), GetTextInputMode(), GetTextInputFlags(),
-      ui::TextInputClient::FOCUS_REASON_OTHER, GetClientShouldDoLearning());
-  ui::IMEBridge::Get()->SetCurrentInputContext(context);
-
-  ui::IMEEngineHandlerInterface* engine = GetEngine();
-  if (engine) {
-    if (old_text_input_type != ui::TEXT_INPUT_TYPE_NONE)
-      engine->FocusOut();
-    if (GetTextInputType() != ui::TEXT_INPUT_TYPE_NONE)
-      engine->FocusIn(context);
-  }
+  InputMethodWinBase::UpdateEngineFocusAndInputContext();
 }
 
 }  // namespace ui

ui/base/ime/input_method_win_tsf.cc

@@ -39,6 +39,11 @@ InputMethodWinTSF::InputMethodWinTSF(internal::InputMethodDelegate* delegate,
 InputMethodWinTSF::~InputMethodWinTSF() {}
 
 void InputMethodWinTSF::OnFocus() {
+  InputMethodBase::OnFocus();
+  if (!ui::TSFBridge::GetInstance()) {
+    // TSFBridge can be null for tests.
+    return;
+  }
   tsf_event_router_->SetManager(
       ui::TSFBridge::GetInstance()->GetThreadManager().Get());
   ui::TSFBridge::GetInstance()->SetInputMethodDelegate(
@@ -46,6 +51,11 @@ void InputMethodWinTSF::OnFocus() {
 }
 
 void InputMethodWinTSF::OnBlur() {
+  InputMethodBase::OnBlur();
+  if (!ui::TSFBridge::GetInstance()) {
+    // TSFBridge can be null for tests.
+    return;
+  }
   tsf_event_router_->SetManager(nullptr);
   ui::TSFBridge::GetInstance()->RemoveInputMethodDelegate();
 }
@@ -83,24 +93,38 @@ bool InputMethodWinTSF::OnUntranslatedIMEMessage(
 
 void InputMethodWinTSF::OnTextInputTypeChanged(const TextInputClient* client) {
   InputMethodBase::OnTextInputTypeChanged(client);
-  if (!IsTextInputClientFocused(client) || !IsWindowFocused(client))
+  if (!ui::TSFBridge::GetInstance() || !IsTextInputClientFocused(client) ||
+      !IsWindowFocused(client)) {
     return;
+  }
   ui::TSFBridge::GetInstance()->CancelComposition();
   ui::TSFBridge::GetInstance()->OnTextInputTypeChanged(client);
+  InputMethodWinBase::UpdateEngineFocusAndInputContext();
 }
 
 void InputMethodWinTSF::OnCaretBoundsChanged(const TextInputClient* client) {
-  if (!IsTextInputClientFocused(client) || !IsWindowFocused(client))
+  if (!ui::TSFBridge::GetInstance() || !IsTextInputClientFocused(client) ||
+      !IsWindowFocused(client)) {
     return;
+  }
+  NotifyTextInputCaretBoundsChanged(client);
   ui::TSFBridge::GetInstance()->OnTextLayoutChanged();
+  InputMethodWinBase::UpdateCompositionBoundsForEngine(client);
 }
 
 void InputMethodWinTSF::CancelComposition(const TextInputClient* client) {
-  if (IsTextInputClientFocused(client) && IsWindowFocused(client))
+  if (ui::TSFBridge::GetInstance() && IsTextInputClientFocused(client) &&
+      IsWindowFocused(client)) {
     ui::TSFBridge::GetInstance()->CancelComposition();
+    InputMethodWinBase::CancelCompositionForEngine();
+  }
 }
 
 void InputMethodWinTSF::DetachTextInputClient(TextInputClient* client) {
+  if (!ui::TSFBridge::GetInstance()) {
+    // TSFBridge can be null for tests.
+    return;
+  }
   InputMethodWinBase::DetachTextInputClient(client);
   ui::TSFBridge::GetInstance()->RemoveFocusedClient(client);
 }
@@ -121,7 +145,8 @@ void InputMethodWinTSF::OnWillChangeFocusedClient(
 void InputMethodWinTSF::OnDidChangeFocusedClient(
     TextInputClient* focused_before,
     TextInputClient* focused) {
-  if (IsWindowFocused(focused) && IsTextInputClientFocused(focused)) {
+  if (ui::TSFBridge::GetInstance() && IsWindowFocused(focused) &&
+      IsTextInputClientFocused(focused)) {
     ui::TSFBridge::GetInstance()->SetFocusedClient(toplevel_window_handle_,
                                                    focused);
 
@@ -138,8 +163,12 @@ void InputMethodWinTSF::OnDidChangeFocusedClient(
 }
 
 void InputMethodWinTSF::ConfirmCompositionText() {
-  if (!IsTextInputTypeNone())
-    ui::TSFBridge::GetInstance()->ConfirmComposition();
+  if (!IsTextInputTypeNone()) {
+    if (GetTextInputClient()->HasCompositionText())
+      InputMethodWinBase::ResetEngine();
+    if (ui::TSFBridge::GetInstance())
+      ui::TSFBridge::GetInstance()->ConfirmComposition();
+  }
 }
 
 }  // namespace ui

ui/base/ime/win/tsf_text_store.cc

@@ -595,7 +595,7 @@ STDMETHODIMP TSFTextStore::RequestLock(DWORD lock_flags, HRESULT* result) {
   // If composition_string is empty and there is an existing composition going
   // on, we still need to call into blink to complete the composition.
   if (previous_composition_string_ != composition_string ||
-      (text_input_client_->HasCompositionText() &&
+      (has_composition_range_ && text_input_client_->HasCompositionText() &&
        composition_string.empty())) {
     previous_composition_string_ = composition_string;