Scroll with Layers in views::ScrollView

ui/views/controls/scroll_view_unittest.cc

 // Copyright (c) 2012 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 "ui/views/controls/scroll_view.h"
 
 #include "base/macros.h"
+#include "base/run_loop.h"
+#include "base/test/test_timeouts.h"
+#include "base/threading/thread_task_runner_handle.h"
 #include "testing/gtest/include/gtest/gtest.h"
 #include "ui/views/border.h"
 #include "ui/views/controls/scrollbar/base_scroll_bar_thumb.h"
 #include "ui/views/controls/scrollbar/native_scroll_bar.h"
 #include "ui/views/controls/scrollbar/native_scroll_bar_views.h"
 #include "ui/views/controls/scrollbar/overlay_scroll_bar.h"
 #include "ui/views/test/test_views.h"
 #include "ui/views/test/widget_test.h"
 
 #if defined(OS_MACOSX)
@@ skipping 21 matching lines @@
   }
 
   const base::Timer& GetScrollBarTimer(ScrollBarOrientation orientation) {
     return GetBaseScrollBar(orientation)->repeater_.timer_for_testing();
   }
 
   BaseScrollBarThumb* GetScrollBarThumb(ScrollBarOrientation orientation) {
     return GetBaseScrollBar(orientation)->thumb_;
   }
 
+  gfx::Point IntegralViewOffset() {
+    return gfx::Point() - gfx::ScrollOffsetToFlooredVector2d(CurrentOffset());
+  }
+
+  gfx::ScrollOffset CurrentOffset() { return scroll_view_->CurrentOffset(); }
+
   View* corner_view() { return scroll_view_->corner_view_; }
+  View* contents_viewport() { return scroll_view_->contents_viewport_; }
 
  private:
   ScrollView* scroll_view_;
 
   DISALLOW_COPY_AND_ASSIGN(ScrollViewTestApi);
 };
 
 }  // namespace test
 
 namespace {
 
 const int kWidth = 100;
 const int kMinHeight = 50;
 const int kMaxHeight = 100;
 
 // View implementation that allows setting the preferred size.
 class CustomView : public View {
  public:
   CustomView() {}
 
   void SetPreferredSize(const gfx::Size& size) {
     preferred_size_ = size;
     PreferredSizeChanged();
   }
 
+  const gfx::Point last_location() const { return last_location_; }
+
   gfx::Size GetPreferredSize() const override { return preferred_size_; }
 
   void Layout() override {
     gfx::Size pref = GetPreferredSize();
     int width = pref.width();
     int height = pref.height();
     if (parent()) {
       width = std::max(parent()->width(), width);
       height = std::max(parent()->height(), height);
     }
     SetBounds(x(), y(), width, height);
   }
 
+  bool OnMousePressed(const ui::MouseEvent& event) override {
+    last_location_ = event.location();
+    return true;
+  }
+
  private:
   gfx::Size preferred_size_;
+  gfx::Point last_location_;
 
   DISALLOW_COPY_AND_ASSIGN(CustomView);
 };
 
 void CheckScrollbarVisibility(const ScrollView& scroll_view,
                               ScrollBarOrientation orientation,
                               bool should_be_visible) {
   const ScrollBar* scrollbar = orientation == HORIZONTAL
                                    ? scroll_view.horizontal_scroll_bar()
                                    : scroll_view.vertical_scroll_bar();
   if (should_be_visible) {
     ASSERT_TRUE(scrollbar);
     EXPECT_TRUE(scrollbar->visible());
   } else {
     EXPECT_TRUE(!scrollbar || !scrollbar->visible());
   }
 }
 
 ui::MouseEvent TestLeftMouseAt(const gfx::Point& location, ui::EventType type) {
   return ui::MouseEvent(type, location, location, base::TimeTicks(),
                         ui::EF_LEFT_MOUSE_BUTTON, ui::EF_LEFT_MOUSE_BUTTON);
 }
 
 }  // namespace
 
 using test::ScrollViewTestApi;
 
 // Test harness that includes a Widget to help test ui::Event handling.
