[Web Animations] Refactor cancelDeclarativeAnimationsForElement and willDestroyRender...
[WebKit-https.git] / Source / WebCore / animation / DeclarativeAnimation.h
1 /*
2  * Copyright (C) 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 "AnimationEffect.h"
29 #include "AnimationEffectPhase.h"
30 #include "WebAnimation.h"
31 #include <wtf/Ref.h>
32 #include <wtf/WeakPtr.h>
33
34 namespace WebCore {
35
36 class Animation;
37 class AnimationEventBase;
38 class Element;
39 class RenderStyle;
40
41 class DeclarativeAnimation : public WebAnimation {
42     WTF_MAKE_ISO_ALLOCATED(DeclarativeAnimation);
43 public:
44     ~DeclarativeAnimation();
45
46     bool isDeclarativeAnimation() const final { return true; }
47
48     Element* owningElement() const;
49     const Animation& backingAnimation() const { return m_backingAnimation; }
50     void setBackingAnimation(const Animation&);
51     void cancelFromStyle();
52
53     Optional<double> startTime() const final;
54     void setStartTime(Optional<double>) final;
55     Optional<double> bindingsCurrentTime() const final;
56     ExceptionOr<void> setBindingsCurrentTime(Optional<double>) final;
57     WebAnimation::PlayState bindingsPlayState() const final;
58     WebAnimation::ReplaceState bindingsReplaceState() const final;
59     bool bindingsPending() const final;
60     WebAnimation::ReadyPromise& bindingsReady() final;
61     WebAnimation::FinishedPromise& bindingsFinished() final;
62     ExceptionOr<void> bindingsPlay() override;
63     ExceptionOr<void> bindingsPause() override;
64
65     void setTimeline(RefPtr<AnimationTimeline>&&) final;
66     void cancel(Silently = Silently::No) final;
67
68     void tick() override;
69
70     bool canHaveGlobalPosition() final;
71
72 protected:
73     DeclarativeAnimation(Element&, const Animation&);
74
75     virtual void initialize(const RenderStyle* oldStyle, const RenderStyle& newStyle);
76     virtual void syncPropertiesWithBackingAnimation();
77     // elapsedTime is the animation's current time at the time the event is added and is exposed through the DOM API, timelineTime is the animations'
78     // timeline current time and is not exposed through the DOM API but used by the DocumentTimeline for sorting events before dispatch. 
79     virtual Ref<AnimationEventBase> createEvent(const AtomString& eventType, double elapsedTime, const String& pseudoId, Optional<Seconds> timelineTime) = 0;
80     void invalidateDOMEvents(Seconds elapsedTime = 0_s);
81
82 private:
83     void disassociateFromOwningElement();
84     void flushPendingStyleChanges() const;
85     AnimationEffectPhase phaseWithoutEffect() const;
86     void enqueueDOMEvent(const AtomString&, Seconds);
87
88     bool m_wasPending { false };
89     AnimationEffectPhase m_previousPhase { AnimationEffectPhase::Idle };
90
91     WeakPtr<Element> m_owningElement;
92     Ref<Animation> m_backingAnimation;
93     double m_previousIteration;
94 };
95
96 } // namespace WebCore
97
98 SPECIALIZE_TYPE_TRAITS_WEB_ANIMATION(DeclarativeAnimation, isDeclarativeAnimation())