Merge lp:~chasedouglas/grail/gesture-end-fix into lp:grail

[Chase Douglas]

Fix gesture end handling. Grail now treats physical gesture ending
separately from logical gesture ending. This resolves the bug where tap
gestures end and then further update and end events are erroneously sent.

[Daniel d'Andrada (dandrader)]

Looks ok.

review: Approve

=== modified file 'src/v3/gesture.cpp'
--- src/v3/gesture.cpp	2012-03-14 20:12:00 +0000
+++ src/v3/gesture.cpp	2012-03-16 23:32:20 +0000
@@ -104,7 +104,7 @@
  * Update a gesture with the passed in frame event and list of modified touches
  */
 void Gesture::Update(UFEvent frame_event, TouchSet& modified_touches) {
-  if (ended_) {
+  if (IsPhysicallyEnded()) {
     /* The new event may have given us ownership of all the touches, in which
      * case we need to send all gesture slices to the client */
     if (IsActive())
@@ -194,16 +194,23 @@
 
   /* If the gesture ended and nothing was recognized or all the gesture slices
    * have been sent, end the gesture */
-  if (last_slice_->state() == UGGestureStateEnd &&
+  if (IsPhysicallyEnded() &&
       (!recognized_ || IsConstructionFinished())) {
+    UGSlice* slice = new UGSlice(last_slice_, true);
+    slices_.push(SharedUGSlice(slice));
+    FlushSlices();
     ended_ = true;
     last_slice_.reset();
   }
 
-  if (ended_ && !recognized_)
+  if (IsPhysicallyEnded() && !recognized_)
     canceled_ = true;
 }
 
+bool Gesture::IsPhysicallyEnded() const {
+  return (ended_ || (last_slice_ && last_slice_->physically_ended()));
+}
+
 /**
  * @internal
  * Check if the gesture is active
@@ -243,7 +250,7 @@
 
   /* Create a new gesture slice to tell the client that construction has
    * finished */
-  UGSlice* slice = new UGSlice(last_slice_);
+  UGSlice* slice = new UGSlice(last_slice_, IsPhysicallyEnded());
   if (!slice)
     return;
 
@@ -256,7 +263,7 @@
   FlushSlices();
 
   /* If we construction has finished on an ended gesture, we're done with it */
-  if (last_slice_->state() == UGGestureStateEnd) {
+  if (IsPhysicallyEnded()) {
     ended_ = true;
     last_slice_.reset();
   }
@@ -378,6 +385,7 @@
   while (!slices_.empty())
     slices_.pop();
   last_slice_.reset();
+  ended_ = true;
 }
 
 /**

=== modified file 'src/v3/gesture.h'
--- src/v3/gesture.h	2012-03-14 20:12:00 +0000
+++ src/v3/gesture.h	2012-03-16 23:32:20 +0000
@@ -47,6 +47,7 @@
   void Update(UFEvent event, TouchSet& touches);
   bool IsActive() const;
   bool IsConstructionFinished() const;
+  bool IsPhysicallyEnded() const;
   void FinishConstruction();
   uint64_t Timeout() const;
   float AngleForTouch(UFTouchId touch_id) const;

=== modified file 'src/v3/slice.cpp'
--- src/v3/slice.cpp	2012-03-06 14:13:04 +0000
+++ src/v3/slice.cpp	2012-03-16 23:32:20 +0000
@@ -55,6 +55,7 @@
       touches_(touches),
       time_(frame_event_get_time(event)),
       state_(UGGestureStateBegin),
+      physically_ended_(false),
       original_center_x_(0),
       original_center_y_(0),
       original_radius_(0),
@@ -96,6 +97,7 @@
       touches_(prev->touches_),
       time_(frame_event_get_time(event_)),
       state_(end ? UGGestureStateEnd : UGGestureStateUpdate),
+      physically_ended_(end ? true : prev->physically_ended_),
       original_center_x_(prev->original_center_x_),
       original_center_y_(prev->original_center_y_),
       original_radius_(prev->original_radius_),
@@ -131,6 +133,7 @@
       touches_(touches),
       time_(frame_event_get_time(event)),
       state_(UGGestureStateUpdate),
+      physically_ended_(prev->physically_ended_),
       original_center_x_(prev->original_center_x_),
       original_center_y_(prev->original_center_y_),
       original_radius_(prev->original_radius_),
@@ -414,7 +417,7 @@
   unsigned int touches_min = subscription->touches_min();
   if ((!touches_min && num_active_touches < touches_start) ||
       (touches_min && num_active_touches < touches_min))
-    state_ = UGGestureStateEnd;
+    physically_ended_ = true;
 }
 
 /**
@@ -477,7 +480,7 @@
       CumulativeTime() < subscription.tap().timeout &&
       CumulativeDrag2() < (subscription.tap().threshold *
                            subscription.tap().threshold) &&
-      state_ == UGGestureStateEnd)
+      physically_ended_)
     recognized_ |= UGGestureTypeTap;
 
   if (subscription.mask() & UGGestureTypeTouch)

=== modified file 'src/v3/slice.h'
--- src/v3/slice.h	2012-01-21 00:00:16 +0000
+++ src/v3/slice.h	2012-03-16 23:32:20 +0000
@@ -55,6 +55,7 @@
   const TouchSet& touches() { return touches_; }
   const UFFrame& frame() { return frame_; }
   UGGestureState state() const { return state_; }
+  bool physically_ended() const { return physically_ended_; }
   void set_state(UGGestureState state) { state_ = state; }
   bool construction_finished() const { return construction_finished_; }
   void set_construction_finished() { construction_finished_ = true; }
@@ -70,6 +71,7 @@
   TouchSet touches_;
   uint64_t time_;
   UGGestureState state_;
+  bool physically_ended_;
   float original_center_x_;
   float original_center_y_;
   float original_radius_;

=== modified file 'test/x11/twodrag.cpp'
--- test/x11/twodrag.cpp	2012-03-16 23:32:20 +0000
+++ test/x11/twodrag.cpp	2012-03-16 23:32:20 +0000
@@ -317,6 +317,29 @@
     Slice slice = {
       false, /* skip */
       0, /* UGSlicePropertyID */
+      UGGestureStateUpdate, /* UGSlicePropertyState */
+      UGGestureTypeDrag, /* UGSlicePropertyRecognized */
+      2, /* UGSlicePropertyNumTouches */
+      506.98666, /* UGSlicePropertyOriginalCenterX */
+      189.12, /* UGSlicePropertyOriginalCenterY */
+      59.668739, /* UGSlicePropertyOriginalRadius */
+      {{ 1, 0, 0 },
+       { 0, 1, 0 },
+       { 0, 0, 1 }}, /* UGSlicePropertyTransform */
+      {{ 1.034080, 0.073854253, -12.853333 },
+       { -0.073854253, 1.034080, 397.119995 },
+       { 0, 0, 1 }}, /* UGSlicePropertyCumulativeTransform */
+      0, /* UGSlicePropertyCenterOfRotationX */
+      0, /* UGSlicePropertyCenterOfRotationY */
+      true, /* UGSlicePropertyConstructionFinished */
+    };
+    events.push_back(slice);
+  }
+
+  {
+    Slice slice = {
+      false, /* skip */
+      0, /* UGSlicePropertyID */
       UGGestureStateEnd, /* UGSlicePropertyState */
       UGGestureTypeDrag, /* UGSlicePropertyRecognized */
       2, /* UGSlicePropertyNumTouches */