Make some things that return never-null pointers return references instead.
[WebKit-https.git] / Source / WebCore / page / animation / AnimationControllerPrivate.h
1 /*
2  * Copyright (C) 2009 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef AnimationControllerPrivate_h
30 #define AnimationControllerPrivate_h
31
32 #include "CSSPropertyNames.h"
33 #include "Timer.h"
34 #include <wtf/HashMap.h>
35 #include <wtf/HashSet.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/Vector.h>
39 #include <wtf/text/AtomicString.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace WebCore {
43
44 class AnimationBase;
45 class CompositeAnimation;
46 class Document;
47 class Element;
48 class Frame;
49 class Node;
50 class RenderObject;
51 class RenderStyle;
52
53 enum SetChanged {
54     DoNotCallSetChanged = 0,
55     CallSetChanged = 1
56 };
57
58 class AnimationControllerPrivate {
59     WTF_MAKE_NONCOPYABLE(AnimationControllerPrivate); WTF_MAKE_FAST_ALLOCATED;
60 public:
61     AnimationControllerPrivate(Frame*);
62     ~AnimationControllerPrivate();
63
64     // Returns the time until the next animation needs to be serviced, or -1 if there are none.
65     double updateAnimations(SetChanged callSetChanged = DoNotCallSetChanged);
66     void updateAnimationTimer(SetChanged callSetChanged = DoNotCallSetChanged);
67
68     CompositeAnimation& ensureCompositeAnimation(RenderObject*);
69     bool clear(RenderObject*);
70
71     void updateStyleIfNeededDispatcherFired(Timer<AnimationControllerPrivate>*);
72     void startUpdateStyleIfNeededDispatcher();
73     void addEventToDispatch(PassRefPtr<Element> element, const AtomicString& eventType, const String& name, double elapsedTime);
74     void addNodeChangeToDispatch(PassRefPtr<Node>);
75
76     bool hasAnimations() const { return !m_compositeAnimations.isEmpty(); }
77
78     bool isSuspended() const { return m_isSuspended; }
79     void suspendAnimations();
80     void resumeAnimations();
81 #if ENABLE(REQUEST_ANIMATION_FRAME)
82     void animationFrameCallbackFired();
83 #endif
84
85     void suspendAnimationsForDocument(Document*);
86     void resumeAnimationsForDocument(Document*);
87     void startAnimationsIfNotSuspended(Document*);
88
89     bool isRunningAnimationOnRenderer(RenderObject*, CSSPropertyID, bool isRunningNow) const;
90     bool isRunningAcceleratedAnimationOnRenderer(RenderObject*, CSSPropertyID, bool isRunningNow) const;
91
92     bool pauseAnimationAtTime(RenderObject*, const AtomicString& name, double t);
93     bool pauseTransitionAtTime(RenderObject*, const String& property, double t);
94     unsigned numberOfActiveAnimations(Document*) const;
95
96     PassRefPtr<RenderStyle> getAnimatedStyleForRenderer(RenderObject* renderer);
97
98     double beginAnimationUpdateTime();
99     void setBeginAnimationUpdateTime(double t) { m_beginAnimationUpdateTime = t; }
100     void endAnimationUpdate();
101     void receivedStartTimeResponse(double);
102     
103     void addToAnimationsWaitingForStyle(AnimationBase*);
104     void removeFromAnimationsWaitingForStyle(AnimationBase*);
105
106     void addToAnimationsWaitingForStartTimeResponse(AnimationBase*, bool willGetResponse);
107     void removeFromAnimationsWaitingForStartTimeResponse(AnimationBase*);
108
109     void animationWillBeRemoved(AnimationBase*);
110
111     void updateAnimationTimerForRenderer(RenderObject*);
112
113     bool allowsNewAnimationsWhileSuspended() const { return m_allowsNewAnimationsWhileSuspended; }
114     void setAllowsNewAnimationsWhileSuspended(bool);
115
116 private:
117     void animationTimerFired(Timer<AnimationControllerPrivate>*);
118
119     void styleAvailable();
120     void fireEventsAndUpdateStyle();
121     void startTimeResponse(double t);
122
123     typedef HashMap<RenderObject*, RefPtr<CompositeAnimation> > RenderObjectAnimationMap;
124
125     RenderObjectAnimationMap m_compositeAnimations;
126     Timer<AnimationControllerPrivate> m_animationTimer;
127     Timer<AnimationControllerPrivate> m_updateStyleIfNeededDispatcher;
128     Frame* m_frame;
129     
130     class EventToDispatch {
131     public:
132         RefPtr<Element> element;
133         AtomicString eventType;
134         String name;
135         double elapsedTime;
136     };
137     
138     Vector<EventToDispatch> m_eventsToDispatch;
139     Vector<RefPtr<Node> > m_nodeChangesToDispatch;
140     
141     double m_beginAnimationUpdateTime;
142
143     typedef HashSet<RefPtr<AnimationBase> > WaitingAnimationsSet;
144     WaitingAnimationsSet m_animationsWaitingForStyle;
145     WaitingAnimationsSet m_animationsWaitingForStartTimeResponse;
146     bool m_waitingForAsyncStartNotification;
147     bool m_isSuspended;
148
149     // Used to flag whether we should revert to previous buggy
150     // behavior of allowing new transitions and animations to
151     // run even when this object is suspended.
152     bool m_allowsNewAnimationsWhileSuspended;
153 };
154
155 } // namespace WebCore
156
157 #endif // AnimationControllerPrivate_h