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     void addAnimation(Ref<WebAnimation>&&);
  51     void removeAnimation(Ref<WebAnimation>&&);
  52     std::optional<double> bindingsCurrentTime();
  53     virtual std::optional<Seconds> currentTime() { return m_currentTime; }
  54     WEBCORE_EXPORT void setCurrentTime(Seconds);
  55     WEBCORE_EXPORT String description();
  56     virtual void pause() { };
  57
  58     virtual void timingModelDidChange() { };
  59
  60     enum class Ordering { Sorted, Unsorted };
  61     const ListHashSet<RefPtr<WebAnimation>>& animations() const { return m_animations; }
  62     Vector<RefPtr<WebAnimation>> animationsForElement(Element&, Ordering ordering = Ordering::Unsorted) const;
  63     void elementWasRemoved(Element&);
  64     void removeAnimationsForElement(Element&);
  65     void cancelDeclarativeAnimationsForElement(Element&);
  66     virtual void animationWasAddedToElement(WebAnimation&, Element&);
  67     virtual void animationWasRemovedFromElement(WebAnimation&, Element&);
  68
  69     void updateCSSAnimationsForElement(Element&, const RenderStyle* currentStyle, const RenderStyle& afterChangeStyle);
  70     void updateCSSTransitionsForElement(Element&, const RenderStyle& currentStyle, const RenderStyle& afterChangeStyle);
  71
  72     virtual ~AnimationTimeline();
  73
  74 protected:
  75     enum ClassType {
  76         DocumentTimelineClass
  77     };
  78
  79     ClassType classType() const { return m_classType; }
  80
  81     explicit AnimationTimeline(ClassType);
  82
  83     bool hasElementAnimations() const { return !m_elementToAnimationsMap.isEmpty() || !m_elementToCSSAnimationsMap.isEmpty() || !m_elementToCSSTransitionsMap.isEmpty(); }
  84
  85     const ListHashSet<WebAnimation*>& animationsWithoutTarget() const { return m_animationsWithoutTarget; }
  86     const HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>>& elementToAnimationsMap() { return m_elementToAnimationsMap; }
  87     const HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>>& elementToCSSAnimationsMap() { return m_elementToCSSAnimationsMap; }
  88     const HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>>& elementToCSSTransitionsMap() { return m_elementToCSSTransitionsMap; }
  89
  90 private:
  91     HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>>& relevantMapForAnimation(WebAnimation&);
  92     void cancelOrRemoveDeclarativeAnimation(RefPtr<DeclarativeAnimation>);
  93     RefPtr<WebAnimation> cssAnimationForElementAndProperty(Element&, CSSPropertyID);
  94
  95     ClassType m_classType;
  96     std::optional<Seconds> m_currentTime;
  97     HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>> m_elementToAnimationsMap;
  98     HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>> m_elementToCSSAnimationsMap;
  99     HashMap<Element*, ListHashSet<RefPtr<WebAnimation>>> m_elementToCSSTransitionsMap;
 100     ListHashSet<RefPtr<WebAnimation>> m_animations;
 101
 102     ListHashSet<WebAnimation*> m_animationsWithoutTarget;
 103     HashMap<Element*, HashMap<String, RefPtr<CSSAnimation>>> m_elementToCSSAnimationByName;
 104     HashMap<Element*, HashMap<CSSPropertyID, RefPtr<CSSTransition>>> m_elementToRunningCSSTransitionByCSSPropertyID;
 105     HashMap<Element*, HashMap<CSSPropertyID, RefPtr<CSSTransition>>> m_elementToCompletedCSSTransitionByCSSPropertyID;
 106 };
 107
 108 } // namespace WebCore
 109
 110 #define SPECIALIZE_TYPE_TRAITS_ANIMATION_TIMELINE(ToValueTypeName, predicate) \
 111 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
 112 static bool isType(const WebCore::AnimationTimeline& value) { return value.predicate; } \
 113 SPECIALIZE_TYPE_TRAITS_END()