Use NeverDestroyed instead of DEPRECATED_DEFINE_STATIC_LOCAL
[WebKit-https.git] / Source / WebCore / page / animation / CompositeAnimation.cpp
1 /*
2  * Copyright (C) 2007 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "CompositeAnimation.h"
31
32 #include "AnimationControllerPrivate.h"
33 #include "CSSPropertyAnimation.h"
34 #include "CSSPropertyNames.h"
35 #include "ImplicitAnimation.h"
36 #include "KeyframeAnimation.h"
37 #include "Logging.h"
38 #include "RenderElement.h"
39 #include "RenderStyle.h"
40 #include <wtf/NeverDestroyed.h>
41 #include <wtf/text/CString.h>
42
43 namespace WebCore {
44
45 CompositeAnimation::CompositeAnimation(AnimationControllerPrivate& animationController)
46     : m_animationController(animationController)
47 {
48     m_suspended = m_animationController.isSuspended() && !m_animationController.allowsNewAnimationsWhileSuspended();
49 }
50
51 CompositeAnimation::~CompositeAnimation()
52 {
53     // Toss the refs to all animations, but make sure we remove them from
54     // any waiting lists first.
55
56     clearRenderer();
57     m_transitions.clear();
58     m_keyframeAnimations.clear();
59 }
60
61 void CompositeAnimation::clearRenderer()
62 {
63     if (!m_transitions.isEmpty()) {
64         // Clear the renderers from all running animations, in case we are in the middle of
65         // an animation callback (see https://bugs.webkit.org/show_bug.cgi?id=22052)
66         for (auto& transition : m_transitions.values()) {
67             animationController().animationWillBeRemoved(transition.get());
68             transition->clear();
69         }
70     }
71     if (!m_keyframeAnimations.isEmpty()) {
72         m_keyframeAnimations.checkConsistency();
73         for (auto& animation : m_keyframeAnimations.values()) {
74             animationController().animationWillBeRemoved(animation.get());
75             animation->clear();
76         }
77     }
78 }
79
80 void CompositeAnimation::updateTransitions(RenderElement* renderer, RenderStyle* currentStyle, RenderStyle* targetStyle)
81 {
82     // If currentStyle is null or there are no old or new transitions, just skip it
83     if (!currentStyle || (!targetStyle->transitions() && m_transitions.isEmpty()))
84         return;
85
86     // Mark all existing transitions as no longer active. We will mark the still active ones
87     // in the next loop and then toss the ones that didn't get marked.
88     for (auto& transition : m_transitions.values())
89         transition->setActive(false);
90         
91     RefPtr<RenderStyle> modifiedCurrentStyle;
92     
93     // Check to see if we need to update the active transitions
94     if (targetStyle->transitions()) {
95         for (size_t i = 0; i < targetStyle->transitions()->size(); ++i) {
96             Animation& animation = targetStyle->transitions()->animation(i);
97             bool isActiveTransition = !m_suspended && (animation.duration() || animation.delay() > 0);
98
99             Animation::AnimationMode mode = animation.animationMode();
100             if (mode == Animation::AnimateNone)
101                 continue;
102
103             CSSPropertyID prop = animation.property();
104
105             bool all = mode == Animation::AnimateAll;
106
107             // Handle both the 'all' and single property cases. For the single prop case, we make only one pass
108             // through the loop.
109             for (int propertyIndex = 0; propertyIndex < CSSPropertyAnimation::getNumProperties(); ++propertyIndex) {
110                 if (all) {
111                     // Get the next property which is not a shorthand.
112                     bool isShorthand;
113                     prop = CSSPropertyAnimation::getPropertyAtIndex(propertyIndex, isShorthand);
114                     if (isShorthand)
115                         continue;
116                 }
117
118                 // ImplicitAnimations are always hashed by actual properties, never animateAll.
119                 ASSERT(prop >= firstCSSProperty && prop < (firstCSSProperty + numCSSProperties));
120
121                 // If there is a running animation for this property, the transition is overridden
122                 // and we have to use the unanimatedStyle from the animation. We do the test
123                 // against the unanimated style here, but we "override" the transition later.
124                 RefPtr<KeyframeAnimation> keyframeAnim = getAnimationForProperty(prop);
125                 RenderStyle* fromStyle = keyframeAnim ? keyframeAnim->unanimatedStyle() : currentStyle;
126
127                 // See if there is a current transition for this prop
128                 ImplicitAnimation* implAnim = m_transitions.get(prop);
129                 bool equal = true;
130
131                 if (implAnim) {
132                     // If we are post active don't bother setting the active flag. This will cause
133                     // this animation to get removed at the end of this function.
134                     if (!implAnim->postActive())
135                         implAnim->setActive(true);
136                     
137                     // This might be a transition that is just finishing. That would be the case
138                     // if it were postActive. But we still need to check for equality because
139                     // it could be just finishing AND changing to a new goal state.
140                     //
141                     // This implAnim might also not be an already running transition. It might be
142                     // newly added to the list in a previous iteration. This would happen if
143                     // you have both an explicit transition-property and 'all' in the same
144                     // list. In this case, the latter one overrides the earlier one, so we
145                     // behave as though this is a running animation being replaced.
146                     if (!implAnim->isTargetPropertyEqual(prop, targetStyle)) {
147                         // For accelerated animations we need to return a new RenderStyle with the _current_ value
148                         // of the property, so that restarted transitions use the correct starting point.
149                         if (CSSPropertyAnimation::animationOfPropertyIsAccelerated(prop) && implAnim->isAccelerated()) {
150                             if (!modifiedCurrentStyle)
151                                 modifiedCurrentStyle = RenderStyle::clone(currentStyle);
152
153                             implAnim->blendPropertyValueInStyle(prop, modifiedCurrentStyle.get());
154                         }
155                         LOG(Animations, "Removing existing ImplicitAnimation %p for property %s", implAnim, getPropertyName(prop));
156                         animationController().animationWillBeRemoved(implAnim);
157                         m_transitions.remove(prop);
158                         equal = false;
159                     }
160                 } else {
161                     // We need to start a transition if it is active and the properties don't match
162                     equal = !isActiveTransition || CSSPropertyAnimation::propertiesEqual(prop, fromStyle, targetStyle);
163                 }
164
165                 // We can be in this loop with an inactive transition (!isActiveTransition). We need
166                 // to do that to check to see if we are canceling a transition. But we don't want to
167                 // start one of the inactive transitions. So short circuit that here. (See
168                 // <https://bugs.webkit.org/show_bug.cgi?id=24787>
169                 if (!equal && isActiveTransition) {
170                     // Add the new transition
171                     RefPtr<ImplicitAnimation> implicitAnimation = ImplicitAnimation::create(animation, prop, renderer, this, modifiedCurrentStyle ? modifiedCurrentStyle.get() : fromStyle);
172                     LOG(Animations, "Created ImplicitAnimation %p on renderer %p for property %s duration %.2f delay %.2f", implicitAnimation.get(), renderer, getPropertyName(prop), animation.duration(), animation.delay());
173                     m_transitions.set(prop, implicitAnimation.release());
174                 }
175                 
176                 // We only need one pass for the single prop case
177                 if (!all)
178                     break;
179             }
180         }
181     }
182
183     // Make a list of transitions to be removed
184     Vector<int> toBeRemoved;
185     for (auto& transition : m_transitions.values()) {
186         if (!transition->active()) {
187             animationController().animationWillBeRemoved(transition.get());
188             toBeRemoved.append(transition->animatingProperty());
189             LOG(Animations, "Removing ImplicitAnimation %p from renderer %p for property %s", transition.get(), renderer, getPropertyName(transition->animatingProperty()));
190         }
191     }
192
193     // Now remove the transitions from the list
194     for (auto propertyToRemove : toBeRemoved)
195         m_transitions.remove(propertyToRemove);
196 }
197
198 void CompositeAnimation::updateKeyframeAnimations(RenderElement* renderer, RenderStyle* currentStyle, RenderStyle* targetStyle)
199 {
200     // Nothing to do if we don't have any animations, and didn't have any before
201     if (m_keyframeAnimations.isEmpty() && !targetStyle->hasAnimations())
202         return;
203
204     m_keyframeAnimations.checkConsistency();
205     
206     if (currentStyle && currentStyle->hasAnimations() && targetStyle->hasAnimations() && *(currentStyle->animations()) == *(targetStyle->animations())) {
207         // The current and target animations are the same so we just need to toss any 
208         // animation which is finished (postActive).
209         for (auto& animation : m_keyframeAnimations.values()) {
210             if (animation->postActive())
211                 animation->setIndex(-1);
212         }
213     } else {
214         // Mark all existing animations as no longer active.
215         for (auto& animation : m_keyframeAnimations.values())
216             animation->setIndex(-1);
217
218 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
219         m_hasScrollTriggeredAnimation = false;
220 #endif
221
222         // Toss the animation order map.
223         m_keyframeAnimationOrderMap.clear();
224
225         static NeverDestroyed<const AtomicString> none("none", AtomicString::ConstructFromLiteral);
226         
227         // Now mark any still active animations as active and add any new animations.
228         if (targetStyle->animations()) {
229             int numAnims = targetStyle->animations()->size();
230             for (int i = 0; i < numAnims; ++i) {
231                 Animation& animation = targetStyle->animations()->animation(i);
232                 AtomicString animationName(animation.name());
233
234                 if (!animation.isValidAnimation())
235                     continue;
236                 
237                 // See if there is a current animation for this name.
238                 RefPtr<KeyframeAnimation> keyframeAnim = m_keyframeAnimations.get(animationName.impl());
239                 
240                 if (keyframeAnim) {
241                     // If this animation is postActive, skip it so it gets removed at the end of this function.
242                     if (keyframeAnim->postActive())
243                         continue;
244
245 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
246                     if (animation.trigger()->isScrollAnimationTrigger())
247                         m_hasScrollTriggeredAnimation = true;
248 #endif
249
250                     // This one is still active.
251
252                     // Animations match, but play states may differ. Update if needed.
253                     keyframeAnim->updatePlayState(animation.playState());
254                                 
255                     // Set the saved animation to this new one, just in case the play state has changed.
256                     keyframeAnim->setAnimation(animation);
257                     keyframeAnim->setIndex(i);
258                 } else if ((animation.duration() || animation.delay()) && animation.iterationCount() && animationName != none) {
259                     keyframeAnim = KeyframeAnimation::create(animation, renderer, i, this, targetStyle);
260                     LOG(Animations, "Creating KeyframeAnimation %p on renderer %p with keyframes %s, duration %.2f, delay %.2f, iterations %.2f", keyframeAnim.get(), renderer, animation.name().utf8().data(), animation.duration(), animation.delay(), animation.iterationCount());
261                     if (m_suspended) {
262                         keyframeAnim->updatePlayState(AnimPlayStatePaused);
263                         LOG(Animations, "  (created in suspended/paused state)");
264                     }
265 #if !LOG_DISABLED
266                     for (auto propertyID : keyframeAnim->keyframes().properties())
267                         LOG(Animations, "  property %s", getPropertyName(propertyID));
268 #endif
269
270 #if ENABLE(CSS_ANIMATIONS_LEVEL_2)
271                     if (animation.trigger()->isScrollAnimationTrigger())
272                         m_hasScrollTriggeredAnimation = true;
273 #endif
274
275                     m_keyframeAnimations.set(keyframeAnim->name().impl(), keyframeAnim);
276                 }
277                 
278                 // Add this to the animation order map.
279                 if (keyframeAnim)
280                     m_keyframeAnimationOrderMap.append(keyframeAnim->name().impl());
281             }
282         }
283     }
284     
285     // Make a list of animations to be removed.
286     Vector<AtomicStringImpl*> animsToBeRemoved;
287     for (auto& animation : m_keyframeAnimations.values()) {
288         if (animation->index() < 0) {
289             animsToBeRemoved.append(animation->name().impl());
290             animationController().animationWillBeRemoved(animation.get());
291             animation->clear();
292             LOG(Animations, "Removing KeyframeAnimation %p from renderer %p", animation.get(), renderer);
293         }
294     }
295     
296     // Now remove the animations from the list.
297     for (auto* nameForRemoval : animsToBeRemoved)
298         m_keyframeAnimations.remove(nameForRemoval);
299 }
300
301 bool CompositeAnimation::animate(RenderElement& renderer, RenderStyle* currentStyle, RenderStyle& targetStyle, Ref<RenderStyle>& blendedStyle)
302 {
303     // We don't do any transitions if we don't have a currentStyle (on startup).
304     updateTransitions(&renderer, currentStyle, &targetStyle);
305     updateKeyframeAnimations(&renderer, currentStyle, &targetStyle);
306     m_keyframeAnimations.checkConsistency();
307
308     RefPtr<RenderStyle> animatedStyle;
309     bool animationStateChanged = false;
310
311     if (currentStyle) {
312         // Now that we have transition objects ready, let them know about the new goal state.  We want them
313         // to fill in a RenderStyle*& only if needed.
314         for (auto& transition : m_transitions.values()) {
315             if (transition->animate(this, &renderer, currentStyle, &targetStyle, animatedStyle))
316                 animationStateChanged = true;
317         }
318     }
319
320     // Now that we have animation objects ready, let them know about the new goal state.  We want them
321     // to fill in a RenderStyle*& only if needed.
322     for (auto& name : m_keyframeAnimationOrderMap) {
323         RefPtr<KeyframeAnimation> keyframeAnim = m_keyframeAnimations.get(name);
324         if (keyframeAnim && keyframeAnim->animate(this, &renderer, currentStyle, &targetStyle, animatedStyle))
325             animationStateChanged = true;
326     }
327
328     if (animatedStyle)
329         blendedStyle = animatedStyle.releaseNonNull();
330     else
331         blendedStyle = targetStyle;
332
333     return animationStateChanged;
334 }
335
336 PassRefPtr<RenderStyle> CompositeAnimation::getAnimatedStyle() const
337 {
338     RefPtr<RenderStyle> resultStyle;
339     for (auto& transition : m_transitions.values())
340         transition->getAnimatedStyle(resultStyle);
341
342     m_keyframeAnimations.checkConsistency();
343
344     for (auto& name : m_keyframeAnimationOrderMap) {
345         RefPtr<KeyframeAnimation> keyframeAnimation = m_keyframeAnimations.get(name);
346         if (keyframeAnimation)
347             keyframeAnimation->getAnimatedStyle(resultStyle);
348     }
349     
350     return resultStyle;
351 }
352
353 double CompositeAnimation::timeToNextService() const
354 {
355     // Returns the time at which next service is required. -1 means no service is required. 0 means 
356     // service is required now, and > 0 means service is required that many seconds in the future.
357     double minT = -1;
358     
359     if (!m_transitions.isEmpty()) {
360         for (auto& transition : m_transitions.values()) {
361             double t = transition->timeToNextService();
362             if (t < minT || minT == -1)
363                 minT = t;
364             if (minT == 0)
365                 return 0;
366         }
367     }
368     if (!m_keyframeAnimations.isEmpty()) {
369         m_keyframeAnimations.checkConsistency();
370         for (auto& animation : m_keyframeAnimations.values()) {
371             double t = animation->timeToNextService();
372             if (t < minT || minT == -1)
373                 minT = t;
374             if (minT == 0)
375                 return 0;
376         }
377     }
378
379     return minT;
380 }
381
382 PassRefPtr<KeyframeAnimation> CompositeAnimation::getAnimationForProperty(CSSPropertyID property) const
383 {
384     RefPtr<KeyframeAnimation> retval;
385     
386     // We want to send back the last animation with the property if there are multiples.
387     // So we need to iterate through all animations
388     if (!m_keyframeAnimations.isEmpty()) {
389         m_keyframeAnimations.checkConsistency();
390         for (auto& animation : m_keyframeAnimations.values()) {
391             if (animation->hasAnimationForProperty(property))
392                 retval = animation;
393         }
394     }
395     
396     return retval;
397 }
398
399 bool CompositeAnimation::computeExtentOfTransformAnimation(LayoutRect& bounds) const
400 {
401     // If more than one transition and animation affect transform, give up.
402     bool seenTransformAnimation = false;
403     
404     for (auto& animation : m_keyframeAnimations.values()) {
405         if (!animation->hasAnimationForProperty(CSSPropertyTransform))
406             continue;
407
408         if (seenTransformAnimation)
409             return false;
410
411         seenTransformAnimation = true;
412
413         if (!animation->computeExtentOfTransformAnimation(bounds))
414             return false;
415     }
416
417     for (auto& transition : m_transitions.values()) {
418         if (transition->animatingProperty() != CSSPropertyTransform || !transition->hasStyle())
419             continue;
420
421         if (seenTransformAnimation)
422             return false;
423
424         if (!transition->computeExtentOfTransformAnimation(bounds))
425             return false;
426     }
427     
428     return true;
429 }
430
431 void CompositeAnimation::suspendAnimations()
432 {
433     if (m_suspended)
434         return;
435
436     m_suspended = true;
437
438     if (!m_keyframeAnimations.isEmpty()) {
439         m_keyframeAnimations.checkConsistency();
440         for (auto& animation : m_keyframeAnimations.values())
441             animation->updatePlayState(AnimPlayStatePaused);
442     }
443
444     if (!m_transitions.isEmpty()) {
445         for (auto& transition : m_transitions.values()) {
446             if (transition->hasStyle())
447                 transition->updatePlayState(AnimPlayStatePaused);
448         }
449     }
450 }
451
452 void CompositeAnimation::resumeAnimations()
453 {
454     if (!m_suspended)
455         return;
456
457     m_suspended = false;
458
459     if (!m_keyframeAnimations.isEmpty()) {
460         m_keyframeAnimations.checkConsistency();
461         for (auto& animation : m_keyframeAnimations.values()) {
462             if (animation->playStatePlaying())
463                 animation->updatePlayState(AnimPlayStatePlaying);
464         }
465     }
466
467     if (!m_transitions.isEmpty()) {
468         for (auto& transition : m_transitions.values()) {
469             if (transition->hasStyle())
470                 transition->updatePlayState(AnimPlayStatePlaying);
471         }
472     }
473 }
474
475 void CompositeAnimation::overrideImplicitAnimations(CSSPropertyID property)
476 {
477     if (!m_transitions.isEmpty()) {
478         for (auto& transition : m_transitions.values()) {
479             if (transition->animatingProperty() == property)
480                 transition->setOverridden(true);
481         }
482     }
483 }
484
485 void CompositeAnimation::resumeOverriddenImplicitAnimations(CSSPropertyID property)
486 {
487     if (!m_transitions.isEmpty()) {
488         for (auto& transition : m_transitions.values()) {
489             if (transition->animatingProperty() == property)
490                 transition->setOverridden(false);
491         }
492     }
493 }
494
495 bool CompositeAnimation::isAnimatingProperty(CSSPropertyID property, bool acceleratedOnly, AnimationBase::RunningState runningState) const
496 {
497     if (!m_keyframeAnimations.isEmpty()) {
498         m_keyframeAnimations.checkConsistency();
499         for (auto& animation : m_keyframeAnimations.values()) {
500             if (animation->isAnimatingProperty(property, acceleratedOnly, runningState))
501                 return true;
502         }
503     }
504
505     if (!m_transitions.isEmpty()) {
506         for (auto& transition : m_transitions.values()) {
507             if (transition->isAnimatingProperty(property, acceleratedOnly, runningState))
508                 return true;
509         }
510     }
511     return false;
512 }
513
514 bool CompositeAnimation::pauseAnimationAtTime(const AtomicString& name, double t)
515 {
516     m_keyframeAnimations.checkConsistency();
517
518     RefPtr<KeyframeAnimation> keyframeAnim = m_keyframeAnimations.get(name.impl());
519     if (!keyframeAnim || !keyframeAnim->running())
520         return false;
521
522     keyframeAnim->freezeAtTime(t);
523     return true;
524 }
525
526 bool CompositeAnimation::pauseTransitionAtTime(CSSPropertyID property, double t)
527 {
528     if ((property < firstCSSProperty) || (property >= firstCSSProperty + numCSSProperties))
529         return false;
530
531     ImplicitAnimation* implAnim = m_transitions.get(property);
532     if (!implAnim) {
533         // Check to see if this property is being animated via a shorthand.
534         // This code is only used for testing, so performance is not critical here.
535         HashSet<CSSPropertyID> shorthandProperties = CSSPropertyAnimation::animatableShorthandsAffectingProperty(property);
536         bool anyPaused = false;
537         for (auto propertyID : shorthandProperties) {
538             if (pauseTransitionAtTime(propertyID, t))
539                 anyPaused = true;
540         }
541         return anyPaused;
542     }
543
544     if (!implAnim->running())
545         return false;
546
547     if ((t >= 0.0) && (t <= implAnim->duration())) {
548         implAnim->freezeAtTime(t);
549         return true;
550     }
551
552     return false;
553 }
554
555 unsigned CompositeAnimation::numberOfActiveAnimations() const
556 {
557     unsigned count = 0;
558     
559     m_keyframeAnimations.checkConsistency();
560     for (auto& animation : m_keyframeAnimations.values()) {
561         if (animation->running())
562             ++count;
563     }
564
565     for (auto& transition : m_transitions.values()) {
566         if (transition->running())
567             ++count;
568     }
569     
570     return count;
571 }
572
573 } // namespace WebCore