Web Animations: Introduce String based KeyframeEffectModel

Source/core/animation/KeyframeEffectModel.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 13 matching lines @@
  * 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.
  */
 
 #ifndef KeyframeEffectModel_h
 #define KeyframeEffectModel_h
 
-#include "core/animation/AnimatableValue.h"
+#include "core/animation/AnimatableValueKeyframe.h"
 #include "core/animation/AnimationEffect.h"
 #include "core/animation/InterpolationEffect.h"
+#include "core/animation/StringKeyframe.h"
+#include "core/animation/TimedItem.h"
 #include "heap/Handle.h"
 #include "platform/animation/TimingFunction.h"
 #include "wtf/HashMap.h"
 #include "wtf/HashSet.h"
 #include "wtf/PassOwnPtr.h"
 #include "wtf/PassRefPtr.h"
 #include "wtf/RefCounted.h"
 #include "wtf/Vector.h"
 
 namespace WebCore {
 
-typedef HashSet<CSSPropertyID> PropertySet;
-
 class KeyframeEffectModelTest;
 
-// Represents the keyframes set through the API.
-class Keyframe : public RefCountedWillBeGarbageCollectedFinalized<Keyframe> {
+class KeyframeEffectModelBase : public AnimationEffect {
 public:
-    static PassRefPtrWillBeRawPtr<Keyframe> create()
-    {
-        return adoptRefWillBeNoop(new Keyframe);
-    }
-    static bool compareOffsets(const RefPtrWillBeRawPtr<Keyframe>& a, const RefPtrWillBeRawPtr<Keyframe>& b)
-    {
-        return a->offset() < b->offset();
-    }
-    void setOffset(double offset) { m_offset = offset; }
-    double offset() const { return m_offset; }
-    void setComposite(AnimationEffect::CompositeOperation composite) { m_composite = composite; }
-    AnimationEffect::CompositeOperation composite() const { return m_composite; }
-    void setEasing(PassRefPtr<TimingFunction>);
-    TimingFunction* easing() const { return m_easing.get(); }
-    void setPropertyValue(CSSPropertyID, const AnimatableValue*);
-    void clearPropertyValue(CSSPropertyID);
-    const AnimatableValue* propertyValue(CSSPropertyID) const;
-    PropertySet properties() const;
-    PassRefPtrWillBeRawPtr<Keyframe> clone() const { return adoptRefWillBeNoop(new Keyframe(*this)); }
-    PassRefPtrWillBeRawPtr<Keyframe> cloneWithOffset(double offset) const;
+    // FIXME: Implement accumulation.
 
-    void trace(Visitor*);
+    typedef Vector<OwnPtr<Keyframe::PropertySpecificKeyframe> > PropertySpecificKeyframeVector;
+    class PropertySpecificKeyframeGroup {
+    public:
+        void appendKeyframe(PassOwnPtrWillBeRawPtr<Keyframe::PropertySpecificKeyframe>);
+        const PropertySpecificKeyframeVector& keyframes() const { return m_keyframes; }
 
-private:
-    Keyframe();
-    Keyframe(const Keyframe&);
-    double m_offset;
-    AnimationEffect::CompositeOperation m_composite;
-    RefPtr<TimingFunction> m_easing;
-    typedef WillBeHeapHashMap<CSSPropertyID, RefPtrWillBeMember<AnimatableValue> > PropertyValueMap;
-    PropertyValueMap m_propertyValues;
-};
+        void trace(Visitor*);
 
-class KeyframeEffectModel FINAL : public AnimationEffect {
-public:
-    class PropertySpecificKeyframe;
-    typedef WillBeHeapVector<RefPtrWillBeMember<Keyframe> > KeyframeVector;
-    typedef WillBeHeapVector<OwnPtrWillBeMember<PropertySpecificKeyframe> > PropertySpecificKeyframeVector;
-    // FIXME: Implement accumulation.
-    static PassRefPtrWillBeRawPtr<KeyframeEffectModel> create(const KeyframeVector& keyframes)
-    {
-        return adoptRefWillBeNoop(new KeyframeEffectModel(keyframes));
-    }
+    private:
+        void removeRedundantKeyframes();
+        void addSyntheticKeyframeIfRequired(const KeyframeEffectModelBase* context);
 
-    virtual bool affects(CSSPropertyID property) OVERRIDE
-    {
-        ensureKeyframeGroups();
-        return m_keyframeGroups->contains(property);
-    }
+        PropertySpecificKeyframeVector m_keyframes;
 
-    // AnimationEffect implementation.
-    virtual PassOwnPtrWillBeRawPtr<WillBeHeapVector<RefPtrWillBeMember<Interpolation> > > sample(int iteration, double fraction, double iterationDuration) const OVERRIDE;
-
-    // FIXME: Implement setFrames()
-    const KeyframeVector& getFrames() const { return m_keyframes; }
-
-    virtual bool isKeyframeEffectModel() const OVERRIDE { return true; }
+        friend class KeyframeEffectModelBase;
+    };
 
     bool isReplaceOnly();
 
     PropertySet properties() const;
 
-    class PropertySpecificKeyframe : public NoBaseWillBeGarbageCollectedFinalized<PropertySpecificKeyframe> {
-    public:
-        PropertySpecificKeyframe(double offset, PassRefPtr<TimingFunction> easing, const AnimatableValue*, CompositeOperation);
-        double offset() const { return m_offset; }
-        TimingFunction* easing() const { return m_easing.get(); }
-        const AnimatableValue* value() const { return m_value.get(); }
-        AnimationEffect::CompositeOperation composite() const { return m_composite; }
-        PassOwnPtrWillBeRawPtr<PropertySpecificKeyframe> cloneWithOffset(double offset) const;
-
-        void trace(Visitor*);
-
-    private:
-        // Used by cloneWithOffset().
-        PropertySpecificKeyframe(double offset, PassRefPtr<TimingFunction> easing, PassRefPtrWillBeRawPtr<AnimatableValue>, CompositeOperation);
-        double m_offset;
-        RefPtr<TimingFunction> m_easing;
-        RefPtrWillBeMember<AnimatableValue> m_value;
-        AnimationEffect::CompositeOperation m_composite;
-    };
-
-    class PropertySpecificKeyframeGroup : public NoBaseWillBeGarbageCollectedFinalized<PropertySpecificKeyframeGroup> {
-    public:
-        void appendKeyframe(PassOwnPtrWillBeRawPtr<PropertySpecificKeyframe>);
-        const PropertySpecificKeyframeVector& keyframes() const { return m_keyframes; }
-
-        void trace(Visitor*);
-
-    private:
-        PropertySpecificKeyframeVector m_keyframes;
-        void removeRedundantKeyframes();
-        void addSyntheticKeyframeIfRequired();
-
-        friend class KeyframeEffectModel;
-    };
+    typedef WillBeHeapVector<RefPtrWillBeMember<Keyframe> > KeyframeVector;
+    const KeyframeVector& getFrames() const { return m_keyframes; }
+    // FIXME: Implement setFrames()
 
     const PropertySpecificKeyframeVector& getPropertySpecificKeyframes(CSSPropertyID id) const
     {
         ensureKeyframeGroups();
         return m_keyframeGroups->get(id)->keyframes();
     }
 
+    // AnimationEffect implementation.
+    virtual PassOwnPtrWillBeRawPtr<WillBeHeapVector<RefPtrWillBeMember<Interpolation> > > sample(int iteration, double fraction, double iterationDuration) const OVERRIDE;
+
+    virtual bool isKeyframeEffectModel() const OVERRIDE { return true; }
+
+    virtual bool isAnimatableValueKeyframeEffectModel() const { return false; }
+    virtual bool isStringKeyframeEffectModel() const { return false; }
+
     virtual void trace(Visitor*) OVERRIDE;
 
-private:
-    KeyframeEffectModel(const KeyframeVector& keyframes);
-
+protected:
     static KeyframeVector normalizedKeyframes(const KeyframeVector& keyframes);
 
     // Lazily computes the groups of property-specific keyframes.
     void ensureKeyframeGroups() const;
     void ensureInterpolationEffect() const;
 
     KeyframeVector m_keyframes;
     // The spec describes filtering the normalized keyframes at sampling time
     // to get the 'property-specific keyframes'. For efficiency, we cache the
     // property-specific lists.
     typedef WillBeHeapHashMap<CSSPropertyID, OwnPtrWillBeMember<PropertySpecificKeyframeGroup> > KeyframeGroupMap;
     mutable OwnPtrWillBeMember<KeyframeGroupMap> m_keyframeGroups;
-
-    mutable RefPtrWillBeMember<InterpolationEffect> m_interpolationEffect;
+    mutable RefPtr<InterpolationEffect> m_interpolationEffect;
 
     friend class KeyframeEffectModelTest;
+
+    bool affects(CSSPropertyID property)
+    {
+        ensureKeyframeGroups();
+        return m_keyframeGroups->contains(property);
+    }
 };
 
-DEFINE_TYPE_CASTS(KeyframeEffectModel, AnimationEffect, value, value->isKeyframeEffectModel(), value.isKeyframeEffectModel());
+template <class Keyframe>
+class KeyframeEffectModel FINAL : public KeyframeEffectModelBase {
+public:
+    typedef WillBeHeapVector<RefPtrWillBeMember<Keyframe> > KeyframeVector;
+    static PassRefPtrWillBeRawPtr<KeyframeEffectModel<Keyframe> > create(const KeyframeVector& keyframes) { return adoptRefWillBeNoop(new KeyframeEffectModel(keyframes)); }
+
+private:
+    KeyframeEffectModel(const KeyframeVector& keyframes)
+    {
+        m_keyframes.appendVector(keyframes);
+    }
+
+    virtual bool isAnimatableValueKeyframeEffectModel() const { return false; }
+    virtual bool isStringKeyframeEffectModel() const { return false; }
+
+};
+
+typedef KeyframeEffectModelBase::KeyframeVector KeyframeVector;
+typedef KeyframeEffectModelBase::PropertySpecificKeyframeVector PropertySpecificKeyframeVector;
+
+typedef KeyframeEffectModel<AnimatableValueKeyframe> AnimatableValueKeyframeEffectModel;
+typedef AnimatableValueKeyframeEffectModel::KeyframeVector AnimatableValueKeyframeVector;
+typedef AnimatableValueKeyframeEffectModel::PropertySpecificKeyframeVector AnimatableValuePropertySpecificKeyframeVector;
+
+typedef KeyframeEffectModel<StringKeyframe> StringKeyframeEffectModel;
+typedef StringKeyframeEffectModel::KeyframeVector StringKeyframeVector;
+typedef StringKeyframeEffectModel::PropertySpecificKeyframeVector StringPropertySpecificKeyframeVector;
+
+DEFINE_TYPE_CASTS(KeyframeEffectModelBase, AnimationEffect, value, value->isKeyframeEffectModel(), value.isKeyframeEffectModel());
+DEFINE_TYPE_CASTS(AnimatableValueKeyframeEffectModel, KeyframeEffectModelBase, value, value->isAnimatableValueKeyframeEffectModel(), value.isAnimatableValueKeyframeEffectModel());
+
+inline const AnimatableValueKeyframeEffectModel* toAnimatableValueKeyframeEffectModel(const AnimationEffect* base)
+{
+    return toAnimatableValueKeyframeEffectModel(toKeyframeEffectModelBase(base));
+}
+
+inline AnimatableValueKeyframeEffectModel* toAnimatableValueKeyframeEffectModel(AnimationEffect* base)
+{
+    return toAnimatableValueKeyframeEffectModel(toKeyframeEffectModelBase(base));
+}
 
 } // namespace WebCore
 
 #endif // KeyframeEffectModel_h