exo: Initial support for multiple displays in ARC

components/exo/wayland/server.cc

 // Copyright 2015 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/wayland/server.h"
 
 #include <alpha-compositing-unstable-v1-server-protocol.h>
 #include <gaming-input-unstable-v1-server-protocol.h>
 #include <grp.h>
 #include <keyboard-configuration-unstable-v1-server-protocol.h>
 #include <linux/input.h>
 #include <presentation-time-server-protocol.h>
 #include <remote-shell-unstable-v1-server-protocol.h>
 #include <secure-output-unstable-v1-server-protocol.h>
 #include <stddef.h>
 #include <stdint.h>
 #include <stylus-unstable-v1-server-protocol.h>
 #include <stylus-unstable-v2-server-protocol.h>
 #include <viewporter-server-protocol.h>
 #include <vsync-feedback-unstable-v1-server-protocol.h>
 #include <wayland-server-core.h>
 #include <wayland-server-protocol-core.h>
 #include <xdg-shell-unstable-v5-server-protocol.h>
 #include <xdg-shell-unstable-v6-server-protocol.h>
 
 #include <algorithm>
 #include <cstdlib>
 #include <iterator>
 #include <string>
+#include <unordered_set>
 #include <utility>
 
-#include "ash/common/shell_observer.h"
 #include "ash/public/cpp/shell_window_ids.h"
 #include "ash/shell.h"
 #include "base/bind.h"
 #include "base/cancelable_callback.h"
 #include "base/files/file_path.h"
 #include "base/macros.h"
 #include "base/memory/free_deleter.h"
 #include "base/memory/ptr_util.h"
 #include "base/memory/weak_ptr.h"
 #include "base/strings/stringprintf.h"
