Add NativeWidgetDelegate/Widget::OnKeyEvent post-IME handling.

Refactor XEvent code and InputMethodGtk::DispatchKeyEvent.
Nix WidgetWin::GetFocusedViewRootView, rename RootView::OnKeyEvent.
Cleanup headers and refactor code in extension_input_api.cc.

BUG=72040
TEST=Key event handling in win/linux_views/touch; extension input API SendKeyboardEventInputFunction use.

Committed: http://src.chromium.org/viewvc/chrome?view=rev&revision=82713

Review URL: http://codereview.chromium.org/6823055

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@82751 0039d316-1c4b-4281-b951-d872f2087c98

11 files changed, 45 insertions, 87 deletions

diff --git a/views/focus/accelerator_handler_touch.cc b/views/focus/accelerator_handler_touch.cc
index 716cb29..a18bbe1 100644
--- a/views/focus/accelerator_handler_touch.cc
+++ b/views/focus/accelerator_handler_touch.cc
@@ -179,14 +179,7 @@ bool DispatchXEvent(XEvent* xev) {
       case KeyRelease: {
         Event::FromNativeEvent2 from_native;
         KeyEvent keyev(xev, from_native);
-        InputMethod* ime = widget->GetInputMethod();
-        // Always dispatch key events to the input method first, to make sure
-        // that the input method's hotkeys work all time.
-        if (ime) {
-          ime->DispatchKeyEvent(keyev);
-          return true;
-        }
-        return root->ProcessKeyEvent(keyev);
+        return widget->OnKeyEvent(keyev);
       }
 
       case ButtonPress:
diff --git a/views/ime/input_method_gtk.cc b/views/ime/input_method_gtk.cc
index 023bcc6..07da18f 100644
--- a/views/ime/input_method_gtk.cc
+++ b/views/ime/input_method_gtk.cc
@@ -110,13 +110,13 @@ void InputMethodGtk::OnBlur() {
 }
 
 void InputMethodGtk::DispatchKeyEvent(const KeyEvent& key) {
+  DCHECK(key.type() == ui::ET_KEY_PRESSED || key.type() == ui::ET_KEY_RELEASED);
   suppress_next_result_ = false;
 
   // We should bypass |context_| and |context_simple_| only if there is no
-  // text input client is focused at all. Otherwise, we should always send the
-  // key event to either |context_| or |context_simple_| even if the text input
-  // type is ui::TEXT_INPUT_TYPE_NONE, to make sure we can get correct character
-  // result.
+  // text input client focused. Otherwise, always send the key event to either
+  // |context_| or |context_simple_| even if the text input type is
+  // ui::TEXT_INPUT_TYPE_NONE, to make sure we can get correct character result.
   if (!GetTextInputClient()) {
     DispatchKeyEventPostIME(key);
     return;
@@ -126,22 +126,11 @@ void InputMethodGtk::DispatchKeyEvent(const KeyEvent& key) {
   composition_changed_ = false;
   result_text_.clear();
 
-  GdkEvent* event = key.native_event();
-  DCHECK(!event || event->type == GDK_KEY_PRESS ||
-         event->type == GDK_KEY_RELEASE);
-
-  // If it's a fake key event, then we need to synthesis a GdkEventKey.
-  bool need_free_event = false;
-  if (!event) {
-    event = SynthesizeGdkEventKey(key);
-    need_free_event = true;
-  }
-
-  gboolean filtered = false;
-  if (context_focused_)
-    filtered = gtk_im_context_filter_keypress(context_, &event->key);
-  else
-    filtered = gtk_im_context_filter_keypress(context_simple_, &event->key);
+  // If it's a fake key event, then we need to synthesize a GdkEventKey.
+  GdkEvent* event = key.native_event() ? key.native_event() :
+                                         SynthesizeGdkEventKey(key);
+  gboolean filtered = gtk_im_context_filter_keypress(
+      context_focused_ ? context_ : context_simple_, &event->key);
 
   handling_key_event_ = false;
 
@@ -149,24 +138,21 @@ void InputMethodGtk::DispatchKeyEvent(const KeyEvent& key) {
   if (key.type() == ui::ET_KEY_PRESSED && filtered)
     ProcessFilteredKeyPressEvent(key);
 
-  // In case the focus was changed by the key event.
-  if (old_focused_view != focused_view())
-    return;
-
-  if (HasInputMethodResult())
-    ProcessInputMethodResult(key, filtered);
-
-  // In case the focus was changed when sending input method results to the
-  // focused View.
-  if (old_focused_view != focused_view())
-    return;
-
-  if (key.type() == ui::ET_KEY_PRESSED && !filtered)
-    ProcessUnfilteredKeyPressEvent(key);
-  else if (key.type() == ui::ET_KEY_RELEASED)
-    DispatchKeyEventPostIME(key);
+  // Ensure no focus change from processing the key event.
+  if (old_focused_view == focused_view()) {
+    if (HasInputMethodResult())
+      ProcessInputMethodResult(key, filtered);
+    // Ensure no focus change sending input method results to the focused View.
+    if (old_focused_view == focused_view()) {
+      if (key.type() == ui::ET_KEY_PRESSED && !filtered)
+        ProcessUnfilteredKeyPressEvent(key);
+      else if (key.type() == ui::ET_KEY_RELEASED)
+        DispatchKeyEventPostIME(key);
+    }
+  }
 
-  if (need_free_event)
+  // Free the synthesized event if there was no underlying native event.
+  if (event != key.native_event())
     gdk_event_free(event);
 }
 
@@ -360,14 +346,10 @@ GdkEvent* InputMethodGtk::SynthesizeGdkEventKey(const KeyEvent& key) const {
   guint keyval =
       ui::GdkKeyCodeForWindowsKeyCode(key.key_code(), key.IsShiftDown());
   guint state = 0;
-  if (key.IsShiftDown())
-    state |= GDK_SHIFT_MASK;
-  if (key.IsControlDown())
-    state |= GDK_CONTROL_MASK;
-  if (key.IsAltDown())
-    state |= GDK_MOD1_MASK;
-  if (key.IsCapsLockDown())
-    state |= GDK_LOCK_MASK;
+  state |= key.IsShiftDown() ? GDK_SHIFT_MASK : 0;
+  state |= key.IsControlDown() ? GDK_CONTROL_MASK : 0;
+  state |= key.IsAltDown() ? GDK_MOD1_MASK : 0;
+  state |= key.IsCapsLockDown() ? GDK_LOCK_MASK : 0;
 
   DCHECK(widget()->GetNativeView()->window);
   return ui::SynthesizeKeyEvent(widget()->GetNativeView()->window,
diff --git a/views/widget/native_widget_delegate.h b/views/widget/native_widget_delegate.h
index e5e3752..0ac5e09 100644
--- a/views/widget/native_widget_delegate.h
+++ b/views/widget/native_widget_delegate.h
@@ -41,7 +41,8 @@ class NativeWidgetDelegate {
   // tree if necessary when accelerated painting is enabled.
   virtual void OnNativeWidgetPaint(gfx::Canvas* canvas) = 0;
 
-  // MouseEvent handlers.
+  // Mouse and key event handlers.
+  virtual bool OnKeyEvent(const KeyEvent& event) = 0;
   virtual bool OnMouseEvent(const MouseEvent& event) = 0;
   virtual void OnMouseCaptureLost() = 0;
 };
diff --git a/views/widget/root_view.cc b/views/widget/root_view.cc
index 323612e..f69c6a4 100644
--- a/views/widget/root_view.cc
+++ b/views/widget/root_view.cc
@@ -82,7 +82,7 @@ void RootView::NotifyNativeViewHierarchyChanged(bool attached,
 
 // Input -----------------------------------------------------------------------
 
-bool RootView::ProcessKeyEvent(const KeyEvent& event) {
+bool RootView::OnKeyEvent(const KeyEvent& event) {
   bool consumed = false;
 
   View* v = GetFocusManager()->GetFocusedView();
diff --git a/views/widget/root_view.h b/views/widget/root_view.h
index 3465312..11541d2 100644
--- a/views/widget/root_view.h
+++ b/views/widget/root_view.h
@@ -61,8 +61,8 @@ class RootView : public View,
 
   // Process a key event. Send the event to the focused view and up the focus
   // path, and finally to the default keyboard handler, until someone consumes
-  // it.  Returns whether anyone consumed the event.
-  bool ProcessKeyEvent(const KeyEvent& event);
+  // it. Returns whether anyone consumed the event.
+  bool OnKeyEvent(const KeyEvent& event);
 
 #if defined(TOUCH_UI) && defined(UNIT_TEST)
   // For unit testing purposes, we use this method to set a mock
diff --git a/views/widget/widget.cc b/views/widget/widget.cc
index 924c448..aeaebad8 100644
--- a/views/widget/widget.cc
+++ b/views/widget/widget.cc
@@ -320,6 +320,10 @@ void Widget::OnNativeWidgetPaint(gfx::Canvas* canvas) {
   RefreshCompositeTree();
 }
 
+bool Widget::OnKeyEvent(const KeyEvent& event) {
+  return GetRootView()->OnKeyEvent(event);
+}
+
 bool Widget::OnMouseEvent(const MouseEvent& event) {
   switch (event.type()) {
     case ui::ET_MOUSE_PRESSED:
diff --git a/views/widget/widget.h b/views/widget/widget.h
index ec126a0..d2c17a7 100644
--- a/views/widget/widget.h
+++ b/views/widget/widget.h
@@ -291,6 +291,7 @@ class Widget : public internal::NativeWidgetDelegate,
   virtual void OnSizeChanged(const gfx::Size& new_size) OVERRIDE;
   virtual bool HasFocusManager() const OVERRIDE;
   virtual void OnNativeWidgetPaint(gfx::Canvas* canvas) OVERRIDE;
+  virtual bool OnKeyEvent(const KeyEvent& event) OVERRIDE;
   virtual bool OnMouseEvent(const MouseEvent& event) OVERRIDE;
   virtual void OnMouseCaptureLost() OVERRIDE;
 
diff --git a/views/widget/widget_gtk.cc b/views/widget/widget_gtk.cc
index 00c9610..85b361c 100644
--- a/views/widget/widget_gtk.cc
+++ b/views/widget/widget_gtk.cc
@@ -615,9 +615,9 @@ void WidgetGtk::Init(GtkWidget* parent,
   // See views::Views::Focus and views::FocusManager::ClearNativeFocus
   // for more details.
   g_signal_connect(widget_, "key_press_event",
-                   G_CALLBACK(&OnKeyEventThunk), this);
+                   G_CALLBACK(&OnEventKeyThunk), this);
   g_signal_connect(widget_, "key_release_event",
-                   G_CALLBACK(&OnKeyEventThunk), this);
+                   G_CALLBACK(&OnEventKeyThunk), this);
 
   // Drag and drop.
   gtk_drag_dest_set(window_contents_, static_cast<GtkDestDefaults>(0),
@@ -1291,7 +1291,7 @@ gboolean WidgetGtk::OnFocusOut(GtkWidget* widget, GdkEventFocus* event) {
   return false;
 }
 
-gboolean WidgetGtk::OnKeyEvent(GtkWidget* widget, GdkEventKey* event) {
+gboolean WidgetGtk::OnEventKey(GtkWidget* widget, GdkEventKey* event) {
   KeyEvent key(reinterpret_cast<NativeEvent>(event));
   if (input_method_.get())
     input_method_->DispatchKeyEvent(key);
@@ -1385,10 +1385,8 @@ void WidgetGtk::DispatchKeyEventPostIME(const KeyEvent& key) {
   if (key.key_code() != ui::VKEY_MENU || key.type() != ui::ET_KEY_RELEASED)
     should_handle_menu_key_release_ = false;
 
-  bool handled = false;
-
-  // Dispatch the key event to View hierarchy first.
-  handled = GetRootView()->ProcessKeyEvent(key);
+  // Send the key event to View hierarchy first.
+  bool handled = delegate_->OnKeyEvent(key);
 
   if (key.key_code() == ui::VKEY_PROCESSKEY || handled)
     return;
diff --git a/views/widget/widget_gtk.h b/views/widget/widget_gtk.h
index e931f59..a7ede90 100644
--- a/views/widget/widget_gtk.h
+++ b/views/widget/widget_gtk.h
@@ -272,7 +272,7 @@ class WidgetGtk : public Widget,
   CHROMEGTK_CALLBACK_1(WidgetGtk, gboolean, OnButtonRelease, GdkEventButton*);
   CHROMEGTK_CALLBACK_1(WidgetGtk, gboolean, OnFocusIn, GdkEventFocus*);
   CHROMEGTK_CALLBACK_1(WidgetGtk, gboolean, OnFocusOut, GdkEventFocus*);
-  CHROMEGTK_CALLBACK_1(WidgetGtk, gboolean, OnKeyEvent, GdkEventKey*);
+  CHROMEGTK_CALLBACK_1(WidgetGtk, gboolean, OnEventKey, GdkEventKey*);
   CHROMEGTK_CALLBACK_4(WidgetGtk, gboolean, OnQueryTooltip,
                        gint, gint, gboolean, GtkTooltip*);
   CHROMEGTK_CALLBACK_1(WidgetGtk, gboolean, OnScroll, GdkEventScroll*);
diff --git a/views/widget/widget_win.cc b/views/widget/widget_win.cc
index bc6cf23c..16332b5 100644
--- a/views/widget/widget_win.cc
+++ b/views/widget/widget_win.cc
@@ -1028,19 +1028,6 @@ Window* WidgetWin::GetWindowImpl(HWND hwnd) {
   return NULL;
 }
 
-RootView* WidgetWin::GetFocusedViewRootView() {
-  // TODO(beng): get rid of this
-  FocusManager* focus_manager = GetFocusManager();
-  if (!focus_manager) {
-    NOTREACHED();
-    return NULL;
-  }
-  View* focused_view = focus_manager->GetFocusedView();
-  if (!focused_view)
-    return NULL;
-  return focused_view->GetRootView();
-}
-
 // static
 void WidgetWin::PostProcessActivateMessage(WidgetWin* widget,
                                            int activation_state) {
@@ -1126,11 +1113,7 @@ gfx::AcceleratedWidget WidgetWin::GetAcceleratedWidget() {
 }
 
 void WidgetWin::DispatchKeyEventPostIME(const KeyEvent& key) {
-  RootView* root_view = GetFocusedViewRootView();
-  if (!root_view)
-    root_view = GetRootView();
-
-  SetMsgHandled(root_view->ProcessKeyEvent(key));
+  SetMsgHandled(delegate_->OnKeyEvent(key));
 }
 
 ////////////////////////////////////////////////////////////////////////////////
diff --git a/views/widget/widget_win.h b/views/widget/widget_win.h
index 6e795de..5f92a1f 100644
--- a/views/widget/widget_win.h
+++ b/views/widget/widget_win.h
@@ -419,10 +419,6 @@ class WidgetWin : public ui::WindowImpl,
   // first ancestor that is a Window.
   static Window* GetWindowImpl(HWND hwnd);
 
-  // Returns the RootView that contains the focused view, or NULL if there is no
-  // focused view.
-  RootView* GetFocusedViewRootView();
-
   // Called after the WM_ACTIVATE message has been processed by the default
   // windows procedure.
   static void PostProcessActivateMessage(WidgetWin* widget,