Changeset 277069 in webkit

Timestamp:

May 5, 2021 11:43:14 PM (3 years ago)

Author:

Megan Gardner

Message:

AppHighlight scrolls should be smooth
​https://bugs.webkit.org/show_bug.cgi?id=225395

Reviewed by Simon Fraser.

Leverage smooth scrolling experimental feature to allow AppHighlight scrolls
to be smooth.

• Modules/highlight/AppHighlightStorage.cpp:

(WebCore::AppHighlightStorage::attemptToRestoreHighlightAndScroll):

• editing/Editor.cpp:

(WebCore::TemporarySelectionChange::setSelection):

• editing/Editor.h:
• editing/FrameSelection.cpp:

(WebCore::FrameSelection::setSelection):
(WebCore::FrameSelection::updateAndRevealSelection):
(WebCore::FrameSelection::revealSelection):

• editing/FrameSelection.h:
• page/DOMWindow.cpp:

(WebCore::DOMWindow::scrollTo const):

• page/ScrollBehavior.cpp:

(WebCore::useSmoothScrolling):

• platform/ScrollTypes.h:

Location:

trunk/Source/WebCore

Files:

• ChangeLog (modified) (1 diff)
• Modules/highlight/AppHighlightStorage.cpp (modified) (1 diff)
• dom/Element.cpp (modified) (1 diff)
• editing/Editor.cpp (modified) (1 diff)
• editing/Editor.h (modified) (1 diff)
• editing/FrameSelection.cpp (modified) (6 diffs)
• editing/FrameSelection.h (modified) (4 diffs)
• page/ScrollBehavior.cpp (modified) (2 diffs)
• page/ScrollBehavior.h (modified) (1 diff)
• rendering/RenderLayer.cpp (modified) (1 diff)
• rendering/RenderLayer.h (modified) (1 diff)

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2021-05-05  Megan Gardner  <megan_gardner@apple.com>
+
+        AppHighlight scrolls should be smooth
+        https://bugs.webkit.org/show_bug.cgi?id=225395
+
+        Reviewed by Simon Fraser.
+
+        Leverage smooth scrolling experimental feature to allow AppHighlight scrolls
+        to be smooth.
+
+        * Modules/highlight/AppHighlightStorage.cpp:
+        (WebCore::AppHighlightStorage::attemptToRestoreHighlightAndScroll):
+        * editing/Editor.cpp:
+        (WebCore::TemporarySelectionChange::setSelection):
+        * editing/Editor.h:
+        * editing/FrameSelection.cpp:
+        (WebCore::FrameSelection::setSelection):
+        (WebCore::FrameSelection::updateAndRevealSelection):
+        (WebCore::FrameSelection::revealSelection):
+        * editing/FrameSelection.h:
+        * page/DOMWindow.cpp:
+        (WebCore::DOMWindow::scrollTo const):
+        * page/ScrollBehavior.cpp:
+        (WebCore::useSmoothScrolling):
+        * platform/ScrollTypes.h:
+
 2021-05-05  Mark Lam  <mark.lam@apple.com>
 

trunk/Source/WebCore/Modules/highlight/AppHighlightStorage.cpp

@@ -261 +261 @@
     strongDocument->appHighlightRegister().addAppHighlight(StaticRange::create(*range));
     
-    if (scroll == ScrollToHighlight::Yes) {
-        OptionSet<TemporarySelectionOption> temporarySelectionOptions;
-        temporarySelectionOptions.add(TemporarySelectionOption::RevealSelection);
-        TemporarySelectionChange selectionChange(*strongDocument, { range.value() }, temporarySelectionOptions);
-    }
+    if (scroll == ScrollToHighlight::Yes)
+        TemporarySelectionChange selectionChange(*strongDocument, { range.value() }, { TemporarySelectionOption::RevealSelection, TemporarySelectionOption::SmoothScroll, TemporarySelectionOption::OverrideSmoothScrollFeatureEnablment });
+
     return true;
 }

trunk/Source/WebCore/dom/Element.cpp

@@ -937 +937 @@
         isHorizontal ? alignY : alignX,
         ShouldAllowCrossOriginScrolling::No,
