Handle nested position:sticky elements

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

 // Copyright 2016 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.
 
 #ifndef StickyPositionScrollingConstraints_h
 #define StickyPositionScrollingConstraints_h
 
 #include "platform/geometry/FloatRect.h"
+#include "platform/geometry/FloatSize.h"
 
 namespace blink {
 
+class LayoutBoxModelObject;
+
 class StickyPositionScrollingConstraints final {
  public:
   enum AnchorEdgeFlags {
     AnchorEdgeLeft = 1 << 0,
     AnchorEdgeRight = 1 << 1,
     AnchorEdgeTop = 1 << 2,
     AnchorEdgeBottom = 1 << 3
   };
   typedef unsigned AnchorEdges;
 
   StickyPositionScrollingConstraints()
       : m_anchorEdges(0),
         m_leftOffset(0),
         m_rightOffset(0),
         m_topOffset(0),
-        m_bottomOffset(0) {}
+        m_bottomOffset(0),
+        m_nearestStickyElementToContainingBlock(nullptr),
+        m_nearestStickyElementFromContainingBlockToScrollContainer(nullptr) {}
 
   StickyPositionScrollingConstraints(
       const StickyPositionScrollingConstraints& other)
       : m_anchorEdges(other.m_anchorEdges),
         m_leftOffset(other.m_leftOffset),
         m_rightOffset(other.m_rightOffset),
         m_topOffset(other.m_topOffset),
         m_bottomOffset(other.m_bottomOffset),
         m_scrollContainerRelativeContainingBlockRect(
             other.m_scrollContainerRelativeContainingBlockRect),
         m_scrollContainerRelativeStickyBoxRect(
-            other.m_scrollContainerRelativeStickyBoxRect) {}
+            other.m_scrollContainerRelativeStickyBoxRect),
+        m_nearestStickyElementToContainingBlock(
+            other.m_nearestStickyElementToContainingBlock),
+        m_nearestStickyElementFromContainingBlockToScrollContainer(
+            other.m_nearestStickyElementFromContainingBlockToScrollContainer),
+        m_accumulatedStickyOffsetToContainingBlock(
+            other.m_accumulatedStickyOffsetToContainingBlock),
+        m_accumulatedStickyOffsetFromContainingBlockToScrollContainer(
+            other
+                .m_accumulatedStickyOffsetFromContainingBlockToScrollContainer) {
+  }
 
-  FloatSize computeStickyOffset(const FloatRect& viewportRect) const;
+  FloatSize computeStickyOffset(const FloatRect& viewportRect,
+                                const FloatSize& accumulatedToCB,
+                                const FloatSize& accumulatedToVP);
+
+  bool hasAncestorStickyElement() {
+    return m_nearestStickyElementToContainingBlock ||
+           m_nearestStickyElementFromContainingBlockToScrollContainer;
+  }
 
   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; }
 
   float leftOffset() const { return m_leftOffset; }
   float rightOffset() const { return m_rightOffset; }
@@ skipping 12 matching lines @@
     return m_scrollContainerRelativeContainingBlockRect;
   }
 
   void setScrollContainerRelativeStickyBoxRect(const FloatRect& rect) {
     m_scrollContainerRelativeStickyBoxRect = rect;
   }
   const FloatRect& scrollContainerRelativeStickyBoxRect() const {
     return m_scrollContainerRelativeStickyBoxRect;
   }
 
