Swipe Gestures for Accessibility

ui/chromeos/touch_exploration_controller.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ui/chromeos/touch_exploration_controller.h"
 
 #include "base/logging.h"
 #include "base/strings/string_number_conversions.h"
 #include "ui/aura/client/cursor_client.h"
 #include "ui/aura/window.h"
@@ skipping 13 matching lines @@
 // touch id remapping yet.
 const int kTouchIdUnassigned = 0;
 
 // The value for initial_touch_id_passthrough_mapping_ if the user has
 // released the first finger but some other fingers are held down. In this
 // state we don't do any touch id remapping, but we distinguish it from the
 // kTouchIdUnassigned state because we don't want to assign
 // initial_touch_id_passthrough_mapping_ a touch id anymore,
 // until all fingers are released.
 const int kTouchIdNone = -1;
+
+// In ChromeOS, VKEY_LWIN is synonymous for the search key.
+const ui::KeyboardCode kChromeOSSearchKey = ui::VKEY_LWIN;
 }  // namespace
 
 TouchExplorationController::TouchExplorationController(
     aura::Window* root_window)
     : root_window_(root_window),
       initial_touch_id_passthrough_mapping_(kTouchIdUnassigned),
       state_(NO_FINGERS_DOWN),
       event_handler_for_testing_(NULL),
+      gesture_provider_(this),
       prev_state_(NO_FINGERS_DOWN) {
   CHECK(root_window);
   root_window->GetHost()->GetEventSource()->AddEventRewriter(this);
 }
 
 TouchExplorationController::~TouchExplorationController() {
   root_window_->GetHost()->GetEventSource()->RemoveEventRewriter(this);
 }
 
 void TouchExplorationController::CallTapTimerNowForTesting() {
   DCHECK(tap_timer_.IsRunning());
   tap_timer_.Stop();
   OnTapTimerFired();
 }
 
 void TouchExplorationController::SetEventHandlerForTesting(
     ui::EventHandler* event_handler_for_testing) {
   event_handler_for_testing_ = event_handler_for_testing;
 }
 
 bool TouchExplorationController::IsInNoFingersDownStateForTesting() const {
   return state_ == NO_FINGERS_DOWN;
 }
 
