Implement visual-viewport based position:fixed handling for Mac async scrolling
[WebKit-https.git] / Source / WebCore / page / scrolling / ThreadedScrollingTree.h
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 #pragma once
27
28 #if ENABLE(ASYNC_SCROLLING)
29
30 #include "ScrollingStateTree.h"
31 #include "ScrollingTree.h"
32 #include <wtf/RefPtr.h>
33
34 namespace WebCore {
35
36 class AsyncScrollingCoordinator;
37
38 // The ThreadedScrollingTree class lives almost exclusively on the scrolling thread and manages the
39 // hierarchy of scrollable regions on the page. It's also responsible for dispatching events
40 // to the correct scrolling tree nodes or dispatching events back to the ScrollingCoordinator
41 // object on the main thread if they can't be handled on the scrolling thread for various reasons.
42 class ThreadedScrollingTree : public ScrollingTree {
43 public:
44     virtual ~ThreadedScrollingTree();
45
46     void commitTreeState(std::unique_ptr<ScrollingStateTree>) override;
47
48     void handleWheelEvent(const PlatformWheelEvent&) override;
49
50     // Can be called from any thread. Will try to handle the wheel event on the scrolling thread.
51     // Returns true if the wheel event can be handled on the scrolling thread and false if the
52     // event must be sent again to the WebCore event handler.
53     EventResult tryToHandleWheelEvent(const PlatformWheelEvent&) override;
54
55     void invalidate() override;
56
57 protected:
58     explicit ThreadedScrollingTree(AsyncScrollingCoordinator*);
59
60     void scrollingTreeNodeDidScroll(ScrollingNodeID, const FloatPoint& scrollPosition, const Optional<FloatPoint>& layoutViewportOrigin, SetOrSyncScrollingLayerPosition = SyncScrollingLayerPosition) override;
61     void currentSnapPointIndicesDidChange(ScrollingNodeID, unsigned horizontal, unsigned vertical) override;
62 #if PLATFORM(MAC)
63     void handleWheelEventPhase(PlatformWheelEventPhase) override;
64     void setActiveScrollSnapIndices(ScrollingNodeID, unsigned horizontalIndex, unsigned verticalIndex) override;
65     void deferTestsForReason(WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReason) override;
66     void removeTestDeferralForReason(WheelEventTestTrigger::ScrollableAreaIdentifier, WheelEventTestTrigger::DeferTestTriggerReason) override;
67 #endif
68
69 private:
70     bool isThreadedScrollingTree() const override { return true; }
71
72     RefPtr<AsyncScrollingCoordinator> m_scrollingCoordinator;
73 };
74
75 } // namespace WebCore
76
77 SPECIALIZE_TYPE_TRAITS_SCROLLING_TREE(WebCore::ThreadedScrollingTree, isThreadedScrollingTree())
78
79 #endif // ENABLE(ASYNC_SCROLLING)