Source/WebCore/page/FrameActionScheduler.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  *  * Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  *  * 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 THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef FrameActionScheduler_h
  27 #define FrameActionScheduler_h
  28
  29 #include <wtf/FastAllocBase.h>
  30 #include <wtf/Noncopyable.h>
  31 #include <wtf/OwnPtr.h>
  32 #include <wtf/PassOwnPtr.h>
  33 #include <wtf/Vector.h>
  34
  35 namespace WebCore {
  36
  37 class Node;
  38 class Event;
  39
  40 class FrameAction {
  41     WTF_MAKE_FAST_ALLOCATED;
  42     WTF_MAKE_NONCOPYABLE(FrameAction);
  43 public:
  44     FrameAction() {}
  45     virtual ~FrameAction() {}
  46     virtual void fire() = 0;
  47 };
  48
  49 class FrameActionScheduler {
  50 public:
  51     FrameActionScheduler();
  52     ~FrameActionScheduler();
  53
  54     bool isEmpty() const;
  55     bool isScheduled() const { return 0 < m_enqueueActions; }
  56     void clear();
  57     void pause();
  58     void resume();
  59
  60     void scheduleAction(PassOwnPtr<FrameAction>);
  61     void scheduleEvent(PassRefPtr<Event>, PassRefPtr<Node>);
  62
  63 private:
  64     void dispatch();
  65
  66     unsigned m_enqueueActions;
  67     Vector< OwnPtr<FrameAction> > m_scheduledActions;
  68 };
  69
  70 } // namespace WebCore
  71
  72 #endif // FrameActionScheduler_h