-        options.behavior.valueOr(ScrollBehavior::Auto)
+        options.behavior.valueOr(ScrollBehavior::Auto),
+        SmoothScrollFeatureEnablement::Default
     };
     renderer()->scrollRectToVisible(absoluteBounds, insideFixed, visibleOptions);

trunk/Source/WebCore/editing/Editor.cpp

@@ -266 +266 @@
     if (m_options & TemporarySelectionOption::RevealSelection)
         options.add(FrameSelection::RevealSelection);
+    if (m_options & TemporarySelectionOption::SmoothScroll)
+        options.add(FrameSelection::SmoothScroll);
+    if (m_options & TemporarySelectionOption::OverrideSmoothScrollFeatureEnablment)
+        options.add(FrameSelection::OverrideSmoothScrollFeatureEnablement);
     m_document->selection().setSelection(selection, options);
 }

trunk/Source/WebCore/editing/Editor.h

@@ -119 +119 @@
     // Force the render tree to update selection state. Only respected on iOS.
     EnableAppearanceUpdates = 1 << 3,
+    
+    SmoothScroll = 1 << 4,
+    
+    OverrideSmoothScrollFeatureEnablment = 1 << 5,
 };
 

trunk/Source/WebCore/editing/FrameSelection.cpp

@@ -445 +445 @@
         return;
 
-    updateAndRevealSelection(intent);
+    updateAndRevealSelection(intent, options.contains(SmoothScroll) ? ScrollBehavior::Smooth : ScrollBehavior::Instant, options.contains(OverrideSmoothScrollFeatureEnablement) ? SmoothScrollFeatureEnablement::Override : SmoothScrollFeatureEnablement::Default);
 
     if (options & IsUserTriggered) {
@@ -472 +472 @@
 }
 
-void FrameSelection::updateAndRevealSelection(const AXTextStateChangeIntent& intent)
+void FrameSelection::updateAndRevealSelection(const AXTextStateChangeIntent& intent, ScrollBehavior scrollBehavior, SmoothScrollFeatureEnablement overideFeatureEnablement)
 {
     if (!m_pendingSelectionUpdate)
@@ -489 +489 @@
             alignment = m_alwaysAlignCursorOnScrollWhenRevealingSelection ? ScrollAlignment::alignTopAlways : ScrollAlignment::alignToEdgeIfNeeded;
 
-        revealSelection(m_selectionRevealMode, alignment, RevealExtent);
+        revealSelection(m_selectionRevealMode, alignment, RevealExtent, scrollBehavior, overideFeatureEnablement);
     }
 
@@ -2379 +2379 @@
 }
 
-void FrameSelection::revealSelection(SelectionRevealMode revealMode, const ScrollAlignment& alignment, RevealExtentOption revealExtentOption)
+void FrameSelection::revealSelection(SelectionRevealMode revealMode, const ScrollAlignment& alignment, RevealExtentOption revealExtentOption, ScrollBehavior scrollBehavior, SmoothScrollFeatureEnablement overrideFeatureEnablement)
 {
     if (revealMode == SelectionRevealMode::DoNotReveal)
@@ -2402 +2402 @@
                 auto* scrollableArea = layer->ensureLayerScrollableArea();
                 scrollableArea->setAdjustForIOSCaretWhenScrolling(true);
-                layer->scrollRectToVisible(rect, insideFixed, { revealMode, alignment, alignment, ShouldAllowCrossOriginScrolling::Yes });
+                layer->scrollRectToVisible(rect, insideFixed, { revealMode, alignment, alignment, ShouldAllowCrossOriginScrolling::Yes, scrollBehavior, overrideFeatureEnablement});
                 scrollableArea->setAdjustForIOSCaretWhenScrolling(false);
                 updateAppearance();
@@ -2413 +2413 @@
         // the selection rect could intersect more than just that.
         // See <rdar://problem/4799899>.
-        if (start.deprecatedNode()->renderer()->scrollRectToVisible(rect, insideFixed, { revealMode, alignment, alignment, ShouldAllowCrossOriginScrolling::Yes }))
+        if (start.deprecatedNode()->renderer()->scrollRectToVisible(rect, insideFixed, { revealMode, alignment, alignment, ShouldAllowCrossOriginScrolling::Yes, scrollBehavior, overrideFeatureEnablement}))
             updateAppearance();
 #endif

trunk/Source/WebCore/editing/FrameSelection.h

@@ -33 +33 @@
 #include "LayoutRect.h"
 #include "ScrollAlignment.h"
+#include "ScrollBehavior.h"
 #include "Timer.h"
 #include "VisibleSelection.h"
@@ -123 +124 @@
         RevealSelection = 1 << 7,
         RevealSelectionUpToMainFrame = 1 << 8,
+        SmoothScroll = 1 << 9,
+        OverrideSmoothScrollFeatureEnablement = 1 << 10
     };
     static constexpr OptionSet<SetSelectionOption> defaultSetSelectionOptions(EUserTriggered = NotUserTriggered);
