bcd1a8c1c08ccc353b7b91cfc255b4577b54831f
[WebKit-https.git] / Source / WebCore / page / scrolling / AxisScrollSnapOffsets.cpp
1 /*
2  * Copyright (C) 2014-2015 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "AxisScrollSnapOffsets.h"
28
29 #include "ElementChildIterator.h"
30 #include "HTMLCollection.h"
31 #include "HTMLElement.h"
32 #include "Length.h"
33 #include "RenderBox.h"
34 #include "ScrollableArea.h"
35 #include "StyleScrollSnapPoints.h"
36
37 #if ENABLE(CSS_SCROLL_SNAP)
38
39 namespace WebCore {
40
41 static void appendChildSnapOffsets(HTMLElement& parent, bool shouldAddHorizontalChildOffsets, Vector<LayoutUnit>& horizontalSnapOffsetSubsequence, bool shouldAddVerticalChildOffsets, Vector<LayoutUnit>& verticalSnapOffsetSubsequence)
42 {
43     // FIXME: Instead of traversing all children, register children with snap coordinates before appending to snapOffsetSubsequence.
44     for (auto& child : childrenOfType<Element>(parent)) {
45         if (RenderBox* box = child.renderBox()) {
46             LayoutUnit viewWidth = box->width();
47             LayoutUnit viewHeight = box->height();
48             FloatPoint position = box->localToContainerPoint(FloatPoint(), parent.renderBox());
49             LayoutUnit left = position.x();
50             LayoutUnit top = position.y();
51             for (auto& coordinate : box->style().scrollSnapCoordinates()) {
52                 LayoutUnit lastPotentialSnapPositionX = left + valueForLength(coordinate.width(), viewWidth);
53                 if (shouldAddHorizontalChildOffsets && lastPotentialSnapPositionX > 0)
54                     horizontalSnapOffsetSubsequence.append(lastPotentialSnapPositionX);
55
56                 LayoutUnit lastPotentialSnapPositionY = top + valueForLength(coordinate.height(), viewHeight);
57                 if (shouldAddVerticalChildOffsets && lastPotentialSnapPositionY > 0)
58                     verticalSnapOffsetSubsequence.append(lastPotentialSnapPositionY);
59             }
60         }
61     }
62 }
63
64 static LayoutUnit destinationOffsetForViewSize(ScrollEventAxis axis, const LengthSize& destination, LayoutUnit viewSize)
65 {
66     const Length& dimension = (axis == ScrollEventAxis::Horizontal) ? destination.width() : destination.height();
67     return valueForLength(dimension, viewSize);
68 }
69     
70 static void updateFromStyle(Vector<LayoutUnit>& snapOffsets, const RenderStyle& style, ScrollEventAxis axis, LayoutUnit viewSize, LayoutUnit scrollSize, Vector<LayoutUnit>& snapOffsetSubsequence)
71 {
72     std::sort(snapOffsetSubsequence.begin(), snapOffsetSubsequence.end());
73     if (snapOffsetSubsequence.isEmpty())
74         snapOffsetSubsequence.append(0);
75
76     // Always put a snap point on the zero offset.
77     snapOffsets.append(0);
78
79     auto* points = (axis == ScrollEventAxis::Horizontal) ? style.scrollSnapPointsX() : style.scrollSnapPointsY();
80     bool hasRepeat = points ? points->hasRepeat : false;
81     LayoutUnit repeatOffset = points ? valueForLength(points->repeatOffset, viewSize) : LayoutUnit();
82     LayoutUnit destinationOffset = destinationOffsetForViewSize(axis, style.scrollSnapDestination(), viewSize);
83     LayoutUnit curSnapPositionShift = 0;
84     LayoutUnit maxScrollOffset = scrollSize - viewSize;
85     LayoutUnit lastSnapPosition = curSnapPositionShift;
86     do {
87         for (auto& snapPosition : snapOffsetSubsequence) {
88             LayoutUnit potentialSnapPosition = curSnapPositionShift + snapPosition - destinationOffset;
89             if (potentialSnapPosition < 0)
90                 continue;
91
92             if (potentialSnapPosition >= maxScrollOffset)
93                 break;
94
95             // Don't add another zero offset value.
96             if (potentialSnapPosition)
97                 snapOffsets.append(potentialSnapPosition);
98
99             lastSnapPosition = potentialSnapPosition + destinationOffset;
100         }
101         curSnapPositionShift = lastSnapPosition + repeatOffset;
102     } while (hasRepeat && curSnapPositionShift < maxScrollOffset);
103
104     // Always put a snap point on the maximum scroll offset.
105     // Not a part of the spec, but necessary to prevent unreachable content when snapping.
106     if (snapOffsets.last() != maxScrollOffset)
107         snapOffsets.append(maxScrollOffset);
108 }
109
110 static bool styleUsesElements(ScrollEventAxis axis, const RenderStyle& style)
111 {
112     const ScrollSnapPoints* scrollSnapPoints = (axis == ScrollEventAxis::Horizontal) ? style.scrollSnapPointsX() : style.scrollSnapPointsY();
113     if (scrollSnapPoints)
114         return scrollSnapPoints->usesElements;
115
116     const Length& destination = (axis == ScrollEventAxis::Horizontal) ? style.scrollSnapDestination().width() : style.scrollSnapDestination().height();
117
118     return !destination.isUndefined();
119 }
120     
121 void updateSnapOffsetsForScrollableArea(ScrollableArea& scrollableArea, HTMLElement& scrollingElement, const RenderBox& scrollingElementBox, const RenderStyle& scrollingElementStyle)
122 {
123     if (scrollingElementStyle.scrollSnapType() == ScrollSnapType::None) {
124         scrollableArea.clearHorizontalSnapOffsets();
125         scrollableArea.clearVerticalSnapOffsets();
126         return;
127     }
128
129     LayoutUnit viewWidth = scrollingElementBox.width();
130     LayoutUnit viewHeight = scrollingElementBox.height();
131     LayoutUnit scrollWidth = scrollingElementBox.scrollWidth();
132     LayoutUnit scrollHeight = scrollingElementBox.scrollHeight();
133     bool canComputeHorizontalOffsets = scrollWidth > 0 && viewWidth > 0 && viewWidth < scrollWidth;
134     bool canComputeVerticalOffsets = scrollHeight > 0 && viewHeight > 0 && viewHeight < scrollHeight;
135
136     if (!canComputeHorizontalOffsets)
137         scrollableArea.clearHorizontalSnapOffsets();
138     if (!canComputeVerticalOffsets)
139         scrollableArea.clearVerticalSnapOffsets();
140
141     if (!canComputeHorizontalOffsets && !canComputeVerticalOffsets)
142         return;
143
144     Vector<LayoutUnit> horizontalSnapOffsetSubsequence;
145     Vector<LayoutUnit> verticalSnapOffsetSubsequence;
146
147     bool scrollSnapPointsXUsesElements = styleUsesElements(ScrollEventAxis::Horizontal, scrollingElementStyle);
148     bool scrollSnapPointsYUsesElements = styleUsesElements(ScrollEventAxis::Vertical , scrollingElementStyle);
149
150     if (scrollSnapPointsXUsesElements || scrollSnapPointsYUsesElements) {
151         bool shouldAddHorizontalChildOffsets = scrollSnapPointsXUsesElements && canComputeHorizontalOffsets;
152         bool shouldAddVerticalChildOffsets = scrollSnapPointsYUsesElements && canComputeVerticalOffsets;
153         appendChildSnapOffsets(scrollingElement, shouldAddHorizontalChildOffsets, horizontalSnapOffsetSubsequence, shouldAddVerticalChildOffsets, verticalSnapOffsetSubsequence);
154     }
155
156     if (scrollingElementStyle.scrollSnapPointsX() && !scrollSnapPointsXUsesElements && canComputeHorizontalOffsets) {
157         for (auto& snapLength : scrollingElementStyle.scrollSnapPointsX()->offsets)
158             horizontalSnapOffsetSubsequence.append(valueForLength(snapLength, viewWidth));
159     }
160
161     if (scrollingElementStyle.scrollSnapPointsY() && !scrollSnapPointsYUsesElements && canComputeVerticalOffsets) {
162         for (auto& snapLength : scrollingElementStyle.scrollSnapPointsY()->offsets)
163             verticalSnapOffsetSubsequence.append(valueForLength(snapLength, viewHeight));
164     }
165
166     if (canComputeHorizontalOffsets) {
167         auto horizontalSnapOffsets = std::make_unique<Vector<LayoutUnit>>();
168         updateFromStyle(*horizontalSnapOffsets, scrollingElementStyle, ScrollEventAxis::Horizontal, viewWidth, scrollWidth, horizontalSnapOffsetSubsequence);
169         scrollableArea.setHorizontalSnapOffsets(WTF::move(horizontalSnapOffsets));
170     }
171     if (canComputeVerticalOffsets) {
172         auto verticalSnapOffsets = std::make_unique<Vector<LayoutUnit>>();
173         updateFromStyle(*verticalSnapOffsets, scrollingElementStyle, ScrollEventAxis::Vertical, viewHeight, scrollHeight, verticalSnapOffsetSubsequence);
174         scrollableArea.setVerticalSnapOffsets(WTF::move(verticalSnapOffsets));
175     }
176 }
177
178 } // namespace WebCore
179
180 #endif // CSS_SCROLL_SNAP