Node: removedFrom() and insertedInto() should use references.
[WebKit-https.git] / Source / WebCore / svg / animation / SVGSMILElement.h
1 /*
2  * Copyright (C) 2008 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef SVGSMILElement_h
27 #define SVGSMILElement_h
28 #if ENABLE(SVG)
29 #include "SMILTime.h"
30 #include "SVGElement.h"
31
32 #include <wtf/HashMap.h>
33
34 namespace WebCore {
35
36 class ConditionEventListener;
37 class SMILTimeContainer;
38
39 // This class implements SMIL interval timing model as needed for SVG animation.
40 class SVGSMILElement : public SVGElement {
41 public:
42     SVGSMILElement(const QualifiedName&, Document&);
43     virtual ~SVGSMILElement();
44
45     static bool isSMILElement(const Node*);
46
47     bool isSupportedAttribute(const QualifiedName&);
48     virtual void parseAttribute(const QualifiedName&, const AtomicString&) OVERRIDE;
49     virtual void svgAttributeChanged(const QualifiedName&) OVERRIDE;
50     virtual InsertionNotificationRequest insertedInto(ContainerNode&) OVERRIDE;
51     virtual void removedFrom(ContainerNode&) OVERRIDE;
52     
53     virtual bool hasValidAttributeType() = 0;
54     virtual bool hasValidAttributeName();
55     virtual void animationAttributeChanged() = 0;
56
57     SMILTimeContainer* timeContainer() const { return m_timeContainer.get(); }
58
59     SVGElement* targetElement() const { return m_targetElement; }
60     const QualifiedName& attributeName() const { return m_attributeName; }
61
62     void beginByLinkActivation();
63
64     enum Restart {
65         RestartAlways,
66         RestartWhenNotActive,
67         RestartNever
68     };
69
70     Restart restart() const;
71
72     enum FillMode {
73         FillRemove,
74         FillFreeze
75     };
76
77     FillMode fill() const;
78
79     SMILTime dur() const;
80     SMILTime repeatDur() const;
81     SMILTime repeatCount() const;
82     SMILTime maxValue() const;
83     SMILTime minValue() const;
84
85     SMILTime elapsed() const; 
86
87     SMILTime intervalBegin() const { return m_intervalBegin; }
88     SMILTime intervalEnd() const { return m_intervalEnd; }
89     SMILTime previousIntervalBegin() const { return m_previousIntervalBegin; }
90     SMILTime simpleDuration() const;
91
92     void seekToIntervalCorrespondingToTime(SMILTime elapsed);
93     bool progress(SMILTime elapsed, SVGSMILElement* resultsElement, bool seekToTime);
94     SMILTime nextProgressTime() const;
95
96     void reset();
97
98     static SMILTime parseClockValue(const String&);
99     static SMILTime parseOffsetValue(const String&);
100
101     bool isContributing(SMILTime elapsed) const;
102     bool isInactive() const;
103     bool isFrozen() const;
104
105     unsigned documentOrderIndex() const { return m_documentOrderIndex; }
106     void setDocumentOrderIndex(unsigned index) { m_documentOrderIndex = index; }
107
108     virtual bool isAdditive() const = 0;
109     virtual void resetAnimatedType() = 0;
110     virtual void clearAnimatedType(SVGElement* targetElement) = 0;
111     virtual void applyResultsToTarget() = 0;
112
113 protected:
114     void addBeginTime(SMILTime eventTime, SMILTime endTime, SMILTimeWithOrigin::Origin = SMILTimeWithOrigin::ParserOrigin);
115     void addEndTime(SMILTime eventTime, SMILTime endTime, SMILTimeWithOrigin::Origin = SMILTimeWithOrigin::ParserOrigin);
116
117     void setInactive() { m_activeState = Inactive; }
118
119     virtual bool rendererIsNeeded(const RenderStyle&) OVERRIDE { return false; }
120
121     // Sub-classes may need to take action when the target is changed.
122     virtual void setTargetElement(SVGElement*);
123     virtual void setAttributeName(const QualifiedName&);
124
125 private:
126     void buildPendingResource();
127     void clearResourceReferences();
128
129     virtual void startedActiveInterval() = 0;
130     void endedActiveInterval();
131     virtual void updateAnimation(float percent, unsigned repeat, SVGSMILElement* resultElement) = 0;
132
133     enum BeginOrEnd {
134         Begin,
135         End
136     };
137     
138     SMILTime findInstanceTime(BeginOrEnd, SMILTime minimumTime, bool equalsMinimumOK) const;
139     void resolveFirstInterval();
140     void resolveNextInterval(bool notifyDependents);
141     void resolveInterval(bool first, SMILTime& beginResult, SMILTime& endResult) const;
142     SMILTime resolveActiveEnd(SMILTime resolvedBegin, SMILTime resolvedEnd) const;
143     SMILTime repeatingDuration() const;
144     void checkRestart(SMILTime elapsed);
145     void beginListChanged(SMILTime eventTime);
146     void endListChanged(SMILTime eventTime);
147
148     // This represents conditions on elements begin or end list that need to be resolved on runtime
149     // for example <animate begin="otherElement.begin + 8s; button.click" ... />
150     struct Condition {
151         enum Type {
152             EventBase,
153             Syncbase,
154             AccessKey
155         };
156
157         Condition(Type, BeginOrEnd, const String& baseID, const String& name, SMILTime offset, int repeats = -1);
158         Type m_type;
159         BeginOrEnd m_beginOrEnd;
160         String m_baseID;
161         String m_name;
162         SMILTime m_offset;
163         int m_repeats;
164         RefPtr<Element> m_syncbase;
165         RefPtr<ConditionEventListener> m_eventListener;
166     };
167     bool parseCondition(const String&, BeginOrEnd beginOrEnd);
168     void parseBeginOrEnd(const String&, BeginOrEnd beginOrEnd);
169     Element* eventBaseFor(const Condition&);
170
171     void connectConditions();
172     void disconnectConditions();
173
174     // Event base timing
175     void handleConditionEvent(Event*, Condition*);
176
177     // Syncbase timing
178     enum NewOrExistingInterval {
179         NewInterval,
180         ExistingInterval
181     };
182
183     void notifyDependentsIntervalChanged(NewOrExistingInterval);
184     void createInstanceTimesFromSyncbase(SVGSMILElement* syncbase, NewOrExistingInterval);
185     void addTimeDependent(SVGSMILElement*);
186     void removeTimeDependent(SVGSMILElement*);
187
188     enum ActiveState {
189         Inactive,
190         Active,
191         Frozen
192     };
193
194     QualifiedName m_attributeName;
195
196     ActiveState determineActiveState(SMILTime elapsed) const;
197     float calculateAnimationPercentAndRepeat(SMILTime elapsed, unsigned& repeat) const;
198     SMILTime calculateNextProgressTime(SMILTime elapsed) const;
199
200     mutable SVGElement* m_targetElement;
201
202     Vector<Condition> m_conditions;
203     bool m_conditionsConnected;
204     bool m_hasEndEventConditions;     
205
206     bool m_isWaitingForFirstInterval;
207
208     typedef HashSet<SVGSMILElement*> TimeDependentSet;
209     TimeDependentSet m_timeDependents;
210
211     // Instance time lists
212     Vector<SMILTimeWithOrigin> m_beginTimes;
213     Vector<SMILTimeWithOrigin> m_endTimes;
214
215     // This is the upcoming or current interval
216     SMILTime m_intervalBegin;
217     SMILTime m_intervalEnd;
218
219     SMILTime m_previousIntervalBegin;
220
221     ActiveState m_activeState;
222     float m_lastPercent;
223     unsigned m_lastRepeat;
224
225     SMILTime m_nextProgressTime;
226
227     RefPtr<SMILTimeContainer> m_timeContainer;
228     unsigned m_documentOrderIndex;
229
230     mutable SMILTime m_cachedDur;
231     mutable SMILTime m_cachedRepeatDur;
232     mutable SMILTime m_cachedRepeatCount;
233     mutable SMILTime m_cachedMin;
234     mutable SMILTime m_cachedMax;
235
236     friend class ConditionEventListener;
237 };
238
239 inline SVGSMILElement* toSVGSMILElement(Element* element)
240 {
241     ASSERT_WITH_SECURITY_IMPLICATION(!element || SVGSMILElement::isSMILElement(element));
242     return static_cast<SVGSMILElement*>(element);
243 }
244
245 template <> inline bool isElementOfType<SVGSMILElement>(const Element* element) { return SVGSMILElement::isSMILElement(element); }
246
247 }
248
249 #endif // ENABLE(SVG)
250 #endif // SVGSMILElement_h