[Web Animations] transitions/remove-transition-style.html crashes with GuardMalloc on
[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 "RenderStyle.h"
31 #include "WebAnimation.h"
32 #include <wtf/Forward.h>
33 #include <wtf/HashMap.h>
34 #include <wtf/ListHashSet.h>
35 #include <wtf/Optional.h>
36 #include <wtf/Ref.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/Seconds.h>
39
40 namespace WebCore {
41
42 class CSSAnimation;
43 class CSSTransition;
44 class DeclarativeAnimation;
45 class Element;
46
47 class AnimationTimeline : public RefCounted<AnimationTimeline> {
48 public:
49     bool isDocumentTimeline() const { return m_classType == DocumentTimelineClass; }
50
51     void forgetAnimation(WebAnimation*);
52     virtual void animationTimingDidChange(WebAnimation&);
53     virtual void removeAnimation(WebAnimation&);
54
55     std::optional<double> bindingsCurrentTime();
56     virtual std::optional<Seconds> currentTime() { return m_currentTime; }
57
58     enum class Ordering { Sorted, Unsorted };
59     Vector<RefPtr<WebAnimation>> animationsForElement(Element&, Ordering ordering = Ordering::Unsorted) const;
60     void elementWasRemoved(Element&);
61     void removeAnimationsForElement(Element&);
62     void cancelDeclarativeAnimationsForElement(Element&);
63     virtual void animationWasAddedToElement(WebAnimation&, Element&);
64     virtual void animationWasRemovedFromElement(WebAnimation&, Element&);
65     void removeDeclarativeAnimationFromListsForOwningElement(WebAnimation&, Element&);
66
67     void updateCSSAnimationsForElement(Element&, const RenderStyle* currentStyle, const RenderStyle& afterChangeStyle);
68     void updateCSSTransitionsForElement(Element&, const RenderStyle& currentStyle, const RenderStyle& afterChangeStyle);
69
70     using ElementToAnimationsMap = HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>>;
71     using PropertyToTransitionMap = HashMap<CSSPropertyID, RefPtr<CSSTransition>>;
72
73     virtual ~AnimationTimeline();
74
75 protected:
76     enum ClassType {
77         DocumentTimelineClass
78     };
79
80     ClassType classType() const { return m_classType; }
81
82     explicit AnimationTimeline(ClassType);
83
84     ListHashSet<WebAnimation*> m_allAnimations;
85     ListHashSet<RefPtr<WebAnimation>> m_animations;
86     HashMap<Element*, PropertyToTransitionMap> m_elementToCompletedCSSTransitionByCSSPropertyID;
87
88 private:
89     RefPtr<WebAnimation> cssAnimationForElementAndProperty(Element&, CSSPropertyID);
90     PropertyToTransitionMap& ensureRunningTransitionsByProperty(Element&);
91     void cancelDeclarativeAnimation(DeclarativeAnimation&);
92
93     ClassType m_classType;
94     std::optional<Seconds> m_currentTime;
95     ElementToAnimationsMap m_elementToAnimationsMap;
96     ElementToAnimationsMap m_elementToCSSAnimationsMap;
97     ElementToAnimationsMap m_elementToCSSTransitionsMap;
98     HashMap<Element*, HashMap<String, RefPtr<CSSAnimation>>> m_elementToCSSAnimationByName;
99     HashMap<Element*, PropertyToTransitionMap> m_elementToRunningCSSTransitionByCSSPropertyID;
100 };
101
102 } // namespace WebCore
103
104 #define SPECIALIZE_TYPE_TRAITS_ANIMATION_TIMELINE(ToValueTypeName, predicate) \
105 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
106 static bool isType(const WebCore::AnimationTimeline& value) { return value.predicate; } \
107 SPECIALIZE_TYPE_TRAITS_END()