-class WidgetScrollViewTest : public test::WidgetTest {
+class WidgetScrollViewTest : public test::WidgetTest,
+                             public ui::CompositorObserver {
  public:
   static const int kDefaultHeight = 100;
   static const int kDefaultWidth = 100;
 
   WidgetScrollViewTest() {
 #if defined(OS_MACOSX)
     // Disable scrollbar hiding (i.e. disable overlay scrollbars) by default.
     scroller_style_.reset(new ui::test::ScopedPreferredScrollerStyle(false));
 #endif
   }
 
-  // Adds a ScrollView with a contents view of the given |size| and does layout.
-  ScrollView* AddScrollViewWithContentSize(const gfx::Size& contents_size) {
+  // Adds a ScrollView with the given |contents_view| and does layout.
+  ScrollView* AddScrollViewWithContents(View* contents,
+                                        bool commit_layers = true) {
     const gfx::Rect default_bounds(50, 50, kDefaultWidth, kDefaultHeight);
     widget_ = CreateTopLevelFramelessPlatformWidget();
 
     ScrollView* scroll_view = new ScrollView();
-    View* contents = new View;
     scroll_view->SetContents(contents);
-    contents->SetSize(contents_size);
 
     widget_->SetBounds(default_bounds);
     widget_->Show();
 
     widget_->SetContentsView(scroll_view);
     scroll_view->Layout();
+
+    widget_->GetCompositor()->AddObserver(this);
+
+    // Ensure the Compositor has committed layer changes before attempting to
+    // use them for impl-side scrolling. Note that simply RunUntilIdle() works
+    // when tests are run in isolation, but compositor scheduling can interact
+    // between test runs in the general case.
+    if (commit_layers)
+      WaitForCommit();
     return scroll_view;
   }
 
+  // Adds a ScrollView with a contents view of the given |size| and does layout.
+  ScrollView* AddScrollViewWithContentSize(const gfx::Size& contents_size,
+                                           bool commit_layers = true) {
+    View* contents = new View;
+    contents->SetSize(contents_size);
+    return AddScrollViewWithContents(contents, commit_layers);
+  }
+
+  // Wait for a commit to be observed on the compositor.
+  void WaitForCommit() {
+    base::RunLoop run_loop;
+    quit_closure_ = run_loop.QuitClosure();
+    base::ThreadTaskRunnerHandle::Get()->PostDelayedTask(
+        FROM_HERE, quit_closure_, TestTimeouts::action_timeout());
+    run_loop.Run();
+    EXPECT_TRUE(quit_closure_.is_null()) << "Timed out waiting for a commit.";
+  }
+
+  void TestClickAt(const gfx::Point& location) {
+    ui::MouseEvent press(TestLeftMouseAt(location, ui::ET_MOUSE_PRESSED));
+    ui::MouseEvent release(TestLeftMouseAt(location, ui::ET_MOUSE_RELEASED));
+    widget_->OnMouseEvent(&press);
+    widget_->OnMouseEvent(&release);
+  }
+
   // testing::Test:
   void TearDown() override {
+    widget_->GetCompositor()->RemoveObserver(this);
     if (widget_)
       widget_->CloseNow();
     WidgetTest::TearDown();
   }
 
  private:
+  // ui::CompositorObserver:
+  void OnCompositingDidCommit(ui::Compositor* compositor) override {
+    quit_closure_.Run();
+    quit_closure_.Reset();
+  }
+  void OnCompositingStarted(ui::Compositor* compositor,
+                            base::TimeTicks start_time) override {}
+  void OnCompositingEnded(ui::Compositor* compositor) override {}
+  void OnCompositingAborted(ui::Compositor* compositor) override {}
+  void OnCompositingLockStateChanged(ui::Compositor* compositor) override {}
+  void OnCompositingShuttingDown(ui::Compositor* compositor) override {}
+
   Widget* widget_ = nullptr;
 
+  base::Closure quit_closure_;
+
 #if defined(OS_MACOSX)
   std::unique_ptr<ui::test::ScopedPreferredScrollerStyle> scroller_style_;
 #endif
 
   DISALLOW_COPY_AND_ASSIGN(WidgetScrollViewTest);
 };
 
 const int WidgetScrollViewTest::kDefaultHeight;
 const int WidgetScrollViewTest::kDefaultWidth;
 
@@ skipping 129 matching lines @@
   scroll_view.SetHeader(header);
   View* header_parent = header->parent();
   scroll_view.SetContents(contents);
   scroll_view.SetBoundsRect(gfx::Rect(0, 0, 100, 100));
   scroll_view.Layout();
   // |header|s preferred size is empty, which should result in all space going
   // to contents.
   EXPECT_EQ("0,0 100x0", header->parent()->bounds().ToString());
   EXPECT_EQ("0,0 100x100", contents->parent()->bounds().ToString());
 
+  // With layered scrolling, ScrollView::Layout() will impose a size on the
+  // contents that fills the viewport. Since the test view doesn't have its own
+  // Layout, reset it in this case so that adding a header doesn't shift the
+  // contents down and require scrollbars.
+  if (contents->layer()) {
+    EXPECT_EQ("0,0 100x100", contents->bounds().ToString());
+    contents->SetBoundsRect(gfx::Rect());
+  }
+  EXPECT_EQ("0,0 0x0", contents->bounds().ToString());
+
   // Get the header a height of 20.
   header->SetPreferredSize(gfx::Size(10, 20));
   EXPECT_EQ("0,0 100x20", header->parent()->bounds().ToString());
   EXPECT_EQ("0,20 100x80", contents->parent()->bounds().ToString());
+  if (contents->layer()) {
+    EXPECT_EQ("0,0 100x80", contents->bounds().ToString());
+    contents->SetBoundsRect(gfx::Rect());
+  }
+  EXPECT_EQ("0,0 0x0", contents->bounds().ToString());
 
   // Remove the header.
   scroll_view.SetHeader(NULL);
   // SetHeader(NULL) deletes header.
   header = NULL;
   EXPECT_EQ("0,0 100x0", header_parent->bounds().ToString());
   EXPECT_EQ("0,0 100x100", contents->parent()->bounds().ToString());
 }
 
 // Verifies the scrollbars are added as necessary when a header is present.
@@ skipping 57 matching lines @@
   EXPECT_EQ(20, header->parent()->height());
   ASSERT_TRUE(scroll_view.horizontal_scroll_bar() != NULL);
   EXPECT_TRUE(scroll_view.horizontal_scroll_bar()->visible());
   ASSERT_TRUE(scroll_view.vertical_scroll_bar() != NULL);
   EXPECT_TRUE(scroll_view.vertical_scroll_bar()->visible());
 }
 
 // Verifies the header scrolls horizontally with the content.
 TEST(ScrollViewTest, HeaderScrollsWithContent) {
   ScrollView scroll_view;
+  ScrollViewTestApi test_api(&scroll_view);
   CustomView* contents = new CustomView;
   scroll_view.SetContents(contents);
   contents->SetPreferredSize(gfx::Size(500, 500));
 
   CustomView* header = new CustomView;
   scroll_view.SetHeader(header);
   header->SetPreferredSize(gfx::Size(500, 20));
 
   scroll_view.SetBoundsRect(gfx::Rect(0, 0, 100, 100));
-  EXPECT_EQ("0,0", contents->bounds().origin().ToString());
+  EXPECT_EQ("0,0", test_api.IntegralViewOffset().ToString());
   EXPECT_EQ("0,0", header->bounds().origin().ToString());
 
   // Scroll the horizontal scrollbar.
   ASSERT_TRUE(scroll_view.horizontal_scroll_bar());
   scroll_view.ScrollToPosition(
       const_cast<ScrollBar*>(scroll_view.horizontal_scroll_bar()), 1);
-  EXPECT_EQ("-1,0", contents->bounds().origin().ToString());
+  EXPECT_EQ("-1,0", test_api.IntegralViewOffset().ToString());
   EXPECT_EQ("-1,0", header->bounds().origin().ToString());
 
   // Scrolling the vertical scrollbar shouldn't effect the header.
   ASSERT_TRUE(scroll_view.vertical_scroll_bar());
   scroll_view.ScrollToPosition(
       const_cast<ScrollBar*>(scroll_view.vertical_scroll_bar()), 1);
-  EXPECT_EQ("-1,-1", contents->bounds().origin().ToString());
+  EXPECT_EQ("-1,-1", test_api.IntegralViewOffset().ToString());
   EXPECT_EQ("-1,0", header->bounds().origin().ToString());
 }
 
 // Verifies ScrollRectToVisible() on the child works.
 TEST(ScrollViewTest, ScrollRectToVisible) {
+#if defined(OS_MACOSX)
+  ui::test::ScopedPreferredScrollerStyle scroller_style_override(false);
+#endif
   ScrollView scroll_view;
+  ScrollViewTestApi test_api(&scroll_view);
   CustomView* contents = new CustomView;
   scroll_view.SetContents(contents);
   contents->SetPreferredSize(gfx::Size(500, 1000));
 
   scroll_view.SetBoundsRect(gfx::Rect(0, 0, 100, 100));
   scroll_view.Layout();
-  EXPECT_EQ("0,0", contents->bounds().origin().ToString());
+  EXPECT_EQ("0,0", test_api.IntegralViewOffset().ToString());
 
   // Scroll to y=405 height=10, this should make the y position of the content
   // at (405 + 10) - viewport_height (scroll region bottom aligned).
   contents->ScrollRectToVisible(gfx::Rect(0, 405, 10, 10));
-  const int viewport_height = contents->parent()->height();
-  EXPECT_EQ(-(415 - viewport_height), contents->y());
+  const int viewport_height = test_api.contents_viewport()->height();
+
+  // Expect there to be a horizontal scrollbar, making the viewport shorter.
+  EXPECT_LT(viewport_height, 100);
+
+  gfx::ScrollOffset offset = test_api.CurrentOffset();
+  EXPECT_EQ(415 - viewport_height, offset.y());
 
   // Scroll to the current y-location and 10x10; should do nothing.
-  contents->ScrollRectToVisible(gfx::Rect(0, -contents->y(), 10, 10));
-  EXPECT_EQ(-(415 - viewport_height), contents->y());
+  contents->ScrollRectToVisible(gfx::Rect(0, offset.y(), 10, 10));
+  EXPECT_EQ(415 - viewport_height, test_api.CurrentOffset().y());
 }
 
 // Verifies ClipHeightTo() uses the height of the content when it is between the
 // minimum and maximum height values.
 TEST(ScrollViewTest, ClipHeightToNormalContentHeight) {
   ScrollView scroll_view;
 
   scroll_view.ClipHeightTo(kMinHeight, kMaxHeight);
 
   const int kNormalContentHeight = 75;
   scroll_view.SetContents(
       new views::StaticSizedView(gfx::Size(kWidth, kNormalContentHeight)));
 
   EXPECT_EQ(gfx::Size(kWidth, kNormalContentHeight),
             scroll_view.GetPreferredSize());
 
   scroll_view.SizeToPreferredSize();
   scroll_view.Layout();
 
   EXPECT_EQ(gfx::Size(kWidth, kNormalContentHeight),
             scroll_view.contents()->size());
   EXPECT_EQ(gfx::Size(kWidth, kNormalContentHeight), scroll_view.size());
 }
 
 // Verifies ClipHeightTo() uses the minimum height when the content is shorter
