[Web Animations] Make WPT test at interfaces/Animation/finish.html pass reliably
[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
40 namespace WebCore {
41
42 class AnimationEffectReadOnly;
43 class AnimationPlaybackEvent;
44 class AnimationTimeline;
45 class Document;
46 class Element;
47 class RenderStyle;
48
49 class WebAnimation : public RefCounted<WebAnimation>, public EventTargetWithInlineData, public ActiveDOMObject {
50 public:
51     static Ref<WebAnimation> create(Document&, AnimationEffectReadOnly*);
52     static Ref<WebAnimation> create(Document&, AnimationEffectReadOnly*, 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     virtual bool canBeListed() const;
60
61     const String& id() const { return m_id; }
62     void setId(const String& id) { m_id = id; }
63
64     AnimationEffectReadOnly* effect() const { return m_effect.get(); }
65     void setEffect(RefPtr<AnimationEffectReadOnly>&&);
66     AnimationTimeline* timeline() const { return m_timeline.get(); }
67     virtual void setTimeline(RefPtr<AnimationTimeline>&&);
68
69     std::optional<Seconds> startTime() const;
70     void setStartTime(std::optional<Seconds>);
71
72     std::optional<Seconds> currentTime() const;
73     ExceptionOr<void> setCurrentTime(std::optional<Seconds>);
74
75     enum class Silently { Yes, No };
76     double playbackRate() const { return m_playbackRate; }
77     void setPlaybackRate(double, Silently silently = Silently::No );
78
79     enum class PlayState { Idle, Running, Paused, Finished };
80     PlayState playState() const;
81
82     bool pending() const { return hasPendingPauseTask() || hasPendingPlayTask(); }
83
84     using ReadyPromise = DOMPromiseProxyWithResolveCallback<IDLInterface<WebAnimation>>;
85     ReadyPromise& ready() { return m_readyPromise.get(); }
86
87     using FinishedPromise = DOMPromiseProxyWithResolveCallback<IDLInterface<WebAnimation>>;
88     FinishedPromise& finished() { return m_finishedPromise.get(); }
89
90     virtual void cancel();
91     ExceptionOr<void> finish();
92     ExceptionOr<void> play();
93     ExceptionOr<void> pause();
94     ExceptionOr<void> reverse();
95
96     virtual std::optional<double> bindingsStartTime() const;
97     virtual void setBindingsStartTime(std::optional<double>);
98     virtual std::optional<double> bindingsCurrentTime() const;
99     virtual ExceptionOr<void> setBindingsCurrentTime(std::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     Seconds timeToNextRequiredTick() const;
108     void resolve();
109     virtual void resolve(RenderStyle&);
110     void runPendingTasks();
111     void effectTargetDidChange(Element* previousTarget, Element* newTarget);
112     void acceleratedStateDidChange();
113     void applyPendingAcceleratedActions();
114
115     void timingModelDidChange();
116     void effectTimingPropertiesDidChange();
117     void suspendEffectInvalidation();
118     void unsuspendEffectInvalidation();
119     void setSuspended(bool);
120     bool isSuspended() const { return m_isSuspended; }
121     virtual void remove();
122
123     String description();
124
125     using RefCounted::ref;
126     using RefCounted::deref;
127
128 protected:
129     explicit WebAnimation(Document&);
130
131     bool isEffectInvalidationSuspended() { return m_suspendCount; }
132
133 private:
134     enum class DidSeek { Yes, No };
135     enum class SynchronouslyNotify { Yes, No };
136     enum class RespectHoldTime { Yes, No };
137     enum class AutoRewind { Yes, No };
138     enum class TimeToRunPendingTask { NotScheduled, ASAP, WhenReady };
139
140     void updateFinishedState(DidSeek, SynchronouslyNotify);
141     void enqueueAnimationPlaybackEvent(const AtomicString&, std::optional<Seconds>, std::optional<Seconds>);
142     Seconds effectEndTime() const;
143     WebAnimation& readyPromiseResolve();
144     WebAnimation& finishedPromiseResolve();
145     void setHoldTime(std::optional<Seconds>);
146     std::optional<Seconds> currentTime(RespectHoldTime) const;
147     ExceptionOr<void> silentlySetCurrentTime(std::optional<Seconds>);
148     void finishNotificationSteps();
149     void scheduleMicrotaskIfNeeded();
150     void performMicrotask();
151     void setTimeToRunPendingPauseTask(TimeToRunPendingTask);
152     void setTimeToRunPendingPlayTask(TimeToRunPendingTask);
153     bool hasPendingPauseTask() const { return m_timeToRunPendingPauseTask != TimeToRunPendingTask::NotScheduled; }
154     bool hasPendingPlayTask() const { return m_timeToRunPendingPlayTask != TimeToRunPendingTask::NotScheduled; }
155     void updatePendingTasks();
156     ExceptionOr<void> play(AutoRewind);
157     void runPendingPauseTask();
158     void runPendingPlayTask();
159     void resetPendingTasks();
160     void setEffectInternal(RefPtr<AnimationEffectReadOnly>&&, bool = false);
161     void setTimelineInternal(RefPtr<AnimationTimeline>&&);
162
163     String m_id;
164     RefPtr<AnimationEffectReadOnly> 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     bool m_isStopped { false };
172     bool m_isSuspended { false };
173     bool m_finishNotificationStepsMicrotaskPending;
174     bool m_scheduledMicrotask;
175     UniqueRef<ReadyPromise> m_readyPromise;
176     UniqueRef<FinishedPromise> m_finishedPromise;
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     void stop() final;
184
185     // EventTarget
186     EventTargetInterface eventTargetInterface() const final { return WebAnimationEventTargetInterfaceType; }
187     void refEventTarget() final { ref(); }
188     void derefEventTarget() final { deref(); }
189     ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
190 };
191
192 } // namespace WebCore
193
194 #define SPECIALIZE_TYPE_TRAITS_WEB_ANIMATION(ToValueTypeName, predicate) \
195 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
196 static bool isType(const WebCore::WebAnimation& value) { return value.predicate; } \
197 SPECIALIZE_TYPE_TRAITS_END()