Remove the SVG elements' attributes macros
[WebKit-https.git] / Source / WebCore / svg / SVGAnimationElement.h
1 /*
2  * Copyright (C) 2004, 2005 Nikolas Zimmermann <zimmermann@kde.org>
3  * Copyright (C) 2004, 2005, 2006 Rob Buis <buis@kde.org>
4  * Copyright (C) 2007 Eric Seidel <eric@webkit.org>
5  * Copyright (C) 2008 Apple Inc. All rights reserved.
6  * Copyright (C) 2008 Cameron McCormack <cam@mcc.id.au>
7  * Copyright (C) Research In Motion Limited 2011. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  */
24
25 #pragma once
26
27 #include "SVGAnimatedBoolean.h"
28 #include "SVGExternalResourcesRequired.h"
29 #include "SVGSMILElement.h"
30 #include "SVGTests.h"
31 #include "UnitBezier.h"
32
33 namespace WebCore {
34
35 class ConditionEventListener;
36 class SVGAnimatedType;
37 class TimeContainer;
38
39 enum AnimationMode {
40     NoAnimation,
41     FromToAnimation,
42     FromByAnimation,
43     ToAnimation,
44     ByAnimation,
45     ValuesAnimation,
46     PathAnimation // Used by AnimateMotion.
47 };
48
49 // If we have 'currentColor' or 'inherit' as animation value, we need to grab
50 // the value during the animation since the value can be animated itself.
51 enum AnimatedPropertyValueType { RegularPropertyValue, CurrentColorValue, InheritValue };
52
53 enum class CalcMode { Discrete, Linear, Paced, Spline };
54
55 class SVGAnimationElement : public SVGSMILElement, public SVGExternalResourcesRequired, public SVGTests {
56     WTF_MAKE_ISO_ALLOCATED(SVGAnimationElement);
57 public:
58     float getStartTime() const;
59     float getCurrentTime() const;
60     float getSimpleDuration() const;
61
62     void beginElement();
63     void beginElementAt(float offset);
64     void endElement();
65     void endElementAt(float offset);
66
67     static bool isTargetAttributeCSSProperty(SVGElement*, const QualifiedName&);
68
69     bool isAdditive() const override;
70     bool isAccumulated() const;
71     AnimationMode animationMode() const { return m_animationMode; }
72     CalcMode calcMode() const { return m_calcMode; }
73
74     enum ShouldApplyAnimation {
75         DontApplyAnimation,
76         ApplyCSSAnimation,
77         ApplyXMLAnimation,
78         ApplyXMLandCSSAnimation // For presentation attributes with SVG DOM properties.
79     };
80
81     ShouldApplyAnimation shouldApplyAnimation(SVGElement* targetElement, const QualifiedName& attributeName);
82
83     AnimatedPropertyValueType fromPropertyValueType() const { return m_fromPropertyValueType; }
84     AnimatedPropertyValueType toPropertyValueType() const { return m_toPropertyValueType; }
85
86     template<typename AnimatedType> void adjustForInheritance(AnimatedType (*parseTypeFromString)(SVGAnimationElement*, const String&), AnimatedPropertyValueType valueType, AnimatedType& animatedType, SVGElement* contextElement)
87     {
88         if (valueType != InheritValue)
89             return;
90         // Replace 'inherit' by its computed property value.
91         ASSERT(parseTypeFromString);
92         String typeString;
93         adjustForInheritance(contextElement, attributeName(), typeString);
94         animatedType = (*parseTypeFromString)(this, typeString);
95     }
96
97     template<typename AnimatedType> bool adjustFromToListValues(const AnimatedType& fromList, const AnimatedType& toList, AnimatedType& animatedList, float percentage, bool resizeAnimatedListIfNeeded = true)
98     {
99         // If no 'to' value is given, nothing to animate.
100         unsigned toListSize = toList.size();
101         if (!toListSize)
102             return false;
103
104         // If the 'from' value is given and it's length doesn't match the 'to' value list length, fallback to a discrete animation.
105         unsigned fromListSize = fromList.size();
106         if (fromListSize != toListSize && fromListSize) {
107             if (percentage < 0.5) {
108                 if (animationMode() != ToAnimation)
109                     animatedList = AnimatedType(fromList);
110             } else
111                 animatedList = AnimatedType(toList);
112
113             return false;
114         }
115
116         ASSERT(!fromListSize || fromListSize == toListSize);
117         if (resizeAnimatedListIfNeeded && animatedList.size() < toListSize)
118             animatedList.resize(toListSize);
119
120         return true;
121     }
122
123     template<typename AnimatedType> void animateDiscreteType(float percentage, const AnimatedType& fromType, const AnimatedType& toType, AnimatedType& animatedType)
124     {
125         if ((animationMode() == FromToAnimation && percentage > 0.5) || animationMode() == ToAnimation || percentage == 1) {
126             animatedType = AnimatedType(toType);
127             return;
128         }
129         animatedType = AnimatedType(fromType);
130     }
131
132     void animateAdditiveNumber(float percentage, unsigned repeatCount, float fromNumber, float toNumber, float toAtEndOfDurationNumber, float& animatedNumber)
133     {
134         float number;
135         if (calcMode() == CalcMode::Discrete)
136             number = percentage < 0.5 ? fromNumber : toNumber;
137         else
138             number = (toNumber - fromNumber) * percentage + fromNumber;
139
140         if (isAccumulated() && repeatCount)
141             number += toAtEndOfDurationNumber * repeatCount;
142
143         if (isAdditive() && animationMode() != ToAnimation)
144             animatedNumber += number;
145         else
146             animatedNumber = number;
147     }
148
149 protected:
150     SVGAnimationElement(const QualifiedName&, Document&);
151
152     using AttributeOwnerProxy = SVGAttributeOwnerProxyImpl<SVGAnimationElement, SVGElement, SVGExternalResourcesRequired, SVGTests>;
153     static AttributeOwnerProxy::AttributeRegistry& attributeRegistry() { return AttributeOwnerProxy::attributeRegistry(); }
154     const SVGAttributeOwnerProxy& attributeOwnerProxy() const override { return m_attributeOwnerProxy; }
155
156     void computeCSSPropertyValue(SVGElement*, CSSPropertyID, String& value);
157     virtual void determinePropertyValueTypes(const String& from, const String& to);
158     virtual void resetAnimatedPropertyType();
159
160     static bool isSupportedAttribute(const QualifiedName&);
161     void parseAttribute(const QualifiedName&, const AtomicString&) override;
162     void svgAttributeChanged(const QualifiedName&) override;
163
164     enum class AttributeType { CSS, XML, Auto };
165     AttributeType attributeType() const { return m_attributeType; }
166
167     String toValue() const;
168     String byValue() const;
169     String fromValue() const;
170
171     String targetAttributeBaseValue();
172
173     // from SVGSMILElement
174     void startedActiveInterval() override;
175     void updateAnimation(float percent, unsigned repeat, SVGSMILElement* resultElement) override;
176
177     AnimatedPropertyValueType m_fromPropertyValueType { RegularPropertyValue };
178     AnimatedPropertyValueType m_toPropertyValueType { RegularPropertyValue };
179
180     void setTargetElement(SVGElement*) override;
181     void setAttributeName(const QualifiedName&) override { }
182     bool hasInvalidCSSAttributeType() const { return m_hasInvalidCSSAttributeType; }
183     void checkInvalidCSSAttributeType(SVGElement*);
184
185     virtual void updateAnimationMode();
186     void setAnimationMode(AnimationMode animationMode) { m_animationMode = animationMode; }
187     void setCalcMode(CalcMode calcMode) { m_calcMode = calcMode; }
188
189 private:
190     void animationAttributeChanged() override;
191     void setAttributeType(const AtomicString&);
192
193     virtual bool calculateToAtEndOfDurationValue(const String& toAtEndOfDurationString) = 0;
194     virtual bool calculateFromAndToValues(const String& fromString, const String& toString) = 0;
195     virtual bool calculateFromAndByValues(const String& fromString, const String& byString) = 0;
196     virtual void calculateAnimatedValue(float percent, unsigned repeatCount, SVGSMILElement* resultElement) = 0;
197     virtual float calculateDistance(const String& /*fromString*/, const String& /*toString*/) { return -1.f; }
198
199     void currentValuesForValuesAnimation(float percent, float& effectivePercent, String& from, String& to);
200     void calculateKeyTimesForCalcModePaced();
201     float calculatePercentFromKeyPoints(float percent) const;
202     void currentValuesFromKeyPoints(float percent, float& effectivePercent, String& from, String& to) const;
203     float calculatePercentForSpline(float percent, unsigned splineIndex) const;
204     float calculatePercentForFromTo(float percent) const;
205     unsigned calculateKeyTimesIndex(float percent) const;
206
207     void applyAnimatedValue(ShouldApplyAnimation, SVGElement* targetElement, const QualifiedName& attributeName, SVGAnimatedType*);
208     void adjustForInheritance(SVGElement* targetElement, const QualifiedName& attributeName, String&);
209
210     void setCalcMode(const AtomicString&);
211
212     bool m_animationValid { false };
213
214     AttributeType m_attributeType { AttributeType::Auto };
215     Vector<String> m_values;
216     Vector<float> m_keyTimes;
217     Vector<float> m_keyPoints;
218     Vector<UnitBezier> m_keySplines;
219     String m_lastValuesAnimationFrom;
220     String m_lastValuesAnimationTo;
221     bool m_hasInvalidCSSAttributeType { false };
222     CalcMode m_calcMode { CalcMode::Linear };
223     AnimationMode m_animationMode { NoAnimation };
224     AttributeOwnerProxy m_attributeOwnerProxy { *this };
225 };
226
227 } // namespace WebCore