content/browser/renderer_host/ui_events_helper.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "content/browser/renderer_host/ui_events_helper.h"
   6
   7 #include "third_party/WebKit/public/web/WebInputEvent.h"
   8 #include "ui/events/event.h"
   9 #include "ui/events/event_constants.h"
  10
  11 namespace {
  12
  13 int WebModifiersToUIFlags(int modifiers) {
  14   int flags = ui::EF_NONE;
  15
  16   if (modifiers & blink::WebInputEvent::ShiftKey)
  17     flags |= ui::EF_SHIFT_DOWN;
  18   if (modifiers & blink::WebInputEvent::ControlKey)
  19     flags |= ui::EF_CONTROL_DOWN;
  20   if (modifiers & blink::WebInputEvent::AltKey)
  21     flags |= ui::EF_ALT_DOWN;
  22
  23   if (modifiers & blink::WebInputEvent::LeftButtonDown)
  24     flags |= ui::EF_LEFT_MOUSE_BUTTON;
  25   if (modifiers & blink::WebInputEvent::RightButtonDown)
  26     flags |= ui::EF_RIGHT_MOUSE_BUTTON;
  27   if (modifiers & blink::WebInputEvent::MiddleButtonDown)
  28     flags |= ui::EF_MIDDLE_MOUSE_BUTTON;
  29
  30   if (modifiers & blink::WebInputEvent::CapsLockOn)
  31     flags |= ui::EF_CAPS_LOCK_DOWN;
  32
  33   return flags;
  34 }
  35
  36 ui::EventType WebTouchPointStateToEventType(
  37     blink::WebTouchPoint::State state) {
  38   switch (state) {
  39     case blink::WebTouchPoint::StateReleased:
  40       return ui::ET_TOUCH_RELEASED;
  41
  42     case blink::WebTouchPoint::StatePressed:
  43       return ui::ET_TOUCH_PRESSED;
  44
  45     case blink::WebTouchPoint::StateMoved:
  46       return ui::ET_TOUCH_MOVED;
  47
  48     case blink::WebTouchPoint::StateCancelled:
  49       return ui::ET_TOUCH_CANCELLED;
  50
  51     default:
  52       return ui::ET_UNKNOWN;
  53   }
  54 }
  55
  56 blink::WebTouchPoint::State TouchPointStateFromEvent(
  57     const ui::TouchEvent& event) {
  58   switch (event.type()) {
  59     case ui::ET_TOUCH_PRESSED:
  60       return blink::WebTouchPoint::StatePressed;
  61     case ui::ET_TOUCH_RELEASED:
  62       return blink::WebTouchPoint::StateReleased;
  63     case ui::ET_TOUCH_MOVED:
  64       return blink::WebTouchPoint::StateMoved;
  65     case ui::ET_TOUCH_CANCELLED:
  66       return blink::WebTouchPoint::StateCancelled;
  67     default:
  68       return blink::WebTouchPoint::StateUndefined;
  69   }
  70 }
  71
  72 blink::WebInputEvent::Type TouchEventTypeFromEvent(
  73     const ui::TouchEvent& event) {
  74   switch (event.type()) {
  75     case ui::ET_TOUCH_PRESSED:
  76       return blink::WebInputEvent::TouchStart;
  77     case ui::ET_TOUCH_RELEASED:
  78       return blink::WebInputEvent::TouchEnd;
  79     case ui::ET_TOUCH_MOVED:
  80       return blink::WebInputEvent::TouchMove;
  81     case ui::ET_TOUCH_CANCELLED:
  82       return blink::WebInputEvent::TouchCancel;
  83     default:
  84       return blink::WebInputEvent::Undefined;
  85   }
  86 }
  87
  88 }  // namespace
  89
  90 namespace content {
  91
  92 bool MakeUITouchEventsFromWebTouchEvents(
  93     const TouchEventWithLatencyInfo& touch_with_latency,
  94     ScopedVector<ui::TouchEvent>* list,
  95     TouchEventCoordinateSystem coordinate_system) {
  96   const blink::WebTouchEvent& touch = touch_with_latency.event;
  97   ui::EventType type = ui::ET_UNKNOWN;
  98   switch (touch.type) {
  99     case blink::WebInputEvent::TouchStart:
 100       type = ui::ET_TOUCH_PRESSED;
 101       break;
 102     case blink::WebInputEvent::TouchEnd:
 103       type = ui::ET_TOUCH_RELEASED;
 104       break;
 105     case blink::WebInputEvent::TouchMove:
 106       type = ui::ET_TOUCH_MOVED;
 107       break;
 108     case blink::WebInputEvent::TouchCancel:
 109       type = ui::ET_TOUCH_CANCELLED;
 110       break;
 111     default:
 112       NOTREACHED();
 113       return false;
 114   }
 115
 116   int flags = WebModifiersToUIFlags(touch.modifiers);
 117   base::TimeDelta timestamp = base::TimeDelta::FromMicroseconds(
 118       static_cast<int64>(touch.timeStampSeconds * 1000000));
 119   for (unsigned i = 0; i < touch.touchesLength; ++i) {
 120     const blink::WebTouchPoint& point = touch.touches[i];
 121     if (WebTouchPointStateToEventType(point.state) != type)
 122       continue;
 123     // ui events start in the co-ordinate space of the EventDispatcher.
 124     gfx::Point location;
 125     if (coordinate_system == LOCAL_COORDINATES)
 126       location = gfx::Point(point.position.x, point.position.y);
 127     else
 128       location = gfx::Point(point.screenPosition.x, point.screenPosition.y);
 129     ui::TouchEvent* uievent = new ui::TouchEvent(type,
 130           location,
 131           flags,
 132           point.id,
 133           timestamp,
 134           point.radiusX,
 135           point.radiusY,
 136           point.rotationAngle,
 137           point.force);
 138     uievent->set_latency(touch_with_latency.latency);
 139     list->push_back(uievent);
 140   }
 141   return true;
 142 }
 143
 144 blink::WebGestureEvent MakeWebGestureEventFromUIEvent(
 145     const ui::GestureEvent& event) {
 146   blink::WebGestureEvent gesture_event;
 147
 148   switch (event.type()) {
 149     case ui::ET_GESTURE_TAP:
 150       gesture_event.type = blink::WebInputEvent::GestureTap;
 151       gesture_event.data.tap.tapCount = event.details().tap_count();
 152       gesture_event.data.tap.width = event.details().bounding_box().width();
 153       gesture_event.data.tap.height = event.details().bounding_box().height();
 154       break;
 155     case ui::ET_GESTURE_TAP_DOWN:
 156       gesture_event.type = blink::WebInputEvent::GestureTapDown;
 157       gesture_event.data.tapDown.width =
 158           event.details().bounding_box().width();
 159       gesture_event.data.tapDown.height =
 160           event.details().bounding_box().height();
 161       break;
 162     case ui::ET_GESTURE_SHOW_PRESS:
 163       gesture_event.type = blink::WebInputEvent::GestureShowPress;
 164       gesture_event.data.showPress.width =
 165           event.details().bounding_box().width();
 166       gesture_event.data.showPress.height =
 167           event.details().bounding_box().height();
 168       break;
 169     case ui::ET_GESTURE_TAP_CANCEL:
 170       gesture_event.type = blink::WebInputEvent::GestureTapCancel;
 171       break;
 172     case ui::ET_GESTURE_SCROLL_BEGIN:
 173       gesture_event.type = blink::WebInputEvent::GestureScrollBegin;
 174       gesture_event.data.scrollBegin.deltaXHint =
 175           event.details().scroll_x_hint();
 176       gesture_event.data.scrollBegin.deltaYHint =
 177           event.details().scroll_y_hint();
 178       break;
 179     case ui::ET_GESTURE_SCROLL_UPDATE:
 180       gesture_event.type = blink::WebInputEvent::GestureScrollUpdate;
 181       gesture_event.data.scrollUpdate.deltaX = event.details().scroll_x();
 182       gesture_event.data.scrollUpdate.deltaY = event.details().scroll_y();
 183       break;
 184     case ui::ET_GESTURE_SCROLL_END:
 185       gesture_event.type = blink::WebInputEvent::GestureScrollEnd;
 186       break;
 187     case ui::ET_GESTURE_PINCH_BEGIN:
 188       gesture_event.type = blink::WebInputEvent::GesturePinchBegin;
 189       break;
 190     case ui::ET_GESTURE_PINCH_UPDATE:
 191       gesture_event.type = blink::WebInputEvent::GesturePinchUpdate;
 192       gesture_event.data.pinchUpdate.scale = event.details().scale();
 193       break;
 194     case ui::ET_GESTURE_PINCH_END:
 195       gesture_event.type = blink::WebInputEvent::GesturePinchEnd;
 196       break;
 197     case ui::ET_SCROLL_FLING_START:
 198       gesture_event.type = blink::WebInputEvent::GestureFlingStart;
 199       gesture_event.data.flingStart.velocityX = event.details().velocity_x();
 200       gesture_event.data.flingStart.velocityY = event.details().velocity_y();
 201       break;
 202     case ui::ET_SCROLL_FLING_CANCEL:
 203       gesture_event.type = blink::WebInputEvent::GestureFlingCancel;
 204       break;
 205     case ui::ET_GESTURE_LONG_PRESS:
 206       gesture_event.type = blink::WebInputEvent::GestureLongPress;
 207       gesture_event.data.longPress.width =
 208           event.details().bounding_box().width();
 209       gesture_event.data.longPress.height =
 210           event.details().bounding_box().height();
 211       break;
 212     case ui::ET_GESTURE_LONG_TAP:
 213       gesture_event.type = blink::WebInputEvent::GestureLongTap;
 214       gesture_event.data.longPress.width =
 215           event.details().bounding_box().width();
 216       gesture_event.data.longPress.height =
 217           event.details().bounding_box().height();
 218       break;
 219     case ui::ET_GESTURE_TWO_FINGER_TAP:
 220       gesture_event.type = blink::WebInputEvent::GestureTwoFingerTap;
 221       gesture_event.data.twoFingerTap.firstFingerWidth =
 222           event.details().first_finger_width();
 223       gesture_event.data.twoFingerTap.firstFingerHeight =
 224           event.details().first_finger_height();
 225       break;
 226     case ui::ET_GESTURE_BEGIN:
 227     case ui::ET_GESTURE_END:
 228     case ui::ET_GESTURE_MULTIFINGER_SWIPE:
 229       gesture_event.type = blink::WebInputEvent::Undefined;
 230       break;
 231     default:
 232       NOTREACHED() << "Unknown gesture type: " << event.type();
 233   }
 234
 235   gesture_event.sourceDevice = blink::WebGestureEvent::Touchscreen;
 236   gesture_event.modifiers = EventFlagsToWebEventModifiers(event.flags());
 237   gesture_event.timeStampSeconds = event.time_stamp().InSecondsF();
 238
 239   return gesture_event;
 240 }
 241
 242 int EventFlagsToWebEventModifiers(int flags) {
 243   int modifiers = 0;
 244
 245   if (flags & ui::EF_SHIFT_DOWN)
 246     modifiers |= blink::WebInputEvent::ShiftKey;
 247   if (flags & ui::EF_CONTROL_DOWN)
 248     modifiers |= blink::WebInputEvent::ControlKey;
 249   if (flags & ui::EF_ALT_DOWN)
 250     modifiers |= blink::WebInputEvent::AltKey;
 251   // TODO(beng): MetaKey/META_MASK
 252   if (flags & ui::EF_LEFT_MOUSE_BUTTON)
 253     modifiers |= blink::WebInputEvent::LeftButtonDown;
 254   if (flags & ui::EF_MIDDLE_MOUSE_BUTTON)
 255     modifiers |= blink::WebInputEvent::MiddleButtonDown;
 256   if (flags & ui::EF_RIGHT_MOUSE_BUTTON)
 257     modifiers |= blink::WebInputEvent::RightButtonDown;
 258   if (flags & ui::EF_CAPS_LOCK_DOWN)
 259     modifiers |= blink::WebInputEvent::CapsLockOn;
 260   return modifiers;
 261 }
 262
 263 blink::WebTouchPoint* UpdateWebTouchEventFromUIEvent(
 264     const ui::TouchEvent& event,
 265     blink::WebTouchEvent* web_event) {
 266   blink::WebTouchPoint* point = NULL;
 267   switch (event.type()) {
 268     case ui::ET_TOUCH_PRESSED:
 269       // Add a new touch point.
 270       if (web_event->touchesLength < blink::WebTouchEvent::touchesLengthCap) {
 271         point = &web_event->touches[web_event->touchesLength++];
 272         point->id = event.touch_id();
 273       }
 274       break;
 275     case ui::ET_TOUCH_RELEASED:
 276     case ui::ET_TOUCH_CANCELLED:
 277     case ui::ET_TOUCH_MOVED: {
 278       // The touch point should have been added to the event from an earlier
 279       // _PRESSED event. So find that.
 280       // At the moment, only a maximum of 4 touch-points are allowed. So a
 281       // simple loop should be sufficient.
 282       for (unsigned i = 0; i < web_event->touchesLength; ++i) {
 283         point = web_event->touches + i;
 284         if (point->id == event.touch_id())
 285           break;
 286         point = NULL;
 287       }
 288       break;
 289     }
 290     default:
 291       DLOG(WARNING) << "Unknown touch event " << event.type();
 292       break;
 293   }
 294
 295   if (!point)
 296     return NULL;
 297
 298   // The spec requires the radii values to be positive (and 1 when unknown).
 299   point->radiusX = std::max(1.f, event.radius_x());
 300   point->radiusY = std::max(1.f, event.radius_y());
 301   point->rotationAngle = event.rotation_angle();
 302   point->force = event.force();
 303
 304   // Update the location and state of the point.
 305   point->state = TouchPointStateFromEvent(event);
 306   if (point->state == blink::WebTouchPoint::StateMoved) {
 307     // It is possible for badly written touch drivers to emit Move events even
 308     // when the touch location hasn't changed. In such cases, consume the event
 309     // and pretend nothing happened.
 310     if (point->position.x == event.x() && point->position.y == event.y())
 311       return NULL;
 312   }
 313   point->position.x = event.x();
 314   point->position.y = event.y();
 315
 316   const gfx::Point root_point = event.root_location();
 317   point->screenPosition.x = root_point.x();
 318   point->screenPosition.y = root_point.y();
 319
 320   // Mark the rest of the points as stationary.
 321   for (unsigned i = 0; i < web_event->touchesLength; ++i) {
 322     blink::WebTouchPoint* iter = web_event->touches + i;
 323     if (iter != point)
 324       iter->state = blink::WebTouchPoint::StateStationary;
 325   }
 326
 327   // Update the type of the touch event.
 328   web_event->type = TouchEventTypeFromEvent(event);
 329   web_event->timeStampSeconds = event.time_stamp().InSecondsF();
 330   web_event->modifiers = EventFlagsToWebEventModifiers(event.flags());
 331
 332   return point;
 333 }
 334
 335 }  // namespace content