583e66620c5d5fda457d8316587f6113ec1bb6b4
[WebKit-https.git] / Source / WebCore / animation / AnimationTimeline.h
1 /*
2  * Copyright (C) Canon Inc. 2016
3  * Copyright (C) 2017 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "CSSValue.h"
30 #include "ComputedEffectTiming.h"
31 #include "RenderStyle.h"
32 #include "WebAnimation.h"
33 #include <wtf/Forward.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/ListHashSet.h>
36 #include <wtf/Optional.h>
37 #include <wtf/Ref.h>
38 #include <wtf/RefCounted.h>
39 #include <wtf/Seconds.h>
40
41 namespace WebCore {
42
43 class CSSAnimation;
44 class CSSTransition;
45 class DeclarativeAnimation;
46 class Element;
47
48 class AnimationTimeline : public RefCounted<AnimationTimeline> {
49 public:
50     bool isDocumentTimeline() const { return m_classType == DocumentTimelineClass; }
51
52     void forgetAnimation(WebAnimation*);
53     virtual void animationTimingDidChange(WebAnimation&);
54     virtual void removeAnimation(WebAnimation&);
55
56     Optional<double> bindingsCurrentTime();
57     virtual Optional<Seconds> currentTime() { return m_currentTime; }
58
59     enum class Ordering { Sorted, Unsorted };
60     Vector<RefPtr<WebAnimation>> animationsForElement(Element&, Ordering ordering = Ordering::Unsorted) const;
61     void elementWasRemoved(Element&);
62     void removeAnimationsForElement(Element&);
63     void cancelDeclarativeAnimationsForElement(Element&);
64     virtual void animationWasAddedToElement(WebAnimation&, Element&);
65     virtual void animationWasRemovedFromElement(WebAnimation&, Element&);
66     void removeDeclarativeAnimationFromListsForOwningElement(WebAnimation&, Element&);
67
68     void updateCSSAnimationsForElement(Element&, const RenderStyle* currentStyle, const RenderStyle& afterChangeStyle);
69     void updateCSSTransitionsForElement(Element&, const RenderStyle& currentStyle, const RenderStyle& afterChangeStyle);
70
71     using ElementToAnimationsMap = HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>>;
72     using PropertyToTransitionMap = HashMap<CSSPropertyID, RefPtr<CSSTransition>>;
73
74     virtual ~AnimationTimeline();
75
76 protected:
77     enum ClassType {
78         DocumentTimelineClass
79     };
80
81     ClassType classType() const { return m_classType; }
82
83     explicit AnimationTimeline(ClassType);
84
85     ListHashSet<WebAnimation*> m_allAnimations;
86     ListHashSet<RefPtr<WebAnimation>> m_animations;
87     HashMap<Element*, PropertyToTransitionMap> m_elementToCompletedCSSTransitionByCSSPropertyID;
88
89 private:
90     RefPtr<WebAnimation> cssAnimationForElementAndProperty(Element&, CSSPropertyID);
91     PropertyToTransitionMap& ensureRunningTransitionsByProperty(Element&);
92     void cancelDeclarativeAnimation(DeclarativeAnimation&);
93
94     ClassType m_classType;
95     Optional<Seconds> m_currentTime;
96     ElementToAnimationsMap m_elementToAnimationsMap;
97     ElementToAnimationsMap m_elementToCSSAnimationsMap;
98     ElementToAnimationsMap m_elementToCSSTransitionsMap;
99     HashMap<Element*, HashMap<String, RefPtr<CSSAnimation>>> m_elementToCSSAnimationByName;
100     HashMap<Element*, PropertyToTransitionMap> m_elementToRunningCSSTransitionByCSSPropertyID;
101 };
102
103 } // namespace WebCore
104
105 #define SPECIALIZE_TYPE_TRAITS_ANIMATION_TIMELINE(ToValueTypeName, predicate) \
106 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
107 static bool isType(const WebCore::AnimationTimeline& value) { return value.predicate; } \
108 SPECIALIZE_TYPE_TRAITS_END()