exo: Add toast shell for ARC++ toasts

This CL introduces a new shell type for ARC++ toasts in remote-shell.
Since the purpose of toasts is a notification for users and the toast
appears and disappears quickly without any user interaction, so toasts
are supposed to be shown over Chrome OS's virtual keyboard.

ARC++ side CL: ag/11272597
design overview: go/vk-overlays-toasts

BUG=b:109717200
TEST=ToastSurfaceTest

Change-Id: I3cec22a031a7046ff63770ff308b6d0695c313e5
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2167792
Commit-Queue: Toshiki Kikuchi <toshikikikuchi@chromium.org>
Reviewed-by: Mitsuru Oshima <oshima@chromium.org>
Reviewed-by: Yuichiro Hanada <yhanada@chromium.org>
Cr-Commit-Position: refs/heads/master@{#786617}

Author: Toshiki Kikuchi

chrome/browser/exo_parts.cc

@@ -20,6 +20,7 @@
 #include "chrome/common/chrome_switches.h"
 #include "components/exo/file_helper.h"
 #include "components/exo/server/wayland_server_controller.h"
+#include "components/exo/toast_surface_manager.h"
 #include "components/user_manager/user_manager.h"
 #include "content/public/browser/browser_thread.h"
 #include "content/public/common/drop_data.h"
@@ -125,7 +126,7 @@ ExoParts::ExoParts() {
   wayland_server_ = exo::WaylandServerController::CreateIfNecessary(
       std::make_unique<ChromeFileHelper>(),
       std::make_unique<ash::ArcNotificationSurfaceManagerImpl>(),
-      std::make_unique<ash::ArcInputMethodSurfaceManager>());
+      std::make_unique<ash::ArcInputMethodSurfaceManager>(), nullptr);
   ash::Shell::Get()->TrackInputMethodBounds(
       ash::ArcInputMethodBoundsTracker::Get());
 }

components/exo/BUILD.gn