-// thamn the minimum height value.
+// than the minimum height value.
 TEST(ScrollViewTest, ClipHeightToShortContentHeight) {
   ScrollView scroll_view;
 
   scroll_view.ClipHeightTo(kMinHeight, kMaxHeight);
 
   const int kShortContentHeight = 10;
-  scroll_view.SetContents(
-      new views::StaticSizedView(gfx::Size(kWidth, kShortContentHeight)));
+  View* contents =
+      new views::StaticSizedView(gfx::Size(kWidth, kShortContentHeight));
+  scroll_view.SetContents(contents);
 
   EXPECT_EQ(gfx::Size(kWidth, kMinHeight), scroll_view.GetPreferredSize());
 
   scroll_view.SizeToPreferredSize();
   scroll_view.Layout();
 
-  EXPECT_EQ(gfx::Size(kWidth, kShortContentHeight),
-            scroll_view.contents()->size());
+  // Layered scrolling requires the contents to fill the viewport.
+  if (contents->layer()) {
+    EXPECT_EQ(gfx::Size(kWidth, kMinHeight), scroll_view.contents()->size());

[tapted, 2016/08/05 07:12:31]

Technically.... this violates StaticSizedView::GetMinimumSize(), but I don't
think there's a use-case in Chrome that isn't satisfied.

+  } else {
+    EXPECT_EQ(gfx::Size(kWidth, kShortContentHeight),
+              scroll_view.contents()->size());
+  }
   EXPECT_EQ(gfx::Size(kWidth, kMinHeight), scroll_view.size());
 }
 
 // Verifies ClipHeightTo() uses the maximum height when the content is longer
 // thamn the maximum height value.
 TEST(ScrollViewTest, ClipHeightToTallContentHeight) {
   ScrollView scroll_view;
 
   // Use a scrollbar that is disabled by default, so the width of the content is
   // not affected.
@@ skipping 167 matching lines @@
 
   // While the mouse is pressed, timer should trigger more scroll events.
   EXPECT_TRUE(timer.IsRunning());
 
   // Upon release timer should stop (and scroll position should remain).
   scroll_bar->OnMouseEvent(&release);
   EXPECT_FALSE(timer.IsRunning());
   EXPECT_EQ(kDefaultHeight, scroll_view->GetVisibleRect().y());
 }
 
