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