Remove the 2-level input method system & InputMethodBridge.

ui/views/controls/textfield/textfield.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 "ui/views/controls/textfield/textfield.h"
 
 #include <string>
 
 #include "base/trace_event/trace_event.h"
 #include "ui/accessibility/ax_view_state.h"
 #include "ui/base/clipboard/scoped_clipboard_writer.h"
 #include "ui/base/cursor/cursor.h"
 #include "ui/base/dragdrop/drag_drop_types.h"
 #include "ui/base/dragdrop/drag_utils.h"
+#include "ui/base/ime/input_method.h"
 #include "ui/base/touch/selection_bound.h"
 #include "ui/base/ui_base_switches_util.h"
 #include "ui/compositor/canvas_painter.h"
 #include "ui/compositor/scoped_animation_duration_scale_mode.h"
 #include "ui/events/event.h"
 #include "ui/events/keycodes/keyboard_codes.h"
 #include "ui/gfx/canvas.h"
 #include "ui/gfx/display.h"
 #include "ui/gfx/geometry/insets.h"
 #include "ui/gfx/screen.h"
 #include "ui/native_theme/native_theme.h"
 #include "ui/strings/grit/ui_strings.h"
 #include "ui/views/background.h"
 #include "ui/views/controls/focusable_border.h"
 #include "ui/views/controls/label.h"
 #include "ui/views/controls/menu/menu_runner.h"
 #include "ui/views/controls/native/native_view_host.h"
 #include "ui/views/controls/textfield/textfield_controller.h"
 #include "ui/views/drag_utils.h"
-#include "ui/views/ime/input_method.h"
 #include "ui/views/metrics.h"
 #include "ui/views/native_cursor.h"
 #include "ui/views/painter.h"
 #include "ui/views/views_delegate.h"
 #include "ui/views/widget/widget.h"
 
 #if defined(OS_WIN)
 #include "base/win/win_util.h"
 #endif
 
@@ skipping 239 matching lines @@
   SetBorder(scoped_ptr<Border>(new FocusableBorder()));
   SetFocusable(true);
 
   if (ViewsDelegate::GetInstance()) {
     password_reveal_duration_ =
         ViewsDelegate::GetInstance()
             ->GetDefaultTextfieldObscuredRevealDuration();
   }
 }
 
-Textfield::~Textfield() {}
+Textfield::~Textfield() {
+  if (GetInputMethod())

[yukawa, 2015/06/11 21:48:42]

Why do we test GetTextInputClient() in Combobox::~Combobox() but not in
Textfield::~Textfield()?

Combobox::~Combobox() {
  model_->RemoveObserver(this);
  if (GetTextInputClient() && GetInputMethod())
    GetInputMethod()->DetachTextInputClient(GetTextInputClient());
}

Since neither Textfield nor Textfield::GetTextInputClient() is marked as final,
so in theory you can override Textfield::GetTextInputClient() to return null.

BTW, if you create a derived class of Textfield, who is responsible to call
GetInputMethod()->DetachTextInputClient() ?  Can we put those clean-up code in
more common place?

[Shu Chen, 2015/06/12 03:34:38]

You're right. I've updated the code to check GetTextInputClient().
The derived class of Textfield should be responsible to call
GetInputMethod()->DetachTextInputClient().
And, no, we cannot put this code in common place.

I used to put it in View::~View(), but it caused test failures.
The reason was Combobox::GetTextInputClient() returns PrefixSelector instance:
  ui::TextInputClient* Combobox::GetTextInputClient() {
    if (!selector_)
      selector_.reset(new PrefixSelector(this));
    return selector_.get();
  }
So when destructing Combobox, |selector_| is destructed before its parent's
destructor (~View) being called.
In View's destructor, GetTextInputClient() will get NULL.

[yukawa, 2015/06/12 05:20:45]

Hmm, if the derived class of TextField calls
|GetInputMethod()->DetachTextInputClient()|, then Textfield::~Textfield() calls
|GetInputMethod()->DetachTextInputClient()| again, right?
Probably it will work, but it sounds a bit confusing.
One idea is that adding
  protected:
    void View::DetachTextInputClient();
and call it from Combobox::~Combobox().  Then we can make sure that View can
simply ignore multiple calls of DetachTextInputClient().

[Shu Chen, 2015/06/12 05:32:54]

I think the derived class of TextField overrides GetTextInputClient() doesn't
make sense.
Because TextField is "kind-of" TextInputClient, thus MyTextField should also be
"kind-of" TextInputClient.
If MyTextField overrides GetTextInputClient() which returns non-this, it
conceptually breaks the "kind-of" assumption.
There is no problem to call GetInputMethod()->DetachTextInputClient() for
multiple times, because ui::InputMethodBase's logic can handle it very well.
Ditto. ui::InputMethodBase's logic can handle multiple DetachTextInputClient
calls very well.

+    GetInputMethod()->DetachTextInputClient(GetTextInputClient());
+}
 
 void Textfield::SetReadOnly(bool read_only) {
   // Update read-only without changing the focusable state (or active, etc.).
   read_only_ = read_only;
   if (GetInputMethod())
     GetInputMethod()->OnTextInputTypeChanged(this);
   SetColor(GetTextColor());
   UpdateBackgroundColor();
 }
 
