Implement Gesture event hit testing/forwarding for OOPIF.

content/browser/renderer_host/render_widget_host_input_event_router.cc

 // Copyright 2015 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_input_event_router.h"
 
 #include "cc/quads/surface_draw_quad.h"
 #include "cc/surfaces/surface_id_allocator.h"
 #include "cc/surfaces/surface_manager.h"
 #include "content/browser/renderer_host/render_widget_host_view_base.h"
@@ skipping 22 matching lines @@
   for (auto entry : owner_map_) {
     if (entry.second == view) {
       owner_map_.erase(entry.first);
       // There will only be one instance of a particular view in the map.
       break;
     }
   }
 
   if (view == current_touch_target_) {
     current_touch_target_ = nullptr;
     active_touches_ = 0;

[tdresser, 2016/03/02 17:54:43]

Let's clear the transforms here as well.

[wjmaclean, 2016/03/02 18:33:40]

Done.

   }
+
+  // If the target that's being destroyed is in the gesture target queue, we
+  // replace it with nullptr so that we maintain the 1:1 correspondence between
+  // queue entries and the touch sequences that underly them.
+  for (size_t i = 0; i < gesture_target_queue_.size(); ++i) {
+    if (gesture_target_queue_[i].target == view)
+      gesture_target_queue_[i].target = nullptr;
+  }
+
+  if (view == current_gesture_target_)
+    current_gesture_target_ = nullptr;
 }
 
 void RenderWidgetHostInputEventRouter::ClearAllObserverRegistrations() {
   for (auto entry : owner_map_)
     entry.second->RemoveObserver(this);
   owner_map_.clear();
 }
 
 RenderWidgetHostInputEventRouter::HittestDelegate::HittestDelegate(
     const std::unordered_map<cc::SurfaceId, HittestData, cc::SurfaceIdHash>&
@@ skipping 12 matching lines @@
 bool RenderWidgetHostInputEventRouter::HittestDelegate::AcceptHitTarget(
     const cc::SurfaceDrawQuad* surface_quad,
     const gfx::Point& point_in_quad_space) {
   auto it = hittest_data_.find(surface_quad->surface_id);
   if (it != hittest_data_.end() && !it->second.ignored_for_hittest)
     return true;
   return false;
 }
 
 RenderWidgetHostInputEventRouter::RenderWidgetHostInputEventRouter()
-    : current_touch_target_(nullptr), active_touches_(0) {}
+    : current_touch_target_(nullptr),
+      current_gesture_target_(nullptr),
+      active_touches_(0) {}
 
 RenderWidgetHostInputEventRouter::~RenderWidgetHostInputEventRouter() {
   // We may be destroyed before some of the owners in the map, so we must
   // remove ourself from their observer lists.
   ClearAllObserverRegistrations();
 }
 
 RenderWidgetHostViewBase* RenderWidgetHostInputEventRouter::FindEventTarget(
     RenderWidgetHostViewBase* root_view,
     const gfx::Point& point,
@@ skipping 49 matching lines @@
       root_view, gfx::Point(event->x, event->y), &transformed_point);
   if (!target)
     return;
 
   event->x = transformed_point.x();
   event->y = transformed_point.y();
 
   target->ProcessMouseWheelEvent(*event);
 }
 