@@ -246 +249 @@
     WEBCORE_EXPORT HTMLFormElement* currentForm() const;
 
-    WEBCORE_EXPORT void revealSelection(SelectionRevealMode = SelectionRevealMode::Reveal, const ScrollAlignment& = ScrollAlignment::alignCenterIfNeeded, RevealExtentOption = DoNotRevealExtent);
+    WEBCORE_EXPORT void revealSelection(SelectionRevealMode = SelectionRevealMode::Reveal, const ScrollAlignment& = ScrollAlignment::alignCenterIfNeeded, RevealExtentOption = DoNotRevealExtent, ScrollBehavior = ScrollBehavior::Instant, SmoothScrollFeatureEnablement = SmoothScrollFeatureEnablement::Default);
     WEBCORE_EXPORT void setSelectionFromNone();
 
@@ -261 +264 @@
 
 private:
-    void updateAndRevealSelection(const AXTextStateChangeIntent&);
+    void updateAndRevealSelection(const AXTextStateChangeIntent&, ScrollBehavior = ScrollBehavior::Instant, SmoothScrollFeatureEnablement = SmoothScrollFeatureEnablement::Override);
     void updateDataDetectorsForSelection();
 

trunk/Source/WebCore/page/ScrollBehavior.cpp

@@ -34 +34 @@
 namespace WebCore {
 
-bool useSmoothScrolling(ScrollBehavior behavior, Element* associatedElement)
+bool useSmoothScrolling(ScrollBehavior behavior, Element* associatedElement, SmoothScrollFeatureEnablement overrideFeatureEnablement)
 {
     if (!associatedElement)
@@ -44 +44 @@
         associatedElement = associatedElement->document().documentElement();
 
-    if (!associatedElement->renderer() || !associatedElement->document().settings().CSSOMViewSmoothScrollingEnabled())
+    if (!associatedElement->renderer() || (overrideFeatureEnablement == SmoothScrollFeatureEnablement::Default && !associatedElement->document().settings().CSSOMViewSmoothScrollingEnabled()))
         return false;
 

trunk/Source/WebCore/page/ScrollBehavior.h

@@ -36 +36 @@
 };
 
-bool useSmoothScrolling(ScrollBehavior, Element* associatedElement);
+enum class SmoothScrollFeatureEnablement : bool { Default, Override };
+
+bool useSmoothScrolling(ScrollBehavior, Element* associatedElement, SmoothScrollFeatureEnablement = SmoothScrollFeatureEnablement::Default);
 
 } // namespace WebCore

trunk/Source/WebCore/rendering/RenderLayer.cpp

@@ -2408 +2408 @@
     {
         auto scrollPositionOptions = ScrollPositionChangeOptions::createProgrammatic();
-        if (!renderer().frame().eventHandler().autoscrollInProgress() && element && useSmoothScrolling(options.behavior, element))
+        if (!renderer().frame().eventHandler().autoscrollInProgress() && element && useSmoothScrolling(options.behavior, element, options.overrideFeatureEnablement))
             scrollPositionOptions.animated = AnimatedScroll::Yes;
         return scrollPositionOptions;

trunk/Source/WebCore/rendering/RenderLayer.h

@@ -142 +142 @@
     ShouldAllowCrossOriginScrolling shouldAllowCrossOriginScrolling { ShouldAllowCrossOriginScrolling::No };
     ScrollBehavior behavior { ScrollBehavior::Auto };
+    SmoothScrollFeatureEnablement overrideFeatureEnablement { SmoothScrollFeatureEnablement::Default };
 };