Return a Promise from HTMLMediaElement.play()
[WebKit-https.git] / 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 #ifndef GenericEventQueue_h
27 #define GenericEventQueue_h
28
29 #include "GenericTaskQueue.h"
30 #include <wtf/Deque.h>
31 #include <wtf/Forward.h>
32 #include <wtf/RefPtr.h>
33 #include <wtf/WeakPtr.h>
34
35 namespace WebCore {
36
37 class Event;
38 class EventTarget;
39 class Timer;
40
41 class GenericEventQueue {
42 public:
43     explicit GenericEventQueue(EventTarget&);
44     ~GenericEventQueue();
45
46     void enqueueEvent(RefPtr<Event>&&);
47     void close();
48
49     void cancelAllEvents();
50     bool hasPendingEvents() const;
51
52     void suspend();
53     void resume();
54
55 private:
56     void dispatchOneEvent();
57
58     EventTarget& m_owner;
59     GenericTaskQueue<Timer> m_taskQueue;
60     Deque<RefPtr<Event>> m_pendingEvents;
61     bool m_isClosed;
62     bool m_isSuspended { false };
63 };
64
65 }
66
67 #endif