src/third_party/WebKit/Source/core/svg/SVGLength.h

   1 /*
   2  * Copyright (C) 2004, 2005, 2006, 2008 Nikolas Zimmermann <zimmermann@kde.org>
   3  * Copyright (C) 2004, 2005, 2006 Rob Buis <buis@kde.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Library General Public License
  16  * along with this library; see the file COPYING.LIB.  If not, write to
  17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18  * Boston, MA 02110-1301, USA.
  19  */
  20
  21 #ifndef SVGLength_h
  22 #define SVGLength_h
  23
  24 #include "bindings/v8/ExceptionMessages.h"
  25 #include "bindings/v8/ExceptionStatePlaceholder.h"
  26 #include "core/svg/SVGLengthContext.h"
  27 #include "core/svg/properties/NewSVGProperty.h"
  28 #include "heap/Handle.h"
  29
  30 namespace WebCore {
  31
  32 class CSSPrimitiveValue;
  33 class ExceptionState;
  34 class QualifiedName;
  35
  36 enum SVGLengthNegativeValuesMode {
  37     AllowNegativeLengths,
  38     ForbidNegativeLengths
  39 };
  40
  41 class SVGLengthTearOff;
  42
  43 class SVGLength FINAL : public NewSVGPropertyBase {
  44 public:
  45     typedef SVGLengthTearOff TearOffType;
  46
  47     static PassRefPtr<SVGLength> create(SVGLengthMode mode = LengthModeOther)
  48     {
  49         return adoptRef(new SVGLength(mode));
  50     }
  51
  52     PassRefPtr<SVGLength> clone() const;
  53     virtual PassRefPtr<NewSVGPropertyBase> cloneForAnimation(const String&) const OVERRIDE;
  54
  55     SVGLengthType unitType() const { return static_cast<SVGLengthType>(m_unitType); }
  56     void setUnitType(SVGLengthType);
  57     SVGLengthMode unitMode() const { return static_cast<SVGLengthMode>(m_unitMode); }
  58
  59     bool operator==(const SVGLength&) const;
  60     bool operator!=(const SVGLength& other) const { return !operator==(other); }
  61
  62     float value(const SVGLengthContext& context) const
  63     {
  64         return value(context, IGNORE_EXCEPTION);
  65     }
  66     float value(const SVGLengthContext&, ExceptionState&) const;
  67     void setValue(float, const SVGLengthContext&, ExceptionState&);
  68
  69     float valueInSpecifiedUnits() const { return m_valueInSpecifiedUnits; }
  70     void setValueInSpecifiedUnits(float value) { m_valueInSpecifiedUnits = value; }
  71
  72     float valueAsPercentage() const;
  73
  74     virtual String valueAsString() const OVERRIDE;
  75     void setValueAsString(const String&, ExceptionState&);
  76
  77     void newValueSpecifiedUnits(SVGLengthType, float valueInSpecifiedUnits);
  78     void convertToSpecifiedUnits(SVGLengthType, const SVGLengthContext&, ExceptionState&);
  79
  80     // Helper functions
  81     inline bool isRelative() const
  82     {
  83         return m_unitType == LengthTypePercentage
  84             || m_unitType == LengthTypeEMS
  85             || m_unitType == LengthTypeEXS;
  86     }
  87
  88     bool isZero() const
  89     {
  90         return !m_valueInSpecifiedUnits;
  91     }
  92
  93     static PassRefPtr<SVGLength> fromCSSPrimitiveValue(CSSPrimitiveValue*);
  94     static PassRefPtrWillBeRawPtr<CSSPrimitiveValue> toCSSPrimitiveValue(PassRefPtr<SVGLength>);
  95     static SVGLengthMode lengthModeForAnimatedLengthAttribute(const QualifiedName&);
  96
  97     PassRefPtr<SVGLength> blend(PassRefPtr<SVGLength> from, float progress) const;
  98
  99     virtual void add(PassRefPtr<NewSVGPropertyBase>, SVGElement*) OVERRIDE;
 100     virtual void calculateAnimatedValue(SVGAnimationElement*, float percentage, unsigned repeatCount, PassRefPtr<NewSVGPropertyBase> from, PassRefPtr<NewSVGPropertyBase> to, PassRefPtr<NewSVGPropertyBase> toAtEndOfDurationValue, SVGElement* contextElement) OVERRIDE;
 101     virtual float calculateDistance(PassRefPtr<NewSVGPropertyBase> to, SVGElement* contextElement) OVERRIDE;
 102
 103     static AnimatedPropertyType classType() { return AnimatedLength; }
 104
 105 private:
 106     SVGLength(SVGLengthMode);
 107     SVGLength(const SVGLength&);
 108
 109     float m_valueInSpecifiedUnits;
 110     unsigned m_unitMode : 2;
 111     unsigned m_unitType : 4;
 112 };
 113
 114 inline PassRefPtr<SVGLength> toSVGLength(PassRefPtr<NewSVGPropertyBase> passBase)
 115 {
 116     RefPtr<NewSVGPropertyBase> base = passBase;
 117     ASSERT(base->type() == SVGLength::classType());
 118     return static_pointer_cast<SVGLength>(base.release());
 119 }
 120
 121 } // namespace WebCore
 122
 123 #endif // SVGLength_h