+  void setNearestStickyElementToContainingBlock(LayoutBoxModelObject* layer) {
+    m_nearestStickyElementToContainingBlock = layer;
+  }
+  const LayoutBoxModelObject* nearestStickyElementToContainingBlock() {
+    return m_nearestStickyElementToContainingBlock;
+  }
+
+  void setNearestStickyElementFromContainingBlockToScrollContainer(
+      LayoutBoxModelObject* layer) {
+    m_nearestStickyElementFromContainingBlockToScrollContainer = layer;
+  }
+  const LayoutBoxModelObject*
+  nearestStickyElementFromContainingBlockToScrollContainer() {
+    return m_nearestStickyElementFromContainingBlockToScrollContainer;
+  }
+
+  const FloatSize& getAccumulatedStickyOffsetToContainingBlock() {
+    return m_accumulatedStickyOffsetToContainingBlock;
+  }
+  const FloatSize&
+  getAccumulatedStickyOffsetFromContainingBlockToScrollContainer() {
+    return m_accumulatedStickyOffsetFromContainingBlockToScrollContainer;
+  }
+
   bool operator==(const StickyPositionScrollingConstraints& other) const {
     return m_leftOffset == other.m_leftOffset &&
            m_rightOffset == other.m_rightOffset &&
            m_topOffset == other.m_topOffset &&
            m_bottomOffset == other.m_bottomOffset &&
            m_scrollContainerRelativeContainingBlockRect ==
                other.m_scrollContainerRelativeContainingBlockRect &&
            m_scrollContainerRelativeStickyBoxRect ==
-               other.m_scrollContainerRelativeStickyBoxRect;
+               other.m_scrollContainerRelativeStickyBoxRect &&
+           m_nearestStickyElementToContainingBlock ==
+               other.m_nearestStickyElementToContainingBlock &&
+           m_nearestStickyElementFromContainingBlockToScrollContainer ==
+               other
+                   .m_nearestStickyElementFromContainingBlockToScrollContainer &&
+           m_accumulatedStickyOffsetToContainingBlock ==
+               other.m_accumulatedStickyOffsetToContainingBlock &&
+           m_accumulatedStickyOffsetFromContainingBlockToScrollContainer ==
+               other
+                   .m_accumulatedStickyOffsetFromContainingBlockToScrollContainer;
   }
 
   bool operator!=(const StickyPositionScrollingConstraints& other) const {
     return !(*this == other);
   }
 
  private:
   AnchorEdges m_anchorEdges;
   float m_leftOffset;
   float m_rightOffset;
   float m_topOffset;
   float m_bottomOffset;
   FloatRect m_scrollContainerRelativeContainingBlockRect;
   FloatRect m_scrollContainerRelativeStickyBoxRect;
+
+  // In order to properly compute the stickyOffset, we need to know if we have
+  // any sticky ancestors both between ourselves and our containingBlock and
+  // between our containingBlock and the viewport.
+  //
+  // Any such ancestors are computed at layout time, and then the accumulated
+  // offset from them is recomputed after each scroll update.
+  LayoutBoxModelObject* m_nearestStickyElementToContainingBlock;
+  LayoutBoxModelObject*
+      m_nearestStickyElementFromContainingBlockToScrollContainer;

[flackr, 2017/01/20 02:42:44]

Maybe m_nearestStickyElementShifting(ContainingBlock|StickyBox)?

[smcgruer, 2017/01/24 15:45:22]

Done.

+
+  // For performance, we cache our accumulated sticky offset for descendant
+  // sticky elements to use. Because we can either be the "to containing block"

[flackr, 2017/01/20 02:42:44]

nit: explain that we offset the constraint rects of descendants by these.

[smcgruer, 2017/01/24 15:45:22]

Done.

+  // or the "to scroll container" ancestor for a given sticky element, we need
+  // to accumulate both.
+  //
+  // NOTE(smcgruer): The case where we can be both a "to containing block"
+  // and a "to scroll container" ancestor for different sticky descendants is
+  // quite complex. See the NAME_ME test in LayoutBoxModelObjectTest.cpp.
+  FloatSize m_accumulatedStickyOffsetToContainingBlock;
+  FloatSize m_accumulatedStickyOffsetFromContainingBlockToScrollContainer;

[flackr, 2017/01/20 02:42:44]

How about m_totalStickyBoxStickyOffset and m_totalContainingBlockStickyOffset?

[smcgruer, 2017/01/24 15:45:22]

Done.

 };
 
 }  // namespace blink
 
 #endif  // StickyPositionScrollingConstraints_h