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
|
/*
* Copyright (C) 2020 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.
*/
#include "config.h"
#include "WebWheelEventCoalescer.h"
#include "Logging.h"
#include "NativeWebWheelEvent.h"
#include "WebEventConversion.h"
#include <wtf/TZoneMallocInlines.h>
#include <wtf/text/TextStream.h>
namespace WebKit {
// Represents the number of wheel events we can hold in the queue before we start pushing them preemptively.
constexpr unsigned wheelEventQueueSizeThreshold = 10;
#if !LOG_DISABLED
static TextStream& operator<<(TextStream& ts, const NativeWebWheelEvent& nativeWheelEvent)
{
ts << platform(nativeWheelEvent);
return ts;
}
#endif
WTF_MAKE_TZONE_ALLOCATED_IMPL(WebWheelEventCoalescer);
bool WebWheelEventCoalescer::canCoalesce(const WebWheelEvent& a, const WebWheelEvent& b)
{
if (a.position() != b.position())
return false;
if (a.globalPosition() != b.globalPosition())
return false;
if (a.modifiers() != b.modifiers())
return false;
if (a.granularity() != b.granularity())
return false;
#if PLATFORM(COCOA)
if (a.phase() != b.phase())
return false;
if (a.momentumPhase() != b.momentumPhase())
return false;
#endif
#if PLATFORM(COCOA) || PLATFORM(GTK) || USE(LIBWPE)
if (a.hasPreciseScrollingDeltas() != b.hasPreciseScrollingDeltas())
return false;
#endif
return true;
}
WebWheelEvent WebWheelEventCoalescer::coalesce(const WebWheelEvent& a, const WebWheelEvent& b)
{
ASSERT(canCoalesce(a, b));
auto mergedDelta = a.delta() + b.delta();
auto mergedWheelTicks = a.wheelTicks() + b.wheelTicks();
#if PLATFORM(COCOA)
auto mergedUnacceleratedScrollingDelta = a.unacceleratedScrollingDelta() + b.unacceleratedScrollingDelta();
std::optional<WebCore::FloatSize> mergedRawPlatformScrollingDelta;
if (a.rawPlatformDelta() && b.rawPlatformDelta())
mergedRawPlatformScrollingDelta = a.rawPlatformDelta().value() + b.rawPlatformDelta().value();
auto event = WebWheelEvent({ WebEventType::Wheel, b.modifiers(), b.timestamp() }, b.position(), b.globalPosition(), mergedDelta, mergedWheelTicks, b.granularity(), b.directionInvertedFromDevice(), b.phase(), b.momentumPhase(), b.hasPreciseScrollingDeltas(), b.scrollCount(), mergedUnacceleratedScrollingDelta, b.ioHIDEventTimestamp(), mergedRawPlatformScrollingDelta, b.momentumEndType());
#elif PLATFORM(GTK) || USE(LIBWPE)
auto event = WebWheelEvent({ WebEventType::Wheel, b.modifiers(), b.timestamp() }, b.position(), b.globalPosition(), mergedDelta, mergedWheelTicks, b.granularity(), b.phase(), b.momentumPhase(), b.hasPreciseScrollingDeltas());
#else
auto event = WebWheelEvent({ WebEventType::Wheel, b.modifiers(), b.timestamp() }, b.position(), b.globalPosition(), mergedDelta, mergedWheelTicks, b.granularity());
#endif
return event;
}
bool WebWheelEventCoalescer::shouldDispatchEventNow(const WebWheelEvent& event) const
{
#if PLATFORM(GTK)
// Don't queue events representing a non-trivial scrolling phase to
// avoid having them trapped in the queue, potentially preventing a
// scrolling session to beginning or end correctly.
// This is only needed by platforms whose WebWheelEvent has this phase
// information (Cocoa and GTK+) but Cocoa was fine without it.
if (event.phase() == WebWheelEvent::Phase::PhaseNone
|| event.phase() == WebWheelEvent::Phase::PhaseChanged
|| event.momentumPhase() == WebWheelEvent::Phase::PhaseNone
|| event.momentumPhase() == WebWheelEvent::Phase::PhaseChanged)
return true;
#else
UNUSED_PARAM(event);
#endif
return m_wheelEventQueue.size() >= wheelEventQueueSizeThreshold;
}
std::optional<WebWheelEvent> WebWheelEventCoalescer::nextEventToDispatch()
{
if (m_wheelEventQueue.isEmpty())
return std::nullopt;
auto coalescedNativeEvent = m_wheelEventQueue.takeFirst();
auto coalescedSequence = makeUnique<CoalescedEventSequence>();
coalescedSequence->append(coalescedNativeEvent);
auto coalescedWebEvent = WebWheelEvent { coalescedNativeEvent };
while (!m_wheelEventQueue.isEmpty() && canCoalesce(coalescedWebEvent, m_wheelEventQueue.first())) {
auto firstEvent = m_wheelEventQueue.takeFirst();
coalescedSequence->append(firstEvent);
coalescedWebEvent = coalesce(coalescedWebEvent, WebWheelEvent { firstEvent });
}
#if !LOG_DISABLED
if (coalescedSequence->size() > 1)
LOG_WITH_STREAM(WheelEvents, stream << "WebWheelEventCoalescer::wheelEventWithCoalescing coalesced " << *coalescedSequence << " into " << platform(coalescedWebEvent));
#endif
m_eventsBeingProcessed.append(WTFMove(coalescedSequence));
return coalescedWebEvent;
}
bool WebWheelEventCoalescer::shouldDispatchEvent(const NativeWebWheelEvent& event)
{
LOG_WITH_STREAM(WheelEvents, stream << "WebWheelEventCoalescer::shouldDispatchEvent " << platform(event) << " (" << m_wheelEventQueue.size() << " events in the queue, " << m_eventsBeingProcessed.size() << " event sequences being processed)");
m_wheelEventQueue.append(event);
if (!m_eventsBeingProcessed.isEmpty()) {
if (!shouldDispatchEventNow(m_wheelEventQueue.last())) {
LOG_WITH_STREAM(WheelEvents, stream << "WebWheelEventCoalescer::shouldDispatchEvent - " << m_wheelEventQueue.size() << " events queued; not dispatching");
return false;
}
// The queue has too many wheel events, so push a new event.
// FIXME: This logic is confusing, and possibly not necessary.
}
return true;
}
std::optional<NativeWebWheelEvent> WebWheelEventCoalescer::takeOldestEventBeingProcessed()
{
if (m_eventsBeingProcessed.isEmpty())
return { };
auto oldestSequence = m_eventsBeingProcessed.takeFirst();
return oldestSequence->last();
}
void WebWheelEventCoalescer::clear()
{
m_wheelEventQueue.clear();
m_eventsBeingProcessed.clear();
}
} // namespace WebKit
|
