ui/events/x/device_list_cache_x.h

   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 #ifndef UI_EVENTS_X_DEVICE_LIST_CACHE_X_H_
   6 #define UI_EVENTS_X_DEVICE_LIST_CACHE_X_H_
   7
   8 #include <X11/extensions/XInput.h>
   9 #include <X11/extensions/XInput2.h>
  10
  11 #include <map>
  12
  13 #include "base/basictypes.h"
  14 #include "ui/events/events_base_export.h"
  15
  16 template <typename T> struct DefaultSingletonTraits;
  17
  18 typedef struct _XDisplay Display;
  19
  20 template <typename T>
  21 struct DeviceList {
  22   DeviceList() : devices(NULL), count(0) {
  23   }
  24   T& operator[] (int x) {
  25     return devices[x];
  26   }
  27   T* devices;
  28   int count;
  29 };
  30
  31 typedef struct DeviceList<XDeviceInfo> XDeviceList;
  32 typedef struct DeviceList<XIDeviceInfo> XIDeviceList;
  33
  34 namespace ui {
  35
  36 // A class to cache the current XInput device list. This minimized the
  37 // round-trip time to the X server whenever such a device list is needed. The
  38 // update function will be called on each incoming XI_HierarchyChanged event.
  39 class EVENTS_BASE_EXPORT DeviceListCacheX {
  40  public:
  41   static DeviceListCacheX* GetInstance();
  42
  43   void UpdateDeviceList(Display* display);
  44
  45   // Returns the list of devices associated with |display|. Uses the old X11
  46   // protocol to get the list of the devices.
  47   const XDeviceList& GetXDeviceList(Display* display);
  48
  49   // Returns the list of devices associated with |display|. Uses the newer
  50   // XINPUT2 protocol to get the list of devices. Before making this call, make
  51   // sure that XInput2 support is available (e.g. by calling
  52   // IsXInput2Available()).
  53   const XIDeviceList& GetXI2DeviceList(Display* display);
  54
  55  private:
  56   friend struct DefaultSingletonTraits<DeviceListCacheX>;
  57
  58   DeviceListCacheX();
  59   ~DeviceListCacheX();
  60
  61   std::map<Display*, XDeviceList> x_dev_list_map_;
  62   std::map<Display*, XIDeviceList> xi_dev_list_map_;
  63
  64   DISALLOW_COPY_AND_ASSIGN(DeviceListCacheX);
  65 };
  66
  67 }  // namespace ui
  68
  69 #endif  // UI_EVENTS_X_DEVICE_LIST_CACHE_X_H_
  70