Changeset 286035 in webkit

Timestamp:

Nov 18, 2021, 3:20:09 PM (5 years ago)

Author:

Simon Fraser

Message:

Teach WheelEventTestMonitor about scroll animations
​https://bugs.webkit.org/show_bug.cgi?id=233296

Reviewed by Tim Horton.

There was no way for a test to wait for a scroll animation to finish, so enhance
WheelEventTestMonitor to know about scroll animations.

ScrollAnimationInProgress should probably subsume the RubberbandInProgress and
ScrollSnapInProgress reasons, but those are left alone for now.

• page/WheelEventTestMonitor.cpp:

(WebCore::operator<<):

• page/WheelEventTestMonitor.h:
• platform/ScrollingEffectsController.cpp:

(WebCore::ScrollingEffectsController::startScrollSnapAnimation):
(WebCore::ScrollingEffectsController::stopScrollSnapAnimation):
(WebCore::ScrollingEffectsController::scrollAnimationWillStart):
(WebCore::ScrollingEffectsController::scrollAnimationDidEnd):
(WebCore::ScrollingEffectsController::startDeferringWheelEventTestCompletion):
(WebCore::ScrollingEffectsController::stopDeferringWheelEventTestCompletion):

• platform/ScrollingEffectsController.h:
• platform/mac/ScrollingEffectsController.mm:

(WebCore::ScrollingEffectsController::scheduleStatelessScrollSnap):
(WebCore::ScrollingEffectsController::startDeferringWheelEventTestCompletionDueToScrollSnapping): Deleted.
(WebCore::ScrollingEffectsController::stopDeferringWheelEventTestCompletionDueToScrollSnapping): Deleted.

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• page/WheelEventTestMonitor.cpp (modified) (1 diff)
• page/WheelEventTestMonitor.h (modified) (1 diff)
• platform/ScrollingEffectsController.cpp (modified) (6 diffs)
• platform/ScrollingEffectsController.h (modified) (2 diffs)
• platform/mac/ScrollingEffectsController.mm (modified) (3 diffs)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-11-18  Simon Fraser  <simon.fraser@apple.com>
+
+        Teach WheelEventTestMonitor about scroll animations
+        https://bugs.webkit.org/show_bug.cgi?id=233296
+
+        Reviewed by Tim Horton.
+
+        There was no way for a test to wait for a scroll animation to finish, so enhance 
+        WheelEventTestMonitor to know about scroll animations.
+
+        ScrollAnimationInProgress should probably subsume the RubberbandInProgress and
+        ScrollSnapInProgress reasons, but those are left alone for now.
+
+        * page/WheelEventTestMonitor.cpp:
+        (WebCore::operator<<):
+        * page/WheelEventTestMonitor.h:
+        * platform/ScrollingEffectsController.cpp:
+        (WebCore::ScrollingEffectsController::startScrollSnapAnimation):
+        (WebCore::ScrollingEffectsController::stopScrollSnapAnimation):
+        (WebCore::ScrollingEffectsController::scrollAnimationWillStart):
+        (WebCore::ScrollingEffectsController::scrollAnimationDidEnd):
+        (WebCore::ScrollingEffectsController::startDeferringWheelEventTestCompletion):
+        (WebCore::ScrollingEffectsController::stopDeferringWheelEventTestCompletion):
+        * platform/ScrollingEffectsController.h:
+        * platform/mac/ScrollingEffectsController.mm:
+        (WebCore::ScrollingEffectsController::scheduleStatelessScrollSnap):
+        (WebCore::ScrollingEffectsController::startDeferringWheelEventTestCompletionDueToScrollSnapping): Deleted.
+        (WebCore::ScrollingEffectsController::stopDeferringWheelEventTestCompletionDueToScrollSnapping): Deleted.
+
 2021-11-18  Chris Dumez  <cdumez@apple.com>
 

trunk/Source/WebCore/page/WheelEventTestMonitor.cpp

@@ -175 +175 @@
     case WheelEventTestMonitor::RubberbandInProgress: ts << "rubberbanding"; break;
     case WheelEventTestMonitor::ScrollSnapInProgress: ts << "scroll-snapping"; break;
+    case WheelEventTestMonitor::ScrollAnimationInProgress: ts << "scroll animation"; break;
     case WheelEventTestMonitor::ScrollingThreadSyncNeeded: ts << "scrolling thread sync needed"; break;
     case WheelEventTestMonitor::ContentScrollInProgress: ts << "content scrolling"; break;

trunk/Source/WebCore/page/WheelEventTestMonitor.h

@@ -54 +54 @@
         RubberbandInProgress                = 1 << 3,
         ScrollSnapInProgress                = 1 << 4,
-        ScrollingThreadSyncNeeded           = 1 << 5,
-        ContentScrollInProgress             = 1 << 6,
-        RequestedScrollPosition             = 1 << 7,
+        ScrollAnimationInProgress           = 1 << 5,
+        ScrollingThreadSyncNeeded           = 1 << 6,
+        ContentScrollInProgress             = 1 << 7,
+        RequestedScrollPosition             = 1 << 8,
     };
     typedef const void* ScrollableAreaIdentifier;