+bool TouchExplorationController::IsInGestureInProgressStateForTesting() const {
+  return state_ == GESTURE_IN_PROGRESS;
+}
+
 ui::EventRewriteStatus TouchExplorationController::RewriteEvent(
     const ui::Event& event,
     scoped_ptr<ui::Event>* rewritten_event) {
   if (!event.IsTouchEvent())
     return ui::EVENT_REWRITE_CONTINUE;
   const ui::TouchEvent& touch_event =
       static_cast<const ui::TouchEvent&>(event);
 
   // If the tap timer should have fired by now but hasn't, run it now and
   // stop the timer. This is important so that behavior is consistent with
@@ skipping 45 matching lines @@
       return InNoFingersDown(touch_event, rewritten_event);
     case SINGLE_TAP_PRESSED:
       return InSingleTapPressed(touch_event, rewritten_event);
     case SINGLE_TAP_RELEASED:
     case TOUCH_EXPLORE_RELEASED:
       return InSingleTapOrTouchExploreReleased(touch_event, rewritten_event);
     case DOUBLE_TAP_PRESSED:
       return InDoubleTapPressed(touch_event, rewritten_event);
     case TOUCH_EXPLORATION:
       return InTouchExploration(touch_event, rewritten_event);
+    case GESTURE_IN_PROGRESS:
+      return InGestureInProgress(touch_event, rewritten_event);
     case PASSTHROUGH_MINUS_ONE:
       return InPassthroughMinusOne(touch_event, rewritten_event);
     case TOUCH_EXPLORE_SECOND_PRESS:
       return InTouchExploreSecondPress(touch_event, rewritten_event);
   }
 
   NOTREACHED();
   return ui::EVENT_REWRITE_CONTINUE;
 }
 
 ui::EventRewriteStatus TouchExplorationController::NextDispatchEvent(
     const ui::Event& last_event, scoped_ptr<ui::Event>* new_event) {
   NOTREACHED();
   return ui::EVENT_REWRITE_CONTINUE;
 }
 
 ui::EventRewriteStatus TouchExplorationController::InNoFingersDown(
     const ui::TouchEvent& event, scoped_ptr<ui::Event>* rewritten_event) {
   const ui::EventType type = event.type();
   if (type == ui::ET_TOUCH_PRESSED) {
     initial_press_.reset(new TouchEvent(event));
     tap_timer_.Start(FROM_HERE,
                      gesture_detector_config_.double_tap_timeout,
                      this,
                      &TouchExplorationController::OnTapTimerFired);
+    gesture_provider_.OnTouchEvent(event);
+    gesture_provider_.OnTouchEventAck(false);
     state_ = SINGLE_TAP_PRESSED;
     VLOG_STATE();
     return ui::EVENT_REWRITE_DISCARD;
   }
 
   NOTREACHED();
   return ui::EVENT_REWRITE_CONTINUE;
 }
 
 ui::EventRewriteStatus TouchExplorationController::InSingleTapPressed(
     const ui::TouchEvent& event, scoped_ptr<ui::Event>* rewritten_event) {
   const ui::EventType type = event.type();
 
   if (type == ui::ET_TOUCH_PRESSED) {
     // Adding a second finger within the timeout period switches to
     // passthrough.
     state_ = PASSTHROUGH_MINUS_ONE;
     VLOG_STATE();
     return InPassthroughMinusOne(event, rewritten_event);
   } else if (type == ui::ET_TOUCH_RELEASED || type == ui::ET_TOUCH_CANCELLED) {
     DCHECK_EQ(0U, current_touch_ids_.size());
     state_ = SINGLE_TAP_RELEASED;
     VLOG_STATE();
     return EVENT_REWRITE_DISCARD;
   } else if (type == ui::ET_TOUCH_MOVED) {
-    // If the user moves far enough from the initial touch location (outside
-    // the "slop" region, jump to the touch exploration mode early.
-    // TODO(evy, lisayin): Add gesture recognition here instead -
-    // we should probably jump to gesture mode here if the velocity is
-    // high enough, and touch exploration if the velocity is lower.
-    float delta = (event.location() - initial_press_->location()).Length();
-    if (delta > gesture_detector_config_.touch_slop) {
-      EnterTouchToMouseMode();
-      state_ = TOUCH_EXPLORATION;
-      VLOG_STATE();
-      return InTouchExploration(event, rewritten_event);
+    float delta_time =
+        (event.time_stamp() - initial_press_->time_stamp()).InSecondsF();
+    float delta_distance =
+        (event.location() - initial_press_->location()).Length();
+    float velocity = delta_distance / delta_time;
+    VLOG(0) << "\n Delta time: " << delta_time
+            << "\n Delta distance: " << delta_distance
+            << "\n Velocity of click: " << velocity
+            << "\n Minimum swipe velocity: "
+            << gesture_detector_config_.minimum_swipe_velocity;
+    if (delta_distance > gesture_detector_config_.touch_slop) {

[tdresser, 2014/06/25 14:48:40]

Invert this condition to reduce nesting.

if (delta_distance <= gesture_detector_config_.touch_slop)
  return EVENT_REWRITE_DISCARD;

[lisayin, 2014/06/25 22:51:05]

Done.

+      // If the user moves fast enough and far enough
+      // from the initial touch location, start gesture detection

[dmazzoni, 2014/06/25 05:06:02]

Nit: end sentence with period.

[lisayin, 2014/06/25 22:51:04]

Done.

+      // Otherwise, if the user moves far enough from the initial touch location
+      // outside the "slop" region, jump to the touch exploration mode early.
+      if (velocity > gesture_detector_config_.minimum_swipe_velocity) {
+        state_ = GESTURE_IN_PROGRESS;
+        VLOG_STATE();
+        return InGestureInProgress(event, rewritten_event);
+      } else {

[tdresser, 2014/06/25 14:48:40]

This "else" is unnecessary.

[lisayin, 2014/06/25 22:51:05]

Done.

+        EnterTouchToMouseMode();
+        state_ = TOUCH_EXPLORATION;
+        VLOG_STATE();
+        return InTouchExploration(event, rewritten_event);
+      }
     }
 
     return EVENT_REWRITE_DISCARD;
   }
   NOTREACHED() << "Unexpected event type received.";
   return ui::EVENT_REWRITE_CONTINUE;
 }
 
 ui::EventRewriteStatus
 TouchExplorationController::InSingleTapOrTouchExploreReleased(
@@ skipping 83 matching lines @@
     NOTREACHED() << "Unexpected event type received.";
     return ui::EVENT_REWRITE_CONTINUE;
   }
 
   // Rewrite as a mouse-move event.
   *rewritten_event = CreateMouseMoveEvent(event.location(), event.flags());
   last_touch_exploration_.reset(new TouchEvent(event));
   return ui::EVENT_REWRITE_REWRITTEN;
 }
 
