Adapt and reland old position sticky implementation

third_party/WebKit/Source/core/page/scrolling/ScrollingConstraints.h

 /*
  * Copyright (C) 2012 Apple Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
  *    documentation and/or other materials provided with the distribution.
  *
  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  * THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef ScrollingConstraints_h
 #define ScrollingConstraints_h
 
-#include "platform/geometry/FloatRect.h"
+#include "platform/geometry/LayoutRect.h"
 #include "wtf/Allocator.h"
 
 namespace blink {
 
 // ViewportConstraints classes encapsulate data and logic required to reposition elements whose layout
-// depends on the viewport rect (i.e., position fixed), when scrolling and zooming.
+// depends on the viewport rect (positioned fixed and sticky), when scrolling and zooming.
 class ViewportConstraints {
     STACK_ALLOCATED();
 public:
-    // FIXME: Simplify this code now that position: sticky doesn't exist.
     enum ConstraintType {
         FixedPositionConstaint,
+        StickyPositionConstraint,
     };
 
     enum AnchorEdgeFlags {
         AnchorEdgeLeft = 1 << 0,
         AnchorEdgeRight = 1 << 1,
         AnchorEdgeTop = 1 << 2,
         AnchorEdgeBottom = 1 << 3
     };
     typedef unsigned AnchorEdges;
 
     ViewportConstraints(const ViewportConstraints& other)
         : m_alignmentOffset(other.m_alignmentOffset)
         , m_anchorEdges(other.m_anchorEdges)
     { }
 
     virtual ~ViewportConstraints() { }
 
     virtual ConstraintType constraintType() const = 0;
 
     AnchorEdges anchorEdges() const { return m_anchorEdges; }
     bool hasAnchorEdge(AnchorEdgeFlags flag) const { return m_anchorEdges & flag; }
     void addAnchorEdge(AnchorEdgeFlags edgeFlag) { m_anchorEdges |= edgeFlag; }
     void setAnchorEdges(AnchorEdges edges) { m_anchorEdges = edges; }
 
-    FloatSize alignmentOffset() const { return m_alignmentOffset; }
-    void setAlignmentOffset(const FloatSize& offset) { m_alignmentOffset = offset; }
+    LayoutSize alignmentOffset() const { return m_alignmentOffset; }
+    void setAlignmentOffset(const LayoutSize& offset) { m_alignmentOffset = offset; }
 
 protected:
     ViewportConstraints()
         : m_anchorEdges(0)
     { }
 
-    FloatSize m_alignmentOffset;
+    LayoutSize m_alignmentOffset;
     AnchorEdges m_anchorEdges;
 };
 
 class FixedPositionViewportConstraints final : public ViewportConstraints {
     STACK_ALLOCATED();
 public:
     FixedPositionViewportConstraints()
         : ViewportConstraints()
     { }
 
     FixedPositionViewportConstraints(const FixedPositionViewportConstraints& other)
         : ViewportConstraints(other)
         , m_viewportRectAtLastLayout(other.m_viewportRectAtLastLayout)
         , m_layerPositionAtLastLayout(other.m_layerPositionAtLastLayout)
     { }
 
-    FloatPoint layerPositionForViewportRect(const FloatRect& viewportRect) const;

[chrishtr, 2015/12/09 19:12:21]

Not called, remove.

[flackr, 2015/12/10 23:43:15]

Done.

+    LayoutPoint layerPositionForViewportRect(const LayoutRect& viewportRect) const;
 
-    const FloatRect& viewportRectAtLastLayout() const { return m_viewportRectAtLastLayout; }

[chrishtr, 2015/12/09 19:12:21]

Maybe a bunch of these are never called?

[flackr, 2015/12/10 23:43:15]

Done.

-    void setViewportRectAtLastLayout(const FloatRect& rect) { m_viewportRectAtLastLayout = rect; }
+    const LayoutRect& viewportRectAtLastLayout() const { return m_viewportRectAtLastLayout; }
+    void setViewportRectAtLastLayout(const LayoutRect& rect) { m_viewportRectAtLastLayout = rect; }
 
-    const FloatPoint& layerPositionAtLastLayout() const { return m_layerPositionAtLastLayout; }
-    void setLayerPositionAtLastLayout(const FloatPoint& point) { m_layerPositionAtLastLayout = point; }
+    const LayoutPoint& layerPositionAtLastLayout() const { return m_layerPositionAtLastLayout; }
+    void setLayerPositionAtLastLayout(const LayoutPoint& point) { m_layerPositionAtLastLayout = point; }
 
     bool operator==(const FixedPositionViewportConstraints& other) const
     {
         return m_alignmentOffset == other.m_alignmentOffset
             && m_anchorEdges == other.m_anchorEdges
             && m_viewportRectAtLastLayout == other.m_viewportRectAtLastLayout
             && m_layerPositionAtLastLayout == other.m_layerPositionAtLastLayout;
     }
 
     bool operator!=(const FixedPositionViewportConstraints& other) const { return !(*this == other); }
 
 private:
     ConstraintType constraintType() const override { return FixedPositionConstaint; }
 
-    FloatRect m_viewportRectAtLastLayout;

[chrishtr, 2015/12/09 19:12:21]

Remove these if not called.

[flackr, 2015/12/10 23:43:15]

Done.

-    FloatPoint m_layerPositionAtLastLayout;
+    LayoutRect m_viewportRectAtLastLayout;
+    LayoutPoint m_layerPositionAtLastLayout;
+};
+
+class StickyPositionViewportConstraints final : public ViewportConstraints {
+public:
+    StickyPositionViewportConstraints()
+        : m_leftOffset(0)
+        , m_rightOffset(0)
+        , m_topOffset(0)
+        , m_bottomOffset(0)
+    { }
+
+    StickyPositionViewportConstraints(const StickyPositionViewportConstraints& other)
+        : ViewportConstraints(other)
+        , m_leftOffset(other.m_leftOffset)
+        , m_rightOffset(other.m_rightOffset)
+        , m_topOffset(other.m_topOffset)
+        , m_bottomOffset(other.m_bottomOffset)
+        , m_absoluteContainingBlockRect(other.m_absoluteContainingBlockRect)
+        , m_absoluteStickyBoxRect(other.m_absoluteStickyBoxRect)
+        , m_stickyOffsetAtLastLayout(other.m_stickyOffsetAtLastLayout)
+        , m_layerPositionAtLastLayout(other.m_layerPositionAtLastLayout)
+    { }
+
+    LayoutSize computeStickyOffset(const LayoutRect& viewportRect) const;
+
+    const LayoutSize stickyOffsetAtLastLayout() const { return m_stickyOffsetAtLastLayout; }

[chrishtr, 2015/12/09 19:12:21]

Remove the unused accessor functions for now.

[flackr, 2015/12/10 23:43:15]

Done.

+    void setStickyOffsetAtLastLayout(const LayoutSize& offset) { m_stickyOffsetAtLastLayout = offset; }
+
+    LayoutPoint layerPositionForViewportRect(const LayoutRect& viewportRect) const;
+
+    const LayoutPoint& layerPositionAtLastLayout() const { return m_layerPositionAtLastLayout; }
+    void setLayerPositionAtLastLayout(const LayoutPoint& point) { m_layerPositionAtLastLayout = point; }
+
+    LayoutUnit leftOffset() const { return m_leftOffset; }
+    LayoutUnit rightOffset() const { return m_rightOffset; }
+    LayoutUnit topOffset() const { return m_topOffset; }
+    LayoutUnit bottomOffset() const { return m_bottomOffset; }
+
+    void setLeftOffset(LayoutUnit offset) { m_leftOffset = offset; }
+    void setRightOffset(LayoutUnit offset) { m_rightOffset = offset; }
+    void setTopOffset(LayoutUnit offset) { m_topOffset = offset; }
+    void setBottomOffset(LayoutUnit offset) { m_bottomOffset = offset; }
+
+    LayoutRect absoluteContainingBlockRect() const { return m_absoluteContainingBlockRect; }

[chrishtr, 2015/12/09 19:12:21]

Remove the accesssor function, not used.

[flackr, 2015/12/10 23:43:15]

Done, as well as absoluteStickyBoxRect().

+    void setAbsoluteContainingBlockRect(const LayoutRect& rect) { m_absoluteContainingBlockRect = rect; }
+
+    LayoutRect absoluteStickyBoxRect() const { return m_absoluteStickyBoxRect; }
+    void setAbsoluteStickyBoxRect(const LayoutRect& rect) { m_absoluteStickyBoxRect = rect; }
+
+    bool operator==(const StickyPositionViewportConstraints& other) const
+    {
+        return m_leftOffset == other.m_leftOffset
+            && m_rightOffset == other.m_rightOffset
+            && m_topOffset == other.m_topOffset
+            && m_bottomOffset == other.m_bottomOffset
+            && m_absoluteContainingBlockRect == other.m_absoluteContainingBlockRect
+            && m_absoluteStickyBoxRect == other.m_absoluteStickyBoxRect
+            && m_stickyOffsetAtLastLayout == other.m_stickyOffsetAtLastLayout
+            && m_layerPositionAtLastLayout == other.m_layerPositionAtLastLayout;
+    }
+
+    bool operator!=(const StickyPositionViewportConstraints& other) const { return !(*this == other); }
+
+private:
+    ConstraintType constraintType() const override { return StickyPositionConstraint; }
+
+    LayoutUnit m_leftOffset;
+    LayoutUnit m_rightOffset;
+    LayoutUnit m_topOffset;
+    LayoutUnit m_bottomOffset;
+    LayoutRect m_absoluteContainingBlockRect;
+    LayoutRect m_absoluteStickyBoxRect;
+    LayoutSize m_stickyOffsetAtLastLayout;
+    LayoutPoint m_layerPositionAtLastLayout;
 };
 
 } // namespace blink
 
 #endif // ScrollingConstraints_h