src/third_party/WebKit/Source/core/svg/properties/SVGProperty.h

   1 /*
   2  * Copyright (C) 2013 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef SVGProperty_h
  32 #define SVGProperty_h
  33
  34 #include "core/svg/properties/SVGPropertyInfo.h"
  35 #include "platform/heap/Handle.h"
  36 #include "wtf/Noncopyable.h"
  37 #include "wtf/PassRefPtr.h"
  38 #include "wtf/RefCounted.h"
  39 #include "wtf/text/WTFString.h"
  40
  41 namespace blink {
  42
  43 class SVGElement;
  44 class SVGAnimationElement;
  45
  46 class SVGPropertyBase : public RefCountedWillBeRefCountedGarbageCollected<SVGPropertyBase> {
  47     WTF_MAKE_NONCOPYABLE(SVGPropertyBase);
  48
  49 public:
  50     // Properties do not have a primitive type by default
  51     typedef void PrimitiveType;
  52
  53     virtual ~SVGPropertyBase()
  54     {
  55         ASSERT(!m_ownerList);
  56     }
  57
  58     // FIXME: remove this in WebAnimations transition.
  59     // This is used from SVGAnimatedNewPropertyAnimator for its animate-by-string implementation.
  60     virtual PassRefPtr<SVGPropertyBase> cloneForAnimation(const String&) const = 0;
  61
  62     virtual String valueAsString() const = 0;
  63
  64     // FIXME: remove below and just have this inherit AnimatableValue in WebAnimations transition.
  65     virtual void add(PassRefPtrWillBeRawPtr<SVGPropertyBase>, SVGElement*) = 0;
  66     virtual void calculateAnimatedValue(SVGAnimationElement*, float percentage, unsigned repeatCount, PassRefPtr<SVGPropertyBase> from, PassRefPtr<SVGPropertyBase> to, PassRefPtr<SVGPropertyBase> toAtEndOfDurationValue, SVGElement*) = 0;
  67     virtual float calculateDistance(PassRefPtr<SVGPropertyBase> to, SVGElement*) = 0;
  68
  69     AnimatedPropertyType type()
  70     {
  71         return m_type;
  72     }
  73
  74     SVGPropertyBase* ownerList() const
  75     {
  76         return m_ownerList;
  77     }
  78
  79     void setOwnerList(SVGPropertyBase* ownerList)
  80     {
  81         // Previous owner list must be cleared before setting new owner list.
  82         ASSERT((!ownerList && m_ownerList) || (ownerList && !m_ownerList));
  83
  84         m_ownerList = ownerList;
  85     }
  86
  87     virtual void trace(Visitor* visitor)
  88     {
  89         visitor->trace(m_ownerList);
  90     }
  91
  92 protected:
  93     explicit SVGPropertyBase(AnimatedPropertyType type)
  94         : m_type(type)
  95         , m_ownerList(nullptr)
  96     {
  97     }
  98
  99 private:
 100     const AnimatedPropertyType m_type;
 101
 102     RawPtrWillBeMember<SVGPropertyBase> m_ownerList;
 103 };
 104
 105 }
 106
 107 #endif // SVGProperty_h