1/*
2 * Copyright (C) 2010 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 COMPUTER, 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 COMPUTER, 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
27#ifndef DocumentEventQueue_h
28#define DocumentEventQueue_h
29
30#include "core/dom/EventQueue.h"
31#include "wtf/Forward.h"
32#include "wtf/HashSet.h"
33#include "wtf/ListHashSet.h"
34#include "wtf/OwnPtr.h"
35#include "wtf/RefCounted.h"
36
37namespace WebCore {
38
39class Event;
40class DocumentEventQueueTimer;
41class Node;
42class ScriptExecutionContext;
43
44class DocumentEventQueue : public RefCounted<DocumentEventQueue>, public EventQueue {
45public:
46    enum ScrollEventTargetType {
47        ScrollEventDocumentTarget,
48        ScrollEventElementTarget
49    };
50
51    static PassRefPtr<DocumentEventQueue> create(ScriptExecutionContext*);
52    virtual ~DocumentEventQueue();
53
54    // EventQueue
55    virtual bool enqueueEvent(PassRefPtr<Event>) OVERRIDE;
56    virtual bool cancelEvent(Event*) OVERRIDE;
57    virtual void close() OVERRIDE;
58
59    void enqueueOrDispatchScrollEvent(PassRefPtr<Node>, ScrollEventTargetType);
60
61private:
62    explicit DocumentEventQueue(ScriptExecutionContext*);
63
64    void pendingEventTimerFired();
65    void dispatchEvent(PassRefPtr<Event>);
66
67    OwnPtr<DocumentEventQueueTimer> m_pendingEventTimer;
68    ListHashSet<RefPtr<Event>, 16> m_queuedEvents;
69    HashSet<Node*> m_nodesWithQueuedScrollEvents;
70    bool m_isClosed;
71
72    friend class DocumentEventQueueTimer;
73};
74
75}
76
77#endif // DocumentEventQueue_h
78