ui/keyboard/keyboard_controller.cc

   1 // Copyright (c) 2013 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 #include "ui/keyboard/keyboard_controller.h"
   6
   7 #include <set>
   8
   9 #include "base/bind.h"
  10 #include "base/command_line.h"
  11 #include "content/public/browser/render_widget_host.h"
  12 #include "content/public/browser/render_widget_host_iterator.h"
  13 #include "content/public/browser/render_widget_host_view.h"
  14 #include "ui/aura/window.h"
  15 #include "ui/aura/window_delegate.h"
  16 #include "ui/aura/window_observer.h"
  17 #include "ui/base/cursor/cursor.h"
  18 #include "ui/base/hit_test.h"
  19 #include "ui/base/ime/input_method.h"
  20 #include "ui/base/ime/text_input_client.h"
  21 #include "ui/compositor/layer_animation_observer.h"
  22 #include "ui/compositor/scoped_layer_animation_settings.h"
  23 #include "ui/gfx/geometry/rect.h"
  24 #include "ui/gfx/path.h"
  25 #include "ui/gfx/skia_util.h"
  26 #include "ui/keyboard/keyboard_controller_observer.h"
  27 #include "ui/keyboard/keyboard_controller_proxy.h"
  28 #include "ui/keyboard/keyboard_layout_manager.h"
  29 #include "ui/keyboard/keyboard_util.h"
  30 #include "ui/wm/core/masked_window_targeter.h"
  31
  32 #if defined(OS_CHROMEOS)
  33 #include "base/process/launch.h"
  34 #include "base/sys_info.h"
  35 #endif
  36
  37 namespace {
  38
  39 const int kHideKeyboardDelayMs = 100;
  40
  41 // The virtual keyboard show/hide animation duration.
  42 const int kShowAnimationDurationMs = 350;
  43 const int kHideAnimationDurationMs = 100;
  44
  45 // The opacity of virtual keyboard container when show animation starts or
  46 // hide animation finishes. This cannot be zero because we call Show() on the
  47 // keyboard window before setting the opacity back to 1.0. Since windows are not
  48 // allowed to be shown with zero opacity, we always animate to 0.01 instead.
  49 const float kAnimationStartOrAfterHideOpacity = 0.01f;
  50
  51 // The KeyboardWindowDelegate makes sure the keyboard-window does not get focus.
  52 // This is necessary to make sure that the synthetic key-events reach the target
  53 // window.
  54 // The delegate deletes itself when the window is destroyed.
  55 class KeyboardWindowDelegate : public aura::WindowDelegate {
  56  public:
  57   KeyboardWindowDelegate() {}
  58   ~KeyboardWindowDelegate() override {}
  59
  60  private:
  61   // Overridden from aura::WindowDelegate:
  62   gfx::Size GetMinimumSize() const override { return gfx::Size(); }
  63   gfx::Size GetMaximumSize() const override { return gfx::Size(); }
  64   void OnBoundsChanged(const gfx::Rect& old_bounds,
  65                        const gfx::Rect& new_bounds) override {}
  66   ui::TextInputClient* GetFocusedTextInputClient() override {
  67     return nullptr;
  68   }
  69   gfx::NativeCursor GetCursor(const gfx::Point& point) override {
  70     return gfx::kNullCursor;
  71   }
  72   int GetNonClientComponent(const gfx::Point& point) const override {
  73     return HTNOWHERE;
  74   }
  75   bool ShouldDescendIntoChildForEventHandling(
  76       aura::Window* child,
  77       const gfx::Point& location) override {
  78     return true;
  79   }
  80   bool CanFocus() override { return false; }
  81   void OnCaptureLost() override {}
  82   void OnPaint(const ui::PaintContext& context) override {}
  83   void OnDeviceScaleFactorChanged(float device_scale_factor) override {}
  84   void OnWindowDestroying(aura::Window* window) override {}
  85   void OnWindowDestroyed(aura::Window* window) override { delete this; }
  86   void OnWindowTargetVisibilityChanged(bool visible) override {}
  87   bool HasHitTestMask() const override { return false; }
  88   void GetHitTestMask(gfx::Path* mask) const override {}
  89
  90   DISALLOW_COPY_AND_ASSIGN(KeyboardWindowDelegate);
  91 };
  92
  93 void ToggleTouchEventLogging(bool enable) {
  94 #if defined(OS_CHROMEOS)
  95   if (!base::SysInfo::IsRunningOnChromeOS())
  96     return;
  97   base::CommandLine command(
  98       base::FilePath("/opt/google/touchscreen/toggle_touch_event_logging"));
  99   if (enable)
 100     command.AppendArg("1");
 101   else
 102     command.AppendArg("0");
 103   VLOG(1) << "Running " << command.GetCommandLineString();
 104   base::LaunchOptions options;
 105   options.wait = true;
 106   base::LaunchProcess(command, options);
 107 #endif
 108 }
 109
 110 }  // namespace
 111
 112 namespace keyboard {
 113
 114 // Observer for both keyboard show and hide animations. It should be owned by
 115 // KeyboardController.
 116 class CallbackAnimationObserver : public ui::LayerAnimationObserver {
 117  public:
 118   CallbackAnimationObserver(const scoped_refptr<ui::LayerAnimator>& animator,
 119                             base::Callback<void(void)> callback);
 120   ~CallbackAnimationObserver() override;
 121
 122  private:
 123   // Overridden from ui::LayerAnimationObserver:
 124   void OnLayerAnimationEnded(ui::LayerAnimationSequence* seq) override;
 125   void OnLayerAnimationAborted(ui::LayerAnimationSequence* seq) override;
 126   void OnLayerAnimationScheduled(ui::LayerAnimationSequence* seq) override {}
 127
 128   scoped_refptr<ui::LayerAnimator> animator_;
 129   base::Callback<void(void)> callback_;
 130
 131   DISALLOW_COPY_AND_ASSIGN(CallbackAnimationObserver);
 132 };
 133
 134 CallbackAnimationObserver::CallbackAnimationObserver(
 135     const scoped_refptr<ui::LayerAnimator>& animator,
 136     base::Callback<void(void)> callback)
 137     : animator_(animator), callback_(callback) {
 138 }
 139
 140 CallbackAnimationObserver::~CallbackAnimationObserver() {
 141   animator_->RemoveObserver(this);
 142 }
 143
 144 void CallbackAnimationObserver::OnLayerAnimationEnded(
 145     ui::LayerAnimationSequence* seq) {
 146   if (animator_->is_animating())
 147     return;
 148   animator_->RemoveObserver(this);
 149   callback_.Run();
 150 }
 151
 152 void CallbackAnimationObserver::OnLayerAnimationAborted(
 153     ui::LayerAnimationSequence* seq) {
 154   animator_->RemoveObserver(this);
 155 }
 156
 157 class WindowBoundsChangeObserver : public aura::WindowObserver {
 158  public:
 159   void OnWindowBoundsChanged(aura::Window* window,
 160                              const gfx::Rect& old_bounds,
 161                              const gfx::Rect& new_bounds) override;
 162   void OnWindowDestroyed(aura::Window* window) override;
 163
 164   void AddObservedWindow(aura::Window* window);
 165   void RemoveAllObservedWindows();
 166
 167  private:
 168   std::set<aura::Window*> observed_windows_;
 169 };
 170
 171 void WindowBoundsChangeObserver::OnWindowBoundsChanged(aura::Window* window,
 172     const gfx::Rect& old_bounds, const gfx::Rect& new_bounds) {
 173   KeyboardController* controller =  KeyboardController::GetInstance();
 174   if (controller)
 175     controller->UpdateWindowInsets(window);
 176 }
 177
 178 void WindowBoundsChangeObserver::OnWindowDestroyed(aura::Window* window) {
 179   if (window->HasObserver(this))
 180     window->RemoveObserver(this);
 181   observed_windows_.erase(window);
 182 }
 183
 184 void WindowBoundsChangeObserver::AddObservedWindow(aura::Window* window) {
 185   if (!window->HasObserver(this)) {
 186     window->AddObserver(this);
 187     observed_windows_.insert(window);
 188   }
 189 }
 190
 191 void WindowBoundsChangeObserver::RemoveAllObservedWindows() {
 192   for (std::set<aura::Window*>::iterator it = observed_windows_.begin();
 193        it != observed_windows_.end(); ++it)
 194     (*it)->RemoveObserver(this);
 195   observed_windows_.clear();
 196 }
 197
 198 // static
 199 KeyboardController* KeyboardController::instance_ = NULL;
 200
 201 KeyboardController::KeyboardController(KeyboardControllerProxy* proxy)
 202     : proxy_(proxy),
 203       input_method_(NULL),
 204       keyboard_visible_(false),
 205       show_on_resize_(false),
 206       lock_keyboard_(false),
 207       keyboard_mode_(FULL_WIDTH),
 208       type_(ui::TEXT_INPUT_TYPE_NONE),
 209       weak_factory_(this) {
 210   CHECK(proxy);
 211   input_method_ = proxy_->GetInputMethod();
 212   input_method_->AddObserver(this);
 213   window_bounds_observer_.reset(new WindowBoundsChangeObserver());
 214 }
 215
 216 KeyboardController::~KeyboardController() {
 217   if (container_) {
 218     if (container_->GetRootWindow())
 219       container_->GetRootWindow()->RemoveObserver(this);
 220     container_->RemoveObserver(this);
 221   }
 222   if (input_method_)
 223     input_method_->RemoveObserver(this);
 224   ResetWindowInsets();
 225 }
 226
 227 // static
 228 void KeyboardController::ResetInstance(KeyboardController* controller) {
 229   if (instance_ && instance_ != controller)
 230     delete instance_;
 231   instance_ = controller;
 232 }
 233
 234 // static
 235 KeyboardController* KeyboardController::GetInstance() {
 236   return instance_;
 237 }
 238
 239 aura::Window* KeyboardController::GetContainerWindow() {
 240   if (!container_.get()) {
 241     container_.reset(new aura::Window(new KeyboardWindowDelegate()));
 242     container_->SetName("KeyboardContainer");
 243     container_->set_owned_by_parent(false);
 244     container_->Init(ui::LAYER_NOT_DRAWN);
 245     container_->AddObserver(this);
 246     container_->SetLayoutManager(new KeyboardLayoutManager(this));
 247   }
 248   return container_.get();
 249 }
 250
 251 void KeyboardController::NotifyKeyboardBoundsChanging(
 252     const gfx::Rect& new_bounds) {
 253   current_keyboard_bounds_ = new_bounds;
 254   if (proxy_->HasKeyboardWindow() && proxy_->GetKeyboardWindow()->IsVisible()) {
 255     FOR_EACH_OBSERVER(KeyboardControllerObserver,
 256                       observer_list_,
 257                       OnKeyboardBoundsChanging(new_bounds));
 258     if (keyboard::IsKeyboardOverscrollEnabled()) {
 259       // Adjust the height of the viewport for visible windows on the primary
 260       // display.
 261       // TODO(kevers): Add EnvObserver to properly initialize insets if a
 262       // window is created while the keyboard is visible.
 263       scoped_ptr<content::RenderWidgetHostIterator> widgets(
 264           content::RenderWidgetHost::GetRenderWidgetHosts());
 265       aura::Window* keyboard_window = proxy_->GetKeyboardWindow();
 266       aura::Window* root_window = keyboard_window->GetRootWindow();
 267       while (content::RenderWidgetHost* widget = widgets->GetNextHost()) {
 268         content::RenderWidgetHostView* view = widget->GetView();
 269         // Can be NULL, e.g. if the RenderWidget is being destroyed or
 270         // the render process crashed.
 271         if (view) {
 272           aura::Window* window = view->GetNativeView();
 273           // If virtual keyboard failed to load, a widget that displays error
 274           // message will be created and adds as a child of the virtual keyboard
 275           // window. We want to avoid add BoundsChangedObserver to that window.
 276           if (!keyboard_window->Contains(window) &&
 277               window->GetRootWindow() == root_window) {
 278             gfx::Rect window_bounds = window->GetBoundsInScreen();
 279             gfx::Rect intersect = gfx::IntersectRects(window_bounds,
 280                                                       new_bounds);
 281             int overlap = intersect.height();
 282             if (overlap > 0 && overlap < window_bounds.height())
 283               view->SetInsets(gfx::Insets(0, 0, overlap, 0));
 284             else
 285               view->SetInsets(gfx::Insets());
 286             AddBoundsChangedObserver(window);
 287           }
 288         }
 289       }
 290     } else {
 291       ResetWindowInsets();
 292     }
 293   } else {
 294     current_keyboard_bounds_ = gfx::Rect();
 295   }
 296 }
 297
 298 void KeyboardController::HideKeyboard(HideReason reason) {
 299   keyboard_visible_ = false;
 300   ToggleTouchEventLogging(true);
 301
 302   keyboard::LogKeyboardControlEvent(
 303       reason == HIDE_REASON_AUTOMATIC ?
 304           keyboard::KEYBOARD_CONTROL_HIDE_AUTO :
 305           keyboard::KEYBOARD_CONTROL_HIDE_USER);
 306
 307   NotifyKeyboardBoundsChanging(gfx::Rect());
 308
 309   set_lock_keyboard(false);
 310
 311   ui::LayerAnimator* container_animator = container_->layer()->GetAnimator();
 312   animation_observer_.reset(new CallbackAnimationObserver(
 313       container_animator,
 314       base::Bind(&KeyboardController::HideAnimationFinished,
 315                  base::Unretained(this))));
 316   container_animator->AddObserver(animation_observer_.get());
 317
 318   ui::ScopedLayerAnimationSettings settings(container_animator);
 319   settings.SetTweenType(gfx::Tween::FAST_OUT_LINEAR_IN);
 320   settings.SetTransitionDuration(
 321       base::TimeDelta::FromMilliseconds(kHideAnimationDurationMs));
 322   gfx::Transform transform;
 323   transform.Translate(0, kAnimationDistance);
 324   container_->SetTransform(transform);
 325   container_->layer()->SetOpacity(kAnimationStartOrAfterHideOpacity);
 326 }
 327
 328 void KeyboardController::AddObserver(KeyboardControllerObserver* observer) {
 329   observer_list_.AddObserver(observer);
 330 }
 331
 332 void KeyboardController::RemoveObserver(KeyboardControllerObserver* observer) {
 333   observer_list_.RemoveObserver(observer);
 334 }
 335
 336 void KeyboardController::SetKeyboardMode(KeyboardMode mode) {
 337   keyboard_mode_ = mode;
 338 }
 339
 340 void KeyboardController::ShowKeyboard(bool lock) {
 341   set_lock_keyboard(lock);
 342   ShowKeyboardInternal();
 343 }
 344
 345 void KeyboardController::OnWindowHierarchyChanged(
 346     const HierarchyChangeParams& params) {
 347   if (params.new_parent && params.target == container_.get())
 348     OnTextInputStateChanged(proxy_->GetInputMethod()->GetTextInputClient());
 349 }
 350
 351 void KeyboardController::OnWindowAddedToRootWindow(aura::Window* window) {
 352   if (!window->GetRootWindow()->HasObserver(this))
 353     window->GetRootWindow()->AddObserver(this);
 354 }
 355
 356 void KeyboardController::OnWindowRemovingFromRootWindow(aura::Window* window,
 357     aura::Window* new_root) {
 358   if (window->GetRootWindow()->HasObserver(this))
 359     window->GetRootWindow()->RemoveObserver(this);
 360 }
 361
 362 void KeyboardController::OnWindowBoundsChanged(aura::Window* window,
 363                                                const gfx::Rect& old_bounds,
 364                                                const gfx::Rect& new_bounds) {
 365   if (!window->IsRootWindow())
 366     return;
 367   // Keep the same height when window resize. It gets called when screen
 368   // rotate.
 369   if (!keyboard_container_initialized() || !proxy_->HasKeyboardWindow())
 370     return;
 371
 372   int container_height = container_->bounds().height();
 373   if (keyboard_mode_ == FULL_WIDTH) {
 374     container_->SetBounds(gfx::Rect(new_bounds.x(),
 375                                     new_bounds.bottom() - container_height,
 376                                     new_bounds.width(),
 377                                     container_height));
 378   } else if (keyboard_mode_ == FLOATING) {
 379     // When screen rotate, horizontally center floating virtual keyboard
 380     // window and vertically align it to the bottom.
 381     int container_width = container_->bounds().width();
 382     container_->SetBounds(gfx::Rect(
 383         new_bounds.x() + (new_bounds.width() - container_width) / 2,
 384         new_bounds.bottom() - container_height,
 385         container_width,
 386         container_height));
 387   }
 388 }
 389
 390 void KeyboardController::Reload() {
 391   if (proxy_->HasKeyboardWindow()) {
 392     // A reload should never try to show virtual keyboard. If keyboard is not
 393     // visible before reload, it should keep invisible after reload.
 394     show_on_resize_ = false;
 395     proxy_->ReloadKeyboardIfNeeded();
 396   }
 397 }
 398
 399 void KeyboardController::OnTextInputStateChanged(
 400     const ui::TextInputClient* client) {
 401   if (!container_.get())
 402     return;
 403
 404   type_ = client ? client->GetTextInputType() : ui::TEXT_INPUT_TYPE_NONE;
 405
 406   if (type_ == ui::TEXT_INPUT_TYPE_NONE && !lock_keyboard_) {
 407     if (keyboard_visible_) {
 408       // Set the visibility state here so that any queries for visibility
 409       // before the timer fires returns the correct future value.
 410       keyboard_visible_ = false;
 411       base::MessageLoop::current()->PostDelayedTask(
 412           FROM_HERE,
 413           base::Bind(&KeyboardController::HideKeyboard,
 414                      weak_factory_.GetWeakPtr(), HIDE_REASON_AUTOMATIC),
 415           base::TimeDelta::FromMilliseconds(kHideKeyboardDelayMs));
 416     }
 417   } else {
 418     // Abort a pending keyboard hide.
 419     if (WillHideKeyboard()) {
 420       weak_factory_.InvalidateWeakPtrs();
 421       keyboard_visible_ = true;
 422     }
 423     proxy_->SetUpdateInputType(type_);
 424     // Do not explicitly show the Virtual keyboard unless it is in the process
 425     // of hiding. Instead, the virtual keyboard is shown in response to a user
 426     // gesture (mouse or touch) that is received while an element has input
 427     // focus. Showing the keyboard requires an explicit call to
 428     // OnShowImeIfNeeded.
 429   }
 430 }
 431
 432 void KeyboardController::OnInputMethodDestroyed(
 433     const ui::InputMethod* input_method) {
 434   DCHECK_EQ(input_method_, input_method);
 435   input_method_ = NULL;
 436 }
 437
 438 void KeyboardController::OnShowImeIfNeeded() {
 439   ShowKeyboardInternal();
 440 }
 441
 442 bool KeyboardController::ShouldEnableInsets(aura::Window* window) {
 443   aura::Window* keyboard_window = proxy_->GetKeyboardWindow();
 444   return (keyboard_window->GetRootWindow() == window->GetRootWindow() &&
 445           keyboard::IsKeyboardOverscrollEnabled() &&
 446           keyboard_window->IsVisible() && keyboard_visible_);
 447 }
 448
 449 void KeyboardController::UpdateWindowInsets(aura::Window* window) {
 450   aura::Window* keyboard_window = proxy_->GetKeyboardWindow();
 451   if (window == keyboard_window)
 452     return;
 453
 454   scoped_ptr<content::RenderWidgetHostIterator> widgets(
 455       content::RenderWidgetHost::GetRenderWidgetHosts());
 456   while (content::RenderWidgetHost* widget = widgets->GetNextHost()) {
 457     content::RenderWidgetHostView* view = widget->GetView();
 458     if (view && window->Contains(view->GetNativeView())) {
 459       gfx::Rect window_bounds = view->GetNativeView()->GetBoundsInScreen();
 460       gfx::Rect intersect =
 461           gfx::IntersectRects(window_bounds, keyboard_window->bounds());
 462       int overlap = ShouldEnableInsets(window) ? intersect.height() : 0;
 463       if (overlap > 0 && overlap < window_bounds.height())
 464         view->SetInsets(gfx::Insets(0, 0, overlap, 0));
 465       else
 466         view->SetInsets(gfx::Insets());
 467       return;
 468     }
 469   }
 470 }
 471
 472 void KeyboardController::ShowKeyboardInternal() {
 473   if (!container_.get())
 474     return;
 475
 476   if (container_->children().empty()) {
 477     keyboard::MarkKeyboardLoadStarted();
 478     aura::Window* keyboard = proxy_->GetKeyboardWindow();
 479     keyboard->Show();
 480     container_->AddChild(keyboard);
 481     keyboard->set_owned_by_parent(false);
 482   }
 483
 484   proxy_->ReloadKeyboardIfNeeded();
 485
 486   if (keyboard_visible_) {
 487     return;
 488   } else if (proxy_->GetKeyboardWindow()->bounds().height() == 0) {
 489     show_on_resize_ = true;
 490     return;
 491   }
 492
 493   keyboard_visible_ = true;
 494
 495   // If the controller is in the process of hiding the keyboard, do not log
 496   // the stat here since the keyboard will not actually be shown.
 497   if (!WillHideKeyboard())
 498     keyboard::LogKeyboardControlEvent(keyboard::KEYBOARD_CONTROL_SHOW);
 499
 500   weak_factory_.InvalidateWeakPtrs();
 501
 502   // If |container_| has hide animation, its visibility is set to false when
 503   // hide animation finished. So even if the container is visible at this
 504   // point, it may in the process of hiding. We still need to show keyboard
 505   // container in this case.
 506   if (container_->IsVisible() &&
 507       !container_->layer()->GetAnimator()->is_animating())
 508     return;
 509
 510   ToggleTouchEventLogging(false);
 511   ui::LayerAnimator* container_animator = container_->layer()->GetAnimator();
 512
 513   // If the container is not animating, makes sure the position and opacity
 514   // are at begin states for animation.
 515   if (!container_animator->is_animating()) {
 516     gfx::Transform transform;
 517     transform.Translate(0, kAnimationDistance);
 518     container_->SetTransform(transform);
 519     container_->layer()->SetOpacity(kAnimationStartOrAfterHideOpacity);
 520   }
 521
 522   container_animator->set_preemption_strategy(
 523       ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET);
 524   animation_observer_.reset(new CallbackAnimationObserver(
 525       container_animator,
 526       base::Bind(&KeyboardController::ShowAnimationFinished,
 527                  base::Unretained(this))));
 528   container_animator->AddObserver(animation_observer_.get());
 529
 530   proxy_->ShowKeyboardContainer(container_.get());
 531
 532   {
 533     // Scope the following animation settings as we don't want to animate
 534     // visibility change that triggered by a call to the base class function
 535     // ShowKeyboardContainer with these settings. The container should become
 536     // visible immediately.
 537     ui::ScopedLayerAnimationSettings settings(container_animator);
 538     settings.SetTweenType(gfx::Tween::LINEAR_OUT_SLOW_IN);
 539     settings.SetTransitionDuration(
 540         base::TimeDelta::FromMilliseconds(kShowAnimationDurationMs));
 541     container_->SetTransform(gfx::Transform());
 542     container_->layer()->SetOpacity(1.0);
 543   }
 544 }
 545
 546 void KeyboardController::ResetWindowInsets() {
 547   const gfx::Insets insets;
 548   scoped_ptr<content::RenderWidgetHostIterator> widgets(
 549       content::RenderWidgetHost::GetRenderWidgetHosts());
 550   while (content::RenderWidgetHost* widget = widgets->GetNextHost()) {
 551     content::RenderWidgetHostView* view = widget->GetView();
 552     if (view)
 553       view->SetInsets(insets);
 554   }
 555   window_bounds_observer_->RemoveAllObservedWindows();
 556 }
 557
 558 bool KeyboardController::WillHideKeyboard() const {
 559   return weak_factory_.HasWeakPtrs();
 560 }
 561
 562 void KeyboardController::ShowAnimationFinished() {
 563   // Notify observers after animation finished to prevent reveal desktop
 564   // background during animation.
 565   NotifyKeyboardBoundsChanging(container_->bounds());
 566   proxy_->EnsureCaretInWorkArea();
 567 }
 568
 569 void KeyboardController::HideAnimationFinished() {
 570   proxy_->HideKeyboardContainer(container_.get());
 571 }
 572
 573 void KeyboardController::AddBoundsChangedObserver(aura::Window* window) {
 574   aura::Window* target_window = window ? window->GetToplevelWindow() : nullptr;
 575   if (target_window)
 576     window_bounds_observer_->AddObservedWindow(target_window);
 577 }
 578
 579 }  // namespace keyboard