Update RTCScriptTransform constructor up to spec
[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 "EventTarget.h"
30 #include "ExceptionOr.h"
31 #include "IDLTypes.h"
32 #include "Styleable.h"
33 #include "WebAnimationTypes.h"
34 #include <wtf/Forward.h>
35 #include <wtf/Markable.h>
36 #include <wtf/Optional.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/Seconds.h>
39 #include <wtf/UniqueRef.h>
40 #include <wtf/WeakPtr.h>
41
42 namespace WebCore {
43
44 class AnimationEffect;
45 class AnimationEventBase;
46 class AnimationTimeline;
47 class Document;
48 class RenderStyle;
49
50 template<typename IDLType> class DOMPromiseProxyWithResolveCallback;
51
52 class WebAnimation : public RefCounted<WebAnimation>, public EventTargetWithInlineData, public ActiveDOMObject {
53     WTF_MAKE_ISO_ALLOCATED(WebAnimation);
54 public:
55     static Ref<WebAnimation> create(Document&, AnimationEffect*);
56     static Ref<WebAnimation> create(Document&, AnimationEffect*, AnimationTimeline*);
57     ~WebAnimation();
58
59     WEBCORE_EXPORT static HashSet<WebAnimation*>& instances();
60
61     virtual bool isDeclarativeAnimation() const { return false; }
62     virtual bool isCSSAnimation() const { return false; }
63     virtual bool isCSSTransition() const { return false; }
64
65     const String& id() const { return m_id; }
66     void setId(const String&);
67
68     AnimationEffect* bindingsEffect() const { return effect(); }
69     virtual void setBindingsEffect(RefPtr<AnimationEffect>&&);
70     AnimationEffect* effect() const { return m_effect.get(); }
71     void setEffect(RefPtr<AnimationEffect>&&);
72     AnimationTimeline* timeline() const { return m_timeline.get(); }
73     virtual void setTimeline(RefPtr<AnimationTimeline>&&);
74
75     Optional<Seconds> currentTime(Optional<Seconds> = WTF::nullopt) const;
76     ExceptionOr<void> setCurrentTime(Optional<Seconds>);
77
78     double playbackRate() const { return m_playbackRate + 0; }
79     void setPlaybackRate(double);
80
81     enum class PlayState : uint8_t { Idle, Running, Paused, Finished };
82     PlayState playState() const;
83
84     enum class ReplaceState : uint8_t { Active, Removed, Persisted };
85     ReplaceState replaceState() const { return m_replaceState; }
86     void setReplaceState(ReplaceState replaceState) { m_replaceState = replaceState; }
87
88     bool pending() const { return hasPendingPauseTask() || hasPendingPlayTask(); }
89
90     using ReadyPromise = DOMPromiseProxyWithResolveCallback<IDLInterface<WebAnimation>>;
91     ReadyPromise& ready() { return m_readyPromise.get(); }
92
93     using FinishedPromise = DOMPromiseProxyWithResolveCallback<IDLInterface<WebAnimation>>;
94     FinishedPromise& finished() { return m_finishedPromise.get(); }
95
96     virtual void cancel();
97     ExceptionOr<void> finish();
98     ExceptionOr<void> play();
99     void updatePlaybackRate(double);
100     ExceptionOr<void> pause();
101     virtual ExceptionOr<void> bindingsReverse();
102     ExceptionOr<void> reverse();
103     void persist();
104     ExceptionOr<void> commitStyles();
105
106     virtual Optional<double> bindingsStartTime() const;
107     virtual void setBindingsStartTime(Optional<double>);
108     Optional<Seconds> startTime() const { return m_startTime; }
109     void setStartTime(Optional<Seconds>);
110     virtual Optional<double> bindingsCurrentTime() const;
111     virtual ExceptionOr<void> setBindingsCurrentTime(Optional<double>);
112     virtual PlayState bindingsPlayState() const { return playState(); }
113     virtual ReplaceState bindingsReplaceState() const { return replaceState(); }
114     virtual bool bindingsPending() const { return pending(); }
115     virtual ReadyPromise& bindingsReady() { return ready(); }
116     virtual FinishedPromise& bindingsFinished() { return finished(); }
117     virtual ExceptionOr<void> bindingsPlay() { return play(); }
118     virtual ExceptionOr<void> bindingsPause() { return pause(); }
119
120     bool needsTick() const;
121     virtual void tick();
122     WEBCORE_EXPORT Seconds timeToNextTick() const;
123     virtual void resolve(RenderStyle& targetStyle, const RenderStyle* parentElementStyle, Optional<Seconds> = WTF::nullopt);
124     void effectTargetDidChange(const Optional<const Styleable>& previousTarget, const Optional<const Styleable>& newTarget);
125     void acceleratedStateDidChange();
126     void willChangeRenderer();
127
128     bool isRunningAccelerated() const;
129     bool isRelevant() const { return m_isRelevant; }
130     void updateRelevance();
131     void effectTimingDidChange();
132     void suspendEffectInvalidation();
133     void unsuspendEffectInvalidation();
134     void setSuspended(bool);
135     bool isSuspended() const { return m_isSuspended; }
136     bool isReplaceable() const;
137     void remove();
138     void enqueueAnimationPlaybackEvent(const AtomString&, Optional<Seconds>, Optional<Seconds>);
139
140     uint64_t globalPosition() const { return m_globalPosition; }
141     void setGlobalPosition(uint64_t globalPosition) { m_globalPosition = globalPosition; }
142
143     virtual bool canHaveGlobalPosition() { return true; }
144
145     // ContextDestructionObserver.
146     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
147     void contextDestroyed() final;
148
149     using RefCounted::ref;
150     using RefCounted::deref;
151
152 protected:
153     explicit WebAnimation(Document&);
154
155     void enqueueAnimationEvent(Ref<AnimationEventBase>&&);
156
157 private:
158     enum class DidSeek : uint8_t { Yes, No };
159     enum class SynchronouslyNotify : uint8_t { Yes, No };
160     enum class Silently : uint8_t { Yes, No };
161     enum class RespectHoldTime : uint8_t { Yes, No };
162     enum class AutoRewind : uint8_t { Yes, No };
163     enum class TimeToRunPendingTask : uint8_t { NotScheduled, ASAP, WhenReady };
164
165     void timingDidChange(DidSeek, SynchronouslyNotify, Silently = Silently::No);
166     void updateFinishedState(DidSeek, SynchronouslyNotify);
167     Seconds effectEndTime() const;
168     WebAnimation& readyPromiseResolve();
169     WebAnimation& finishedPromiseResolve();
170     Optional<Seconds> currentTime(RespectHoldTime, Optional<Seconds> = WTF::nullopt) const;
171     ExceptionOr<void> silentlySetCurrentTime(Optional<Seconds>);
172     void finishNotificationSteps();
173     bool hasPendingPauseTask() const { return m_timeToRunPendingPauseTask != TimeToRunPendingTask::NotScheduled; }
174     bool hasPendingPlayTask() const { return m_timeToRunPendingPlayTask != TimeToRunPendingTask::NotScheduled; }
175     ExceptionOr<void> play(AutoRewind);
176     void runPendingPauseTask();
177     void runPendingPlayTask();
178     void resetPendingTasks();
179     void setEffectInternal(RefPtr<AnimationEffect>&&, bool = false);
180     void setTimelineInternal(RefPtr<AnimationTimeline>&&);
181     bool isEffectInvalidationSuspended() { return m_suspendCount; }
182     bool computeRelevance();
183     void invalidateEffect();
184     double effectivePlaybackRate() const;
185     void applyPendingPlaybackRate();
186
187     RefPtr<AnimationEffect> m_effect;
188     RefPtr<AnimationTimeline> m_timeline;
189     UniqueRef<ReadyPromise> m_readyPromise;
190     UniqueRef<FinishedPromise> m_finishedPromise;
191     Markable<Seconds, Seconds::MarkableTraits> m_previousCurrentTime;
192     Markable<Seconds, Seconds::MarkableTraits> m_startTime;
193     Markable<Seconds, Seconds::MarkableTraits> m_holdTime;
194     MarkableDouble m_pendingPlaybackRate;
195     double m_playbackRate { 1 };
196     String m_id;
197
198     int m_suspendCount { 0 };
199
200     bool m_isSuspended { false };
201     bool m_finishNotificationStepsMicrotaskPending;
202     bool m_isRelevant;
203     bool m_shouldSkipUpdatingFinishedStateWhenResolving;
204     bool m_hasScheduledEventsDuringTick { false };
205     TimeToRunPendingTask m_timeToRunPendingPlayTask { TimeToRunPendingTask::NotScheduled };
206     TimeToRunPendingTask m_timeToRunPendingPauseTask { TimeToRunPendingTask::NotScheduled };
207     ReplaceState m_replaceState { ReplaceState::Active };
208     uint64_t m_globalPosition { 0 };
209
210     // ActiveDOMObject.
211     const char* activeDOMObjectName() const final;
212     void suspend(ReasonForSuspension) final;
213     void resume() final;
214     void stop() final;
215     bool virtualHasPendingActivity() const final;
216
217     // EventTarget
218     EventTargetInterface eventTargetInterface() const final { return WebAnimationEventTargetInterfaceType; }
219     void refEventTarget() final { ref(); }
220     void derefEventTarget() final { deref(); }
221 };
222
223 } // namespace WebCore
224
225 #define SPECIALIZE_TYPE_TRAITS_WEB_ANIMATION(ToValueTypeName, predicate) \
226 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
227 static bool isType(const WebCore::WebAnimation& value) { return value.predicate; } \
228 SPECIALIZE_TYPE_TRAITS_END()