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 "wtf/ListHashSet.h"
  30 #include "wtf/RefCounted.h"
  31 #include "wtf/RefPtr.h"
  32 #include "wtf/Vector.h"
  33 #include "wtf/text/StringImpl.h"
  34
  35 namespace WebCore {
  36
  37 class Document;
  38 class Event;
  39 class EventTarget;
  40 class RequestAnimationFrameCallback;
  41
  42 class ScriptedAnimationController : public RefCounted<ScriptedAnimationController> {
  43 public:
  44     static PassRefPtr<ScriptedAnimationController> create(Document* document)
  45     {
  46         return adoptRef(new ScriptedAnimationController(document));
  47     }
  48     ~ScriptedAnimationController();
  49     void clearDocumentPointer() { m_document = 0; }
  50
  51     typedef int CallbackId;
  52
  53     int registerCallback(PassOwnPtr<RequestAnimationFrameCallback>);
  54     void cancelCallback(CallbackId);
  55     void serviceScriptedAnimations(double monotonicTimeNow);
  56
  57     void enqueueEvent(PassRefPtr<Event>);
  58     void enqueuePerFrameEvent(PassRefPtr<Event>);
  59
  60     void suspend();
  61     void resume();
  62
  63 private:
  64     explicit ScriptedAnimationController(Document*);
  65
  66     void scheduleAnimationIfNeeded();
  67
  68     void dispatchEvents();
  69     void executeCallbacks(double monotonicTimeNow);
  70
  71     typedef Vector<OwnPtr<RequestAnimationFrameCallback> > CallbackList;
  72     CallbackList m_callbacks;
  73     CallbackList m_callbacksToInvoke; // only non-empty while inside executeCallbacks
  74
  75     Document* m_document;
  76     CallbackId m_nextCallbackId;
  77     int m_suspendCount;
  78     Vector<RefPtr<Event> > m_eventQueue;
  79     ListHashSet<std::pair<const EventTarget*, const StringImpl*> > m_perFrameEvents;
  80 };
  81
  82 }
  83
  84 #endif // ScriptedAnimationController_h