Notify Blink about start of gesture scroll through a queued event.

content/browser/renderer_host/input/touch_event_queue.cc

 // Copyright 2013 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/touch_event_queue.h"
 
 #include <utility>
 
 #include "base/auto_reset.h"
 #include "base/macros.h"
@@ skipping 10 matching lines @@
 using ui::LatencyInfo;
 
 namespace content {
 namespace {
 
 // Time interval at which touchmove events will be forwarded to the client while
 // scrolling is active and possible.
 const double kAsyncTouchMoveIntervalSec = .2;
 
 // A sanity check on touches received to ensure that touch movement outside
-// the platform slop region will cause scrolling, as indicated by the event's
-// |causesScrollingIfUncanceled| bit.
+// the platform slop region will cause scrolling.
 const double kMaxConceivablePlatformSlopRegionLengthDipsSquared = 60. * 60.;
 
 TouchEventWithLatencyInfo ObtainCancelEventForTouchEvent(
     const TouchEventWithLatencyInfo& event_to_cancel) {
   TouchEventWithLatencyInfo event = event_to_cancel;
   WebTouchEventTraits::ResetTypeAndTouchStates(
       WebInputEvent::TouchCancel,
       // TODO(rbyers): Shouldn't we use a fresh timestamp?
       event.event.timeStampSeconds,
       &event.event);
@@ skipping 441 matching lines @@
   // If the last queued touch-event was a touch-move, and the current event is
   // also a touch-move, then the events can be coalesced into a single event.
   if (touch_queue_.size() > 1) {
     CoalescedWebTouchEvent* last_event = touch_queue_.back();
     if (last_event->CoalesceEventIfPossible(event))
       return;
   }
   touch_queue_.push_back(new CoalescedWebTouchEvent(event, false));
 }
 
+void TouchEventQueue::PrependTouchScrollNotification() {
+  TRACE_EVENT0("input", "TouchEventQueue::PrependTouchScrollNotification");
+
+  TouchEventWithLatencyInfo touch;
+  touch.event.type = WebInputEvent::TouchScrollStarted;
+  touch.event.uniqueTouchEventId = 0;
+  touch.event.touchesLength = 0;
+
+  // Leave the head of the queue untouched since it is an in-flight event. The
+  // queue should have an in-flight event at this moment because this method is
+  // triggered by InputRouterImpl::SendGestureEvent, which is triggered by
+  // TouchEventQueue::AckTouchEventToClient, which has just received an ack for
+  // the in-flight event.

[tdresser, 2016/04/11 18:19:38]

Should we DCHECK this here?

[mustaq, 2016/04/11 18:40:41]

Didn't add a DCHECK here because I am not 100% sure that my comment covers all
the cases. To be precise, can the InputRouterImpl::SendGestureEvent() call be
triggered by some "event" from a WebGestureDeviceTouchscreen other than a touch
ack? RenderWidgetHostImpl::ForwardGestureEventWithLatencyInfo has too many
callers to be certain about it.

+  auto it = touch_queue_.begin();
+  if (it != touch_queue_.end())
+    ++it;
+  touch_queue_.insert(it, new CoalescedWebTouchEvent(touch, false));
+}
+
 void TouchEventQueue::ProcessTouchAck(InputEventAckState ack_result,
                                       const LatencyInfo& latency_info,
                                       const uint32_t unique_touch_event_id) {
   TRACE_EVENT0("input", "TouchEventQueue::ProcessTouchAck");
 
   // We receive an ack for async touchmove from render.
   if (!ack_pending_async_touchmove_ids_.empty() &&
       ack_pending_async_touchmove_ids_.front() == unique_touch_event_id) {
     // Remove the first touchmove from the ack_pending_async_touchmove queue.
     ack_pending_async_touchmove_ids_.pop_front();
@@ skipping 14 matching lines @@
   dispatching_touch_ = false;
 
   if (timeout_handler_ && timeout_handler_->ConfirmTouchEvent(ack_result))
     return;
 
   touchmove_slop_suppressor_->ConfirmTouchEvent(ack_result);
 
   if (touch_queue_.empty())
     return;
 
-  DCHECK_EQ(touch_queue_.front()->coalesced_event().event.uniqueTouchEventId,
-            unique_touch_event_id);
+  // We don't care about the ordering of the acks vs the ordering of the
+  // dispatched events because we can receive the ack for event B before the ack
+  // for event A even though A was sent before B. This seems to be happening
+  // when, for example, A is acked from renderer but B isn't, so the ack for B
+  // is synthesized "locally" in InputRouter.
+  //
+  // TODO(crbug.com/600773): Bring the id checks back when dispatch triggering
+  // is sane.
 
   PopTouchEventToClient(ack_result, latency_info);
   TryForwardNextEventToRenderer();
 }
 
 void TouchEventQueue::TryForwardNextEventToRenderer() {
   DCHECK(!dispatching_touch_ack_);
   // If there are queued touch events, then try to forward them to the renderer
   // immediately, or ACK the events back to the client if appropriate.
   while (!touch_queue_.empty()) {
@@ skipping 172 matching lines @@
 void TouchEventQueue::FlushQueue() {
   DCHECK(!dispatching_touch_ack_);
   DCHECK(!dispatching_touch_);
   pending_async_touchmove_.reset();
   drop_remaining_touches_in_sequence_ = true;
   while (!touch_queue_.empty())
     PopTouchEventToClient(INPUT_EVENT_ACK_STATE_NO_CONSUMER_EXISTS);
 }
 
 void TouchEventQueue::PopTouchEventToClient(InputEventAckState ack_result) {
-  AckTouchEventToClient(ack_result, PopTouchEvent(), nullptr);
+  AckTouchEventToClient(ack_result, nullptr);
 }
 
 void TouchEventQueue::PopTouchEventToClient(
     InputEventAckState ack_result,
     const LatencyInfo& renderer_latency_info) {
-  AckTouchEventToClient(ack_result, PopTouchEvent(), &renderer_latency_info);
+  AckTouchEventToClient(ack_result, &renderer_latency_info);
 }
 
 void TouchEventQueue::AckTouchEventToClient(
     InputEventAckState ack_result,
-    std::unique_ptr<CoalescedWebTouchEvent> acked_event,
     const ui::LatencyInfo* optional_latency_info) {
+  DCHECK(!dispatching_touch_ack_);
+  DCHECK(!touch_queue_.empty());
+  std::unique_ptr<CoalescedWebTouchEvent> acked_event(touch_queue_.front());
   DCHECK(acked_event);
-  DCHECK(!dispatching_touch_ack_);
+
   UpdateTouchConsumerStates(acked_event->coalesced_event().event, ack_result);
 
   // Note that acking the touch-event may result in multiple gestures being sent
   // to the renderer, or touch-events being queued.
   base::AutoReset<bool> dispatching_touch_ack(&dispatching_touch_ack_, true);
-  acked_event->DispatchAckToClient(ack_result, optional_latency_info, client_);
-}
 
-std::unique_ptr<CoalescedWebTouchEvent> TouchEventQueue::PopTouchEvent() {
-  DCHECK(!touch_queue_.empty());
-  std::unique_ptr<CoalescedWebTouchEvent> event(touch_queue_.front());
+  // Skip ack for TouchScrollStarted since it was synthesized within the queue.
+  if (acked_event->coalesced_event().event.type !=
+      WebInputEvent::TouchScrollStarted) {
+    acked_event->DispatchAckToClient(ack_result, optional_latency_info,
+                                     client_);
+  }
+
   touch_queue_.pop_front();
-  return event;
 }
 
 void TouchEventQueue::SendTouchEventImmediately(
     TouchEventWithLatencyInfo* touch) {
+  // TODO(crbug.com/600773): Hack to avoid cyclic reentry to this method.
+  if (dispatching_touch_)
+    return;
+
   // For touchmove events, compare touch points position from current event
   // to last sent event and update touch points state.
   if (touch->event.type == WebInputEvent::TouchMove) {
     CHECK(last_sent_touchevent_);
     for (unsigned int i = 0; i < last_sent_touchevent_->touchesLength; ++i) {
       const WebTouchPoint& last_touch_point =
           last_sent_touchevent_->touches[i];
       // Touches with same id may not have same index in Touches array.
       for (unsigned int j = 0; j < touch->event.touchesLength; ++j) {
         const WebTouchPoint& current_touchmove_point = touch->event.touches[j];
         if (current_touchmove_point.id != last_touch_point.id)
           continue;
 
         if (!HasPointChanged(last_touch_point, current_touchmove_point))
           touch->event.touches[j].state = WebTouchPoint::StateStationary;
 
         break;
       }
     }
   }
 
-  if (last_sent_touchevent_)
-    *last_sent_touchevent_ = touch->event;
-  else
-    last_sent_touchevent_.reset(new WebTouchEvent(touch->event));
+  if (touch->event.type != WebInputEvent::TouchScrollStarted) {
+    if (last_sent_touchevent_)
+      *last_sent_touchevent_ = touch->event;
+    else
+      last_sent_touchevent_.reset(new WebTouchEvent(touch->event));
+  }
 
   base::AutoReset<bool> dispatching_touch(&dispatching_touch_, true);
 
   client_->SendTouchEventImmediately(*touch);
 
   // A synchronous ack will reset |dispatching_touch_|, in which case the touch
   // timeout should not be started and the count also should not be increased.
   if (dispatching_touch_) {
     if (touch->event.type == WebInputEvent::TouchMove &&
         !touch->event.cancelable) {
       // When we send out a uncancelable touch move, we increase the count and
       // we do not process input event ack any more, we will just ack to client
       // and wait for the ack from render. Also we will remove it from the front
       // of the queue.
       ack_pending_async_touchmove_ids_.push_back(
           touch->event.uniqueTouchEventId);
       dispatching_touch_ = false;
       PopTouchEventToClient(INPUT_EVENT_ACK_STATE_IGNORED);
       TryForwardNextEventToRenderer();
       return;
     }
 
     if (timeout_handler_)
       timeout_handler_->StartIfNecessary(*touch);
   }
 }
 
 TouchEventQueue::PreFilterResult
 TouchEventQueue::FilterBeforeForwarding(const WebTouchEvent& event) {
+  if (event.type == WebInputEvent::TouchScrollStarted)
+    return FORWARD_TO_RENDERER;
+
   if (WebTouchEventTraits::IsTouchSequenceStart(event)) {
     has_handler_for_current_sequence_ = false;
     send_touch_events_async_ = false;
     pending_async_touchmove_.reset();
     last_sent_touchevent_.reset();
 
     touch_sequence_start_position_ = gfx::PointF(event.touches[0].position);
     drop_remaining_touches_in_sequence_ = false;
     if (!has_handlers_) {
       drop_remaining_touches_in_sequence_ = true;
@@ skipping 62 matching lines @@
     if (ack_result == INPUT_EVENT_ACK_STATE_CONSUMED)
       send_touch_events_async_ = false;
     has_handler_for_current_sequence_ |=
         ack_result != INPUT_EVENT_ACK_STATE_NO_CONSUMER_EXISTS;
   } else if (WebTouchEventTraits::IsTouchSequenceEnd(event)) {
     has_handler_for_current_sequence_ = false;
   }
 }
 
 }  // namespace content