1/*
2 * Copyright (C) 2019 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#pragma once
27
28#if ENABLE(ASYNC_SCROLLING) || USE(COORDINATED_GRAPHICS)
29
30#include "ScrollingConstraints.h"
31#include "ScrollingStateNode.h"
32
33#include <wtf/Forward.h>
34
35namespace WebCore {
36
37// ScrollingStatePositionedNode is used to manage the layers for z-order composited descendants of overflow:scroll
38// which are not containing block descendants. These layers must have their position inside their ancestor clipping
39// layer adjusted on the scrolling thread.
40class ScrollingStatePositionedNode final : public ScrollingStateNode {
41public:
42 static Ref<ScrollingStatePositionedNode> create(ScrollingStateTree&, ScrollingNodeID);
43
44 Ref<ScrollingStateNode> clone(ScrollingStateTree&) override;
45
46 virtual ~ScrollingStatePositionedNode();
47
48 enum {
49 RelatedOverflowScrollingNodes = NumStateNodeBits,
50 LayoutConstraintData,
51 };
52
53 // These are the overflow scrolling nodes whose scroll position affects the layers in this node.
54 const Vector<ScrollingNodeID>& relatedOverflowScrollingNodes() const { return m_relatedOverflowScrollingNodes; }
55 WEBCORE_EXPORT void setRelatedOverflowScrollingNodes(Vector<ScrollingNodeID>&&);
56
57 WEBCORE_EXPORT void updateConstraints(const LayoutConstraints&);
58 const LayoutConstraints& layoutConstraints() const { return m_constraints; }
59
60private:
61 ScrollingStatePositionedNode(ScrollingStateTree&, ScrollingNodeID);
62 ScrollingStatePositionedNode(const ScrollingStatePositionedNode&, ScrollingStateTree&);
63
64 void setAllPropertiesChanged() override;
65
66 void dumpProperties(WTF::TextStream&, ScrollingStateTreeAsTextBehavior) const override;
67
68 Vector<ScrollingNodeID> m_relatedOverflowScrollingNodes;
69 LayoutConstraints m_constraints;
70};
71
72} // namespace WebCore
73
74SPECIALIZE_TYPE_TRAITS_SCROLLING_STATE_NODE(ScrollingStatePositionedNode, isPositionedNode())
75
76#endif // ENABLE(ASYNC_SCROLLING) || USE(COORDINATED_GRAPHICS)
77