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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_AnimationEventDispatcher_h
#define mozilla_AnimationEventDispatcher_h
#include <algorithm> // For <std::stable_sort>
#include "mozilla/AnimationComparator.h"
#include "mozilla/Assertions.h"
#include "mozilla/ContentEvents.h"
#include "mozilla/EventDispatcher.h"
#include "mozilla/Variant.h"
#include "mozilla/dom/AnimationPlaybackEvent.h"
#include "nsCSSProps.h"
#include "nsCycleCollectionParticipant.h"
#include "nsPresContext.h"
class nsRefreshDriver;
namespace mozilla {
struct AnimationEventInfo {
RefPtr<dom::EventTarget> mTarget;
RefPtr<dom::Animation> mAnimation;
TimeStamp mScheduledEventTimeStamp;
typedef Variant<InternalTransitionEvent, InternalAnimationEvent,
RefPtr<dom::AnimationPlaybackEvent>>
EventVariant;
EventVariant mEvent;
// For CSS animation events
AnimationEventInfo(nsAtom* aAnimationName,
const NonOwningAnimationTarget& aTarget,
EventMessage aMessage, double aElapsedTime,
const TimeStamp& aScheduledEventTimeStamp,
dom::Animation* aAnimation)
: mTarget(aTarget.mElement),
mAnimation(aAnimation),
mScheduledEventTimeStamp(aScheduledEventTimeStamp),
mEvent(EventVariant(InternalAnimationEvent(true, aMessage))) {
InternalAnimationEvent& event = mEvent.as<InternalAnimationEvent>();
aAnimationName->ToString(event.mAnimationName);
// XXX Looks like nobody initialize WidgetEvent::time
event.mElapsedTime = aElapsedTime;
event.mPseudoElement =
nsCSSPseudoElements::PseudoTypeAsString(aTarget.mPseudoType);
}
// For CSS transition events
AnimationEventInfo(nsCSSPropertyID aProperty,
const NonOwningAnimationTarget& aTarget,
EventMessage aMessage, double aElapsedTime,
const TimeStamp& aScheduledEventTimeStamp,
dom::Animation* aAnimation)
: mTarget(aTarget.mElement),
mAnimation(aAnimation),
mScheduledEventTimeStamp(aScheduledEventTimeStamp),
mEvent(EventVariant(InternalTransitionEvent(true, aMessage))) {
InternalTransitionEvent& event = mEvent.as<InternalTransitionEvent>();
event.mPropertyName =
NS_ConvertUTF8toUTF16(nsCSSProps::GetStringValue(aProperty));
// XXX Looks like nobody initialize WidgetEvent::time
event.mElapsedTime = aElapsedTime;
event.mPseudoElement =
nsCSSPseudoElements::PseudoTypeAsString(aTarget.mPseudoType);
}
// For web animation events
AnimationEventInfo(const nsAString& aName,
RefPtr<dom::AnimationPlaybackEvent>&& aEvent,
TimeStamp&& aScheduledEventTimeStamp,
dom::Animation* aAnimation)
: mTarget(aAnimation),
mAnimation(aAnimation),
mScheduledEventTimeStamp(std::move(aScheduledEventTimeStamp)),
mEvent(std::move(aEvent)) {}
AnimationEventInfo(const AnimationEventInfo& aOther) = delete;
AnimationEventInfo& operator=(const AnimationEventInfo& aOther) = delete;
AnimationEventInfo(AnimationEventInfo&& aOther) = default;
AnimationEventInfo& operator=(AnimationEventInfo&& aOther) = default;
bool IsWebAnimationEvent() const {
return mEvent.is<RefPtr<dom::AnimationPlaybackEvent>>();
}
#ifdef DEBUG
bool IsStale() const {
const WidgetEvent* widgetEvent = AsWidgetEvent();
return widgetEvent->mFlags.mIsBeingDispatched ||
widgetEvent->mFlags.mDispatchedAtLeastOnce;
}
const WidgetEvent* AsWidgetEvent() const {
return const_cast<AnimationEventInfo*>(this)->AsWidgetEvent();
}
#endif
WidgetEvent* AsWidgetEvent() {
if (mEvent.is<InternalTransitionEvent>()) {
return &mEvent.as<InternalTransitionEvent>();
}
if (mEvent.is<InternalAnimationEvent>()) {
return &mEvent.as<InternalAnimationEvent>();
}
if (mEvent.is<RefPtr<dom::AnimationPlaybackEvent>>()) {
return mEvent.as<RefPtr<dom::AnimationPlaybackEvent>>()->WidgetEventPtr();
}
MOZ_MAKE_COMPILER_ASSUME_IS_UNREACHABLE("Unexpected event type");
return nullptr;
}
void Dispatch(nsPresContext* aPresContext) {
if (mEvent.is<RefPtr<dom::AnimationPlaybackEvent>>()) {
EventDispatcher::DispatchDOMEvent(
mTarget, nullptr /* WidgetEvent */,
mEvent.as<RefPtr<dom::AnimationPlaybackEvent>>(), aPresContext,
nullptr /* nsEventStatus */);
return;
}
MOZ_ASSERT(mEvent.is<InternalTransitionEvent>() ||
mEvent.is<InternalAnimationEvent>());
EventDispatcher::Dispatch(mTarget, aPresContext, AsWidgetEvent());
}
};
class AnimationEventDispatcher final {
public:
explicit AnimationEventDispatcher(nsPresContext* aPresContext)
: mPresContext(aPresContext), mIsSorted(true), mIsObserving(false) {}
NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(AnimationEventDispatcher)
NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(AnimationEventDispatcher)
void Disconnect();
void QueueEvent(AnimationEventInfo&& aEvent);
void QueueEvents(nsTArray<AnimationEventInfo>&& aEvents);
// This will call SortEvents automatically if it has not already been
// called.
void DispatchEvents() {
mIsObserving = false;
if (!mPresContext || mPendingEvents.IsEmpty()) {
return;
}
SortEvents();
EventArray events = std::move(mPendingEvents);
// mIsSorted will be set to true by SortEvents above, and we leave it
// that way since mPendingEvents is now empty
for (AnimationEventInfo& info : events) {
MOZ_ASSERT(!info.IsStale(), "The event shouldn't be stale");
info.Dispatch(mPresContext);
// Bail out if our mPresContext was nullified due to destroying the pres
// context.
if (!mPresContext) {
break;
}
}
}
void ClearEventQueue() {
mPendingEvents.Clear();
mIsSorted = true;
}
bool HasQueuedEvents() const { return !mPendingEvents.IsEmpty(); }
private:
#ifndef DEBUG
~AnimationEventDispatcher() = default;
#else
~AnimationEventDispatcher() {
MOZ_ASSERT(!mIsObserving,
"AnimationEventDispatcher should have disassociated from "
"nsRefreshDriver");
}
#endif
class AnimationEventInfoLessThan {
public:
bool operator()(const AnimationEventInfo& a,
const AnimationEventInfo& b) const {
if (a.mScheduledEventTimeStamp != b.mScheduledEventTimeStamp) {
// Null timestamps sort first
if (a.mScheduledEventTimeStamp.IsNull() ||
b.mScheduledEventTimeStamp.IsNull()) {
return a.mScheduledEventTimeStamp.IsNull();
} else {
return a.mScheduledEventTimeStamp < b.mScheduledEventTimeStamp;
}
}
// Events in the Web Animations spec are prior to CSS events.
if (a.IsWebAnimationEvent() != b.IsWebAnimationEvent()) {
return a.IsWebAnimationEvent();
}
AnimationPtrComparator<RefPtr<dom::Animation>> comparator;
return comparator.LessThan(a.mAnimation, b.mAnimation);
}
};
// Sort all pending CSS animation/transition events by scheduled event time
// and composite order.
// https://drafts.csswg.org/web-animations/#update-animations-and-send-events
void SortEvents() {
if (mIsSorted) {
return;
}
for (auto& pending : mPendingEvents) {
pending.mAnimation->CachedChildIndexRef() = -1;
}
// FIXME: Replace with mPendingEvents.StableSort when bug 1147091 is
// fixed.
std::stable_sort(mPendingEvents.begin(), mPendingEvents.end(),
AnimationEventInfoLessThan());
mIsSorted = true;
}
void ScheduleDispatch();
nsPresContext* mPresContext;
typedef nsTArray<AnimationEventInfo> EventArray;
EventArray mPendingEvents;
bool mIsSorted;
bool mIsObserving;
};
} // namespace mozilla
#endif // mozilla_AnimationEventDispatcher_h
|
