Handle nested position:sticky elements

third_party/WebKit/Source/core/layout/LayoutBoxModelObject.cpp

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2005 Allan Sandfeld Jensen (kde@carewolf.com)
  *           (C) 2005, 2006 Samuel Weinig (sam.weinig@gmail.com)
  * Copyright (C) 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
  * Copyright (C) 2010 Google Inc. All rights reserved.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ skipping 769 matching lines @@
   FloatSize skippedContainersOffset;
   LayoutBlock* containingBlock = this->containingBlock();
   // The location container for boxes is not always the containing block.
   LayoutBox* locationContainer = isLayoutInline()
                                      ? containingBlock
                                      : toLayoutBox(this)->locationContainer();
   // Skip anonymous containing blocks.
   while (containingBlock->isAnonymous()) {
     containingBlock = containingBlock->containingBlock();
   }
-  MapCoordinatesFlags flags = 0;
+  MapCoordinatesFlags flags = IgnoreSticky;
   skippedContainersOffset =
       toFloatSize(locationContainer
                       ->localToAncestorQuadWithoutTransforms(
                           FloatQuad(), containingBlock, flags)
                       .boundingBox()
                       .location());
   LayoutBox* scrollAncestor =
       layer()->ancestorOverflowLayer()->isRootLayer()
           ? nullptr
           : toLayoutBox(layer()->ancestorOverflowLayer()->layoutObject());
@@ skipping 77 matching lines @@
   // the container is our scroll ancestor, we also need to remove the border
   // box because we want the position from within the scroller border.
   FloatSize containerBorderOffset(containingBlock->borderLeft(),
                                   containingBlock->borderTop());
   stickyLocation -= containerBorderOffset;
   constraints.setScrollContainerRelativeStickyBoxRect(
       FloatRect(scrollContainerRelativePaddingBoxRect.location() +
                     toFloatSize(stickyLocation),
                 flippedStickyBoxRect.size()));
 
+  // To correctly compute the offsets, the constraints need to know about any
+  // nested position:sticky between themselves and their containingBlock, and
+  // between the containingBlock and their scrollAncestor.
+  //
+  // The respective search ranges are [container, containingBlock) and
+  // [containingBlock, scrollAncestor).
+
+  // TODO(smcgruer): Fold these into the walks to find the containingBlock and
+  // scrollAncestor.
+  LayoutObject* maybeStickyAncestor = locationContainer;
+  while (maybeStickyAncestor && maybeStickyAncestor != containingBlock) {
+    if (maybeStickyAncestor->isStickyPositioned()) {
+      constraints.setNearestStickyElementShiftingStickyBox(
+          toLayoutBoxModelObject(maybeStickyAncestor));
+      break;
+    }
+    maybeStickyAncestor =
+        maybeStickyAncestor->isLayoutInline()
+            ? maybeStickyAncestor->containingBlock()
+            : toLayoutBox(maybeStickyAncestor)->locationContainer();
+  }

[flackr, 2017/01/31 18:33:00]

Create a function for this common loop code, maybe
enclosingStickyObjectBetween(start, ancestor)?

[smcgruer, 2017/01/31 20:42:16]

I was intended to look at folding these into the walks for finding the
containingBlock/scrollAncestor - do you think we should postpone that for a
follow-up CL and just create a common function atm?

[flackr, 2017/02/02 18:18:11]

Yes, we should just clean it up with a helper function for this patch.

