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>
12 #include <X11/Xutil.h>
14 #include "base/logging.h"
15 #include "base/memory/singleton.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 & Mod4Mask)
141 flags |= ui::EF_COMMAND_DOWN;
142 if (state & Mod5Mask)
143 flags |= ui::EF_ALTGR_DOWN;
144 if (state & Button1Mask)
145 flags |= ui::EF_LEFT_MOUSE_BUTTON;
146 if (state & Button2Mask)
147 flags |= ui::EF_MIDDLE_MOUSE_BUTTON;
148 if (state & Button3Mask)
149 flags |= ui::EF_RIGHT_MOUSE_BUTTON;
153 int GetEventFlagsFromXKeyEvent(XEvent* xevent) {
154 DCHECK(xevent->type == KeyPress || xevent->type == KeyRelease);
156 #if defined(OS_CHROMEOS)
157 const int ime_fabricated_flag = 0;
159 // XIM fabricates key events for the character compositions by XK_Multi_key.
160 // For example, when a user hits XK_Multi_key, XK_apostrophe, and XK_e in
161 // order to input "é", then XIM generates a key event with keycode=0 and
162 // state=0 for the composition, and the sequence of X11 key events will be
163 // XK_Multi_key, XK_apostrophe, **NoSymbol**, and XK_e.
165 // We have to send these fabricated key events to XIM so it can correctly
166 // handle the character compositions.
167 const bool fabricated_by_xim =
168 xevent->xkey.keycode == 0 && xevent->xkey.state == 0;
169 const int ime_fabricated_flag =
170 fabricated_by_xim ? ui::EF_IME_FABRICATED_KEY : 0;
173 return GetEventFlagsFromXState(xevent->xkey.state) |
174 (IsKeypadKey(XLookupKeysym(&xevent->xkey, 0)) ? ui::EF_NUMPAD_KEY : 0) |
178 // Get the event flag for the button in XButtonEvent. During a ButtonPress
179 // event, |state| in XButtonEvent does not include the button that has just been
180 // pressed. Instead |state| contains flags for the buttons (if any) that had
181 // already been pressed before the current button, and |button| stores the most
182 // current pressed button. So, if you press down left mouse button, and while
183 // pressing it down, press down the right mouse button, then for the latter
184 // event, |state| would have Button1Mask set but not Button3Mask, and |button|
186 int GetEventFlagsForButton(int button) {
189 return ui::EF_LEFT_MOUSE_BUTTON;
191 return ui::EF_MIDDLE_MOUSE_BUTTON;
193 return ui::EF_RIGHT_MOUSE_BUTTON;
199 int GetButtonMaskForX2Event(XIDeviceEvent* xievent) {
201 for (int i = 0; i < 8 * xievent->buttons.mask_len; i++) {
202 if (XIMaskIsSet(xievent->buttons.mask, i)) {
203 int button = (xievent->sourceid == xievent->deviceid) ?
204 ui::DeviceDataManager::GetInstance()->GetMappedButton(i) : i;
205 buttonflags |= GetEventFlagsForButton(button);
211 ui::EventType GetTouchEventType(const base::NativeEvent& native_event) {
212 XIDeviceEvent* event =
213 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
214 #if defined(USE_XI2_MT)
215 switch(event->evtype) {
217 return TouchEventIsGeneratedHack(native_event) ? ui::ET_UNKNOWN :
218 ui::ET_TOUCH_PRESSED;
220 return TouchEventIsGeneratedHack(native_event) ? ui::ET_UNKNOWN :
223 return TouchEventIsGeneratedHack(native_event) ? ui::ET_TOUCH_CANCELLED :
224 ui::ET_TOUCH_RELEASED;
226 #endif // defined(USE_XI2_MT)
228 DCHECK(ui::TouchFactory::GetInstance()->IsTouchDevice(event->sourceid));
229 switch (event->evtype) {
231 return ui::ET_TOUCH_PRESSED;
232 case XI_ButtonRelease:
233 return ui::ET_TOUCH_RELEASED;
235 // Should not convert any emulated Motion event from touch device to
237 if (!(event->flags & XIPointerEmulated) &&
238 GetButtonMaskForX2Event(event))
239 return ui::ET_TOUCH_MOVED;
240 return ui::ET_UNKNOWN;
244 return ui::ET_UNKNOWN;
247 double GetTouchParamFromXEvent(XEvent* xev,
248 ui::DeviceDataManager::DataType val,
249 double default_value) {
250 ui::DeviceDataManager::GetInstance()->GetEventData(
251 *xev, val, &default_value);
252 return default_value;
259 void UpdateDeviceList() {
260 XDisplay* display = gfx::GetXDisplay();
261 DeviceListCacheX::GetInstance()->UpdateDeviceList(display);
262 TouchFactory::GetInstance()->UpdateDeviceList(display);
263 DeviceDataManager::GetInstance()->UpdateDeviceList(display);
266 EventType EventTypeFromNative(const base::NativeEvent& native_event) {
267 switch (native_event->type) {
269 return ET_KEY_PRESSED;
271 return ET_KEY_RELEASED;
273 if (static_cast<int>(native_event->xbutton.button) >= kMinWheelButton &&
274 static_cast<int>(native_event->xbutton.button) <= kMaxWheelButton)
275 return ET_MOUSEWHEEL;
276 return ET_MOUSE_PRESSED;
278 // Drop wheel events; we should've already scrolled on the press.
279 if (static_cast<int>(native_event->xbutton.button) >= kMinWheelButton &&
280 static_cast<int>(native_event->xbutton.button) <= kMaxWheelButton)
282 return ET_MOUSE_RELEASED;
284 if (native_event->xmotion.state &
285 (Button1Mask | Button2Mask | Button3Mask))
286 return ET_MOUSE_DRAGGED;
287 return ET_MOUSE_MOVED;
289 // The standard on Windows is to send a MouseMove event when the mouse
290 // first enters a window instead of sending a special mouse enter event.
291 // To be consistent we follow the same style.
292 return ET_MOUSE_MOVED;
294 return ET_MOUSE_EXITED;
296 TouchFactory* factory = TouchFactory::GetInstance();
297 if (!factory->ShouldProcessXI2Event(native_event))
300 XIDeviceEvent* xievent =
301 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
303 // This check works only for master and floating slave devices. That is
304 // why it is necessary to check for the XI_Touch* events in the following
305 // switch statement to account for attached-slave touchscreens.
306 if (factory->IsTouchDevice(xievent->sourceid))
307 return GetTouchEventType(native_event);
309 switch (xievent->evtype) {
311 return ui::ET_TOUCH_PRESSED;
313 return ui::ET_TOUCH_MOVED;
315 return ui::ET_TOUCH_RELEASED;
316 case XI_ButtonPress: {
317 int button = EventButtonFromNative(native_event);
318 if (button >= kMinWheelButton && button <= kMaxWheelButton)
319 return ET_MOUSEWHEEL;
320 return ET_MOUSE_PRESSED;
322 case XI_ButtonRelease: {
323 int button = EventButtonFromNative(native_event);
324 // Drop wheel events; we should've already scrolled on the press.
325 if (button >= kMinWheelButton && button <= kMaxWheelButton)
327 return ET_MOUSE_RELEASED;
331 if (GetFlingData(native_event, NULL, NULL, NULL, NULL, &is_cancel)) {
332 return is_cancel ? ET_SCROLL_FLING_CANCEL : ET_SCROLL_FLING_START;
333 } else if (DeviceDataManager::GetInstance()->IsScrollEvent(
335 return IsTouchpadEvent(native_event) ? ET_SCROLL : ET_MOUSEWHEEL;
336 } else if (DeviceDataManager::GetInstance()->IsCMTMetricsEvent(
339 } else if (GetButtonMaskForX2Event(xievent)) {
340 return ET_MOUSE_DRAGGED;
342 return ET_MOUSE_MOVED;
353 int EventFlagsFromNative(const base::NativeEvent& native_event) {
354 switch (native_event->type) {
357 XModifierStateWatcher::GetInstance()->UpdateStateFromEvent(native_event);
358 return GetEventFlagsFromXKeyEvent(native_event);
361 case ButtonRelease: {
362 int flags = GetEventFlagsFromXState(native_event->xbutton.state);
363 const EventType type = EventTypeFromNative(native_event);
364 if (type == ET_MOUSE_PRESSED || type == ET_MOUSE_RELEASED)
365 flags |= GetEventFlagsForButton(native_event->xbutton.button);
370 return GetEventFlagsFromXState(native_event->xcrossing.state);
372 return GetEventFlagsFromXState(native_event->xmotion.state);
374 XIDeviceEvent* xievent =
375 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
377 switch (xievent->evtype) {
378 #if defined(USE_XI2_MT)
382 return GetButtonMaskForX2Event(xievent) |
383 GetEventFlagsFromXState(xievent->mods.effective) |
384 GetEventFlagsFromXState(
385 XModifierStateWatcher::GetInstance()->state());
389 case XI_ButtonRelease: {
391 TouchFactory::GetInstance()->IsTouchDevice(xievent->sourceid);
392 int flags = GetButtonMaskForX2Event(xievent) |
393 GetEventFlagsFromXState(xievent->mods.effective);
395 flags |= GetEventFlagsFromXState(
396 XModifierStateWatcher::GetInstance()->state());
399 const EventType type = EventTypeFromNative(native_event);
400 int button = EventButtonFromNative(native_event);
401 if ((type == ET_MOUSE_PRESSED || type == ET_MOUSE_RELEASED) && !touch)
402 flags |= GetEventFlagsForButton(button);
406 return GetButtonMaskForX2Event(xievent) |
407 GetEventFlagsFromXState(xievent->mods.effective);
414 base::TimeDelta EventTimeFromNative(const base::NativeEvent& native_event) {
415 switch(native_event->type) {
418 return base::TimeDelta::FromMilliseconds(native_event->xkey.time);
421 return base::TimeDelta::FromMilliseconds(native_event->xbutton.time);
424 return base::TimeDelta::FromMilliseconds(native_event->xmotion.time);
428 return base::TimeDelta::FromMilliseconds(native_event->xcrossing.time);
432 double touch_timestamp;
433 if (GetGestureTimes(native_event, &start, &end)) {
434 // If the driver supports gesture times, use them.
435 return base::TimeDelta::FromMicroseconds(end * 1000000);
436 } else if (DeviceDataManager::GetInstance()->GetEventData(*native_event,
437 DeviceDataManager::DT_TOUCH_RAW_TIMESTAMP, &touch_timestamp)) {
438 return base::TimeDelta::FromMicroseconds(touch_timestamp * 1000000);
440 XIDeviceEvent* xide =
441 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
442 return base::TimeDelta::FromMilliseconds(xide->time);
448 return base::TimeDelta();
451 gfx::Point EventLocationFromNative(const base::NativeEvent& native_event) {
452 switch (native_event->type) {
455 return gfx::Point(native_event->xcrossing.x, native_event->xcrossing.y);
458 return gfx::Point(native_event->xbutton.x, native_event->xbutton.y);
460 return gfx::Point(native_event->xmotion.x, native_event->xmotion.y);
462 XIDeviceEvent* xievent =
463 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
464 return gfx::Point(static_cast<int>(xievent->event_x),
465 static_cast<int>(xievent->event_y));
471 gfx::Point EventSystemLocationFromNative(
472 const base::NativeEvent& native_event) {
473 switch (native_event->type) {
476 return gfx::Point(native_event->xcrossing.x_root,
477 native_event->xcrossing.y_root);
480 case ButtonRelease: {
481 return gfx::Point(native_event->xbutton.x_root,
482 native_event->xbutton.y_root);
485 return gfx::Point(native_event->xmotion.x_root,
486 native_event->xmotion.y_root);
489 XIDeviceEvent* xievent =
490 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
491 return gfx::Point(xievent->root_x, xievent->root_y);
498 int EventButtonFromNative(const base::NativeEvent& native_event) {
499 CHECK_EQ(GenericEvent, native_event->type);
500 XIDeviceEvent* xievent =
501 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
502 int button = xievent->detail;
504 return (xievent->sourceid == xievent->deviceid) ?
505 DeviceDataManager::GetInstance()->GetMappedButton(button) : button;
508 KeyboardCode KeyboardCodeFromNative(const base::NativeEvent& native_event) {
509 return KeyboardCodeFromXKeyEvent(native_event);
512 const char* CodeFromNative(const base::NativeEvent& native_event) {
513 return CodeFromXEvent(native_event);
516 int GetChangedMouseButtonFlagsFromNative(
517 const base::NativeEvent& native_event) {
518 switch (native_event->type) {
521 return GetEventFlagsFromXState(native_event->xbutton.state);
523 XIDeviceEvent* xievent =
524 static_cast<XIDeviceEvent*>(native_event->xcookie.data);
525 switch (xievent->evtype) {
527 case XI_ButtonRelease:
528 return GetEventFlagsForButton(EventButtonFromNative(native_event));
539 gfx::Vector2d GetMouseWheelOffset(const base::NativeEvent& native_event) {
540 float x_offset, y_offset;
541 if (GetScrollOffsets(
542 native_event, &x_offset, &y_offset, NULL, NULL, NULL)) {
543 return gfx::Vector2d(static_cast<int>(x_offset),
544 static_cast<int>(y_offset));
547 int button = native_event->type == GenericEvent ?
548 EventButtonFromNative(native_event) : native_event->xbutton.button;
552 return gfx::Vector2d(0, kWheelScrollAmount);
554 return gfx::Vector2d(0, -kWheelScrollAmount);
556 return gfx::Vector2d(kWheelScrollAmount, 0);
558 return gfx::Vector2d(-kWheelScrollAmount, 0);
560 return gfx::Vector2d();
564 base::NativeEvent CopyNativeEvent(const base::NativeEvent& event) {
565 if (!event || event->type == GenericEvent)
567 XEvent* copy = new XEvent;
572 void ReleaseCopiedNativeEvent(const base::NativeEvent& event) {
576 void ClearTouchIdIfReleased(const base::NativeEvent& xev) {
577 ui::EventType type = ui::EventTypeFromNative(xev);
578 if (type == ui::ET_TOUCH_CANCELLED ||
579 type == ui::ET_TOUCH_RELEASED) {
580 ui::TouchFactory* factory = ui::TouchFactory::GetInstance();
581 ui::DeviceDataManager* manager = ui::DeviceDataManager::GetInstance();
583 if (manager->GetEventData(
584 *xev, ui::DeviceDataManager::DT_TOUCH_TRACKING_ID, &tracking_id)) {
585 factory->ReleaseSlotForTrackingID(tracking_id);
590 int GetTouchId(const base::NativeEvent& xev) {
592 ui::DeviceDataManager* manager = ui::DeviceDataManager::GetInstance();
594 if (!manager->GetEventData(
595 *xev, ui::DeviceDataManager::DT_TOUCH_TRACKING_ID, &tracking_id)) {
596 LOG(ERROR) << "Could not get the tracking ID for the event. Using 0.";
598 ui::TouchFactory* factory = ui::TouchFactory::GetInstance();
599 slot = factory->GetSlotForTrackingID(tracking_id);
604 float GetTouchRadiusX(const base::NativeEvent& native_event) {
605 return GetTouchParamFromXEvent(native_event,
606 ui::DeviceDataManager::DT_TOUCH_MAJOR, 0.0) / 2.0;
609 float GetTouchRadiusY(const base::NativeEvent& native_event) {
610 return GetTouchParamFromXEvent(native_event,
611 ui::DeviceDataManager::DT_TOUCH_MINOR, 0.0) / 2.0;
614 float GetTouchAngle(const base::NativeEvent& native_event) {
615 return GetTouchParamFromXEvent(native_event,
616 ui::DeviceDataManager::DT_TOUCH_ORIENTATION, 0.0) / 2.0;
619 float GetTouchForce(const base::NativeEvent& native_event) {
621 force = GetTouchParamFromXEvent(native_event,
622 ui::DeviceDataManager::DT_TOUCH_PRESSURE, 0.0);
623 unsigned int deviceid =
624 static_cast<XIDeviceEvent*>(native_event->xcookie.data)->sourceid;
625 // Force is normalized to fall into [0, 1]
626 if (!ui::DeviceDataManager::GetInstance()->NormalizeData(
627 deviceid, ui::DeviceDataManager::DT_TOUCH_PRESSURE, &force))
632 bool GetScrollOffsets(const base::NativeEvent& native_event,
635 float* x_offset_ordinal,
636 float* y_offset_ordinal,
638 if (!DeviceDataManager::GetInstance()->IsScrollEvent(native_event))
641 // Temp values to prevent passing NULLs to DeviceDataManager.
642 float x_offset_, y_offset_;
643 float x_offset_ordinal_, y_offset_ordinal_;
646 x_offset = &x_offset_;
648 y_offset = &y_offset_;
649 if (!x_offset_ordinal)
650 x_offset_ordinal = &x_offset_ordinal_;
651 if (!y_offset_ordinal)
652 y_offset_ordinal = &y_offset_ordinal_;
654 finger_count = &finger_count_;
656 DeviceDataManager::GetInstance()->GetScrollOffsets(
659 x_offset_ordinal, y_offset_ordinal,
664 bool GetFlingData(const base::NativeEvent& native_event,
670 if (!DeviceDataManager::GetInstance()->IsFlingEvent(native_event))
674 float vx_ordinal_, vy_ordinal_;
681 vx_ordinal = &vx_ordinal_;
683 vy_ordinal = &vy_ordinal_;
685 is_cancel = &is_cancel_;
687 DeviceDataManager::GetInstance()->GetFlingData(
688 native_event, vx, vy, vx_ordinal, vy_ordinal, is_cancel);
692 bool GetGestureTimes(const base::NativeEvent& native_event,
695 if (!DeviceDataManager::GetInstance()->HasGestureTimes(native_event))
698 double start_time_, end_time_;
700 start_time = &start_time_;
702 end_time = &end_time_;
704 DeviceDataManager::GetInstance()->GetGestureTimes(
705 native_event, start_time, end_time);
709 bool IsTouchpadEvent(const base::NativeEvent& event) {
710 return DeviceDataManager::GetInstance()->IsTouchpadXInputEvent(event);