Update Element API for CSSOM smooth scrolling to match the spec

Source/core/dom/Element.cpp

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2001 Peter Kelly (pmk@post.com)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
  *           (C) 2007 David Smith (catfish.man@gmail.com)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012, 2013 Apple Inc. All rights reserved.
  *           (C) 2007 Eric Seidel (eric@webkit.org)
  *
  * This library is free software; you can redistribute it and/or
@@ skipping 67 matching lines @@
 #include "core/editing/TextIterator.h"
 #include "core/editing/htmlediting.h"
 #include "core/editing/markup.h"
 #include "core/events/EventDispatcher.h"
 #include "core/events/FocusEvent.h"
 #include "core/frame/FrameHost.h"
 #include "core/frame/FrameView.h"
 #include "core/frame/LocalDOMWindow.h"
 #include "core/frame/LocalFrame.h"
 #include "core/frame/PinchViewport.h"
+#include "core/frame/ScrollToOptions.h"
 #include "core/frame/Settings.h"
 #include "core/frame/UseCounter.h"
 #include "core/frame/csp/ContentSecurityPolicy.h"
 #include "core/html/ClassList.h"
 #include "core/html/HTMLCanvasElement.h"
 #include "core/html/HTMLCollection.h"
 #include "core/html/HTMLDocument.h"
 #include "core/html/HTMLElement.h"
 #include "core/html/HTMLFormControlsCollection.h"
 #include "core/html/HTMLFrameElementBase.h"
@@ skipping 584 matching lines @@
         if (document().inQuirksMode())
             return;
 
         LocalFrame* frame = document().frame();
         if (!frame)
             return;
         FrameView* view = frame->view();
         if (!view)
             return;
 
-        view->setScrollPosition(DoublePoint(newLeft * frame->pageZoomFactor(), view->scrollY()));
+        view->setScrollPosition(DoublePoint(newLeft * frame->pageZoomFactor(), view->scrollY()), ScrollBehaviorAuto);
     }
 }
 
-void Element::setScrollLeft(const Dictionary& scrollOptionsHorizontal, ExceptionState& exceptionState)
-{
-    String scrollBehaviorString;
-    ScrollBehavior scrollBehavior = ScrollBehaviorAuto;
-    if (DictionaryHelper::get(scrollOptionsHorizontal, "behavior", scrollBehaviorString)) {
-        if (!ScrollableArea::scrollBehaviorFromString(scrollBehaviorString, scrollBehavior)) {
-            exceptionState.throwTypeError("The ScrollBehavior provided is invalid.");
-            return;
-        }
-    }
-
-    double position;
-    if (!DictionaryHelper::get(scrollOptionsHorizontal, "x", position)) {
-        exceptionState.throwTypeError("ScrollOptionsHorizontal must include an 'x' member.");
-        return;
-    }
-
-    // FIXME: Use scrollBehavior to decide whether to scroll smoothly or instantly.
-    setScrollLeft(position);
-}
-
 void Element::setScrollTop(double newTop)
 {
     document().updateLayoutIgnorePendingStylesheets();
 
     if (std::isnan(newTop))
         return;
 
     if (document().documentElement() != this) {
         RenderBox* rend = renderBox();
         if (rend)
             rend->setScrollTop(LayoutUnit::fromFloatRound(newTop * rend->style()->effectiveZoom()));
         return;
     }
 
     if (RuntimeEnabledFeatures::scrollTopLeftInteropEnabled()) {
         if (document().inQuirksMode())
             return;
 
         LocalFrame* frame = document().frame();
         if (!frame)
             return;
         FrameView* view = frame->view();
         if (!view)
             return;
 
-        view->setScrollPosition(DoublePoint(view->scrollX(), newTop * frame->pageZoomFactor()));
+        view->setScrollPosition(DoublePoint(view->scrollX(), newTop * frame->pageZoomFactor()), ScrollBehaviorAuto);
     }
 }
 
-void Element::setScrollTop(const Dictionary& scrollOptionsVertical, ExceptionState& exceptionState)
-{
-    String scrollBehaviorString;
-    ScrollBehavior scrollBehavior = ScrollBehaviorAuto;
-    if (DictionaryHelper::get(scrollOptionsVertical, "behavior", scrollBehaviorString)) {
-        if (!ScrollableArea::scrollBehaviorFromString(scrollBehaviorString, scrollBehavior)) {
-            exceptionState.throwTypeError("The ScrollBehavior provided is invalid.");
-            return;
-        }
-    }
-
-    double position;
-    if (!DictionaryHelper::get(scrollOptionsVertical, "y", position)) {
-        exceptionState.throwTypeError("ScrollOptionsVertical must include a 'y' member.");
-        return;
-    }
-
-    // FIXME: Use scrollBehavior to decide whether to scroll smoothly or instantly.
-    setScrollTop(position);
-}
-
 int Element::scrollWidth()
 {
     document().updateLayoutIgnorePendingStylesheets();
     if (RenderBox* rend = renderBox())
         return adjustLayoutUnitForAbsoluteZoom(rend->scrollWidth(), *rend).toDouble();
     return 0;
 }
 
 int Element::scrollHeight()
 {
     document().updateLayoutIgnorePendingStylesheets();
     if (RenderBox* rend = renderBox())
         return adjustLayoutUnitForAbsoluteZoom(rend->scrollHeight(), *rend).toDouble();
     return 0;
 }
 
