[Web Animations] Audit Web Animations classes for memory reduction
[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 "GenericEventQueue.h"
31 #include "WebAnimation.h"
32 #include <wtf/Ref.h>
33
34 namespace WebCore {
35
36 class Animation;
37 class Element;
38 class RenderStyle;
39
40 class DeclarativeAnimation : public WebAnimation {
41 public:
42     ~DeclarativeAnimation();
43
44     bool isDeclarativeAnimation() const final { return true; }
45
46     Element* owningElement() const { return m_owningElement; }
47     const Animation& backingAnimation() const { return m_backingAnimation; }
48     void setBackingAnimation(const Animation&);
49     void cancelFromStyle();
50
51     Optional<double> startTime() const final;
52     void setStartTime(Optional<double>) final;
53     Optional<double> bindingsCurrentTime() const final;
54     ExceptionOr<void> setBindingsCurrentTime(Optional<double>) final;
55     WebAnimation::PlayState bindingsPlayState() const final;
56     bool bindingsPending() const final;
57     WebAnimation::ReadyPromise& bindingsReady() final;
58     WebAnimation::FinishedPromise& bindingsFinished() final;
59     ExceptionOr<void> bindingsPlay() override;
60     ExceptionOr<void> bindingsPause() override;
61
62     void setTimeline(RefPtr<AnimationTimeline>&&) final;
63     void cancel() final;
64
65     bool needsTick() const override;
66     void tick() override;
67
68 protected:
69     DeclarativeAnimation(Element&, const Animation&);
70
71     virtual void initialize(const RenderStyle* oldStyle, const RenderStyle& newStyle);
72     virtual void syncPropertiesWithBackingAnimation();
73     void invalidateDOMEvents(Seconds elapsedTime = 0_s);
74
75 private:
76     void disassociateFromOwningElement();
77     void flushPendingStyleChanges() const;
78     AnimationEffectPhase phaseWithoutEffect() const;
79     void enqueueDOMEvent(const AtomicString&, Seconds);
80     void remove() final;
81
82     // ActiveDOMObject.
83     void suspend(ReasonForSuspension) final;
84     void resume() final;
85     void stop() final;
86
87     bool m_wasPending { false };
88     AnimationEffectPhase m_previousPhase { AnimationEffectPhase::Idle };
89
90     GenericEventQueue m_eventQueue;
91
92     Element* m_owningElement;
93     Ref<Animation> m_backingAnimation;
94     double m_previousIteration;
95 };
96
97 } // namespace WebCore
98
99 SPECIALIZE_TYPE_TRAITS_WEB_ANIMATION(DeclarativeAnimation, isDeclarativeAnimation())