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