+ui::EventRewriteStatus TouchExplorationController::InGestureInProgress(
+    const ui::TouchEvent& event, scoped_ptr<ui::Event>* rewritten_event) {
+  ui::EventType type = event.type();
+  if (type == ui::ET_TOUCH_PRESSED ||
+      event.touch_id() != initial_press_->touch_id()) {
+    return ui::EVENT_REWRITE_DISCARD;
+  }
+  if (type == ui::ET_TOUCH_MOVED) {
+    gesture_provider_.OnTouchEvent(event);
+    gesture_provider_.OnTouchEventAck(false);
+   }

[tdresser, 2014/06/25 14:48:40]

Indentation.

[lisayin, 2014/06/25 22:51:05]

Done.

+  if (type == ui::ET_TOUCH_RELEASED || type == ui::ET_TOUCH_CANCELLED) {
+    gesture_provider_.OnTouchEvent(event);
+    gesture_provider_.OnTouchEventAck(true);

[dmazzoni, 2014/06/25 05:06:02]

Are you sure you want to pass true here and false above?

[tdresser, 2014/06/25 14:48:40]

I'm fairly certain this should be "false".

[lisayin, 2014/06/25 22:51:05]

Done.

+    if (current_touch_ids_.size() == 0)
+      ResetToNoFingersDown();
+  }
+  return ui::EVENT_REWRITE_DISCARD;
+}
+
 ui::EventRewriteStatus TouchExplorationController::InPassthroughMinusOne(
     const ui::TouchEvent& event, scoped_ptr<ui::Event>* rewritten_event) {
   ui::EventType type = event.type();
   gfx::PointF location = event.location_f();
 
   if (type == ui::ET_TOUCH_RELEASED || type == ui::ET_TOUCH_CANCELLED) {
     if (current_touch_ids_.size() == 0)
       ResetToNoFingersDown();
 
     if (initial_touch_id_passthrough_mapping_ == kTouchIdUnassigned) {
@@ skipping 63 matching lines @@
     if (current_touch_ids_.size() != 1)
       return EVENT_REWRITE_DISCARD;
 
     // Rewrite at location of last touch exploration.
     rewritten_event->reset(
         new ui::TouchEvent(ui::ET_TOUCH_RELEASED,
                            last_touch_exploration_->location(),
                            initial_press_->touch_id(),
                            event.time_stamp()));
     (*rewritten_event)->set_flags(event.flags());
+    EnterTouchToMouseMode();
     state_ = TOUCH_EXPLORATION;
     VLOG_STATE();
     return ui::EVENT_REWRITE_REWRITTEN;
   }
   NOTREACHED() << "Unexpected event type received.";
   return ui::EVENT_REWRITE_CONTINUE;
 }
 
 void TouchExplorationController::OnTapTimerFired() {
   switch (state_) {
     case SINGLE_TAP_RELEASED:
       ResetToNoFingersDown();
       break;
     case TOUCH_EXPLORE_RELEASED:
       ResetToNoFingersDown();
       last_touch_exploration_.reset(new TouchEvent(*initial_press_));
       return;
     case SINGLE_TAP_PRESSED:
+    case GESTURE_IN_PROGRESS:
       EnterTouchToMouseMode();
+      // Discard any pending gestures.
+      delete gesture_provider_.GetAndResetPendingGestures();
       state_ = TOUCH_EXPLORATION;
       VLOG_STATE();
       break;
     default:
       return;
   }
 
   scoped_ptr<ui::Event> mouse_move = CreateMouseMoveEvent(
       initial_press_->location(), initial_press_->flags());
   DispatchEvent(mouse_move.get());
   last_touch_exploration_.reset(new TouchEvent(*initial_press_));
 }
 
 void TouchExplorationController::DispatchEvent(ui::Event* event) {
   if (event_handler_for_testing_) {
     event_handler_for_testing_->OnEvent(event);
     return;
   }
 
   ui::EventDispatchDetails result ALLOW_UNUSED =
       root_window_->GetHost()->dispatcher()->OnEventFromSource(event);
 }
 
+void TouchExplorationController::OnGestureEvent(ui::GestureEvent* gesture) {
+  CHECK(gesture->IsGestureEvent());
+  VLOG(0) << " \n Gesture Triggered: " << gesture->name();
+  if (tap_timer_.IsRunning())
+    tap_timer_.Stop();
+  switch (gesture->type()) {

[tdresser, 2014/06/25 14:48:40]

Unless you're likely to support other gestures, it would be simpler to just:

if (gesture->type() == ET_GESTURE_SWIPE) {
  OnSwipeEvent(gesture);
  return;
}
if (current_touch_ids_.size()) {
  ...

[lisayin, 2014/06/25 22:51:04]

Done.

+    case ET_GESTURE_SWIPE:
+      OnSwipeEvent(gesture);
+      return;
+    default:
+      if (current_touch_ids_.size() != 0) {

[tdresser, 2014/06/25 14:48:40]

From the style guide: "if one part of an if-else statement uses curly braces,
the other part must too:".

[lisayin, 2014/06/25 22:51:05]

Done.

+        EnterTouchToMouseMode();
+        state_ = TOUCH_EXPLORATION;
+      } else
+        ResetToNoFingersDown();
+      break;
+  }
+}
+
+void TouchExplorationController::OnSwipeEvent(ui::GestureEvent* swipe_gesture) {
+  // A swipe gesture contains details for the direction in which the swipe
+  // occurred.
+  GestureEventDetails event_details = swipe_gesture->details();
+  if (event_details.swipe_left()) {
+    DispatchShiftSearchKeyEvent(ui::VKEY_LEFT);
+    return;
+  } else if (event_details.swipe_right()) {
+    DispatchShiftSearchKeyEvent(ui::VKEY_RIGHT);
+    return;
+  } else if (event_details.swipe_up()) {
+    DispatchShiftSearchKeyEvent(ui::VKEY_UP);
+    return;
+  } else if (event_details.swipe_down()) {
+    DispatchShiftSearchKeyEvent(ui::VKEY_DOWN);
+    return;
+  }
+}
+
+void TouchExplorationController::DispatchShiftSearchKeyEvent(
+    const ui::KeyboardCode direction) {
+  // In order to activate the shortcut shift+search+<arrow key>
+  // three KeyPressed events must be dispatched in succession along
+  // with three KeyReleased events.
+  DispatchEvent(new ui::KeyEvent(
+      ui::ET_KEY_PRESSED, ui::VKEY_SHIFT, ui::EF_SHIFT_DOWN, false));
+  DispatchEvent(new ui::KeyEvent(
+      ui::ET_KEY_PRESSED, kChromeOSSearchKey, ui::EF_SHIFT_DOWN, false));
+  DispatchEvent(new ui::KeyEvent(
+      ui::ET_KEY_PRESSED, direction, ui::EF_SHIFT_DOWN, false));
+
+  DispatchEvent(new ui::KeyEvent(
+      ui::ET_KEY_RELEASED, direction, ui::EF_SHIFT_DOWN, false));
+  DispatchEvent(new ui::KeyEvent(
+      ui::ET_KEY_RELEASED, kChromeOSSearchKey, ui::EF_SHIFT_DOWN, false));
+  DispatchEvent(new ui::KeyEvent(
+      ui::ET_KEY_RELEASED, ui::VKEY_SHIFT, ui::EF_NONE, false));
+}
+
 scoped_ptr<ui::Event> TouchExplorationController::CreateMouseMoveEvent(
     const gfx::PointF& location,
     int flags) {
   return scoped_ptr<ui::Event>(
       new ui::MouseEvent(
           ui::ET_MOUSE_MOVED,
           location,
           location,
           flags | ui::EF_IS_SYNTHESIZED | ui::EF_TOUCH_ACCESSIBILITY,
           0));
 }
 
 void TouchExplorationController::EnterTouchToMouseMode() {
   aura::client::CursorClient* cursor_client =
       aura::client::GetCursorClient(root_window_);
   if (cursor_client && !cursor_client->IsMouseEventsEnabled())
     cursor_client->EnableMouseEvents();
   if (cursor_client && cursor_client->IsCursorVisible())
     cursor_client->HideCursor();
 }
 
 void TouchExplorationController::ResetToNoFingersDown() {
+  scoped_ptr<ScopedVector<ui::GestureEvent> > gestures;
+  gestures.reset(gesture_provider_.GetAndResetPendingGestures());
+  if (gestures != NULL) {
+    for (ScopedVector<GestureEvent>::iterator i = gestures->begin();
+         i != gestures->end();
+         ++i) {
+      OnGestureEvent(*i);

[tdresser, 2014/06/25 14:48:40]

Just making sure - there's no way that OnGestureEvent could cause an
aura::Window to be destroyed, is there?

[dmazzoni, 2014/06/25 15:39:44]

As of this change, no - but in the future you should be able to control the
whole computer with accessibility gestures and it's quite possible a gesture
could result in closing a Window. What's your concern exactly?

[tdresser, 2014/06/25 15:57:31]

That would make things tricky.

If GetAndResetPendingGestures returns several gestures, and one of them destroys
a window, the later gestures will try to target to the destroyed Window. This
causes some nasty crashes. 

We process this list here:
https://code.google.com/p/chromium/codesearch#chromium/src/ui/aura/window_eve...
normally, and in that case, we check if the event target has been destroyed
after each gesture is sent, and stop processing gestures if that is the case.

[tdresser, 2014/06/25 16:06:12]

Though depending on how you target the command to destroy the window, it might
work fine.

+    }
+  }
   state_ = NO_FINGERS_DOWN;
   initial_touch_id_passthrough_mapping_ = kTouchIdUnassigned;
   VLOG_STATE();
   if (tap_timer_.IsRunning())
     tap_timer_.Stop();
 }
 
 void TouchExplorationController::VlogState(const char* function_name) {
   if (prev_state_ == state_)
     return;
@@ skipping 28 matching lines @@
     case SINGLE_TAP_PRESSED:
       return "SINGLE_TAP_PRESSED";
     case SINGLE_TAP_RELEASED:
       return "SINGLE_TAP_RELEASED";
     case TOUCH_EXPLORE_RELEASED:
       return "TOUCH_EXPLORE_RELEASED";
     case DOUBLE_TAP_PRESSED:
       return "DOUBLE_TAP_PRESSED";
     case TOUCH_EXPLORATION:
       return "TOUCH_EXPLORATION";
+    case GESTURE_IN_PROGRESS:
+      return "GESTURE_IN_PROGRESS";
     case PASSTHROUGH_MINUS_ONE:
       return "PASSTHROUGH_MINUS_ONE";
     case TOUCH_EXPLORE_SECOND_PRESS:
       return "TOUCH_EXPLORE_SECOND_PRESS";
   }
   return "Not a state";
 }
 
 std::string TouchExplorationController::EnumEventTypeToString(
     ui::EventType type) {
   // Add more cases later. For now, these are the most frequently seen
   // event types.
   switch (type) {
     case ET_TOUCH_RELEASED:
       return "ET_TOUCH_RELEASED";
     case ET_TOUCH_PRESSED:
       return "ET_TOUCH_PRESSED";
     case ET_TOUCH_MOVED:
       return "ET_TOUCH_MOVED";
     case ET_TOUCH_CANCELLED:
       return "ET_TOUCH_CANCELLED";
     default:
       return base::IntToString(type);
   }
 }
 
 }  // namespace ui