Define the type of SVGPropertyOwnerRegistry for all SVG elements
[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-2019 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 // If we have 'currentColor' or 'inherit' as animation value, we need to grab
40 // the value during the animation since the value can be animated itself.
41 enum AnimatedPropertyValueType { RegularPropertyValue, CurrentColorValue, InheritValue };
42
43 class SVGAnimationElement : public SVGSMILElement, public SVGExternalResourcesRequired, public SVGTests {
44     WTF_MAKE_ISO_ALLOCATED(SVGAnimationElement);
45 public:
46     float getStartTime() const;
47     float getCurrentTime() const;
48     float getSimpleDuration() const;
49
50     void beginElement();
51     void beginElementAt(float offset);
52     void endElement();
53     void endElementAt(float offset);
54
55     static bool isTargetAttributeCSSProperty(SVGElement*, const QualifiedName&);
56
57     bool isAdditive() const override;
58     bool isAccumulated() const;
59     AnimationMode animationMode() const { return m_animationMode; }
60     CalcMode calcMode() const { return m_calcMode; }
61
62     enum ShouldApplyAnimation {
63         DontApplyAnimation,
64         ApplyCSSAnimation,
65         ApplyXMLAnimation,
66         ApplyXMLandCSSAnimation // For presentation attributes with SVG DOM properties.
67     };
68
69     ShouldApplyAnimation shouldApplyAnimation(SVGElement* targetElement, const QualifiedName& attributeName);
70
71     AnimatedPropertyValueType fromPropertyValueType() const { return m_fromPropertyValueType; }
72     AnimatedPropertyValueType toPropertyValueType() const { return m_toPropertyValueType; }
73
74     template<typename AnimatedType> void adjustForInheritance(AnimatedType (*parseTypeFromString)(SVGAnimationElement*, const String&), AnimatedPropertyValueType valueType, AnimatedType& animatedType, SVGElement* contextElement)
75     {
76         if (valueType != InheritValue)
77             return;
78         // Replace 'inherit' by its computed property value.
79         ASSERT(parseTypeFromString);
80         String typeString;
81         adjustForInheritance(contextElement, attributeName(), typeString);
82         animatedType = (*parseTypeFromString)(this, typeString);
83     }
84
85     template<typename AnimatedType> bool adjustFromToListValues(const AnimatedType& fromList, const AnimatedType& toList, AnimatedType& animatedList, float percentage, bool resizeAnimatedListIfNeeded = true)
86     {
87         // If no 'to' value is given, nothing to animate.
88         unsigned toListSize = toList.size();
89         if (!toListSize)
90             return false;
91
92         // If the 'from' value is given and it's length doesn't match the 'to' value list length, fallback to a discrete animation.
93         unsigned fromListSize = fromList.size();
94         if (fromListSize != toListSize && fromListSize) {
95             if (percentage < 0.5) {
96                 if (animationMode() != AnimationMode::To)
97                     animatedList = AnimatedType(fromList);
98             } else
99                 animatedList = AnimatedType(toList);
100
101             return false;
102         }
103
104         ASSERT(!fromListSize || fromListSize == toListSize);
105         if (resizeAnimatedListIfNeeded && animatedList.size() < toListSize)
106             animatedList.resize(toListSize);
107
108         return true;
109     }
110
111     template<typename AnimatedType> void animateDiscreteType(float percentage, const AnimatedType& fromType, const AnimatedType& toType, AnimatedType& animatedType)
112     {
113         if ((animationMode() == AnimationMode::FromTo && percentage > 0.5) || animationMode() == AnimationMode::To || percentage == 1) {
114             animatedType = AnimatedType(toType);
115             return;
116         }
117         animatedType = AnimatedType(fromType);
118     }
119
120     void animateAdditiveNumber(float percentage, unsigned repeatCount, float fromNumber, float toNumber, float toAtEndOfDurationNumber, float& animatedNumber)
121     {
122         float number;
123         if (calcMode() == CalcMode::Discrete)
124             number = percentage < 0.5 ? fromNumber : toNumber;
125         else
126             number = (toNumber - fromNumber) * percentage + fromNumber;
127
128         if (isAccumulated() && repeatCount)
129             number += toAtEndOfDurationNumber * repeatCount;
130
131         if (isAdditive() && animationMode() != AnimationMode::To)
132             animatedNumber += number;
133         else
134             animatedNumber = number;
135     }
136
137     enum class AttributeType : uint8_t { CSS, XML, Auto };
138     AttributeType attributeType() const { return m_attributeType; }
139
140     void computeCSSPropertyValue(SVGElement*, CSSPropertyID, String& value);
141     virtual void determinePropertyValueTypes(const String& from, const String& to);
142
143 protected:
144     SVGAnimationElement(const QualifiedName&, Document&);
145
146     using AttributeOwnerProxy = SVGAttributeOwnerProxyImpl<SVGAnimationElement, SVGElement, SVGExternalResourcesRequired, SVGTests>;
147     static AttributeOwnerProxy::AttributeRegistry& attributeRegistry() { return AttributeOwnerProxy::attributeRegistry(); }
148     const SVGAttributeOwnerProxy& attributeOwnerProxy() const override { return m_attributeOwnerProxy; }
149
150     using PropertyRegistry = SVGPropertyOwnerRegistry<SVGAnimationElement, SVGElement, SVGExternalResourcesRequired, SVGTests>;
151     const SVGPropertyRegistry& propertyRegistry() const override { return m_propertyRegistry; }
152
153     virtual void resetAnimation();
154
155     static bool isSupportedAttribute(const QualifiedName&);
156     void parseAttribute(const QualifiedName&, const AtomicString&) override;
157     void svgAttributeChanged(const QualifiedName&) override;
158
159     String toValue() const;
160     String byValue() const;
161     String fromValue() const;
162
163     String targetAttributeBaseValue();
164
165     // from SVGSMILElement
166     void startedActiveInterval() override;
167     void updateAnimation(float percent, unsigned repeat, SVGSMILElement* resultElement) override;
168
169     AnimatedPropertyValueType m_fromPropertyValueType { RegularPropertyValue };
170     AnimatedPropertyValueType m_toPropertyValueType { RegularPropertyValue };
171
172     void setAttributeName(const QualifiedName&) override { }
173
174     virtual void updateAnimationMode();
175     void setAnimationMode(AnimationMode animationMode) { m_animationMode = animationMode; }
176     void setCalcMode(CalcMode calcMode) { m_calcMode = calcMode; }
177
178 private:
179     void animationAttributeChanged() override;
180     void setAttributeType(const AtomicString&);
181
182     virtual bool calculateToAtEndOfDurationValue(const String& toAtEndOfDurationString) = 0;
183     virtual bool calculateFromAndToValues(const String& fromString, const String& toString) = 0;
184     virtual bool calculateFromAndByValues(const String& fromString, const String& byString) = 0;
185     virtual void calculateAnimatedValue(float percent, unsigned repeatCount, SVGSMILElement* resultElement) = 0;
186     virtual float calculateDistance(const String& /*fromString*/, const String& /*toString*/) { return -1.f; }
187
188     void currentValuesForValuesAnimation(float percent, float& effectivePercent, String& from, String& to);
189     void calculateKeyTimesForCalcModePaced();
190     float calculatePercentFromKeyPoints(float percent) const;
191     void currentValuesFromKeyPoints(float percent, float& effectivePercent, String& from, String& to) const;
192     float calculatePercentForSpline(float percent, unsigned splineIndex) const;
193     float calculatePercentForFromTo(float percent) const;
194     unsigned calculateKeyTimesIndex(float percent) const;
195
196     void applyAnimatedValue(ShouldApplyAnimation, SVGElement* targetElement, const QualifiedName& attributeName, SVGAnimatedType*);
197     void adjustForInheritance(SVGElement* targetElement, const QualifiedName& attributeName, String&);
198
199     void setCalcMode(const AtomicString&);
200
201     bool m_animationValid { false };
202
203     AttributeType m_attributeType { AttributeType::Auto };
204     Vector<String> m_values;
205     Vector<float> m_keyTimes;
206     Vector<float> m_keyPoints;
207     Vector<UnitBezier> m_keySplines;
208     String m_lastValuesAnimationFrom;
209     String m_lastValuesAnimationTo;
210     CalcMode m_calcMode { CalcMode::Linear };
211     AnimationMode m_animationMode { AnimationMode::None };
212     AttributeOwnerProxy m_attributeOwnerProxy { *this };
213     PropertyRegistry m_propertyRegistry { *this };
214 };
215
216 } // namespace WebCore