Web Animations API: Start implementation of timing input objects.

Source/core/animation/ElementAnimation.cpp

 /*
  * 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 14 matching lines @@
  * 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.
  */
 
 #include "config.h"
 #include "core/animation/ElementAnimation.h"
 
 #include "bindings/v8/Dictionary.h"
+#include "bindings/v8/ScriptValue.h"
 #include "core/animation/DocumentTimeline.h"
 #include "core/css/parser/BisonCSSParser.h"
-#include "core/css/RuntimeCSSEnabled.h"
 #include "core/css/resolver/StyleResolver.h"
 #include "wtf/text/StringBuilder.h"
 #include <algorithm>
 
 namespace WebCore {
 
 CSSPropertyID ElementAnimation::camelCaseCSSPropertyNameToID(const String& propertyName)
 {
     if (propertyName.find('-') != kNotFound)
         return CSSPropertyInvalid;
 
     StringBuilder builder;
     size_t position = 0;
     size_t end;
     while ((end = propertyName.find(isASCIIUpper, position)) != kNotFound) {
         builder.append(propertyName.substring(position, end - position) + "-" + toASCIILower((propertyName)[end]));
         position = end + 1;
     }
     builder.append(propertyName.substring(position));
     // Doesn't handle prefixed properties.
     CSSPropertyID id = cssPropertyID(builder.toString());
     return id;
 }
 
-void ElementAnimation::animate(Element* element, Vector<Dictionary> keyframeDictionaryVector, double duration)
+void ElementAnimation::populateTiming(Timing& timing, Dictionary timingInputDictionary)
+{
+    // FIXME: This method needs to be refactored to handle invalid
+    // null, NaN, Infinity values better.
+    // See: http://www.w3.org/TR/WebIDL/#es-double
+    double startDelay = 0;
+    timingInputDictionary.get("delay", startDelay);
+    if (!isnan(startDelay) && !isinf(startDelay))
+        timing.startDelay = startDelay;
+
+    String fillMode;
+    timingInputDictionary.get("fill", fillMode);
+    // FIXME: This will need to be changed to "forwards" when
+    // Timing.h implements the spec change that makes default
+    // fill mode "none".

[dstockwell, 2014/01/21 20:47:29]

The default in the spec seems to be "auto"

[rjwright, 2014/01/22 03:56:08]

Done.

+    if (fillMode == "none") {
+        timing.fillMode = Timing::FillModeNone;
+    } else if (fillMode == "backwards") {
+        timing.fillMode = Timing::FillModeBackwards;
+    } else if (fillMode == "both") {
+        timing.fillMode = Timing::FillModeBoth;
+    }
+
+    double iterationStart = 0;
+    timingInputDictionary.get("iterationStart", iterationStart);
+    if (!isnan(iterationStart) && !isinf(iterationStart))
+        timing.iterationStart = std::max<double>(iterationStart, 0);
+
+    double iterationCount = 1;
+    timingInputDictionary.get("iterations", iterationCount);
+    if (!isnan(iterationCount))
+        timing.iterationCount = std::max<double>(iterationCount, 0);
+
+    v8::Local<v8::Value> iterationDurationValue;

[dstockwell, 2014/01/21 20:47:29]

We shouldn't be using v8::Local in core/, but there doesn't seem to be a good
way to accomplish "all strings are treated as 'auto' except" otherwise.

Let's treat NaN as 'auto' for now. So just get(double&) and only set iteration
duration if !isnan.

// fixme that this needs to be resolved in the spec

[rjwright, 2014/01/22 03:56:08]

Done.

+    bool hasIterationDurationValue = timingInputDictionary.get("duration", iterationDurationValue);
+    if (hasIterationDurationValue) {
+        if (iterationDurationValue->IsString()) {
+            // All strings are treated as 'auto' except strings that are numbers, e.g. '1', 'Infinity'.

[dstockwell, 2014/01/21 20:47:29]

Looks like it should actually be that numbers less than 0 are also treated as
"auto".

[rjwright, 2014/01/22 03:56:08]

Done.

+            double iterationDuration = iterationDurationValue->NumberValue();
+            if (!isnan(iterationDuration))
+                timing.iterationDuration = std::max<double>(iterationDuration, 0);
+            timing.hasIterationDuration = true;
+        } else if (iterationDurationValue->IsNumber()) {
+            double iterationDuration = iterationDurationValue->NumberValue();
+            if (!isnan(iterationDuration)) {
+                timing.iterationDuration = std::max<double>(iterationDuration, 0);
+                timing.hasIterationDuration = true;
+            }
+        }
+    }
+
+    double playbackRate = 1;
+    timingInputDictionary.get("playbackRate", playbackRate);
+    if (!isnan(playbackRate) && !isinf(playbackRate))
+        timing.playbackRate = playbackRate;
+
+    String direction;
+    timingInputDictionary.get("direction", direction);
+    if (direction == "reverse") {
+        timing.direction = Timing::PlaybackDirectionReverse;
+    } else if (direction == "alternate") {
+        timing.direction = Timing::PlaybackDirectionAlternate;
+    } else if (direction == "alternate-reverse") {
+        timing.direction = Timing::PlaybackDirectionAlternateReverse;
+    }
+
+    timing.assertValid();
+}
+
+static bool checkDocumentAndRenderer(Element* element)
+{
+    if (!element->inActiveDocument())
+        return false;
+    element->document().updateStyleIfNeeded();
+    if (!element->renderer())
+        return false;
+    return true;
+}
+
+void ElementAnimation::animate(Element* element, Vector<Dictionary> keyframeDictionaryVector, Dictionary timingInput)
 {
     ASSERT(RuntimeEnabledFeatures::webAnimationsAPIEnabled());
 
     // FIXME: This test will not be neccessary once resolution of keyframe values occurs at
     // animation application time.
-    if (!element->inActiveDocument())
-        return;
-    element->document().updateStyleIfNeeded();
-    if (!element->renderer())
+    if (!checkDocumentAndRenderer(element))
         return;
 
-    startAnimation(element, keyframeDictionaryVector, duration);
+    startAnimation(element, keyframeDictionaryVector, timingInput);
 }
 
-void ElementAnimation::startAnimation(Element* element, Vector<Dictionary> keyframeDictionaryVector, double duration)
+void ElementAnimation::animate(Element* element, Vector<Dictionary> keyframeDictionaryVector, double timingInput)
+{
+    ASSERT(RuntimeEnabledFeatures::webAnimationsAPIEnabled());
+
+    // FIXME: This test will not be neccessary once resolution of keyframe values occurs at
+    // animation application time.
+    if (!checkDocumentAndRenderer(element))
+        return;
+
+    startAnimation(element, keyframeDictionaryVector, timingInput);
+}
+
+void ElementAnimation::animate(Element* element, Vector<Dictionary> keyframeDictionaryVector)
+{
+    ASSERT(RuntimeEnabledFeatures::webAnimationsAPIEnabled());
+
+    // FIXME: This test will not be neccessary once resolution of keyframe values occurs at
+    // animation application time.
+    if (!checkDocumentAndRenderer(element))
+        return;
+
+    startAnimation(element, keyframeDictionaryVector);
+}
+
+static PassRefPtr<KeyframeEffectModel> createKeyframeEffectModel(Element* element, Vector<Dictionary> keyframeDictionaryVector)
 {
     KeyframeEffectModel::KeyframeVector keyframes;
     Vector<RefPtr<MutableStylePropertySet> > propertySetVector;
 
     for (size_t i = 0; i < keyframeDictionaryVector.size(); ++i) {
         RefPtr<MutableStylePropertySet> propertySet = MutableStylePropertySet::create();
         propertySetVector.append(propertySet);
 
         RefPtr<Keyframe> keyframe = Keyframe::create();
         keyframes.append(keyframe);
 
         double offset;
         if (keyframeDictionaryVector[i].get("offset", offset)) {
             keyframe->setOffset(offset);
         } else {
             // FIXME: Web Animations CSS engine does not yet implement handling of
             // keyframes without specified offsets. This check can be removed when
             // that funcitonality is implemented.
             ASSERT_NOT_REACHED();
-            return;
+            return 0;
         }
 
         String compositeString;
         keyframeDictionaryVector[i].get("composite", compositeString);
         if (compositeString == "add")
             keyframe->setComposite(AnimationEffect::CompositeAdd);
 
         Vector<String> keyframeProperties;
         keyframeDictionaryVector[i].getOwnPropertyNames(keyframeProperties);
 
         for (size_t j = 0; j < keyframeProperties.size(); ++j) {
             String property = keyframeProperties[j];
-            CSSPropertyID id = camelCaseCSSPropertyNameToID(property);
+            CSSPropertyID id = ElementAnimation::camelCaseCSSPropertyNameToID(property);
 
             // FIXME: There is no way to store invalid properties or invalid values
             // in a Keyframe object, so for now I just skip over them. Eventually we
             // will need to support getFrames(), which should return exactly the
             // keyframes that were input through the API. We will add a layer to wrap
             // KeyframeEffectModel, store input keyframes and implement getFrames.
             if (id == CSSPropertyInvalid || !CSSAnimations::isAnimatableProperty(id))
                 continue;
 
             String value;
             keyframeDictionaryVector[i].get(property, value);
             propertySet->setProperty(id, value);
         }
     }
 
     // FIXME: Replace this with code that just parses, when that code is available.
     RefPtr<KeyframeEffectModel> effect = StyleResolver::createKeyframeEffectModel(*element, propertySetVector, keyframes);
+    return effect;
+}
 
-    // FIXME: Totally hardcoded Timing for now. Will handle timing parameters later.
+void ElementAnimation::startAnimation(Element* element, Vector<Dictionary> keyframeDictionaryVector, Dictionary timingInput)
+{
+    RefPtr<KeyframeEffectModel> effect = createKeyframeEffectModel(element, keyframeDictionaryVector);
+
     Timing timing;
-    // FIXME: Currently there is no way to tell whether or not an iterationDuration
-    // has been specified (becauser the default argument is 0). So any animation
-    // created using Element.animate() will have a timing with hasIterationDuration()
-    // == true.
-    timing.hasIterationDuration = true;
-    timing.iterationDuration = std::max<double>(duration, 0);
+    populateTiming(timing, timingInput);
 
     RefPtr<Animation> animation = Animation::create(element, effect, timing);
     DocumentTimeline* timeline = element->document().timeline();
+    ASSERT(timeline);
+    timeline->play(animation.get());
+}
+
+void ElementAnimation::startAnimation(Element* element, Vector<Dictionary> keyframeDictionaryVector, double timingInput)
+{
+    RefPtr<KeyframeEffectModel> effect = createKeyframeEffectModel(element, keyframeDictionaryVector);
+
+    Timing timing;
+    if (!isnan(timingInput)) {
+        timing.hasIterationDuration = true;
+        timing.iterationDuration = std::max<double>(timingInput, 0);
+    }
+
+    RefPtr<Animation> animation = Animation::create(element, effect, timing);
+    DocumentTimeline* timeline = element->document().timeline();
+    ASSERT(timeline);
+    timeline->play(animation.get());
+}
+
+void ElementAnimation::startAnimation(Element* element, Vector<Dictionary> keyframeDictionaryVector)
+{
+    RefPtr<KeyframeEffectModel> effect = createKeyframeEffectModel(element, keyframeDictionaryVector);
+
+    Timing timing;
+
+    RefPtr<Animation> animation = Animation::create(element, effect, timing);
+    DocumentTimeline* timeline = element->document().timeline();
     ASSERT(timeline);
     timeline->play(animation.get());
 }
 
 } // namespace WebCore