@@ skipping 956 matching lines @@
       wl_client_get_display(wl_resource_get_client(resource)));
   wl_shell_surface_send_ping(resource, serial);
   wl_client_flush(wl_resource_get_client(resource));
 }
 
 uint32_t HandleShellSurfaceConfigureCallback(
     wl_resource* resource,
     const gfx::Size& size,
     ash::wm::WindowStateType state_type,
     bool resizing,
-    bool activated) {
+    bool activated,
+    const gfx::Point& origin) {
   wl_shell_surface_send_configure(resource, WL_SHELL_SURFACE_RESIZE_NONE,
                                   size.width(), size.height());
   wl_client_flush(wl_resource_get_client(resource));
   return 0;
 }
 
 void shell_get_shell_surface(wl_client* client,
                              wl_resource* resource,
                              uint32_t id,
                              wl_resource* surface) {
@@ skipping 62 matching lines @@
   WaylandPrimaryDisplayObserver(wl_resource* output_resource)
       : output_resource_(output_resource) {
     display::Screen::GetScreen()->AddObserver(this);
     SendDisplayMetrics();
   }
   ~WaylandPrimaryDisplayObserver() override {
     display::Screen::GetScreen()->RemoveObserver(this);
   }
 
   // Overridden from display::DisplayObserver:
-  void OnDisplayAdded(const display::Display& new_display) override {}
-  void OnDisplayRemoved(const display::Display& new_display) override {}
   void OnDisplayMetricsChanged(const display::Display& display,
                                uint32_t changed_metrics) override {
     if (display::Screen::GetScreen()->GetPrimaryDisplay().id() != display.id())
       return;
 
     // There is no need to check DISPLAY_METRIC_PRIMARY because when primary
     // changes, bounds always changes. (new primary should have had non
     // 0,0 origin).
     // Only exception is when switching to newly connected primary with
     // the same bounds. This happens whenyou're in docked mode, suspend,
@@ skipping 422 matching lines @@
   DCHECK(value);
   *value = state;
 }
 
 uint32_t HandleXdgToplevelV6ConfigureCallback(
     wl_resource* resource,
     wl_resource* surface_resource,
     const gfx::Size& size,
     ash::wm::WindowStateType state_type,
     bool resizing,
-    bool activated) {
+    bool activated,
+    const gfx::Point& origin) {
   wl_array states;
   wl_array_init(&states);
   if (state_type == ash::wm::WINDOW_STATE_TYPE_MAXIMIZED)
     AddXdgToplevelV6State(&states, ZXDG_TOPLEVEL_V6_STATE_MAXIMIZED);
   if (state_type == ash::wm::WINDOW_STATE_TYPE_FULLSCREEN)
     AddXdgToplevelV6State(&states, ZXDG_TOPLEVEL_V6_STATE_FULLSCREEN);
   if (resizing)
     AddXdgToplevelV6State(&states, ZXDG_TOPLEVEL_V6_STATE_RESIZING);
   if (activated)
     AddXdgToplevelV6State(&states, ZXDG_TOPLEVEL_V6_STATE_ACTIVATED);
@@ skipping 116 matching lines @@
       wl_array_add(states, sizeof(xdg_surface_state)));
   DCHECK(value);
   *value = state;
 }
 
 uint32_t HandleXdgSurfaceV5ConfigureCallback(
     wl_resource* resource,
     const gfx::Size& size,
     ash::wm::WindowStateType state_type,
     bool resizing,
-    bool activated) {
+    bool activated,
+    const gfx::Point& origin) {
   wl_array states;
   wl_array_init(&states);
   if (state_type == ash::wm::WINDOW_STATE_TYPE_MAXIMIZED)
     AddXdgSurfaceV5State(&states, XDG_SURFACE_STATE_MAXIMIZED);
   if (state_type == ash::wm::WINDOW_STATE_TYPE_FULLSCREEN)
     AddXdgSurfaceV5State(&states, XDG_SURFACE_STATE_FULLSCREEN);
   if (resizing)
     AddXdgSurfaceV5State(&states, XDG_SURFACE_STATE_RESIZING);
   if (activated)
     AddXdgSurfaceV5State(&states, XDG_SURFACE_STATE_ACTIVATED);
@@ skipping 276 matching lines @@
 
 void remote_surface_set_system_modal(wl_client* client, wl_resource* resource) {
   GetUserDataAs<ShellSurface>(resource)->SetSystemModal(true);
 }
 
 void remote_surface_unset_system_modal(wl_client* client,
                                        wl_resource* resource) {
   GetUserDataAs<ShellSurface>(resource)->SetSystemModal(false);
 }
 
+void remote_surface_ack_configure(wl_client* client,
+                                  wl_resource* resource,
+                                  uint32_t serial) {
+  GetUserDataAs<ShellSurface>(resource)->AcknowledgeConfigure(serial);
+}
+
+void remote_surface_set_moving(wl_client* client, wl_resource* resource) {
+  GetUserDataAs<ShellSurface>(resource)->SetMoving();
+}
+
+void remote_surface_unset_moving(wl_client* client, wl_resource* resource) {
+  GetUserDataAs<ShellSurface>(resource)->UnsetMoving(false /* revert */);
+}
+
 const struct zcr_remote_surface_v1_interface remote_surface_implementation = {
     remote_surface_destroy,
     remote_surface_set_app_id,
     remote_surface_set_window_geometry,
     remote_surface_set_scale,
     remote_surface_set_rectangular_shadow,
     remote_surface_set_rectangular_shadow_background_opacity,
     remote_surface_set_title,
     remote_surface_set_top_inset,
     remote_surface_activate,
     remote_surface_maximize,
     remote_surface_minimize,
     remote_surface_restore,
     remote_surface_fullscreen,
     remote_surface_unfullscreen,
     remote_surface_pin,
     remote_surface_unpin,
     remote_surface_set_system_modal,
-    remote_surface_unset_system_modal};
+    remote_surface_unset_system_modal,
+    remote_surface_ack_configure,
+    remote_surface_set_moving,
+    remote_surface_unset_moving};
 
 ////////////////////////////////////////////////////////////////////////////////
 // notification_surface_interface:
 
 void notification_surface_destroy(wl_client* client, wl_resource* resource) {
   wl_resource_destroy(resource);
 }
 
 const struct zcr_notification_surface_v1_interface
     notification_surface_implementation = {notification_surface_destroy};
 
 ////////////////////////////////////////////////////////////////////////////////
 // remote_shell_interface:
 
 // Implements remote shell interface and monitors workspace state needed
 // for the remote shell interface.
