[Web Animations] Audit Web Animations classes for memory reduction
[WebKit-https.git] / Source / WebCore / animation / WebAnimation.h
1 /*
2  * Copyright (C) 2017-2018 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 #pragma once
27
28 #include "ActiveDOMObject.h"
29 #include "DOMPromiseProxy.h"
30 #include "EventTarget.h"
31 #include "ExceptionOr.h"
32 #include "WebAnimationUtilities.h"
33 #include <wtf/Forward.h>
34 #include <wtf/Markable.h>
35 #include <wtf/Optional.h>
36 #include <wtf/Ref.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/RefPtr.h>
39 #include <wtf/Seconds.h>
40 #include <wtf/UniqueRef.h>
41 #include <wtf/WeakPtr.h>
42
43 namespace WebCore {
44
45 class AnimationEffect;
46 class AnimationPlaybackEvent;
47 class AnimationTimeline;
48 class Document;
49 class Element;
50 class RenderStyle;
51
52 class WebAnimation : public RefCounted<WebAnimation>, public CanMakeWeakPtr<WebAnimation>, public EventTargetWithInlineData, public ActiveDOMObject {
53 public:
54     static Ref<WebAnimation> create(Document&, AnimationEffect*);
55     static Ref<WebAnimation> create(Document&, AnimationEffect*, AnimationTimeline*);
56     ~WebAnimation();
57
58     virtual bool isDeclarativeAnimation() const { return false; }
59     virtual bool isCSSAnimation() const { return false; }
60     virtual bool isCSSTransition() const { return false; }
61
62     const String& id() const { return m_id; }
63     void setId(const String& id) { m_id = id; }
64
65     AnimationEffect* effect() const { return m_effect.get(); }
66     void setEffect(RefPtr<AnimationEffect>&&);
67     AnimationTimeline* timeline() const { return m_timeline.get(); }
68     virtual void setTimeline(RefPtr<AnimationTimeline>&&);
69
70     Optional<Seconds> currentTime() const;
71     ExceptionOr<void> setCurrentTime(Optional<Seconds>);
72
73     enum class Silently : uint8_t { Yes, No };
74     double playbackRate() const { return m_playbackRate + 0; }
75     void setPlaybackRate(double);
76
77     enum class PlayState : uint8_t { Idle, Running, Paused, Finished };
78     PlayState playState() const;
79
80     bool pending() const { return hasPendingPauseTask() || hasPendingPlayTask(); }
81
82     using ReadyPromise = DOMPromiseProxyWithResolveCallback<IDLInterface<WebAnimation>>;
83     ReadyPromise& ready() { return m_readyPromise.get(); }
84
85     using FinishedPromise = DOMPromiseProxyWithResolveCallback<IDLInterface<WebAnimation>>;
86     FinishedPromise& finished() { return m_finishedPromise.get(); }
87
88     virtual void cancel();
89     void cancel(Silently);
90     ExceptionOr<void> finish();
91     ExceptionOr<void> play();
92     void updatePlaybackRate(double);
93     ExceptionOr<void> pause();
94     ExceptionOr<void> reverse();
95
96     virtual Optional<double> startTime() const;
97     virtual void setStartTime(Optional<double>);
98     virtual Optional<double> bindingsCurrentTime() const;
99     virtual ExceptionOr<void> setBindingsCurrentTime(Optional<double>);
100     virtual PlayState bindingsPlayState() const { return playState(); }
101     virtual bool bindingsPending() const { return pending(); }
102     virtual ReadyPromise& bindingsReady() { return ready(); }
103     virtual FinishedPromise& bindingsFinished() { return finished(); }
104     virtual ExceptionOr<void> bindingsPlay() { return play(); }
105     virtual ExceptionOr<void> bindingsPause() { return pause(); }
106
107     virtual bool needsTick() const;
108     virtual void tick();
109     Seconds timeToNextTick() const;
110     virtual void resolve(RenderStyle&);
111     void effectTargetDidChange(Element* previousTarget, Element* newTarget);
112     void acceleratedStateDidChange();
113     void applyPendingAcceleratedActions();
114
115     bool isRunningAccelerated() const;
116     bool isRelevant() const { return m_isRelevant; }
117     void effectTimingDidChange();
118     void suspendEffectInvalidation();
119     void unsuspendEffectInvalidation();
120     void setSuspended(bool);
121     bool isSuspended() const { return m_isSuspended; }
122     virtual void remove();
123
124     using RefCounted::ref;
125     using RefCounted::deref;
126
127 protected:
128     explicit WebAnimation(Document&);
129
130     void stop() override;
131
132 private:
133     enum class DidSeek : uint8_t { Yes, No };
134     enum class SynchronouslyNotify : uint8_t { Yes, No };
135     enum class RespectHoldTime : uint8_t { Yes, No };
136     enum class AutoRewind : uint8_t { Yes, No };
137     enum class TimeToRunPendingTask : uint8_t { NotScheduled, ASAP, WhenReady };
138
139     void timingDidChange(DidSeek, SynchronouslyNotify);
140     void updateFinishedState(DidSeek, SynchronouslyNotify);
141     void enqueueAnimationPlaybackEvent(const AtomicString&, Optional<Seconds>, Optional<Seconds>);
142     Seconds effectEndTime() const;
143     WebAnimation& readyPromiseResolve();
144     WebAnimation& finishedPromiseResolve();
145     Optional<Seconds> currentTime(RespectHoldTime) const;
146     ExceptionOr<void> silentlySetCurrentTime(Optional<Seconds>);
147     void finishNotificationSteps();
148     bool hasPendingPauseTask() const { return m_timeToRunPendingPauseTask != TimeToRunPendingTask::NotScheduled; }
149     bool hasPendingPlayTask() const { return m_timeToRunPendingPlayTask != TimeToRunPendingTask::NotScheduled; }
150     ExceptionOr<void> play(AutoRewind);
151     void runPendingPauseTask();
152     void runPendingPlayTask();
153     void resetPendingTasks(Silently = Silently::No);
154     void setEffectInternal(RefPtr<AnimationEffect>&&, bool = false);
155     void setTimelineInternal(RefPtr<AnimationTimeline>&&);
156     bool isEffectInvalidationSuspended() { return m_suspendCount; }
157     bool computeRelevance();
158     void updateRelevance();
159     void invalidateEffect();
160     double effectivePlaybackRate() const;
161     void applyPendingPlaybackRate();
162
163     RefPtr<AnimationEffect> m_effect;
164     RefPtr<AnimationTimeline> m_timeline;
165     UniqueRef<ReadyPromise> m_readyPromise;
166     UniqueRef<FinishedPromise> m_finishedPromise;
167     Markable<Seconds, Seconds::MarkableTraits> m_previousCurrentTime;
168     Markable<Seconds, Seconds::MarkableTraits> m_startTime;
169     Markable<Seconds, Seconds::MarkableTraits> m_holdTime;
170     MarkableDouble m_pendingPlaybackRate;
171     double m_playbackRate { 1 };
172     String m_id;
173
174     int m_suspendCount { 0 };
175
176     bool m_isStopped { false };
177     bool m_isSuspended { false };
178     bool m_finishNotificationStepsMicrotaskPending;
179     bool m_isRelevant;
180     bool m_shouldSkipUpdatingFinishedStateWhenResolving;
181     TimeToRunPendingTask m_timeToRunPendingPlayTask { TimeToRunPendingTask::NotScheduled };
182     TimeToRunPendingTask m_timeToRunPendingPauseTask { TimeToRunPendingTask::NotScheduled };
183
184     // ActiveDOMObject.
185     const char* activeDOMObjectName() const final;
186     bool canSuspendForDocumentSuspension() const final;
187
188     // EventTarget
189     EventTargetInterface eventTargetInterface() const final { return WebAnimationEventTargetInterfaceType; }
190     void refEventTarget() final { ref(); }
191     void derefEventTarget() final { deref(); }
192     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
193 };
194
195 } // namespace WebCore
196
197 #define SPECIALIZE_TYPE_TRAITS_WEB_ANIMATION(ToValueTypeName, predicate) \
198 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
199 static bool isType(const WebCore::WebAnimation& value) { return value.predicate; } \
200 SPECIALIZE_TYPE_TRAITS_END()