+
+  // NOTE(smcgruer): We cannot use |scrollAncestor| here as it disregards the
+  // root ancestorOverflowLayer(), which we should include for the purposes of
+  // finding the nearest sticky element that shifts the containing block rect.
+  LayoutObject* ancestorOverflowLayer =
+      layer()->ancestorOverflowLayer()->layoutObject();
+  maybeStickyAncestor = containingBlock;
+  while (maybeStickyAncestor && maybeStickyAncestor != ancestorOverflowLayer) {
+    if (maybeStickyAncestor->isStickyPositioned()) {
+      constraints.setNearestStickyElementShiftingContainingBlock(
+          toLayoutBoxModelObject(maybeStickyAncestor));
+      break;
+    }
+    maybeStickyAncestor =
+        maybeStickyAncestor->isLayoutInline()
+            ? maybeStickyAncestor->containingBlock()
+            : toLayoutBox(maybeStickyAncestor)->locationContainer();
+  }
+
   // We skip the right or top sticky offset if there is not enough space to
   // honor both the left/right or top/bottom offsets.
   LayoutUnit horizontalOffsets =
       minimumValueForLength(style()->right(),
                             LayoutUnit(constrainingSize.width())) +
       minimumValueForLength(style()->left(),
                             LayoutUnit(constrainingSize.width()));
   bool skipRight = false;
   bool skipLeft = false;
   if (!style()->left().isAuto() && !style()->right().isAuto()) {
@@ skipping 77 matching lines @@
 LayoutSize LayoutBoxModelObject::stickyPositionOffset() const {
   const PaintLayer* ancestorOverflowLayer = layer()->ancestorOverflowLayer();
   // TODO: Force compositing input update if we ask for offset before
   // compositing inputs have been computed?
   if (!ancestorOverflowLayer)
     return LayoutSize();
   FloatRect constrainingRect = computeStickyConstrainingRect();
   PaintLayerScrollableArea* scrollableArea =
       ancestorOverflowLayer->getScrollableArea();
 
+  auto it = scrollableArea->stickyConstraintsMap().find(layer());
+
   // The sticky offset is physical, so we can just return the delta computed in
   // absolute coords (though it may be wrong with transforms).
   // TODO: Force compositing input update if we ask for offset with stale
   // compositing inputs.
-  if (!scrollableArea->stickyConstraintsMap().contains(layer()))
+  if (it == scrollableArea->stickyConstraintsMap().end())
     return LayoutSize();
+
+  StickyPositionScrollingConstraints& constraints = it->value;
+
+  FloatSize ancestorStickyBoxOffset;
+  FloatSize ancestorContainingBlockOffset;
+
+  const LayoutBoxModelObject* toContainingBlock =
+      constraints.nearestStickyElementShiftingStickyBox();
+  if (toContainingBlock) {
+    ancestorStickyBoxOffset = scrollableArea->stickyConstraintsMap()
+                                  .get(toContainingBlock->layer())

[flackr, 2017/01/31 18:33:00]

nit: Helper function to get sticky constraints for the given layout object?

[smcgruer, 2017/01/31 20:42:16]

Done.

+                                  .getTotalStickyBoxStickyOffset();

[flackr, 2017/01/31 18:33:00]

It'd probably be cleaner to get these as part of computeStickyOffset as this
also updates these total offsets. We could maybe pass references to the
StickyPositionScrollingConstraints of these ancestors.

[smcgruer, 2017/01/31 20:42:16]

Done.

+  }
+
+  const LayoutBoxModelObject* toViewport =
+      constraints.nearestStickyElementShiftingContainingBlock();
+  if (toViewport) {
+    ancestorContainingBlockOffset = scrollableArea->stickyConstraintsMap()
+                                        .get(toViewport->layer())
+                                        .getTotalContainingBlockStickyOffset();
+  }
+
   return LayoutSize(
-      scrollableArea->stickyConstraintsMap().get(layer()).computeStickyOffset(
-          constrainingRect));
+      constraints.computeStickyOffset(constrainingRect, ancestorStickyBoxOffset,
+                                      ancestorContainingBlockOffset));
 }
 
 LayoutPoint LayoutBoxModelObject::adjustedPositionRelativeTo(
     const LayoutPoint& startPoint,
     const Element* offsetParent) const {
   // If the element is the HTML body element or doesn't have a parent
   // return 0 and stop this algorithm.
   if (isBody() || !parent())
     return LayoutPoint();
 
@@ skipping 348 matching lines @@
   if (rootElementStyle->hasBackground())
     return false;
 
   if (node() != document().firstBodyElement())
     return false;
 
   return true;
 }
 
 }  // namespace blink