+//
+// This class is also responsible for conversion between server-side screen
+// coordinates and client-side virtual coordinates. This mapping enables
+// support for multiple displays when the client is limited to a single
+// display. In that case, the client uses a virtual display computed as
+// the bounding box of the physical displays, and the server translates
+// positions based on the display layout. For example, P is the client's
+// origin in virtual coordinates, and Q is the server's origin in screen
+// coordinates.
+//
+//  P        Q
+//  +-----+ /
+//  |     |/
+//  |  2  +-----------+
+//  |     |           |
+//  +-----+     1     |
+//        |           |
+//        +-----------+
+//
 class WaylandRemoteShell : public WMHelper::MaximizeModeObserver,
                            public WMHelper::ActivationObserver,
                            public display::DisplayObserver {
  public:
   WaylandRemoteShell(Display* display, wl_resource* remote_shell_resource)
       : display_(display),
         remote_shell_resource_(remote_shell_resource),
         weak_ptr_factory_(this) {
     auto* helper = WMHelper::GetInstance();
     helper->AddMaximizeModeObserver(this);
     helper->AddActivationObserver(this);
     display::Screen::GetScreen()->AddObserver(this);
 
     layout_mode_ = helper->IsMaximizeModeWindowManagerEnabled()
                        ? ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_TABLET
                        : ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_WINDOWED;
 
-    SendPrimaryDisplayMetrics();
+    SendDisplayMetrics();
     SendActivated(helper->GetActiveWindow(), nullptr);
   }
   ~WaylandRemoteShell() override {
     auto* helper = WMHelper::GetInstance();
     helper->RemoveMaximizeModeObserver(this);
     helper->RemoveActivationObserver(this);
     display::Screen::GetScreen()->RemoveObserver(this);
   }
 
   std::unique_ptr<ShellSurface> CreateShellSurface(Surface* surface,
                                                    int container) {
-    return display_->CreateRemoteShellSurface(surface, container);
+    std::unique_ptr<ShellSurface> shell_surface =
+        display_->CreateRemoteShellSurface(surface, virtual_origin_, container);
+
+    shell_surfaces_.insert(shell_surface.get());
+    shell_surface->set_destroyed_callback(
+        base::Bind(&WaylandRemoteShell::OnShellSurfaceDestroyed,
+                   weak_ptr_factory_.GetWeakPtr(), shell_surface.get()));
+
+    return shell_surface;
+  }
+
+  void OnShellSurfaceDestroyed(ShellSurface* shell_surface) {
+    shell_surfaces_.erase(shell_surface);
   }
 
   std::unique_ptr<NotificationSurface> CreateNotificationSurface(
       Surface* surface,
       const std::string& notification_id) {
     return display_->CreateNotificationSurface(surface, notification_id);
   }
 
   // Overridden from display::DisplayObserver:
-  void OnDisplayAdded(const display::Display& new_display) override {}
-  void OnDisplayRemoved(const display::Display& new_display) override {}
+  void OnDisplayAdded(const display::Display& new_display) override {
+    if (IsMultiDisplaySupported())
+      ScheduleSendDisplayMetrics();
+  }
+
+  void OnDisplayRemoved(const display::Display& old_display) override {
+    if (IsMultiDisplaySupported())
+      ScheduleSendDisplayMetrics();
+  }
+
   void OnDisplayMetricsChanged(const display::Display& display,
                                uint32_t changed_metrics) override {
-    if (display::Screen::GetScreen()->GetPrimaryDisplay().id() != display.id())
+    if (!IsMultiDisplaySupported() &&
+        display::Screen::GetScreen()->GetPrimaryDisplay().id() != display.id())
       return;
 
-    // No need to update when a primary dislpay has changed without bounds
+    // No need to update when a primary display has changed without bounds
     // change. See WaylandPrimaryDisplayObserver::OnDisplayMetricsChanged
     // for more details.
     if (changed_metrics &
         (DISPLAY_METRIC_BOUNDS | DISPLAY_METRIC_DEVICE_SCALE_FACTOR |
          DISPLAY_METRIC_ROTATION | DISPLAY_METRIC_WORK_AREA)) {
-      SendDisplayMetrics(display);
+      ScheduleSendDisplayMetrics();
     }
   }
 
   // Overridden from WMHelper::MaximizeModeObserver:
   void OnMaximizeModeStarted() override {
     layout_mode_ = ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_TABLET;
-
-    send_configure_after_layout_change_ = true;
-    base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
-        FROM_HERE, base::Bind(&WaylandRemoteShell::MaybeSendConfigure,
-                              weak_ptr_factory_.GetWeakPtr()),
-        base::TimeDelta::FromMilliseconds(kConfigureDelayAfterLayoutSwitchMs));
+    ScheduleSendDisplayMetrics(kConfigureDelayAfterLayoutSwitchMs);
   }
   void OnMaximizeModeEnded() override {
     layout_mode_ = ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_WINDOWED;
-    send_configure_after_layout_change_ = true;
-    base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
-        FROM_HERE, base::Bind(&WaylandRemoteShell::MaybeSendConfigure,
-                              weak_ptr_factory_.GetWeakPtr()),
-        base::TimeDelta::FromMilliseconds(kConfigureDelayAfterLayoutSwitchMs));
+    ScheduleSendDisplayMetrics(kConfigureDelayAfterLayoutSwitchMs);
   }
 
   // Overridden from WMHelper::ActivationObserver:
   void OnWindowActivated(aura::Window* gained_active,
                          aura::Window* lost_active) override {
     SendActivated(gained_active, lost_active);
   }
 
  private:
