src/third_party/WebKit/Source/core/dom/ScriptedAnimationController.h

   1 /*
   2  * Copyright (C) 2011 Google Inc. All Rights Reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  *  THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  *  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  *  DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  *  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  *  ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  *
  24  */
  25
  26 #ifndef ScriptedAnimationController_h
  27 #define ScriptedAnimationController_h
  28
  29 #include "platform/heap/Handle.h"
  30 #include "wtf/ListHashSet.h"
  31 #include "wtf/RefCounted.h"
  32 #include "wtf/RefPtr.h"
  33 #include "wtf/Vector.h"
  34 #include "wtf/text/StringImpl.h"
  35
  36 namespace blink {
  37
  38 class Document;
  39 class Event;
  40 class EventTarget;
  41 class MediaQueryListListener;
  42 class RequestAnimationFrameCallback;
  43
  44 class ScriptedAnimationController : public RefCountedWillBeGarbageCollectedFinalized<ScriptedAnimationController> {
  45 public:
  46     static PassRefPtrWillBeRawPtr<ScriptedAnimationController> create(Document* document)
  47     {
  48         return adoptRefWillBeNoop(new ScriptedAnimationController(document));
  49     }
  50     ~ScriptedAnimationController();
  51     void trace(Visitor*);
  52     void clearDocumentPointer() { m_document = nullptr; }
  53
  54     typedef int CallbackId;
  55
  56     int registerCallback(RequestAnimationFrameCallback*);
  57     void cancelCallback(CallbackId);
  58     void serviceScriptedAnimations(double monotonicTimeNow);
  59
  60     void enqueueEvent(PassRefPtrWillBeRawPtr<Event>);
  61     void enqueuePerFrameEvent(PassRefPtrWillBeRawPtr<Event>);
  62     void enqueueMediaQueryChangeListeners(WillBeHeapVector<RefPtrWillBeMember<MediaQueryListListener> >&);
  63
  64     void suspend();
  65     void resume();
  66
  67     void dispatchEventsAndCallbacksForPrinting();
  68 private:
  69     explicit ScriptedAnimationController(Document*);
  70
  71     void scheduleAnimationIfNeeded();
  72
  73     void dispatchEvents();
  74     void executeCallbacks(double monotonicTimeNow);
  75     void callMediaQueryListListeners();
  76
  77     typedef PersistentHeapVectorWillBeHeapVector<Member<RequestAnimationFrameCallback> > CallbackList;
  78     CallbackList m_callbacks;
  79     CallbackList m_callbacksToInvoke; // only non-empty while inside executeCallbacks
  80
  81     RawPtrWillBeMember<Document> m_document;
  82     CallbackId m_nextCallbackId;
  83     int m_suspendCount;
  84     WillBeHeapVector<RefPtrWillBeMember<Event> > m_eventQueue;
  85     WillBeHeapListHashSet<std::pair<RawPtrWillBeMember<const EventTarget>, const StringImpl*> > m_perFrameEvents;
  86     typedef WillBeHeapListHashSet<RefPtrWillBeMember<MediaQueryListListener> > MediaQueryListListeners;
  87     MediaQueryListListeners m_mediaQueryListListeners;
  88 };
  89
  90 }
  91
  92 #endif // ScriptedAnimationController_h