@@ -138,6 +138,9 @@ static_library("exo") {
       "shell_surface_base.h",
       "text_input.cc",
       "text_input.h",
+      "toast_surface.cc",
+      "toast_surface.h",
+      "toast_surface_manager.h",
       "wm_helper_chromeos.cc",
       "wm_helper_chromeos.h",
       "xdg_shell_surface.cc",
@@ -258,6 +261,7 @@ source_set("unit_tests") {
       "sub_surface_unittest.cc",
       "surface_unittest.cc",
       "text_input_unittest.cc",
+      "toast_surface_unittest.cc",
       "touch_unittest.cc",
       "xdg_shell_surface_unittest.cc",
     ]

components/exo/client_controlled_shell_surface.cc

@@ -349,6 +349,24 @@ void ClientControlledShellSurface::SetBounds(int64_t display_id,
   SetGeometry(bounds);
 }
 
+void ClientControlledShellSurface::SetBoundsOrigin(const gfx::Point& origin) {
+  TRACE_EVENT1("exo", "ClientControlledShellSurface::SetBoundsOrigin", "origin",
+               origin.ToString());
+
+  pending_geometry_.set_origin(origin);
+}
+
+void ClientControlledShellSurface::SetBoundsSize(const gfx::Size& size) {
+  TRACE_EVENT1("exo", "ClientControlledShellSurface::SetBoundsSize", "size",
+               size.ToString());
+
+  if (size.IsEmpty()) {
+    DLOG(WARNING) << "Bounds size must be non-empty";
+    return;
+  }
+
+  pending_geometry_.set_size(size);
+}
 void ClientControlledShellSurface::SetMaximized() {
   TRACE_EVENT0("exo", "ClientControlledShellSurface::SetMaximized");
   pending_window_state_ = ash::WindowStateType::kMaximized;

components/exo/client_controlled_shell_surface.h

@@ -63,6 +63,12 @@ class ClientControlledShellSurface : public ShellSurfaceBase,
   // Set bounds in root window coordinates relative to the given display.
   void SetBounds(int64_t display_id, const gfx::Rect& bounds);
 
+  // Set origin of bounds for surface while preserving the size.
+  void SetBoundsOrigin(const gfx::Point& origin);
+
+  // Set size of bounds for surface while preserving the origin.
+  void SetBoundsSize(const gfx::Size& size);
+
   // Called when the client was maximized.
   void SetMaximized();
 

components/exo/display.cc

@@ -40,6 +40,8 @@
 #include "components/exo/client_controlled_shell_surface.h"
 #include "components/exo/input_method_surface.h"
 #include "components/exo/shell_surface.h"
+#include "components/exo/toast_surface.h"
+#include "components/exo/toast_surface_manager.h"
 #include "components/exo/xdg_shell_surface.h"
 #endif
 
@@ -60,9 +62,11 @@ Display::Display()
 Display::Display(
     std::unique_ptr<NotificationSurfaceManager> notification_surface_manager,
     std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager,
+    std::unique_ptr<ToastSurfaceManager> toast_surface_manager,
     std::unique_ptr<FileHelper> file_helper)
     : notification_surface_manager_(std::move(notification_surface_manager)),
       input_method_surface_manager_(std::move(input_method_surface_manager)),
+      toast_surface_manager_(std::move(toast_surface_manager)),
       file_helper_(std::move(file_helper)),
       client_native_pixmap_factory_(
           gfx::CreateClientNativePixmapFactoryDmabuf()) {}
@@ -212,6 +216,26 @@ std::unique_ptr<InputMethodSurface> Display::CreateInputMethodSurface(
       input_method_surface_manager_.get(), surface,
       default_device_scale_factor);
 }
+
+std::unique_ptr<ToastSurface> Display::CreateToastSurface(
+    Surface* surface,
+    double default_device_scale_factor) {
+  TRACE_EVENT1("exo", "Display::CreateToastSurface", "surface",
+               surface->AsTracedValue());
+
+  if (!toast_surface_manager_) {
+    DLOG(ERROR) << "Toast surface cannot be registered";
+    return nullptr;
+  }
+
+  if (surface->HasSurfaceDelegate()) {
+    DLOG(ERROR) << "Surface has already been assigned a role";
+    return nullptr;
+  }
+
+  return std::make_unique<ToastSurface>(toast_surface_manager_.get(), surface,
+                                        default_device_scale_factor);
+}
 #endif  // defined(OS_CHROMEOS)
 
 std::unique_ptr<SubSurface> Display::CreateSubSurface(Surface* surface,

components/exo/display.h

@@ -40,6 +40,8 @@ class Surface;
 #if defined(OS_CHROMEOS)
 class InputMethodSurface;
 class ShellSurface;
+class ToastSurface;
+class ToastSurfaceManager;
 class XdgShellSurface;
 #endif
 
@@ -58,6 +60,7 @@ class Display {
   Display(
       std::unique_ptr<NotificationSurfaceManager> notification_surface_manager,
       std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager,
+      std::unique_ptr<ToastSurfaceManager> toast_surface_manager,
       std::unique_ptr<FileHelper> file_helper);
 #endif  // defined(OS_CHROMEOS)
 
@@ -103,6 +106,11 @@ class Display {
   std::unique_ptr<InputMethodSurface> CreateInputMethodSurface(
       Surface* surface,
       double default_device_scale_factor);
+
+  // Creates a toast surface for a surface.
+  std::unique_ptr<ToastSurface> CreateToastSurface(
+      Surface* surface,
+      double default_device_scale_factor);
 #endif  // defined(OS_CHROMEOS)
 
   // Creates a sub-surface for an existing surface. The sub-surface will be
@@ -126,6 +134,7 @@ class Display {
 #if defined(OS_CHROMEOS)
   std::unique_ptr<NotificationSurfaceManager> notification_surface_manager_;
   std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager_;
+  std::unique_ptr<ToastSurfaceManager> toast_surface_manager_;
 #endif  // defined(OS_CHROMEOS)
 
   std::unique_ptr<FileHelper> file_helper_;

components/exo/display_unittest.cc

@@ -18,6 +18,7 @@
 #include "components/exo/sub_surface.h"
 #include "components/exo/surface.h"
 #include "components/exo/test/exo_test_base.h"
+#include "components/exo/toast_surface_manager.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 #if defined(USE_OZONE)
@@ -241,7 +242,8 @@ class TestFileHelper : public FileHelper {
 
 TEST_F(DisplayTest, CreateDataDevice) {
   TestDataDeviceDelegate device_delegate;
-  Display display(nullptr, nullptr, std::make_unique<TestFileHelper>());
+  Display display(nullptr, nullptr, nullptr,
+                  std::make_unique<TestFileHelper>());
 
   std::unique_ptr<DataDevice> device =
       display.CreateDataDevice(&device_delegate);

components/exo/server/wayland_server_controller.cc

@@ -13,6 +13,7 @@
 #include "components/exo/file_helper.h"
 #include "components/exo/input_method_surface_manager.h"
 #include "components/exo/notification_surface_manager.h"
+#include "components/exo/toast_surface_manager.h"
 #include "components/exo/wayland/server.h"
 #include "components/exo/wayland/wayland_watcher.h"
 #include "components/exo/wm_helper.h"
@@ -25,10 +26,12 @@ std::unique_ptr<WaylandServerController>
 WaylandServerController::CreateIfNecessary(
     std::unique_ptr<FileHelper> file_helper,
     std::unique_ptr<NotificationSurfaceManager> notification_surface_manager,
-    std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager) {
+    std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager,
+    std::unique_ptr<ToastSurfaceManager> toast_surface_manager) {
   return std::make_unique<WaylandServerController>(
       std::move(file_helper), std::move(notification_surface_manager),
-      std::move(input_method_surface_manager));
+      std::move(input_method_surface_manager),
+      std::move(toast_surface_manager));
 }
 
 WaylandServerController::~WaylandServerController() {
@@ -37,11 +40,13 @@ WaylandServerController::~WaylandServerController() {
 WaylandServerController::WaylandServerController(
     std::unique_ptr<FileHelper> file_helper,
     std::unique_ptr<NotificationSurfaceManager> notification_surface_manager,
-    std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager)
+    std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager,
+    std::unique_ptr<ToastSurfaceManager> toast_surface_manager)
     : wm_helper_(std::make_unique<WMHelperChromeOS>()),
       display_(
           std::make_unique<Display>(std::move(notification_surface_manager),
                                     std::move(input_method_surface_manager),
+                                    std::move(toast_surface_manager),
                                     std::move(file_helper))),
 
       wayland_server_(wayland::Server::Create(display_.get())) {

components/exo/server/wayland_server_controller.h

@@ -21,6 +21,7 @@ class FileHelper;
 class WMHelper;
 class NotificationSurfaceManager;
 class InputMethodSurfaceManager;
+class ToastSurfaceManager;
 
 class WaylandServerController {
  public:
@@ -32,7 +33,8 @@ class WaylandServerController {
   static std::unique_ptr<WaylandServerController> CreateIfNecessary(
       std::unique_ptr<FileHelper> file_helper,
       std::unique_ptr<NotificationSurfaceManager> notification_surface_manager,
-      std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager);
+      std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager,
+      std::unique_ptr<ToastSurfaceManager> toast_surface_manager);
 
   ~WaylandServerController();
 
@@ -43,7 +45,8 @@ class WaylandServerController {
   WaylandServerController(
       std::unique_ptr<FileHelper> file_helper,
       std::unique_ptr<NotificationSurfaceManager> notification_surface_manager,
-      std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager);
+      std::unique_ptr<InputMethodSurfaceManager> input_method_surface_manager,
+      std::unique_ptr<ToastSurfaceManager> toast_surface_manager);
 
  private:
   std::unique_ptr<WMHelper> wm_helper_;

components/exo/test/exo_test_helper.cc

@@ -15,6 +15,7 @@
 #include "components/exo/display.h"
 #include "components/exo/input_method_surface.h"
 #include "components/exo/surface.h"
+#include "components/exo/toast_surface.h"
 #include "components/exo/wm_helper.h"
 #include "components/exo/xdg_shell_surface.h"
 #include "gpu/command_buffer/client/gpu_memory_buffer_manager.h"
@@ -191,5 +192,21 @@ std::unique_ptr<InputMethodSurface> ExoTestHelper::CreateInputMethodSurface(
   return shell_surface;
 }
 
+std::unique_ptr<ToastSurface> ExoTestHelper::CreateToastSurface(
+    Surface* surface,
+    ToastSurfaceManager* surface_manager) {
+  auto shell_surface = std::make_unique<ToastSurface>(
+      surface_manager, surface,
+      WMHelper::GetInstance()->GetDefaultDeviceScaleFactor());
+
+  shell_surface->set_state_changed_callback(base::BindRepeating(
+      &HandleWindowStateRequest, base::Unretained(shell_surface.get())));
+
+  shell_surface->set_bounds_changed_callback(
+      base::BindRepeating(&HandleBoundsChangedRequest, shell_surface.get()));
+
+  return shell_surface;
+}
+
 }  // namespace test
 }  // namespace exo

components/exo/test/exo_test_helper.h

@@ -25,6 +25,8 @@ class InputMethodSurface;
 class InputMethodSurfaceManager;
 class Surface;
 class ShellSurface;
+class ToastSurface;
+class ToastSurfaceManager;
 
 namespace test {
 
@@ -63,6 +65,9 @@ class ExoTestHelper {
   std::unique_ptr<InputMethodSurface> CreateInputMethodSurface(
       Surface* surface,
       InputMethodSurfaceManager* surface_manager);
+  std::unique_ptr<ToastSurface> CreateToastSurface(
+      Surface* surface,
+      ToastSurfaceManager* surface_manager);
 
  private:
   DISALLOW_COPY_AND_ASSIGN(ExoTestHelper);

components/exo/toast_surface.cc

@@ -0,0 +1,44 @@
+// Copyright 2020 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 "components/exo/toast_surface.h"
+
+#include "ash/public/cpp/shell_window_ids.h"
+#include "components/exo/toast_surface_manager.h"
+#include "components/exo/wm_helper.h"
+#include "ui/base/class_property.h"
+#include "ui/gfx/geometry/dip_util.h"
+#include "ui/gfx/geometry/rect.h"
+#include "ui/views/accessibility/view_accessibility.h"
+
+namespace exo {
+
+ToastSurface::ToastSurface(ToastSurfaceManager* manager,
+                           Surface* surface,
+                           double default_device_scale_factor)
+    : ClientControlledShellSurface(surface,
+                                   false /* can_minimize */,
+                                   ash::kShellWindowId_OverlayContainer),
+      manager_(manager) {
+  SetScale(default_device_scale_factor);
+  SetActivatable(false);
+  DisableMovement();
+  host_window()->SetName("ExoToastSurface");
+}
+
+ToastSurface::~ToastSurface() {
+  if (added_to_manager_)
+    manager_->RemoveSurface(this);
+}
+
+void ToastSurface::OnSurfaceCommit() {
+  ClientControlledShellSurface::OnSurfaceCommit();
+
+  if (!added_to_manager_) {
+    added_to_manager_ = true;
+    manager_->AddSurface(this);
+  }
+}
+
+}  // namespace exo

components/exo/toast_surface.h

@@ -0,0 +1,37 @@
+// Copyright 2020 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.
+
+#ifndef COMPONENTS_EXO_TOAST_SURFACE_H_
+#define COMPONENTS_EXO_TOAST_SURFACE_H_
+
+#include "base/macros.h"
+#include "components/exo/client_controlled_shell_surface.h"
+#include "components/exo/surface_delegate.h"
+#include "components/exo/surface_observer.h"
+
+namespace exo {
+
+class ToastSurfaceManager;
+
+// Handles toast surface role of a given surface.
+class ToastSurface : public ClientControlledShellSurface {
+ public:
+  ToastSurface(ToastSurfaceManager* manager,
+               Surface* surface,
+               double default_device_scale_factor);
+  ~ToastSurface() override;
+
+  // Overridden from SurfaceDelegate:
+  void OnSurfaceCommit() override;
+
+ private:
+  ToastSurfaceManager* const manager_;
+  bool added_to_manager_ = false;
+
+  DISALLOW_COPY_AND_ASSIGN(ToastSurface);
+};
+
+}  // namespace exo
+
+#endif  // COMPONENTS_EXO_TOAST_SURFACE_H_

components/exo/toast_surface_manager.h

@@ -0,0 +1,25 @@
+// Copyright 2020 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.
+
+#ifndef COMPONENTS_EXO_TOAST_SURFACE_MANAGER_H_
+#define COMPONENTS_EXO_TOAST_SURFACE_MANAGER_H_
+
+namespace exo {
+
+class ToastSurface;
+
+class ToastSurfaceManager {
+ public:
+  virtual ~ToastSurfaceManager() = default;
+
+  // Adds an ToastSurface to the manager.
+  virtual void AddSurface(ToastSurface* surface) = 0;
+
+  // Removes an ToastSurface from the manager.
+  virtual void RemoveSurface(ToastSurface* surface) = 0;
+};
+
+}  // namespace exo
+
+#endif  // COMPONENTS_EXO_TOAST_SURFACE_MANAGER_H_