Tiimer based phase info generated for mouse wheel events.

content/browser/renderer_host/render_widget_host_view_event_handler.cc

 // Copyright 2016 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/render_widget_host_view_event_handler.h"
 
 #include "base/metrics/user_metrics.h"
 #include "base/metrics/user_metrics_action.h"
 #include "content/browser/renderer_host/input/touch_selection_controller_client_aura.h"
 #include "content/browser/renderer_host/overscroll_controller.h"
@@ skipping 318 matching lines @@
     if (host) {
       HWND parent = host->GetAcceleratedWidget();
       HWND toplevel_hwnd = ::GetAncestor(parent, GA_ROOT);
       EnumThreadWindows(GetCurrentThreadId(), DismissOwnedPopups,
                         reinterpret_cast<LPARAM>(toplevel_hwnd));
     }
 #endif
     blink::WebMouseWheelEvent mouse_wheel_event =
         ui::MakeWebMouseWheelEvent(static_cast<ui::MouseWheelEvent&>(*event),
                                    base::Bind(&GetScreenLocationFromEvent));
+    bool should_route_event = ShouldRouteEvent(event);

[bokan, 2017/05/18 16:47:00]

Nit: move this inside the `if` block.

[sahel, 2017/05/18 18:15:14]

Done.

+
     if (mouse_wheel_event.delta_x != 0 || mouse_wheel_event.delta_y != 0) {
-      if (ShouldRouteEvent(event)) {
+      if (host_view_->wheel_scroll_latching_enabled())
+        AddSyntheticPhase(mouse_wheel_event, should_route_event);
+      if (should_route_event) {
         host_->delegate()->GetInputEventRouter()->RouteMouseWheelEvent(
             host_view_, &mouse_wheel_event, *event->latency());
       } else {
         ProcessMouseWheelEvent(mouse_wheel_event, *event->latency());
       }
     }
   } else {
     bool is_selection_popup = NeedsInputGrab(popup_child_host_view_);
     if (CanRendererHandleEvent(event, mouse_locked_, is_selection_popup) &&
         !(event->flags() & ui::EF_FROM_TOUCH)) {
@@ skipping 46 matching lines @@
       return;
 #endif
     blink::WebGestureEvent gesture_event = ui::MakeWebGestureEventFlingCancel();
     // Coordinates need to be transferred to the fling cancel gesture only
     // for Surface-targeting to ensure that it is targeted to the correct
     // RenderWidgetHost.
     gesture_event.x = event->x();
     gesture_event.y = event->y();
     blink::WebMouseWheelEvent mouse_wheel_event = ui::MakeWebMouseWheelEvent(
         *event, base::Bind(&GetScreenLocationFromEvent));
-    if (ShouldRouteEvent(event)) {
+
+    bool should_route_event = ShouldRouteEvent(event);
+    if (host_view_->wheel_scroll_latching_enabled())
+      AddSyntheticPhase(mouse_wheel_event, should_route_event);
+    if (should_route_event) {
       host_->delegate()->GetInputEventRouter()->RouteGestureEvent(
           host_view_, &gesture_event,
           ui::LatencyInfo(ui::SourceEventType::WHEEL));
       host_->delegate()->GetInputEventRouter()->RouteMouseWheelEvent(
           host_view_, &mouse_wheel_event, *event->latency());
     } else {
       host_->ForwardGestureEvent(gesture_event);
       host_->ForwardWheelEventWithLatencyInfo(mouse_wheel_event,
                                               *event->latency());
     }
   } else if (event->type() == ui::ET_SCROLL_FLING_START ||
              event->type() == ui::ET_SCROLL_FLING_CANCEL) {
     blink::WebGestureEvent gesture_event = ui::MakeWebGestureEvent(
         *event, base::Bind(&GetScreenLocationFromEvent));
-    if (ShouldRouteEvent(event)) {
+    bool should_route_event = ShouldRouteEvent(event);

[bokan, 2017/05/18 16:47:00]

Define this variable outside only once and use in both blocks.

[sahel, 2017/05/18 18:15:14]

Done.

+    if (should_route_event) {
       host_->delegate()->GetInputEventRouter()->RouteGestureEvent(
           host_view_, &gesture_event,
           ui::LatencyInfo(ui::SourceEventType::WHEEL));
     } else {
       host_->ForwardGestureEvent(gesture_event);
     }
-    if (event->type() == ui::ET_SCROLL_FLING_START)
+    if (event->type() == ui::ET_SCROLL_FLING_START) {
       RecordAction(base::UserMetricsAction("TrackpadScrollFling"));
+
+      if (mouse_wheel_phase_timer_.IsRunning()) {
+        // Stop the timer to avoid sending a synthetic wheel event with
+        // kPhaseEnded.
+        mouse_wheel_phase_timer_.Stop();

[bokan, 2017/05/18 16:47:00]

Is there any harm in calling Stop on a timer that isn't running? If not, remove
the `if`.

[sahel, 2017/05/18 18:15:15]

Done.

+      }
+    }
   }
 
   event->SetHandled();
 }
 
 void RenderWidgetHostViewEventHandler::OnTouchEvent(ui::TouchEvent* event) {
   TRACE_EVENT0("input", "RenderWidgetHostViewBase::OnTouchEvent");
 
   bool had_no_pointer = !pointer_state_.GetPointerCount();
 
@@ skipping 71 matching lines @@
     if (ShouldRouteEvent(event)) {
       host_->delegate()->GetInputEventRouter()->RouteGestureEvent(
           host_view_, &fling_cancel,
           ui::LatencyInfo(ui::SourceEventType::TOUCH));
     } else {
       host_->ForwardGestureEvent(fling_cancel);
     }
   }
 
   if (gesture.GetType() != blink::WebInputEvent::kUndefined) {
+    if (event->type() == ui::ET_GESTURE_SCROLL_BEGIN) {
+      RecordAction(base::UserMetricsAction("TouchscreenScroll"));
+
+      if (mouse_wheel_phase_timer_.IsRunning()) {
+        // If there is a current scroll going on and a new scroll that isn't
+        // wheel based send a synthetic wheel event with kPhaseEnded to cancel
+        // the current scroll.
+        base::Closure task = mouse_wheel_phase_timer_.user_task();
+        mouse_wheel_phase_timer_.Stop();
+        task.Run();
+      }
+    } else if (event->type() == ui::ET_GESTURE_SCROLL_END) {
+      // Make sure that the next wheel event will have phase = |kPhaseBegan|.
+      // This is for maintaining the correct phase info when some of the wheel
+      // events get ignored while a touchscreen scroll is going on.
+      if (mouse_wheel_phase_timer_.IsRunning()) {

[bokan, 2017/05/18 16:47:00]

If the wheel events are ignored while a touchscreen scroll is in progress, and
we stopped the timer when the touchscreen scroll started, how can this happen?

[sahel, 2017/05/18 18:15:15]

They will be still generated (with phase info) and sent to
mouse_wheel_event_queue, but there they will be ignored. It can happen when in
the middle of touch screen scrolling sequence we start wheel scrolling and then
we stop touch screen scrolling.

[bokan, 2017/05/19 15:52:59]

Acknowledged.

+        mouse_wheel_phase_timer_.Stop();
+      }
+    } else if (event->type() == ui::ET_SCROLL_FLING_START) {
+      RecordAction(base::UserMetricsAction("TouchscreenScrollFling"));
+    }
+
     if (ShouldRouteEvent(event)) {
       host_->delegate()->GetInputEventRouter()->RouteGestureEvent(
           host_view_, &gesture, *event->latency());
     } else {
       host_->ForwardGestureEventWithLatencyInfo(gesture, *event->latency());
     }
-
-    if (event->type() == ui::ET_GESTURE_SCROLL_BEGIN) {
-      RecordAction(base::UserMetricsAction("TouchscreenScroll"));
-    } else if (event->type() == ui::ET_SCROLL_FLING_START) {
-      RecordAction(base::UserMetricsAction("TouchscreenScrollFling"));
-    }
   }
 
   // If a gesture is not processed by the webpage, then WebKit processes it
   // (e.g. generates synthetic mouse events).
   event->SetHandled();
 }
 
 bool RenderWidgetHostViewEventHandler::CanRendererHandleEvent(
     const ui::MouseEvent* event,
     bool mouse_locked,
@@ skipping 336 matching lines @@
     const ui::LatencyInfo& latency) {
   host_->ForwardWheelEventWithLatencyInfo(event, latency);
 }
 
 void RenderWidgetHostViewEventHandler::ProcessTouchEvent(
     const blink::WebTouchEvent& event,
     const ui::LatencyInfo& latency) {
   host_->ForwardTouchEventWithLatencyInfo(event, latency);
 }
 
+void RenderWidgetHostViewEventHandler::SendSyntheticWheelEventWithPhaseEnded(

[bokan, 2017/05/18 16:47:00]

Please add a DCHECK that touchpad latching is enabled here and in
AddSyntheticPhase.

[sahel, 2017/05/18 18:15:15]

Done.

+    blink::WebMouseWheelEvent last_mouse_wheel_event,
+    bool should_route_event) {
+  blink::WebMouseWheelEvent mouse_wheel_event = last_mouse_wheel_event;
+  mouse_wheel_event.delta_x = 0;
+  mouse_wheel_event.delta_y = 0;
+  mouse_wheel_event.phase = blink::WebMouseWheelEvent::kPhaseEnded;
+  mouse_wheel_event.dispatch_type =
+      blink::WebInputEvent::DispatchType::kEventNonBlocking;
+  if (should_route_event) {
+    host_->delegate()->GetInputEventRouter()->RouteMouseWheelEvent(
+        host_view_, &mouse_wheel_event,
+        ui::LatencyInfo(ui::SourceEventType::WHEEL));
+  } else {
+    ProcessMouseWheelEvent(mouse_wheel_event,
+                           ui::LatencyInfo(ui::SourceEventType::WHEEL));
+  }
+}
+
+void RenderWidgetHostViewEventHandler::AddSyntheticPhase(

[tdresser, 2017/05/18 13:49:05]

The name of this function doesn't make it clear that it might start a timer
which dispatches an event.

I haven't come up with a name I really like though.
Any ideas?

[bokan, 2017/05/18 16:47:00]

IMO, it doesn't matter that the phase is "synthetic" (it's synthetic by virtue
of us adding it here), I'd call this AddPhaseAndScheduleEndEvent. I'd also
rename the method to just "AddPhase".

[sahel, 2017/05/18 18:15:15]

Done.

[sahel, 2017/05/18 18:15:15]

I changed the name, it might be too long but is descriptive. 

[bokan, 2017/05/19 15:52:59]

We have (much) longer :)

