Web Animations CSS: Split AnimatableNumber into AnimatableDouble and AnimatableLength

Source/core/animation/AnimatableLength.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 10 matching lines @@
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * 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 AnimatableNumber_h
-#define AnimatableNumber_h
+#ifndef AnimatableLength_h
+#define AnimatableLength_h
 
 #include "core/animation/AnimatableValue.h"
 #include "core/css/CSSCalculationValue.h"
 #include "core/css/CSSPrimitiveValue.h"
+#include "core/platform/Length.h"
 
 namespace WebCore {
 
 enum NumberRange {
     AllValues,
     NonNegativeValues,
 };
 
-// Handles animation of CSSPrimitiveValues that can be represented by doubles including CSSCalcValue.
-// See primitiveUnitToNumberType() for the list of supported units (with the exception of calc).
-// If created from a CSSPrimitiveValue this class will cache it to be returned in toCSSValue().
-class AnimatableNumber : public AnimatableValue {
+class AnimatableLength : public AnimatableValue {

[Steve Block, 2013/09/30 23:21:31]

It would be good to retain the class-level comment, here and in
AnimatableDouble.

[alancutter (OOO until 2018), 2013/10/02 00:01:19]

Done.

 public:
     enum NumberUnitType {
-        UnitTypeNumber,
         UnitTypeLength,

[Steve Block, 2013/09/30 23:21:31]

This seems like a bad name, now that the class is AnimatableLength. These are
all ways of specifying a length. Maybe UnitTypeFixed/Constant/Simple?

[alancutter (OOO until 2018), 2013/10/02 00:01:19]

I agree, UnitTypeFixed sounds okay but in the context of zooming I don't think
it's suitable here (the value is yet to be zoomed unlike a Length). Instead I've
renamed it as UnitTypePixels.

         UnitTypeFontSize,
         UnitTypeFontXSize,
         UnitTypeRootFontSize,
         UnitTypePercentage,
         UnitTypeViewportWidth,
         UnitTypeViewportHeight,
         UnitTypeViewportMin,
         UnitTypeViewportMax,
-        UnitTypeTime,
-        UnitTypeAngle,
-        UnitTypeFrequency,
-        UnitTypeResolution,
         UnitTypeInvalid,
     };
 
-    virtual ~AnimatableNumber() { }
+    virtual ~AnimatableLength() { }
     static bool canCreateFrom(const CSSValue*);
-    static PassRefPtr<AnimatableNumber> create(CSSValue*);
-    static PassRefPtr<AnimatableNumber> create(double number, NumberUnitType unitType, CSSPrimitiveValue* cssPrimitiveValue = 0)
+    static PassRefPtr<AnimatableLength> create(CSSValue*);
+    static PassRefPtr<AnimatableLength> create(double number, NumberUnitType unitType, CSSPrimitiveValue* cssPrimitiveValue = 0)
     {
-        return adoptRef(new AnimatableNumber(number, unitType, cssPrimitiveValue));
+        return adoptRef(new AnimatableLength(number, unitType, cssPrimitiveValue));
     }
     PassRefPtr<CSSValue> toCSSValue(NumberRange = AllValues) const;
-    double toDouble() const;
     Length toLength(const RenderStyle* currStyle, const RenderStyle* rootStyle, double zoom, NumberRange = AllValues) const;
 
 protected:
     virtual PassRefPtr<AnimatableValue> interpolateTo(const AnimatableValue*, double fraction) const OVERRIDE;
     virtual PassRefPtr<AnimatableValue> addWith(const AnimatableValue*) const OVERRIDE;
 
 private:
-    AnimatableNumber(double number, NumberUnitType unitType, CSSPrimitiveValue* cssPrimitiveValue)
-        : m_number(number)
+    AnimatableLength(double number, NumberUnitType unitType, CSSPrimitiveValue* cssPrimitiveValue)
+        : m_isCalc(false)
+        , m_number(number)
         , m_unitType(unitType)
-        , m_isCalc(false)
         , m_cachedCSSPrimitiveValue(cssPrimitiveValue)
     {
-        ASSERT(m_unitType != UnitTypeInvalid);
     }
-    AnimatableNumber(PassRefPtr<CSSCalcExpressionNode> calcExpression, CSSPrimitiveValue* cssPrimitiveValue)
+    AnimatableLength(PassRefPtr<CSSCalcExpressionNode> calcExpression, CSSPrimitiveValue* cssPrimitiveValue)
         : m_isCalc(true)
         , m_calcExpression(calcExpression)
         , m_cachedCSSPrimitiveValue(cssPrimitiveValue)
     {
         ASSERT(m_calcExpression);
     }
-    virtual AnimatableType type() const OVERRIDE { return TypeNumber; }
+    virtual AnimatableType type() const OVERRIDE { return TypeLength; }
 
-    static PassRefPtr<AnimatableNumber> create(PassRefPtr<CSSCalcExpressionNode> calcExpression, CSSPrimitiveValue* cssPrimitiveValue = 0)
+    static PassRefPtr<AnimatableLength> create(PassRefPtr<CSSCalcExpressionNode> calcExpression, CSSPrimitiveValue* cssPrimitiveValue = 0)
     {
-        return adoptRef(new AnimatableNumber(calcExpression, cssPrimitiveValue));
+        return adoptRef(new AnimatableLength(calcExpression, cssPrimitiveValue));
     }
-    static PassRefPtr<AnimatableNumber> create(const AnimatableNumber* leftAddend, const AnimatableNumber* rightAddend);
+    static PassRefPtr<AnimatableLength> create(const AnimatableLength* leftAddend, const AnimatableLength* rightAddend);
 
     PassRefPtr<CSSPrimitiveValue> toCSSPrimitiveValue(NumberRange) const;
     PassRefPtr<CSSCalcExpressionNode> toCSSCalcExpressionNode() const;
 
-    PassRefPtr<AnimatableNumber> scale(double) const;
+    PassRefPtr<AnimatableLength> scale(double) const;
     double clampedNumber(NumberRange range) const
     {
         ASSERT(!m_isCalc);
         return (range == NonNegativeValues && m_number <= 0) ? 0 : m_number;
     }
     static NumberUnitType primitiveUnitToNumberType(unsigned short primitiveUnit);
     static unsigned short numberTypeToPrimitiveUnit(NumberUnitType numberType);
 
+    bool m_isCalc;
+
     double m_number;
     NumberUnitType m_unitType;
 
-    bool m_isCalc;
     RefPtr<CSSCalcExpressionNode> m_calcExpression;
 
     mutable RefPtr<CSSPrimitiveValue> m_cachedCSSPrimitiveValue;
 };
 
-inline const AnimatableNumber* toAnimatableNumber(const AnimatableValue* value)
+inline const AnimatableLength* toAnimatableLength(const AnimatableValue* value)
 {
-    ASSERT_WITH_SECURITY_IMPLICATION(value && value->isNumber());
-    return static_cast<const AnimatableNumber*>(value);
+    ASSERT_WITH_SECURITY_IMPLICATION(value && value->isLength());
+    return static_cast<const AnimatableLength*>(value);
 }
 
 } // namespace WebCore
 
-#endif // AnimatableNumber_h
+#endif // AnimatableLength_h