+void Element::scrollBy(double x, double y)
+{
+    ScrollToOptions scrollToOptions;
+    scrollToOptions.setLeft(x);
+    scrollToOptions.setTop(y);
+    scrollBy(scrollToOptions);
+}
+
+void Element::scrollBy(const ScrollToOptions& scrollToOptions)
+{
+    document().updateLayoutIgnorePendingStylesheets();

[Ian Vollick, 2014/12/08 16:35:23]

Eventually, we'll want to process scrolls after compositing update. Will this
still be required when that's the case? If not, can you add comment referencing
the related bug (https://code.google.com/p/chromium/issues/detail?id=420741)?
(Here and in ::scrollTo)

[ajuma, 2014/12/08 18:34:13]

No, there's nothing smooth-scroll specific that requires this. Once this can be
removed for 'regular' scrolls (e.g. in setScrollTop/setScrollLeft) it can be
removed here too.
Done.

+
+    double left = scrollToOptions.hasLeft() ? scrollToOptions.left() : 0.0;
+    double top = scrollToOptions.hasTop() ? scrollToOptions.top() : 0.0;
+    if (std::isnan(left) || std::isnan(top))
+        return;
+
+    ScrollBehavior scrollBehavior = ScrollBehaviorAuto;
+    ScrollableArea::scrollBehaviorFromString(scrollToOptions.behavior(), scrollBehavior);
+
+    if (document().documentElement() != this) {
+        RenderBox* rend = renderBox();
+        if (rend) {
+            double currentScaledLeft = rend->scrollLeft();
+            double currentScaledTop = rend->scrollTop();
+            double newScaledLeft = left * rend->style()->effectiveZoom() + currentScaledLeft;
+            double newScaledTop = top * rend->style()->effectiveZoom() + currentScaledTop;
+            // FIXME: Use scrollBehavior to decide whether to scroll smoothly or instantly.
+            rend->scrollToOffset(DoubleSize(newScaledLeft, newScaledTop));
+        }
+        return;
+    }
+
+    if (RuntimeEnabledFeatures::scrollTopLeftInteropEnabled()) {
+        if (document().inQuirksMode())
+            return;
+
+        LocalFrame* frame = document().frame();
+        if (!frame)
+            return;
+        FrameView* view = frame->view();
+        if (!view)
+            return;
+
+        double newScaledLeft = left * frame->pageZoomFactor() + view->scrollX();
+        double newScaledTop = top * frame->pageZoomFactor() + view->scrollY();
+        view->setScrollPosition(DoublePoint(newScaledLeft, newScaledTop), scrollBehavior);
+    }
+}
+
+void Element::scrollTo(double x, double y)
+{
+    ScrollToOptions scrollToOptions;
+    scrollToOptions.setLeft(x);
+    scrollToOptions.setTop(y);
+    scrollTo(scrollToOptions);
+}
+
+void Element::scrollTo(const ScrollToOptions& scrollToOptions)
+{
+    document().updateLayoutIgnorePendingStylesheets();
+    if ((scrollToOptions.hasLeft() && std::isnan(scrollToOptions.left()))
+        || (scrollToOptions.hasTop() && std::isnan(scrollToOptions.top())))
+        return;
+
+    ScrollBehavior scrollBehavior = ScrollBehaviorAuto;
+    ScrollableArea::scrollBehaviorFromString(scrollToOptions.behavior(), scrollBehavior);
+
+    if (document().documentElement() != this) {
+        RenderBox* rend = renderBox();
+        if (rend) {
+            double scaledLeft = rend->scrollLeft();
+            double scaledTop = rend->scrollTop();
+            if (scrollToOptions.hasLeft())
+                scaledLeft = scrollToOptions.left() * rend->style()->effectiveZoom();
+            if (scrollToOptions.hasTop())
+                scaledTop = scrollToOptions.top() * rend->style()->effectiveZoom();
+            // FIXME: Use scrollBehavior to decide whether to scroll smoothly or instantly.
+            rend->scrollToOffset(DoubleSize(scaledLeft, scaledTop));
+        }
+        return;
+    }
+
+    if (RuntimeEnabledFeatures::scrollTopLeftInteropEnabled()) {
+        if (document().inQuirksMode())
+            return;
+
+        LocalFrame* frame = document().frame();
+        if (!frame)
+            return;
+        FrameView* view = frame->view();
+        if (!view)
+            return;
+
+        double scaledLeft = view->scrollX();
+        double scaledTop = view->scrollY();
+        if (scrollToOptions.hasLeft())
+            scaledLeft = scrollToOptions.left() * frame->pageZoomFactor();
+        if (scrollToOptions.hasTop())
+            scaledTop = scrollToOptions.top() * frame->pageZoomFactor();
+        view->setScrollPosition(DoublePoint(scaledLeft, scaledTop), scrollBehavior);
+    }
+}
+
 IntRect Element::boundsInRootViewSpace()
 {
     document().updateLayoutIgnorePendingStylesheets();
 
     FrameView* view = document().view();
     if (!view)
         return IntRect();
 
     Vector<FloatQuad> quads;
     if (isSVGElement() && renderer()) {
@@ skipping 2514 matching lines @@
         return wrapper;
 
     CustomElementBinding* binding = perContextData->customElementBinding(customElementDefinition());
 
     wrapper->SetPrototype(binding->prototype());
 
     return V8DOMWrapper::associateObjectWithWrapper(isolate, this, wrapperType, wrapper);
 }
 
 } // namespace blink