+void RenderWidgetHostInputEventRouter::RouteGestureEvent(
+    RenderWidgetHostViewBase* root_view,
+    blink::WebGestureEvent* event,
+    const ui::LatencyInfo& latency) {
+  // We use GestureTapDown to detect the start of a gesture sequence since there
+  // is not WebGestureEvent equivalent for ET_GESTURE_BEGIN. Note that this

[tdresser, 2016/03/02 17:54:43]

is not -> is no

[wjmaclean, 2016/03/02 18:33:40]

Done.

+  // means the GestureFlingCancel that always comes between ET_GESTURE_BEGIN and
+  // GestureTapDown is sent to the previous target, but that is intentional.

[tdresser, 2016/03/02 17:54:43]

We should have a test for this case. We should state why this behavior is
correct.

[wjmaclean, 2016/03/02 18:33:40]

Hmmm, ok. I'm not sure I'm clear on what constitutes a valid test here. The
current test *does* process the initial GestureFlingCancel, but as there have
been no prior touch events, it gets a null target.

At present OOPIF fling-scroll doesn't work. This CL lays the groundwork for
fixing it though.

[tdresser, 2016/03/02 19:25:11]

We should have a test where there are prior touch events, so it gets a non-null
target.

+  if (event->type == blink::WebInputEvent::GestureTapDown) {
+    if (!gesture_target_queue_.empty()) {
+      GestureTargetData& data = gesture_target_queue_.front();

[tdresser, 2016/03/02 17:54:43]

const?

[wjmaclean, 2016/03/02 18:33:40]

Done.

+      current_gesture_target_ = data.target;
+      gesture_delta_ = data.delta;
+      gesture_target_queue_.pop_front();
+    } else {
+      NOTIMPLEMENTED();

[tdresser, 2016/03/02 17:54:43]

We should probably DCHECK that the queue isn't empty.

[wjmaclean, 2016/03/02 18:33:40]

Done.

+    }
+  }
+
+  if (!current_gesture_target_)
+    return;
+
+  event->x += gesture_delta_.x();
+  event->y += gesture_delta_.y();
+  current_gesture_target_->ProcessGestureEvent(*event, latency);
+}
+
 void RenderWidgetHostInputEventRouter::RouteTouchEvent(
     RenderWidgetHostViewBase* root_view,
     blink::WebTouchEvent* event,
     const ui::LatencyInfo& latency) {
   switch (event->type) {
     case blink::WebInputEvent::TouchStart: {
       if (!active_touches_) {
         // Since this is the first touch, it defines the target for the rest
         // of this sequence.
         DCHECK(!current_touch_target_);
         gfx::Point transformed_point;
         gfx::Point original_point(event->touches[0].position.x,
                                   event->touches[0].position.y);
         current_touch_target_ =
             FindEventTarget(root_view, original_point, &transformed_point);
-        if (!current_touch_target_)
-          return;
 
         // TODO(wjmaclean): Instead of just computing a delta, we should extract
         // the complete transform. We assume it doesn't change for the duration
         // of the touch sequence, though this could be wrong; a better approach
         // might be to always transform each point to the current_touch_target_
         // for the duration of the sequence.

[tdresser, 2016/03/02 17:54:43]

Computing the transform each event seems more correct and simpler, though I'm a
bit worried about the perf implications. It probably makes sense to take that
approach for now though.

Either way, we should have a test for changing the transform mid-test.

[wjmaclean, 2016/03/02 18:33:40]

Acknowledged.

As indicated in a previous comment, we need to come up with a way to recover the
transform dynamically, but that's another CL.

[tdresser, 2016/03/02 19:25:11]

Acknowledged.

         touch_delta_ = transformed_point - original_point;
+        gesture_target_queue_.emplace_back(current_touch_target_, touch_delta_);
+
+        if (!current_touch_target_)
+          return;
       }
       ++active_touches_;
       if (current_touch_target_) {
         TransformEventTouchPositions(event, touch_delta_);
         current_touch_target_->ProcessTouchEvent(*event, latency);
       }
       break;
     }
     case blink::WebInputEvent::TouchMove:
       if (current_touch_target_) {
@@ skipping 51 matching lines @@
   if (owner_map_.find(cc::SurfaceIdAllocator::NamespaceForId(
           params.surface_id)) == owner_map_.end()) {
     return;
   }
   HittestData data;
   data.ignored_for_hittest = params.ignored_for_hittest;
   hittest_data_[params.surface_id] = data;
 }
 
 }  // namespace content