Initial browser-side implementation for touch-action

content/browser/renderer_host/input/immediate_input_router.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/immediate_input_router.h"
 
 #include "base/auto_reset.h"
 #include "base/command_line.h"
 #include "base/metrics/histogram.h"
 #include "content/browser/renderer_host/input/gesture_event_filter.h"
 #include "content/browser/renderer_host/input/input_ack_handler.h"
 #include "content/browser/renderer_host/input/input_router_client.h"
 #include "content/browser/renderer_host/input/touch_event_queue.h"
 #include "content/browser/renderer_host/input/touchpad_tap_suppression_controller.h"
 #include "content/browser/renderer_host/overscroll_controller.h"
 #include "content/common/content_constants_internal.h"
 #include "content/common/edit_command.h"
 #include "content/common/input/web_input_event_traits.h"
 #include "content/common/input_messages.h"
 #include "content/common/view_messages.h"
 #include "content/port/common/input_event_ack_state.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
 #include "content/public/browser/user_metrics.h"
 #include "content/public/common/content_switches.h"
+#include "content/public/common/touch_action.h"
 #include "ipc/ipc_sender.h"
 #include "ui/events/event.h"
 #include "ui/events/keycodes/keyboard_codes.h"
 
 using base::Time;
 using base::TimeDelta;
 using base::TimeTicks;
 using WebKit::WebGestureEvent;
 using WebKit::WebInputEvent;
 using WebKit::WebKeyboardEvent;
@@ skipping 42 matching lines @@
                                            int routing_id)
     : sender_(sender),
       client_(client),
       ack_handler_(ack_handler),
       routing_id_(routing_id),
       select_range_pending_(false),
       move_caret_pending_(false),
       mouse_move_pending_(false),
       mouse_wheel_pending_(false),
       has_touch_handler_(false),
+      drop_scroll_gesture_events_(false),
+      allowed_touch_action_(content::TOUCH_ACTION_AUTO),
       current_ack_source_(ACK_SOURCE_NONE),
       touch_event_queue_(new TouchEventQueue(this)),
       gesture_event_filter_(new GestureEventFilter(this, this)) {
   DCHECK(sender);
   DCHECK(client);
   DCHECK(ack_handler);
 }
 
 ImmediateInputRouter::~ImmediateInputRouter() {
 }
