1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/*
* Copyright (C) 2015-2019 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of Apple Inc. ("Apple") nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "PlatformWheelEvent.h"
#include <functional>
#include <wtf/Function.h>
#include <wtf/HashMap.h>
#include <wtf/Lock.h>
#include <wtf/ThreadSafeRefCounted.h>
namespace WebCore {
class Page;
class WheelEventTestMonitor : public ThreadSafeRefCounted<WheelEventTestMonitor> {
WTF_MAKE_NONCOPYABLE(WheelEventTestMonitor); WTF_MAKE_FAST_ALLOCATED;
public:
WheelEventTestMonitor(Page&);
WEBCORE_EXPORT void setTestCallbackAndStartMonitoring(bool expectWheelEndOrCancel, bool expectMomentumEnd, Function<void()>&&);
WEBCORE_EXPORT void clearAllTestDeferrals();
enum DeferReason {
HandlingWheelEvent = 1 << 0,
HandlingWheelEventOnMainThread = 1 << 1,
PostMainThreadWheelEventHandling = 1 << 2,
RubberbandInProgress = 1 << 3,
ScrollSnapInProgress = 1 << 4,
ScrollAnimationInProgress = 1 << 5,
ScrollingThreadSyncNeeded = 1 << 6,
ContentScrollInProgress = 1 << 7,
RequestedScrollPosition = 1 << 8,
};
typedef const void* ScrollableAreaIdentifier;
WEBCORE_EXPORT void receivedWheelEventWithPhases(PlatformWheelEventPhase phase, PlatformWheelEventPhase momentumPhase);
WEBCORE_EXPORT void deferForReason(ScrollableAreaIdentifier, DeferReason);
WEBCORE_EXPORT void removeDeferralForReason(ScrollableAreaIdentifier, DeferReason);
void checkShouldFireCallbacks();
using ScrollableAreaReasonMap = HashMap<ScrollableAreaIdentifier, OptionSet<DeferReason>>;
private:
void scheduleCallbackCheck();
Function<void()> m_completionCallback;
Page& m_page;
Lock m_lock;
ScrollableAreaReasonMap m_deferCompletionReasons WTF_GUARDED_BY_LOCK(m_lock);
bool m_expectWheelEndOrCancel WTF_GUARDED_BY_LOCK(m_lock) { false };
bool m_receivedWheelEndOrCancel WTF_GUARDED_BY_LOCK(m_lock) { false };
bool m_expectMomentumEnd WTF_GUARDED_BY_LOCK(m_lock) { false };
bool m_receivedMomentumEnd WTF_GUARDED_BY_LOCK(m_lock) { false };
bool m_everHadDeferral WTF_GUARDED_BY_LOCK(m_lock) { false };
};
class WheelEventTestMonitorCompletionDeferrer {
public:
WheelEventTestMonitorCompletionDeferrer(WheelEventTestMonitor* monitor, WheelEventTestMonitor::ScrollableAreaIdentifier identifier, WheelEventTestMonitor::DeferReason reason)
: m_monitor(monitor)
, m_identifier(identifier)
, m_reason(reason)
{
if (m_monitor)
m_monitor->deferForReason(m_identifier, m_reason);
}
WheelEventTestMonitorCompletionDeferrer(WheelEventTestMonitorCompletionDeferrer&& other)
: m_monitor(WTFMove(other.m_monitor))
, m_identifier(other.m_identifier)
, m_reason(other.m_reason)
{
}
~WheelEventTestMonitorCompletionDeferrer()
{
if (m_monitor)
m_monitor->removeDeferralForReason(m_identifier, m_reason);
}
private:
RefPtr<WheelEventTestMonitor> m_monitor;
WheelEventTestMonitor::ScrollableAreaIdentifier m_identifier;
WheelEventTestMonitor::DeferReason m_reason;
};
WEBCORE_EXPORT WTF::TextStream& operator<<(WTF::TextStream&, WheelEventTestMonitor::DeferReason);
WTF::TextStream& operator<<(WTF::TextStream&, const WheelEventTestMonitor::ScrollableAreaReasonMap&);
} // namespace WebCore
namespace WTF {
template<> struct EnumTraits<WebCore::WheelEventTestMonitor::DeferReason> {
using values = EnumValues<
WebCore::WheelEventTestMonitor::DeferReason,
WebCore::WheelEventTestMonitor::DeferReason::HandlingWheelEvent,
WebCore::WheelEventTestMonitor::DeferReason::HandlingWheelEventOnMainThread,
WebCore::WheelEventTestMonitor::DeferReason::PostMainThreadWheelEventHandling,
WebCore::WheelEventTestMonitor::DeferReason::RubberbandInProgress,
WebCore::WheelEventTestMonitor::DeferReason::ScrollSnapInProgress,
WebCore::WheelEventTestMonitor::DeferReason::ScrollAnimationInProgress,
WebCore::WheelEventTestMonitor::DeferReason::ScrollingThreadSyncNeeded,
WebCore::WheelEventTestMonitor::DeferReason::ContentScrollInProgress,
WebCore::WheelEventTestMonitor::DeferReason::RequestedScrollPosition
>;
};
} // namespace WTF
|
