Source/WebCore/dom/GenericEventQueue.h

   1 /*
   2  * Copyright (C) 2012 Victor Carbune (victor@rosedu.org)
   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. ``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 APPLE INC. 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 #pragma once
  27
  28 #include "ActiveDOMObject.h"
  29 #include "GenericTaskQueue.h"
  30 #include <wtf/Deque.h>
  31 #include <wtf/Forward.h>
  32 #include <wtf/RefPtr.h>
  33 #include <wtf/UniqueRef.h>
  34
  35 namespace WebCore {
  36
  37 class Event;
  38 class EventTarget;
  39 class Timer;
  40 class ScriptExecutionContext;
  41
  42 template<typename T>
  43 class GenericEventQueueBase : public ActiveDOMObject {
  44     WTF_MAKE_FAST_ALLOCATED;
  45 public:
  46     explicit GenericEventQueueBase(EventTarget&);
  47     ~GenericEventQueueBase();
  48
  49     void enqueueEvent(RefPtr<Event>&&);
  50     void close();
  51
  52     void cancelAllEvents();
  53     bool hasPendingEvents() const;
  54     bool hasPendingEventsOfType(const AtomString&) const;
  55
  56     void setPaused(bool);
  57
  58     bool isSuspended() const { return m_isSuspended; }
  59
  60 private:
  61     void dispatchOneEvent();
  62
  63     const char* activeDOMObjectName() const final;
  64     void stop() final;
  65     void suspend(ReasonForSuspension) final;
  66     void resume() final;
  67
  68     void rescheduleAllEventsIfNeeded();
  69     bool isSuspendedOrPausedByClient() const { return m_isSuspended || m_isPausedByClient; }
  70
  71     EventTarget& m_owner;
  72     UniqueRef<GenericTaskQueue<T>> m_taskQueue;
  73     Deque<RefPtr<Event>> m_pendingEvents;
  74     bool m_isClosed { false };
  75     bool m_isPausedByClient { false };
  76     bool m_isSuspended { false };
  77 };
  78
  79 // All instances of MainThreadGenericEventQueue use a shared Timer for dispatching events.
  80 class MainThreadGenericEventQueue : public GenericEventQueueBase<Timer> {
  81 public:
  82     static UniqueRef<MainThreadGenericEventQueue> create(EventTarget&);
  83
  84 private:
  85     friend UniqueRef<MainThreadGenericEventQueue> WTF::makeUniqueRefWithoutFastMallocCheck<MainThreadGenericEventQueue, WebCore::EventTarget&>(WebCore::EventTarget&);
  86     explicit MainThreadGenericEventQueue(EventTarget& eventTarget)
  87         : GenericEventQueueBase<Timer>(eventTarget)
  88     {
  89     }
  90 };
  91
  92 class GenericEventQueue : public GenericEventQueueBase<ScriptExecutionContext> {
  93     WTF_MAKE_FAST_ALLOCATED;
  94 public:
  95     static UniqueRef<GenericEventQueue> create(EventTarget&);
  96
  97 private:
  98     friend UniqueRef<GenericEventQueue> WTF::makeUniqueRefWithoutFastMallocCheck<GenericEventQueue, WebCore::EventTarget&>(WebCore::EventTarget&);
  99     explicit GenericEventQueue(EventTarget& eventTarget)
 100         : GenericEventQueueBase<ScriptExecutionContext>(eventTarget)
 101     {
 102     }
 103 };
 104
 105 } // namespace WebCore