mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
e4cb3c7353
The long-term plan is to drop the mozilla::css namespace altogether. Before we go to much further with refactoring code in AnimationCommon, we should drop usage of the mozilla::css namespace. Specifically, this patch moves the CommonAnimationManager and AnimValuesStyleRule classes to the mozilla namespace.
343 lines
11 KiB
C++
343 lines
11 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* 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 mozilla_dom_KeyframeEffect_h
|
|
#define mozilla_dom_KeyframeEffect_h
|
|
|
|
#include "nsAutoPtr.h"
|
|
#include "nsCycleCollectionParticipant.h"
|
|
#include "nsCSSPseudoElements.h"
|
|
#include "nsIDocument.h"
|
|
#include "nsWrapperCache.h"
|
|
#include "mozilla/Attributes.h"
|
|
#include "mozilla/StickyTimeDuration.h"
|
|
#include "mozilla/StyleAnimationValue.h"
|
|
#include "mozilla/TimeStamp.h"
|
|
#include "mozilla/dom/AnimationEffectReadOnly.h"
|
|
#include "mozilla/dom/Element.h"
|
|
#include "mozilla/dom/Nullable.h"
|
|
#include "nsSMILKeySpline.h"
|
|
#include "nsStyleStruct.h" // for nsTimingFunction
|
|
|
|
struct JSContext;
|
|
class nsCSSPropertySet;
|
|
|
|
namespace mozilla {
|
|
|
|
class AnimValuesStyleRule;
|
|
|
|
/**
|
|
* Input timing parameters.
|
|
*
|
|
* Eventually this will represent all the input timing parameters specified
|
|
* by content but for now it encapsulates just the subset of those
|
|
* parameters passed to GetPositionInIteration.
|
|
*/
|
|
struct AnimationTiming
|
|
{
|
|
TimeDuration mIterationDuration;
|
|
TimeDuration mDelay;
|
|
float mIterationCount; // mozilla::PositiveInfinity<float>() means infinite
|
|
uint8_t mDirection;
|
|
uint8_t mFillMode;
|
|
|
|
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 operator==(const AnimationTiming& aOther) const {
|
|
return mIterationDuration == aOther.mIterationDuration &&
|
|
mDelay == aOther.mDelay &&
|
|
mIterationCount == aOther.mIterationCount &&
|
|
mDirection == aOther.mDirection &&
|
|
mFillMode == aOther.mFillMode;
|
|
}
|
|
bool operator!=(const AnimationTiming& aOther) const {
|
|
return !(*this == aOther);
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Stores the results of calculating the timing properties of an animation
|
|
* at a given sample time.
|
|
*/
|
|
struct ComputedTiming
|
|
{
|
|
ComputedTiming()
|
|
: mProgress(kNullProgress)
|
|
, mCurrentIteration(0)
|
|
, mPhase(AnimationPhase_Null)
|
|
{ }
|
|
|
|
static const double kNullProgress;
|
|
|
|
// The total duration of the animation including all iterations.
|
|
// Will equal StickyTimeDuration::Forever() if the animation repeats
|
|
// indefinitely.
|
|
StickyTimeDuration mActiveDuration;
|
|
|
|
// Progress towards the end of the current iteration. If the effect is
|
|
// being sampled backwards, this will go from 1.0 to 0.0.
|
|
// Will be kNullProgress if the animation is neither animating nor
|
|
// filling at the sampled time.
|
|
double mProgress;
|
|
|
|
// Zero-based iteration index (meaningless if mProgress is kNullProgress).
|
|
uint64_t mCurrentIteration;
|
|
|
|
enum {
|
|
// Not sampled (null sample time)
|
|
AnimationPhase_Null,
|
|
// Sampled prior to the start of the active interval
|
|
AnimationPhase_Before,
|
|
// Sampled within the active interval
|
|
AnimationPhase_Active,
|
|
// Sampled after (or at) the end of the active interval
|
|
AnimationPhase_After
|
|
} mPhase;
|
|
};
|
|
|
|
class ComputedTimingFunction
|
|
{
|
|
public:
|
|
typedef nsTimingFunction::Type Type;
|
|
void Init(const nsTimingFunction &aFunction);
|
|
double GetValue(double aPortion) const;
|
|
const nsSMILKeySpline* GetFunction() const {
|
|
NS_ASSERTION(mType == nsTimingFunction::Function, "Type mismatch");
|
|
return &mTimingFunction;
|
|
}
|
|
Type GetType() const { return mType; }
|
|
uint32_t GetSteps() const { return mSteps; }
|
|
bool operator==(const ComputedTimingFunction& aOther) const {
|
|
return mType == aOther.mType &&
|
|
(mType == nsTimingFunction::Function ?
|
|
mTimingFunction == aOther.mTimingFunction :
|
|
mSteps == aOther.mSteps);
|
|
}
|
|
bool operator!=(const ComputedTimingFunction& aOther) const {
|
|
return !(*this == aOther);
|
|
}
|
|
|
|
private:
|
|
Type mType;
|
|
nsSMILKeySpline mTimingFunction;
|
|
uint32_t mSteps;
|
|
};
|
|
|
|
struct AnimationPropertySegment
|
|
{
|
|
float mFromKey, mToKey;
|
|
StyleAnimationValue mFromValue, mToValue;
|
|
ComputedTimingFunction mTimingFunction;
|
|
|
|
bool operator==(const AnimationPropertySegment& aOther) const {
|
|
return mFromKey == aOther.mFromKey &&
|
|
mToKey == aOther.mToKey &&
|
|
mFromValue == aOther.mFromValue &&
|
|
mToValue == aOther.mToValue &&
|
|
mTimingFunction == aOther.mTimingFunction;
|
|
}
|
|
bool operator!=(const AnimationPropertySegment& aOther) const {
|
|
return !(*this == aOther);
|
|
}
|
|
};
|
|
|
|
struct AnimationProperty
|
|
{
|
|
nsCSSProperty mProperty;
|
|
|
|
// Does this property win in the CSS Cascade?
|
|
//
|
|
// For CSS transitions, this is true as long as a CSS animation on the
|
|
// same property and element is not running, in which case we set this
|
|
// to false so that the animation (lower in the cascade) can win. We
|
|
// then use this to decide whether to apply the style both in the CSS
|
|
// cascade and for OMTA.
|
|
//
|
|
// For CSS Animations, which are overridden by !important rules in the
|
|
// cascade, we actually determine this from the CSS cascade
|
|
// computations, and then use it for OMTA.
|
|
// **NOTE**: For CSS animations, we only bother setting mWinsInCascade
|
|
// accurately for properties that we can animate on the compositor.
|
|
// For other properties, we make it always be true.
|
|
bool mWinsInCascade;
|
|
|
|
InfallibleTArray<AnimationPropertySegment> mSegments;
|
|
|
|
bool operator==(const AnimationProperty& aOther) const {
|
|
return mProperty == aOther.mProperty &&
|
|
mWinsInCascade == aOther.mWinsInCascade &&
|
|
mSegments == aOther.mSegments;
|
|
}
|
|
bool operator!=(const AnimationProperty& aOther) const {
|
|
return !(*this == aOther);
|
|
}
|
|
};
|
|
|
|
struct ElementPropertyTransition;
|
|
|
|
namespace dom {
|
|
|
|
class KeyframeEffectReadOnly : public AnimationEffectReadOnly
|
|
{
|
|
public:
|
|
KeyframeEffectReadOnly(nsIDocument* aDocument,
|
|
Element* aTarget,
|
|
nsCSSPseudoElements::Type aPseudoType,
|
|
const AnimationTiming &aTiming)
|
|
: AnimationEffectReadOnly(aDocument)
|
|
, mTarget(aTarget)
|
|
, mTiming(aTiming)
|
|
, mIsFinishedTransition(false)
|
|
, mPseudoType(aPseudoType)
|
|
{
|
|
MOZ_ASSERT(aTarget, "null animation target is not yet supported");
|
|
}
|
|
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(KeyframeEffectReadOnly,
|
|
AnimationEffectReadOnly)
|
|
|
|
virtual JSObject* WrapObject(JSContext* aCx,
|
|
JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
virtual ElementPropertyTransition* AsTransition() { return nullptr; }
|
|
virtual const ElementPropertyTransition* AsTransition() const
|
|
{
|
|
return nullptr;
|
|
}
|
|
|
|
// KeyframeEffectReadOnly interface
|
|
Element* GetTarget() const {
|
|
// Currently we never return animations from the API whose effect
|
|
// targets a pseudo-element so this should never be called when
|
|
// mPseudoType is not 'none' (see bug 1174575).
|
|
MOZ_ASSERT(mPseudoType == nsCSSPseudoElements::ePseudo_NotPseudoElement,
|
|
"Requesting the target of a KeyframeEffect that targets a"
|
|
" pseudo-element is not yet supported.");
|
|
return mTarget;
|
|
}
|
|
|
|
// Temporary workaround to return both the target element and pseudo-type
|
|
// until we implement PseudoElement (bug 1174575).
|
|
void GetTarget(Element*& aTarget,
|
|
nsCSSPseudoElements::Type& aPseudoType) const {
|
|
aTarget = mTarget;
|
|
aPseudoType = mPseudoType;
|
|
}
|
|
|
|
void SetParentTime(Nullable<TimeDuration> aParentTime);
|
|
|
|
const AnimationTiming& Timing() const {
|
|
return mTiming;
|
|
}
|
|
AnimationTiming& Timing() {
|
|
return mTiming;
|
|
}
|
|
|
|
// Return the duration from the start the active interval to the point where
|
|
// the animation begins playback. This is zero unless the animation has
|
|
// a negative delay in which case it is the absolute value of the delay.
|
|
// This is used for setting the elapsedTime member of CSS AnimationEvents.
|
|
TimeDuration InitialAdvance() const {
|
|
return std::max(TimeDuration(), mTiming.mDelay * -1);
|
|
}
|
|
|
|
Nullable<TimeDuration> GetLocalTime() const {
|
|
// Since the *animation* start time is currently always zero, the local
|
|
// time is equal to the parent time.
|
|
return mParentTime;
|
|
}
|
|
|
|
// This function takes as input the timing parameters of an animation and
|
|
// returns the computed timing at the specified local time.
|
|
//
|
|
// The local time may be null in which case only static parameters such as the
|
|
// active duration are calculated. All other members of the returned object
|
|
// are given a null/initial value.
|
|
//
|
|
// This function returns ComputedTiming::kNullProgress for the mProgress
|
|
// member of the return value if the animation should not be run
|
|
// (because it is not currently active and is not filling at this time).
|
|
static ComputedTiming
|
|
GetComputedTimingAt(const Nullable<TimeDuration>& aLocalTime,
|
|
const AnimationTiming& aTiming);
|
|
|
|
// Shortcut for that gets the computed timing using the current local time as
|
|
// calculated from the timeline time.
|
|
ComputedTiming GetComputedTiming(const AnimationTiming* aTiming
|
|
= nullptr) const {
|
|
return GetComputedTimingAt(GetLocalTime(), aTiming ? *aTiming : mTiming);
|
|
}
|
|
|
|
// Return the duration of the active interval for the given timing parameters.
|
|
static StickyTimeDuration
|
|
ActiveDuration(const AnimationTiming& aTiming);
|
|
|
|
// After transitions finish they need to be retained in order to
|
|
// address the issue described in
|
|
// https://lists.w3.org/Archives/Public/www-style/2015Jan/0444.html .
|
|
// However, finished transitions are ignored for many purposes.
|
|
bool IsFinishedTransition() const {
|
|
return mIsFinishedTransition;
|
|
}
|
|
|
|
void SetIsFinishedTransition(bool aIsFinished) {
|
|
MOZ_ASSERT(AsTransition(),
|
|
"Calling SetIsFinishedTransition but it's not a transition");
|
|
mIsFinishedTransition = aIsFinished;
|
|
}
|
|
|
|
bool IsInPlay(const Animation& aAnimation) const;
|
|
bool IsCurrent(const Animation& aAnimation) const;
|
|
bool IsInEffect() const;
|
|
|
|
const AnimationProperty*
|
|
GetAnimationOfProperty(nsCSSProperty aProperty) const;
|
|
bool HasAnimationOfProperty(nsCSSProperty aProperty) const {
|
|
return GetAnimationOfProperty(aProperty) != nullptr;
|
|
}
|
|
bool HasAnimationOfProperties(const nsCSSProperty* aProperties,
|
|
size_t aPropertyCount) const;
|
|
const InfallibleTArray<AnimationProperty>& Properties() const {
|
|
return mProperties;
|
|
}
|
|
InfallibleTArray<AnimationProperty>& Properties() {
|
|
return mProperties;
|
|
}
|
|
|
|
// Updates |aStyleRule| with the animation values produced by this
|
|
// Animation for the current time except any properties already contained
|
|
// in |aSetProperties|.
|
|
// Any updated properties are added to |aSetProperties|.
|
|
void ComposeStyle(nsRefPtr<AnimValuesStyleRule>& aStyleRule,
|
|
nsCSSPropertySet& aSetProperties);
|
|
|
|
protected:
|
|
virtual ~KeyframeEffectReadOnly() { }
|
|
|
|
nsCOMPtr<Element> mTarget;
|
|
Nullable<TimeDuration> mParentTime;
|
|
|
|
AnimationTiming mTiming;
|
|
// A flag to mark transitions that have finished and are due to
|
|
// be removed on the next throttle-able cycle.
|
|
bool mIsFinishedTransition;
|
|
nsCSSPseudoElements::Type mPseudoType;
|
|
|
|
InfallibleTArray<AnimationProperty> mProperties;
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_dom_KeyframeEffect_h
|