Home | History | Annotate | Download | only in dom 
      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 WebCore {
     37 
     38 class Document;
     39 class Event;
     40 class EventTarget;
     41 class RequestAnimationFrameCallback;
     42 
     43 class ScriptedAnimationController : public RefCountedWillBeGarbageCollectedFinalized<ScriptedAnimationController> {
     44 public:
     45     static PassRefPtrWillBeRawPtr<ScriptedAnimationController> create(Document* document)
     46     {
     47         return adoptRefWillBeNoop(new ScriptedAnimationController(document));
     48     }
     49     ~ScriptedAnimationController();
     50     void trace(Visitor*);
     51     void clearDocumentPointer() { m_document = nullptr; }
     52 
     53     typedef int CallbackId;
     54 
     55     int registerCallback(PassOwnPtr<RequestAnimationFrameCallback>);
     56     void cancelCallback(CallbackId);
     57     void serviceScriptedAnimations(double monotonicTimeNow);
     58 
     59     void enqueueEvent(PassRefPtrWillBeRawPtr<Event>);
     60     void enqueuePerFrameEvent(PassRefPtrWillBeRawPtr<Event>);
     61 
     62     void suspend();
     63     void resume();
     64 
     65 private:
     66     explicit ScriptedAnimationController(Document*);
     67 
     68     void scheduleAnimationIfNeeded();
     69 
     70     void dispatchEvents();
     71     void executeCallbacks(double monotonicTimeNow);
     72 
     73     typedef Vector<OwnPtr<RequestAnimationFrameCallback> > CallbackList;
     74     CallbackList m_callbacks;
     75     CallbackList m_callbacksToInvoke; // only non-empty while inside executeCallbacks
     76 
     77     RawPtrWillBeMember<Document> m_document;
     78     CallbackId m_nextCallbackId;
     79     int m_suspendCount;
     80     WillBeHeapVector<RefPtrWillBeMember<Event> > m_eventQueue;
     81     WillBeHeapListHashSet<std::pair<RawPtrWillBeMember<const EventTarget>, const StringImpl*> > m_perFrameEvents;
     82 };
     83 
     84 }
     85 
     86 #endif // ScriptedAnimationController_h
     87