Only dispatch menu events if they have a valid target.

BUG=370162
TEST=In touchview, open wrench menu and press a key (i.e. 'T'), nothing should happen.

Review URL: https://codereview.chromium.org/284903002

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

ui/events/event_utils.cc

@@ -16,6 +16,53 @@ namespace {
 int g_custom_event_types = ET_LAST;
 }  // namespace
 
+scoped_ptr<Event> EventFromNative(const base::NativeEvent& native_event) {
+  scoped_ptr<Event> event;
+  EventType type = EventTypeFromNative(native_event);
+  switch(type) {
+    case ET_KEY_PRESSED:
+    case ET_KEY_RELEASED:
+      event.reset(new KeyEvent(native_event, false));
+      break;
+
+    case ET_TRANSLATED_KEY_PRESS:
+    case ET_TRANSLATED_KEY_RELEASE:
+      // These should not be generated by native events.
+      NOTREACHED();
+      break;
+
+    case ET_MOUSE_PRESSED:
+    case ET_MOUSE_DRAGGED:
+    case ET_MOUSE_RELEASED:
+    case ET_MOUSE_MOVED:
+    case ET_MOUSE_ENTERED:
+    case ET_MOUSE_EXITED:
+      event.reset(new MouseEvent(native_event));
+      break;
+
+    case ET_MOUSEWHEEL:
+      event.reset(new MouseWheelEvent(native_event));
+      break;
+
+    case ET_SCROLL_FLING_START:
+    case ET_SCROLL_FLING_CANCEL:
+    case ET_SCROLL:
+      event.reset(new ScrollEvent(native_event));
+      break;
+
+    case ET_TOUCH_RELEASED:
+    case ET_TOUCH_PRESSED:
+    case ET_TOUCH_MOVED:
+    case ET_TOUCH_CANCELLED:
+      event.reset(new TouchEvent(native_event));
+      break;
+
+    default:
+      break;
+  }
+  return event.Pass();
+}
+
 int RegisterCustomEventType() {
   return ++g_custom_event_types;
 }

ui/events/event_utils.h

@@ -6,6 +6,7 @@
 #define UI_EVENTS_EVENT_UTILS_H_
 
 #include "base/event_types.h"
+#include "base/memory/scoped_ptr.h"
 #include "ui/events/event_constants.h"
 #include "ui/events/keycodes/keyboard_codes.h"
 #include "ui/gfx/display.h"
@@ -32,6 +33,11 @@ class Event;
 // Updates the list of devices for cached properties.
 EVENTS_EXPORT void UpdateDeviceList();
 
+// Returns a ui::Event wrapping a native event. Ownership of the returned value
+// is transferred to the caller.
+EVENTS_EXPORT scoped_ptr<Event> EventFromNative(
+    const base::NativeEvent& native_event);
+
 // Get the EventType from a native event.
 EVENTS_EXPORT EventType EventTypeFromNative(
     const base::NativeEvent& native_event);

ui/views/controls/menu/menu_controller.h

