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