760e7d536b4ba4b55a396d2c0db5d75f2695349a
[WebKit-https.git] / Source / WebCore / dom / EventNames.h
1 /*
2  * Copyright (C) 2005, 2007, 2015 Apple Inc. All rights reserved.
3  * Copyright (C) 2006 Jon Shier (jshier@iastate.edu)
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #ifndef EventNames_h
23 #define EventNames_h
24
25 #include "ThreadGlobalData.h"
26 #include <array>
27 #include <functional>
28 #include <wtf/text/AtomicString.h>
29
30 namespace WebCore {
31
32 #define DOM_EVENT_NAMES_FOR_EACH(macro) \
33     macro(DOMActivate) \
34     macro(DOMCharacterDataModified) \
35     macro(DOMContentLoaded) \
36     macro(DOMFocusIn) \
37     macro(DOMFocusOut) \
38     macro(DOMNodeInserted) \
39     macro(DOMNodeInsertedIntoDocument) \
40     macro(DOMNodeRemoved) \
41     macro(DOMNodeRemovedFromDocument) \
42     macro(DOMSubtreeModified) \
43     macro(abort) \
44     macro(active) \
45     macro(addsourcebuffer) \
46     macro(addstream) \
47     macro(addtrack) \
48     macro(animationend) \
49     macro(animationiteration) \
50     macro(animationstart) \
51     macro(audioend) \
52     macro(audioprocess) \
53     macro(audiostart) \
54     macro(autocomplete) \
55     macro(autocompleteerror) \
56     macro(beforecopy) \
57     macro(beforecut) \
58     macro(beforeload) \
59     macro(beforepaste) \
60     macro(beforeunload) \
61     macro(blocked) \
62     macro(blur) \
63     macro(boundary) \
64     macro(cached) \
65     macro(canplay) \
66     macro(canplaythrough) \
67     macro(change) \
68     macro(chargingchange) \
69     macro(chargingtimechange) \
70     macro(checking) \
71     macro(click) \
72     macro(close) \
73     macro(complete) \
74     macro(compositionend) \
75     macro(compositionstart) \
76     macro(compositionupdate) \
77     macro(connect) \
78     macro(connecting) \
79     macro(contextmenu) \
80     macro(copy) \
81     macro(cuechange) \
82     macro(cut) \
83     macro(datachannel) \
84     macro(dblclick) \
85     macro(devicemotion) \
86     macro(deviceorientation) \
87     macro(dischargingtimechange) \
88     macro(downloading) \
89     macro(drag) \
90     macro(dragend) \
91     macro(dragenter) \
92     macro(dragleave) \
93     macro(dragover) \
94     macro(dragstart) \
95     macro(drop) \
96     macro(durationchange) \
97     macro(emptied) \
98     macro(end) \
99     macro(ended) \
100     macro(enter) \
101     macro(error) \
102     macro(exit) \
103     macro(focus) \
104     macro(focusin) \
105     macro(focusout) \
106     macro(gamepadconnected) \
107     macro(gamepaddisconnected) \
108     macro(gesturechange) \
109     macro(gestureend) \
110     macro(gesturescrollend) \
111     macro(gesturescrollstart) \
112     macro(gesturescrollupdate) \
113     macro(gesturestart) \
114     macro(gesturetap) \
115     macro(gesturetapdown) \
116     macro(hashchange) \
117     macro(icecandidate) \
118     macro(iceconnectionstatechange) \
119     macro(inactive) \
120     macro(input) \
121     macro(invalid) \
122     macro(keydown) \
123     macro(keypress) \
124     macro(keyup) \
125     macro(levelchange) \
126     macro(load) \
127     macro(loadeddata) \
128     macro(loadedmetadata) \
129     macro(loadend) \
130     macro(loading) \
131     macro(loadingdone) \
132     macro(loadstart) \
133     macro(mark) \
134     macro(message) \
135     macro(mousedown) \
136     macro(mouseenter) \
137     macro(mouseleave) \
138     macro(mousemove) \
139     macro(mouseout) \
140     macro(mouseover) \
141     macro(mouseup) \
142     macro(mousewheel) \
143     macro(mute) \
144     macro(negotiationneeded) \
145     macro(nomatch) \
146     macro(noupdate) \
147     macro(obsolete) \
148     macro(offline) \
149     macro(online) \
150     macro(open) \
151     macro(orientationchange) \
152     macro(overconstrained) \
153     macro(overflowchanged) \
154     macro(pagehide) \
155     macro(pageshow) \
156     macro(paste) \
157     macro(pause) \
158     macro(play) \
159     macro(playing) \
160     macro(pointerlockchange) \
161     macro(pointerlockerror) \
162     macro(popstate) \
163     macro(progress) \
164     macro(ratechange) \
165     macro(readystatechange) \
166     macro(removesourcebuffer) \
167     macro(removestream) \
168     macro(removetrack) \
169     macro(reset) \
170     macro(resize) \
171     macro(result) \
172     macro(resume) \
173     macro(scroll) \
174     macro(search) \
175     macro(securitypolicyviolation) \
176     macro(seeked) \
177     macro(seeking) \
178     macro(select) \
179     macro(selectionchange) \
180     macro(selectstart) \
181     macro(show) \
182     macro(signalingstatechange) \
183     macro(soundend) \
184     macro(soundstart) \
185     macro(sourceclose) \
186     macro(sourceended) \
187     macro(sourceopen) \
188     macro(speechend) \
189     macro(speechstart) \
190     macro(stalled) \
191     macro(start) \
192     macro(started) \
193     macro(storage) \
194     macro(submit) \
195     macro(success) \
196     macro(suspend) \
197     macro(textInput) \
198     macro(timeout) \
199     macro(timeupdate) \
200     macro(tonechange) \
201     macro(touchcancel) \
202     macro(touchend) \
203     macro(touchmove) \
204     macro(touchstart) \
205     macro(transitionend) \
206     macro(unload) \
207     macro(unmute) \
208     macro(update) \
209     macro(updateend) \
210     macro(updateready) \
211     macro(updatestart) \
212     macro(upgradeneeded) \
213     macro(versionchange) \
214     macro(visibilitychange) \
215     macro(volumechange) \
216     macro(waiting) \
217     macro(webglcontextcreationerror) \
218     macro(webglcontextlost) \
219     macro(webglcontextrestored) \
220     macro(webkitAnimationEnd) \
221     macro(webkitAnimationIteration) \
222     macro(webkitAnimationStart) \
223     macro(webkitBeforeTextInserted) \
224     macro(webkitEditableContentChanged) \
225     macro(webkitTransitionEnd) \
226     macro(webkitbeginfullscreen) \
227     macro(webkitcurrentplaybacktargetiswirelesschanged) \
228     macro(webkitdeviceproximity) \
229     macro(webkitendfullscreen) \
230     macro(webkitfullscreenchange) \
231     macro(webkitfullscreenerror) \
232     macro(webkitkeyadded) \
233     macro(webkitkeyerror) \
234     macro(webkitkeymessage) \
235     macro(webkitneedkey) \
236     macro(webkitnetworkinfochange) \
237     macro(webkitplaybacktargetavailabilitychanged) \
238     macro(webkitpresentationmodechanged) \
239     macro(webkitregionoversetchange) \
240     macro(webkitremovesourcebuffer) \
241     macro(webkitresourcetimingbufferfull) \
242     macro(webkitsourceclose) \
243     macro(webkitsourceended) \
244     macro(webkitsourceopen) \
245     macro(webkitspeechchange) \
246     macro(webkitwillrevealbottom) \
247     macro(webkitwillrevealleft) \
248     macro(webkitwillrevealright) \
249     macro(webkitwillrevealtop) \
250     macro(wheel) \
251     macro(write) \
252     macro(writeend) \
253     macro(writestart) \
254     macro(zoom) \
255 // end of DOM_EVENT_NAMES_FOR_EACH
256
257 struct EventNames {
258     WTF_MAKE_NONCOPYABLE(EventNames); WTF_MAKE_FAST_ALLOCATED;
259
260 public:
261 #define DOM_EVENT_NAMES_DECLARE(name) const AtomicString name##Event;
262     DOM_EVENT_NAMES_FOR_EACH(DOM_EVENT_NAMES_DECLARE)
263 #undef DOM_EVENT_NAMES_DECLARE
264
265     // FIXME: Inelegant to call these both event names and event types.
266     // We should choose one term and stick to it.
267     bool isGestureEventType(const AtomicString& eventType) const;
268     bool isTouchEventType(const AtomicString& eventType) const;
269 #if ENABLE(GAMEPAD)
270     bool isGamepadEventType(const AtomicString& eventType) const;
271 #endif
272
273     std::array<std::reference_wrapper<const AtomicString>, 4> touchEventNames() const;
274
275 private:
276     EventNames(); // Private to prevent accidental call to EventNames() instead of eventNames().
277     friend class ThreadGlobalData; // Allow ThreadGlobalData to create the per-thread EventNames object.
278
279     int dummy; // Needed to make initialization macro work.
280 };
281
282 const EventNames& eventNames();
283
284 inline const EventNames& eventNames()
285 {
286     return threadGlobalData().eventNames();
287 }
288
289 inline bool EventNames::isGestureEventType(const AtomicString& eventType) const
290 {
291     return eventType == gesturestartEvent || eventType == gesturechangeEvent || eventType == gestureendEvent;
292 }
293
294 inline bool EventNames::isTouchEventType(const AtomicString& eventType) const
295 {
296     return eventType == touchstartEvent
297         || eventType == touchmoveEvent
298         || eventType == touchendEvent
299         || eventType == touchcancelEvent;
300 }
301
302 inline std::array<std::reference_wrapper<const AtomicString>, 4> EventNames::touchEventNames() const
303 {
304     return { { touchstartEvent, touchmoveEvent, touchendEvent, touchcancelEvent } };
305 }
306
307 #if ENABLE(GAMEPAD)
308
309 inline bool EventNames::isGamepadEventType(const AtomicString& eventType) const
310 {
311     return eventType == gamepadconnectedEvent
312         || eventType == gamepaddisconnectedEvent;
313 }
314
315 #endif
316
317 }
318
319 #endif