@@ -92,6 +92,10 @@ class VIEWS_EXPORT MenuController : public WidgetObserver {
   // Whether or not drag operation is in progress.
   bool drag_in_progress() const { return drag_in_progress_; }
 
+  // Returns the owner of child windows.
+  // WARNING: this may be NULL.
+  Widget* owner() { return owner_; }
+
   // Get the anchor position wich is used to show this menu.
   MenuAnchorPosition GetAnchorPosition() { return state_.anchor; }
 

ui/views/controls/menu/menu_controller_unittest.cc

@@ -5,8 +5,11 @@
 #include "ui/views/controls/menu/menu_controller.h"
 
 #include "base/run_loop.h"
+#include "ui/aura/scoped_window_targeter.h"
 #include "ui/aura/window.h"
+#include "ui/events/event_targeter.h"
 #include "ui/events/platform/platform_event_source.h"
+#include "ui/views/controls/menu/menu_item_view.h"
 #include "ui/views/test/views_test_base.h"
 #include "ui/wm/public/dispatcher_client.h"
 
@@ -16,12 +19,22 @@
 #include <X11/Xlib.h>
 #undef Bool
 #undef None
+#include "ui/events/test/events_test_utils_x11.h"
 #endif
 
 namespace views {
 
 namespace {
 
+class TestMenuItemView : public MenuItemView {
+ public:
+  TestMenuItemView() : MenuItemView(NULL) {}
+  virtual ~TestMenuItemView() {}
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(TestMenuItemView);
+};
+
 class TestPlatformEventSource : public ui::PlatformEventSource {
  public:
   TestPlatformEventSource() {}
@@ -35,6 +48,20 @@ class TestPlatformEventSource : public ui::PlatformEventSource {
   DISALLOW_COPY_AND_ASSIGN(TestPlatformEventSource);
 };
 
+class TestNullTargeter : public ui::EventTargeter {
+ public:
+  TestNullTargeter() {}
+  virtual ~TestNullTargeter() {}
+
+  virtual ui::EventTarget* FindTargetForEvent(ui::EventTarget* root,
+                                              ui::Event* event) OVERRIDE {
+    return NULL;
+  }
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(TestNullTargeter);
+};
+
 class TestDispatcherClient : public aura::client::DispatcherClient {
  public:
   TestDispatcherClient() : dispatcher_(NULL) {}
@@ -79,16 +106,7 @@ class MenuControllerTest : public ViewsTestBase {
     base::MessageLoop::ScopedNestableTaskAllower allow(loop);
     controller_->exit_type_ = MenuController::EXIT_ALL;
 
-#if defined(USE_X11)
-    XEvent xevent;
-    memset(&xevent, 0, sizeof(xevent));
-    event_source_.Dispatch(&xevent);
-#else
-    MSG msg;
-    memset(&msg, 0, sizeof(MSG));
-    dispatcher_client_.dispatcher()->Dispatch(msg);
-#endif
-
+    DispatchEvent();
     if (count) {
       base::MessageLoop::current()->PostTask(
           FROM_HERE,
@@ -115,24 +133,59 @@ class MenuControllerTest : public ViewsTestBase {
   }
 
   void Step1_RunMenu() {
-    Widget widget;
+    base::MessageLoop::current()->PostTask(
+        FROM_HERE,
+        base::Bind(&MenuControllerTest::Step2_RunNestedLoop,
+                   base::Unretained(this)));
+    scoped_ptr<Widget> owner(CreateOwnerWidget());
+    RunMenu(owner.get());
+  }
+
+  scoped_ptr<Widget> CreateOwnerWidget() {
+    scoped_ptr<Widget> widget(new Widget);
     Widget::InitParams params = CreateParams(Widget::InitParams::TYPE_POPUP);
     params.ownership = Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET;
-    widget.Init(params);
-    widget.Show();
+    widget->Init(params);
+    widget->Show();
 
-    aura::client::SetDispatcherClient(widget.GetNativeWindow()->GetRootWindow(),
-                                      &dispatcher_client_);
+    aura::client::SetDispatcherClient(
+        widget->GetNativeWindow()->GetRootWindow(), &dispatcher_client_);
+    return widget.Pass();
+  }
 
+  void RunMenu(views::Widget* owner) {
+    scoped_ptr<TestMenuItemView> menu_item(new TestMenuItemView);
     controller_ = new MenuController(NULL, true, NULL);
-    controller_->owner_ = &widget;
-    base::MessageLoop::current()->PostTask(
-        FROM_HERE,
-        base::Bind(&MenuControllerTest::Step2_RunNestedLoop,
-                   base::Unretained(this)));
+    controller_->owner_ = owner;
+    controller_->showing_ = true;
+    controller_->SetSelection(menu_item.get(),
+                              MenuController::SELECTION_UPDATE_IMMEDIATELY);
     controller_->RunMessageLoop(false);
   }
 
+#if defined(USE_X11)
+  void DispatchEscapeAndExpect(MenuController::ExitType exit_type) {
+    ui::ScopedXI2Event key_event;
+    key_event.InitKeyEvent(ui::ET_KEY_PRESSED, ui::VKEY_ESCAPE, 0);
+    event_source_.Dispatch(key_event);
+    EXPECT_EQ(exit_type, controller_->exit_type());
+    controller_->exit_type_ = MenuController::EXIT_ALL;
+    DispatchEvent();
+  }
+#endif
+
+  void DispatchEvent() {
+#if defined(USE_X11)
+    XEvent xevent;
+    memset(&xevent, 0, sizeof(xevent));
+    event_source_.Dispatch(&xevent);
+#else
+    MSG msg;
+    memset(&msg, 0, sizeof(MSG));
+    dispatcher_client_.dispatcher()->Dispatch(msg);
+#endif
+  }
+
  private:
   MenuController* controller_;
   scoped_ptr<base::RunLoop> run_loop_;
@@ -150,4 +203,36 @@ TEST_F(MenuControllerTest, Basic) {
       base::Bind(&MenuControllerTest::Step1_RunMenu, base::Unretained(this)));
 }
 
+#if defined(OS_LINUX) && defined(USE_X11)
+// Tests that an event targeter which blocks events will be honored by the menu
+// event dispatcher.
+TEST_F(MenuControllerTest, EventTargeter) {
+  {
+    // Verify that the menu handles the escape key under normal circumstances.
+    scoped_ptr<Widget> owner(CreateOwnerWidget());
+    message_loop()->PostTask(
+        FROM_HERE,
+        base::Bind(&MenuControllerTest::DispatchEscapeAndExpect,
+                   base::Unretained(this),
+                   MenuController::EXIT_OUTERMOST));
+    RunMenu(owner.get());
+  }
+
+  {
+    // With the NULL targeter instantiated and assigned we expect the menu to
+    // not handle the key event.
+    scoped_ptr<Widget> owner(CreateOwnerWidget());
+    aura::ScopedWindowTargeter scoped_targeter(
+        owner->GetNativeWindow()->GetRootWindow(),
+        scoped_ptr<ui::EventTargeter>(new TestNullTargeter));
+    message_loop()->PostTask(
+        FROM_HERE,
+        base::Bind(&MenuControllerTest::DispatchEscapeAndExpect,
+                   base::Unretained(this),
+                   MenuController::EXIT_NONE));
+    RunMenu(owner.get());
+  }
+}
+#endif
+
 }  // namespace views

ui/views/controls/menu/menu_event_dispatcher_linux.cc

@@ -4,10 +4,13 @@
 
 #include "ui/views/controls/menu/menu_event_dispatcher_linux.h"
 
+#include "base/memory/scoped_ptr.h"
+#include "ui/aura/window.h"
 #include "ui/events/event_utils.h"
 #include "ui/events/keycodes/keyboard_code_conversion.h"
 #include "ui/events/keycodes/keyboard_codes.h"
 #include "ui/views/controls/menu/menu_controller.h"
+#include "ui/views/widget/widget.h"
 
 namespace views {
 namespace internal {
@@ -24,10 +27,27 @@ bool MenuEventDispatcher::CanDispatchEvent(const ui::PlatformEvent& event) {
 uint32_t MenuEventDispatcher::DispatchEvent(const ui::PlatformEvent& event) {
   bool should_quit = false;
   bool should_perform_default = true;
+  bool should_process_event = true;
+
+  // Check if the event should be handled.
+  scoped_ptr<ui::Event> ui_event(ui::EventFromNative(event));
+  if (ui_event && menu_controller_->owner()) {
+    aura::Window* menu_window = menu_controller_->owner()->GetNativeWindow();
+    aura::Window* target_window = static_cast<aura::Window*>(
+        static_cast<ui::EventTarget*>(menu_window->GetRootWindow())->
+            GetEventTargeter()->FindTargetForEvent(menu_window,
+                                                   ui_event.get()));
+    // TODO(flackr): The event shouldn't be handled if target_window is not
+    // menu_window, however the event targeter does not properly target the
+    // open menu. For now, we allow targeters to prevent handling by the menu.
+    if (!target_window)
+      should_process_event = false;
+  }
+
   if (menu_controller_->exit_type() == MenuController::EXIT_ALL ||
       menu_controller_->exit_type() == MenuController::EXIT_DESTROYED) {
     should_quit = true;
-  } else {
+  } else if (should_process_event) {
     switch (ui::EventTypeFromNative(event)) {
       case ui::ET_KEY_PRESSED: {
         if (!menu_controller_->OnKeyDown(ui::KeyboardCodeFromNative(event))) {