280bb0aa2abc7cbf1c9925156fa339288f3517ed
[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 #pragma once
23
24 #include "ThreadGlobalData.h"
25 #include <array>
26 #include <functional>
27 #include <wtf/text/AtomicString.h>
28
29 namespace WebCore {
30
31 #if !defined(ADDITIONAL_DOM_EVENT_NAMES_FOR_EACH)
32 #define ADDITIONAL_DOM_EVENT_NAMES_FOR_EACH(macro)
33 #endif
34
35 #define DOM_EVENT_NAMES_FOR_EACH(macro) \
36     ADDITIONAL_DOM_EVENT_NAMES_FOR_EACH(macro) \
37     macro(DOMActivate) \
38     macro(DOMCharacterDataModified) \
39     macro(DOMContentLoaded) \
40     macro(DOMFocusIn) \
41     macro(DOMFocusOut) \
42     macro(DOMNodeInserted) \
43     macro(DOMNodeInsertedIntoDocument) \
44     macro(DOMNodeRemoved) \
45     macro(DOMNodeRemovedFromDocument) \
46     macro(DOMSubtreeModified) \
47     macro(abort) \
48     macro(active) \
49     macro(addsourcebuffer) \
50     macro(addstream) \
51     macro(addtrack) \
52     macro(animationend) \
53     macro(animationiteration) \
54     macro(animationstart) \
55     macro(audioend) \
56     macro(audioprocess) \
57     macro(audiostart) \
58     macro(autocomplete) \
59     macro(autocompleteerror) \
60     macro(beforecopy) \
61     macro(beforecut) \
62     macro(beforeinput) \
63     macro(beforeload) \
64     macro(beforepaste) \
65     macro(beforeunload) \
66     macro(beginEvent) \
67     macro(blocked) \
68     macro(blur) \
69     macro(boundary) \
70     macro(bufferedamountlow) \
71     macro(cached) \
72     macro(cancel) \
73     macro(canplay) \
74     macro(canplaythrough) \
75     macro(change) \
76     macro(chargingchange) \
77     macro(chargingtimechange) \
78     macro(checking) \
79     macro(click) \
80     macro(close) \
81     macro(complete) \
82     macro(compositionend) \
83     macro(compositionstart) \
84     macro(compositionupdate) \
85     macro(connect) \
86     macro(connectionstatechange) \
87     macro(connecting) \
88     macro(contextmenu) \
89     macro(copy) \
90     macro(cuechange) \
91     macro(cut) \
92     macro(datachannel) \
93     macro(dblclick) \
94     macro(devicechange) \
95     macro(devicemotion) \
96     macro(deviceorientation) \
97     macro(dischargingtimechange) \
98     macro(downloading) \
99     macro(drag) \
100     macro(dragend) \
101     macro(dragenter) \
102     macro(dragleave) \
103     macro(dragover) \
104     macro(dragstart) \
105     macro(drop) \
106     macro(durationchange) \
107     macro(emptied) \
108     macro(encrypted) \
109     macro(end) \
110     macro(endEvent) \
111     macro(ended) \
112     macro(enter) \
113     macro(error) \
114     macro(exit) \
115     macro(focus) \
116     macro(focusin) \
117     macro(focusout) \
118     macro(gamepadconnected) \
119     macro(gamepaddisconnected) \
120     macro(gesturechange) \
121     macro(gestureend) \
122     macro(gesturescrollend) \
123     macro(gesturescrollstart) \
124     macro(gesturescrollupdate) \
125     macro(gesturestart) \
126     macro(gesturetap) \
127     macro(gesturetapdown) \
128     macro(hashchange) \
129     macro(icecandidate) \
130     macro(iceconnectionstatechange) \
131     macro(icegatheringstatechange) \
132     macro(inactive) \
133     macro(input) \
134     macro(invalid) \
135     macro(keydown) \
136     macro(keypress) \
137     macro(keystatuseschange) \
138     macro(keyup) \
139     macro(languagechange) \
140     macro(levelchange) \
141     macro(load) \
142     macro(loadeddata) \
143     macro(loadedmetadata) \
144     macro(loadend) \
145     macro(loading) \
146     macro(loadingdone) \
147     macro(loadingerror) \
148     macro(loadstart) \
149     macro(mark) \
150     macro(message) \
151     macro(mousedown) \
152     macro(mouseenter) \
153     macro(mouseleave) \
154     macro(mousemove) \
155     macro(mouseout) \
156     macro(mouseover) \
157     macro(mouseup) \
158     macro(mousewheel) \
159     macro(mute) \
160     macro(negotiationneeded) \
161     macro(nexttrack) \
162     macro(nomatch) \
163     macro(noupdate) \
164     macro(obsolete) \
165     macro(offline) \
166     macro(online) \
167     macro(open) \
168     macro(orientationchange) \
169     macro(overconstrained) \
170     macro(overflowchanged) \
171     macro(pagehide) \
172     macro(pageshow) \
173     macro(paste) \
174     macro(pause) \
175     macro(paymentauthorized) \
176     macro(paymentmethodselected) \
177     macro(play) \
178     macro(playing) \
179     macro(pointerlockchange) \
180     macro(pointerlockerror) \
181     macro(popstate) \
182     macro(previoustrack) \
183     macro(progress) \
184     macro(ratechange) \
185     macro(readystatechange) \
186     macro(rejectionhandled) \
187     macro(removesourcebuffer) \
188     macro(removestream) \
189     macro(removetrack) \
190     macro(reset) \
191     macro(resize) \
192     macro(resourcetimingbufferfull) \
193     macro(result) \
194     macro(resume) \
195     macro(scroll) \
196     macro(search) \
197     macro(securitypolicyviolation) \
198     macro(seeked) \
199     macro(seeking) \
200     macro(select) \
201     macro(selectionchange) \
202     macro(selectstart) \
203     macro(shippingmethodselected) \
204     macro(shippingcontactselected) \
205     macro(show) \
206     macro(signalingstatechange) \
207     macro(slotchange) \
208     macro(soundend) \
209     macro(soundstart) \
210     macro(sourceclose) \
211     macro(sourceended) \
212     macro(sourceopen) \
213     macro(speechend) \
214     macro(speechstart) \
215     macro(stalled) \
216     macro(start) \
217     macro(started) \
218     macro(statechange) \
219     macro(storage) \
220     macro(submit) \
221     macro(success) \
222     macro(suspend) \
223     macro(textInput) \
224     macro(timeout) \
225     macro(timeupdate) \
226     macro(toggle) \
227     macro(tonechange) \
228     macro(touchcancel) \
229     macro(touchend) \
230     macro(touchforcechange) \
231     macro(touchmove) \
232     macro(touchstart) \
233     macro(track) \
234     macro(transitionend) \
235     macro(unhandledrejection) \
236     macro(unload) \
237     macro(unmute) \
238     macro(update) \
239     macro(updateend) \
240     macro(updateready) \
241     macro(updatestart) \
242     macro(upgradeneeded) \
243     macro(validatemerchant) \
244     macro(versionchange) \
245     macro(visibilitychange) \
246     macro(volumechange) \
247     macro(waiting) \
248     macro(waitingforkey) \
249     macro(webglcontextchanged) \
250     macro(webglcontextcreationerror) \
251     macro(webglcontextlost) \
252     macro(webglcontextrestored) \
253     macro(webkitAnimationEnd) \
254     macro(webkitAnimationIteration) \
255     macro(webkitAnimationStart) \
256     macro(webkitBeforeTextInserted) \
257     macro(webkitEditableContentChanged) \
258     macro(webkitTransitionEnd) \
259     macro(webkitbeginfullscreen) \
260     macro(webkitcurrentplaybacktargetiswirelesschanged) \
261     macro(webkitdeviceproximity) \
262     macro(webkitendfullscreen) \
263     macro(webkitfullscreenchange) \
264     macro(webkitfullscreenerror) \
265     macro(webkitkeyadded) \
266     macro(webkitkeyerror) \
267     macro(webkitkeymessage) \
268     macro(webkitmouseforcechanged) \
269     macro(webkitmouseforcedown) \
270     macro(webkitmouseforcewillbegin) \
271     macro(webkitmouseforceup) \
272     macro(webkitneedkey) \
273     macro(webkitnetworkinfochange) \
274     macro(webkitplaybacktargetavailabilitychanged) \
275     macro(webkitpresentationmodechanged) \
276     macro(webkitregionoversetchange) \
277     macro(webkitremovesourcebuffer) \
278     macro(webkitsourceclose) \
279     macro(webkitsourceended) \
280     macro(webkitsourceopen) \
281     macro(webkitspeechchange) \
282     macro(webkitwillrevealbottom) \
283     macro(webkitwillrevealleft) \
284     macro(webkitwillrevealright) \
285     macro(webkitwillrevealtop) \
286     macro(wheel) \
287     macro(write) \
288     macro(writeend) \
289     macro(writestart) \
290     macro(zoom) \
291 // end of DOM_EVENT_NAMES_FOR_EACH
292
293 struct EventNames {
294     WTF_MAKE_NONCOPYABLE(EventNames); WTF_MAKE_FAST_ALLOCATED;
295
296 public:
297 #define DOM_EVENT_NAMES_DECLARE(name) const AtomicString name##Event;
298     DOM_EVENT_NAMES_FOR_EACH(DOM_EVENT_NAMES_DECLARE)
299 #undef DOM_EVENT_NAMES_DECLARE
300
301     // FIXME: The friend declaration to std::make_unique below does not work in windows port.
302     //
303     // template<class T, class... Args>
304     // friend typename std::_Unique_if<T>::_Single_object std::make_unique(Args&&...);
305     //
306     // This create function should be deleted later and is only for keeping EventNames as private.
307     // std::make_unique should be used instead.
308     //
309     template<class... Args>
310     static std::unique_ptr<EventNames> create(Args&&... args)
311     {
312         return std::unique_ptr<EventNames>(new EventNames(std::forward<Args>(args)...));
313     }
314
315     // FIXME: Inelegant to call these both event names and event types.
316     // We should choose one term and stick to it.
317     bool isWheelEventType(const AtomicString& eventType) const;
318     bool isGestureEventType(const AtomicString& eventType) const;
319     bool isTouchEventType(const AtomicString& eventType) const;
320 #if ENABLE(GAMEPAD)
321     bool isGamepadEventType(const AtomicString& eventType) const;
322 #endif
323
324     std::array<std::reference_wrapper<const AtomicString>, 5> touchEventNames() const;
325     std::array<std::reference_wrapper<const AtomicString>, 3> gestureEventNames() const;
326
327 private:
328     EventNames(); // Private to prevent accidental call to EventNames() instead of eventNames().
329     friend class ThreadGlobalData; // Allow ThreadGlobalData to create the per-thread EventNames object.
330
331     int dummy; // Needed to make initialization macro work.
332 };
333
334 const EventNames& eventNames();
335
336 inline const EventNames& eventNames()
337 {
338     return threadGlobalData().eventNames();
339 }
340
341 inline bool EventNames::isGestureEventType(const AtomicString& eventType) const
342 {
343     return eventType == gesturestartEvent || eventType == gesturechangeEvent || eventType == gestureendEvent;
344 }
345
346 inline bool EventNames::isTouchEventType(const AtomicString& eventType) const
347 {
348     return eventType == touchstartEvent
349         || eventType == touchmoveEvent
350         || eventType == touchendEvent
351         || eventType == touchcancelEvent
352         || eventType == touchforcechangeEvent;
353 }
354
355 inline bool EventNames::isWheelEventType(const AtomicString& eventType) const
356 {
357     return eventType == wheelEvent
358         || eventType == mousewheelEvent;
359 }
360
361 inline std::array<std::reference_wrapper<const AtomicString>, 5> EventNames::touchEventNames() const
362 {
363     return { { touchstartEvent, touchmoveEvent, touchendEvent, touchcancelEvent, touchforcechangeEvent } };
364 }
365
366 inline std::array<std::reference_wrapper<const AtomicString>, 3> EventNames::gestureEventNames() const
367 {
368     return { { gesturestartEvent, gesturechangeEvent, gestureendEvent } };
369 }
370
371 #if ENABLE(GAMEPAD)
372
373 inline bool EventNames::isGamepadEventType(const AtomicString& eventType) const
374 {
375     return eventType == gamepadconnectedEvent
376         || eventType == gamepaddisconnectedEvent;
377 }
378
379 #endif
380
381 } // namespace WebCore