ash: Refactor autoclick common code to ash/autoclick/common.

ash/autoclick/common/autoclick_controller_common.cc

+// Copyright 2013 The Chromium Authors. All rights reserved.

[sadrul, 2016/08/12 15:00:35]

2016

[riajiang, 2016/08/12 16:31:38]

Done.

+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "ash/autoclick/common/autoclick_controller_common.h"
+
+#include "ui/aura/env.h"
+#include "ui/aura/window.h"
+#include "ui/events/event.h"
+#include "ui/events/event_constants.h"
+#include "ui/gfx/geometry/vector2d.h"
+#include "ui/wm/core/coordinate_conversion.h"
+
+namespace ash {
+
+namespace {
+
+// The threshold of mouse movement measured in DIP that will
+// initiate a new autoclick.
+const int kMovementThreshold = 20;
+
+}  // namespace
+
+AutoclickControllerCommon::AutoclickControllerCommon(base::TimeDelta delay,
+                                                     Delegate* delegate)
+    : delay_(delay),
+      mouse_event_flags_(ui::EF_NONE),
+      delegate_(delegate),
+      widget_(nullptr),
+      anchor_location_(-kMovementThreshold, -kMovementThreshold),
+      autoclick_ring_handler_(new AutoclickRingHandler()) {
+  InitClickTimer();
+}
+
+AutoclickControllerCommon::~AutoclickControllerCommon() {}
+
+void AutoclickControllerCommon::HandleMouseEvent(const ui::MouseEvent& event) {
+  gfx::Point mouse_location = event.location();
+  if (event.type() == ui::ET_MOUSE_MOVED &&
+      !(event.flags() & ui::EF_IS_SYNTHESIZED)) {
+    mouse_event_flags_ = event.flags();
+
+    ::wm::ConvertPointToScreen(static_cast<aura::Window*>(event.target()),
+                               &mouse_location);
+    GetAutoclickRingWidget(mouse_location);
+
+    // The distance between the mouse location and the anchor location
+    // must exceed a certain threshold to initiate a new autoclick countdown.
+    // This ensures that mouse jitter caused by poor motor control does not
+    // 1. initiate an unwanted autoclick from rest
+    // 2. prevent the autoclick from ever occuring when the mouse
+    //    arrives at the target.
+    gfx::Vector2d delta = mouse_location - anchor_location_;
+    if (delta.LengthSquared() >= kMovementThreshold * kMovementThreshold) {
+      anchor_location_ = mouse_location;
+      autoclick_timer_->Reset();
+      autoclick_ring_handler_->StartGesture(delay_, anchor_location_, widget_);
+    } else if (autoclick_timer_->IsRunning()) {
+      autoclick_ring_handler_->SetGestureCenter(mouse_location, widget_);
+    }
+  } else if (event.type() == ui::ET_MOUSE_PRESSED) {
+    StopAutoclickTimer();
+    StopGesture();

[sadrul, 2016/08/12 15:00:35]

Looks like both StopAutoclickTimer() and StopGesture() are always called
together. Merge these into a single Stop()/Cancel()/Reset() function instead?

[riajiang, 2016/08/12 16:31:38]

Only StopAutoclickTimer() is called in AutoclickControllerImpl::SetEnabled() and
only StopGesture() is called in AutoclickControllerImpl::OnWindowDestroying().

[sadrul, 2016/08/15 15:25:10]

I think if you can call both StopTimer and StopGesture from both places.

[riajiang, 2016/08/15 17:16:23]

Done.

+  } else if (event.type() == ui::ET_MOUSEWHEEL &&
+             autoclick_timer_->IsRunning()) {
+    autoclick_timer_->Reset();
+    GetAutoclickRingWidget(mouse_location);
+    autoclick_ring_handler_->StartGesture(delay_, anchor_location_, widget_);

[sadrul, 2016/08/12 15:00:35]

Since |autoclick_timer_| is running at this point, do you actually want to
StartGesture(), or should you call SetGestureCenter() instead? (because it looks
like the timer running implies the gesture has started)?

[riajiang, 2016/08/12 16:31:38]

StartGesture() will stop the previous gesture/ ring widget animation first and
then start animation at the new location. SetGestureCenter() only updates the
location and won't start animation.

+  }
+}
+
+void AutoclickControllerCommon::HandleKeyEvent(const ui::KeyEvent& event) {
+  int modifier_mask = ui::EF_SHIFT_DOWN | ui::EF_CONTROL_DOWN |
+                      ui::EF_ALT_DOWN | ui::EF_COMMAND_DOWN |
+                      ui::EF_IS_EXTENDED_KEY;
+  int new_modifiers = event.flags() & modifier_mask;
+  mouse_event_flags_ = (mouse_event_flags_ & ~modifier_mask) | new_modifiers;
+
+  if (!IsModifierKey(event.key_code())) {
+    StopAutoclickTimer();
+    StopGesture();
+  }
+}
+
+void AutoclickControllerCommon::HandleTouchEvent(const ui::TouchEvent& event) {
+  StopAutoclickTimer();
+  StopGesture();
+}
+
+void AutoclickControllerCommon::HandleGestureEvent(
+    const ui::GestureEvent& event) {
+  StopAutoclickTimer();
+  StopGesture();
+}
+
+void AutoclickControllerCommon::HandleScrollEvent(
+    const ui::ScrollEvent& event) {
+  StopAutoclickTimer();
+  StopGesture();
+}
+
+void AutoclickControllerCommon::SetAutoclickDelay(const base::TimeDelta delay) {
+  delay_ = delay;
+  InitClickTimer();
+}
+
+void AutoclickControllerCommon::StopAutoclickTimer() {
+  autoclick_timer_->Stop();
+}
+
+void AutoclickControllerCommon::StopGesture() {
+  autoclick_ring_handler_->StopGesture();
+}
+
+bool AutoclickControllerCommon::IsModifierKey(const ui::KeyboardCode key_code) {

[sadrul, 2016/08/12 15:00:35]

Move this into a separate function in the anon namespace in this .cc file

[riajiang, 2016/08/12 16:31:38]

But it's also being used in AutoclickControllerImpl?

+  return key_code == ui::VKEY_SHIFT || key_code == ui::VKEY_LSHIFT ||
+         key_code == ui::VKEY_CONTROL || key_code == ui::VKEY_LCONTROL ||
+         key_code == ui::VKEY_RCONTROL || key_code == ui::VKEY_MENU ||
+         key_code == ui::VKEY_LMENU || key_code == ui::VKEY_RMENU;
+}
+
+void AutoclickControllerCommon::InitClickTimer() {
+  autoclick_timer_.reset(new base::Timer(
+      FROM_HERE, delay_, base::Bind(&AutoclickControllerCommon::DoAutoclick,
+                                    base::Unretained(this)),
+      false));
+}
+
+void AutoclickControllerCommon::DoAutoclick() {
+  gfx::Point screen_location = aura::Env::GetInstance()->last_mouse_location();

[sadrul, 2016/08/12 15:00:35]

Use Screen::GetCursorScreenPoint() instead.

[riajiang, 2016/08/12 16:31:38]

Done.

+  anchor_location_ = screen_location;
+  delegate_->DoAutoclick(screen_location, mouse_event_flags_);
+}
+
+void AutoclickControllerCommon::GetAutoclickRingWidget(
+    const gfx::Point& mouse_location) {
+  if (!widget_)
+    widget_ = delegate_->CreateAutoclickRingWidget(mouse_location);
+  else
+    delegate_->UpdateAutoclickRingWidget(widget_, mouse_location);
+}
+
+}  // namespace ash