[Web Animations] Audit Web Animations classes for memory reduction
[WebKit-https.git] / Source / WebCore / animation / DeclarativeAnimation.cpp
1 /*
2  * Copyright (C) 2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "DeclarativeAnimation.h"
28
29 #include "Animation.h"
30 #include "AnimationEvent.h"
31 #include "Element.h"
32 #include "EventNames.h"
33 #include "KeyframeEffect.h"
34 #include "PseudoElement.h"
35 #include "TransitionEvent.h"
36
37 namespace WebCore {
38
39 DeclarativeAnimation::DeclarativeAnimation(Element& owningElement, const Animation& backingAnimation)
40     : WebAnimation(owningElement.document())
41     , m_eventQueue(owningElement)
42     , m_owningElement(&owningElement)
43     , m_backingAnimation(const_cast<Animation&>(backingAnimation))
44 {
45 }
46
47 DeclarativeAnimation::~DeclarativeAnimation()
48 {
49 }
50
51 void DeclarativeAnimation::tick()
52 {
53     bool wasRelevant = isRelevant();
54     
55     WebAnimation::tick();
56     invalidateDOMEvents();
57
58     // If a declarative animation transitions from a non-idle state to an idle state, it means it was
59     // canceled using the Web Animations API and it should be disassociated from its owner element.
60     // From this point on, this animation is like any other animation and should not appear in the
61     // maps containing running CSS Transitions and CSS Animations for a given element.
62     if (wasRelevant && playState() == WebAnimation::PlayState::Idle) {
63         disassociateFromOwningElement();
64         m_eventQueue.close();
65     }
66 }
67
68 void DeclarativeAnimation::disassociateFromOwningElement()
69 {
70     if (!m_owningElement)
71         return;
72
73     if (auto* animationTimeline = timeline())
74         animationTimeline->removeDeclarativeAnimationFromListsForOwningElement(*this, *m_owningElement);
75     m_owningElement = nullptr;
76 }
77
78 bool DeclarativeAnimation::needsTick() const
79 {
80     return WebAnimation::needsTick() || m_eventQueue.hasPendingEvents();
81 }
82
83 void DeclarativeAnimation::remove()
84 {
85     m_eventQueue.close();
86     WebAnimation::remove();
87 }
88
89 void DeclarativeAnimation::setBackingAnimation(const Animation& backingAnimation)
90 {
91     m_backingAnimation = const_cast<Animation&>(backingAnimation);
92     syncPropertiesWithBackingAnimation();
93 }
94
95 void DeclarativeAnimation::initialize(const RenderStyle* oldStyle, const RenderStyle& newStyle)
96 {
97     // We need to suspend invalidation of the animation's keyframe effect during its creation
98     // as it would otherwise trigger invalidation of the document's style and this would be
99     // incorrect since it would happen during style invalidation.
100     suspendEffectInvalidation();
101
102     ASSERT(m_owningElement);
103
104     setEffect(KeyframeEffect::create(*m_owningElement));
105     setTimeline(&m_owningElement->document().timeline());
106     downcast<KeyframeEffect>(effect())->computeDeclarativeAnimationBlendingKeyframes(oldStyle, newStyle);
107     syncPropertiesWithBackingAnimation();
108     if (backingAnimation().playState() == AnimationPlayState::Playing)
109         play();
110     else
111         pause();
112
113     unsuspendEffectInvalidation();
114 }
115
116 void DeclarativeAnimation::syncPropertiesWithBackingAnimation()
117 {
118 }
119
120 Optional<double> DeclarativeAnimation::startTime() const
121 {
122     flushPendingStyleChanges();
123     return WebAnimation::startTime();
124 }
125
126 void DeclarativeAnimation::setStartTime(Optional<double> startTime)
127 {
128     flushPendingStyleChanges();
129     return WebAnimation::setStartTime(startTime);
130 }
131
132 Optional<double> DeclarativeAnimation::bindingsCurrentTime() const
133 {
134     flushPendingStyleChanges();
135     return WebAnimation::bindingsCurrentTime();
136 }
137
138 ExceptionOr<void> DeclarativeAnimation::setBindingsCurrentTime(Optional<double> currentTime)
139 {
140     flushPendingStyleChanges();
141     return WebAnimation::setBindingsCurrentTime(currentTime);
142 }
143
144 WebAnimation::PlayState DeclarativeAnimation::bindingsPlayState() const
145 {
146     flushPendingStyleChanges();
147     return WebAnimation::bindingsPlayState();
148 }
149
150 bool DeclarativeAnimation::bindingsPending() const
151 {
152     flushPendingStyleChanges();
153     return WebAnimation::bindingsPending();
154 }
155
156 WebAnimation::ReadyPromise& DeclarativeAnimation::bindingsReady()
157 {
158     flushPendingStyleChanges();
159     return WebAnimation::bindingsReady();
160 }
161
162 WebAnimation::FinishedPromise& DeclarativeAnimation::bindingsFinished()
163 {
164     flushPendingStyleChanges();
165     return WebAnimation::bindingsFinished();
166 }
167
168 ExceptionOr<void> DeclarativeAnimation::bindingsPlay()
169 {
170     flushPendingStyleChanges();
171     return WebAnimation::bindingsPlay();
172 }
173
174 ExceptionOr<void> DeclarativeAnimation::bindingsPause()
175 {
176     flushPendingStyleChanges();
177     return WebAnimation::bindingsPause();
178 }
179
180 void DeclarativeAnimation::flushPendingStyleChanges() const
181 {
182     if (auto* animationEffect = effect()) {
183         if (is<KeyframeEffect>(animationEffect)) {
184             if (auto* target = downcast<KeyframeEffect>(animationEffect)->target())
185                 target->document().updateStyleIfNeeded();
186         }
187     }
188 }
189
190 void DeclarativeAnimation::setTimeline(RefPtr<AnimationTimeline>&& newTimeline)
191 {
192     if (timeline() && !newTimeline)
193         cancel();
194
195     WebAnimation::setTimeline(WTFMove(newTimeline));
196 }
197
198 void DeclarativeAnimation::cancel()
199 {
200     auto cancelationTime = 0_s;
201     if (auto* animationEffect = effect()) {
202         if (auto activeTime = animationEffect->getBasicTiming().activeTime)
203             cancelationTime = *activeTime;
204     }
205
206     WebAnimation::cancel();
207
208     invalidateDOMEvents(cancelationTime);
209 }
210
211 void DeclarativeAnimation::cancelFromStyle()
212 {
213     cancel();
214     disassociateFromOwningElement();
215 }
216
217 AnimationEffectPhase DeclarativeAnimation::phaseWithoutEffect() const
218 {
219     // This shouldn't be called if we actually have an effect.
220     ASSERT(!effect());
221
222     auto animationCurrentTime = currentTime();
223     if (!animationCurrentTime)
224         return AnimationEffectPhase::Idle;
225
226     // Since we don't have an effect, the duration will be zero so the phase is 'before' if the current time is less than zero.
227     return *animationCurrentTime < 0_s ? AnimationEffectPhase::Before : AnimationEffectPhase::After;
228 }
229
230 void DeclarativeAnimation::invalidateDOMEvents(Seconds elapsedTime)
231 {
232     if (!m_owningElement)
233         return;
234     
235     auto isPending = pending();
236     if (isPending && m_wasPending)
237         return;
238
239     double iteration = 0;
240     AnimationEffectPhase currentPhase;
241     Seconds intervalStart;
242     Seconds intervalEnd;
243
244     auto* animationEffect = effect();
245     if (animationEffect) {
246         auto timing = animationEffect->getComputedTiming();
247         if (auto computedIteration = timing.currentIteration)
248             iteration = *computedIteration;
249         currentPhase = timing.phase;
250         intervalStart = std::max(0_s, Seconds::fromMilliseconds(std::min(-timing.delay, timing.activeDuration)));
251         intervalEnd = std::max(0_s, Seconds::fromMilliseconds(std::min(timing.endTime - timing.delay, timing.activeDuration)));
252     } else {
253         iteration = 0;
254         currentPhase = phaseWithoutEffect();
255         intervalStart = 0_s;
256         intervalEnd = 0_s;
257     }
258
259     bool wasActive = m_previousPhase == AnimationEffectPhase::Active;
260     bool wasAfter = m_previousPhase == AnimationEffectPhase::After;
261     bool wasBefore = m_previousPhase == AnimationEffectPhase::Before;
262     bool wasIdle = m_previousPhase == AnimationEffectPhase::Idle;
263
264     bool isActive = currentPhase == AnimationEffectPhase::Active;
265     bool isAfter = currentPhase == AnimationEffectPhase::After;
266     bool isBefore = currentPhase == AnimationEffectPhase::Before;
267     bool isIdle = currentPhase == AnimationEffectPhase::Idle;
268
269     if (is<CSSAnimation>(this)) {
270         // https://drafts.csswg.org/css-animations-2/#events
271         if ((wasIdle || wasBefore) && isActive)
272             enqueueDOMEvent(eventNames().animationstartEvent, intervalStart);
273         else if ((wasIdle || wasBefore) && isAfter) {
274             enqueueDOMEvent(eventNames().animationstartEvent, intervalStart);
275             enqueueDOMEvent(eventNames().animationendEvent, intervalEnd);
276         } else if (wasActive && isBefore)
277             enqueueDOMEvent(eventNames().animationendEvent, intervalStart);
278         else if (wasActive && isActive && m_previousIteration != iteration) {
279             auto iterationBoundary = iteration;
280             if (m_previousIteration > iteration)
281                 iterationBoundary++;
282             auto elapsedTime = animationEffect ? animationEffect->iterationDuration() * (iterationBoundary - animationEffect->iterationStart()) : 0_s;
283             enqueueDOMEvent(eventNames().animationiterationEvent, elapsedTime);
284         } else if (wasActive && isAfter)
285             enqueueDOMEvent(eventNames().animationendEvent, intervalEnd);
286         else if (wasAfter && isActive)
287             enqueueDOMEvent(eventNames().animationstartEvent, intervalEnd);
288         else if (wasAfter && isBefore) {
289             enqueueDOMEvent(eventNames().animationstartEvent, intervalEnd);
290             enqueueDOMEvent(eventNames().animationendEvent, intervalStart);
291         } else if ((!wasIdle && !wasAfter) && isIdle)
292             enqueueDOMEvent(eventNames().animationcancelEvent, elapsedTime);
293     } else if (is<CSSTransition>(this)) {
294         // https://drafts.csswg.org/css-transitions-2/#transition-events
295         if (wasIdle && (isPending || isBefore))
296             enqueueDOMEvent(eventNames().transitionrunEvent, intervalStart);
297         else if (wasIdle && isActive) {
298             enqueueDOMEvent(eventNames().transitionrunEvent, intervalStart);
299             enqueueDOMEvent(eventNames().transitionstartEvent, intervalStart);
300         } else if (wasIdle && isAfter) {
301             enqueueDOMEvent(eventNames().transitionrunEvent, intervalStart);
302             enqueueDOMEvent(eventNames().transitionstartEvent, intervalStart);
303             enqueueDOMEvent(eventNames().transitionendEvent, intervalEnd);
304         } else if ((m_wasPending || wasBefore) && isActive)
305             enqueueDOMEvent(eventNames().transitionstartEvent, intervalStart);
306         else if ((m_wasPending || wasBefore) && isAfter) {
307             enqueueDOMEvent(eventNames().transitionstartEvent, intervalStart);
308             enqueueDOMEvent(eventNames().transitionendEvent, intervalEnd);
309         } else if (wasActive && isAfter)
310             enqueueDOMEvent(eventNames().transitionendEvent, intervalEnd);
311         else if (wasActive && isBefore)
312             enqueueDOMEvent(eventNames().transitionendEvent, intervalStart);
313         else if (wasAfter && isActive)
314             enqueueDOMEvent(eventNames().transitionstartEvent, intervalEnd);
315         else if (wasAfter && isBefore) {
316             enqueueDOMEvent(eventNames().transitionstartEvent, intervalEnd);
317             enqueueDOMEvent(eventNames().transitionendEvent, intervalStart);
318         } else if ((!wasIdle && !wasAfter) && isIdle)
319             enqueueDOMEvent(eventNames().transitioncancelEvent, elapsedTime);
320     }
321
322     m_wasPending = isPending;
323     m_previousPhase = currentPhase;
324     m_previousIteration = iteration;
325 }
326
327 void DeclarativeAnimation::enqueueDOMEvent(const AtomicString& eventType, Seconds elapsedTime)
328 {
329     ASSERT(m_owningElement);
330     auto time = secondsToWebAnimationsAPITime(elapsedTime) / 1000;
331     if (is<CSSAnimation>(this))
332         m_eventQueue.enqueueEvent(AnimationEvent::create(eventType, downcast<CSSAnimation>(this)->animationName(), time));
333     else if (is<CSSTransition>(this))
334         m_eventQueue.enqueueEvent(TransitionEvent::create(eventType, downcast<CSSTransition>(this)->transitionProperty(), time, PseudoElement::pseudoElementNameForEvents(m_owningElement->pseudoId())));
335 }
336
337 void DeclarativeAnimation::stop()
338 {
339     m_eventQueue.close();
340     WebAnimation::stop();
341 }
342
343 void DeclarativeAnimation::suspend(ReasonForSuspension reason)
344 {
345     m_eventQueue.suspend();
346     WebAnimation::suspend(reason);
347 }
348
349 void DeclarativeAnimation::resume()
350 {
351     m_eventQueue.resume();
352     WebAnimation::resume();
353 }
354
355 } // namespace WebCore