@@ skipping 682 matching lines @@
 void Textfield::OnPaint(gfx::Canvas* canvas) {
   OnPaintBackground(canvas);
   PaintTextAndCursor(canvas);
   OnPaintBorder(canvas);
 }
 
 void Textfield::OnFocus() {
   GetRenderText()->set_focused(true);
   cursor_visible_ = true;
   SchedulePaint();
-  GetInputMethod()->OnFocus();
+  if (GetInputMethod())

[yukawa, 2015/06/11 21:48:42]

ditto.

[Shu Chen, 2015/06/12 03:34:38]

Done.

+    GetInputMethod()->SetFocusedTextInputClient(this);
   OnCaretBoundsChanged();
 
   const size_t caret_blink_ms = Textfield::GetCaretBlinkMs();
   if (caret_blink_ms != 0) {
     cursor_repaint_timer_.Start(FROM_HERE,
         base::TimeDelta::FromMilliseconds(caret_blink_ms), this,
         &Textfield::UpdateCursor);
   }
 
   View::OnFocus();
   SchedulePaint();
 }
 
 void Textfield::OnBlur() {
   GetRenderText()->set_focused(false);
-  GetInputMethod()->OnBlur();
+  if (GetInputMethod())

[yukawa, 2015/06/11 21:48:42]

ditto.

[Shu Chen, 2015/06/12 03:34:38]

Done.

+    GetInputMethod()->DetachTextInputClient(this);
   cursor_repaint_timer_.Stop();
   if (cursor_visible_) {
     cursor_visible_ = false;
     RepaintCursor();
   }
 
   DestroyTouchSelection();
 
   // Border typically draws focus indicator.
   SchedulePaint();
@@ skipping 428 matching lines @@
   DoInsertChar(ch);
 
   if (text_input_type_ == ui::TEXT_INPUT_TYPE_PASSWORD &&
       password_reveal_duration_ != base::TimeDelta()) {
     const size_t change_offset = model_->GetCursorPosition();
     DCHECK_GT(change_offset, 0u);
     RevealPasswordChar(change_offset - 1);
   }
 }
 
-gfx::NativeWindow Textfield::GetAttachedWindow() const {
-  // Imagine the following hierarchy.
-  //   [NativeWidget A] - FocusManager
-  //     [View]
-  //     [NativeWidget B]
-  //       [View]
-  //         [View X]
-  // An important thing is that [NativeWidget A] owns Win32 input focus even
-  // when [View X] is logically focused by FocusManager. As a result, an Win32
-  // IME may want to interact with the native view of [NativeWidget A] rather
-  // than that of [NativeWidget B]. This is why we need to call
-  // GetTopLevelWidget() here.
-  return GetWidget()->GetTopLevelWidget()->GetNativeWindow();
-}
-
 ui::TextInputType Textfield::GetTextInputType() const {
   if (read_only() || !enabled())
     return ui::TEXT_INPUT_TYPE_NONE;
   return text_input_type_;
 }
 
 ui::TextInputMode Textfield::GetTextInputMode() const {
   return ui::TEXT_INPUT_MODE_DEFAULT;
 }
 
@@ skipping 406 matching lines @@
     RequestFocus();
   model_->MoveCursorTo(mouse);
   if (!selection_clipboard_text.empty()) {
     model_->InsertText(selection_clipboard_text);
     UpdateAfterChange(true, true);
   }
   OnAfterUserAction();
 }
 
 }  // namespace views