Merge lp:~dandrader/frame/non_x11_accept into lp:frame

[Daniel d'Andrada]

new: frame_accept_touch() and frame_reject_touch()

So that grail code can be completely backend-agnostic.

new: frame_accept_touch() and frame_reject_touch()

So that grail code can be completely backend-agnostic.

With that in place we can run tests in grail using frame_backend.h instead of a frame mock (as it is currently) to create the frame events.

[Stephen M. Webb (bregma)]

OK.

I don't see any tests for the case of no X11, but the test coverage there is incomplete anyways.

review: Approve

=== modified file 'configure.ac'
--- configure.ac	2012-11-29 15:30:50 +0000
+++ configure.ac	2012-12-05 14:06:20 +0000
@@ -1,7 +1,7 @@
 # Initialize Autoconf
 AC_PREREQ([2.60])
 AC_INIT([Touch Frame Library],
-        [2.4.4],
+        [2.5.0],
         [],
         [frame])
 AC_CONFIG_SRCDIR([Makefile.am])

=== modified file 'debian/libframe6.symbols'
--- debian/libframe6.symbols	2012-11-22 22:16:27 +0000
+++ debian/libframe6.symbols	2012-12-05 14:06:20 +0000
@@ -1,6 +1,9 @@
 libframe.so.6 libframe6 #MINVER#
  FRAME_2.2@FRAME_2.2 2.2.0
  FRAME_2.4@FRAME_2.4 2.4.3
+ FRAME_2.5@FRAME_2.5 2.5.0
+ frame_accept_touch@FRAME_2.5 2.5.0
+ frame_reject_touch@FRAME_2.5 2.5.0
  frame_axis_get_maximum@FRAME_2.2 2.2.4
  frame_axis_get_minimum@FRAME_2.2 2.2.4
  frame_axis_get_resolution@FRAME_2.2 2.2.4

=== modified file 'include/oif/frame.h.in'
--- include/oif/frame.h.in	2012-11-20 14:13:20 +0000
+++ include/oif/frame.h.in	2012-12-05 14:06:20 +0000
@@ -741,6 +741,43 @@
 FRAME_PUBLIC
 uint64_t frame_touch_get_start_time(UFTouch touch);
 
+/**
+ * Accept ownership of a touch
+ *
+ * All touches received should be eventally accepted or rejected.
+ * This decision can come even after they have already ended but
+ * should be done as soon as possible.
+ *
+ * You should accept a touch when you're going to use it and
+ * reject it if you're not interested in it.
+ *
+ * Not all window servers have this concept. Those that do use
+ * this information to pass rejected touches forward to other
+ * clients that might want it.
+ *
+ * @param [in] device The device object for the touch (const)
+ * @param [in] window The window to accept the touch for
+ * @param [in] touch_id The touch ID object for the touch
+ * @return UFStatusSuccess, UFStatusErrorInvalidTouch
+ * @see frame_reject_touch
+ */
+FRAME_PUBLIC
+UFStatus frame_accept_touch(UFDevice device, UFWindowId window,
+                            UFTouchId touch_id);
+
+/**
+ * Reject ownership of a touch
+ *
+ * @param [in] device The device object for the touch (const)
+ * @param [in] window The window to reject the touch for
+ * @param [in] touch_id The touch ID object for the touch
+ * @return UFStatusSuccess, UFStatusErrorInvalidTouch
+ * @see frame_accept_touch
+ */
+FRAME_PUBLIC
+UFStatus frame_reject_touch(UFDevice device, UFWindowId window,
+                            UFTouchId touch_id);
+
 /** @} */
 
 #include "frame_internal.h"

=== modified file 'include/oif/frame_x11.h'
--- include/oif/frame_x11.h	2012-07-24 21:36:05 +0000
+++ include/oif/frame_x11.h	2012-12-05 14:06:20 +0000
@@ -71,6 +71,7 @@
 /**
  * Accept ownership of a touch
  *
+ * @deprecated Use frame_accept_touch instead.
  * @param [in] device The device object for the touch (const)
  * @param [in] window The window to accept the touch for
  * @param [in] touch_id The touch ID object for the touch
@@ -83,6 +84,7 @@
 /**
  * Reject ownership of a touch
  *
+ * @deprecated Use frame_reject_touch instead.
  * @param [in] device The device object for the touch (const)
  * @param [in] window The window to reject the touch for
  * @param [in] touch_id The touch ID object for the touch

=== modified file 'src/device.cpp'
--- src/device.cpp	2012-08-29 18:53:37 +0000
+++ src/device.cpp	2012-12-05 14:06:20 +0000
@@ -51,6 +51,20 @@
   return UFStatusSuccess;
 }
 
+UFStatus UFDevice::AcceptTouch(UFWindowId window_id, UFTouchId touch_id)
+{
+    (void)window_id;
+    (void)touch_id;
+    return UFStatusSuccess;
+}
+
+UFStatus UFDevice::RejectTouch(UFWindowId window_id, UFTouchId touch_id)
+{
+    (void)window_id;
+    (void)touch_id;
+    return UFStatusSuccess;
+}
+
 } // namespace frame
 } // namespace oif
 
@@ -143,6 +157,20 @@
   return resolution;
 }
 
+UFStatus frame_accept_touch(UFDevice device, UFWindowId window_id,
+                            UFTouchId touch_id)
+{
+  return static_cast<oif::frame::UFDevice*>(device)->
+      AcceptTouch(window_id, touch_id);
+}
+
+UFStatus frame_reject_touch(UFDevice device, UFWindowId window_id,
+                            UFTouchId touch_id)
+{
+  return static_cast<oif::frame::UFDevice*>(device)->
+      RejectTouch(window_id, touch_id);
+}
+
 UFBackendDevice frame_backend_device_new()
 {
   return new UFBackendDevice_(new oif::frame::UFDevice);

=== modified file 'src/device.h'
--- src/device.h	2012-08-28 18:20:51 +0000
+++ src/device.h	2012-12-05 14:06:20 +0000
@@ -55,6 +55,9 @@
   typedef std::unique_ptr<UFAxis> UniqueUFAxis;
 
   std::map<UFAxisType, UniqueUFAxis> axes_;
+
+  virtual UFStatus AcceptTouch(UFWindowId window_id, UFTouchId touch_id);
+  virtual UFStatus RejectTouch(UFWindowId window_id, UFTouchId touch_id);
 };
 
 } // namespace frame

=== modified file 'src/libframe.ver'
--- src/libframe.ver	2012-11-26 19:55:29 +0000
+++ src/libframe.ver	2012-12-05 14:06:20 +0000
@@ -103,3 +103,9 @@
     frame_event_set_frame;
     frame_event_set_time;
 } FRAME_2.2;
+
+FRAME_2.5 {
+  global:
+    frame_accept_touch;
+    frame_reject_touch;
+} FRAME_2.4;

=== modified file 'src/x11/device_x11.cpp'
--- src/x11/device_x11.cpp	2012-08-28 19:25:07 +0000
+++ src/x11/device_x11.cpp	2012-12-05 14:06:20 +0000
@@ -179,9 +179,10 @@
   return false;
 }
 
-UFStatus UFDeviceX11::AcceptTouch(::Window window_id,
-                                  UFTouchId touch_id) const {
-  auto it = windows_.find(window_id);
+UFStatus UFDeviceX11::AcceptTouch(UFWindowId window_id,
+                                  UFTouchId touch_id) {
+  ::Window x11_window_id = frame_x11_get_window_id(window_id);
+  auto it = windows_.find(x11_window_id);
   if (it != windows_.end()) {
     WindowX11* window = static_cast<WindowX11*>(it->second.get());
     return window->AcceptTouch(touch_id);
@@ -190,9 +191,10 @@
   return UFStatusErrorInvalidTouch;
 }
 
-UFStatus UFDeviceX11::RejectTouch(::Window window_id,
-                                  UFTouchId touch_id) const {
-  auto it = windows_.find(window_id);
+UFStatus UFDeviceX11::RejectTouch(UFWindowId window_id,
+                                  UFTouchId touch_id) {
+  ::Window x11_window_id = frame_x11_get_window_id(window_id);
+  auto it = windows_.find(x11_window_id);
   if (it != windows_.end()) {
     WindowX11* window = static_cast<WindowX11*>(it->second.get());
     return window->RejectTouch(touch_id);
@@ -212,18 +214,18 @@
 
 extern "C" {
 
-UFStatus frame_x11_accept_touch(UFDevice device, UFWindowId window,
+UFStatus frame_x11_accept_touch(UFDevice device, UFWindowId window_id,
                                 UFTouchId touch_id) {
   oif::frame::UFDeviceX11* device_x11 =
       static_cast<oif::frame::UFDeviceX11*>(device);
-  return device_x11->AcceptTouch(frame_x11_get_window_id(window), touch_id);
+  return device_x11->AcceptTouch(window_id, touch_id);
 }
 
-UFStatus frame_x11_reject_touch(UFDevice device, UFWindowId window,
+UFStatus frame_x11_reject_touch(UFDevice device, UFWindowId window_id,
                                 UFTouchId touch_id) {
   oif::frame::UFDeviceX11* device_x11 =
       static_cast<oif::frame::UFDeviceX11*>(device);
-  return device_x11->RejectTouch(frame_x11_get_window_id(window), touch_id);
+  return device_x11->RejectTouch(window_id, touch_id);
 }
 
 } // extern "C"

=== modified file 'src/x11/device_x11.h'
--- src/x11/device_x11.h	2012-06-21 19:41:40 +0000
+++ src/x11/device_x11.h	2012-12-05 14:06:20 +0000
@@ -45,8 +45,8 @@
   bool HandleDeviceEvent(const XIDeviceEvent* event, SharedUFFrame* frame);
   bool HandleOwnershipEvent(const XITouchOwnershipEvent* event,
                             SharedUFFrame* frame);
-  UFStatus AcceptTouch(::Window window_id, UFTouchId touch_id) const;
-  UFStatus RejectTouch(::Window window_id, UFTouchId touch_id) const;
+  virtual UFStatus AcceptTouch(UFWindowId window_id, UFTouchId touch_id);
+  virtual UFStatus RejectTouch(UFWindowId window_id, UFTouchId touch_id);
   void ReleaseFrames();
 
   UFDeviceX11(const UFDeviceX11&) = delete;

=== modified file 'test/regular/Makefile.am'
--- test/regular/Makefile.am	2012-11-20 14:13:20 +0000
+++ test/regular/Makefile.am	2012-12-05 14:06:20 +0000
@@ -46,6 +46,7 @@
 if HAVE_XINPUT
 check_regular_SOURCES += \
 	accept-ended-touch.cpp \
+    x11-accept-touch.cpp \
 	frame-x11-fixture.cpp \
 	frame-x11-fixture.h
 endif

=== added file 'test/regular/x11-accept-touch.cpp'
--- test/regular/x11-accept-touch.cpp	1970-01-01 00:00:00 +0000
+++ test/regular/x11-accept-touch.cpp	2012-12-05 14:06:20 +0000
@@ -0,0 +1,86 @@
+#include "frame-x11-fixture.h"
+#include "x11_mocks.h"
+
+class X11TouchAcceptance : public FrameX11Fixture
+{
+};
+
+/*
+ Calls frame_accept_touch and check if the corresponding X11 call is made
+ */
+TEST_F(X11TouchAcceptance, Accept)
+{
+  UFStatus status;
+  UFDevice device;
+
+  xmock_server_time = 1234;
+
+  CreateXMockTouchScreenDevice();
+
+  Display *display = XOpenDisplay(NULL);
+
+  status = frame_x11_new(display, &frame_handle);
+  ASSERT_EQ(UFStatusSuccess, status);
+
+  FetchDeviceAddedEvent(&device);
+  AssertNoMoreEvents();
+
+  SendTouchEvent(XI_TouchBegin, 1, 10.0f, 10.0f);
+  SendTouchOwnershipEvent(1);
+
+  UFWindowId frame_window_id = frame_x11_create_window_id(DefaultRootWindow(display));
+  status = frame_accept_touch(device, frame_window_id, 1);
+  ASSERT_EQ(UFStatusSuccess, status);
+
+  ASSERT_EQ(XIAcceptTouch,
+            xmock_get_touch_acceptance(xmock_devices[0].attachment /* device id */,
+                                       1 /* touch id */,
+                                       DefaultRootWindow(display)));
+
+  frame_x11_delete(frame_handle);
+  frame_handle = nullptr;
+
+  XCloseDisplay(display);
+
+  DestroyXMockDevices();
+}
+
+/*
+ Calls frame_reject_touch and check if the corresponding X11 call is made
+ */
+TEST_F(X11TouchAcceptance, Reject)
+{
+  UFStatus status;
+  UFDevice device;
+
+  xmock_server_time = 1234;
+
+  CreateXMockTouchScreenDevice();
+
+  Display *display = XOpenDisplay(NULL);
+
+  status = frame_x11_new(display, &frame_handle);
+  ASSERT_EQ(UFStatusSuccess, status);
+
+  FetchDeviceAddedEvent(&device);
+  AssertNoMoreEvents();
+
+  SendTouchEvent(XI_TouchBegin, 1, 10.0f, 10.0f);
+  SendTouchOwnershipEvent(1);
+
+  UFWindowId frame_window_id = frame_x11_create_window_id(DefaultRootWindow(display));
+  status = frame_reject_touch(device, frame_window_id, 1);
+  ASSERT_EQ(UFStatusSuccess, status);
+
+  ASSERT_EQ(XIRejectTouch,
+            xmock_get_touch_acceptance(xmock_devices[0].attachment /* device id */,
+                                       1 /* touch id */,
+                                       DefaultRootWindow(display)));
+
+  frame_x11_delete(frame_handle);
+  frame_handle = nullptr;
+
+  XCloseDisplay(display);
+
+  DestroyXMockDevices();
+}