@@ skipping 75 matching lines @@
   HISTOGRAM_COUNTS_100("Renderer.KeyboardQueueSize", key_queue_.size());
 
   gesture_event_filter_->FlingHasBeenHalted();
 
   // Only forward the non-native portions of our event.
   FilterAndSendWebInputEvent(key_event, latency_info, is_keyboard_shortcut);
 }
 
 void ImmediateInputRouter::SendGestureEvent(
     const GestureEventWithLatencyInfo& gesture_event) {
-  HandleGestureScroll(gesture_event);
+  if (FilterTouchAction(gesture_event))
+    return;
 
   if (!IsInOverscrollGesture() &&
       !gesture_event_filter_->ShouldForward(gesture_event)) {
     OverscrollController* controller = client_->GetOverscrollController();
     if (controller)
       controller->DiscardingGestureEvent(gesture_event.event);
     return;
   }
 
   FilterAndSendWebInputEvent(gesture_event.event, gesture_event.latency, false);
@@ skipping 26 matching lines @@
   FilterAndSendWebInputEvent(mouse_event.event, mouse_event.latency, false);
 }
 
 void ImmediateInputRouter::SendTouchEventImmediately(
     const TouchEventWithLatencyInfo& touch_event) {
   FilterAndSendWebInputEvent(touch_event.event, touch_event.latency, false);
 }
 
 void ImmediateInputRouter::SendGestureEventImmediately(
     const GestureEventWithLatencyInfo& gesture_event) {
-  HandleGestureScroll(gesture_event);
+  if (FilterTouchAction(gesture_event))
+    return;
   FilterAndSendWebInputEvent(gesture_event.event, gesture_event.latency, false);
 }
 
 const NativeWebKeyboardEvent*
     ImmediateInputRouter::GetLastKeyboardEvent() const {
   if (key_queue_.empty())
     return NULL;
   return &key_queue_.front();
 }
 
 bool ImmediateInputRouter::ShouldForwardTouchEvent() const {
   // Always send a touch event if the renderer has a touch-event handler. It is
   // possible that a renderer stops listening to touch-events while there are
   // still events in the touch-queue. In such cases, the new events should still
   // get into the queue.
   return has_touch_handler_ || !touch_event_queue_->empty();
 }
 
 bool ImmediateInputRouter::OnMessageReceived(const IPC::Message& message) {
   bool handled = true;
   bool message_is_ok = true;
   IPC_BEGIN_MESSAGE_MAP_EX(ImmediateInputRouter, message, message_is_ok)
     IPC_MESSAGE_HANDLER(InputHostMsg_HandleInputEvent_ACK, OnInputEventAck)
     IPC_MESSAGE_HANDLER(ViewHostMsg_MoveCaret_ACK, OnMsgMoveCaretAck)
     IPC_MESSAGE_HANDLER(ViewHostMsg_SelectRange_ACK, OnSelectRangeAck)
     IPC_MESSAGE_HANDLER(ViewHostMsg_HasTouchEventHandlers,
                         OnHasTouchEventHandlers)
+    IPC_MESSAGE_HANDLER(ViewHostMsg_SetTouchAction,
+                        OnSetTouchAction)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP()
 
   if (!message_is_ok)
     ack_handler_->OnUnexpectedEventAck(InputAckHandler::BAD_ACK_MESSAGE);
 
   return handled;
 }
 
 void ImmediateInputRouter::OnTouchEventAck(
@@ skipping 187 matching lines @@
 
 void ImmediateInputRouter::OnHasTouchEventHandlers(bool has_handlers) {
  if (has_touch_handler_ == has_handlers)
     return;
   has_touch_handler_ = has_handlers;
   if (!has_handlers)
     touch_event_queue_->FlushQueue();
   client_->OnHasTouchEventHandlers(has_handlers);
 }
 
+void ImmediateInputRouter::OnSetTouchAction(
+    int touch_id,
+    content::TouchAction touchAction)
+{
+  // Don't process touch-action messages for synthetic touches we know
+  // nothing about.
+  if (!touch_event_queue_->IsTouchStartPendingAck(touch_id))
+    return;
+
+  // For multiple fingers, we take the intersection of the touch actions for
+  // all fingers that have gone down during this action.
+  // TODO(rbyers): Get some agreed upon multi-finger semantic for touch-action
+  // included in the pointer events specification. crbug.com/241964
+  if (touchAction == content::TOUCH_ACTION_NONE)
+    allowed_touch_action_ = content::TOUCH_ACTION_NONE;
+}
+
 void ImmediateInputRouter::ProcessInputEventAck(
     WebInputEvent::Type event_type,
     InputEventAckState ack_result,
     const ui::LatencyInfo& latency_info,
     AckSource ack_source) {
   TRACE_EVENT2("input", "ImmediateInputRouter::ProcessInputEventAck",
                "type", WebInputEventTraits::GetName(event_type),
                "ack", GetEventAckName(ack_result));
 
   // Note: The keyboard ack must be treated carefully, as it may result in
@@ skipping 109 matching lines @@
     return;
 
   OverscrollController* controller = client_->GetOverscrollController();
   if (!controller)
     return;
 
   controller->ReceivedEventACK(
       event, (INPUT_EVENT_ACK_STATE_CONSUMED == ack_result));
 }
 
-void ImmediateInputRouter::HandleGestureScroll(
+bool ImmediateInputRouter::FilterTouchAction(
     const GestureEventWithLatencyInfo& gesture_event) {
+
+  // Filter for allowable touch actions first (eg. before the TouchEventQueue
+  // can decide to send a touch cancel event).
+  // TODO: Does this belong in GestureEventFilter, even though the filtering
+  // happens at a different stage from the other filters there?
+  // TODO(rbyers): Add touch-action control over for pinch.  crbug.com/247566.
+  switch(gesture_event.event.type) {
+  case WebInputEvent::GestureScrollBegin:
+    if (allowed_touch_action_ == TOUCH_ACTION_NONE)
+      drop_scroll_gesture_events_ = true;
+    // FALL THROUGH
+  case WebInputEvent::GestureScrollUpdate:
+  case WebInputEvent::GestureScrollUpdateWithoutPropagation:
+    if (drop_scroll_gesture_events_)
+      return true;
+    break;
+
+  case WebInputEvent::GestureScrollEnd:
+  case WebInputEvent::GestureFlingStart:
+    allowed_touch_action_ = content::TOUCH_ACTION_AUTO;
+    if (drop_scroll_gesture_events_) {
+      drop_scroll_gesture_events_ = false;
+      return true;
+    }
+    break;
+
+  default:
+    break;
+  }
+
+  // This touch action is permitted, allow it to cancel in-progress touches.
   touch_event_queue_->OnGestureScrollEvent(gesture_event);
+  return false;
 }
 
 void ImmediateInputRouter::SimulateTouchGestureWithMouse(
     const MouseEventWithLatencyInfo& event) {
   const WebMouseEvent& mouse_event = event.event;
   int x = mouse_event.x, y = mouse_event.y;
   float dx = mouse_event.movementX, dy = mouse_event.movementY;
   static int startX = 0, startY = 0;
 
   switch (mouse_event.button) {
@@ skipping 68 matching lines @@
       break;
   }
 }
 
 bool ImmediateInputRouter::IsInOverscrollGesture() const {
   OverscrollController* controller = client_->GetOverscrollController();
   return controller && controller->overscroll_mode() != OVERSCROLL_NONE;
 }
 
 }  // namespace content