Bug 1225699 part 1 - Add EffectSet class; r=smaug

dom/animation/EffectSet.cpp

@@ -0,0 +1,83 @@
+/* -*- 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/. */
+
+#include "EffectSet.h"
+#include "mozilla/dom/Element.h" // For Element
+
+namespace mozilla {
+
+/* static */ void
+EffectSet::PropertyDtor(void* aObject, nsIAtom* aPropertyName,
+                        void* aPropertyValue, void* aData)
+{
+  EffectSet* effectSet = static_cast<EffectSet*>(aPropertyValue);
+
+#ifdef DEBUG
+  MOZ_ASSERT(!effectSet->mCalledPropertyDtor, "Should not call dtor twice");
+  effectSet->mCalledPropertyDtor = true;
+#endif
+
+  delete effectSet;
+}
+
+/* static */ EffectSet*
+EffectSet::GetEffectSet(dom::Element* aElement,
+                        nsCSSPseudoElements::Type aPseudoType)
+{
+  nsIAtom* propName = GetEffectSetPropertyAtom(aPseudoType);
+  return static_cast<EffectSet*>(aElement->GetProperty(propName));
+}
+
+/* static */ EffectSet*
+EffectSet::GetOrCreateEffectSet(dom::Element* aElement,
+                                nsCSSPseudoElements::Type aPseudoType)
+{
+  EffectSet* effectSet = GetEffectSet(aElement, aPseudoType);
+  if (effectSet) {
+    return effectSet;
+  }
+
+  nsIAtom* propName = GetEffectSetPropertyAtom(aPseudoType);
+  effectSet = new EffectSet();
+
+  nsresult rv = aElement->SetProperty(propName, effectSet,
+                                      &EffectSet::PropertyDtor, false);
+  if (NS_FAILED(rv)) {
+    NS_WARNING("SetProperty failed");
+    // The set must be destroyed via PropertyDtor, otherwise
+    // mCalledPropertyDtor assertion is triggered in destructor.
+    EffectSet::PropertyDtor(aElement, propName, effectSet, nullptr);
+    return nullptr;
+  }
+
+  if (aPseudoType == nsCSSPseudoElements::ePseudo_NotPseudoElement) {
+    aElement->SetMayHaveAnimations();
+  }
+
+  return effectSet;
+}
+
+/* static */ nsIAtom*
+EffectSet::GetEffectSetPropertyAtom(nsCSSPseudoElements::Type aPseudoType)
+{
+  switch (aPseudoType) {
+    case nsCSSPseudoElements::ePseudo_NotPseudoElement:
+      return nsGkAtoms::animationEffectsProperty;
+
+    case nsCSSPseudoElements::ePseudo_before:
+      return nsGkAtoms::animationEffectsForBeforeProperty;
+
+    case nsCSSPseudoElements::ePseudo_after:
+      return nsGkAtoms::animationEffectsForAfterProperty;
+
+    default:
+      NS_NOTREACHED("Should not try to get animation effects for a pseudo "
+                    "other that :before or :after");
+      return nullptr;
+  }
+}
+
+} // namespace mozilla

dom/animation/EffectSet.h

@@ -0,0 +1,56 @@
+/* -*- 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_EffectSet_h
+#define mozilla_EffectSet_h
+
+#include "nsCSSPseudoElements.h" // For nsCSSPseudoElements::Type
+
+namespace mozilla {
+
+namespace dom {
+class Element;
+} // namespace dom
+
+// A wrapper around a hashset of AnimationEffect objects to handle
+// storing the set as a property of an element.
+class EffectSet
+{
+public:
+  EffectSet()
+#ifdef DEBUG
+    : mCalledPropertyDtor(false)
+#endif
+  {
+    MOZ_COUNT_CTOR(EffectSet);
+  }
+
+  ~EffectSet()
+  {
+    MOZ_ASSERT(mCalledPropertyDtor,
+               "must call destructor through element property dtor");
+    MOZ_COUNT_DTOR(EffectSet);
+  }
+  static void PropertyDtor(void* aObject, nsIAtom* aPropertyName,
+                           void* aPropertyValue, void* aData);
+
+  static EffectSet* GetEffectSet(dom::Element* aElement,
+                                 nsCSSPseudoElements::Type aPseudoType);
+  static EffectSet* GetOrCreateEffectSet(dom::Element* aElement,
+                                         nsCSSPseudoElements::Type aPseudoType);
+
+private:
+  static nsIAtom* GetEffectSetPropertyAtom(nsCSSPseudoElements::Type
+                                             aPseudoType);
+
+#ifdef DEBUG
+  bool mCalledPropertyDtor;
+#endif
+};
+
+} // namespace mozilla
+
+#endif // mozilla_EffectSet_h

dom/animation/moz.build

@@ -19,6 +19,7 @@ EXPORTS.mozilla += [
     'AnimationComparator.h',
     'AnimationUtils.h',
     'ComputedTimingFunction.h',
+    'EffectSet.h',
     'PendingAnimationTracker.h',
 ]
 
@@ -28,6 +29,7 @@ UNIFIED_SOURCES += [
     'AnimationTimeline.cpp',
     'ComputedTimingFunction.cpp',
     'DocumentTimeline.cpp',
+    'EffectSet.cpp',
     'KeyframeEffect.cpp',
     'PendingAnimationTracker.cpp',
 ]

dom/base/nsGkAtomList.h

@@ -2099,6 +2099,9 @@ GK_ATOM(ongamepaddisconnected, "ongamepaddisconnected")
 GK_ATOM(animationsProperty, "AnimationsProperty")        // FrameAnimations*
 GK_ATOM(animationsOfBeforeProperty, "AnimationsOfBeforeProperty") // FrameAnimations*
 GK_ATOM(animationsOfAfterProperty, "AnimationsOfAfterProperty") // FrameAnimations*
+GK_ATOM(animationEffectsProperty, "AnimationEffectsProperty") // EffectSet*
+GK_ATOM(animationEffectsForBeforeProperty, "AnimationsEffectsForBeforeProperty") // EffectSet*
+GK_ATOM(animationEffectsForAfterProperty, "AnimationsEffectsForAfterProperty") // EffectSet*
 GK_ATOM(transitionsProperty, "TransitionsProperty")        // FrameTransitions*
 GK_ATOM(transitionsOfBeforeProperty, "TransitionsOfBeforeProperty") // FrameTransitions*
 GK_ATOM(transitionsOfAfterProperty, "TransitionsOfAfterProperty") // FrameTransitions*