MacViews: Add WidgetEventGenerator to abstract platform-specific event generation for tests.

ui/views/widget/widget_unittest.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 <algorithm>
 #include <set>
 
 #include "base/basictypes.h"
 #include "base/bind.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/message_loop/message_loop.h"
 #include "base/run_loop.h"
 #include "base/strings/utf_string_conversions.h"
 #include "testing/gtest/include/gtest/gtest.h"
-#include "ui/aura/test/event_generator.h"
-#include "ui/aura/window.h"
 #include "ui/base/hit_test.h"
 #include "ui/compositor/layer_animation_observer.h"
 #include "ui/compositor/scoped_animation_duration_scale_mode.h"
 #include "ui/compositor/scoped_layer_animation_settings.h"
 #include "ui/events/event_processor.h"
 #include "ui/events/event_utils.h"
+#include "ui/events/test/event_generator.h"
 #include "ui/gfx/native_widget_types.h"
 #include "ui/gfx/point.h"
 #include "ui/views/bubble/bubble_delegate.h"
 #include "ui/views/controls/textfield/textfield.h"
 #include "ui/views/test/test_views_delegate.h"
 #include "ui/views/test/widget_test.h"
 #include "ui/views/views_delegate.h"
 #include "ui/views/widget/native_widget_delegate.h"
 #include "ui/views/widget/root_view.h"
 #include "ui/views/widget/widget_deletion_observer.h"
 #include "ui/views/window/dialog_delegate.h"
 #include "ui/views/window/native_frame_view.h"
 
 #if defined(OS_WIN)
 #include "ui/views/win/hwnd_util.h"
 #endif
 
 namespace views {
 namespace test {
 
-// A view that keeps track of the events it receives, but consumes no events.
+// A view that keeps track of the events it receives, optionally consuming them.
 class EventCountView : public View {
  public:
-  EventCountView() {}
+  // Whether to call SetHandled() on events as they are received. For some event
+  // types, this will allow EventCountView to receives future events in the
+  // event sequence, such as a drag.
+  enum HandleMode {
+    PROPAGATE_EVENTS,
+    CONSUME_EVENTS
+  };
+
+  EventCountView()
+      : last_flags_(0),
+        handle_mode_(PROPAGATE_EVENTS) {}
+
   virtual ~EventCountView() {}
 
   int GetEventCount(ui::EventType type) {
     return event_count_[type];
   }
 
   void ResetCounts() {
     event_count_.clear();
   }
 
+  int last_flags() const {
+    return last_flags_;
+  }
+
+  void set_handle_mode(HandleMode handle_mode) {
+    handle_mode_ = handle_mode;
+  }
+
  protected:
+  // Overridden from View:
+  virtual void OnMouseMoved(const ui::MouseEvent& event) OVERRIDE {
+    // MouseMove events are not re-dispatched from the RootView.
+    ++event_count_[ui::ET_MOUSE_MOVED];
+    last_flags_ = 0;
+  }
+
   // Overridden from ui::EventHandler:
   virtual void OnKeyEvent(ui::KeyEvent* event) OVERRIDE {
-    RecordEvent(*event);
+    RecordEvent(event);
   }
   virtual void OnMouseEvent(ui::MouseEvent* event) OVERRIDE {
-    RecordEvent(*event);
+    RecordEvent(event);
   }
   virtual void OnScrollEvent(ui::ScrollEvent* event) OVERRIDE {
-    RecordEvent(*event);
+    RecordEvent(event);
   }
   virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE {
-    RecordEvent(*event);
+    RecordEvent(event);
   }
 
  private:
-  void RecordEvent(const ui::Event& event) {
-    ++event_count_[event.type()];
+  void RecordEvent(ui::Event* event) {
+    ++event_count_[event->type()];
+    last_flags_ = event->flags();
+    if (handle_mode_ == CONSUME_EVENTS)
+      event->SetHandled();
   }
 
   std::map<ui::EventType, int> event_count_;
+  int last_flags_;
+  HandleMode handle_mode_;
 
   DISALLOW_COPY_AND_ASSIGN(EventCountView);
 };
 
 // A view that keeps track of the events it receives, and consumes all scroll
 // gesture events and ui::ET_SCROLL events.
 class ScrollableEventCountView : public EventCountView {
  public:
   ScrollableEventCountView() {}
   virtual ~ScrollableEventCountView() {}
@@ skipping 1430 matching lines @@
   widget->Show();
   widget->SetSize(gfx::Size(300, 300));
 
   EventCountView* event_count_view = new EventCountView();
   event_count_view->SetBounds(0, 0, 300, 300);
   widget->GetRootView()->AddChildView(event_count_view);
 
   MousePressEventConsumer consumer;
   event_count_view->AddPostTargetHandler(&consumer);
 
-  aura::test::EventGenerator generator(GetContext(), widget->GetNativeWindow());
+  ui::test::EventGenerator generator(GetContext(), widget->GetNativeWindow());
   generator.PressTouch();
   generator.ClickLeftButton();
 
   EXPECT_EQ(1, event_count_view->GetEventCount(ui::ET_MOUSE_PRESSED));
   EXPECT_EQ(1, event_count_view->GetEventCount(ui::ET_MOUSE_RELEASED));
 
   widget->CloseNow();
 }
 
 // Used by SingleWindowClosing to count number of times WindowClosing() has
@@ skipping 99 matching lines @@
   Widget* widget = new Widget;
   Widget::InitParams params =
       CreateParams(views::Widget::InitParams::TYPE_POPUP);
   widget->Init(params);
 
   widget->SetContentsView(new CloseWidgetView(ui::ET_MOUSE_PRESSED));
 
   widget->SetSize(gfx::Size(100, 100));
   widget->Show();
 
-  aura::test::EventGenerator generator(GetContext(), widget->GetNativeWindow());
+  ui::test::EventGenerator generator(GetContext(), widget->GetNativeWindow());
 
   WidgetDeletionObserver deletion_observer(widget);
   generator.ClickLeftButton();
   EXPECT_FALSE(deletion_observer.IsWidgetAlive());
 
   // Yay we did not crash!
 }
 
 TEST_F(WidgetTest, WidgetDeleted_InDispatchGestureEvent) {
   Widget* widget = new Widget;
   Widget::InitParams params =
       CreateParams(views::Widget::InitParams::TYPE_POPUP);
   widget->Init(params);
 
   widget->SetContentsView(new CloseWidgetView(ui::ET_GESTURE_TAP_DOWN));
 
   widget->SetSize(gfx::Size(100, 100));
   widget->Show();
 
-  aura::test::EventGenerator generator(GetContext());
+  ui::test::EventGenerator generator(GetContext(), widget->GetNativeWindow());
 
   WidgetDeletionObserver deletion_observer(widget);
   generator.GestureTapAt(widget->GetWindowBoundsInScreen().CenterPoint());
   EXPECT_FALSE(deletion_observer.IsWidgetAlive());
 
   // Yay we did not crash!
 }
 
 // See description of RunGetNativeThemeFromDestructor() for details.
 class GetNativeThemeFromDestructorView : public WidgetDelegateView {
@@ skipping 491 matching lines @@
   init_params.ownership = Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET;
 
   {
     Widget top_level_widget;
     top_level_widget.Init(init_params);
     top_level_widget.SetFullscreen(true);
     EXPECT_EQ(top_level_widget.IsVisible(),
               IsNativeWindowVisible(top_level_widget.GetNativeWindow()));
     top_level_widget.CloseNow();
   }
-
 #if !defined(OS_CHROMEOS)
   {
     Widget top_level_widget;
     init_params.native_widget =
         new PlatformDesktopNativeWidget(&top_level_widget);
     top_level_widget.Init(init_params);
     top_level_widget.SetFullscreen(true);
     EXPECT_EQ(top_level_widget.IsVisible(),
               IsNativeWindowVisible(top_level_widget.GetNativeWindow()));
     top_level_widget.CloseNow();
   }
 #endif
 }
-
 #if defined(OS_WIN)
 
 // Provides functionality to test widget activation via an activation flag
 // which can be set by an accessor.
 class ModalWindowTestWidgetDelegate : public WidgetDelegate {
  public:
   ModalWindowTestWidgetDelegate()
       : widget_(NULL),
         can_activate_(true) {}
 
@@ skipping 287 matching lines @@
   child_params.ownership = Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET;
   child_params.context = parent_widget.GetNativeWindow();
   child_widget.Init(child_params);
   child_widget.AddObserver(&observer);
   child_widget.Show();
 
   parent_widget.CloseNow();
 }
 #endif  // !defined(OS_CHROMEOS)
 
+// Tests that events propagate through from the dispatcher with the correct
+// event type, and that the different platforms behave the same.
+TEST_F(WidgetTest, MouseEventTypesViaGenerator) {
+  EventCountView* view = new EventCountView;
+  view->set_handle_mode(EventCountView::CONSUME_EVENTS);
+  view->SetBounds(10, 10, 50, 40);
+
+  Widget* widget = CreateTopLevelFramelessPlatformWidget();
+  widget->GetRootView()->AddChildView(view);
+
+  widget->SetBounds(gfx::Rect(0, 0, 100, 80));
+  widget->Show();
+
+  ui::test::EventGenerator generator(GetContext(), widget->GetNativeWindow());
+  generator.set_current_location(gfx::Point(20, 20));
+
+  generator.ClickLeftButton();
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_PRESSED));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_RELEASED));
+  EXPECT_EQ(ui::EF_LEFT_MOUSE_BUTTON, view->last_flags());
+
+  generator.PressRightButton();
+  EXPECT_EQ(2, view->GetEventCount(ui::ET_MOUSE_PRESSED));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_RELEASED));
+  EXPECT_EQ(ui::EF_RIGHT_MOUSE_BUTTON, view->last_flags());
+
+  generator.ReleaseRightButton();
+  EXPECT_EQ(2, view->GetEventCount(ui::ET_MOUSE_PRESSED));
+  EXPECT_EQ(2, view->GetEventCount(ui::ET_MOUSE_RELEASED));
+  EXPECT_EQ(ui::EF_RIGHT_MOUSE_BUTTON, view->last_flags());
+
+  // Test mouse move events.
+  EXPECT_EQ(0, view->GetEventCount(ui::ET_MOUSE_MOVED));
+  EXPECT_EQ(0, view->GetEventCount(ui::ET_MOUSE_ENTERED));
+
+  // Move the mouse within the view (20, 20) -> (30, 30).
+  generator.MoveMouseTo(gfx::Point(30, 30));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_MOVED));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_ENTERED));
+  EXPECT_EQ(ui::EF_NONE, view->last_flags());
+
+  // Move it again - entered count shouldn't change.
+  generator.MoveMouseTo(gfx::Point(31, 31));
+  EXPECT_EQ(2, view->GetEventCount(ui::ET_MOUSE_MOVED));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_ENTERED));
+  EXPECT_EQ(0, view->GetEventCount(ui::ET_MOUSE_EXITED));
+
+  // Move it off the view.
+  generator.MoveMouseTo(gfx::Point(5, 5));
+  EXPECT_EQ(2, view->GetEventCount(ui::ET_MOUSE_MOVED));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_ENTERED));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_EXITED));
+
+  // Move it back on.
+  generator.MoveMouseTo(gfx::Point(20, 20));
+  EXPECT_EQ(3, view->GetEventCount(ui::ET_MOUSE_MOVED));
+  EXPECT_EQ(2, view->GetEventCount(ui::ET_MOUSE_ENTERED));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_EXITED));
+
+  // Drargging. Cover HasCapture() and NativeWidgetPrivate::IsMouseButtonDown().
+  generator.DragMouseTo(gfx::Point(40, 40));
+  EXPECT_EQ(3, view->GetEventCount(ui::ET_MOUSE_PRESSED));
+  EXPECT_EQ(3, view->GetEventCount(ui::ET_MOUSE_RELEASED));
+  EXPECT_EQ(1, view->GetEventCount(ui::ET_MOUSE_DRAGGED));
+  EXPECT_EQ(ui::EF_LEFT_MOUSE_BUTTON, view->last_flags());
+
+  widget->CloseNow();
+}
+
 }  // namespace test
 }  // namespace views