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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
/*
* Copyright (C) 2021 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. 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 INC. 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
#if ENABLE(MOMENTUM_EVENT_DISPATCHER)
#define ENABLE_MOMENTUM_EVENT_DISPATCHER_TEMPORARY_LOGGING 0
#include "ScrollingAccelerationCurve.h"
#include "WebWheelEvent.h"
#include <WebCore/FloatSize.h>
#include <WebCore/PageIdentifier.h>
#include <WebCore/RectEdges.h>
#include <memory>
#include <wtf/CheckedPtr.h>
#include <wtf/Deque.h>
#include <wtf/MonotonicTime.h>
#include <wtf/Noncopyable.h>
#include <wtf/TZoneMalloc.h>
namespace WebCore {
struct DisplayUpdate;
using FramesPerSecond = unsigned;
using PlatformDisplayID = uint32_t;
enum class RubberBandingBehavior : uint8_t;
}
namespace WebKit {
class MomentumEventDispatcher {
WTF_MAKE_NONCOPYABLE(MomentumEventDispatcher);
WTF_MAKE_TZONE_ALLOCATED(MomentumEventDispatcher);
public:
class Client : public CanMakeCheckedPtr<Client> {
WTF_MAKE_FAST_ALLOCATED;
WTF_OVERRIDE_DELETE_FOR_CHECKED_PTR(Client);
friend class MomentumEventDispatcher;
public:
virtual ~Client() = default;
private:
virtual void handleSyntheticWheelEvent(WebCore::PageIdentifier, const WebWheelEvent&, WebCore::RectEdges<WebCore::RubberBandingBehavior> rubberBandableEdges) = 0;
virtual void startDisplayDidRefreshCallbacks(WebCore::PlatformDisplayID) = 0;
virtual void stopDisplayDidRefreshCallbacks(WebCore::PlatformDisplayID) = 0;
#if ENABLE(MOMENTUM_EVENT_DISPATCHER_TEMPORARY_LOGGING)
virtual void flushMomentumEventLoggingSoon() = 0;
#endif
};
MomentumEventDispatcher(Client&);
~MomentumEventDispatcher();
bool handleWheelEvent(WebCore::PageIdentifier, const WebWheelEvent&, WebCore::RectEdges<WebCore::RubberBandingBehavior> rubberBandableEdges);
void setScrollingAccelerationCurve(WebCore::PageIdentifier, std::optional<ScrollingAccelerationCurve>);
void displayDidRefresh(WebCore::PlatformDisplayID);
void pageScreenDidChange(WebCore::PageIdentifier, WebCore::PlatformDisplayID, std::optional<unsigned> nominalFramesPerSecond);
#if ENABLE(MOMENTUM_EVENT_DISPATCHER_TEMPORARY_LOGGING)
void flushLog();
#endif
private:
void didStartMomentumPhase(WebCore::PageIdentifier, const WebWheelEvent&);
void didEndMomentumPhase();
bool eventShouldStartSyntheticMomentumPhase(WebCore::PageIdentifier, const WebWheelEvent&) const;
std::optional<ScrollingAccelerationCurve> scrollingAccelerationCurveForPage(WebCore::PageIdentifier) const;
void startDisplayLink();
void stopDisplayLink();
struct DisplayProperties {
WebCore::PlatformDisplayID displayID;
WebCore::FramesPerSecond nominalFrameRate;
};
std::optional<DisplayProperties> displayProperties(WebCore::PageIdentifier) const;
void dispatchSyntheticMomentumEvent(WebWheelEvent::Phase, WebCore::FloatSize delta);
void buildOffsetTableWithInitialDelta(WebCore::FloatSize);
void equalizeTailGaps();
// Once consumed, this delta *must* be dispatched in an event.
std::optional<WebCore::FloatSize> consumeDeltaForCurrentTime();
WebCore::FloatSize offsetAtTime(Seconds);
std::pair<WebCore::FloatSize, WebCore::FloatSize> computeNextDelta(WebCore::FloatSize currentUnacceleratedDelta);
void didReceiveScrollEventWithInterval(WebCore::FloatSize, Seconds);
void didReceiveScrollEvent(const WebWheelEvent&);
#if ENABLE(MOMENTUM_EVENT_DISPATCHER_TEMPORARY_LOGGING)
void pushLogEntry(uint32_t generatedPhase, uint32_t eventPhase);
WebCore::FloatSize m_lastActivePhaseDelta;
struct LogEntry {
MonotonicTime time;
float totalGeneratedOffset { 0 };
float totalEventOffset { 0 };
uint32_t generatedPhase { 0 };
uint32_t eventPhase { 0 };
};
LogEntry m_currentLogState;
Vector<LogEntry> m_log;
#endif
struct Delta {
float rawPlatformDelta;
Seconds frameInterval;
};
static constexpr unsigned deltaHistoryQueueSize = 9;
typedef Deque<Delta, deltaHistoryQueueSize> HistoricalDeltas;
HistoricalDeltas m_deltaHistoryX;
HistoricalDeltas m_deltaHistoryY;
Markable<WallTime> m_lastScrollTimestamp;
std::optional<WebWheelEvent> m_lastIncomingEvent;
WebCore::RectEdges<WebCore::RubberBandingBehavior> m_lastRubberBandableEdges;
bool m_isInOverriddenPlatformMomentumGesture { false };
struct {
bool active { false };
Markable<WebCore::PageIdentifier> pageIdentifier;
std::optional<ScrollingAccelerationCurve> accelerationCurve;
std::optional<WebWheelEvent> initiatingEvent;
WebCore::FloatSize currentOffset;
MonotonicTime startTime;
Vector<WebCore::FloatSize> offsetTable; // Always at 60Hz intervals.
Vector<WebCore::FloatSize> tailDeltaTable; // Always at event dispatch intervals.
Seconds tailStartDelay;
unsigned currentTailDeltaIndex { 0 };
WebCore::FramesPerSecond displayNominalFrameRate { 0 };
#if ENABLE(MOMENTUM_EVENT_DISPATCHER_TEMPORARY_LOGGING)
WebCore::FloatSize accumulatedEventOffset;
bool didLogInitialQueueState { false };
#endif
#if ENABLE(MOMENTUM_EVENT_DISPATCHER_PREMATURE_ROUNDING)
WebCore::FloatSize carryOffset;
#endif
} m_currentGesture;
HashMap<WebCore::PageIdentifier, DisplayProperties> m_displayProperties;
mutable Lock m_accelerationCurvesLock;
HashMap<WebCore::PageIdentifier, std::optional<ScrollingAccelerationCurve>> m_accelerationCurves WTF_GUARDED_BY_LOCK(m_accelerationCurvesLock);
CheckedRef<Client> m_client;
};
} // namespace WebKit
#endif
|
