mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 14:45:29 +00:00
8ebe5a4445
This matches the CSS Working Group consensus recorded in http://lists.w3.org/Archives/Public/www-style/2012Nov/0261.html , though the spec hasn't yet been updated.
294 lines
11 KiB
C++
294 lines
11 KiB
C++
/* vim: set shiftwidth=2 tabstop=8 autoindent cindent expandtab: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
#ifndef nsAnimationManager_h_
|
|
#define nsAnimationManager_h_
|
|
|
|
#include "mozilla/Attributes.h"
|
|
#include "AnimationCommon.h"
|
|
#include "nsCSSPseudoElements.h"
|
|
#include "nsStyleContext.h"
|
|
#include "nsDataHashtable.h"
|
|
#include "nsGUIEvent.h"
|
|
#include "mozilla/TimeStamp.h"
|
|
#include "mozilla/Preferences.h"
|
|
#include "nsThreadUtils.h"
|
|
|
|
class nsCSSKeyframesRule;
|
|
|
|
namespace mozilla {
|
|
namespace css {
|
|
class Declaration;
|
|
}
|
|
}
|
|
|
|
struct AnimationEventInfo {
|
|
nsRefPtr<mozilla::dom::Element> mElement;
|
|
nsAnimationEvent mEvent;
|
|
|
|
AnimationEventInfo(mozilla::dom::Element *aElement,
|
|
const nsString& aAnimationName,
|
|
uint32_t aMessage, mozilla::TimeDuration aElapsedTime)
|
|
: mElement(aElement),
|
|
mEvent(true, aMessage, aAnimationName, aElapsedTime.ToSeconds())
|
|
{
|
|
}
|
|
|
|
// nsAnimationEvent doesn't support copy-construction, so we need
|
|
// to ourselves in order to work with nsTArray
|
|
AnimationEventInfo(const AnimationEventInfo &aOther)
|
|
: mElement(aOther.mElement),
|
|
mEvent(true, aOther.mEvent.message,
|
|
aOther.mEvent.animationName, aOther.mEvent.elapsedTime)
|
|
{
|
|
}
|
|
};
|
|
|
|
typedef InfallibleTArray<AnimationEventInfo> EventArray;
|
|
|
|
struct AnimationPropertySegment
|
|
{
|
|
float mFromKey, mToKey;
|
|
nsStyleAnimation::Value mFromValue, mToValue;
|
|
mozilla::css::ComputedTimingFunction mTimingFunction;
|
|
};
|
|
|
|
struct AnimationProperty
|
|
{
|
|
nsCSSProperty mProperty;
|
|
InfallibleTArray<AnimationPropertySegment> mSegments;
|
|
};
|
|
|
|
/**
|
|
* Data about one animation (i.e., one of the values of
|
|
* 'animation-name') running on an element.
|
|
*/
|
|
struct ElementAnimation
|
|
{
|
|
ElementAnimation()
|
|
: mLastNotification(LAST_NOTIFICATION_NONE)
|
|
{
|
|
}
|
|
|
|
nsString mName; // empty string for 'none'
|
|
float mIterationCount; // NS_IEEEPositiveInfinity() means infinite
|
|
uint8_t mDirection;
|
|
uint8_t mFillMode;
|
|
uint8_t mPlayState;
|
|
|
|
bool FillsForwards() const {
|
|
return mFillMode == NS_STYLE_ANIMATION_FILL_MODE_BOTH ||
|
|
mFillMode == NS_STYLE_ANIMATION_FILL_MODE_FORWARDS;
|
|
}
|
|
bool FillsBackwards() const {
|
|
return mFillMode == NS_STYLE_ANIMATION_FILL_MODE_BOTH ||
|
|
mFillMode == NS_STYLE_ANIMATION_FILL_MODE_BACKWARDS;
|
|
}
|
|
|
|
bool IsPaused() const {
|
|
return mPlayState == NS_STYLE_ANIMATION_PLAY_STATE_PAUSED;
|
|
}
|
|
|
|
virtual bool HasAnimationOfProperty(nsCSSProperty aProperty) const;
|
|
bool IsRunningAt(mozilla::TimeStamp aTime) const;
|
|
|
|
// Return the duration, at aTime (or, if paused, mPauseStart), since
|
|
// the *end* of the delay period. May be negative.
|
|
mozilla::TimeDuration ElapsedDurationAt(mozilla::TimeStamp aTime) const {
|
|
NS_ABORT_IF_FALSE(!IsPaused() || aTime >= mPauseStart,
|
|
"if paused, aTime must be at least mPauseStart");
|
|
return (IsPaused() ? mPauseStart : aTime) - mStartTime - mDelay;
|
|
}
|
|
|
|
mozilla::TimeStamp mStartTime; // the beginning of the delay period
|
|
mozilla::TimeStamp mPauseStart;
|
|
mozilla::TimeDuration mDelay;
|
|
mozilla::TimeDuration mIterationDuration;
|
|
|
|
enum {
|
|
LAST_NOTIFICATION_NONE = uint32_t(-1),
|
|
LAST_NOTIFICATION_END = uint32_t(-2)
|
|
};
|
|
// One of the above constants, or an integer for the iteration
|
|
// whose start we last notified on.
|
|
uint32_t mLastNotification;
|
|
|
|
InfallibleTArray<AnimationProperty> mProperties;
|
|
};
|
|
|
|
/**
|
|
* Data about all of the animations running on an element.
|
|
*/
|
|
struct ElementAnimations MOZ_FINAL
|
|
: public mozilla::css::CommonElementAnimationData
|
|
{
|
|
typedef mozilla::TimeStamp TimeStamp;
|
|
typedef mozilla::TimeDuration TimeDuration;
|
|
|
|
ElementAnimations(mozilla::dom::Element *aElement, nsIAtom *aElementProperty,
|
|
nsAnimationManager *aAnimationManager);
|
|
|
|
// This function takes as input the start time, duration, and direction of an
|
|
// animation and returns the position in the current iteration. Note that
|
|
// this only works when we know that the animation is currently running.
|
|
// This way of calling the function can be used from the compositor. Note
|
|
// that if the animation has not started yet, has already ended, or is paused,
|
|
// it should not be run from the compositor. When this function is called
|
|
// from the main thread, we need the actual ElementAnimation* in order to
|
|
// get correct animation-fill behavior and to fire animation events.
|
|
// This function returns -1 for the position if the animation should not be
|
|
// run (because it is not currently active and has no fill behavior), but
|
|
// only does so if aAnimation is non-null; with a null aAnimation it is an
|
|
// error to give aCurrentTime < aStartTime, and fill-forwards is assumed.
|
|
static double GetPositionInIteration(TimeDuration aElapsedDuration,
|
|
TimeDuration aIterationDuration,
|
|
double aIterationCount,
|
|
uint32_t aDirection,
|
|
bool aIsForElement = true,
|
|
ElementAnimation* aAnimation = nullptr,
|
|
ElementAnimations* aEa = nullptr,
|
|
EventArray* aEventsToDispatch = nullptr);
|
|
|
|
void EnsureStyleRuleFor(TimeStamp aRefreshTime,
|
|
EventArray &aEventsToDispatch,
|
|
bool aIsThrottled);
|
|
|
|
bool IsForElement() const { // rather than for a pseudo-element
|
|
return mElementProperty == nsGkAtoms::animationsProperty;
|
|
}
|
|
|
|
void PostRestyleForAnimation(nsPresContext *aPresContext) {
|
|
nsRestyleHint styleHint = IsForElement() ? eRestyle_Self : eRestyle_Subtree;
|
|
aPresContext->PresShell()->RestyleForAnimation(mElement, styleHint);
|
|
}
|
|
|
|
// True if this animation can be performed on the compositor thread.
|
|
virtual bool CanPerformOnCompositorThread(CanAnimateFlags aFlags) const MOZ_OVERRIDE;
|
|
virtual bool HasAnimationOfProperty(nsCSSProperty aProperty) const MOZ_OVERRIDE;
|
|
|
|
// False when we know that our current style rule is valid
|
|
// indefinitely into the future (because all of our animations are
|
|
// either completed or paused). May be invalidated by a style change.
|
|
bool mNeedsRefreshes;
|
|
|
|
InfallibleTArray<ElementAnimation> mAnimations;
|
|
};
|
|
|
|
class nsAnimationManager : public mozilla::css::CommonAnimationManager
|
|
{
|
|
public:
|
|
nsAnimationManager(nsPresContext *aPresContext)
|
|
: mozilla::css::CommonAnimationManager(aPresContext)
|
|
, mKeyframesListIsDirty(true)
|
|
{
|
|
mKeyframesRules.Init(16); // FIXME: make infallible!
|
|
}
|
|
|
|
static ElementAnimations* GetAnimationsForCompositor(nsIContent* aContent,
|
|
nsCSSProperty aProperty)
|
|
{
|
|
if (!aContent->MayHaveAnimations())
|
|
return nullptr;
|
|
ElementAnimations* animations = static_cast<ElementAnimations*>(
|
|
aContent->GetProperty(nsGkAtoms::animationsProperty));
|
|
if (!animations)
|
|
return nullptr;
|
|
bool propertyMatches = animations->HasAnimationOfProperty(aProperty);
|
|
return (propertyMatches &&
|
|
animations->CanPerformOnCompositorThread(
|
|
mozilla::css::CommonElementAnimationData::CanAnimate_AllowPartial))
|
|
? animations
|
|
: nullptr;
|
|
}
|
|
|
|
// Returns true if aContent or any of its ancestors has an animation.
|
|
static bool ContentOrAncestorHasAnimation(nsIContent* aContent) {
|
|
do {
|
|
if (aContent->GetProperty(nsGkAtoms::animationsProperty)) {
|
|
return true;
|
|
}
|
|
} while ((aContent = aContent->GetParent()));
|
|
|
|
return false;
|
|
}
|
|
|
|
void EnsureStyleRuleFor(ElementAnimations* aET);
|
|
|
|
// nsIStyleRuleProcessor (parts)
|
|
virtual void RulesMatching(ElementRuleProcessorData* aData) MOZ_OVERRIDE;
|
|
virtual void RulesMatching(PseudoElementRuleProcessorData* aData) MOZ_OVERRIDE;
|
|
virtual void RulesMatching(AnonBoxRuleProcessorData* aData) MOZ_OVERRIDE;
|
|
#ifdef MOZ_XUL
|
|
virtual void RulesMatching(XULTreeRuleProcessorData* aData) MOZ_OVERRIDE;
|
|
#endif
|
|
virtual NS_MUST_OVERRIDE size_t
|
|
SizeOfExcludingThis(nsMallocSizeOfFun aMallocSizeOf) const MOZ_OVERRIDE;
|
|
virtual NS_MUST_OVERRIDE size_t
|
|
SizeOfIncludingThis(nsMallocSizeOfFun aMallocSizeOf) const MOZ_OVERRIDE;
|
|
|
|
// nsARefreshObserver
|
|
virtual void WillRefresh(mozilla::TimeStamp aTime) MOZ_OVERRIDE;
|
|
|
|
void FlushAnimations(FlushFlags aFlags);
|
|
|
|
/**
|
|
* Return the style rule that RulesMatching should add for
|
|
* aStyleContext. This might be different from what RulesMatching
|
|
* actually added during aStyleContext's construction because the
|
|
* element's animation-name may have changed. (However, this does
|
|
* return null during the non-animation restyling phase, as
|
|
* RulesMatching does.)
|
|
*
|
|
* aStyleContext may be a style context for aElement or for its
|
|
* :before or :after pseudo-element.
|
|
*/
|
|
nsIStyleRule* CheckAnimationRule(nsStyleContext* aStyleContext,
|
|
mozilla::dom::Element* aElement);
|
|
|
|
void KeyframesListIsDirty() {
|
|
mKeyframesListIsDirty = true;
|
|
}
|
|
|
|
/**
|
|
* Dispatch any pending events. We accumulate animationend and
|
|
* animationiteration events only during refresh driver notifications
|
|
* (and dispatch them at the end of such notifications), but we
|
|
* accumulate animationstart events at other points when style
|
|
* contexts are created.
|
|
*/
|
|
void DispatchEvents() {
|
|
// Fast-path the common case: no events
|
|
if (!mPendingEvents.IsEmpty()) {
|
|
DoDispatchEvents();
|
|
}
|
|
}
|
|
|
|
ElementAnimations* GetElementAnimations(mozilla::dom::Element *aElement,
|
|
nsCSSPseudoElements::Type aPseudoType,
|
|
bool aCreateIfNeeded);
|
|
|
|
private:
|
|
void BuildAnimations(nsStyleContext* aStyleContext,
|
|
InfallibleTArray<ElementAnimation>& aAnimations);
|
|
bool BuildSegment(InfallibleTArray<AnimationPropertySegment>& aSegments,
|
|
nsCSSProperty aProperty, const nsAnimation& aAnimation,
|
|
float aFromKey, nsStyleContext* aFromContext,
|
|
mozilla::css::Declaration* aFromDeclaration,
|
|
float aToKey, nsStyleContext* aToContext);
|
|
nsIStyleRule* GetAnimationRule(mozilla::dom::Element* aElement,
|
|
nsCSSPseudoElements::Type aPseudoType);
|
|
|
|
nsCSSKeyframesRule* KeyframesRuleFor(const nsSubstring& aName);
|
|
|
|
// The guts of DispatchEvents
|
|
void DoDispatchEvents();
|
|
|
|
bool mKeyframesListIsDirty;
|
|
nsDataHashtable<nsStringHashKey, nsCSSKeyframesRule*> mKeyframesRules;
|
|
|
|
EventArray mPendingEvents;
|
|
};
|
|
|
|
#endif /* !defined(nsAnimationManager_h_) */
|