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.
5 #include "ui/events/event_constants.h"
9 #include <X11/extensions/XInput.h>
10 #include <X11/extensions/XInput2.h>
13 #include "base/logging.h"
14 #include "base/memory/singleton.h"
15 #include "base/message_loop/message_pump_x11.h"
16 #include "ui/events/event_utils.h"
17 #include "ui/events/keycodes/keyboard_code_conversion_x.h"
18 #include "ui/events/x/device_data_manager.h"
19 #include "ui/events/x/device_list_cache_x.h"
20 #include "ui/events/x/touch_factory_x11.h"
21 #include "ui/gfx/display.h"
22 #include "ui/gfx/point.h"
23 #include "ui/gfx/rect.h"
24 #include "ui/gfx/screen.h"
25 #include "ui/gfx/x/x11_atom_cache.h"
26 #include "ui/gfx/x/x11_types.h"
30 // Scroll amount for each wheelscroll event. 53 is also the value used for GTK+.
31 const int kWheelScrollAmount = 53;
33 const int kMinWheelButton = 4;
34 const int kMaxWheelButton = 7;
36 // A class to track current modifier state on master device. Only track ctrl,
37 // alt, shift and caps lock keys currently. The tracked state can then be used
38 // by floating device.
39 class XModifierStateWatcher{
41 static XModifierStateWatcher* GetInstance() {
42 return Singleton<XModifierStateWatcher>::get();
45 void UpdateStateFromEvent(const base::NativeEvent& native_event) {
46 // Floating device can't access the modifer state from master device.
47 // We need to track the states of modifier keys in a singleton for
48 // floating devices such as touch screen. Issue 106426 is one example
49 // of why we need the modifier states for floating device.
50 state_ = native_event->xkey.state;
51 // master_state is the state before key press. We need to track the
52 // state after key press for floating device. Currently only ctrl,
53 // shift, alt and caps lock keys are tracked.
54 ui::KeyboardCode keyboard_code = ui::KeyboardCodeFromNative(native_event);
55 unsigned int mask = 0;
57 switch (keyboard_code) {
58 case ui::VKEY_CONTROL: {
62 case ui::VKEY_SHIFT: {
70 case ui::VKEY_CAPITAL: {
78 if (native_event->type == KeyPress)
84 // Returns the current modifer state in master device. It only contains the
85 // state of ctrl, shift, alt and caps lock keys.
86 unsigned int state() { return state_; }
89 friend struct DefaultSingletonTraits<XModifierStateWatcher>;
91 XModifierStateWatcher() : state_(0) { }
95 DISALLOW_COPY_AND_ASSIGN(XModifierStateWatcher);
98 #if defined(USE_XI2_MT)
99 // Detects if a touch event is a driver-generated 'special event'.
100 // A 'special event' is a touch event with maximum radius and pressure at
102 // This needs to be done in a cleaner way: http://crbug.com/169256
103 bool TouchEventIsGeneratedHack(const base::NativeEvent& native_event) {
104 XIDeviceEvent* event =
105 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
106 CHECK(event->evtype == XI_TouchBegin ||
107 event->evtype == XI_TouchUpdate ||
108 event->evtype == XI_TouchEnd);
110 // Force is normalized to [0, 1].
111 if (ui::GetTouchForce(native_event) < 1.0f)
114 if (ui::EventLocationFromNative(native_event) != gfx::Point())
117 // Radius is in pixels, and the valuator is the diameter in pixels.
118 double radius = ui::GetTouchRadiusX(native_event), min, max;
119 unsigned int deviceid =
120 static_cast<XIDeviceEvent*>(native_event->xcookie.data)->sourceid;
121 if (!ui::DeviceDataManager::GetInstance()->GetDataRange(
122 deviceid, ui::DeviceDataManager::DT_TOUCH_MAJOR, &min, &max)) {
126 return radius * 2 == max;
130 int GetEventFlagsFromXState(unsigned int state) {
132 if (state & ControlMask)
133 flags |= ui::EF_CONTROL_DOWN;
134 if (state & ShiftMask)
135 flags |= ui::EF_SHIFT_DOWN;
136 if (state & Mod1Mask)
137 flags |= ui::EF_ALT_DOWN;
138 if (state & LockMask)
139 flags |= ui::EF_CAPS_LOCK_DOWN;
140 if (state & Mod5Mask)
141 flags |= ui::EF_ALTGR_DOWN;
142 if (state & Button1Mask)
143 flags |= ui::EF_LEFT_MOUSE_BUTTON;
144 if (state & Button2Mask)
145 flags |= ui::EF_MIDDLE_MOUSE_BUTTON;
146 if (state & Button3Mask)
147 flags |= ui::EF_RIGHT_MOUSE_BUTTON;
151 // Get the event flag for the button in XButtonEvent. During a ButtonPress
152 // event, |state| in XButtonEvent does not include the button that has just been
153 // pressed. Instead |state| contains flags for the buttons (if any) that had
154 // already been pressed before the current button, and |button| stores the most
155 // current pressed button. So, if you press down left mouse button, and while
156 // pressing it down, press down the right mouse button, then for the latter
157 // event, |state| would have Button1Mask set but not Button3Mask, and |button|
159 int GetEventFlagsForButton(int button) {
162 return ui::EF_LEFT_MOUSE_BUTTON;
164 return ui::EF_MIDDLE_MOUSE_BUTTON;
166 return ui::EF_RIGHT_MOUSE_BUTTON;
172 int GetButtonMaskForX2Event(XIDeviceEvent* xievent) {
174 for (int i = 0; i < 8 * xievent->buttons.mask_len; i++) {
175 if (XIMaskIsSet(xievent->buttons.mask, i)) {
176 int button = (xievent->sourceid == xievent->deviceid) ?
177 ui::DeviceDataManager::GetInstance()->GetMappedButton(i) : i;
178 buttonflags |= GetEventFlagsForButton(button);
184 ui::EventType GetTouchEventType(const base::NativeEvent& native_event) {
185 XIDeviceEvent* event =
186 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
187 #if defined(USE_XI2_MT)
188 switch(event->evtype) {
190 return TouchEventIsGeneratedHack(native_event) ? ui::ET_UNKNOWN :
191 ui::ET_TOUCH_PRESSED;
193 return TouchEventIsGeneratedHack(native_event) ? ui::ET_UNKNOWN :
196 return TouchEventIsGeneratedHack(native_event) ? ui::ET_TOUCH_CANCELLED :
197 ui::ET_TOUCH_RELEASED;
199 #endif // defined(USE_XI2_MT)
201 DCHECK(ui::TouchFactory::GetInstance()->IsTouchDevice(event->sourceid));
202 switch (event->evtype) {
204 return ui::ET_TOUCH_PRESSED;
205 case XI_ButtonRelease:
206 return ui::ET_TOUCH_RELEASED;
208 // Should not convert any emulated Motion event from touch device to
210 if (!(event->flags & XIPointerEmulated) &&
211 GetButtonMaskForX2Event(event))
212 return ui::ET_TOUCH_MOVED;
213 return ui::ET_UNKNOWN;
217 return ui::ET_UNKNOWN;
220 double GetTouchParamFromXEvent(XEvent* xev,
221 ui::DeviceDataManager::DataType val,
222 double default_value) {
223 ui::DeviceDataManager::GetInstance()->GetEventData(
224 *xev, val, &default_value);
225 return default_value;
232 void UpdateDeviceList() {
233 XDisplay* display = gfx::GetXDisplay();
234 DeviceListCacheX::GetInstance()->UpdateDeviceList(display);
235 TouchFactory::GetInstance()->UpdateDeviceList(display);
236 DeviceDataManager::GetInstance()->UpdateDeviceList(display);
239 EventType EventTypeFromNative(const base::NativeEvent& native_event) {
240 switch (native_event->type) {
242 return ET_KEY_PRESSED;
244 return ET_KEY_RELEASED;
246 if (static_cast<int>(native_event->xbutton.button) >= kMinWheelButton &&
247 static_cast<int>(native_event->xbutton.button) <= kMaxWheelButton)
248 return ET_MOUSEWHEEL;
249 return ET_MOUSE_PRESSED;
251 // Drop wheel events; we should've already scrolled on the press.
252 if (static_cast<int>(native_event->xbutton.button) >= kMinWheelButton &&
253 static_cast<int>(native_event->xbutton.button) <= kMaxWheelButton)
255 return ET_MOUSE_RELEASED;
257 if (native_event->xmotion.state &
258 (Button1Mask | Button2Mask | Button3Mask))
259 return ET_MOUSE_DRAGGED;
260 return ET_MOUSE_MOVED;
262 // The standard on Windows is to send a MouseMove event when the mouse
263 // first enters a window instead of sending a special mouse enter event.
264 // To be consistent we follow the same style.
265 return ET_MOUSE_MOVED;
267 return ET_MOUSE_EXITED;
269 TouchFactory* factory = TouchFactory::GetInstance();
270 if (!factory->ShouldProcessXI2Event(native_event))
273 XIDeviceEvent* xievent =
274 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
276 // This check works only for master and floating slave devices. That is
277 // why it is necessary to check for the XI_Touch* events in the following
278 // switch statement to account for attached-slave touchscreens.
279 if (factory->IsTouchDevice(xievent->sourceid))
280 return GetTouchEventType(native_event);
282 switch (xievent->evtype) {
284 return ui::ET_TOUCH_PRESSED;
286 return ui::ET_TOUCH_MOVED;
288 return ui::ET_TOUCH_RELEASED;
289 case XI_ButtonPress: {
290 int button = EventButtonFromNative(native_event);
291 if (button >= kMinWheelButton && button <= kMaxWheelButton)
292 return ET_MOUSEWHEEL;
293 return ET_MOUSE_PRESSED;
295 case XI_ButtonRelease: {
296 int button = EventButtonFromNative(native_event);
297 // Drop wheel events; we should've already scrolled on the press.
298 if (button >= kMinWheelButton && button <= kMaxWheelButton)
300 return ET_MOUSE_RELEASED;
304 if (GetFlingData(native_event, NULL, NULL, NULL, NULL, &is_cancel)) {
305 return is_cancel ? ET_SCROLL_FLING_CANCEL : ET_SCROLL_FLING_START;
306 } else if (DeviceDataManager::GetInstance()->IsScrollEvent(
308 return IsTouchpadEvent(native_event) ? ET_SCROLL : ET_MOUSEWHEEL;
309 } else if (DeviceDataManager::GetInstance()->IsCMTMetricsEvent(
312 } else if (GetButtonMaskForX2Event(xievent)) {
313 return ET_MOUSE_DRAGGED;
315 return ET_MOUSE_MOVED;
326 int EventFlagsFromNative(const base::NativeEvent& native_event) {
327 switch (native_event->type) {
330 XModifierStateWatcher::GetInstance()->UpdateStateFromEvent(native_event);
331 return GetEventFlagsFromXState(native_event->xkey.state);
334 case ButtonRelease: {
335 int flags = GetEventFlagsFromXState(native_event->xbutton.state);
336 const EventType type = EventTypeFromNative(native_event);
337 if (type == ET_MOUSE_PRESSED || type == ET_MOUSE_RELEASED)
338 flags |= GetEventFlagsForButton(native_event->xbutton.button);
343 return GetEventFlagsFromXState(native_event->xcrossing.state);
345 return GetEventFlagsFromXState(native_event->xmotion.state);
347 XIDeviceEvent* xievent =
348 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
350 switch (xievent->evtype) {
351 #if defined(USE_XI2_MT)
355 return GetButtonMaskForX2Event(xievent) |
356 GetEventFlagsFromXState(xievent->mods.effective) |
357 GetEventFlagsFromXState(
358 XModifierStateWatcher::GetInstance()->state());
362 case XI_ButtonRelease: {
364 TouchFactory::GetInstance()->IsTouchDevice(xievent->sourceid);
365 int flags = GetButtonMaskForX2Event(xievent) |
366 GetEventFlagsFromXState(xievent->mods.effective);
368 flags |= GetEventFlagsFromXState(
369 XModifierStateWatcher::GetInstance()->state());
372 const EventType type = EventTypeFromNative(native_event);
373 int button = EventButtonFromNative(native_event);
374 if ((type == ET_MOUSE_PRESSED || type == ET_MOUSE_RELEASED) && !touch)
375 flags |= GetEventFlagsForButton(button);
379 return GetButtonMaskForX2Event(xievent) |
380 GetEventFlagsFromXState(xievent->mods.effective);
387 base::TimeDelta EventTimeFromNative(const base::NativeEvent& native_event) {
388 switch(native_event->type) {
391 return base::TimeDelta::FromMilliseconds(native_event->xkey.time);
394 return base::TimeDelta::FromMilliseconds(native_event->xbutton.time);
397 return base::TimeDelta::FromMilliseconds(native_event->xmotion.time);
401 return base::TimeDelta::FromMilliseconds(native_event->xcrossing.time);
405 double touch_timestamp;
406 if (GetGestureTimes(native_event, &start, &end)) {
407 // If the driver supports gesture times, use them.
408 return base::TimeDelta::FromMicroseconds(end * 1000000);
409 } else if (DeviceDataManager::GetInstance()->GetEventData(*native_event,
410 DeviceDataManager::DT_TOUCH_RAW_TIMESTAMP, &touch_timestamp)) {
411 return base::TimeDelta::FromMicroseconds(touch_timestamp * 1000000);
413 XIDeviceEvent* xide =
414 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
415 return base::TimeDelta::FromMilliseconds(xide->time);
421 return base::TimeDelta();
424 gfx::Point EventLocationFromNative(const base::NativeEvent& native_event) {
425 switch (native_event->type) {
428 return gfx::Point(native_event->xcrossing.x, native_event->xcrossing.y);
431 return gfx::Point(native_event->xbutton.x, native_event->xbutton.y);
433 return gfx::Point(native_event->xmotion.x, native_event->xmotion.y);
435 XIDeviceEvent* xievent =
436 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
437 return gfx::Point(static_cast<int>(xievent->event_x),
438 static_cast<int>(xievent->event_y));
444 gfx::Point EventSystemLocationFromNative(
445 const base::NativeEvent& native_event) {
446 switch (native_event->type) {
449 return gfx::Point(native_event->xcrossing.x_root,
450 native_event->xcrossing.y_root);
453 case ButtonRelease: {
454 return gfx::Point(native_event->xbutton.x_root,
455 native_event->xbutton.y_root);
458 return gfx::Point(native_event->xmotion.x_root,
459 native_event->xmotion.y_root);
462 XIDeviceEvent* xievent =
463 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
464 return gfx::Point(xievent->root_x, xievent->root_y);
471 int EventButtonFromNative(const base::NativeEvent& native_event) {
472 CHECK_EQ(GenericEvent, native_event->type);
473 XIDeviceEvent* xievent =
474 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
475 int button = xievent->detail;
477 return (xievent->sourceid == xievent->deviceid) ?
478 DeviceDataManager::GetInstance()->GetMappedButton(button) : button;
481 KeyboardCode KeyboardCodeFromNative(const base::NativeEvent& native_event) {
482 return KeyboardCodeFromXKeyEvent(native_event);
485 const char* CodeFromNative(const base::NativeEvent& native_event) {
486 return CodeFromXEvent(native_event);
489 int GetChangedMouseButtonFlagsFromNative(
490 const base::NativeEvent& native_event) {
491 switch (native_event->type) {
494 return GetEventFlagsFromXState(native_event->xbutton.state);
496 XIDeviceEvent* xievent =
497 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
498 switch (xievent->evtype) {
500 case XI_ButtonRelease:
501 return GetEventFlagsForButton(EventButtonFromNative(native_event));
512 gfx::Vector2d GetMouseWheelOffset(const base::NativeEvent& native_event) {
513 float x_offset, y_offset;
514 if (GetScrollOffsets(
515 native_event, &x_offset, &y_offset, NULL, NULL, NULL)) {
516 return gfx::Vector2d(static_cast<int>(x_offset),
517 static_cast<int>(y_offset));
520 int button = native_event->type == GenericEvent ?
521 EventButtonFromNative(native_event) : native_event->xbutton.button;
525 return gfx::Vector2d(0, kWheelScrollAmount);
527 return gfx::Vector2d(0, -kWheelScrollAmount);
529 // TODO(derat): Do something for horizontal scrolls (buttons 6 and 7)?
530 return gfx::Vector2d();
534 void ClearTouchIdIfReleased(const base::NativeEvent& xev) {
535 ui::EventType type = ui::EventTypeFromNative(xev);
536 if (type == ui::ET_TOUCH_CANCELLED ||
537 type == ui::ET_TOUCH_RELEASED) {
538 ui::TouchFactory* factory = ui::TouchFactory::GetInstance();
539 ui::DeviceDataManager* manager = ui::DeviceDataManager::GetInstance();
541 if (manager->GetEventData(
542 *xev, ui::DeviceDataManager::DT_TOUCH_TRACKING_ID, &tracking_id)) {
543 factory->ReleaseSlotForTrackingID(tracking_id);
548 int GetTouchId(const base::NativeEvent& xev) {
550 #if defined(ENABLE_XI21_MT)
551 // If using XInput2.1 for multi-touch support, the slot is tracked by the
552 // source id of each device event.
553 XIDeviceEvent* xievent = static_cast<XIDeviceEvent*>(xev->xcookie.data);
554 slot = xievent->sourceid;
556 ui::DeviceDataManager* manager = ui::DeviceDataManager::GetInstance();
558 if (!manager->GetEventData(
559 *xev, ui::DeviceDataManager::DT_TOUCH_TRACKING_ID, &tracking_id)) {
560 LOG(ERROR) << "Could not get the tracking ID for the event. Using 0.";
562 ui::TouchFactory* factory = ui::TouchFactory::GetInstance();
563 slot = factory->GetSlotForTrackingID(tracking_id);
568 float GetTouchRadiusX(const base::NativeEvent& native_event) {
569 return GetTouchParamFromXEvent(native_event,
570 ui::DeviceDataManager::DT_TOUCH_MAJOR, 0.0) / 2.0;
573 float GetTouchRadiusY(const base::NativeEvent& native_event) {
574 return GetTouchParamFromXEvent(native_event,
575 ui::DeviceDataManager::DT_TOUCH_MINOR, 0.0) / 2.0;
578 float GetTouchAngle(const base::NativeEvent& native_event) {
579 return GetTouchParamFromXEvent(native_event,
580 ui::DeviceDataManager::DT_TOUCH_ORIENTATION, 0.0) / 2.0;
583 float GetTouchForce(const base::NativeEvent& native_event) {
585 force = GetTouchParamFromXEvent(native_event,
586 ui::DeviceDataManager::DT_TOUCH_PRESSURE, 0.0);
587 unsigned int deviceid =
588 static_cast<XIDeviceEvent*>(native_event->xcookie.data)->sourceid;
589 // Force is normalized to fall into [0, 1]
590 if (!ui::DeviceDataManager::GetInstance()->NormalizeData(
591 deviceid, ui::DeviceDataManager::DT_TOUCH_PRESSURE, &force))
596 bool GetScrollOffsets(const base::NativeEvent& native_event,
599 float* x_offset_ordinal,
600 float* y_offset_ordinal,
602 if (!DeviceDataManager::GetInstance()->IsScrollEvent(native_event))
605 // Temp values to prevent passing NULLs to DeviceDataManager.
606 float x_offset_, y_offset_;
607 float x_offset_ordinal_, y_offset_ordinal_;
610 x_offset = &x_offset_;
612 y_offset = &y_offset_;
613 if (!x_offset_ordinal)
614 x_offset_ordinal = &x_offset_ordinal_;
615 if (!y_offset_ordinal)
616 y_offset_ordinal = &y_offset_ordinal_;
618 finger_count = &finger_count_;
620 DeviceDataManager::GetInstance()->GetScrollOffsets(
623 x_offset_ordinal, y_offset_ordinal,
628 bool GetFlingData(const base::NativeEvent& native_event,
634 if (!DeviceDataManager::GetInstance()->IsFlingEvent(native_event))
638 float vx_ordinal_, vy_ordinal_;
645 vx_ordinal = &vx_ordinal_;
647 vy_ordinal = &vy_ordinal_;
649 is_cancel = &is_cancel_;
651 DeviceDataManager::GetInstance()->GetFlingData(
652 native_event, vx, vy, vx_ordinal, vy_ordinal, is_cancel);
656 bool GetGestureTimes(const base::NativeEvent& native_event,
659 if (!DeviceDataManager::GetInstance()->HasGestureTimes(native_event))
662 double start_time_, end_time_;
664 start_time = &start_time_;
666 end_time = &end_time_;
668 DeviceDataManager::GetInstance()->GetGestureTimes(
669 native_event, start_time, end_time);
673 void SetNaturalScroll(bool enabled) {
674 DeviceDataManager::GetInstance()->set_natural_scroll_enabled(enabled);
677 bool IsNaturalScrollEnabled() {
678 return DeviceDataManager::GetInstance()->natural_scroll_enabled();
681 bool IsTouchpadEvent(const base::NativeEvent& event) {
682 return DeviceDataManager::GetInstance()->IsTouchpadXInputEvent(event);