CTTE Timer and DeferrableOneShotTimer
[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 RenderElement;
50 class RenderStyle;
51
52 enum SetChanged {
53     DoNotCallSetChanged = 0,
54     CallSetChanged = 1
55 };
56
57 class AnimationControllerPrivate {
58     WTF_MAKE_NONCOPYABLE(AnimationControllerPrivate); WTF_MAKE_FAST_ALLOCATED;
59 public:
60     explicit AnimationControllerPrivate(Frame&);
61     ~AnimationControllerPrivate();
62
63     // Returns the time until the next animation needs to be serviced, or -1 if there are none.
64     double updateAnimations(SetChanged callSetChanged = DoNotCallSetChanged);
65     void updateAnimationTimer(SetChanged callSetChanged = DoNotCallSetChanged);
66
67     CompositeAnimation& ensureCompositeAnimation(RenderElement*);
68     bool clear(RenderElement*);
69
70     void updateStyleIfNeededDispatcherFired(Timer<AnimationControllerPrivate>&);
71     void startUpdateStyleIfNeededDispatcher();
72     void addEventToDispatch(PassRefPtr<Element> element, const AtomicString& eventType, const String& name, double elapsedTime);
73     void addElementChangeToDispatch(PassRef<Element>);
74
75     bool hasAnimations() const { return !m_compositeAnimations.isEmpty(); }
76
77     bool isSuspended() const { return m_isSuspended; }
78     void suspendAnimations();
79     void resumeAnimations();
80 #if ENABLE(REQUEST_ANIMATION_FRAME)
81     void animationFrameCallbackFired();
82 #endif
83
84     void suspendAnimationsForDocument(Document*);
85     void resumeAnimationsForDocument(Document*);
86     void startAnimationsIfNotSuspended(Document*);
87
88     bool isRunningAnimationOnRenderer(RenderElement*, CSSPropertyID, bool isRunningNow) const;
89     bool isRunningAcceleratedAnimationOnRenderer(RenderElement*, CSSPropertyID, bool isRunningNow) const;
90
91     bool pauseAnimationAtTime(RenderElement*, const AtomicString& name, double t);
92     bool pauseTransitionAtTime(RenderElement*, const String& property, double t);
93     unsigned numberOfActiveAnimations(Document*) const;
94
95     PassRefPtr<RenderStyle> getAnimatedStyleForRenderer(RenderElement* renderer);
96
97     double beginAnimationUpdateTime();
98     void setBeginAnimationUpdateTime(double t) { m_beginAnimationUpdateTime = t; }
99     void endAnimationUpdate();
100     void receivedStartTimeResponse(double);
101     
102     void addToAnimationsWaitingForStyle(AnimationBase*);
103     void removeFromAnimationsWaitingForStyle(AnimationBase*);
104
105     void addToAnimationsWaitingForStartTimeResponse(AnimationBase*, bool willGetResponse);
106     void removeFromAnimationsWaitingForStartTimeResponse(AnimationBase*);
107
108     void animationWillBeRemoved(AnimationBase*);
109
110     void updateAnimationTimerForRenderer(RenderElement*);
111
112     bool allowsNewAnimationsWhileSuspended() const { return m_allowsNewAnimationsWhileSuspended; }
113     void setAllowsNewAnimationsWhileSuspended(bool);
114
115 private:
116     void animationTimerFired(Timer<AnimationControllerPrivate>&);
117
118     void styleAvailable();
119     void fireEventsAndUpdateStyle();
120     void startTimeResponse(double t);
121
122     HashMap<RenderElement*, RefPtr<CompositeAnimation>> m_compositeAnimations;
123     Timer<AnimationControllerPrivate> m_animationTimer;
124     Timer<AnimationControllerPrivate> m_updateStyleIfNeededDispatcher;
125     Frame& m_frame;
126     
127     class EventToDispatch {
128     public:
129         RefPtr<Element> element;
130         AtomicString eventType;
131         String name;
132         double elapsedTime;
133     };
134     
135     Vector<EventToDispatch> m_eventsToDispatch;
136     Vector<Ref<Element>> m_elementChangesToDispatch;
137     
138     double m_beginAnimationUpdateTime;
139
140     typedef HashSet<RefPtr<AnimationBase>> WaitingAnimationsSet;
141     WaitingAnimationsSet m_animationsWaitingForStyle;
142     WaitingAnimationsSet m_animationsWaitingForStartTimeResponse;
143     bool m_waitingForAsyncStartNotification;
144     bool m_isSuspended;
145
146     // Used to flag whether we should revert to previous buggy
147     // behavior of allowing new transitions and animations to
148     // run even when this object is suspended.
149     bool m_allowsNewAnimationsWhileSuspended;
150 };
151
152 } // namespace WebCore
153
154 #endif // AnimationControllerPrivate_h