Make it possible to test rubber-banding in overflow scroll
[WebKit-https.git] / Source / WebCore / platform / mock / ScrollAnimatorMock.h
1 /*
2  * Copyright (c) 2016 Igalia S.L.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #pragma once
32
33 #include "ScrollAnimator.h"
34
35 namespace WebCore {
36
37 // A Mock implementation of ScrollAnimator used to test the scroll events
38 // received by the scroll animator. Tests can enable this scroll animator using
39 // the internal setting enableMockScrollAnimator.
40 class ScrollAnimatorMock final : public ScrollAnimator {
41 public:
42     ScrollAnimatorMock(ScrollableArea&, WTF::Function<void(const String&)>&&);
43     virtual ~ScrollAnimatorMock();
44
45 private:
46
47 #if ENABLE(RUBBER_BANDING)
48     bool allowsHorizontalStretching(const PlatformWheelEvent&) override { return false; }
49     bool allowsVerticalStretching(const PlatformWheelEvent&) override { return false; }
50     IntSize stretchAmount() override { return IntSize(); }
51     bool pinnedInDirection(const FloatSize&) override { return false; }
52     bool canScrollHorizontally() override { return false; }
53     bool canScrollVertically() override { return false; }
54     bool shouldRubberBandInDirection(ScrollDirection) override { return false; }
55     void immediateScrollBy(const FloatSize&) override { }
56     void immediateScrollByWithoutContentEdgeConstraints(const FloatSize&) override { }
57     void adjustScrollPositionToBoundsIfNecessary() override { }
58 #endif
59
60     void didAddVerticalScrollbar(Scrollbar*) override;
61     void didAddHorizontalScrollbar(Scrollbar*) override;
62     void willRemoveVerticalScrollbar(Scrollbar*) override;
63     void willRemoveHorizontalScrollbar(Scrollbar*) override;
64     void mouseEnteredContentArea() override;
65     void mouseMovedInContentArea() override;
66     void mouseExitedContentArea() override;
67     void mouseEnteredScrollbar(Scrollbar*) const override;
68     void mouseExitedScrollbar(Scrollbar*) const override;
69     void mouseIsDownInScrollbar(Scrollbar*, bool) const override;
70
71     WTF::Function<void(const String&)> m_logger;
72     Scrollbar* m_verticalScrollbar { nullptr };
73     Scrollbar* m_horizontalScrollbar { nullptr };
74 };
75
76 } // namespace WebCore
77