DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (1aeaa33a64f9)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
/* -*- 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_KeyframeEffectReadOnly_h
#define mozilla_dom_KeyframeEffectReadOnly_h

#include "nsChangeHint.h"
#include "nsCSSPropertyID.h"
#include "nsCSSPropertyIDSet.h"
#include "nsCSSValue.h"
#include "nsCycleCollectionParticipant.h"
#include "nsRefPtrHashtable.h"
#include "nsTArray.h"
#include "nsWrapperCache.h"
#include "mozilla/AnimationPerformanceWarning.h"
#include "mozilla/AnimationPropertySegment.h"
#include "mozilla/AnimationTarget.h"
#include "mozilla/Attributes.h"
#include "mozilla/ComputedTimingFunction.h"
#include "mozilla/EffectCompositor.h"
#include "mozilla/Keyframe.h"
#include "mozilla/KeyframeEffectParams.h"
// RawServoDeclarationBlock and associated RefPtrTraits
#include "mozilla/ServoBindingTypes.h"
#include "mozilla/StyleAnimationValue.h"
#include "mozilla/dom/AnimationEffectReadOnly.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/Element.h"

struct JSContext;
class JSObject;
class nsIContent;
class nsIDocument;
class nsIFrame;
class nsIPresShell;

namespace mozilla {

class AnimValuesStyleRule;
enum class CSSPseudoElementType : uint8_t;
class ErrorResult;
struct AnimationRule;
struct TimingParams;
class EffectSet;
class ServoStyleContext;
class GeckoStyleContext;

namespace dom {
class ElementOrCSSPseudoElement;
class GlobalObject;
class OwningElementOrCSSPseudoElement;
class UnrestrictedDoubleOrKeyframeAnimationOptions;
class UnrestrictedDoubleOrKeyframeEffectOptions;
enum class IterationCompositeOperation : uint8_t;
enum class CompositeOperation : uint8_t;
struct AnimationPropertyDetails;
}  // namespace dom

struct AnimationProperty {
  nsCSSPropertyID mProperty = eCSSProperty_UNKNOWN;

  // If true, the propery is currently being animated on the compositor.
  //
  // Note that when the owning Animation requests a non-throttled restyle, in
  // between calling RequestRestyle on its EffectCompositor and when the
  // restyle is performed, this member may temporarily become false even if
  // the animation remains on the layer after the restyle.
  //
  // **NOTE**: This member is not included when comparing AnimationProperty
  // objects for equality.
  bool mIsRunningOnCompositor = false;

  Maybe<AnimationPerformanceWarning> mPerformanceWarning;

  InfallibleTArray<AnimationPropertySegment> mSegments;

  // The copy constructor/assignment doesn't copy mIsRunningOnCompositor and
  // mPerformanceWarning.
  AnimationProperty() = default;
  AnimationProperty(const AnimationProperty& aOther)
      : mProperty(aOther.mProperty), mSegments(aOther.mSegments) {}
  AnimationProperty& operator=(const AnimationProperty& aOther) {
    mProperty = aOther.mProperty;
    mSegments = aOther.mSegments;
    return *this;
  }

  // NOTE: This operator does *not* compare the mIsRunningOnCompositor member.
  // This is because AnimationProperty objects are compared when recreating
  // CSS animations to determine if mutation observer change records need to
  // be created or not. However, at the point when these objects are compared
  // the mIsRunningOnCompositor will not have been set on the new objects so
  // we ignore this member to avoid generating spurious change records.
  bool operator==(const AnimationProperty& aOther) const {
    return mProperty == aOther.mProperty && mSegments == aOther.mSegments;
  }
  bool operator!=(const AnimationProperty& aOther) const {
    return !(*this == aOther);
  }
};

struct ElementPropertyTransition;

namespace dom {

class Animation;

class KeyframeEffectReadOnly : public AnimationEffectReadOnly {
 public:
  KeyframeEffectReadOnly(nsIDocument* aDocument,
                         const Maybe<OwningAnimationTarget>& aTarget,
                         const TimingParams& aTiming,
                         const KeyframeEffectParams& aOptions);

  NS_DECL_ISUPPORTS_INHERITED
  NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(
      KeyframeEffectReadOnly, AnimationEffectReadOnly)

  virtual JSObject* WrapObject(JSContext* aCx,
                               JS::Handle<JSObject*> aGivenProto) override;

  KeyframeEffectReadOnly* AsKeyframeEffect() override { return this; }

  // KeyframeEffectReadOnly interface
  static already_AddRefed<KeyframeEffectReadOnly> Constructor(
      const GlobalObject& aGlobal,
      const Nullable<ElementOrCSSPseudoElement>& aTarget,
      JS::Handle<JSObject*> aKeyframes,
      const UnrestrictedDoubleOrKeyframeEffectOptions& aOptions,
      ErrorResult& aRv);

  static already_AddRefed<KeyframeEffectReadOnly> Constructor(
      const GlobalObject& aGlobal, KeyframeEffectReadOnly& aSource,
      ErrorResult& aRv);

  void GetTarget(Nullable<OwningElementOrCSSPseudoElement>& aRv) const;
  Maybe<NonOwningAnimationTarget> GetTarget() const {
    Maybe<NonOwningAnimationTarget> result;
    if (mTarget) {
      result.emplace(*mTarget);
    }
    return result;
  }
  void GetKeyframes(JSContext*& aCx, nsTArray<JSObject*>& aResult,
                    ErrorResult& aRv);
  void GetProperties(nsTArray<AnimationPropertyDetails>& aProperties,
                     ErrorResult& aRv) const;

  IterationCompositeOperation IterationComposite() const;
  CompositeOperation Composite() const;
  void NotifyAnimationTimingUpdated();
  void RequestRestyle(EffectCompositor::RestyleType aRestyleType);
  void SetAnimation(Animation* aAnimation) override;
  void SetKeyframes(JSContext* aContext, JS::Handle<JSObject*> aKeyframes,
                    ErrorResult& aRv);
#ifdef MOZ_OLD_STYLE
  void SetKeyframes(nsTArray<Keyframe>&& aKeyframes,
                    GeckoStyleContext* aStyleContext);
#endif
  void SetKeyframes(nsTArray<Keyframe>&& aKeyframes,
                    const ServoStyleContext* aComputedValues);

  // Returns true if the effect includes |aProperty| regardless of whether the
  // property is overridden by !important rule.
  bool HasAnimationOfProperty(nsCSSPropertyID aProperty) const;

  // GetEffectiveAnimationOfProperty returns AnimationProperty corresponding
  // to a given CSS property if the effect includes the property and the
  // property is not overridden by !important rules.
  // Also EffectiveAnimationOfProperty returns true under the same condition.
  //
  // NOTE: We don't currently check for !important rules for properties that
  // can't run on the compositor.
  bool HasEffectiveAnimationOfProperty(nsCSSPropertyID aProperty) const {
    return GetEffectiveAnimationOfProperty(aProperty) != nullptr;
  }
  const AnimationProperty* GetEffectiveAnimationOfProperty(
      nsCSSPropertyID aProperty) const;

  const InfallibleTArray<AnimationProperty>& Properties() const {
    return mProperties;
  }

  // Update |mProperties| by recalculating from |mKeyframes| using
  // |aStyleContext| to resolve specified values.
  void UpdateProperties(nsStyleContext* aStyleContext);
  // Servo version of the above function.
  void UpdateProperties(const ServoStyleContext* aComputedValues);

  // Update various bits of state related to running ComposeStyle().
  // We need to update this outside ComposeStyle() because we should avoid
  // mutating any state in ComposeStyle() since it might be called during
  // parallel traversal.
  void WillComposeStyle();

  // Updates |aComposeResult| with the animation values produced by this
  // AnimationEffect for the current time except any properties contained
  // in |aPropertiesToSkip|.
  template <typename ComposeAnimationResult>
  void ComposeStyle(ComposeAnimationResult&& aRestultContainer,
                    const nsCSSPropertyIDSet& aPropertiesToSkip);

#ifdef MOZ_OLD_STYLE
  // Composite |aValueToComposite| on |aUnderlyingValue| with
  // |aCompositeOperation|.
  // Returns |aValueToComposite| if |aCompositeOperation| is Replace.
  static StyleAnimationValue CompositeValue(
      nsCSSPropertyID aProperty, const StyleAnimationValue& aValueToComposite,
      const StyleAnimationValue& aUnderlyingValue,
      CompositeOperation aCompositeOperation);
#endif

  // Returns true if at least one property is being animated on compositor.
  bool IsRunningOnCompositor() const;
  void SetIsRunningOnCompositor(nsCSSPropertyID aProperty, bool aIsRunning);
  void ResetIsRunningOnCompositor();

  // Returns true if this effect, applied to |aFrame|, contains properties
  // that mean we shouldn't run transform compositor animations on this element.
  //
  // For example, if we have an animation of geometric properties like 'left'
  // and 'top' on an element, we force all 'transform' animations running at
  // the same time on the same element to run on the main thread.
  //
  // When returning true, |aPerformanceWarning| stores the reason why
  // we shouldn't run the transform animations.
  bool ShouldBlockAsyncTransformAnimations(
      const nsIFrame* aFrame,
      AnimationPerformanceWarning::Type& aPerformanceWarning) const;
  bool HasGeometricProperties() const;
  bool AffectsGeometry() const override {
    return GetTarget() && HasGeometricProperties();
  }

  nsIDocument* GetRenderedDocument() const;
  nsIPresShell* GetPresShell() const;

  // Associates a warning with the animated property on the specified frame
  // indicating why, for example, the property could not be animated on the
  // compositor. |aParams| and |aParamsLength| are optional parameters which
  // will be used to generate a localized message for devtools.
  void SetPerformanceWarning(nsCSSPropertyID aProperty,
                             const AnimationPerformanceWarning& aWarning);

  // Cumulative change hint on each segment for each property.
  // This is used for deciding the animation is paint-only.
  template <typename StyleType>
  void CalculateCumulativeChangeHint(StyleType* aStyleContext);

  // Returns true if all of animation properties' change hints
  // can ignore painting if the animation is not visible.
  // See nsChangeHint_Hints_CanIgnoreIfNotVisible in nsChangeHint.h
  // in detail which change hint can be ignored.
  bool CanIgnoreIfNotVisible() const;

  // Returns true if the effect is current state and has scale animation.
  // |aFrame| is used for calculation of scale values.
  bool ContainsAnimatedScale(const nsIFrame* aFrame) const;

  AnimationValue BaseStyle(nsCSSPropertyID aProperty) const {
    AnimationValue result;
    bool hasProperty = false;
    if (mDocument->IsStyledByServo()) {
      // We cannot use getters_AddRefs on RawServoAnimationValue because it is
      // an incomplete type, so Get() doesn't work. Instead, use GetWeak, and
      // then assign the raw pointer to a RefPtr.
      result.mServo = mBaseStyleValuesForServo.GetWeak(aProperty, &hasProperty);
    } else {
#ifdef MOZ_OLD_STYLE
      hasProperty = mBaseStyleValues.Get(aProperty, &result.mGecko);
#else
      MOZ_CRASH("old style system disabled");
#endif
    }
    MOZ_ASSERT(hasProperty || result.IsNull());
    return result;
  }

 protected:
  KeyframeEffectReadOnly(nsIDocument* aDocument,
                         const Maybe<OwningAnimationTarget>& aTarget,
                         AnimationEffectTimingReadOnly* aTiming,
                         const KeyframeEffectParams& aOptions);

  ~KeyframeEffectReadOnly() override = default;

  static Maybe<OwningAnimationTarget> ConvertTarget(
      const Nullable<ElementOrCSSPseudoElement>& aTarget);

  template <class KeyframeEffectType, class OptionsType>
  static already_AddRefed<KeyframeEffectType> ConstructKeyframeEffect(
      const GlobalObject& aGlobal,
      const Nullable<ElementOrCSSPseudoElement>& aTarget,
      JS::Handle<JSObject*> aKeyframes, const OptionsType& aOptions,
      ErrorResult& aRv);

  template <class KeyframeEffectType>
  static already_AddRefed<KeyframeEffectType> ConstructKeyframeEffect(
      const GlobalObject& aGlobal, KeyframeEffectReadOnly& aSource,
      ErrorResult& aRv);

  // Build properties by recalculating from |mKeyframes| using |aStyleContext|
  // to resolve specified values. This function also applies paced spacing if
  // needed.
  template <typename StyleType>
  nsTArray<AnimationProperty> BuildProperties(StyleType* aStyle);

  // This effect is registered with its target element so long as:
  //
  // (a) It has a target element, and
  // (b) It is "relevant" (i.e. yet to finish but not idle, or finished but
  //     filling forwards)
  //
  // As a result, we need to make sure this gets called whenever anything
  // changes with regards to this effects's timing including changes to the
  // owning Animation's timing.
  void UpdateTargetRegistration();

  // Remove the current effect target from its EffectSet.
  void UnregisterTarget();

  // Update the associated frame state bits so that, if necessary, a stacking
  // context will be created and the effect sent to the compositor.  We
  // typically need to do this when the properties referenced by the keyframe
  // have changed, or when the target frame might have changed.
  void MaybeUpdateFrameForCompositor();

  // Looks up the style context associated with the target element, if any.
  // We need to be careful to *not* call this when we are updating the style
  // context. That's because calling GetStyleContext when we are in the process
  // of building a style context may trigger various forms of infinite
  // recursion.
  already_AddRefed<nsStyleContext> GetTargetStyleContext();

  // A wrapper for marking cascade update according to the current
  // target and its effectSet.
  void MarkCascadeNeedsUpdate();

#ifdef MOZ_OLD_STYLE
  // Composites |aValueToComposite| using |aCompositeOperation| onto the value
  // for |aProperty| in |aAnimationRule|, or, if there is no suitable value in
  // |aAnimationRule|, uses the base value for the property recorded on the
  // target element's EffectSet.
  StyleAnimationValue CompositeValue(
      nsCSSPropertyID aProperty,
      const RefPtr<AnimValuesStyleRule>& aAnimationRule,
      const StyleAnimationValue& aValueToComposite,
      CompositeOperation aCompositeOperation);

  // Returns underlying style animation value for |aProperty|.
  StyleAnimationValue GetUnderlyingStyle(
      nsCSSPropertyID aProperty,
      const RefPtr<AnimValuesStyleRule>& aAnimationRule);

  // Ensure the base styles is available for any properties in |aProperties|.
  void EnsureBaseStyles(GeckoStyleContext* aStyleContext,
                        const nsTArray<AnimationProperty>& aProperties);
#endif
  void EnsureBaseStyles(const ServoStyleContext* aComputedValues,
                        const nsTArray<AnimationProperty>& aProperties);

#ifdef MOZ_OLD_STYLE
  // If no base style is already stored for |aProperty|, resolves the base style
  // for |aProperty| using |aStyleContext| and stores it in mBaseStyleValues.
  // If |aCachedBaseStyleContext| is non-null, it will be used, otherwise the
  // base style context will be resolved and stored in
  // |aCachedBaseStyleContext|.
  void EnsureBaseStyle(nsCSSPropertyID aProperty,
                       GeckoStyleContext* aStyleContext,
                       RefPtr<GeckoStyleContext>& aCachedBaseStyleContext);
#endif
  // Stylo version of the above function that also first checks for an additive
  // value in |aProperty|'s list of segments.
  void EnsureBaseStyle(const AnimationProperty& aProperty,
                       nsPresContext* aPresContext,
                       const ServoStyleContext* aComputedValues,
                       RefPtr<mozilla::ServoStyleContext>& aBaseComputedValues);

  Maybe<OwningAnimationTarget> mTarget;

  KeyframeEffectParams mEffectOptions;

  // The specified keyframes.
  nsTArray<Keyframe> mKeyframes;

  // A set of per-property value arrays, derived from |mKeyframes|.
  nsTArray<AnimationProperty> mProperties;

  // The computed progress last time we composed the style rule. This is
  // used to detect when the progress is not changing (e.g. due to a step
  // timing function) so we can avoid unnecessary style updates.
  Nullable<double> mProgressOnLastCompose;

  // The purpose of this value is the same as mProgressOnLastCompose but
  // this is used to detect when the current iteration is not changing
  // in the case when iterationComposite is accumulate.
  uint64_t mCurrentIterationOnLastCompose = 0;

  // We need to track when we go to or from being "in effect" since
  // we need to re-evaluate the cascade of animations when that changes.
  bool mInEffectOnLastAnimationTimingUpdate;

  // The non-animated values for properties in this effect that contain at
  // least one animation value that is composited with the underlying value
  // (i.e. it uses the additive or accumulate composite mode).
#ifdef MOZ_OLD_STYLE
  nsDataHashtable<nsUint32HashKey, StyleAnimationValue> mBaseStyleValues;
#endif
  nsRefPtrHashtable<nsUint32HashKey, RawServoAnimationValue>
      mBaseStyleValuesForServo;

  // True if this effect is in the EffectSet for its target element. This is
  // used as an optimization to avoid unnecessary hashmap lookups on the
  // EffectSet.
  bool mInEffectSet = false;

 private:
  nsChangeHint mCumulativeChangeHint;

  template <typename StyleType>
  void DoSetKeyframes(nsTArray<Keyframe>&& aKeyframes, StyleType* aStyle);

  template <typename StyleType>
  void DoUpdateProperties(StyleType* aStyle);

#ifdef MOZ_OLD_STYLE
  void ComposeStyleRule(RefPtr<AnimValuesStyleRule>& aStyleRule,
                        const AnimationProperty& aProperty,
                        const AnimationPropertySegment& aSegment,
                        const ComputedTiming& aComputedTiming);
#endif

  void ComposeStyleRule(RawServoAnimationValueMap& aAnimationValues,
                        const AnimationProperty& aProperty,
                        const AnimationPropertySegment& aSegment,
                        const ComputedTiming& aComputedTiming);

#ifdef MOZ_OLD_STYLE
  already_AddRefed<nsStyleContext> CreateStyleContextForAnimationValue(
      nsCSSPropertyID aProperty, const AnimationValue& aValue,
      GeckoStyleContext* aBaseStyleContext);
#endif

  already_AddRefed<nsStyleContext> CreateStyleContextForAnimationValue(
      nsCSSPropertyID aProperty, const AnimationValue& aValue,
      const ServoStyleContext* aBaseStyleContext);

  nsIFrame* GetAnimationFrame() const;

  bool CanThrottle() const;
  bool CanThrottleTransformChanges(const nsIFrame& aFrame) const;
  bool CanThrottleTransformChangesInScrollable(nsIFrame& aFrame) const;

  // Returns true if the computedTiming has changed since the last
  // composition.
  bool HasComputedTimingChanged() const;

  // Returns true unless Gecko limitations prevent performing transform
  // animations for |aFrame|. When returning true, the reason for the
  // limitation is stored in |aOutPerformanceWarning|.
  static bool CanAnimateTransformOnCompositor(
      const nsIFrame* aFrame,
      AnimationPerformanceWarning::Type& aPerformanceWarning);
  static bool IsGeometricProperty(const nsCSSPropertyID aProperty);

  static const TimeDuration OverflowRegionRefreshInterval();

  void UpdateEffectSet(mozilla::EffectSet* aEffectSet = nullptr) const;

  // Returns true if this effect has transform and the transform might affect
  // the overflow region.
  // This function is used for updating scroll bars or notifying intersection
  // observers reflected by the transform.
  bool HasTransformThatMightAffectOverflow() const {
    return mCumulativeChangeHint & (nsChangeHint_UpdatePostTransformOverflow |
                                    nsChangeHint_AddOrRemoveTransform |
                                    nsChangeHint_UpdateTransformLayer);
  }

  // FIXME: This flag will be removed in bug 1324966.
  bool mIsComposingStyle = false;

  // Returns true if this effect causes visibility change.
  // (i.e. 'visibility: hidden' -> 'visibility: visible' and vice versa.)
  bool HasVisibilityChange() const {
    return mCumulativeChangeHint & nsChangeHint_VisibilityChange;
  }
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_KeyframeEffectReadOnly_h