Generate bindings code for EventTarget.addEventListener() / removeEventListener()
[WebKit-https.git] / Source / WebCore / dom / EventListenerMap.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007, 2012 Apple Inc. All rights reserved.
6  * Copyright (C) 2006 Alexey Proskuryakov (ap@webkit.org)
7  *           (C) 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
8  * Copyright (C) 2011 Andreas Kling (kling@webkit.org)
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
27  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  *
31  */
32
33 #ifndef EventListenerMap_h
34 #define EventListenerMap_h
35
36 #include "RegisteredEventListener.h"
37 #include <atomic>
38 #include <memory>
39 #include <wtf/Forward.h>
40 #include <wtf/text/AtomicString.h>
41
42 namespace WebCore {
43
44 class EventTarget;
45
46 typedef Vector<RegisteredEventListener, 1> EventListenerVector;
47
48 class EventListenerMap {
49 public:
50     EventListenerMap();
51
52     bool isEmpty() const { return m_entries.isEmpty(); }
53     WEBCORE_EXPORT bool contains(const AtomicString& eventType) const;
54     bool containsCapturing(const AtomicString& eventType) const;
55
56     void clear();
57     bool add(const AtomicString& eventType, Ref<EventListener>&&, bool useCapture);
58     bool remove(const AtomicString& eventType, EventListener&, bool useCapture, size_t& indexOfRemovedListener);
59     EventListenerVector* find(const AtomicString& eventType);
60     Vector<AtomicString> eventTypes() const;
61
62     void removeFirstEventListenerCreatedFromMarkup(const AtomicString& eventType);
63     void copyEventListenersNotCreatedFromMarkupToTarget(EventTarget*);
64
65 private:
66     friend class EventListenerIterator;
67
68     void assertNoActiveIterators();
69
70     Vector<std::pair<AtomicString, std::unique_ptr<EventListenerVector>>, 2> m_entries;
71
72 #ifndef NDEBUG
73     std::atomic<int> m_activeIteratorCount { 0 };
74 #endif
75 };
76
77 class EventListenerIterator {
78     WTF_MAKE_NONCOPYABLE(EventListenerIterator);
79 public:
80     EventListenerIterator();
81     explicit EventListenerIterator(EventTarget*);
82 #ifndef NDEBUG
83     ~EventListenerIterator();
84 #endif
85
86     EventListener* nextListener();
87
88 private:
89     EventListenerMap* m_map { nullptr };
90     unsigned m_entryIndex { 0 };
91     unsigned m_index { 0 };
92 };
93
94 #ifdef NDEBUG
95 inline void EventListenerMap::assertNoActiveIterators() { }
96 #endif
97
98 } // namespace WebCore
99
100 #endif // EventListenerMap_h