Refactoring: Extract gesture event filtering into helper class.

content/browser/renderer_host/render_widget_host_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 "base/basictypes.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/shared_memory.h"
 #include "base/timer.h"
 #include "content/browser/browser_thread_impl.h"
 #include "content/browser/renderer_host/backing_store.h"
 #include "content/browser/renderer_host/render_widget_host_delegate.h"
+#include "content/browser/renderer_host/gesture_event_filter.h"
 #include "content/browser/renderer_host/test_render_view_host.h"
 #include "content/common/view_messages.h"
 #include "content/port/browser/render_widget_host_view_port.h"
 #include "content/public/browser/notification_details.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/notification_source.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/test/mock_render_process_host.h"
 #include "content/public/test/test_browser_context.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 #include "ui/gfx/canvas.h"
 
 #if defined(USE_AURA)
 #include "content/browser/renderer_host/render_widget_host_view_aura.h"
 #include "ui/aura/env.h"
 #endif
 
 using base::TimeDelta;
 using content::BackingStore;
 using content::BrowserThread;
 using content::BrowserThreadImpl;
+using content::GestureEventFilter;
 using content::MockRenderProcessHost;
 using content::NativeWebKeyboardEvent;
 using content::RenderWidgetHost;
 using content::RenderWidgetHostImpl;
 using WebKit::WebGestureEvent;
 using WebKit::WebInputEvent;
 using WebKit::WebMouseWheelEvent;
 
 namespace gfx {
 class Size;
@@ skipping 171 matching lines @@
         unresponsive_timer_fired_(false) {
   }
 
   // Allow poking at a few private members.
   using RenderWidgetHostImpl::OnMsgPaintAtSizeAck;
   using RenderWidgetHostImpl::OnMsgUpdateRect;
   using RenderWidgetHostImpl::RendererExited;
   using RenderWidgetHostImpl::in_flight_size_;
   using RenderWidgetHostImpl::is_hidden_;
   using RenderWidgetHostImpl::resize_ack_pending_;
-  using RenderWidgetHostImpl::coalesced_gesture_events_;
-  using RenderWidgetHostImpl::fling_in_progress_;
+  using RenderWidgetHostImpl::gesture_event_filter_;
 
   bool unresponsive_timer_fired() const {
     return unresponsive_timer_fired_;
   }
 
   void set_hung_renderer_delay_ms(int delay_ms) {
     hung_renderer_delay_ms_ = delay_ms;
   }
 
+  WebGestureEvent GestureEventLastQueueEvent() {
+    return gesture_event_filter_->coalesced_gesture_events_.back();
+  }
+
+  unsigned GestureEventLastQueueEventSize() {
+    return gesture_event_filter_->coalesced_gesture_events_.size();
+  }
+
+  bool FlingInProgress() {
+    return gesture_event_filter_->fling_in_progress_;
+  }
+
  protected:
   virtual void NotifyRendererUnresponsive() OVERRIDE {
     unresponsive_timer_fired_ = true;
   }
 
  private:
   bool unresponsive_timer_fired_;
 };
 
 // MockPaintingObserver --------------------------------------------------------
@@ skipping 541 matching lines @@
   // Only GestureScrollUpdate events can be coalesced.
   // Simulate gesture events.
 
   // Sent.
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureScrollBegin);
 
   // Enqueued.
   SimulateGestureEvent(8, -5, 0, WebInputEvent::GestureScrollUpdate);
 
   // Make sure that the queue contains what we think it should.
-  WebGestureEvent merged_event = host_->coalesced_gesture_events_.back();
+  WebGestureEvent merged_event = host_->GestureEventLastQueueEvent();
   EXPECT_EQ(WebInputEvent::GestureScrollUpdate, merged_event.type);
 
   // Coalesced.
   SimulateGestureEvent(8, -6, 0, WebInputEvent::GestureScrollUpdate);
 
   // Check that coalescing updated the correct values.
