exo: Fix multi-display hardware cursor

components/exo/pointer.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/pointer.h"
 
 #include "ash/public/cpp/shell_window_ids.h"
 #include "cc/output/copy_output_request.h"
 #include "cc/output/copy_output_result.h"
 #include "components/exo/pointer_delegate.h"
 #include "components/exo/pointer_stylus_delegate.h"
 #include "components/exo/surface.h"
 #include "components/exo/wm_helper.h"
 #include "ui/aura/client/cursor_client.h"
 #include "ui/aura/env.h"
 #include "ui/aura/window.h"
+#include "ui/base/cursor/cursor_util.h"
 #include "ui/display/manager/display_manager.h"
 #include "ui/display/manager/managed_display_info.h"
 #include "ui/display/screen.h"
 #include "ui/events/event.h"
 #include "ui/gfx/geometry/vector2d_conversions.h"
 #include "ui/gfx/transform_util.h"
 
 #if defined(USE_OZONE)
 #include "ui/ozone/public/cursor_factory_ozone.h"
 #endif
 
 #if defined(USE_X11)
 #include "ui/base/cursor/cursor_loader_x11.h"
 #endif
 
 namespace exo {
 namespace {
 
-const float kLargeCursorScale = 2.8f;
+// TODO(oshima): Some accessibility features, including large cursors, disable
+// hardware cursors. Ash does not support compositing for custom cursors, so it
+// replaces them with the default cursor. As a result, this scale has no effect
+// for now. See crbug.com/708378.
+float GetCursorScale(ui::CursorSetType cursor_set) {
+  return cursor_set == ui::CURSOR_SET_LARGE ? 2.8f : 1.0f;

[reveman, 2017/05/25 10:52:55]

I still prefer if this was folded into UpdateCursor as before. Let's not change
more than necessary in this patch.

[Dominik Laskowski, 2017/05/31 02:06:26]

Done.

+}
 
 // Synthesized events typically lack floating point precision so to avoid
 // generating mouse event jitter we consider the location of these events
 // to be the same as |location| if floored values match.
 bool SameLocation(const ui::LocatedEvent* event, const gfx::PointF& location) {
   if (event->flags() & ui::EF_IS_SYNTHESIZED)
     return event->location() == gfx::ToFlooredPoint(location);
 
   return event->location_f() == location;
 }
 
+inline const display::ManagedDisplayInfo& GetDisplayInfo(

[reveman, 2017/05/25 10:52:55]

this helper doesn't seem useful. please use WMHelper::GetInstance() directly
instead.

[Dominik Laskowski, 2017/05/31 02:06:26]

Done.

+    const display::Display& display) {
+  return WMHelper::GetInstance()->GetDisplayInfo(display.id());
+}
+
+constexpr float kCursorCaptureScale = 2.0f;
+
 }  // namespace
 
 ////////////////////////////////////////////////////////////////////////////////
 // Pointer, public:
 
 Pointer::Pointer(PointerDelegate* delegate)
     : delegate_(delegate),
-      cursor_(ui::CursorType::kNull),
       cursor_capture_source_id_(base::UnguessableToken::Create()),
       cursor_capture_weak_ptr_factory_(this) {
   auto* helper = WMHelper::GetInstance();
   helper->AddPreTargetHandler(this);
   helper->AddCursorObserver(this);
+
+  cursor_scale_ = GetCursorScale(helper->GetCursorSet());
+
+  display::Screen* screen = display::Screen::GetScreen();
+  OnCursorDisplayChanging(
+      screen->GetDisplayNearestPoint(screen->GetCursorScreenPoint()));

[reveman, 2017/05/25 10:52:55]

these lines should not be necessary after addressing my other feedback. ping me
if not clear why.

[Dominik Laskowski, 2017/05/31 02:06:26]

Done.

 }
 
 Pointer::~Pointer() {
   delegate_->OnPointerDestroying(this);
   if (surface_)
     surface_->RemoveSurfaceObserver(this);
   if (focus_) {
     focus_->RemoveSurfaceObserver(this);
     focus_->UnregisterCursorProvider(this);
   }
   auto* helper = WMHelper::GetInstance();
   helper->RemoveCursorObserver(this);
   helper->RemovePreTargetHandler(this);
 }
 
 void Pointer::SetCursor(Surface* surface, const gfx::Point& hotspot) {
   // Early out if the pointer doesn't have a surface in focus.
   if (!focus_)
     return;
 
-  // This is used to avoid unnecessary cursor changes.

[reveman, 2017/05/25 10:52:55]

I'd like to keep this logic as before.

[Dominik Laskowski, 2017/05/31 02:06:26]

Done.

-  bool cursor_changed = false;
-
   // If surface is different than the current pointer surface then remove the
   // current surface and add the new surface.
   if (surface != surface_) {
     if (surface && surface->HasSurfaceDelegate()) {
       DLOG(ERROR) << "Surface has already been assigned a role";
       return;
     }
     if (surface_) {
       surface_->window()->SetTransform(gfx::Transform());
       if (surface_->window()->parent())
         surface_->window()->parent()->RemoveChild(surface_->window());
       surface_->SetSurfaceDelegate(nullptr);
       surface_->RemoveSurfaceObserver(this);
     }
     surface_ = surface;
     if (surface_) {
       surface_->SetSurfaceDelegate(this);
       surface_->AddSurfaceObserver(this);
       // Note: Surface window needs to be added to the tree so we can take a
       // snapshot. Where in the tree is not important but we might as well use
       // the cursor container.
       WMHelper::GetInstance()
-          ->GetContainer(ash::kShellWindowId_MouseCursorContainer)
+          ->GetContainer(display::Screen::GetScreen()->GetPrimaryDisplay().id(),
+                         ash::kShellWindowId_MouseCursorContainer)
           ->AddChild(surface_->window());
     }
-    cursor_changed = true;
+  } else if (hotspot == hotspot_) {
+    // Early out if cursor did not change.
+    return;
   }
 
-  // Update hotspot.
-  if (hotspot != hotspot_) {
-    hotspot_ = hotspot;
-    cursor_changed = true;
-  }
-
-  // Early out if cursor did not change.
-  if (!cursor_changed)
-    return;
-
   // If |surface_| is set then asynchronously capture a snapshot of cursor,
   // otherwise cancel pending capture and immediately set the cursor to "none".
   if (surface_) {
-    CaptureCursor();
+    CaptureCursor(hotspot);
   } else {
+    cursor_bitmap_.reset();
     cursor_capture_weak_ptr_factory_.InvalidateWeakPtrs();
-    cursor_ = ui::CursorType::kNone;
-    UpdateCursor();
+    SetCursor(ui::CursorType::kNone);
   }
 }
 
 gfx::NativeCursor Pointer::GetCursor() {
-  return cursor_;
+  if (focus_)
+    if (auto* root_window = focus_->window()->GetRootWindow())
+      if (auto* cursor_client = aura::client::GetCursorClient(root_window))
+        return cursor_client->GetCursor();
+
+  return ui::CursorType::kNull;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // ui::EventHandler overrides:
 
 void Pointer::OnMouseEvent(ui::MouseEvent* event) {
   Surface* target = GetEffectiveTargetForEvent(event);
 
   // If target is different than the current pointer focus then we need to
   // generate enter and leave events.
   if (target != focus_) {
     // First generate a leave event if we currently have a target in focus.
     if (focus_) {
       delegate_->OnPointerLeave(focus_);
       focus_->RemoveSurfaceObserver(this);
       // Require SetCursor() to be called and cursor to be re-defined in
       // response to each OnPointerEnter() call.
       focus_->UnregisterCursorProvider(this);
       focus_ = nullptr;
-      cursor_ = ui::CursorType::kNull;
       cursor_capture_weak_ptr_factory_.InvalidateWeakPtrs();
     }
     // Second generate an enter event if focus moved to a new target.
     if (target) {
       delegate_->OnPointerEnter(target, event->location_f(),
                                 event->button_flags());
       location_ = event->location_f();
       focus_ = target;
       focus_->AddSurfaceObserver(this);
       focus_->RegisterCursorProvider(this);
@@ skipping 69 matching lines @@
     case ui::ET_MOUSE_ENTERED:
     case ui::ET_MOUSE_EXITED:
     case ui::ET_MOUSE_CAPTURE_CHANGED:
       break;
     default:
       NOTREACHED();
       break;
   }
 
   last_event_type_ = event->type();
-  UpdateCursorScale();
 }
 
 void Pointer::OnScrollEvent(ui::ScrollEvent* event) {
   OnMouseEvent(event);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // WMHelper::CursorObserver overrides:
 
 void Pointer::OnCursorSetChanged(ui::CursorSetType cursor_set) {
+  cursor_scale_ = GetCursorScale(cursor_set);
   if (focus_)
-    UpdateCursorScale();
+    UpdateCursor();
+}
+
+void Pointer::OnCursorDisplayChanging(const display::Display& display) {
+  cursor_device_scale_factor_ = GetDisplayInfo(display).device_scale_factor();

[reveman, 2017/05/25 10:52:55]

hm, do we need |cursor_scale_| and |cursor_rotation_| at all. Let's just do:

if (focus_)
  UpdateCursor();

here and in the function above?

[Dominik Laskowski, 2017/05/31 02:06:26]

Done.

+  cursor_rotation_ = display.rotation();
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // SurfaceDelegate overrides:
 
 void Pointer::OnSurfaceCommit() {
   surface_->CheckIfSurfaceHierarchyNeedsCommitToNewSurfaces();
   surface_->CommitSurfaceHierarchy();
 
   // Capture new cursor to reflect result of commit.
   if (focus_)
-    CaptureCursor();
+    CaptureCursor(hotspot_);
 }
 
 bool Pointer::IsSurfaceSynchronized() const {
   // A pointer surface is always desynchronized.
   return false;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // SurfaceObserver overrides:
 
@@ skipping 11 matching lines @@
 
 Surface* Pointer::GetEffectiveTargetForEvent(ui::Event* event) const {
   Surface* target =
       Surface::AsSurface(static_cast<aura::Window*>(event->target()));
   if (!target)
     return nullptr;
 
   return delegate_->CanAcceptPointerEventsForSurface(target) ? target : nullptr;
 }
 
-void Pointer::UpdateCursorScale() {
-  DCHECK(focus_);
-
-  display::Screen* screen = display::Screen::GetScreen();
-  WMHelper* helper = WMHelper::GetInstance();
-
-  // Update cursor scale if the effective UI scale has changed.
-  display::Display display = screen->GetDisplayNearestWindow(focus_->window());
-  float scale = helper->GetDisplayInfo(display.id()).GetEffectiveUIScale();
-
-  if (display::Display::HasInternalDisplay()) {
-    float primary_device_scale_factor =
-        screen->GetPrimaryDisplay().device_scale_factor();
-    // The size of the cursor surface is the quotient of its physical size and
-    // the DSF of the primary display. The physical size is proportional to the
-    // DSF of the internal display. For external displays (and the internal
-    // display when secondary to a display with a different DSF), scale the
-    // cursor so its physical size matches with the single display case.
-    if (!display.IsInternal() ||
-        display.device_scale_factor() != primary_device_scale_factor) {
-      scale *= primary_device_scale_factor /
-               helper->GetDisplayInfo(display::Display::InternalDisplayId())
-                   .device_scale_factor();
-    }
-  }
-
-  if (helper->GetCursorSet() == ui::CURSOR_SET_LARGE)
-    scale *= kLargeCursorScale;
-
-  if (scale != cursor_scale_) {
-    cursor_scale_ = scale;
-    if (surface_)
-      CaptureCursor();
-  }
-}
-
-void Pointer::CaptureCursor() {
+void Pointer::CaptureCursor(const gfx::Point& hotspot) {
   DCHECK(surface_);
   DCHECK(focus_);
 
-  // Set UI scale before submitting capture request.
-  surface_->window()->layer()->SetTransform(
-      gfx::GetScaleTransform(gfx::Point(), cursor_scale_));
-
-  float primary_device_scale_factor =
-      display::Screen::GetScreen()->GetPrimaryDisplay().device_scale_factor();
+  // Surface size is in DIPs, while layer size is in pseudo-DIP units that
+  // depend on the DSF of the display mode. Scale the layer to capture the
+  // surface at a constant pixel size, regardless of the primary display's
+  // UI scale and display mode DSF.
+  display::Display display = display::Screen::GetScreen()->GetPrimaryDisplay();
+  float scale = GetDisplayInfo(display).GetEffectiveUIScale() *
+                kCursorCaptureScale / display.device_scale_factor();
+  surface_->window()->SetTransform(gfx::GetScaleTransform(gfx::Point(), scale));
 
   std::unique_ptr<cc::CopyOutputRequest> request =
       cc::CopyOutputRequest::CreateBitmapRequest(
           base::Bind(&Pointer::OnCursorCaptured,
-                     cursor_capture_weak_ptr_factory_.GetWeakPtr(),
-                     gfx::ScaleToFlooredPoint(
-                         hotspot_,
-                         // |hotspot_| is in surface coordinate space so apply
-                         // both device scale and UI scale.
-                         cursor_scale_ * primary_device_scale_factor)));
+                     cursor_capture_weak_ptr_factory_.GetWeakPtr(), hotspot));
+
   request->set_source(cursor_capture_source_id_);
   surface_->window()->layer()->RequestCopyOfOutput(std::move(request));
 }
 
 void Pointer::OnCursorCaptured(const gfx::Point& hotspot,
                                std::unique_ptr<cc::CopyOutputResult> result) {
   if (!focus_)
     return;
 
-  cursor_ = ui::CursorType::kNone;
-  if (!result->IsEmpty()) {
-    DCHECK(result->HasBitmap());
-    std::unique_ptr<SkBitmap> bitmap = result->TakeBitmap();
-
-    ui::PlatformCursor platform_cursor;
-#if defined(USE_OZONE)
-    // TODO(reveman): Add interface for creating cursors from GpuMemoryBuffers
-    // and use that here instead of the current bitmap API. crbug.com/686600
-    platform_cursor = ui::CursorFactoryOzone::GetInstance()->CreateImageCursor(
-        *bitmap.get(), hotspot, cursor_scale_);
-#elif defined(USE_X11)
-    XcursorImage* image = ui::SkBitmapToXcursorImage(bitmap.get(), hotspot);
-    platform_cursor = ui::CreateReffedCustomXCursor(image);
-#endif
-    cursor_ = ui::CursorType::kCustom;
-    cursor_.SetPlatformCursor(platform_cursor);
-#if defined(USE_OZONE)
-    ui::CursorFactoryOzone::GetInstance()->UnrefImageCursor(platform_cursor);
-#elif defined(USE_X11)
-    ui::UnrefCustomXCursor(platform_cursor);
-#endif
+  if (result->IsEmpty()) {
+    cursor_bitmap_.reset();
+    SetCursor(ui::CursorType::kNone);
+    return;
   }
 
+  DCHECK(result->HasBitmap());
+  cursor_bitmap_ = *result->TakeBitmap();
+  hotspot_ = hotspot;
   UpdateCursor();
 }
 
 void Pointer::UpdateCursor() {
   DCHECK(focus_);
 
+  if (cursor_bitmap_.drawsNothing())
+    return;
+
+  SkBitmap bitmap = cursor_bitmap_;
+  gfx::Point hotspot = gfx::ScaleToFlooredPoint(hotspot_, kCursorCaptureScale);
+
+  ui::ScaleAndRotateCursorBitmapAndHotpoint(
+      cursor_scale_ * cursor_device_scale_factor_ / kCursorCaptureScale,
+      cursor_rotation_, &bitmap, &hotspot);
+
+  ui::PlatformCursor platform_cursor;
+#if defined(USE_OZONE)
+  // TODO(reveman): Add interface for creating cursors from GpuMemoryBuffers
+  // and use that here instead of the current bitmap API. crbug.com/686600
+  platform_cursor = ui::CursorFactoryOzone::GetInstance()->CreateImageCursor(
+      bitmap, hotspot, 0);
+#elif defined(USE_X11)
+  XcursorImage* image = ui::SkBitmapToXcursorImage(&bitmap, hotspot);
+  platform_cursor = ui::CreateReffedCustomXCursor(image);
+#endif
+  gfx::NativeCursor cursor = ui::CursorType::kCustom;
+  cursor.SetPlatformCursor(platform_cursor);
+#if defined(USE_OZONE)
+  ui::CursorFactoryOzone::GetInstance()->UnrefImageCursor(platform_cursor);
+#elif defined(USE_X11)
+  ui::UnrefCustomXCursor(platform_cursor);
+#endif
+
+  SetCursor(cursor);
+}
+
+void Pointer::SetCursor(gfx::NativeCursor cursor) {
+  DCHECK(focus_);
+
   aura::Window* root_window = focus_->window()->GetRootWindow();
   if (!root_window)
     return;
 
   aura::client::CursorClient* cursor_client =
       aura::client::GetCursorClient(root_window);
   if (cursor_client)
-    cursor_client->SetCursor(cursor_);
+    cursor_client->SetCursor(cursor);
 }
 
 }  // namespace exo