+// Test that LocatedEvents are transformed correctly when scrolling.
+TEST_F(WidgetScrollViewTest, EventLocation) {
+  // Set up with both scrollers.
+  CustomView* contents = new CustomView;
+  contents->SetPreferredSize(gfx::Size(kDefaultHeight * 5, kDefaultHeight * 5));
+  AddScrollViewWithContents(contents);
+
+  const gfx::Point location_in_widget(10, 10);
+
+  // Click without scrolling.
+  TestClickAt(location_in_widget);
+  EXPECT_EQ(location_in_widget, contents->last_location());
+
+  // Scroll down a page.
+  contents->ScrollRectToVisible(
+      gfx::Rect(0, kDefaultHeight, 1, kDefaultHeight));
+  TestClickAt(location_in_widget);
+  EXPECT_EQ(gfx::Point(10, 10 + kDefaultHeight), contents->last_location());
+
+  // Scroll right a page (and back up).
+  contents->ScrollRectToVisible(gfx::Rect(kDefaultWidth, 0, kDefaultWidth, 1));
+  TestClickAt(location_in_widget);
+  EXPECT_EQ(gfx::Point(10 + kDefaultWidth, 10), contents->last_location());
+
+  // Scroll both directions.
+  contents->ScrollRectToVisible(
+      gfx::Rect(kDefaultWidth, kDefaultHeight, kDefaultWidth, kDefaultHeight));
+  TestClickAt(location_in_widget);
+  EXPECT_EQ(gfx::Point(10 + kDefaultWidth, 10 + kDefaultHeight),
+            contents->last_location());
+}
+
+// Test that views scroll offsets are in sync with the layer scroll offsets.
+TEST_F(WidgetScrollViewTest, ScrollOffsetUsingLayers) {
+  // Set up with a vertical scroller, but don't commit the layer changes yet.
+  ScrollView* scroll_view =
+      AddScrollViewWithContentSize(gfx::Size(10, kDefaultHeight * 5), false);
+  ScrollViewTestApi test_api(scroll_view);
+
+  EXPECT_EQ(gfx::ScrollOffset(0, 0), test_api.CurrentOffset());
+
+  // UI code may request a scroll before layer changes are committed.
+  gfx::Rect offset(0, kDefaultHeight * 2, 1, kDefaultHeight);
+  scroll_view->contents()->ScrollRectToVisible(offset);
+  EXPECT_EQ(gfx::ScrollOffset(0, offset.y()), test_api.CurrentOffset());
+
+  // The following only makes sense when layered scrolling is enabled.
+  View* container = scroll_view->contents();
+#if defined(OS_MACOSX)
+  // Sanity check: Mac should always scroll with layers.
+  EXPECT_TRUE(container->layer());
+#endif
+  if (!container->layer())
+    return;
+
+  // Container and viewport should have layers.
+  EXPECT_TRUE(container->layer());
+  EXPECT_TRUE(test_api.contents_viewport()->layer());
+
+  // In a Widget, so there should be a compositor.
+  ui::Compositor* compositor = container->layer()->GetCompositor();
+  EXPECT_TRUE(compositor);
+
+  // But setting on the impl side should fail since the layer isn't committed.
+  int layer_id = container->layer()->cc_layer_for_testing()->id();
+  EXPECT_FALSE(compositor->ScrollLayerTo(layer_id, gfx::ScrollOffset(0, 0)));
+  EXPECT_EQ(gfx::ScrollOffset(0, offset.y()), test_api.CurrentOffset());
+
+  WaitForCommit();
+  EXPECT_EQ(gfx::ScrollOffset(0, offset.y()), test_api.CurrentOffset());
+
+  // Upon commit, the impl side should report the same value too.
+  gfx::ScrollOffset impl_offset;
+  EXPECT_TRUE(compositor->GetScrollOffsetForLayer(layer_id, &impl_offset));
+  EXPECT_EQ(gfx::ScrollOffset(0, offset.y()), impl_offset);
+
+  // Now impl-side scrolling should work, and also update the ScrollView.
+  offset.set_y(kDefaultHeight * 3);
+  EXPECT_TRUE(
+      compositor->ScrollLayerTo(layer_id, gfx::ScrollOffset(0, offset.y())));
+  EXPECT_EQ(gfx::ScrollOffset(0, offset.y()), test_api.CurrentOffset());
+
+  // Scroll via ScrollView API. Should be reflected on the impl side.
+  offset.set_y(kDefaultHeight * 4);
+  scroll_view->contents()->ScrollRectToVisible(offset);
+  EXPECT_EQ(gfx::ScrollOffset(0, offset.y()), test_api.CurrentOffset());
+
+  EXPECT_TRUE(compositor->GetScrollOffsetForLayer(layer_id, &impl_offset));
+  EXPECT_EQ(gfx::ScrollOffset(0, offset.y()), impl_offset);
+}
+
 }  // namespace views