#pragma once
#include "ActiveDOMObject.h"
#include "DOMPromiseProxy.h"
#include "EventTarget.h"
#include "ExceptionOr.h"
#include <wtf/Forward.h>
#include <wtf/Optional.h>
#include <wtf/Ref.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>
#include <wtf/Seconds.h>
#include <wtf/UniqueRef.h>
namespace WebCore {
class AnimationEffectReadOnly;
class AnimationPlaybackEvent;
class AnimationTimeline;
class Document;
class Element;
class RenderStyle;
class WebAnimation : public RefCounted<WebAnimation>, public EventTargetWithInlineData, public ActiveDOMObject {
public:
static Ref<WebAnimation> create(Document&, AnimationEffectReadOnly*);
static Ref<WebAnimation> create(Document&, AnimationEffectReadOnly*, AnimationTimeline*);
~WebAnimation();
virtual bool isDeclarativeAnimation() const { return false; }
virtual bool isCSSAnimation() const { return false; }
virtual bool isCSSTransition() const { return false; }
virtual bool canBeListed() const;
const String& id() const { return m_id; }
void setId(const String& id) { m_id = id; }
AnimationEffectReadOnly* effect() const { return m_effect.get(); }
void setEffect(RefPtr<AnimationEffectReadOnly>&&);
AnimationTimeline* timeline() const { return m_timeline.get(); }
virtual void setTimeline(RefPtr<AnimationTimeline>&&);
std::optional<Seconds> startTime() const;
void setStartTime(std::optional<Seconds>);
std::optional<Seconds> currentTime() const;
ExceptionOr<void> setCurrentTime(std::optional<Seconds>);
enum class Silently { Yes, No };
double playbackRate() const { return m_playbackRate; }
void setPlaybackRate(double, Silently silently = Silently::No );
enum class PlayState { Idle, Running, Paused, Finished };
PlayState playState() const;
bool pending() const { return hasPendingPauseTask() || hasPendingPlayTask(); }
using ReadyPromise = DOMPromiseProxyWithResolveCallback<IDLInterface<WebAnimation>>;
ReadyPromise& ready() { return m_readyPromise.get(); }
using FinishedPromise = DOMPromiseProxyWithResolveCallback<IDLInterface<WebAnimation>>;
FinishedPromise& finished() { return m_finishedPromise.get(); }
virtual void cancel();
ExceptionOr<void> finish();
ExceptionOr<void> play();
ExceptionOr<void> pause();
ExceptionOr<void> reverse();
virtual std::optional<double> bindingsStartTime() const;
virtual void setBindingsStartTime(std::optional<double>);
virtual std::optional<double> bindingsCurrentTime() const;
virtual ExceptionOr<void> setBindingsCurrentTime(std::optional<double>);
virtual PlayState bindingsPlayState() const { return playState(); }
virtual bool bindingsPending() const { return pending(); }
virtual ReadyPromise& bindingsReady() { return ready(); }
virtual FinishedPromise& bindingsFinished() { return finished(); }
virtual ExceptionOr<void> bindingsPlay() { return play(); }
virtual ExceptionOr<void> bindingsPause() { return pause(); }
Seconds timeToNextRequiredTick() const;
void resolve();
virtual void resolve(RenderStyle&);
void runPendingTasks();
void effectTargetDidChange(Element* previousTarget, Element* newTarget);
void acceleratedStateDidChange();
void applyPendingAcceleratedActions();
void timingModelDidChange();
void effectTimingPropertiesDidChange();
void suspendEffectInvalidation();
void unsuspendEffectInvalidation();
void setSuspended(bool);
bool isSuspended() const { return m_isSuspended; }
virtual void remove();
String description();
using RefCounted::ref;
using RefCounted::deref;
protected:
explicit WebAnimation(Document&);
bool isEffectInvalidationSuspended() { return m_suspendCount; }
private:
enum class DidSeek { Yes, No };
enum class SynchronouslyNotify { Yes, No };
enum class RespectHoldTime { Yes, No };
enum class AutoRewind { Yes, No };
enum class TimeToRunPendingTask { NotScheduled, ASAP, WhenReady };
void updateFinishedState(DidSeek, SynchronouslyNotify);
void enqueueAnimationPlaybackEvent(const AtomicString&, std::optional<Seconds>, std::optional<Seconds>);
Seconds effectEndTime() const;
WebAnimation& readyPromiseResolve();
WebAnimation& finishedPromiseResolve();
void setHoldTime(std::optional<Seconds>);
std::optional<Seconds> currentTime(RespectHoldTime) const;
ExceptionOr<void> silentlySetCurrentTime(std::optional<Seconds>);
void finishNotificationSteps();
void scheduleMicrotaskIfNeeded();
void performMicrotask();
void setTimeToRunPendingPauseTask(TimeToRunPendingTask);
void setTimeToRunPendingPlayTask(TimeToRunPendingTask);
bool hasPendingPauseTask() const { return m_timeToRunPendingPauseTask != TimeToRunPendingTask::NotScheduled; }
bool hasPendingPlayTask() const { return m_timeToRunPendingPlayTask != TimeToRunPendingTask::NotScheduled; }
void updatePendingTasks();
ExceptionOr<void> play(AutoRewind);
void runPendingPauseTask();
void runPendingPlayTask();
void resetPendingTasks();
void setEffectInternal(RefPtr<AnimationEffectReadOnly>&&, bool = false);
void setTimelineInternal(RefPtr<AnimationTimeline>&&);
String m_id;
RefPtr<AnimationEffectReadOnly> m_effect;
RefPtr<AnimationTimeline> m_timeline;
std::optional<Seconds> m_previousCurrentTime;
std::optional<Seconds> m_startTime;
std::optional<Seconds> m_holdTime;
int m_suspendCount { 0 };
double m_playbackRate { 1 };
bool m_isStopped { false };
bool m_isSuspended { false };
bool m_finishNotificationStepsMicrotaskPending;
bool m_scheduledMicrotask;
UniqueRef<ReadyPromise> m_readyPromise;
UniqueRef<FinishedPromise> m_finishedPromise;
TimeToRunPendingTask m_timeToRunPendingPlayTask { TimeToRunPendingTask::NotScheduled };
TimeToRunPendingTask m_timeToRunPendingPauseTask { TimeToRunPendingTask::NotScheduled };
const char* activeDOMObjectName() const final;
bool canSuspendForDocumentSuspension() const final;
void stop() final;
EventTargetInterface eventTargetInterface() const final { return WebAnimationEventTargetInterfaceType; }
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
ScriptExecutionContext* scriptExecutionContext() const final { return ActiveDOMObject::scriptExecutionContext(); }
};
}
#define SPECIALIZE_TYPE_TRAITS_WEB_ANIMATION(ToValueTypeName, predicate) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
static bool isType(const WebCore::WebAnimation& value) { return value.predicate; } \
SPECIALIZE_TYPE_TRAITS_END()