-  void SendPrimaryDisplayMetrics() {
-    const display::Display primary =
-        display::Screen::GetScreen()->GetPrimaryDisplay();
-
-    SendDisplayMetrics(primary);
+  bool IsMultiDisplaySupported() const {
+    return wl_resource_get_version(remote_shell_resource_) >= 2;
   }
 
-  void MaybeSendConfigure() {
-    if (send_configure_after_layout_change_)
-      SendPrimaryDisplayMetrics();
+  void ScheduleSendDisplayMetrics(int delay_ms = 0) {
+    needs_send_display_metrics_ = true;
+    base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
+        FROM_HERE, base::Bind(&WaylandRemoteShell::SendDisplayMetrics,
+                              weak_ptr_factory_.GetWeakPtr()),
+        base::TimeDelta::FromMilliseconds(delay_ms));
   }
 
-  void SendDisplayMetrics(const display::Display& display) {
-    send_configure_after_layout_change_ = false;
+  void SendDisplayMetrics() {
+    if (!needs_send_display_metrics_)
+      return;
+    needs_send_display_metrics_ = false;
 
-    const gfx::Insets& work_area_insets = display.GetWorkAreaInsets();
+    const display::Screen* screen = display::Screen::GetScreen();
+    const display::Display primary = screen->GetPrimaryDisplay();
+
+    gfx::Size size = primary.size();
+
+    if (IsMultiDisplaySupported()) {
+      // Virtual screen is the bounding box of the displays in screen
+      // coordinates.
+      gfx::Rect bounds;
+      for (const auto& display : screen->GetAllDisplays())
+        bounds.Union(display.bounds());
+
+      virtual_origin_ = bounds.origin();
+      size = bounds.size();
+
+      for (ShellSurface* shell_surface : shell_surfaces_)
+        shell_surface->SetOrigin(virtual_origin_);
+    }
+
+    // TODO(domlaskowski): Send insets for each workspace.
+    const gfx::Insets& work_area_insets = primary.GetWorkAreaInsets();
 
     zcr_remote_shell_v1_send_configuration_changed(
-        remote_shell_resource_, display.size().width(), display.size().height(),
-        OutputTransform(display.rotation()),
-        wl_fixed_from_double(display.device_scale_factor()),
+        remote_shell_resource_, size.width(), size.height(),
+        OutputTransform(primary.rotation()),
+        wl_fixed_from_double(primary.device_scale_factor()),
         work_area_insets.left(), work_area_insets.top(),
         work_area_insets.right(), work_area_insets.bottom(), layout_mode_);
     wl_client_flush(wl_resource_get_client(remote_shell_resource_));
   }
 
   void SendActivated(aura::Window* gained_active, aura::Window* lost_active) {
     Surface* gained_active_surface =
         gained_active ? ShellSurface::GetMainSurface(gained_active) : nullptr;
     Surface* lost_active_surface =
         lost_active ? ShellSurface::GetMainSurface(lost_active) : nullptr;
@@ skipping 24 matching lines @@
                                        lost_active_surface_resource);
     wl_client_flush(client);
   }
 
   // The exo display instance. Not owned.
   Display* const display_;
 
   // The remote shell resource associated with observer.
   wl_resource* const remote_shell_resource_;
 
-  bool send_configure_after_layout_change_ = false;
+  bool needs_send_display_metrics_ = true;
 
   int layout_mode_ = ZCR_REMOTE_SHELL_V1_LAYOUT_MODE_WINDOWED;
 
+  // Origin of the virtual screen relative to the primary display.
+  gfx::Point virtual_origin_;
+
+  std::unordered_set<ShellSurface*> shell_surfaces_;  // Unowned.
+
   base::WeakPtrFactory<WaylandRemoteShell> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(WaylandRemoteShell);
 };
 
 void remote_shell_destroy(wl_client* client, wl_resource* resource) {
   // Nothing to do here.
 }
 
 int RemoteSurfaceContainer(uint32_t container) {
@@ skipping 37 matching lines @@
       state_type = ZCR_REMOTE_SHELL_V1_STATE_TYPE_TRUSTED_PINNED;
       break;
     default:
       break;
   }
 
   zcr_remote_surface_v1_send_state_type_changed(resource, state_type);
   wl_client_flush(wl_resource_get_client(resource));
 }
 