-  merged_event = host_->coalesced_gesture_events_.back();
+  merged_event = host_->GestureEventLastQueueEvent();
   EXPECT_EQ(WebInputEvent::GestureScrollUpdate, merged_event.type);
   EXPECT_EQ(0, merged_event.modifiers);
   EXPECT_EQ(16, merged_event.deltaX);
   EXPECT_EQ(-11, merged_event.deltaY);
 
   // Enqueued.
   SimulateGestureEvent(8, -7, 1, WebInputEvent::GestureScrollUpdate);
 
   // Check that we didn't wrongly coalesce.
-  merged_event = host_->coalesced_gesture_events_.back();
+  merged_event = host_->GestureEventLastQueueEvent();
   EXPECT_EQ(WebInputEvent::GestureScrollUpdate, merged_event.type);
   EXPECT_EQ(1, merged_event.modifiers);
 
   // Different.
   SimulateGestureEvent(9, -8, 0, WebInputEvent::GestureScrollEnd);
 
   // Check that only the first event was sent.
   EXPECT_EQ(1U, process_->sink().message_count());
   EXPECT_TRUE(process_->sink().GetUniqueMessageMatching(
               ViewMsg_HandleInputEvent::ID));
@@ skipping 27 matching lines @@
   SendInputEventACK(WebInputEvent::GestureScrollEnd, true);
   MessageLoop::current()->RunAllPending();
   EXPECT_EQ(0U, process_->sink().message_count());
 }
 
 TEST_F(RenderWidgetHostTest, GestureFlingCancelsFiltered) {
   process_->sink().ClearMessages();
   // GFC without previous GFS is dropped.
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingCancel);
   EXPECT_EQ(0U, process_->sink().message_count());
-  EXPECT_EQ(0U, host_->coalesced_gesture_events_.size());
+  EXPECT_EQ(0U, host_->GestureEventLastQueueEventSize());
 
   // GFC after previous GFS is dispatched and acked.
   process_->sink().ClearMessages();
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingStart);
-  EXPECT_TRUE(host_->fling_in_progress_);
+  EXPECT_TRUE(host_->FlingInProgress());
   SendInputEventACK(WebInputEvent::GestureFlingStart, true);
   MessageLoop::current()->RunAllPending();
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingCancel);
-  EXPECT_FALSE(host_->fling_in_progress_);
+  EXPECT_FALSE(host_->FlingInProgress());
   EXPECT_EQ(2U, process_->sink().message_count());
   SendInputEventACK(WebInputEvent::GestureFlingCancel, true);
   MessageLoop::current()->RunAllPending();
-  EXPECT_EQ(0U, host_->coalesced_gesture_events_.size());
+  EXPECT_EQ(0U, host_->GestureEventLastQueueEventSize());
 
   // GFC before previous GFS is acked.
   process_->sink().ClearMessages();
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingStart);
-  EXPECT_TRUE(host_->fling_in_progress_);
+  EXPECT_TRUE(host_->FlingInProgress());
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingCancel);
-  EXPECT_FALSE(host_->fling_in_progress_);
+  EXPECT_FALSE(host_->FlingInProgress());
   EXPECT_EQ(1U, process_->sink().message_count());
-  EXPECT_FALSE(host_->coalesced_gesture_events_.empty());
+  EXPECT_EQ(1U, host_->GestureEventLastQueueEventSize());
 
   // Advance state realistically.
   SendInputEventACK(WebInputEvent::GestureFlingStart, true);
   MessageLoop::current()->RunAllPending();
   SendInputEventACK(WebInputEvent::GestureFlingCancel, true);
   MessageLoop::current()->RunAllPending();
-  EXPECT_EQ(0U, host_->coalesced_gesture_events_.size());
+  EXPECT_EQ(0U, host_->GestureEventLastQueueEventSize());
 
   // GFS is added to the queue if another event is pending
   process_->sink().ClearMessages();
   SimulateGestureEvent(8, -7, 0, WebInputEvent::GestureScrollUpdate);
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingStart);
   EXPECT_EQ(1U, process_->sink().message_count());
-  WebGestureEvent merged_event = host_->coalesced_gesture_events_.back();
+  WebGestureEvent merged_event = host_->GestureEventLastQueueEvent();
   EXPECT_EQ(WebInputEvent::GestureFlingStart, merged_event.type);
