Update animation when changes in animation keyframes are detected.

Source/core/animation/css/CSSAnimations.h

 /*
  * Copyright (C) 2013 Google 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:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 18 matching lines @@
  */
 
 #ifndef CSSAnimations_h
 #define CSSAnimations_h
 
 #include "core/animation/Animation.h"
 #include "core/animation/AnimationPlayer.h"
 #include "core/animation/InertAnimation.h"
 #include "core/animation/Interpolation.h"
 #include "core/animation/css/CSSAnimationData.h"
+#include "core/css/CSSKeyframesRule.h"
 #include "core/css/StylePropertySet.h"
 #include "core/dom/Document.h"
 #include "core/rendering/style/RenderStyleConstants.h"
 #include "wtf/HashMap.h"
 #include "wtf/Vector.h"
 #include "wtf/text/AtomicString.h"
 
 namespace blink {
 
 class CSSTransitionData;
 class Element;
 class StylePropertyShorthand;
 class StyleResolver;
-class StyleRuleKeyframes;
 
 // This class stores the CSS Animations/Transitions information we use during a style recalc.
 // This includes updates to animations/transitions as well as the Interpolations to be applied.
 class CSSAnimationUpdate final : public NoBaseWillBeGarbageCollectedFinalized<CSSAnimationUpdate> {
 public:
-    void startAnimation(const AtomicString& animationName, PassRefPtrWillBeRawPtr<InertAnimation> animation)
+    void startAnimation(const AtomicString& animationName, PassRefPtrWillBeRawPtr<InertAnimation> animation, const Timing& timing, PassRefPtrWillBeRawPtr<StyleRuleKeyframes> styleRule)
     {
         animation->setName(animationName);
         NewAnimation newAnimation;
         newAnimation.name = animationName;
         newAnimation.animation = animation;
+        newAnimation.timing = timing;
+        newAnimation.styleChangeCounter = styleRule->styleChangeCounter();
+        newAnimation.styleRule = styleRule;
         m_newAnimations.append(newAnimation);
     }
     // Returns whether player has been suppressed and should be filtered during style application.
     bool isSuppressedAnimation(const AnimationPlayer* player) const { return m_suppressedAnimationPlayers.contains(player); }
     void cancelAnimation(const AtomicString& name, AnimationPlayer& player)
     {
         m_cancelledAnimationNames.append(name);
         m_suppressedAnimationPlayers.add(&player);
     }
     void toggleAnimationPaused(const AtomicString& name)
     {
         m_animationsWithPauseToggled.append(name);
     }
-    void updateAnimationTiming(AnimationPlayer* player, PassRefPtrWillBeRawPtr<InertAnimation> animation, const Timing& timing)
+    void updateAnimation(const AtomicString& name, AnimationPlayer* player, PassRefPtrWillBeRawPtr<InertAnimation> animation, const Timing& specifiedTiming, PassRefPtrWillBeRawPtr<StyleRuleKeyframes> styleRule)
     {
-        UpdatedAnimationTiming updatedAnimation;
+        UpdatedAnimation updatedAnimation;
+        updatedAnimation.name = name;
         updatedAnimation.player = player;
         updatedAnimation.animation = animation;
-        updatedAnimation.newTiming = timing;
-        m_animationsWithTimingUpdates.append(updatedAnimation);
+        updatedAnimation.specifiedTiming = specifiedTiming;

[shans, 2015/01/14 00:26:19]

just 'timing' for consistency with InertAnimations?

[shend, 2015/01/14 00:42:04]

The 'timing' in InertAnimations isn't actually the true specified timing when
created from CSSAnimations, because it always uses the default easing of linear.
In order to detect changes in the easing, I keep track of the actual specified
timing as 'specifiedTiming' (with the actual specified easing). Maybe there's
something we can do to make this clearer?

[shans, 2015/01/15 00:29:52]

Could InertAnimations have the easing from the CSSAnimation? That might make
tracking the timing slightly easier too?

[shend, 2015/01/15 01:51:28]

I originally talked to Sam about this, but we thought that it was better to keep
CSS animation specific things out of web animations. What do you think?

+        updatedAnimation.styleChangeCounter = styleRule->styleChangeCounter();
+        updatedAnimation.styleRule = styleRule;
+        m_animationsWithUpdates.append(updatedAnimation);
         m_suppressedAnimationPlayers.add(player);
     }
 
     void startTransition(CSSPropertyID id, CSSPropertyID eventId, const AnimatableValue* from, const AnimatableValue* to, PassRefPtrWillBeRawPtr<InertAnimation> animation)
     {
         animation->setName(getPropertyName(id));
         NewTransition newTransition;
         newTransition.id = id;
         newTransition.eventId = eventId;
         newTransition.from = from;
         newTransition.to = to;
         newTransition.animation = animation;
         m_newTransitions.set(id, newTransition);
     }
     bool isCancelledTransition(CSSPropertyID id) const { return m_cancelledTransitions.contains(id); }
     void cancelTransition(CSSPropertyID id) { m_cancelledTransitions.add(id); }
 
     struct NewAnimation {
         ALLOW_ONLY_INLINE_ALLOCATION();
     public:
         void trace(Visitor* visitor)
         {
             visitor->trace(animation);
         }
 
         AtomicString name;
         RefPtrWillBeMember<InertAnimation> animation;
+        Timing timing;
+        RefPtrWillBeMember<StyleRuleKeyframes> styleRule;
+        unsigned styleChangeCounter;
     };
 
-    struct UpdatedAnimationTiming {
+    struct UpdatedAnimation {
         ALLOW_ONLY_INLINE_ALLOCATION();
     public:
         void trace(Visitor* visitor)
         {
             visitor->trace(player);
             visitor->trace(animation);
         }
 
+        AtomicString name;
         RawPtrWillBeMember<AnimationPlayer> player;
         RefPtrWillBeMember<InertAnimation> animation;
-        Timing newTiming;
+        Timing specifiedTiming;
+        RefPtrWillBeMember<StyleRuleKeyframes> styleRule;
+        unsigned styleChangeCounter;
     };
 
     const WillBeHeapVector<NewAnimation>& newAnimations() const { return m_newAnimations; }
     const Vector<AtomicString>& cancelledAnimationNames() const { return m_cancelledAnimationNames; }
     const WillBeHeapHashSet<RawPtrWillBeMember<const AnimationPlayer>>& suppressedAnimationAnimationPlayers() const { return m_suppressedAnimationPlayers; }
     const Vector<AtomicString>& animationsWithPauseToggled() const { return m_animationsWithPauseToggled; }
-    const WillBeHeapVector<UpdatedAnimationTiming>& animationsWithTimingUpdates() const { return m_animationsWithTimingUpdates; }
+    const WillBeHeapVector<UpdatedAnimation>& animationsWithUpdates() const { return m_animationsWithUpdates; }
 
     struct NewTransition {
         ALLOW_ONLY_INLINE_ALLOCATION();
     public:
         void trace(Visitor* visitor)
         {
             visitor->trace(from);
             visitor->trace(to);
             visitor->trace(animation);
         }
@@ skipping 13 matching lines @@
     const WillBeHeapHashMap<CSSPropertyID, RefPtrWillBeMember<Interpolation>>& activeInterpolationsForAnimations() const { return m_activeInterpolationsForAnimations; }
     const WillBeHeapHashMap<CSSPropertyID, RefPtrWillBeMember<Interpolation>>& activeInterpolationsForTransitions() const { return m_activeInterpolationsForTransitions; }
     WillBeHeapHashMap<CSSPropertyID, RefPtrWillBeMember<Interpolation>>& activeInterpolationsForAnimations() { return m_activeInterpolationsForAnimations; }
 
     bool isEmpty() const
     {
         return m_newAnimations.isEmpty()
             && m_cancelledAnimationNames.isEmpty()
             && m_suppressedAnimationPlayers.isEmpty()
             && m_animationsWithPauseToggled.isEmpty()
-            && m_animationsWithTimingUpdates.isEmpty()
+            && m_animationsWithUpdates.isEmpty()
             && m_newTransitions.isEmpty()
             && m_cancelledTransitions.isEmpty()
             && m_activeInterpolationsForAnimations.isEmpty()
             && m_activeInterpolationsForTransitions.isEmpty();
     }
 
     void trace(Visitor*);
 
 private:
     // Order is significant since it defines the order in which new animations
     // will be started. Note that there may be multiple animations present
     // with the same name, due to the way in which we split up animations with
     // incomplete keyframes.
     WillBeHeapVector<NewAnimation> m_newAnimations;
     Vector<AtomicString> m_cancelledAnimationNames;
     WillBeHeapHashSet<RawPtrWillBeMember<const AnimationPlayer>> m_suppressedAnimationPlayers;
     Vector<AtomicString> m_animationsWithPauseToggled;
-    WillBeHeapVector<UpdatedAnimationTiming> m_animationsWithTimingUpdates;
+    WillBeHeapVector<UpdatedAnimation> m_animationsWithUpdates;
 
     NewTransitionMap m_newTransitions;
     HashSet<CSSPropertyID> m_cancelledTransitions;
 
     WillBeHeapHashMap<CSSPropertyID, RefPtrWillBeMember<Interpolation>> m_activeInterpolationsForAnimations;
     WillBeHeapHashMap<CSSPropertyID, RefPtrWillBeMember<Interpolation>> m_activeInterpolationsForTransitions;
 };
 
 class CSSAnimations final {
     WTF_MAKE_NONCOPYABLE(CSSAnimations);
     DISALLOW_ALLOCATION();
 public:
     CSSAnimations();
 
     const AtomicString getAnimationNameForInspector(const AnimationPlayer&);
 
     static const StylePropertyShorthand& animatableProperties();
     static bool isAllowedAnimation(CSSPropertyID);
     static PassOwnPtrWillBeRawPtr<CSSAnimationUpdate> calculateUpdate(const Element* animatingElement, Element&, const RenderStyle&, RenderStyle* parentStyle, StyleResolver*);
 
     void setPendingUpdate(PassOwnPtrWillBeRawPtr<CSSAnimationUpdate> update) { m_pendingUpdate = update; }
     void maybeApplyPendingUpdate(Element*);
     bool isEmpty() const { return m_animations.isEmpty() && m_transitions.isEmpty() && !m_pendingUpdate; }
     void cancel();
 
     void trace(Visitor*);
 
 private:
+    struct RunningAnimation {
+        ALLOW_ONLY_INLINE_ALLOCATION();
+    public:
+        void trace(Visitor* visitor)
+        {
+            visitor->trace(player);
+        }
+
+        RefPtrWillBeMember<AnimationPlayer> player;
+        Timing specifiedTiming;
+        RefPtrWillBeMember<StyleRuleKeyframes> styleRule;
+        unsigned styleChangeCounter;
+    };
+
     struct RunningTransition {
         ALLOW_ONLY_INLINE_ALLOCATION();
     public:
         void trace(Visitor* visitor)
         {
             visitor->trace(player);
             visitor->trace(from);
             visitor->trace(to);
         }
 
         RefPtrWillBeMember<AnimationPlayer> player;
         RawPtrWillBeMember<const AnimatableValue> from;
         RawPtrWillBeMember<const AnimatableValue> to;
     };
 
-    using AnimationMap = WillBeHeapHashMap<AtomicString, RefPtrWillBeMember<AnimationPlayer>>;
+    using AnimationMap = WillBeHeapHashMap<AtomicString, RunningAnimation>;
     AnimationMap m_animations;
 
     using TransitionMap = WillBeHeapHashMap<CSSPropertyID, RunningTransition>;
     TransitionMap m_transitions;
 
     OwnPtrWillBeMember<CSSAnimationUpdate> m_pendingUpdate;
 
     WillBeHeapHashMap<CSSPropertyID, RefPtrWillBeMember<Interpolation>> m_previousActiveInterpolationsForAnimations;
 
     static void calculateAnimationUpdate(CSSAnimationUpdate*, const Element* animatingElement, Element&, const RenderStyle&, RenderStyle* parentStyle, StyleResolver*);
@@ skipping 39 matching lines @@
     private:
         RawPtrWillBeMember<Element> m_target;
         const CSSPropertyID m_property;
         AnimationNode::Phase m_previousPhase;
     };
 };
 
 } // namespace blink
 
 WTF_ALLOW_INIT_WITH_MEM_FUNCTIONS(blink::CSSAnimationUpdate::NewAnimation);
-WTF_ALLOW_INIT_WITH_MEM_FUNCTIONS(blink::CSSAnimationUpdate::UpdatedAnimationTiming);
+WTF_ALLOW_INIT_WITH_MEM_FUNCTIONS(blink::CSSAnimationUpdate::UpdatedAnimation);
 
 #endif