trunk/Source/WebCore/platform/ScrollingEffectsController.cpp

@@ -35 +35 @@
 #include "ScrollExtents.h"
 #include "ScrollableArea.h"
-#include "WheelEventTestMonitor.h"
 #include <wtf/text/TextStream.h>
 
@@ -447 +446 @@
     LOG_WITH_STREAM(ScrollSnap, stream << "ScrollingEffectsController " << this << " startScrollSnapAnimation (main thread " << isMainThread() << ")");
 
-#if PLATFORM(MAC)
-    startDeferringWheelEventTestCompletionDueToScrollSnapping();
-#endif
+    startDeferringWheelEventTestCompletion(WheelEventTestMonitor::ScrollSnapInProgress);
     m_client.willStartScrollSnapAnimation();
     setIsAnimatingScrollSnap(true);
@@ -461 +458 @@
     LOG_WITH_STREAM(ScrollSnap, stream << "ScrollingEffectsController " << this << " stopScrollSnapAnimation (main thread " << isMainThread() << ")");
 
-#if PLATFORM(MAC)
-    stopDeferringWheelEventTestCompletionDueToScrollSnapping();
-#endif
+    stopDeferringWheelEventTestCompletion(WheelEventTestMonitor::ScrollSnapInProgress);
     m_client.didStopScrollSnapAnimation();
 
@@ -498 +493 @@
 #endif
 
+    startDeferringWheelEventTestCompletion(WheelEventTestMonitor::ScrollAnimationInProgress);
     startOrStopAnimationCallbacks();
 }
@@ -520 +516 @@
     m_client.didStopAnimatedScroll();
     startOrStopAnimationCallbacks();
+    stopDeferringWheelEventTestCompletion(WheelEventTestMonitor::ScrollAnimationInProgress);
 }
 
@@ -525 +522 @@
 {
     return m_client.scrollExtents();
+}
+
+void ScrollingEffectsController::startDeferringWheelEventTestCompletion(WheelEventTestMonitor::DeferReason reason)
+{
+    m_client.deferWheelEventTestCompletionForReason(reinterpret_cast<WheelEventTestMonitor::ScrollableAreaIdentifier>(this), reason);
+}
+
+void ScrollingEffectsController::stopDeferringWheelEventTestCompletion(WheelEventTestMonitor::DeferReason reason)
+{
+    m_client.removeWheelEventTestCompletionDeferralForReason(reinterpret_cast<WheelEventTestMonitor::ScrollableAreaIdentifier>(this), reason);
 }
 

trunk/Source/WebCore/platform/ScrollingEffectsController.h

@@ -202 +202 @@
     void statelessSnapTransitionTimerFired();
     void scheduleStatelessScrollSnap();
-    void startDeferringWheelEventTestCompletionDueToScrollSnapping();
-    void stopDeferringWheelEventTestCompletionDueToScrollSnapping();
 
     bool modifyScrollDeltaForStretching(const PlatformWheelEvent&, FloatSize&, bool isHorizontallyStretched, bool isVerticallyStretched);
@@ -225 +223 @@
 
     bool momentumScrollingAnimatorEnabled() const { return m_momentumScrollingAnimatorEnabled; }
+
+    void startDeferringWheelEventTestCompletion(WheelEventTestMonitor::DeferReason);
+    void stopDeferringWheelEventTestCompletion(WheelEventTestMonitor::DeferReason);
 
     // ScrollAnimationClient

trunk/Source/WebCore/platform/mac/ScrollingEffectsController.mm

@@ -32 +32 @@
 #import "ScrollExtents.h"
 #import "WheelEventDeltaFilter.h"
-#import "WheelEventTestMonitor.h"
 #import <pal/spi/mac/NSScrollViewSPI.h>
 #import <sys/sysctl.h>
@@ -681 +680 @@
     });
     m_statelessSnapTransitionTimer->startOneShot(statelessScrollSnapDelay);
-    startDeferringWheelEventTestCompletionDueToScrollSnapping();
+    startDeferringWheelEventTestCompletion(WheelEventTestMonitor::ScrollSnapInProgress);
 }
 
@@ -693 +692 @@
     if (m_scrollSnapState->transitionToSnapAnimationState(m_client.scrollExtents(), m_client.pageScaleFactor(), m_client.scrollOffset()))
         startScrollSnapAnimation();
-}
-
-void ScrollingEffectsController::startDeferringWheelEventTestCompletionDueToScrollSnapping()
-{
-    m_client.deferWheelEventTestCompletionForReason(reinterpret_cast<WheelEventTestMonitor::ScrollableAreaIdentifier>(this), WheelEventTestMonitor::ScrollSnapInProgress);
-}
-
-void ScrollingEffectsController::stopDeferringWheelEventTestCompletionDueToScrollSnapping()
-{
-    m_client.removeWheelEventTestCompletionDeferralForReason(reinterpret_cast<WheelEventTestMonitor::ScrollableAreaIdentifier>(this), WheelEventTestMonitor::ScrollSnapInProgress);
 }