+    blink::WebMouseWheelEvent& mouse_wheel_event,
+    bool should_route_event) {
+  DCHECK(mouse_wheel_event.phase == blink::WebMouseWheelEvent::kPhaseNone &&

[bokan, 2017/05/18 16:47:00]

Where do the Mac events that do have this go?

[sahel, 2017/05/18 18:15:15]

This event handler is aura only, mac events are handled in
render_widget_host_view_mac.mm

[bokan, 2017/05/19 15:52:59]

Acknowledged.

+         mouse_wheel_event.momentum_phase ==
+             blink::WebMouseWheelEvent::kPhaseNone);
+
+  if (!mouse_wheel_phase_timer_.IsRunning()) {
+    mouse_wheel_event.phase = blink::WebMouseWheelEvent::kPhaseBegan;
+    mouse_wheel_phase_timer_.Start(
+        FROM_HERE,
+        base::TimeDelta::FromMilliseconds(
+            kDefaultMouseWheelLatchingTransactionMs),
+        base::Bind(&RenderWidgetHostViewEventHandler::
+                       SendSyntheticWheelEventWithPhaseEnded,
+                   base::Unretained(this), mouse_wheel_event,
+                   should_route_event));
+  } else {
+    bool non_zero_delta =
+        mouse_wheel_event.delta_x || mouse_wheel_event.delta_y;
+    mouse_wheel_event.phase = non_zero_delta
+                                  ? blink::WebMouseWheelEvent::kPhaseChanged
+                                  : blink::WebMouseWheelEvent::kPhaseStationary;
+    mouse_wheel_phase_timer_.Reset();
+  }
+}
+
 }  // namespace content