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)
+static void populateTiming(Timing& timing, Dictionary timingInputDictionary)
+{
+    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".
+    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))

[dstockwell, 2014/01/15 11:13:52]

I'm not sure this is the correct procedure for converting to 'double'. For
example, null should be treated as 0, while NaN, Infinity will throw a type
error :( I guess the bindings generator will take care of this once it supports
dictionaries.

See: http://www.w3.org/TR/WebIDL/#es-double

[rjwright, 2014/01/17 05:08:15]

Yeah I wasn't sure what to do about this.

+        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;
+    bool hasIterationDurationValue = timingInputDictionary.get("duration", iterationDurationValue);

[dstockwell, 2014/01/15 11:13:52]

Did we discover whether this will invoke a custom getter?

timing = {get duration() { return 1; }}

[rjwright, 2014/01/17 05:08:15]

Yes it does invoke the getter in this case.

+    double iterationDuration = 0;

[dstockwell, 2014/01/15 11:13:52]

just declare this as needed on lines 98 / 103

[rjwright, 2014/01/17 05:08:15]

Done.

+    if (hasIterationDurationValue) {
+        if (iterationDurationValue->IsString()) {
+            // All strings are treated as 'auto' except strings that are numbers, e.g. '1', 'Infinity'.
+            iterationDuration = iterationDurationValue->NumberValue();
+            if (!isnan(iterationDuration))
+                timing.iterationDuration = std::max<double>(iterationDuration, 0);
+            timing.hasIterationDuration = true;
+        } else if (iterationDurationValue->IsNumber()) {
+            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;
+    }
+}

[dstockwell, 2014/01/15 11:13:52]

timing.assertValid();

[rjwright, 2014/01/17 05:08:15]

Done.

+
+static void processTimingInput(Timing& timing, v8::Handle<v8::Value> timingInput)
+{
+    if (!timingInput.IsEmpty()) {
+        if (timingInput->IsObject()) {
+            populateTiming(timing, Dictionary(v8::Handle<v8::Value>::Cast(timingInput), v8::Isolate::GetCurrent()));
+        } else {
+            double duration = timingInput->NumberValue();
+            if (!isnan(duration)) {
+                timing.hasIterationDuration = true;
+                timing.iterationDuration = std::max<double>(duration, 0);
+            }
+        }
+    }
+}
+
+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)
 {
     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);
 }
 
-void ElementAnimation::startAnimation(Element* element, Vector<Dictionary> keyframeDictionaryVector, double duration)
+void ElementAnimation::animate(Element* element, Vector<Dictionary> keyframeDictionaryVector, ScriptValue 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.v8Value());
+}
+
+void ElementAnimation::startAnimation(Element* element, Vector<Dictionary> keyframeDictionaryVector, v8::Handle<v8::Value> timingInput)
 {
     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);
@@ skipping 31 matching lines @@
 
             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);
 
-    // FIXME: Totally hardcoded Timing for now. Will handle timing parameters later.
     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);
+    processTimingInput(timing, timingInput);
 
     RefPtr<Animation> animation = Animation::create(element, effect, timing);
     DocumentTimeline* timeline = element->document().timeline();
     ASSERT(timeline);
     timeline->play(animation.get());
 }
 
 } // namespace WebCore