Web Animations: Make AnimationPlayer an ActiveDOMObject

Source/core/animation/AnimationPlayer.cpp

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 30 matching lines @@
 namespace {
 
 static unsigned nextSequenceNumber()
 {
     static unsigned next = 0;
     return ++next;
 }
 
 }
 
-PassRefPtrWillBeRawPtr<AnimationPlayer> AnimationPlayer::create(AnimationTimeline& timeline, AnimationSource* content)
+PassRefPtrWillBeRawPtr<AnimationPlayer> AnimationPlayer::create(ExecutionContext& executionContext, AnimationTimeline& timeline, AnimationSource* content)
 {
-    return adoptRefWillBeRefCountedGarbageCollected(new AnimationPlayer(timeline, content));
+    RefPtrWillBeRawPtr<AnimationPlayer> player = adoptRefWillBeRefCountedGarbageCollected(new AnimationPlayer(executionContext, timeline, content));
+    player->suspendIfNeeded();
+    return player.release();
 }
 
-AnimationPlayer::AnimationPlayer(AnimationTimeline& timeline, AnimationSource* content)
-    : m_playbackRate(1)
+AnimationPlayer::AnimationPlayer(ExecutionContext& executionContext, AnimationTimeline& timeline, AnimationSource* content)
+    : ActiveDOMObject(&executionContext)
+    , m_playbackRate(1)
     , m_startTime(nullValue())
     , m_holdTime(nullValue())
     , m_storedTimeLag(0)
     , m_sortInfo(nextSequenceNumber(), timeline.effectiveTime())
     , m_content(content)
     , m_timeline(&timeline)
     , m_paused(false)
     , m_held(false)
     , m_isPausedForTesting(false)
     , m_outdated(true)
@@ skipping 210 matching lines @@
     cancelAnimationOnCompositor();
 }
 
 const AtomicString& AnimationPlayer::interfaceName() const
 {
     return EventTargetNames::AnimationPlayer;
 }
 
 ExecutionContext* AnimationPlayer::executionContext() const
 {
-    if (m_timeline) {
-        if (Document* document = m_timeline->document())
-            return document->contextDocument().get();
-    }
-    return 0;
+    return ActiveDOMObject::executionContext();
+}
+
+bool AnimationPlayer::hasPendingActivity() const
+{
+    return m_pendingFinishedEvent || (!m_finished && hasEventListeners(EventTypeNames::finish));
+}
+
+void AnimationPlayer::stop()
+{
+    m_pendingFinishedEvent = nullptr;

[haraken, 2014/05/26 01:16:09]

Just to confirm: You don't need to change m_finished to true, right?

[dstockwell, 2014/05/26 01:32:40]

Correct, this is not needed here.

[dstockwell, 2014/05/30 09:28:21]

I was wrong. I thought m_finished only needed to become true to dispatch the
event, but we do need to set it here in order to satisfy the conditions of
hasPendingActivity() correctly after stop(). That's the reason for the leak.

Will send a followup patch.

+}
+
+bool AnimationPlayer::dispatchEvent(PassRefPtrWillBeRawPtr<Event> event)
+{
+    if (m_pendingFinishedEvent == event)
+        m_pendingFinishedEvent = nullptr;
+    return EventTargetWithInlineData::dispatchEvent(event);
 }
 
 void AnimationPlayer::setPlaybackRate(double playbackRate)
 {
     if (!std::isfinite(playbackRate))
         return;
     double storedCurrentTime = currentTimeInternal();
     if ((m_playbackRate < 0 && playbackRate >= 0) || (m_playbackRate > 0 && playbackRate <= 0))
         m_finished = false;
     m_playbackRate = playbackRate;
@@ skipping 57 matching lines @@
 
     if (m_content) {
         double inheritedTime = isNull(m_timeline->currentTimeInternal()) ? nullValue() : currentTimeInternal();
         m_content->updateInheritedTime(inheritedTime, reason);
     }
 
     if (finished() && !m_finished) {
         if (reason == TimingUpdateForAnimationFrame && hasStartTime()) {
             const AtomicString& eventType = EventTypeNames::finish;
             if (executionContext() && hasEventListeners(eventType)) {
-                RefPtrWillBeRawPtr<AnimationPlayerEvent> event = AnimationPlayerEvent::create(eventType, currentTime(), timeline()->currentTime());
-                event->setTarget(this);
-                event->setCurrentTarget(this);
-                m_timeline->document()->enqueueAnimationFrameEvent(event.release());
+                m_pendingFinishedEvent = AnimationPlayerEvent::create(eventType, currentTime(), timeline()->currentTime());
+                m_pendingFinishedEvent->setTarget(this);
+                m_pendingFinishedEvent->setCurrentTarget(this);
+                m_timeline->document()->enqueueAnimationFrameEvent(m_pendingFinishedEvent);
             }
             m_finished = true;
         }
     }
     ASSERT(!m_outdated);
     return !m_finished || !finished();
 }
 
 double AnimationPlayer::timeToEffectChange()
 {
@@ skipping 47 matching lines @@
     pause();
 }
 
 void AnimationPlayer::trace(Visitor* visitor)
 {
     visitor->trace(m_content);
     visitor->trace(m_timeline);
 }
 
 } // namespace