+uint32_t HandleRemoteSurfaceConfigureCallback(
+    wl_resource* resource,
+    const gfx::Size& size,
+    ash::wm::WindowStateType state_type,
+    bool resizing,
+    bool activated,
+    const gfx::Point& origin) {
+  uint32_t serial = wl_display_next_serial(
+      wl_client_get_display(wl_resource_get_client(resource)));
+  zcr_remote_surface_v1_send_configure(resource, origin.x(), origin.y(),
+                                       serial);
+  wl_client_flush(wl_resource_get_client(resource));
+  return serial;
+}
+
 void remote_shell_get_remote_surface(wl_client* client,
                                      wl_resource* resource,
                                      uint32_t id,
                                      wl_resource* surface,
                                      uint32_t container) {
   std::unique_ptr<ShellSurface> shell_surface =
       GetUserDataAs<WaylandRemoteShell>(resource)->CreateShellSurface(
           GetUserDataAs<Surface>(surface), RemoteSurfaceContainer(container));
   if (!shell_surface) {
     wl_resource_post_error(resource, ZCR_REMOTE_SHELL_V1_ERROR_ROLE,
                            "surface has already been assigned a role");
     return;
   }
 
   wl_resource* remote_surface_resource =
       wl_resource_create(client, &zcr_remote_surface_v1_interface,
                          wl_resource_get_version(resource), id);
 
   shell_surface->set_close_callback(
       base::Bind(&HandleRemoteSurfaceCloseCallback,
                  base::Unretained(remote_surface_resource)));
   shell_surface->set_state_changed_callback(
       base::Bind(&HandleRemoteSurfaceStateChangedCallback,
                  base::Unretained(remote_surface_resource)));
+  shell_surface->set_configure_callback(
+      base::Bind(&HandleRemoteSurfaceConfigureCallback,
+                 base::Unretained(remote_surface_resource)));
 
   SetImplementation(remote_surface_resource, &remote_surface_implementation,
                     std::move(shell_surface));
 }
 
 void remote_shell_get_notification_surface(wl_client* client,
                                            wl_resource* resource,
                                            uint32_t id,
                                            wl_resource* surface,
                                            const char* notification_id) {
@@ skipping 18 matching lines @@
                          wl_resource_get_version(resource), id);
   SetImplementation(notification_surface_resource,
                     &notification_surface_implementation,
                     std::move(notification_surface));
 }
 
 const struct zcr_remote_shell_v1_interface remote_shell_implementation = {
     remote_shell_destroy, remote_shell_get_remote_surface,
     remote_shell_get_notification_surface};
 
-const uint32_t remote_shell_version = 1;
+const uint32_t remote_shell_version = 2;
 
 void bind_remote_shell(wl_client* client,
                        void* data,
                        uint32_t version,
                        uint32_t id) {
   wl_resource* resource =
       wl_resource_create(client, &zcr_remote_shell_v1_interface,
                          std::min(version, remote_shell_version), id);
 
   SetImplementation(resource, &remote_shell_implementation,
@@ skipping 1436 matching lines @@
   DCHECK(event_loop);
   wl_event_loop_dispatch(event_loop, timeout.InMilliseconds());
 }
 
 void Server::Flush() {
   wl_display_flush_clients(wl_display_.get());
 }
 
 }  // namespace wayland
 }  // namespace exo