1 // Copyright 2013 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 #ifndef UI_EVENTS_X_DEVICE_DATA_MANAGER_H_ 6 #define UI_EVENTS_X_DEVICE_DATA_MANAGER_H_ 7 8 // Generically-named #defines from Xlib is conflicting with symbols in GTest. 9 // So many tests .cc file #undef Bool before including device_data_manager.h, 10 // which makes Bool unrecognized in XInput2.h. 11 #ifndef Bool 12 #define Bool int 13 #endif 14 15 #include <X11/extensions/XInput2.h> 16 17 #include <bitset> 18 #include <map> 19 #include <vector> 20 21 #include "base/basictypes.h" 22 #include "base/event_types.h" 23 #include "ui/events/event_constants.h" 24 #include "ui/events/events_base_export.h" 25 #include "ui/gfx/x/x11_atom_cache.h" 26 27 template <typename T> struct DefaultSingletonTraits; 28 29 typedef union _XEvent XEvent; 30 31 namespace ui { 32 33 // CrOS touchpad metrics gesture types 34 enum GestureMetricsType { 35 kGestureMetricsTypeNoisyGround = 0, 36 kGestureMetricsTypeUnknown, 37 }; 38 39 // A class that extracts and tracks the input events data. It currently handles 40 // mouse, touchpad and touchscreen devices. 41 class EVENTS_BASE_EXPORT DeviceDataManager { 42 public: 43 // Enumerate additional data that one might be interested on an input event, 44 // which are usually wrapped in X valuators. If you modify any of this, 45 // make sure to update the kCachedAtoms data structure in the source file 46 // and the k*Type[Start/End] constants used by IsCMTDataType and 47 // IsTouchDataType. 48 enum DataType { 49 // Define the valuators used the CrOS CMT driver. Used by mice and CrOS 50 // touchpads. 51 DT_CMT_SCROLL_X = 0, // Scroll amount on the X (horizontal) direction. 52 DT_CMT_SCROLL_Y, // Scroll amount on the Y (vertical) direction. 53 DT_CMT_ORDINAL_X, // Original (unaccelerated) value on the X direction. 54 // Can be used both for scrolls and flings. 55 DT_CMT_ORDINAL_Y, // Original (unaccelerated) value on the Y direction. 56 // Can be used both for scrolls and flings. 57 DT_CMT_START_TIME, // Gesture start time. 58 DT_CMT_END_TIME, // Gesture end time. 59 DT_CMT_FLING_X, // Fling amount on the X (horizontal) direction. 60 DT_CMT_FLING_Y, // Fling amount on the Y (vertical) direction. 61 DT_CMT_FLING_STATE, // The state of fling gesture (whether the user just 62 // start flinging or that he/she taps down). 63 DT_CMT_METRICS_TYPE, // Metrics type of the metrics gesture, which are 64 // used to wrap interesting patterns that we would 65 // like to track via the UMA system. 66 DT_CMT_METRICS_DATA1, // Complementary data 1 of the metrics gesture. 67 DT_CMT_METRICS_DATA2, // Complementary data 2 of the metrics gesture. 68 DT_CMT_FINGER_COUNT, // Finger counts in the current gesture. A same type 69 // of gesture can have very different meanings based 70 // on that (e.g. 2f scroll v.s. 3f swipe). 71 72 // End of CMT data types. 73 // Beginning of touch data types. 74 75 // Define the valuators following the Multi-touch Protocol. Used by 76 // touchscreen devices. 77 DT_TOUCH_MAJOR, // Length of the touch area. 78 DT_TOUCH_MINOR, // Width of the touch area. 79 DT_TOUCH_ORIENTATION, // Angle between the X-axis and the major axis of the 80 // touch area. 81 DT_TOUCH_PRESSURE, // Pressure of the touch contact. 82 83 // NOTE for XInput MT: 'Tracking ID' is provided in every touch event to 84 // track individual touch. 'Tracking ID' is an unsigned 32-bit value and 85 // is increased for each new touch. It will wrap back to 0 when reaching 86 // the numerical limit. 87 DT_TOUCH_TRACKING_ID, // ID of the touch point. 88 89 // Kernel timestamp from touch screen (if available). 90 DT_TOUCH_RAW_TIMESTAMP, 91 92 // End of touch data types. 93 94 DT_LAST_ENTRY // This must come last. 95 }; 96 97 // Data struct to store extracted data from an input event. 98 typedef std::map<int, double> EventData; 99 100 // We use int because enums can be casted to ints but not vice versa. 101 static bool IsCMTDataType(const int type); 102 static bool IsTouchDataType(const int type); 103 104 // Returns the DeviceDataManager singleton. 105 static DeviceDataManager* GetInstance(); 106 107 // Natural scroll setter/getter. natural_scroll_enabled()108 bool natural_scroll_enabled() const { return natural_scroll_enabled_; } set_natural_scroll_enabled(bool enabled)109 void set_natural_scroll_enabled(bool enabled) { 110 natural_scroll_enabled_ = enabled; 111 } 112 113 // Returns if XInput2 is available on the system. 114 bool IsXInput2Available() const; 115 116 // Get the natural scroll direction multiplier (1.0f or -1.0f). 117 float GetNaturalScrollFactor(int sourceid) const; 118 119 // Updates the list of devices. 120 void UpdateDeviceList(Display* display); 121 122 // For multitouch events we use slot number to distinguish touches from 123 // different fingers. This function returns true if the associated slot 124 // for |xiev| can be found and it is saved in |slot|, returns false if 125 // no slot can be found. 126 bool GetSlotNumber(const XIDeviceEvent* xiev, int* slot); 127 128 // Get all event data in one pass. We extract only data types that we know 129 // about (defined in enum DataType). The data is not processed (e.g. not 130 // filled in by cached values) as in GetEventData. 131 void GetEventRawData(const XEvent& xev, EventData* data); 132 133 // Get a datum of the specified type. Return true and the value 134 // is updated if the data is found, false and value unchanged if the data is 135 // not found. In the case of MT-B/XI2.2, the value can come from a previously 136 // cached one (see the comment above last_seen_valuator_). 137 bool GetEventData(const XEvent& xev, const DataType type, double* value); 138 139 // Check if the event is an XI input event in the strict sense 140 // (i.e. XIDeviceEvent). This rules out things like hierarchy changes, 141 /// device changes, property changes and so on. 142 bool IsXIDeviceEvent(const base::NativeEvent& native_event) const; 143 144 // Check if the event comes from touchpad devices. 145 bool IsTouchpadXInputEvent(const base::NativeEvent& native_event) const; 146 147 // Check if the event comes from devices running CMT driver or using 148 // CMT valuators (e.g. mouses). Note that doesn't necessarily mean the event 149 // is a CMT event (e.g. it could be a mouse pointer move). 150 bool IsCMTDeviceEvent(const base::NativeEvent& native_event) const; 151 152 // Check if the event is one of the CMT gesture events (scroll, fling, 153 // metrics etc.). 154 bool IsCMTGestureEvent(const base::NativeEvent& native_event) const; 155 156 // Returns true if the event is of the specific type, false if not. 157 bool IsScrollEvent(const base::NativeEvent& native_event) const; 158 bool IsFlingEvent(const base::NativeEvent& native_event) const; 159 bool IsCMTMetricsEvent(const base::NativeEvent& native_event) const; 160 161 // Returns true if the event has CMT start/end timestamps. 162 bool HasGestureTimes(const base::NativeEvent& native_event) const; 163 164 // Extract data from a scroll event (a motion event with the necessary 165 // valuators). User must first verify the event type with IsScrollEvent. 166 // Pointers shouldn't be NULL. 167 void GetScrollOffsets(const base::NativeEvent& native_event, 168 float* x_offset, 169 float* y_offset, 170 float* x_offset_ordinal, 171 float* y_offset_ordinal, 172 int* finger_count); 173 174 // Extract data from a fling event. User must first verify the event type 175 // with IsFlingEvent. Pointers shouldn't be NULL. 176 void GetFlingData(const base::NativeEvent& native_event, 177 float* vx, 178 float* vy, 179 float* vx_ordinal, 180 float* vy_ordinal, 181 bool* is_cancel); 182 183 // Extract data from a CrOS metrics gesture event. User must first verify 184 // the event type with IsCMTMetricsEvent. Pointers shouldn't be NULL. 185 void GetMetricsData(const base::NativeEvent& native_event, 186 GestureMetricsType* type, 187 float* data1, 188 float* data2); 189 190 // Returns the mapped button. 191 int GetMappedButton(int button); 192 193 // Updates button mapping. This is usually called when a MappingNotify event 194 // is received. 195 void UpdateButtonMap(); 196 197 // Extract the start/end timestamps from CMT events. User must first verify 198 // the event with HasGestureTimes. Pointers shouldn't be NULL. 199 void GetGestureTimes(const base::NativeEvent& native_event, 200 double* start_time, 201 double* end_time); 202 203 // Normalize the data value on deviceid to fall into [0, 1]. 204 // *value = (*value - min_value_of_tp) / (max_value_of_tp - min_value_of_tp) 205 // Returns true and sets the normalized value in|value| if normalization is 206 // successful. Returns false and |value| is unchanged otherwise. 207 bool NormalizeData(unsigned int deviceid, 208 const DataType type, 209 double* value); 210 211 // Extract the range of the data type. Return true if the range is available 212 // and written into min & max, false if the range is not available. 213 bool GetDataRange(unsigned int deviceid, 214 const DataType type, 215 double* min, 216 double* max); 217 218 // Sets up relevant valuator informations for device ids in the device lists. 219 // This function is only for test purpose. It does not query the X server for 220 // the actual device info, but rather inits the relevant valuator structures 221 // to have safe default values for testing. 222 void SetDeviceListForTest(const std::vector<unsigned int>& touchscreen, 223 const std::vector<unsigned int>& cmt_devices); 224 225 void SetValuatorDataForTest(XIDeviceEvent* xievent, 226 DataType type, 227 double value); 228 229 private: 230 // Requirement for Singleton. 231 friend struct DefaultSingletonTraits<DeviceDataManager>; 232 233 DeviceDataManager(); 234 ~DeviceDataManager(); 235 236 // Initialize the XInput related system information. 237 bool InitializeXInputInternal(); 238 239 // Check if an XI event contains data of the specified type. 240 bool HasEventData(const XIDeviceEvent* xiev, const DataType type) const; 241 242 void InitializeValuatorsForTest(int deviceid, 243 int start_valuator, 244 int end_valuator, 245 double min_value, 246 double max_value); 247 248 static const int kMaxDeviceNum = 128; 249 static const int kMaxXIEventType = XI_LASTEVENT + 1; 250 static const int kMaxSlotNum = 10; 251 bool natural_scroll_enabled_; 252 253 // Major opcode for the XInput extension. Used to identify XInput events. 254 int xi_opcode_; 255 256 // A quick lookup table for determining if the XI event is an XIDeviceEvent. 257 std::bitset<kMaxXIEventType> xi_device_event_types_; 258 259 // A quick lookup table for determining if events from the pointer device 260 // should be processed. 261 std::bitset<kMaxDeviceNum> cmt_devices_; 262 std::bitset<kMaxDeviceNum> touchpads_; 263 264 // Number of valuators on the specific device. 265 int valuator_count_[kMaxDeviceNum]; 266 267 // Index table to find the valuator for DataType on the specific device 268 // by valuator_lookup_[device_id][data_type]. 269 std::vector<int> valuator_lookup_[kMaxDeviceNum]; 270 271 // Index table to find the DataType for valuator on the specific device 272 // by data_type_lookup_[device_id][valuator]. 273 std::vector<int> data_type_lookup_[kMaxDeviceNum]; 274 275 // Index table to find the min & max value of the Valuator on a specific 276 // device. 277 std::vector<double> valuator_min_[kMaxDeviceNum]; 278 std::vector<double> valuator_max_[kMaxDeviceNum]; 279 280 // Table to keep track of the last seen value for the specified valuator for 281 // a specified slot of a device. Defaults to 0 if the valuator for that slot 282 // was not specified in an earlier event. With MT-B/XI2.2, valuators in an 283 // XEvent are not reported if the values haven't changed from the previous 284 // event. So it is necessary to remember these valuators so that chrome 285 // doesn't think X/device doesn't know about the valuators. We currently 286 // use this only on touchscreen devices. 287 std::vector<double> last_seen_valuator_[kMaxDeviceNum][kMaxSlotNum]; 288 289 // X11 atoms cache. 290 X11AtomCache atom_cache_; 291 292 unsigned char button_map_[256]; 293 int button_map_count_; 294 295 DISALLOW_COPY_AND_ASSIGN(DeviceDataManager); 296 }; 297 298 } // namespace ui 299 300 #endif // UI_EVENTS_X_DEVICE_DATA_MANAGER_H_ 301