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