Collapse the API surface on WebInputEvent via accessor functions.

content/browser/renderer_host/input/gesture_event_queue.cc

 // Copyright 2014 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 "content/browser/renderer_host/input/gesture_event_queue.h"
 
 #include "base/trace_event/trace_event.h"
 #include "content/browser/renderer_host/input/touchpad_tap_suppression_controller.h"
 #include "content/browser/renderer_host/input/touchscreen_tap_suppression_controller.h"
 #include "ui/events/blink/web_input_event_traits.h"
 
 using blink::WebGestureEvent;
 using blink::WebInputEvent;
 
 namespace content {
 namespace {
 
 // Whether |event_in_queue| is GesturePinchUpdate or GestureScrollUpdate and
 // has the same modifiers/source as the new scroll/pinch event. Compatible
 // scroll and pinch event pairs can be logically coalesced.
 bool IsCompatibleScrollorPinch(
     const GestureEventWithLatencyInfo& new_event,
     const GestureEventWithLatencyInfo& event_in_queue) {
-  DCHECK(new_event.event.type == WebInputEvent::GestureScrollUpdate ||
-         new_event.event.type == WebInputEvent::GesturePinchUpdate)
+  DCHECK(new_event.event.type() == WebInputEvent::GestureScrollUpdate ||
+         new_event.event.type() == WebInputEvent::GesturePinchUpdate)
       << "Invalid event type for pinch/scroll coalescing: "
-      << WebInputEvent::GetName(new_event.event.type);
-  DLOG_IF(WARNING, new_event.event.timeStampSeconds <
-                       event_in_queue.event.timeStampSeconds)
+      << WebInputEvent::GetName(new_event.event.type());
+  DLOG_IF(WARNING, new_event.event.timeStampSeconds() <
+                       event_in_queue.event.timeStampSeconds())
       << "Event time not monotonic?\n";
-  return (event_in_queue.event.type == WebInputEvent::GestureScrollUpdate ||
-          event_in_queue.event.type == WebInputEvent::GesturePinchUpdate) &&
-         event_in_queue.event.modifiers == new_event.event.modifiers &&
+  return (event_in_queue.event.type() == WebInputEvent::GestureScrollUpdate ||
+          event_in_queue.event.type() == WebInputEvent::GesturePinchUpdate) &&
+         event_in_queue.event.modifiers() == new_event.event.modifiers() &&
          event_in_queue.event.sourceDevice == new_event.event.sourceDevice;
 }
 
 // Returns the transform matrix corresponding to the gesture event.
 gfx::Transform GetTransformForEvent(
     const GestureEventWithLatencyInfo& gesture_event) {
   gfx::Transform gesture_transform;
-  if (gesture_event.event.type == WebInputEvent::GestureScrollUpdate) {
+  if (gesture_event.event.type() == WebInputEvent::GestureScrollUpdate) {
     gesture_transform.Translate(gesture_event.event.data.scrollUpdate.deltaX,
                                 gesture_event.event.data.scrollUpdate.deltaY);
-  } else if (gesture_event.event.type == WebInputEvent::GesturePinchUpdate) {
+  } else if (gesture_event.event.type() == WebInputEvent::GesturePinchUpdate) {
     float scale = gesture_event.event.data.pinchUpdate.scale;
     gesture_transform.Translate(-gesture_event.event.x, -gesture_event.event.y);
     gesture_transform.Scale(scale, scale);
     gesture_transform.Translate(gesture_event.event.x, gesture_event.event.y);
   } else {
     NOTREACHED() << "Invalid event type for transform retrieval: "
-                 << WebInputEvent::GetName(gesture_event.event.type);
+                 << WebInputEvent::GetName(gesture_event.event.type());
   }
   return gesture_transform;
 }
 
 }  // namespace
 
 GestureEventQueue::Config::Config() {
 }
 
 GestureEventQueue::GestureEventQueue(
@@ skipping 29 matching lines @@
   QueueAndForwardIfNecessary(gesture_event);
 }
 
 bool GestureEventQueue::ShouldDiscardFlingCancelEvent(
     const GestureEventWithLatencyInfo& gesture_event) const {
   if (coalesced_gesture_events_.empty() && fling_in_progress_)
     return false;
   GestureQueue::const_reverse_iterator it =
       coalesced_gesture_events_.rbegin();
   while (it != coalesced_gesture_events_.rend()) {
-    if (it->event.type == WebInputEvent::GestureFlingStart)
+    if (it->event.type() == WebInputEvent::GestureFlingStart)
       return false;
-    if (it->event.type == WebInputEvent::GestureFlingCancel)
+    if (it->event.type() == WebInputEvent::GestureFlingCancel)
       return true;
     it++;
   }
   return true;
 }
 
 bool GestureEventQueue::ShouldForwardForBounceReduction(
     const GestureEventWithLatencyInfo& gesture_event) {
   if (debounce_interval_ <= base::TimeDelta())
     return true;
-  switch (gesture_event.event.type) {
+  switch (gesture_event.event.type()) {
     case WebInputEvent::GestureScrollUpdate:
       if (!scrolling_in_progress_) {
         debounce_deferring_timer_.Start(
             FROM_HERE,
             debounce_interval_,
             this,
             &GestureEventQueue::SendScrollEndingEventsNow);
       } else {
         // Extend the bounce interval.
         debounce_deferring_timer_.Reset();
@@ skipping 11 matching lines @@
       if (scrolling_in_progress_) {
         debouncing_deferral_queue_.push_back(gesture_event);
         return false;
       }
       return true;
   }
 }
 
 bool GestureEventQueue::ShouldForwardForGFCFiltering(
     const GestureEventWithLatencyInfo& gesture_event) const {
-  return gesture_event.event.type != WebInputEvent::GestureFlingCancel ||
-      !ShouldDiscardFlingCancelEvent(gesture_event);
+  return gesture_event.event.type() != WebInputEvent::GestureFlingCancel ||
+         !ShouldDiscardFlingCancelEvent(gesture_event);
 }
 
 bool GestureEventQueue::ShouldForwardForTapSuppression(
     const GestureEventWithLatencyInfo& gesture_event) {
-  switch (gesture_event.event.type) {
+  switch (gesture_event.event.type()) {
     case WebInputEvent::GestureFlingCancel:
       if (gesture_event.event.sourceDevice ==
           blink::WebGestureDeviceTouchscreen)
         touchscreen_tap_suppression_controller_.GestureFlingCancel();
       else
         touchpad_tap_suppression_controller_.GestureFlingCancel();
       return true;
     case WebInputEvent::GestureTapDown:
     case WebInputEvent::GestureShowPress:
     case WebInputEvent::GestureTapUnconfirmed:
     case WebInputEvent::GestureTapCancel:
     case WebInputEvent::GestureTap:
     case WebInputEvent::GestureDoubleTap:
     case WebInputEvent::GestureLongPress:
     case WebInputEvent::GestureLongTap:
     case WebInputEvent::GestureTwoFingerTap:
       if (gesture_event.event.sourceDevice ==
           blink::WebGestureDeviceTouchscreen) {
         return !touchscreen_tap_suppression_controller_.FilterTapEvent(
             gesture_event);
       }
       return true;
     default:
       return true;
   }
 }
 
 void GestureEventQueue::QueueAndForwardIfNecessary(
     const GestureEventWithLatencyInfo& gesture_event) {
-  switch (gesture_event.event.type) {
+  switch (gesture_event.event.type()) {
     case WebInputEvent::GestureFlingCancel:
       fling_in_progress_ = false;
       break;
     case WebInputEvent::GestureFlingStart:
       fling_in_progress_ = true;
       break;
     case WebInputEvent::GesturePinchUpdate:
     case WebInputEvent::GestureScrollUpdate:
       QueueScrollOrPinchAndForwardIfNecessary(gesture_event);
       return;
@@ skipping 12 matching lines @@
 bool GestureEventQueue::OnScrollBegin(
     const GestureEventWithLatencyInfo& gesture_event) {
   // If a synthetic scroll begin is encountered, it can cancel out a previous
   // synthetic scroll end. This allows a later gesture scroll update to coalesce
   // with the previous one. crbug.com/607340.
   bool synthetic = gesture_event.event.data.scrollBegin.synthetic;
   bool have_unsent_events =
       EventsInFlightCount() < coalesced_gesture_events_.size();
   if (synthetic && have_unsent_events) {
     GestureEventWithLatencyInfo* last_event = &coalesced_gesture_events_.back();
-    if (last_event->event.type == WebInputEvent::GestureScrollEnd &&
+    if (last_event->event.type() == WebInputEvent::GestureScrollEnd &&
         last_event->event.data.scrollEnd.synthetic) {
       coalesced_gesture_events_.pop_back();
       return true;
     }
   }
   return false;
 }
 
 void GestureEventQueue::ProcessGestureAck(InputEventAckState ack_result,
                                           WebInputEvent::Type type,
                                           const ui::LatencyInfo& latency) {
   TRACE_EVENT0("input", "GestureEventQueue::ProcessGestureAck");
 
   if (coalesced_gesture_events_.empty()) {
     DLOG(ERROR) << "Received unexpected ACK for event type " << type;
     return;
   }
 
   // It's possible that the ack for the second event in an in-flight, coalesced
   // Gesture{Scroll,Pinch}Update pair is received prior to the first event ack.
   size_t event_index = 0;
-  if (ignore_next_ack_ &&
-      coalesced_gesture_events_.size() > 1 &&
-      coalesced_gesture_events_[0].event.type != type &&
-      coalesced_gesture_events_[1].event.type == type) {
+  if (ignore_next_ack_ && coalesced_gesture_events_.size() > 1 &&
+      coalesced_gesture_events_[0].event.type() != type &&
+      coalesced_gesture_events_[1].event.type() == type) {
     event_index = 1;
   }
   GestureEventWithLatencyInfo event_with_latency =
       coalesced_gesture_events_[event_index];
-  DCHECK_EQ(event_with_latency.event.type, type);
+  DCHECK_EQ(event_with_latency.event.type(), type);
   event_with_latency.latency.AddNewLatencyFrom(latency);
 
   // Ack'ing an event may enqueue additional gesture events.  By ack'ing the
   // event before the forwarding of queued events below, such additional events
   // can be coalesced with existing queued events prior to dispatch.
   client_->OnGestureEventAck(event_with_latency, ack_result);
 
   const bool processed = (INPUT_EVENT_ACK_STATE_CONSUMED == ack_result);
   if (type == WebInputEvent::GestureFlingCancel) {
     if (event_with_latency.event.sourceDevice ==
@@ skipping 13 matching lines @@
 
   if (coalesced_gesture_events_.empty())
     return;
 
   const GestureEventWithLatencyInfo& first_gesture_event =
       coalesced_gesture_events_.front();
 
   // Check for the coupled GesturePinchUpdate before sending either event,
   // handling the case where the first GestureScrollUpdate ack is synchronous.
   GestureEventWithLatencyInfo second_gesture_event;
-  if (first_gesture_event.event.type == WebInputEvent::GestureScrollUpdate &&
+  if (first_gesture_event.event.type() == WebInputEvent::GestureScrollUpdate &&
       coalesced_gesture_events_.size() > 1 &&
-      coalesced_gesture_events_[1].event.type ==
+      coalesced_gesture_events_[1].event.type() ==
           WebInputEvent::GesturePinchUpdate) {
     second_gesture_event = coalesced_gesture_events_[1];
     ignore_next_ack_ = true;
   }
 
   client_->SendGestureEventImmediately(first_gesture_event);
-  if (second_gesture_event.event.type != WebInputEvent::Undefined)
+  if (second_gesture_event.event.type() != WebInputEvent::Undefined)
     client_->SendGestureEventImmediately(second_gesture_event);
 }
 
 TouchpadTapSuppressionController*
     GestureEventQueue::GetTouchpadTapSuppressionController() {
   return &touchpad_tap_suppression_controller_;
 }
 
 void GestureEventQueue::FlingHasBeenHalted() {
   fling_in_progress_ = false;
@@ skipping 28 matching lines @@
     coalesced_gesture_events_.push_back(gesture_event);
     if (coalesced_gesture_events_.size() == 1) {
       client_->SendGestureEventImmediately(gesture_event);
     } else if (coalesced_gesture_events_.size() == 2) {
       DCHECK(!ignore_next_ack_);
       // If there is an in-flight scroll, the new pinch can be forwarded
       // immediately, avoiding a potential frame delay between the two
       // (similarly for an in-flight pinch with a new scroll).
       const GestureEventWithLatencyInfo& first_event =
           coalesced_gesture_events_.front();
-      if (gesture_event.event.type != first_event.event.type &&
+      if (gesture_event.event.type() != first_event.event.type() &&
           IsCompatibleScrollorPinch(gesture_event, first_event)) {
         ignore_next_ack_ = true;
         client_->SendGestureEventImmediately(gesture_event);
       }
     }
     return;
   }
 
   GestureEventWithLatencyInfo* last_event = &coalesced_gesture_events_.back();
   if (last_event->CanCoalesceWith(gesture_event)) {
     last_event->CoalesceWith(gesture_event);
     return;
   }
 
   if (!IsCompatibleScrollorPinch(gesture_event, *last_event)) {
     coalesced_gesture_events_.push_back(gesture_event);
     return;
   }
 
   // Keep the oldest LatencyInfo.
   DCHECK_LE(last_event->latency.trace_id(), gesture_event.latency.trace_id());
   GestureEventWithLatencyInfo scroll_event(
-      WebInputEvent::GestureScrollUpdate, gesture_event.event.modifiers,
-      gesture_event.event.timeStampSeconds, last_event->latency);
+      WebInputEvent::GestureScrollUpdate, gesture_event.event.modifiers(),
+      gesture_event.event.timeStampSeconds(), last_event->latency);
   GestureEventWithLatencyInfo pinch_event(
-      WebInputEvent::GesturePinchUpdate, gesture_event.event.modifiers,
-      gesture_event.event.timeStampSeconds, last_event->latency);
+      WebInputEvent::GesturePinchUpdate, gesture_event.event.modifiers(),
+      gesture_event.event.timeStampSeconds(), last_event->latency);
   pinch_event.event.sourceDevice = scroll_event.event.sourceDevice =
       gesture_event.event.sourceDevice;
   pinch_event.event.x =
-      gesture_event.event.type == WebInputEvent::GesturePinchUpdate
+      gesture_event.event.type() == WebInputEvent::GesturePinchUpdate
           ? gesture_event.event.x
           : last_event->event.x;
   pinch_event.event.y =
-      gesture_event.event.type == WebInputEvent::GesturePinchUpdate
+      gesture_event.event.type() == WebInputEvent::GesturePinchUpdate
           ? gesture_event.event.y
           : last_event->event.y;
 
   gfx::Transform combined_scroll_pinch = GetTransformForEvent(*last_event);
   // Only include the second-to-last event in the coalesced pair if it exists
   // and can be combined with the new event.
   if (unsent_events_count > 1) {
     const GestureEventWithLatencyInfo& second_last_event =
         coalesced_gesture_events_[coalesced_gesture_events_.size() - 2];
     if (IsCompatibleScrollorPinch(gesture_event, second_last_event)) {
@@ skipping 32 matching lines @@
     return 0;
 
   if (!ignore_next_ack_)
     return 1;
 
   DCHECK_GT(coalesced_gesture_events_.size(), 1U);
   return 2;
 }
 
 }  // namespace content