-  EXPECT_FALSE(host_->fling_in_progress_);
-  EXPECT_EQ(1U, host_->coalesced_gesture_events_.size());
+  EXPECT_FALSE(host_->FlingInProgress());
+  EXPECT_EQ(1U, host_->GestureEventLastQueueEventSize());
 
   // GFS in queue means that a GFC is added to the queue
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingCancel);
-  merged_event = host_->coalesced_gesture_events_.back();
+  merged_event =host_->GestureEventLastQueueEvent();
   EXPECT_EQ(WebInputEvent::GestureFlingCancel, merged_event.type);
-  EXPECT_FALSE(host_->fling_in_progress_);
-  EXPECT_EQ(2U, host_->coalesced_gesture_events_.size());
+  EXPECT_FALSE(host_->FlingInProgress());
+  EXPECT_EQ(2U, host_->GestureEventLastQueueEventSize());
 
 
   // Adding a second GFC is dropped.
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingCancel);
-  EXPECT_FALSE(host_->fling_in_progress_);
-  EXPECT_EQ(2U, host_->coalesced_gesture_events_.size());
+  EXPECT_FALSE(host_->FlingInProgress());
+  EXPECT_EQ(2U, host_->GestureEventLastQueueEventSize());
 
   // Adding another GFS will add it to the queue.
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingStart);
-  merged_event = host_->coalesced_gesture_events_.back();
+  merged_event = host_->GestureEventLastQueueEvent();
   EXPECT_EQ(WebInputEvent::GestureFlingStart, merged_event.type);
-  EXPECT_FALSE(host_->fling_in_progress_);
-  EXPECT_EQ(3U, host_->coalesced_gesture_events_.size());
+  EXPECT_FALSE(host_->FlingInProgress());
+  EXPECT_EQ(3U, host_->GestureEventLastQueueEventSize());
 
   // GFS in queue means that a GFC is added to the queue
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingCancel);
-  merged_event = host_->coalesced_gesture_events_.back();
+  merged_event = host_->GestureEventLastQueueEvent();
   EXPECT_EQ(WebInputEvent::GestureFlingCancel, merged_event.type);
-  EXPECT_FALSE(host_->fling_in_progress_);
-  EXPECT_EQ(4U, host_->coalesced_gesture_events_.size());
+  EXPECT_FALSE(host_->FlingInProgress());
+  EXPECT_EQ(4U, host_->GestureEventLastQueueEventSize());
 
   // Adding another GFC with a GFC already there is dropped.
   SimulateGestureEvent(0, -10, 0, WebInputEvent::GestureFlingCancel);
-  merged_event = host_->coalesced_gesture_events_.back();
+  merged_event = host_->GestureEventLastQueueEvent();
   EXPECT_EQ(WebInputEvent::GestureFlingCancel, merged_event.type);
-  EXPECT_FALSE(host_->fling_in_progress_);
-  EXPECT_EQ(4U, host_->coalesced_gesture_events_.size());
+  EXPECT_FALSE(host_->FlingInProgress());
+  EXPECT_EQ(4U, host_->GestureEventLastQueueEventSize());
 }
 
 // Test that the hang monitor timer expires properly if a new timer is started
 // while one is in progress (see crbug.com/11007).
 TEST_F(RenderWidgetHostTest, DontPostponeHangMonitorTimeout) {
   // Start with a short timeout.
   host_->StartHangMonitorTimeout(TimeDelta::FromMilliseconds(10));
 
   // Immediately try to add a long 30 second timeout.
   EXPECT_FALSE(host_->unresponsive_timer_fired());
@@ skipping 53 matching lines @@
   SimulateKeyboardEvent(WebInputEvent::RawKeyDown);
   SimulateKeyboardEvent(WebInputEvent::RawKeyDown);
   SendInputEventACK(WebInputEvent::RawKeyDown, true);
 
   // Wait long enough for first timeout and see if it fired.
   MessageLoop::current()->PostDelayedTask(
       FROM_HERE, MessageLoop::QuitClosure(), TimeDelta::FromMilliseconds(40));
   MessageLoop::current()->Run();
   EXPECT_TRUE(host_->unresponsive_timer_fired());
 }